Zend_Loader.xml 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.loader.load">
  5. <title>Dynamisches Laden von Dateien und Klassen</title>
  6. <para>
  7. Die Zend_Loader Klasse enthält Methoden die helfen Dateien dynamisch zu laden.
  8. </para>
  9. <tip>
  10. <title>Zend_Loader vs. require_once()</title>
  11. <para>
  12. Die <classname>Zend_Loader</classname> Methoden werden am Besten verwendet wenn der Dateiname
  13. der Verwendet wird variabel ist. Wenn er zum Beispiel auf einem Parameter
  14. einer Benutzereinfabe oder eines Arguments einer Methode basiert. Wenn
  15. eine Datei oder eine Klasse geladen werden soll deren Name konstant ist,
  16. gibt es keinen Vorteil durch die Verwendung von <classname>Zend_Loader</classname> gegenüber
  17. traditionellen PHP Funktionen wie
  18. <ulink url="http://php.net/require_once"><code>require_once()</code></ulink>.
  19. </para>
  20. </tip>
  21. <sect2 id="zend.loader.load.file">
  22. <title>Dateien laden</title>
  23. <para>
  24. Die statische Methode <classname>Zend_Loader::loadFile()</classname> lädt eine
  25. PHP Datei. Die geladene Datei kann jeden PHP Code enthalten.
  26. Diese Methode ist ein Wrapper für die PHP Funktion
  27. <ulink url="http://php.net/include"><code>include()</code></ulink>.
  28. Diese Methode gibt bei einem Fehler ein boosches false zurück,
  29. zum Beispiel wenn die definierte Datei nicht existiert.
  30. </para>
  31. <example id="zend.loader.load.file.example">
  32. <title>Beispiel der loadFile() Methode</title>
  33. <programlisting role="php"><![CDATA[
  34. Zend_Loader::loadFile($filename, $dirs=null, $once=false);
  35. ]]></programlisting>
  36. </example>
  37. <para>
  38. Das <code>$filename</code> Argument definert den Dateinamen der geladen
  39. werden soll, und der keine Verzeichnis Informationen enthalten darf.
  40. Eine Sicherheitsprüfung wird auf <code>$filename</code>
  41. durchgeführt. Das <code>$filename</code> Argument darf nur
  42. Alphanumerische Zeichen enthalten, Bindestriche ("-"), Unterstriche ("_")
  43. oder Punkte ("."). Das <code>$dirs</code> Argument hat keine dieser
  44. Einschränkungen.
  45. </para>
  46. <para>
  47. Das <code>$dirs</code> Argument definiert das Verzeichnis in welchem
  48. nach der Datei gesucht werden soll. Wenn der Wert <code>NULL</code> ist, wird
  49. nur anhand vom <code>include_path</code> gesucht. Wenn der Wert Zeichenkette
  50. oder ein Array ist, wird das definierte Verzeichnis oder
  51. die Verzeichnisse durchsucht, gefolgt vom <code>include_path</code>.
  52. </para>
  53. <para>
  54. Das <code>$once</code> Argument ist Boolean. Wenn es <code>TRUE</code>
  55. ist, verwendet <classname>Zend_Loader::loadFile()</classname> die PHP Funktion
  56. <ulink url="http://php.net/include"><code>include_once()</code></ulink>
  57. für das Laden der Datei, andernfalls wird die PHP Funktion
  58. <ulink url="http://php.net/include_once"><code>include()</code></ulink>
  59. verwendet.
  60. </para>
  61. </sect2>
  62. <sect2 id="zend.loader.load.class">
  63. <title>Klassen laden</title>
  64. <para>
  65. Die statische Methode <classname>Zend_Loader::loadClass($class, $dirs)</classname>
  66. lädt eine PHP Datei und prüft anschließend ob die Klasse existiert.
  67. </para>
  68. <example id="zend.loader.load.class.example">
  69. <title>Beispiel der loadClass() Methode</title>
  70. <programlisting role="php"><![CDATA[
  71. Zend_Loader::loadClass('Container_Tree',
  72. array(
  73. '/home/production/mylib',
  74. '/home/production/myapp'
  75. )
  76. );
  77. ]]></programlisting>
  78. </example>
  79. <para>
  80. Die Zeichenkette die die Klasse definiert, wird in einen relativen Pfad
  81. umgewandelt durch die Annahme das Verzeichnisse für das OS mit Unterstrichen
  82. getrennt werden und anfügen von '.php'. Im obigen Beispiel wird für Windows
  83. 'Container_Tree' zu 'Container/Tree.php'.
  84. </para>
  85. <para>
  86. Wenn <code>$dirs</code> eine Zeichenkette oder ein Array ist, durchsucht
  87. <classname>Zend_Loader::loadClass()</classname> die Verzeichnisse in der
  88. angegebenen Reihenfolge. Die erste passende Datei wird geladen. Wenn die
  89. Datei in den definierten Verzeichnissen <code>$dirs</code> nicht existiert
  90. wird der <code>include_path</code> der PHP Umgebung durchsucht.
  91. </para>
  92. <para>
  93. Wenn die Datei nicht gefunden wird, oder die Klasse nach dem Laden nicht
  94. existiert, wirft <classname>Zend_Loader::loadClass()</classname> eine <classname>Zend_Exception</classname>.
  95. </para>
  96. <para>
  97. <classname>Zend_Loader::loadFile()</classname> wird für das Laden verwendet, deswegen
  98. darf der Klassenname nur Alphanumerische Zeichen, den Bindestrich ('-'),
  99. den Unterstrich ('_') und den Punkt ('.') enthalten.
  100. </para>
  101. </sect2>
  102. <sect2 id="zend.loader.load.isreadable">
  103. <title>Testen ob eine Datei gelesen werden kann</title>
  104. <para>
  105. Die statische Methode <classname>Zend_Loader::isReadable($pathname)</classname>
  106. gibt <code>TRUE</code> zurück wenn eine Datei im angegebenen Pfadnamen
  107. existiert und lesbar ist, andernfalls <code>FALSE</code>.
  108. </para>
  109. <example id="zend.loader.load.isreadable.example">
  110. <title>Beispiel der isReadable() Methode</title>
  111. <programlisting role="php"><![CDATA[
  112. if (Zend_Loader::isReadable($filename)) {
  113. // Mach was mit $filename
  114. }
  115. ]]></programlisting>
  116. </example>
  117. <para>
  118. Das <code>$filename</code> Argument definiert den Dateinamen der
  119. geprüft werden soll. Er darf Pfadinformationen enthalten. Diese Methode
  120. ist ein Wrapper für die PHP Funktion
  121. <ulink url="http://php.net/is_readable"><code>is_readable()</code></ulink>.
  122. Diese PHP Funktion durchsucht den <code>include_path</code> nicht, wärend
  123. <classname>Zend_Loader::isReadable()</classname> dies macht.
  124. </para>
  125. </sect2>
  126. <sect2 id="zend.loader.load.autoload">
  127. <title>Verwenden von Autoloaders</title>
  128. <para>
  129. Die <classname>Zend_Loader</classname> Klasse enthält eine Methode die im PHP SPL Autoloader
  130. registriert werden kann. <classname>Zend_Loader::autoload()</classname> ist die
  131. Callback Methode. Als Vereinfachung bietet <classname>Zend_Loader</classname> die
  132. <code>registerAutoload()</code> Funktion welche die
  133. <code>autoload()</code> Methode registriert. Wenn die
  134. <code>spl_autoload</code> Erweiterung in der PHP Umgebung nicht
  135. vorhanden ist wird die <code>registerAutoload()</code> Methode eine
  136. <classname>Zend_Exception</classname> werfen.
  137. </para>
  138. <example id="zend.loader.load.autoload.example">
  139. <title>Beispiel für das registrieren der Autoloader Callback Methode</title>
  140. <programlisting role="php"><![CDATA[
  141. Zend_Loader::registerAutoload();
  142. ]]></programlisting>
  143. </example>
  144. <para>
  145. Nach dem registrieren des Zend Framework Autoload Callbacks, können
  146. die Klassen des Zend Frameworks referenziert werden ohne das sie
  147. explizit geladen werden müssen. Die <code>autoload()</code> Methode
  148. verwendet automatisch <classname>Zend_Loader::loadClass()</classname> wenn eine
  149. Klasse referenziert wird.
  150. </para>
  151. <para>
  152. Wenn die <classname>Zend_Loader</classname> Klasse erweitert wird, kann ein optionales Argument
  153. für <code>registerAutoload()</code> angegeben werden, um die Klasse zu
  154. definieren von welcher die <code>autoload()</code> Methode registriert
  155. werden soll.
  156. </para>
  157. <example id="zend.loader.load.autoload.example-extended">
  158. <title>
  159. Beispiel für das registrieren der Autoload Callback Methode von einer
  160. erweiterten Klasse
  161. </title>
  162. <para>
  163. Wegen der Semantik der Referenzen von statischen Funktionen in PHP,
  164. muß Code für beide <code>loadClass()</code> und <code>autoload()</code>
  165. implementiert werden, und <code>autoload()</code> muß <code>self::loadClass()</code>
  166. aufrufen. Wenn die <code>autoload()</code> Methode den Aufruf zu <code>self::loadClass()</code>
  167. an die Elternklasse delegiert, ruft Sie die Methode des Namens in der Elternklasse und nicht
  168. in der Subklasse auf.
  169. </para>
  170. <programlisting role="php"><![CDATA[
  171. class My_Loader extends Zend_Loader
  172. {
  173. public static function loadClass($class, $dirs = null)
  174. {
  175. parent::loadClass($class, $dirs);
  176. }
  177. public static function autoload($class)
  178. {
  179. try {
  180. self::loadClass($class);
  181. return $class;
  182. } catch (Exception $e) {
  183. return false;
  184. }
  185. }
  186. }
  187. Zend_Loader::registerAutoload('My_Loader');
  188. ]]></programlisting>
  189. </example>
  190. <para>
  191. Der Callback für den Autoloader kann entfernt werden. Die <code>registerAutoload()</code> Methode hat
  192. ein zweites optionales Argument welches standardmäßig <code>true</code> ist. Wenn dieses Argument
  193. <code>false</code> ist, wird die Registrierung des Callback des Autoloaders vom SPL Autoload Stack
  194. entfernt.
  195. </para>
  196. </sect2>
  197. </sect1>
  198. <!--
  199. vim:se ts=4 sw=4 et:
  200. -->