Zend_Registry.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15743 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.registry.using">
  5. <title>Die Registry verwenden</title>
  6. <para>
  7. Eine Registry ist ein Container für das Speichern von Objekten und Werten im
  8. Raum der Anwendung. Durch das Speichern der Werte in einer Registry steht das
  9. selbe Objekt immer innerhalb der kompletten Anwendung zur Verfügung.
  10. Dieser Mechanismus ist eine Alernative zur Verwendung eines Globalen Speichers.
  11. </para>
  12. <para>
  13. Die typische Methode um Registries mit dem Zend Framework zu verwenden ist durch die
  14. statischen Methoden in der <classname>Zend_Registry</classname> Klasse. Alternativ kann die
  15. Registry als Arrayobjekt verwendet werden, und so können Elemente welche darin gespeichert
  16. wurden durch ein gewöhnliches Array-artiges Interface verwendet werden.
  17. </para>
  18. <sect2 id="zend.registry.using.storing">
  19. <title>Werte in die Registry speichern</title>
  20. <para>
  21. Verwende die statische Methode <code>set()</code> um einen Eintrag in der Registry zu
  22. Speichern.
  23. </para>
  24. <example id="zend.registry.using.storing.example">
  25. <title>Beispiel der Verwendung der set() Methode</title>
  26. <programlisting language="php"><![CDATA[
  27. Zend_Registry::set('index', $value);
  28. ]]></programlisting>
  29. </example>
  30. <para>
  31. Der zurückgegebene Wert kann ein Objekt, ein Array oder ein Skalar sein.
  32. Der gespeicherte Wert in einem speziellen Eintrag der Registry
  33. kann durch den Aufruf der <code>set()</code> Methode verändert werden um
  34. den Eintrag auf einen neuen Wert zu setzen.
  35. </para>
  36. <para>
  37. Der Index kann ein Skalar (<constant>NULL</constant>, String oder Nummer),
  38. sowie ein gewöhnliches Array sein.
  39. </para>
  40. </sect2>
  41. <sect2 id="zend.registry.using.retrieving">
  42. <title>Werte aus der Registry lesen</title>
  43. <para>
  44. Um einen Eintrag von der Registry zu erhalten, kann die statische
  45. <code>get()</code> Methode verwendet werden.
  46. </para>
  47. <example id="zend.registry.using.retrieving.example">
  48. <title>Beispiel der Verwendung der get() Methode</title>
  49. <programlisting language="php"><![CDATA[
  50. $value = Zend_Registry::get('index');
  51. ]]></programlisting>
  52. </example>
  53. <para>
  54. Die <code>getInstance()</code> Methode gibt ein Singleton Registry Objekt zurück.
  55. Dieses Registry Objekt ist durchsuchbar, und erlaubt es auf alle in der Registry
  56. gespeicherten Werte einfach zuzugreifen.
  57. </para>
  58. <example id="zend.registry.using.retrieving.example-iterating">
  59. <title>Beispiel des Durchsuchens der Registry</title>
  60. <programlisting language="php"><![CDATA[
  61. $registry = Zend_Registry::getInstance();
  62. foreach ($registry as $index => $value) {
  63. echo "Registry Index $index enthält:\n";
  64. var_dump($value);
  65. }
  66. ]]></programlisting>
  67. </example>
  68. </sect2>
  69. <sect2 id="zend.registry.using.constructing">
  70. <title>Erstellen eines Registry Objektes</title>
  71. <para>
  72. Zusätzlich zur Verwendung der statischen Registry über die statischen Methoden,
  73. kann eine Instanz direkt erzeugt werden und als Objekt verwendet werden.
  74. </para>
  75. <para>
  76. Die Registry Instanz die durch die statischen Methoden verwendet wird,
  77. ist einfach eine solche Instanz. Es ist eine Vereinfachung die statisch
  78. gespeichert ist damit Sie von überall innerhalb einer Anwendung verwendet
  79. werden kann.
  80. </para>
  81. <para>
  82. Der traditionelle <code>new</code> Operator kann verwendet werden um
  83. <classname>Zend_Registry</classname> zu initiieren. Das Initiieren von
  84. <classname>Zend_Registry</classname> mit seinem Konstruktor initiiert auch die Einträge
  85. in der Registry einfach durch die Verwendung eines assoziativen Arrays als Argument.
  86. </para>
  87. <example id="zend.registry.using.constructing.example">
  88. <title>Beispiel für das Erstellen einer Registry</title>
  89. <programlisting language="php"><![CDATA[
  90. $registry = new Zend_Registry(array('index' => $value));
  91. ]]></programlisting>
  92. </example>
  93. <para>
  94. Sobald so ein <classname>Zend_Registry</classname> Objekt initiiert wurde, kann es durch
  95. den Aufruf irgendeiner Array Objektmethode verwendet werden, oder indem es als
  96. Singleton Instanz für <classname>Zend_Registry</classname> mit der statischen Methode
  97. <code>setInstance()</code> gesetzt wird.
  98. </para>
  99. <example id="zend.registry.using.constructing.example-setinstance">
  100. <title>Beispiel der Initialisierung der Singleton Registry</title>
  101. <programlisting language="php"><![CDATA[
  102. $registry = new Zend_Registry(array('index' => $value));
  103. Zend_Registry::setInstance($registry);
  104. ]]></programlisting>
  105. </example>
  106. <para>
  107. Die <code>setInstance()</code> Methode wirft eine <classname>Zend_Exception</classname>
  108. wenn die statische Registry bereits initialisiert wurde.
  109. </para>
  110. </sect2>
  111. <sect2 id="zend.registry.using.array-access">
  112. <title>Auf die Registry als Array zugreifen</title>
  113. <para>
  114. Wenn mehrere Werte gesetzt oder gelesen werden sollen, kann es einfacher
  115. sein auf die Registry in Array Schreibweise zuzugreifen.
  116. </para>
  117. <example id="zend.registry.using.array-access.example">
  118. <title>Beispiel eines Array-zugriffs</title>
  119. <programlisting language="php"><![CDATA[
  120. $registry = Zend_Registry::getInstance();
  121. $registry['index'] = $value;
  122. var_dump( $registry['index'] );
  123. ]]></programlisting>
  124. </example>
  125. </sect2>
  126. <sect2 id="zend.registry.using.array-object">
  127. <title>Zugriff auf die Registry als Objekt</title>
  128. <para>
  129. Manchmal ist es einfacher auf die Registry in einer Objekt-Orientierten
  130. Art und Weise zuzugreifen, durch Verwendung von Indexnamen als Objekt Eigenschaften.
  131. Man muß das Registry Objekt mit der <code>ArrayObject::ARRAY_AS_PROPS</code>
  132. Option erstellen und die statische Instanz initialisieren um diese Funktionalität
  133. einzuschalten.
  134. <note>
  135. <para>
  136. Man muß die <code>ArrayObject::ARRAY_AS_PROPS</code> Option setzen
  137. <emphasis>bevor</emphasis> auf die statische Registry das erste Mal
  138. zugegriffen wird.
  139. </para>
  140. </note>
  141. </para>
  142. <warning>
  143. <title>Bekannte Probleme mit der ArrayObject::ARRAY_AS_PROPS Option</title>
  144. <para>
  145. Einige Versionen von PHP sind bekanntermaßen sehr fehlerhaft wenn die Registry mit
  146. der <code>ArrayObject::ARRAY_AS_PROPS</code> Option verwendet wird.
  147. </para>
  148. </warning>
  149. <example id="zend.registry.using.array-object.example">
  150. <title>Beispiel eines Objektzugriffs</title>
  151. <programlisting language="php"><![CDATA[
  152. // In der Anwendungs Bootstrap Datei:
  153. $registry = new Zend_Registry(array(), ArrayObject::ARRAY_AS_PROPS)
  154. Zend_Registry::setInstance($registry);
  155. $registry->tree = 'Apfel';
  156. .
  157. .
  158. .
  159. // In einer anderen Funktion, irgendwo in der Anwendung:
  160. $registry = Zend_Registry::getInstance();
  161. echo $registry->tree; // Gibt "Apfel" aus
  162. $registry->index = $value;
  163. var_dump($registry->index);
  164. ]]></programlisting>
  165. </example>
  166. </sect2>
  167. <sect2 id="zend.registry.using.isset">
  168. <title>Abfragen ob ein Index existiert</title>
  169. <para>
  170. Um herauszufinden ob ein bestimmter Index in der Registry gesetzt wurde,
  171. kann die statische Methode <code>isRegistered()</code> verwendet werden.
  172. </para>
  173. <example id="zend.registry.using.isset.example-isregistered">
  174. <title>Beispiel der Verwendung der isRegistered() Methode</title>
  175. <programlisting language="php"><![CDATA[
  176. if (Zend_Registry::isRegistered($index)) {
  177. $value = Zend_Registry::get($index);
  178. }
  179. ]]></programlisting>
  180. </example>
  181. <para>
  182. Um herauszufinden ob ein bestimmter Index in einem Registry Array oder Objekt
  183. einen Wert hat kann die <code>isset()</code> Methode verwendet werden, wie bei einem
  184. gewöhnlichen Array.
  185. </para>
  186. <example id="zend.registry.using.isset.example-isset">
  187. <title>Beispiel der Verwendung der isset() Methode</title>
  188. <programlisting language="php"><![CDATA[
  189. $registry = Zend_Registry::getInstance();
  190. // Verwendung der Array Syntax
  191. if (isset($registry['index'])) {
  192. var_dump( $registry['index'] );
  193. }
  194. // Verwendung der Objekt Syntax
  195. if (isset($registry->index)) {
  196. var_dump( $registry->index );
  197. }
  198. ]]></programlisting>
  199. </example>
  200. </sect2>
  201. <sect2 id="zend.registry.using.subclassing">
  202. <title>Erweitern der Registry</title>
  203. <para>
  204. Die statische Registry ist eine Instanz der Klasse <classname>Zend_Registry</classname>.
  205. Wenn Funktionalität zur Registry hinzugefügt werden soll, sollte eine Klasse
  206. erstellt werden die <classname>Zend_Registry</classname> erweitert und dann kann diese
  207. spezielle Klasse definiert werden um das Singleton in der statische Registry zu
  208. initiieren. Die statische Methode <code>setClassName()</code> kann verwendet
  209. werden um die Klasse zu definieren.
  210. <note>
  211. <para>
  212. Diese Klasse muß eine Unterklasse von <classname>Zend_Registry</classname> sein.
  213. </para>
  214. </note>
  215. </para>
  216. <example id="zend.registry.using.subclassing.example">
  217. <title>Beispiel des Definierens des Singleton Registry Klassennamens</title>
  218. <programlisting language="php"><![CDATA[
  219. Zend_Registry::setClassName('Meine_Registry');
  220. Zend_Registry::set('index', $value);
  221. ]]></programlisting>
  222. </example>
  223. <para>
  224. Die Registry wirft eine <classname>Zend_Exception</classname> wenn man versucht den
  225. Klassennamen zu setzen nachdem die Registry das erste Mal verwendet wurde. Es ist
  226. deshalb notwendig den Klassennamen für die statische Registry in der Bootstrap
  227. Datei der Anwendung zu definieren.
  228. </para>
  229. </sect2>
  230. <sect2 id="zend.registry.using.unsetting">
  231. <title>Entfernen der statischen Registry</title>
  232. <para>
  233. Obwohl es normalerweise nicht notwendig ist, kann die Singleton Instanz
  234. der Registry entfernt werden. Die statische Methode
  235. <code>_unsetInstance()</code> verwendet werden, um das zu tun.
  236. </para>
  237. <warning>
  238. <title>Risiko des Datenverlustes</title>
  239. <para>
  240. Wenn <code>_unsetInstance()</code> verwendet wird,
  241. werden alle Daten in der statischen Registry verworfen und können
  242. nicht wiederhergestellt werden.
  243. </para>
  244. </warning>
  245. <para>
  246. Diese Methode kann zum Beispiel verwendet werden, wenn
  247. <code>setInstance()</code> oder <code>setClassName()</code> nach der
  248. Initialisierung des Singleton Registry Objektes verwendet werden soll.
  249. Entfernen der Singleton Instanz erlaubt die Benutzung dieser Methoden
  250. selbst nachdem das Singleton Registry Objekt gesetzt wurde. Die Verwendung
  251. von <classname>Zend_Registry</classname> auf diese Weise ist für typische Anwendungen
  252. und Umgebungen nicht empfohlen.
  253. </para>
  254. <example id="zend.registry.using.unsetting.example">
  255. <title>Beispiel der Verwendung der _unsetInstance() Methode</title>
  256. <programlisting language="php"><![CDATA[
  257. Zend_Registry::set('index', $value);
  258. Zend_Registry::_unsetInstance();
  259. // Ändern der Klasse
  260. Zend_Registry::setClassName('Meine_Registry');
  261. Zend_Registry::set('index', $value);
  262. ]]></programlisting>
  263. </example>
  264. </sect2>
  265. </sect1>
  266. <!--
  267. vim:se ts=4 sw=4 et:
  268. -->