Zend_Loader-Autoloader-Resource.xml 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17232 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.loader.autoloader-resource">
  5. <title>Autoloaders de ressources</title>
  6. <para>
  7. Les autoloaders de ressources servent à manipuler du code de librairies dans des
  8. espaces de noms, respectant les conventions de codage du Zend Framework, mais n'ayant pas
  9. une correspondance 1:1 entre le nom de la classe et la structure du dossier. Leur but est de
  10. faciliter le chargement du code des ressources de l'application, comme les modèles, les
  11. <acronym>ACL</acronym>s, les formulaires...
  12. </para>
  13. <para>
  14. Les autoloaders de ressources s'enregistrent dans l'<link
  15. linkend="zend.loader.autoloader">autoloader</link> à leur instanciation, avec l'espace de
  16. noms auxquels ils sont rattachés. Ceci permet de facilement isoler du code dans des
  17. dossiers, sous l'espace de noms, tout en gardant les bénéfices de l'autoload.
  18. </para>
  19. <sect2 id="zend.loader.autoloader-resource.usage">
  20. <title>Utilisation de l'autoloader de ressources</title>
  21. <para>Soit la structure de répertoires suivante&#160;:</para>
  22. <programlisting language="text"><![CDATA[
  23. path/to/some/directory/
  24. acls/
  25. Site.php
  26. forms/
  27. Login.php
  28. models/
  29. User.php
  30. ]]></programlisting>
  31. <para>
  32. Au sein de ce répertoire, toutes les classes sont préfixées par l'espace de noms
  33. "My_". Dans le dossier "acls", le préfixe de composant "Acl_" est ajouté, ce qui donne
  34. un nom de classe final "My_Acl_Site". Aussi, le dossier "forms" correspond à "Form_", ce
  35. qui donne "My_Form_Login". Le dossier "models" n'a pas d'espace de noms particulier,
  36. donnant donc "My_User".
  37. </para>
  38. <para>
  39. Pour instancier un autoloader de ressoucres, il faut au minimum lui passer son
  40. dossier de travail (base path), et le nom de l'espace de noms correspondant&#160;:
  41. </para>
  42. <programlisting language="php"><![CDATA[
  43. $resourceLoader = new Zend_Loader_Autoloader_Resource(array(
  44. 'basePath' => 'path/to/some/directory',
  45. 'namespace' => 'My',
  46. ));
  47. ]]></programlisting>
  48. <note>
  49. <title>Espace de noms de base</title>
  50. <para>
  51. Dans <classname>Zend_Loader_Autoloader</classname>, vous devez spécifier le
  52. underscore final ("_") dans votre espace de noms.
  53. <classname>Zend_Loader_Autoloader_Resource</classname> suppose par contre que tout
  54. le code à auto-charger utilisera le séparateur d'espaces de noms underscore. Ainsi,
  55. vous n'avez pas besoin de le préciser avec l'autoloader de ressources.
  56. </para>
  57. </note>
  58. <para>
  59. Maintenant que notre autoloader est configuré, nous pouvons ajouter des composants
  60. à auto-charger. Ceci se fait via la méthode <methodname>addResourceType()</methodname>, qui accepte
  61. 3 arguments : un "type" de ressource, utiliser en interne comme nom de référence&#160;;
  62. le sous dossier dans lequel la ressource en question est logé, et l'espace de noms du
  63. composant à rajouter à l'espace de noms général. Voici un exemple&#160;:
  64. </para>
  65. <programlisting language="php"><![CDATA[
  66. $resourceLoader->addResourceType('acl', 'acls/', 'Acl')
  67. ->addResourceType('form', 'forms/', 'Form')
  68. ->addResourceType('model', 'models/');
  69. ]]></programlisting>
  70. <para>
  71. Aussi, vous auriez pu effectuer la même action avec un tableau <acronym>PHP</acronym>.
  72. <methodname>addResourceTypes()</methodname> est alors appropriée&#160;:
  73. </para>
  74. <programlisting language="php"><![CDATA[
  75. $resourceLoader->addResourceTypes(array(
  76. 'acl' => array(
  77. 'path' => 'acls/',
  78. 'namespace' => 'Acl',
  79. ),
  80. 'form' => array(
  81. 'path' => 'forms/',
  82. 'namespace' => 'Form',
  83. ),
  84. 'model' => array(
  85. 'path' => 'models/',
  86. ),
  87. ));
  88. ]]></programlisting>
  89. <para>
  90. Enfin, vous pouvez spécifier tout cela d'un seul coup avec des tableaux nichés. La
  91. clé doit alors être "resourceTypes"&#160;:
  92. </para>
  93. <programlisting language="php"><![CDATA[
  94. $resourceLoader = new Zend_Loader_Autoloader_Resource(array(
  95. 'basePath' => 'path/to/some/directory',
  96. 'namespace' => 'My',
  97. 'resourceTypes' => array(
  98. 'acl' => array(
  99. 'path' => 'acls/',
  100. 'namespace' => 'Acl',
  101. ),
  102. 'form' => array(
  103. 'path' => 'forms/',
  104. 'namespace' => 'Form',
  105. ),
  106. 'model' => array(
  107. 'path' => 'models/',
  108. ),
  109. ),
  110. ));
  111. ]]></programlisting>
  112. </sect2>
  113. <sect2 id="zend.loader.autoloader-resource.module">
  114. <title>L'autoloader de ressource Module</title>
  115. <para>
  116. Zend Framework fournit une implémentation concrète de
  117. <classname>Zend_Loader_Autoloader_Resource</classname> qui contient des correspondances
  118. de ressources pour mettre en avant la structure modulaire par défaut que propose le Zend
  119. Framework dans ses applications <acronym>MVC</acronym>. Ce chargeur,
  120. <classname>Zend_Application_Module_Autoloader</classname>, propose le mapping
  121. suivant&#160;:
  122. </para>
  123. <programlisting language="text"><![CDATA[
  124. api/ => Api
  125. forms/ => Form
  126. models/ => Model
  127. DbTable/ => Model_DbTable
  128. plugins/ => Plugin
  129. ]]></programlisting>
  130. <para>
  131. Par exemple, avec un module dont le préfixe est "Blog_", le chargement de la
  132. classe "Blog_Form_Entry" mènerait au chargement du fichier "forms/Entry.php".
  133. </para>
  134. <para>
  135. En utilisant les bootstraps de modules avec
  136. <classname>Zend_Application</classname>, une instance de
  137. <classname>Zend_Application_Module_Autoloader</classname> sera crée pour chaque module
  138. utilisé.
  139. </para>
  140. </sect2>
  141. <sect2 id="zend.loader.autoloader-resource.factory">
  142. <title>Utiliser les autoloaders de ressources comme fabriques d'objets</title>
  143. <para></para>
  144. <!-- @todo -->
  145. </sect2>
  146. <sect2 id="zend.loader.autoloader-resource.reference">
  147. <title>Référence de l'autoloader de ressources</title>
  148. <para></para>
  149. <!-- @todo -->
  150. </sect2>
  151. <!-- @todo
  152. Write section on using load() functionality
  153. Potentially add functionality to load() to allow passing arguments
  154. Show how to use overloading to retrieve class instances
  155. Write reference section
  156. -->
  157. </sect1>