- path/to/some/directory/
- acls/
- Site.php
- forms/
- Login.php
- models/
- User.php
Programmer's Reference Guide
| Der Autoloader |
Ressource Autoloader
Ressource Autoloader sind dazu gedacht Namespaced Bibliothekscode zu Managen der den Coding Standard Richtlinien vom Zend Framework folgt, welche aber kein 1:1 Mapping zwischen dem Klassennamen und der Verzeichnis Struktur haben. Ihr primärer Zweck ist es als Autoloader Anwendungs-Ressource Code zu arbeiten, wie z.B. für Anwendungs-spezifische Modelle, Formen, und ACLs.
Ressource Autoloader werden mit dem autoloader bei der Instanziierung registriert, und zwar mit dem Namespace mit dem Sie assoziiert sind. Das erlaubt es Code in speziellen Verzeichnissen zu namespacen, und trotzdem die Vorteile des Autoloadings zu nutzen.
Verwendung von Ressource Autoloadern
Nehmen wir die folgende Verzeichnis Struktur an:
In diesem Verzeichnis hat jeder Code ein Präfix mit dem Namespace "My_". Im Unterverzeichnis "acls" ist der Komponentenpräfix "Acl_" hinzugefügt, was letztendlich zu einem Klassennamen von "My_Acl_Site" führt. So ähnlich mappt das Unterverzeichnis "forms" auf "Form_", was zu "My_Form_Login" führt. Das Unterverzeichnis "models" hat keinen Komponenten Namespace, was zu "My_User" führt.
Man kann einen Ressource Autoloader verwenden um diese Klassen automatisch zu laden. um den Ressource Autoloader zu instanziieren ist es mindestens notwendig den Basispfad und den Namespace für die Ressourcen zu übergeben für die er verantwortlich ist:
- 'basePath' => 'path/to/some/directory',
- 'namespace' => 'My',
- ));
Hinweis: Basis Namespace
In Zend_Loader_Autoloader wird erwartet das man den endenden Unterstrich ("_") im Namespace angibt wenn der eigene Autoloader verwendet wird um den Namespace zu suchen. Zend_Loader_Autoloader_Resource nimmt an das alle Codes die man automatisch laden will ein Unterstrich Trennzeichen zwischen Namespace, Komponente und Klasse verwenden. Als Ergebnis, muß man den endenen Unterstrich nicht verwenden wenn ein Ressource Autoloader registriert wird.
Jetzt da wir den Basis Ressource Autoloader eingerichtet haben, können wir einige Komponenten zu Ihm hinzufügen um die automatisch zu Laden. Das wird mit der addResourceType() Methode getan, welche drei Argumente akzeptiert: einen Ressource "type", der intern als Referenzname verwendet wird; den Pfad des Unterverzeichnisses unter dem Basispfad in dem diese Ressource existiert; und den Namespace der Komponente die dem Basis Namespace hinzugefügt wird. Als Beispiel fügen wir jeden unserer Ressource Typen hinzu.
- $resourceLoader->addResourceType('acl', 'acls/', 'Acl')
- ->addResourceType('form', 'forms/', 'Form')
- ->addResourceType('model', 'models/');
Alternativ können diese als Array an addResourceTypes() übergeben werden; das folgende ist äquivalent zu dem obigen:
Letztendlich kann alles davon spezifiziert werden wenn das Objekt instanziiert wird indem einfach ein "resourceTypes" Schlüssel in den Optionen spezifiziert und übergeben wird, sowie eine Struktur wie anbei:
- 'basePath' => 'path/to/some/directory',
- 'namespace' => 'My',
- 'path' => 'acls/',
- 'namespace' => 'Acl',
- ),
- 'path' => 'forms/',
- 'namespace' => 'Form',
- ),
- 'path' => 'models/',
- ),
- ),
- ));
Der Modul Ressource Autoloader
Zend Framework wird mit einer konkreten Implementation von Zend_Loader_Autoloader_Resource ausgeliefert die Ressourcen Typen enthält welche den notwendigen Standard Verzeichnisstrukturen für Zend Framework MVC Anwendungen entsprechen. Diese Lader, Zend_Application_Module_Autoloader, kommt mit den folgenden Mappings:
- forms/ => Form
- models/ => Model
- DbTable/ => Model_DbTable
- mappers/ => Model_Mapper
- plugins/ => Plugin
- services/ => Service
- views/
- helpers => View_Helper
- filters => View_Filter
Wenn man, als Beispiel, ein Modul mit dem Präfix "Blog_" hat, und die Klasse "Blog_Form_Entry" instanziieren will, würde diese in den Ressourcen Verzeichnis "forms/" im Unterverzeichnis nach einer Datei die "Entry.php" heißt suchen.
Wenn Modul Bootstraps mit Zend_Application verwendet werden, wird standardmäßig eine Instanz von Zend_Application_Module_Autoloader für jede eigene Modul erstellt, was es erlaubt Modul Ressource automatisch zu laden.
Verwendung von Ressource Autoloadern als Objekt Factories
Referenz zu den Ressource Autoloadern
| Der Autoloader |
Add A Comment
Please do not report issues via comments; use the ZF Issue Tracker.
If you have a JIRA/Crowd account, we suggest you login first before commenting.
Comments
I add a resource to the resource autoloader like in the examples above. for my example I will use form.
$resourceLoader->addResourceType('form', 'forms/', 'Form');
On my local machine my directory can look like the following example, and can auto load the files without error given that the class name follows the directory.
forms/
- Login.php (Form_Login)
- Signup.php (Form_Signup)
- Admin/
- - News.php (Form_Admin_News)
- - User.php (Form_Admin_User)
But on my remote test server the auto loader fails and returns an error:
Fatal error: Class 'Form_Admin_News' not found in /application/controllers/AdminController.php on line 53
on my Dev System (ZendserverCE on MAC) al walks fine, but on my production system with ubuntu 8.04 it fail:
Fatal error: Class 'Media_Model_DbTable_Sources' not found in /www/projectname/application/modules/media/controllers/SourcesController.php on line 20
I can not find a solution. :(
d
I'm using this:
$resourceLoader = new Zend_Loader_Autoloader_Resource(array(
'basePath' => 'path/to/some/directory',
'namespace' => 'My',
'resourceTypes' => array(
'acl' => array(
'path' => 'acls/',
'namespace' => 'Acl',
),
'form' => array(
'path' => 'forms/',
'namespace' => 'Form',
),
'model' => array(
'path' => 'models/',
),
),
));
It's copied from this tutorial.
I'm getting an Exception:
Fatal error: Uncaught exception 'Zend_Loader_Exception' with message 'Initial definition of a resource type must include a namespace' in C:\Program Files\Zend\ZendServer\share\ZendFramework\library\Zend\Loader\Autoloader\Resource.php:276 Stack trace: #0
...
Why?!
$resourceLoader = new Zend_Loader_Autoloader_Resource(array(
'basePath' => 'path/to/some/directory',
'namespace' => 'My',
'resourceTypes' => array(
'acl' => array(
'path' => 'acls/',
'namespace' => 'Acl',
),
'form' => array(
'path' => 'forms/',
'namespace' => 'Form',
),
'model' => array(
'path' => 'models/',
),
),
));
Note the missing namespace in the 'model' resource type. That example should actually be:
$resourceLoader = new Zend_Loader_Autoloader_Resource(array(
'basePath' => 'path/to/some/directory',
'namespace' => 'My',
'resourceTypes' => array(
'acl' => array(
'path' => 'acls/',
'namespace' => 'Acl',
),
'form' => array(
'path' => 'forms/',
'namespace' => 'Form',
),
'model' => array(
'path' => 'models/',
'namespace' => 'Model',
),
),
));
Even if you set things up as shown in the above example don't forget you need to include the namespaces names in your class names too!
So if you have:
$user = new My_Model_User();
and this refers to the User.php file sat under application_directory/models/User.php
you still must make sure that the user class name is actually My_Model_User
class My_Model_User {
//code
}
Zend do this themselves too. For example if you load the config.php class in the Zend library directory via the autoloader you will see that the class name in that file is Zend_Config.php
If you would name the class:
class User {
}
then you will get the "class not found" error.
This may seem obvious to many but it had me baffled when I started out using the Zend Framework in the MVC style.
I think Zend could give more detailed examples as that would help.
Alguien me explica?
Indeed, I was struggling to solve the 'Class Model_Users' not found error to finally realize that the mistake was because the file was wrongly named 'Model_Users.php' and not 'Users.php' as expected.
Cheers!
Any idea how to resolve this?
path/to/some/directory/
acls/
Site.php (ENSURE YOUR class's filename starts with UPPER CASE)
forms/
Login.php (ENSURE YOUR class's filename starts with UPPER CASE)
models/
User.php (ENSURE YOUR class's filename starts with UPPER CASE)
Zend_Loader_Autoloader works Capitalized!!
My_Acl_Site points to -->
/acls/Site.php NOT /acls/site.php
I'm new to Zend Framework, and i'm trying to understand something, what are the benefits of using the Zend_Application_Module_Autoloader and the namespace "My_" when im using the modules structure. Why not simply call the controller and classes by its names. What am I trying to avoid when using those tools?