Zend_Loader.xml 10 KB

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