Zend_Loader.xml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 16364 -->
  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
  13. Dateiname 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>
  17. gegenüber 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 language="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 <constant>NULL</constant> 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 <constant>TRUE</constant>
  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 language="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
  95. <classname>Zend_Exception</classname>.
  96. </para>
  97. <para>
  98. <classname>Zend_Loader::loadFile()</classname> wird für das Laden verwendet, deswegen
  99. darf der Klassenname nur Alphanumerische Zeichen, den Bindestrich ('-'),
  100. den Unterstrich ('_') und den Punkt ('.') enthalten.
  101. </para>
  102. </sect2>
  103. <sect2 id="zend.loader.load.isreadable">
  104. <title>Testen ob eine Datei gelesen werden kann</title>
  105. <para>
  106. Die statische Methode <classname>Zend_Loader::isReadable($pathname)</classname>
  107. gibt <constant>TRUE</constant> zurück wenn eine Datei im angegebenen Pfadnamen
  108. existiert und lesbar ist, andernfalls <constant>FALSE</constant>.
  109. </para>
  110. <example id="zend.loader.load.isreadable.example">
  111. <title>Beispiel der isReadable() Methode</title>
  112. <programlisting language="php"><![CDATA[
  113. if (Zend_Loader::isReadable($filename)) {
  114. // Mach was mit $filename
  115. }
  116. ]]></programlisting>
  117. </example>
  118. <para>
  119. Das <code>$filename</code> Argument definiert den Dateinamen der
  120. geprüft werden soll. Er darf Pfadinformationen enthalten. Diese Methode
  121. ist ein Wrapper für die PHP Funktion
  122. <ulink url="http://php.net/is_readable"><code>is_readable()</code></ulink>.
  123. Diese PHP Funktion durchsucht den <code>include_path</code> nicht, wärend
  124. <classname>Zend_Loader::isReadable()</classname> dies macht.
  125. </para>
  126. </sect2>
  127. <sect2 id="zend.loader.load.autoload">
  128. <title>Verwenden von Autoloaders</title>
  129. <para>
  130. Die <classname>Zend_Loader</classname> Klasse enthält eine Methode die im PHP SPL
  131. Autoloader registriert werden kann. <classname>Zend_Loader::autoload()</classname> ist
  132. die Callback Methode. Als Vereinfachung bietet <classname>Zend_Loader</classname> die
  133. <code>registerAutoload()</code> Funktion welche die
  134. <code>autoload()</code> Methode registriert. Wenn die
  135. <code>spl_autoload</code> Erweiterung in der PHP Umgebung nicht
  136. vorhanden ist wird die <code>registerAutoload()</code> Methode eine
  137. <classname>Zend_Exception</classname> werfen.
  138. </para>
  139. <example id="zend.loader.load.autoload.example">
  140. <title>Beispiel für das registrieren der Autoloader Callback Methode</title>
  141. <programlisting language="php"><![CDATA[
  142. Zend_Loader::registerAutoload();
  143. ]]></programlisting>
  144. </example>
  145. <para>
  146. Nach dem registrieren des Zend Framework Autoload Callbacks, können
  147. die Klassen des Zend Frameworks referenziert werden ohne das sie
  148. explizit geladen werden müssen. Die <code>autoload()</code> Methode
  149. verwendet automatisch <classname>Zend_Loader::loadClass()</classname> wenn eine
  150. Klasse referenziert wird.
  151. </para>
  152. <para>
  153. Wenn die <classname>Zend_Loader</classname> Klasse erweitert wird, kann ein optionales
  154. Argument für <code>registerAutoload()</code> angegeben werden, um die Klasse zu
  155. definieren von welcher die <code>autoload()</code> Methode registriert
  156. werden soll.
  157. </para>
  158. <example id="zend.loader.load.autoload.example-extended">
  159. <title>
  160. Beispiel für das registrieren der Autoload Callback Methode von einer
  161. erweiterten Klasse
  162. </title>
  163. <para>
  164. Wegen der Semantik der Referenzen von statischen Funktionen in PHP,
  165. muß Code für beide <code>loadClass()</code> und <code>autoload()</code>
  166. implementiert werden, und <code>autoload()</code> muß <code>self::loadClass()</code>
  167. aufrufen. Wenn die <code>autoload()</code> Methode den Aufruf zu
  168. <code>self::loadClass()</code> an die Elternklasse delegiert, ruft Sie die Methode
  169. des Namens in der Elternklasse und nicht in der Subklasse auf.
  170. </para>
  171. <programlisting language="php"><![CDATA[
  172. class My_Loader extends Zend_Loader
  173. {
  174. public static function loadClass($class, $dirs = null)
  175. {
  176. parent::loadClass($class, $dirs);
  177. }
  178. public static function autoload($class)
  179. {
  180. try {
  181. self::loadClass($class);
  182. return $class;
  183. } catch (Exception $e) {
  184. return false;
  185. }
  186. }
  187. }
  188. Zend_Loader::registerAutoload('My_Loader');
  189. ]]></programlisting>
  190. </example>
  191. <para>
  192. Der Callback für den Autoloader kann entfernt werden. Die
  193. <code>registerAutoload()</code> Methode hat ein zweites optionales Argument welches
  194. standardmäßig <constant>TRUE</constant> ist. Wenn dieses Argument <constant>FALSE</constant> ist, wird
  195. die Registrierung des Callback des Autoloaders vom SPL Autoload Stack entfernt.
  196. </para>
  197. </sect2>
  198. </sect1>
  199. <!--
  200. vim:se ts=4 sw=4 et:
  201. -->