Zend_Controller-Router-Route-Chain.xml 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15103 -->
  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 mehrere
  8. 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 Kontroller definiert,
  18. der Kontroller 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 erstellen
  24. und dann die <code>chain</code> Methode mehrere Male mit allen Routen aufzurufen die
  25. zusammen verkettet werden sollen. Der andere Weg besteht darin die erste Route zu nehmen,
  26. z.B. eine Hostname Route, und die <code>chain</code> Methode mit der Route auf Ihr
  27. aufzurufen, die angehängt werden soll. Das verändert die Hostname Route nicht, gibt aber
  28. eine neue Instanz von <classname>Zend_Controller_Router_Route_Chain</classname> zurück, die dann
  29. beide Routen verkettet hat:
  30. </para>
  31. <programlisting role="php"><![CDATA[
  32. // Erstellung zweier Routen
  33. $hostnameRoute = new Zend_Controller_Router_Route_Hostname(...);
  34. $pathRoute = new Zend_Controller_Router_Route(...);
  35. // Erster Weg, mit Verkettung über die Chain Route
  36. $chainedRoute = new Zend_Controller_Router_Route_Chain();
  37. $chainedRoute->chain($hostnameRoute)
  38. ->chain($pathRoute);
  39. // Zweiter Weg, direkt verketten
  40. $chainedRoute = $hostnameRoute->chain($pathRoute);
  41. ]]>
  42. </programlisting>
  43. <para>
  44. Wenn Routen miteinander verkettet werden, ist Ihr standardmäßiges Trennzeichen ein
  45. Schrägstrich. Es kann Fälle geben in denen man ein anderes Trennzeichen verwenden will:
  46. </para>
  47. <programlisting role="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. ]]>
  56. </programlisting>
  57. <sect4 id="zend.controller.router.routes.chain.config">
  58. <title>Verkettete Routen über <classname>Zend_Config</classname></title>
  59. <para>
  60. Um Routen in einer Config Datei miteinander zu verketten gibt es zusätzliche Parameter
  61. für die Konfiguration von Ihnen. Der einfachere Weg ist die Verwendung des
  62. <code>chains</code> Parameters. Dieser ist einfach eine Liste von Routen, die mit der
  63. Eltern-Route verkettet werden. Weder die Eltern-, noch die Kind-Routen werden dem
  64. Router direkt hinzugefügt sondern nur die resultierende verkettete Route. Der Name der
  65. verketteten Route im Router ist der Name der Eltern-Route und der Name der Kind-Route
  66. verbunden mit einem Bindestrich (-). Eine einfache Konfiguration würde in XML wie folgt
  67. aussehen:
  68. </para>
  69. <programlisting role="xml"><![CDATA[
  70. <routes>
  71. <www type="Zend_Controller_Router_Route_Hostname">
  72. <route>www.example.com</route>
  73. <chains>
  74. <language type="Zend_Controller_Router_Route">
  75. <route>:language</route>
  76. <reqs language="[a-z]{2}">
  77. <chains>
  78. <index type="Zend_Controller_Router_Route_Static">
  79. <route></route>
  80. <defaults module="default" controller="index" action="index" />
  81. </index>
  82. <imprint type="Zend_Controller_Router_Route_Static">
  83. <route>imprint</route>
  84. <defaults module="default" controller="index" action="index" />
  85. </imprint>
  86. </chains>
  87. </language>
  88. </chains>
  89. </www>
  90. <users type="Zend_Controller_Router_Route_Hostname">
  91. <route>users.example.com</route>
  92. <chains>
  93. <profile type="Zend_Controller_Router_Route">
  94. <route>:username</route>
  95. <defaults module="users" controller="profile" action="index" />
  96. </profile>
  97. </chains>
  98. </users>
  99. <misc type="Zend_Controller_Router_Route_Static">
  100. <route>misc</route>
  101. </misc>
  102. </routes>
  103. ]]>
  104. </programlisting>
  105. <para>
  106. Das führt zu den drei Routen <code>www-language-index</code>,
  107. <code>www-language-imprint</code> und <code>users-language-profile</code> die nur
  108. basierend auf dem Hostnamen und der Route <code>misc</code> passen, was wiederum mit
  109. jedem Hostnamen passt.
  110. </para>
  111. <para>
  112. Der alternative Weg der Erstellung einer verketteten Route ist der über den
  113. <code>chain</code> Parameter, was wiederum nur mit dem Chain-Route Typ direkt
  114. verwendet werden kann, und auch im Root Level funktioniert:
  115. </para>
  116. <programlisting role="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. ]]>
  141. </programlisting>
  142. <para>
  143. Man kann auch den <code>chain</code> Parameter als Array übergeben statt die Routen
  144. mit einem Komma zu seperieren:
  145. </para>
  146. <programlisting role="xml"><![CDATA[
  147. <routes>
  148. <www-index type="Zend_Controller_Router_Route_Chain">
  149. <chain>www</chain>
  150. <chain>language</chain>
  151. <chain>index</chain>
  152. </www-index>
  153. <www-imprint type="Zend_Controller_Router_Route_Chain">
  154. <chain>www</chain>
  155. <chain>language</chain>
  156. <chain>imprint</chain>
  157. </www-imprint>
  158. </routes>
  159. ]]>
  160. </programlisting>
  161. </sect4>
  162. </sect3>
  163. <!--
  164. vim:se ts=4 sw=4 et:
  165. -->