Zend_Application-Examples.xml 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: 22741 -->
  4. <sect1 id="zend.application.examples">
  5. <title>Beispiele</title>
  6. <para>
  7. Die Klasse Bootstrap selbst wird typischerweise sehr minimal sein; oft wird sie einfach
  8. nur ein leerer Stub sein, der die Basis Bootstrapping-Klasse erweitert:
  9. </para>
  10. <programlisting language="php"><![CDATA[
  11. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  12. {
  13. }
  14. ]]></programlisting>
  15. <para>
  16. Mit einer entsprechenden Konfigurationsdatei:
  17. </para>
  18. <programlisting language="ini"><![CDATA[
  19. ; APPLICATION_PATH/configs/application.ini
  20. [production]
  21. autoloaderNamespaces[] = "My_"
  22. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  23. bootstrap.class = "Bootstrap"
  24. pluginpaths.My_Bootstrap_Resource = "My/Bootstrap/Resource"
  25. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  26. [testing: production]
  27. [development : production]
  28. ]]></programlisting>
  29. <note>
  30. <title>Namespaces für Autoloader</title>
  31. <para>
  32. Weil diese Beispiele eigenen Code verwenden, müssen wir die Präfixe der Namespaces
  33. für diesen Code in unserer Konfiguration registrieren; dies wird mit dem
  34. Konfigurationsschlüssel <property>autoloaderNamespaces</property> getan, welcher ein
  35. Array ist.
  36. </para>
  37. <para>
  38. Um zusätzlich sicherzustellen, dass eigene Plugin-Ressourcen erkannt werden, müssen wir
  39. einen Plugin-Präfixpfad in der Bootstrap registrieren. Das wird mit dem
  40. Konfigurationsschlüssel <property>pluginpaths</property> getan, welcher ein assoziatives
  41. Array ist, mit Schlüsseln, die das zu verwendenden Präfix kennzeichnen, und Werten,
  42. welche den Pfad enthalten, der diesem Präfix entspricht.
  43. </para>
  44. </note>
  45. <para>
  46. Sollten trotzdem eigene Initialisierungen notwendig sein, hat man zwei Möglichkeiten.
  47. Erstens kann man Methoden schreiben, die mit <emphasis>_init</emphasis> anfangen, um eigenen
  48. Code zu spezifizieren, der für das Bootstrapping verwendet werden soll. Diese Methoden
  49. werden durch <methodname>bootstrap()</methodname> aufgerufen, und können genauso aufgerufen
  50. werden, wie wenn sie öffentliche Methoden wären:
  51. <emphasis>bootstrap&lt;resource&gt;()</emphasis>. Sie sollten ein optionales Array an
  52. Optionen akzeptieren.
  53. </para>
  54. <para>
  55. Wenn die eigene Ressource-Methode einen Wert zurückgibt, wird diese in einem Container
  56. im Bootstrap gespeichert. Das kann nützlich sein, wenn verschiedene Ressourcen interagieren
  57. müssen (wie wenn eine Ressource sich selbst in eine andere iniziiert). Die Methode
  58. <methodname>getResource()</methodname> kann dann verwendet werden, um diese Werte zu
  59. erhalten.
  60. </para>
  61. <para>
  62. Das Beispiel unten zeigt eine Ressource-Methode für die Initialisierung des Anfrage-Objekts.
  63. Es verwendet die Erkennung der Abhängigkeit (diese hängt von der Ressource FrontController
  64. ab), holt eine Ressource vom Bootstrap, und gibt einen Wert zurück, um ihn im
  65. Bootstrap zu speichern.
  66. </para>
  67. <programlisting language="php"><![CDATA[
  68. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  69. {
  70. protected function _initRequest()
  71. {
  72. // Sicherstellen, dass eine FrontController-Instanz vorhanden ist
  73. // und diese holen
  74. $this->bootstrap('FrontController');
  75. $front = $this->getResource('FrontController');
  76. // Das Anfrage-Objekt initialisieren
  77. $request = new Zend_Controller_Request_Http();
  78. $request->setBaseUrl('/foo');
  79. // Sie dem FrontController hinzufügen
  80. $front->setRequest($request);
  81. // Bootstrap speichert den Wert im 'request' Schlüssel
  82. // seines Containers
  83. return $request;
  84. }
  85. }
  86. ]]></programlisting>
  87. <para>
  88. Man beachte in diesem Beispiel den Aufruf von <methodname>bootstrap()</methodname>; dieser
  89. stellt sicher, dass der FrontController initialisiert wurde, bevor die Methode aufgerufen
  90. wird. Dieser Aufruf kann entweder eine Ressource oder eine andere Methode in der Klasse
  91. auslösen.
  92. </para>
  93. <para>
  94. Die andere Option ist, die Verwendung eines Ressource-Plugins. Ressource-Plugins sind
  95. Objekte, die spezielle Initialisierungen ausführen, und die wie folgt spezifiziert werden
  96. können:
  97. </para>
  98. <itemizedlist>
  99. <listitem>
  100. <para>
  101. Während der Instanzierung des Objekts <classname>Zend_Application</classname>
  102. </para>
  103. </listitem>
  104. <listitem>
  105. <para>
  106. Während der Initialisierung des Objekts Bootstrap
  107. </para>
  108. </listitem>
  109. <listitem>
  110. <para>
  111. Durch explizites Einschalten über Methodenaufrufe auf dem Objekt Bootstrap
  112. </para>
  113. </listitem>
  114. </itemizedlist>
  115. <para>
  116. Ressource-Plugins implementieren
  117. <classname>Zend_Application_Resource_ResourceAbstract</classname>, welche einfach
  118. definieren, dass sie Injektion des Aufrufers und von Optionen erlauben, und die eine
  119. <methodname>init()</methodname> Methode haben. Als Beispiel, könnte eine eigene
  120. "View"-Bootstrap-Ressource wie folgt aussehen:
  121. </para>
  122. <programlisting language="php"><![CDATA[
  123. class My_Bootstrap_Resource_View
  124. extends Zend_Application_Resource_ResourceAbstract
  125. {
  126. public function init()
  127. {
  128. $view = new Zend_View($this->_getOptions());
  129. Zend_Dojo::enableView($view);
  130. $view->doctype('XHTML1_STRICT');
  131. $view->headTitle()->setSeparator(' - ')->append('Meine Site');
  132. $view->headMeta()->appendHttpEquiv('Content-Type',
  133. 'text/html; charset=utf-8');
  134. $view->dojo()->setDjConfigOption('parseOnLoad', true)
  135. ->setLocalPath('/js/dojo/dojo.js')
  136. ->registerModulePath('../spindle', 'spindle')
  137. ->addStylesheetModule('spindle.themes.spindle')
  138. ->requireModule('spindle.main')
  139. ->disable();
  140. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
  141. 'ViewRenderer'
  142. );
  143. $viewRenderer->setView($view);
  144. return $view;
  145. }
  146. }
  147. ]]></programlisting>
  148. <para>
  149. Um der Bootstrap zu sagen, dass sie das verwenden soll, würde man entweder den Klassennamen
  150. des Ressource-Plugins übergeben müssen, oder eine Kombination eines Plugin Loader
  151. Präfixpfades und den Kurznamen des Ressource-Plugins (z.B. "view"):
  152. </para>
  153. <programlisting language="php"><![CDATA[
  154. $application = new Zend_Application(
  155. APPLICATION_ENV,
  156. array(
  157. 'resources' => array(
  158. 'My_Bootstrap_Resource_View' => array(), // kompletter Klassenname
  159. 'view', // ODER Kurzname
  160. 'FrontController' => array(
  161. 'controllerDirectory' => APPLICATION_PATH . '/controllers',
  162. ),
  163. ),
  164. // Für Kurznamen, definiere die Plugin Pfade:
  165. 'pluginPaths = array(
  166. 'My_Bootstrap_Resource' => 'My/Bootstrap/Resource',
  167. )
  168. )
  169. );
  170. ]]></programlisting>
  171. <para>
  172. Ressource-Plugins können andere Ressourcen und Initialisierungen aufrufen, indem sie auf den
  173. Eltern-Bootstrap zugreifen:
  174. </para>
  175. <programlisting language="php"><![CDATA[
  176. class My_Bootstrap_Resource_Layout
  177. extends Zend_Application_Resource_ResourceAbstract
  178. {
  179. public function init()
  180. {
  181. // Sicherstellen, dass die View initialisiert ist...
  182. $this->getBootstrap()->bootstrap('view');
  183. // Das View-Objekt erhalten
  184. $view = $this->getBootstrap()->getResource('view');
  185. // ...
  186. }
  187. }
  188. ]]></programlisting>
  189. <para>
  190. Bei normaler Verwendung würde man die Anwendung instanzieren, sie bootstrappen, und
  191. anschließend ausführen:
  192. </para>
  193. <programlisting language="php"><![CDATA[
  194. $application = new Zend_Application(...);
  195. $application->bootstrap()
  196. ->run();
  197. ]]></programlisting>
  198. <para>
  199. Für ein eigenes Skript müsste man einfach spezifische Ressourcen initialisieren:
  200. </para>
  201. <programlisting language="php"><![CDATA[
  202. $application = new Zend_Application(...);
  203. $application->getBootstrap('db');
  204. $service = new Zend_XmlRpc_Server();
  205. $service->setClass('Foo'); // Verwende die Datenbank...
  206. echo $service->handle();
  207. ]]></programlisting>
  208. <para>
  209. Statt der Verwendung der Methode <methodname>bootstrap()</methodname>, um interne Methoden
  210. oder Ressourcen aufzurufen, kann man auch Überladung verwenden:
  211. </para>
  212. <programlisting language="php"><![CDATA[
  213. $application = new Zend_Application(...);
  214. $application->getBootstrapDb();
  215. ]]></programlisting>
  216. </sect1>