Zend_Loader.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 21818 -->
  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 <acronym>PHP</acronym> 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. <acronym>PHP</acronym> Datei. Die geladene Datei kann jeden <acronym>PHP</acronym> Code
  27. enthalten. Diese Methode ist ein Wrapper für die <acronym>PHP</acronym> Funktion
  28. <ulink url="http://php.net/include"><methodname>include()</methodname></ulink>.
  29. Diese Methode gibt bei einem Fehler ein boosches <constant>FALSE</constant> 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
  57. <acronym>PHP</acronym> Funktion <ulink
  58. url="http://php.net/include"><methodname>include_once()</methodname></ulink>
  59. für das Laden der Datei, andernfalls wird die <acronym>PHP</acronym> Funktion
  60. <ulink url="http://php.net/include_once"><methodname>include()</methodname></ulink>
  61. verwendet.
  62. </para>
  63. </sect2>
  64. <sect2 id="zend.loader.load.class">
  65. <title>Klassen laden</title>
  66. <para>
  67. Die statische Methode <methodname>Zend_Loader::loadClass($class, $dirs)</methodname>
  68. lädt eine <acronym>PHP</acronym> Datei und prüft anschließend ob die Klasse existiert.
  69. </para>
  70. <example id="zend.loader.load.class.example">
  71. <title>Beispiel der loadClass() Methode</title>
  72. <programlisting language="php"><![CDATA[
  73. Zend_Loader::loadClass('Container_Tree',
  74. array(
  75. '/home/production/mylib',
  76. '/home/production/myapp'
  77. )
  78. );
  79. ]]></programlisting>
  80. </example>
  81. <para>
  82. Die Zeichenkette welche die Klasse definiert, wird in einen relativen Pfad
  83. umgewandelt durch die Annahme das Verzeichnisse für das OS mit Unterstrichen
  84. getrennt werden und anfügen von '.php'. Im obigen Beispiel wird für Windows
  85. 'Container_Tree' zu 'Container\\Tree.php'.
  86. </para>
  87. <para>
  88. Wenn <varname>$dirs</varname> eine Zeichenkette oder ein Array ist, durchsucht
  89. <methodname>Zend_Loader::loadClass()</methodname> die Verzeichnisse in der
  90. angegebenen Reihenfolge. Die erste passende Datei wird geladen. Wenn die
  91. Datei in den definierten Verzeichnissen <varname>$dirs</varname> nicht existiert
  92. wird der <code>include_path</code> der <acronym>PHP</acronym> Umgebung durchsucht.
  93. </para>
  94. <para>
  95. Wenn die Datei nicht gefunden wird, oder die Klasse nach dem Laden nicht
  96. existiert, wirft <methodname>Zend_Loader::loadClass()</methodname> eine
  97. <classname>Zend_Exception</classname>.
  98. </para>
  99. <para>
  100. <methodname>Zend_Loader::loadFile()</methodname> wird für das Laden verwendet, deswegen
  101. darf der Klassenname nur Alphanumerische Zeichen, den Bindestrich ('-'),
  102. den Unterstrich ('_') und den Punkt ('.') enthalten.
  103. </para>
  104. <note>
  105. <title>Klassen von PHP Namespaces laden</title>
  106. <para>
  107. Beginnend mit Version 1.10.0 erlaubt Zend Framework das Laden von Klassen aus
  108. <acronym>PHP</acronym> Namespaces. Diese Unterstützung folgt den gleichen
  109. Richtlinien und Implementationen wie Sie in der <ulink
  110. url="http://groups.google.com/group/php-standards/web/psr-0-final-proposal">PHP
  111. Framework Interop Group PSR-0</ulink> Referenz Implementation gefunden werden
  112. können.
  113. </para>
  114. <para>
  115. Mit dieser Richtlinie werden die folgenden Regeln angewandt:
  116. </para>
  117. <itemizedlist>
  118. <listitem>
  119. <para>
  120. Jeder Separator für Namespaces wird zu einem
  121. <constant>DIRECTORY_SEPARATOR</constant> konvertiert wenn er vom Dateisystem
  122. geladen wird.
  123. </para>
  124. </listitem>
  125. <listitem>
  126. <para>
  127. Jedes "_" Zeichen im <emphasis>CLASS NAME</emphasis> wird zu einem
  128. <constant>DIRECTORY_SEPARATOR</constant> konvertiert. Das "_" Zeichen hat
  129. keine spezielle Bedeutung im Namespace.
  130. </para>
  131. </listitem>
  132. <listitem>
  133. <para>
  134. Dem voll-qualifizierte Namespace und der Klasse wird ".php" angehängt wenn
  135. Sie vom Dateisystem geladen werden.
  136. </para>
  137. </listitem>
  138. </itemizedlist>
  139. <para>
  140. Als Beispiel:
  141. </para>
  142. <itemizedlist>
  143. <listitem>
  144. <para>
  145. <classname>\Doctrine\Common\IsolatedClassLoader</classname> =&gt;
  146. <filename>/path/to/project/lib/vendor/Doctrine/Common/IsolatedClassLoader.php</filename>
  147. </para>
  148. </listitem>
  149. <listitem>
  150. <para>
  151. <classname>\namespace\package\Class_Name</classname> =&gt;
  152. <filename>/path/to/project/lib/vendor/namespace/package/Class/Name.php</filename>
  153. </para>
  154. </listitem>
  155. <listitem>
  156. <para>
  157. <classname>\namespace\package_name\Class_Name</classname> =&gt;
  158. <filename>/path/to/project/lib/vendor/namespace/package_name/Class/Name.php</filename>
  159. </para>
  160. </listitem>
  161. </itemizedlist>
  162. </note>
  163. </sect2>
  164. <sect2 id="zend.loader.load.isreadable">
  165. <title>Testen ob eine Datei gelesen werden kann</title>
  166. <para>
  167. Die statische Methode <methodname>Zend_Loader::isReadable($pathname)</methodname>
  168. gibt <constant>TRUE</constant> zurück wenn eine Datei im angegebenen Pfadnamen
  169. existiert und lesbar ist, andernfalls <constant>FALSE</constant>.
  170. </para>
  171. <example id="zend.loader.load.isreadable.example">
  172. <title>Beispiel der isReadable() Methode</title>
  173. <programlisting language="php"><![CDATA[
  174. if (Zend_Loader::isReadable($filename)) {
  175. // Mach was mit $filename
  176. }
  177. ]]></programlisting>
  178. </example>
  179. <para>
  180. Das <varname>$filename</varname> Argument definiert den Dateinamen der
  181. geprüft werden soll. Er darf Pfadinformationen enthalten. Diese Methode
  182. ist ein Wrapper für die <acronym>PHP</acronym> Funktion
  183. <ulink url="http://php.net/is_readable"><methodname>is_readable()</methodname></ulink>.
  184. Diese <acronym>PHP</acronym> Funktion durchsucht den <code>include_path</code> nicht,
  185. wärend <methodname>Zend_Loader::isReadable()</methodname> dies macht.
  186. </para>
  187. </sect2>
  188. <sect2 id="zend.loader.load.autoload">
  189. <title>Verwenden von Autoloaders</title>
  190. <para>
  191. Die <classname>Zend_Loader</classname> Klasse enthält eine Methode die im
  192. <acronym>PHP</acronym> SPL Autoloader registriert werden kann.
  193. <methodname>Zend_Loader::autoload()</methodname> ist die Callback Methode. Als
  194. Vereinfachung bietet <classname>Zend_Loader</classname> die
  195. <methodname>registerAutoload()</methodname> Funktion welche die
  196. <methodname>autoload()</methodname> Methode registriert. Wenn die
  197. <code>spl_autoload</code> Erweiterung in der <acronym>PHP</acronym> Umgebung nicht
  198. vorhanden ist wird die <methodname>registerAutoload()</methodname> Methode eine
  199. <classname>Zend_Exception</classname> werfen.
  200. </para>
  201. <example id="zend.loader.load.autoload.example">
  202. <title>Beispiel für das registrieren der Autoloader Callback Methode</title>
  203. <programlisting language="php"><![CDATA[
  204. Zend_Loader::registerAutoload();
  205. ]]></programlisting>
  206. </example>
  207. <para>
  208. Nach dem registrieren des Zend Framework Autoload Callbacks, können
  209. die Klassen des Zend Frameworks referenziert werden ohne das sie
  210. explizit geladen werden müssen. Die <methodname>autoload()</methodname> Methode
  211. verwendet automatisch <methodname>Zend_Loader::loadClass()</methodname> wenn eine
  212. Klasse referenziert wird.
  213. </para>
  214. <para>
  215. Wenn die <classname>Zend_Loader</classname> Klasse erweitert wird, kann ein optionales
  216. Argument für <methodname>registerAutoload()</methodname> angegeben werden, um die Klasse
  217. zu definieren von welcher die <methodname>autoload()</methodname> Methode registriert
  218. werden soll.
  219. </para>
  220. <example id="zend.loader.load.autoload.example-extended">
  221. <title>
  222. Beispiel für das registrieren der Autoload Callback Methode von einer
  223. erweiterten Klasse
  224. </title>
  225. <para>
  226. Wegen der Semantik der Referenzen von statischen Funktionen in
  227. <acronym>PHP</acronym>, muß Code für beide <methodname>loadClass()</methodname> und
  228. <methodname>autoload()</methodname> implementiert werden, und
  229. <methodname>autoload()</methodname> muß <methodname>self::loadClass()</methodname>
  230. aufrufen. Wenn die <methodname>autoload()</methodname> Methode den Aufruf zu
  231. <methodname>self::loadClass()</methodname> an die Elternklasse delegiert, ruft Sie
  232. die Methode des Namens in der Elternklasse und nicht in der Subklasse auf.
  233. </para>
  234. <programlisting language="php"><![CDATA[
  235. class My_Loader extends Zend_Loader
  236. {
  237. public static function loadClass($class, $dirs = null)
  238. {
  239. parent::loadClass($class, $dirs);
  240. }
  241. public static function autoload($class)
  242. {
  243. try {
  244. self::loadClass($class);
  245. return $class;
  246. } catch (Exception $e) {
  247. return false;
  248. }
  249. }
  250. }
  251. Zend_Loader::registerAutoload('My_Loader');
  252. ]]></programlisting>
  253. </example>
  254. <para>
  255. Der Callback für den Autoloader kann entfernt werden. Die
  256. <methodname>registerAutoload()</methodname> Methode hat ein zweites optionales Argument
  257. welches standardmäßig <constant>TRUE</constant> ist. Wenn dieses Argument
  258. <constant>FALSE</constant> ist, wird die Registrierung des Callback des Autoloaders vom
  259. SPL Autoload Stack entfernt.
  260. </para>
  261. </sect2>
  262. </sect1>