Zend_Controller-Modular.xml 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15713 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.controller.modular">
  5. <title>Eine konventionelle modulare Verzeichnis Struktur verwenden</title>
  6. <sect2 id="zend.controller.modular.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. Eine konventionelle modulare Verzeichnisstruktur erlaubt es verschiedene MVC Anwendungen
  10. in selbst-enthaltene Einheiten zu teilen, und diese mit verschiedenen Front Kontrollern
  11. wiederzuverwenden. Um so eine Verzeichnisstruktur zu zeigen:
  12. </para>
  13. <programlisting language="txt"><![CDATA[
  14. docroot/
  15. index.php
  16. application/
  17. default/
  18. controllers/
  19. IndexController.php
  20. FooController.php
  21. models/
  22. views/
  23. scripts/
  24. index/
  25. foo/
  26. helpers/
  27. filters/
  28. blog/
  29. controllers/
  30. IndexController.php
  31. models/
  32. views/
  33. scripts/
  34. index/
  35. helpers/
  36. filters/
  37. news/
  38. controllers/
  39. IndexController.php
  40. ListController.php
  41. models/
  42. views/
  43. scripts/
  44. index/
  45. list/
  46. helpers/
  47. filters/
  48. ]]></programlisting>
  49. <para>
  50. In diesem Paradigma arbeitet der Modulname als Prefix für den Kontroller den er enthält.
  51. Das obige Beispiel enthält drei Modul Kontroller, 'Blog_IndexController',
  52. 'News_IndexController', und 'News_ListController'. Zwei gloale Kontroller,
  53. 'IndexController' und 'FooController' werden auch definiert; keiner von diesen ist in
  54. einem Namensraum. Diese Verzeichnisstruktur wird für die Beispiele in diesem Kapitel
  55. verwendet.
  56. </para>
  57. <note>
  58. <title>Keine Verwendung von Namensräumen im Standard Modul</title>
  59. <para>
  60. Es ist zu beachten das Kontroller, im Standardmodul, keinen Prefix für den
  61. Namensraum benötigen. Deshalb benötigt der Kontroller, im obigen Beispiel, den
  62. Prefix 'Default_' nicht -- sie werden einfach dispatched gemäß dem Namen des Basis
  63. Kontrollers: 'IndexController' und 'FooController'. Ein Prefix für den Namensraum
  64. wird trotzdem in allen anderen Modulen verwendet.
  65. </para>
  66. </note>
  67. <para>
  68. Also, wie kann solch ein Verzeichnislayout mit den MVC Komponenten des Zend Frameworks
  69. implementiert werden?
  70. </para>
  71. </sect2>
  72. <sect2 id="zend.controller.modular.directories">
  73. <title>Verzeichnisse für Modul Kontroller spezifizieren</title>
  74. <para>
  75. Der erste Schritt um Module zu verwenden ist es, die Art der Spezifizierung der
  76. Kontroller Verzeichnis Liste im Front Kontroller, zu Ändern. In der grundsätzlichen MVC
  77. Serie, kann entweder ein Array oder ein String an <code>setControllerDirectory()</code>,
  78. oder ein Pfad an <code>addControllerDirectory()</code> übergeben werden. Wenn Module
  79. verwendet werden, müssen die Aufrufe dieser Methoden leicht geändert werden.
  80. </para>
  81. <para>
  82. Mit <code>setControllerDirectory()</code>, muß ein assoziatives Array übergeben und
  83. Schlüssel/Werte Paare von Modul Namen/Verzeichnis Pfaden übergeben werden. Der spezielle
  84. Schlüssel <code>default</code> wird für globale Kontroller verwenden (diejenigen die
  85. keinen Modul Namensraum benötigen). Alle Einträge sollten einen String Schlüssel
  86. enthalten der zu einem einzelnen Pfad zeigt, und der <code>default</code> Schlüssel muß
  87. vorhanden sein. Als Beispiel:
  88. </para>
  89. <programlisting language="php"><![CDATA[
  90. $front->setControllerDirectory(array(
  91. 'default' => '/path/to/application/controllers',
  92. 'blog' => '/path/to/application/blog/controllers'
  93. ));
  94. ]]></programlisting>
  95. <para>
  96. <code>addControllerDirectory()</code> nimmt ein optionales zweites Argument. Wenn Module
  97. verwendet werden, kann der Modulname als zweites Argument übergeben werden; wenn nicht
  98. spezifiziert, wird der Pfad zum <code>default</code> Namensraum hinzugefügt. Als
  99. Beispiel:
  100. </para>
  101. <programlisting language="php"><![CDATA[
  102. $front->addControllerDirectory('/path/to/application/news/controllers',
  103. 'news');
  104. ]]></programlisting>
  105. <para>
  106. Und das beste zum Schluß. Der einfachste Weg um Modul Verzeichnisse zu spezifizieren ist
  107. es en masse zu machen, mit allen Modulen in einem gemeinsamen Verzeichnis und die
  108. gleiche Struktur verwendend. Das kann mit <code>addModuleDirectory()</code> getan
  109. werden:
  110. </para>
  111. <programlisting language="php"><![CDATA[
  112. /**
  113. * Nehmen wir die folgende Verzeichnisstruktur an:
  114. * application/
  115. * modules/
  116. * default/
  117. * controllers/
  118. * foo/
  119. * controllers/
  120. * bar/
  121. * controllers/
  122. */
  123. $front->addModuleDirectory('/path/to/application/modules');
  124. ]]></programlisting>
  125. <para>
  126. Das obige Beispiel definiert die <code>default</code>, <code>foo</code>, und
  127. <code>bar</code> Module, die alle zum Unterverzeichnis <code>controllers</code> zeigen
  128. und zu Ihrem betreffenden Modul.
  129. </para>
  130. <para>
  131. Das Unterverzeichnis für den Kontroller kann angepasst werden um diesen in eigenen
  132. Modulen mit <code>setModuleControllerDirectoryName()</code> verwenden:
  133. </para>
  134. <programlisting language="php"><![CDATA[
  135. /**
  136. * Das Kontroller Unterverzeichnis ändern damit es 'con' ist
  137. * application/
  138. * modules/
  139. * default/
  140. * con/
  141. * foo/
  142. * con/
  143. * bar/
  144. * con/
  145. */
  146. $front->setModuleControllerDirectoryName('con');
  147. $front->addModuleDirectory('/path/to/application/modules');
  148. ]]></programlisting>
  149. <note><para>
  150. Man kann angeben das kein Kontroller Unterverzeichnis für die eigenen Module verwendet
  151. wird, indem ein leerer Wert an <code>setModuleControllerDirectoryName()</code> übergeben
  152. wird.
  153. </para></note>
  154. </sect2>
  155. <sect2 id="zend.controller.modular.router">
  156. <title>Zu Modulen routen</title>
  157. <para>
  158. Die Standardroute in <classname>Zend_Controller_Router_Rewrite</classname> ist ein
  159. Objekt vom Typ <classname>Zend_Controller_Router_Route_Module</classname>. Diese Route
  160. erwartet eines der folgenden Routing Schemas:
  161. </para>
  162. <itemizedlist>
  163. <listitem><para><code>:module/:controller/:action/*</code></para></listitem>
  164. <listitem><para><code>:controller/:action/*</code></para></listitem>
  165. </itemizedlist>
  166. <para>
  167. In anderen Worten, wird jeder Kontroller und jede Aktion durch sich selbst entsprechen
  168. oder mit einem vorangestellten Modul. Diese Regeln für die Entsprechung spezifizieren,
  169. das ein Modul nur dann entspricht, wenn ein Schlüssel mit dem gleichen Namen im
  170. Kontroller Verzeichnis Array existiert, das dem Front Kontroller und Dispatcher
  171. übergeben wird.
  172. </para>
  173. </sect2>
  174. <sect2 id="zend.controller.modular.defaultcontroller">
  175. <title>Modul oder globaler Standard Kontroller</title>
  176. <para>
  177. Im Standardrouter wird der Standardkontroller verwendet (<code>IndexController</code>,
  178. solange nicht anders angefragt), wenn kein Kontroller in der URL spezifiziert wurde. Bei
  179. modularen Kontrollern wird der Dispatcher zuerst für diesen Standardkontroller im
  180. Modulpfad nachsehen, wenn ein Modul aber kein Kontroller spezifiziert wurde, und fällt
  181. dann auf den Standardcontroller zurück, der im 'default' globalen Namensraum gefunden
  182. wird.
  183. </para>
  184. <para>
  185. Wenn immer auf den globalen Namensraum zurückgefallen werden soll, muß der
  186. <code>useDefaultControllerAlways</code> im Front Kontroller gesetzt werden:
  187. </para>
  188. <programlisting language="php"><![CDATA[
  189. $front->setParam('useDefaultControllerAlways', true);
  190. ]]></programlisting>
  191. </sect2>
  192. </sect1>
  193. <!--
  194. vim:se ts=4 sw=4 et:
  195. -->