Zend_Controller-Router-Route-Chain.xml 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.controller.router.routes.chain">
  5. <title>Zend_Controller_Router_Route_Chain</title>
  6. <para>
  7. <classname>Zend_Controller_Router_Route_Chain</classname> ist eine Route die es erlaubt
  8. mehrere Routen miteinander zu verketten. Das erlaubt es Hostname-Routen und Pfad-Routen zu
  9. verketten, oder zum Beispiel mehrere Pfad-Routen. Verkettung kann entweder
  10. program-technisch oder mit einer Konfigurationsdatei durchgeführt werden.
  11. </para>
  12. <note>
  13. <title>Priorität der Parameter</title>
  14. <para>
  15. Wenn Routen wie die Hostnameroute und die Pfadroute zusammengekettet werden, haben die
  16. Parameter der Hostnameroute eine höhere Priorität als die Parameter der Pfadroute.
  17. Deshalb wird, wenn man im Hostnamen und in der Pfadroute einen Controller definiert,
  18. der Controller der Hostnameroute ausgewählt.
  19. </para>
  20. </note>
  21. <para>
  22. Wenn Programmtechnisch verkettet wird, gibt es zwei Wege das zu tun. Der erste besteht
  23. darin eine neue Instanz von <classname>Zend_Controller_Router_Route_Chain</classname> zu
  24. erstellen und dann die <methodname>chain()</methodname> Methode mehrere Male mit allen
  25. Routen aufzurufen die zusammen verkettet werden sollen. Der andere Weg besteht darin die
  26. erste Route zu nehmen, z.B. eine Hostname Route, und die <methodname>chain()</methodname>
  27. Methode mit der Route auf Ihr aufzurufen, die angehängt werden soll. Das verändert die
  28. Hostname Route nicht, gibt aber eine neue Instanz von
  29. <classname>Zend_Controller_Router_Route_Chain</classname> zurück, die dann beide Routen
  30. verkettet hat:
  31. </para>
  32. <programlisting language="php"><![CDATA[
  33. // Erstellung zweier Routen
  34. $hostnameRoute = new Zend_Controller_Router_Route_Hostname(...);
  35. $pathRoute = new Zend_Controller_Router_Route(...);
  36. // Erster Weg, mit Verkettung über die Chain Route
  37. $chainedRoute = new Zend_Controller_Router_Route_Chain();
  38. $chainedRoute->chain($hostnameRoute)
  39. ->chain($pathRoute);
  40. // Zweiter Weg, direkt verketten
  41. $chainedRoute = $hostnameRoute->chain($pathRoute);
  42. ]]></programlisting>
  43. <para>
  44. Wenn Routen miteinander verkettet werden, ist Ihr Trennzeichen ein
  45. Schrägstrich. Es kann Fälle geben in denen man ein anderes Trennzeichen verwenden will:
  46. </para>
  47. <programlisting language="php"><![CDATA[
  48. // Zwei Routen erstellen
  49. $firstRoute = new Zend_Controller_Router_Route('foo');
  50. $secondRoute = new Zend_Controller_Router_Route('bar');
  51. // Sie mit einem anderen Trennzeichen miteinander verketten
  52. $chainedRoute = $firstRoute->chain($secondRoute, '-');
  53. // Zusammenbauen der Route: "foo-bar"
  54. echo $chainedRoute->assemble();
  55. ]]></programlisting>
  56. <sect4 id="zend.controller.router.routes.chain.config">
  57. <title>Verkettete Routen über Zend_Config</title>
  58. <para>
  59. Um Routen in einer Config Datei miteinander zu verketten gibt es zusätzliche Parameter
  60. für die Konfiguration von Ihnen. Der einfachere Weg ist die Verwendung des
  61. <property>chains</property> Parameters. Dieser ist einfach eine Liste von Routen, die
  62. mit der Eltern-Route verkettet werden. Weder die Eltern-, noch die Kind-Routen werden
  63. dem Router direkt hinzugefügt sondern nur die resultierende verkettete Route. Der Name
  64. der verketteten Route im Router ist standardmäßig der Name der Eltern-Route und der Name
  65. der Kind-Route verbunden mit einem Bindestrich (-). Eine einfache Konfiguration würde
  66. in <acronym>XML</acronym> wie folgt aussehen:
  67. </para>
  68. <programlisting language="xml"><![CDATA[
  69. <routes>
  70. <www type="Zend_Controller_Router_Route_Hostname">
  71. <route>www.example.com</route>
  72. <chains>
  73. <language type="Zend_Controller_Router_Route">
  74. <route>:language</route>
  75. <reqs language="[a-z]{2}">
  76. <chains>
  77. <index type="Zend_Controller_Router_Route_Static">
  78. <route></route>
  79. <defaults module="default" controller="index"
  80. action="index" />
  81. </index>
  82. <imprint type="Zend_Controller_Router_Route_Static">
  83. <route>imprint</route>
  84. <defaults module="default" controller="index"
  85. action="index" />
  86. </imprint>
  87. </chains>
  88. </language>
  89. </chains>
  90. </www>
  91. <users type="Zend_Controller_Router_Route_Hostname">
  92. <route>users.example.com</route>
  93. <chains>
  94. <profile type="Zend_Controller_Router_Route">
  95. <route>:username</route>
  96. <defaults module="users" controller="profile" action="index" />
  97. </profile>
  98. </chains>
  99. </users>
  100. <misc type="Zend_Controller_Router_Route_Static">
  101. <route>misc</route>
  102. </misc>
  103. </routes>
  104. ]]></programlisting>
  105. <para>
  106. Das führt zu den drei Routen <command>www-language-index</command>,
  107. <command>www-language-imprint</command> und <command>users-language-profile</command>
  108. die nur basierend auf dem Hostnamen und der Route <command>misc</command> passen, was
  109. wiederum mit jedem Hostnamen passt.
  110. </para>
  111. <para>
  112. Der alternative Weg der Erstellung einer verketteten Route ist der über den
  113. <property>chain</property> Parameter, was wiederum nur mit dem Chain-Route Typ direkt
  114. verwendet werden kann, und auch im Root Level funktioniert:
  115. </para>
  116. <programlisting language="xml"><![CDATA[
  117. <routes>
  118. <www type="Zend_Controller_Router_Route_Chain">
  119. <route>www.example.com</route>
  120. </www>
  121. <language type="Zend_Controller_Router_Route">
  122. <route>:language</route>
  123. <reqs language="[a-z]{2}">
  124. </language>
  125. <index type="Zend_Controller_Router_Route_Static">
  126. <route></route>
  127. <defaults module="default" controller="index" action="index" />
  128. </index>
  129. <imprint type="Zend_Controller_Router_Route_Static">
  130. <route>imprint</route>
  131. <defaults module="default" controller="index" action="index" />
  132. </imprint>
  133. <www-index type="Zend_Controller_Router_Route_Chain">
  134. <chain>www, language, index</chain>
  135. </www-index>
  136. <www-imprint type="Zend_Controller_Router_Route_Chain">
  137. <chain>www, language, imprint</chain>
  138. </www-imprint>
  139. </routes>
  140. ]]></programlisting>
  141. <para>
  142. Man kann auch den <property>chain</property> Parameter als Array übergeben statt die
  143. Routen mit einem Komma zu seperieren:
  144. </para>
  145. <programlisting language="xml"><![CDATA[
  146. <routes>
  147. <www-index type="Zend_Controller_Router_Route_Chain">
  148. <chain>www</chain>
  149. <chain>language</chain>
  150. <chain>index</chain>
  151. </www-index>
  152. <www-imprint type="Zend_Controller_Router_Route_Chain">
  153. <chain>www</chain>
  154. <chain>language</chain>
  155. <chain>imprint</chain>
  156. </www-imprint>
  157. </routes>
  158. ]]></programlisting>
  159. <para>
  160. Wenn man Chain-Routen mit <classname>Zend_Config</classname> konfiguriert und will dass
  161. das Trennzeichen ein anderes als ein Unterstrich ist, dann muss man dises Trennzeichen
  162. separat spezifizieren:
  163. </para>
  164. <programlisting language="php"><![CDATA[
  165. $config = new Zend_Config(array(
  166. 'chainName' => array(
  167. 'type' => 'Zend_Controller_Router_Route_Static',
  168. 'route' => 'foo',
  169. 'chains' => array(
  170. 'subRouteName' => array(
  171. 'type' => 'Zend_Controller_Router_Route_Static',
  172. 'route' => 'bar',
  173. 'defaults' => array(
  174. 'module' => 'module',
  175. 'controller' => 'controller',
  176. 'action' => 'action'
  177. )
  178. )
  179. )
  180. )
  181. ));
  182. // Das Trennzeichen vor dem hinzufügen der Config setzen
  183. $router->setChainNameSeparator('_separator_')
  184. // Config hinzufügen
  185. $router->addConfig($config);
  186. // Der Name unserer Route ist jetzt: chainName_separator_subRouteName
  187. echo $this->_router->assemble(array(), 'chainName_separator_subRouteName');
  188. // Die Prüfung: Ausgegeben wird /foo/bar
  189. ]]></programlisting>
  190. </sect4>
  191. </sect3>