Zend_Controller-Router-Route-Regex.xml 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.controller.router.routes.regex">
  5. <title>Zend_Controller_Router_Route_Regex</title>
  6. <para>
  7. Zusätzlich zu den standard statischen Routetypen, ist ein Regular Expression Routetyp
  8. vorhanden. Diese Route bietet mehr Power und Flexibilität als die anderen, aber auf leichten
  9. Kosten von Komplexität. Wärend der selben Zeit, sollte Sie schneller als die Standardroute
  10. sein.
  11. </para>
  12. <para>
  13. Wie die Standardroute, muß diese Route mit einer Routendefinition und einigen Standardwerten
  14. initialisiert werden. Lasst uns eine Archivroute als Beispiel erstellen, ähnlich der zuletzt
  15. definierten, nur das dieses Mal die Regex Route verwendet wird:
  16. </para>
  17. <programlisting language="php"><![CDATA[
  18. $route = new Zend_Controller_Router_Route_Regex(
  19. 'archive/(\d+)',
  20. array(
  21. 'controller' => 'archive',
  22. 'action' => 'show'
  23. )
  24. );
  25. $router->addRoute('archive', $route);
  26. ]]></programlisting>
  27. <para>
  28. Jedes definierte Regex Subpattern wird in das Anfrageobjekt injiziiert. Mit dem obigen
  29. Beispiel, nachdem <filename>http://domain.com/archive/2006</filename> erfolgreich geprüft
  30. wurde, kann das resultierende Wertearray so aussehen:
  31. </para>
  32. <programlisting language="php"><![CDATA[
  33. $values = array(
  34. 1 => '2006',
  35. 'controller' => 'archive',
  36. 'action' => 'show'
  37. );
  38. ]]></programlisting>
  39. <note>
  40. <para>
  41. Führende und folgende Schrägstriche werden von der <acronym>URL</acronym> im Router vor
  42. dem Vergleich entfernt. Als Ergebnis, wird ein Vergleich der <acronym>URL</acronym>
  43. <filename>http://domain.com/foo/bar/</filename>, ein Regex von
  44. <filename>foo/bar</filename> inkludieren, aber nicht <filename>/foo/bar</filename>.
  45. </para>
  46. </note>
  47. <note>
  48. <para>
  49. Zeilenbeginn und Endanker (normalerweise '^' und '$') werden automatisch allen
  50. Ausdrücken vor- und nachgesetzt. Deswegen sollten Sie nicht in den Regular Expressions
  51. verwendet werden, und der komplette String sollte entsprechen.
  52. </para>
  53. </note>
  54. <note>
  55. <para>
  56. Diese Routeklasse verwendet das '<emphasis>#</emphasis>' Zeichen als Begrenzer. Das
  57. bedeutet das ein Hashzeichen ('#') kommentiert werden muß aber keine Schrägstriche ('/')
  58. in der Routendefinition. Da das '#' Zeichen (Anker genannt) selben an einen Webserver
  59. übergeben wird, wird man dieses Zeichen selten in der eigenen regex verwenden.
  60. </para>
  61. </note>
  62. <para>
  63. Die Inhalte von definierten Subpattern können auf dem üblichen Weg bekommen werden:
  64. </para>
  65. <programlisting language="php"><![CDATA[
  66. public function showAction()
  67. {
  68. $request = $this->getRequest();
  69. $year = $request->getParam(1); // $year = '2006';
  70. }
  71. ]]></programlisting>
  72. <note>
  73. <para>Beachte das der Schlüssel ein Integer ist (1) anstatt ein String ('1').</para>
  74. </note>
  75. <para>
  76. Diese Route wird jetzt noch nicht exakt gleich wie Ihr Gegenspieler, die Standardroute,
  77. arbeiten da der Standard für 'year' noch nicht gesetzt ist. Und was jetzt noch nicht
  78. offensichtlich ist, ist das wir ein Problem mit endenden Schrägstrichen haben, selbst wenn
  79. wir einen Standard für das Jahr definieren und das Subpattern optional machen. Die Lösung
  80. ist, den ganzen year Teil optional zu nachen zusammen mit dem Schrägstrich, aber nur den
  81. nummerischen Teil zu holen:
  82. </para>
  83. <programlisting language="php"><![CDATA[
  84. $route = new Zend_Controller_Router_Route_Regex(
  85. 'archive(?:/(\d+))?',
  86. array(
  87. 1 => '2006',
  88. 'controller' => 'archive',
  89. 'action' => 'show'
  90. )
  91. );
  92. $router->addRoute('archive', $route);
  93. ]]></programlisting>
  94. <para>
  95. Jetzt betrachten wir das Problem das möglicherweise schon selbst gefunden wurde. Die
  96. Verwendung von Integer basierten Schlüsseln für Parameter ist keine einfach zu handhabende
  97. Lösung und kann, während einer langen Laufzeit, potentiell problematisch sein. Hier kommt der
  98. dritte Parameter ins Spiel. Dieser Parameter ist ein assoziatives Array das einer Karte von
  99. Regex Subpatterns zu Parametern benannten Schlüsseln entspricht. Betrachten wir ein
  100. einfacheres Beispiel:
  101. </para>
  102. <programlisting language="php"><![CDATA[
  103. $route = new Zend_Controller_Router_Route_Regex(
  104. 'archive/(\d+)',
  105. array(
  106. 'controller' => 'archive',
  107. 'action' => 'show'
  108. ),
  109. array(
  110. 1 => 'year'
  111. )
  112. );
  113. $router->addRoute('archive', $route);
  114. ]]></programlisting>
  115. <para>
  116. Als Ergebnis werden die folgenden Werte in die Anfrage injiziiert:
  117. </para>
  118. <programlisting language="php"><![CDATA[
  119. $values = array(
  120. 'year' => '2006',
  121. 'controller' => 'archive',
  122. 'action' => 'show'
  123. );
  124. ]]></programlisting>
  125. <para>
  126. Die Karte kann in jede Richtung definiert werden damit Sie in jeder Umgebung funktioniert.
  127. Schlüssel können Variablennamen oder Indezes von Subpattern enthalten:
  128. </para>
  129. <programlisting language="php"><![CDATA[
  130. $route = new Zend_Controller_Router_Route_Regex(
  131. 'archive/(\d+)',
  132. array( ... ),
  133. array(1 => 'year')
  134. );
  135. // ODER
  136. $route = new Zend_Controller_Router_Route_Regex(
  137. 'archive/(\d+)',
  138. array( ... ),
  139. array('year' => 1)
  140. );
  141. ]]></programlisting>
  142. <note>
  143. <para>
  144. Schlüssel von Subpattern müssen durch Integer repräsentiert werden.
  145. </para>
  146. </note>
  147. <para>
  148. Es gilt zu beachten das der nummerische Index in den Anfragewerten jetzt weg ist und eine
  149. benannte Variable statt Ihm angezeigt wird. Natürlich können nummerische und benannte
  150. Variablen gemischt werden wenn das gewünscht ist:
  151. </para>
  152. <programlisting language="php"><![CDATA[
  153. $route = new Zend_Controller_Router_Route_Regex(
  154. 'archive/(\d+)/page/(\d+)',
  155. array( ... ),
  156. array('year' => 1)
  157. );
  158. ]]></programlisting>
  159. <para>
  160. Das führt zu gemischten Werten die in der Anfrage vorhanden sind. Als Beispiel, wird die
  161. <acronym>URL</acronym> <filename>http://domain.com/archive/2006/page/10</filename> zu
  162. folgenden Werte führen:
  163. </para>
  164. <programlisting language="php"><![CDATA[
  165. $values = array(
  166. 'year' => '2006',
  167. 2 => 10,
  168. 'controller' => 'archive',
  169. 'action' => 'show'
  170. );
  171. ]]></programlisting>
  172. <para>
  173. Da Regex Patterns nicht einfach rückgängig zu machen sind, muß eine umgekehrte
  174. <acronym>URL</acronym> vorbereitet werden wenn ein <acronym>URL</acronym> Helfer verwendet
  175. werden soll oder sogar eine Herstellungsmethode dieser Klasse. Dieser umgekehrte Pfad wird
  176. durch einen String dargestellt der durch <methodname>sprintf()</methodname> durchsucht
  177. werden kann und als vierter Parameter definiert wird:
  178. </para>
  179. <programlisting language="php"><![CDATA[
  180. $route = new Zend_Controller_Router_Route_Regex(
  181. 'archive/(\d+)',
  182. array( ... ),
  183. array('year' => 1),
  184. 'archive/%s'
  185. );
  186. ]]></programlisting>
  187. <para>
  188. Da all das bereits etwas ist das durch die Bedeutung eines standardmäßigen Route Objektes
  189. möglich ist kommt natürlich die Frage aus worin der Vorteil einer regex Route besteht?
  190. Primär erlaubt Sie jeden Typ von <acronym>URL</acronym> zu beschreiben ohne irgendwelche
  191. Einschränkungen. Angenommen man hat einen Blog und will eine <acronym>URL</acronym> wie die
  192. folgende erstellen:
  193. <filename>http://domain.com/blog/archive/01-Using_the_Regex_Router.html</filename>, und muß
  194. das jetzt Pfad Element <filename>01-Using_the_Regex_Router.html</filename> bearbeiten, in
  195. eine Artikel ID und eine Artikel Titel oder Beschreibung; das ist nicht möglich mit der
  196. Standardroute. Mit der Regex Route ist etwas wie die folgende Lösung möglich:
  197. </para>
  198. <programlisting language="php"><![CDATA[
  199. $route = new Zend_Controller_Router_Route_Regex(
  200. 'blog/archive/(\d+)-(.+)\.html',
  201. array(
  202. 'controller' => 'blog',
  203. 'action' => 'view'
  204. ),
  205. array(
  206. 1 => 'id',
  207. 2 => 'description'
  208. ),
  209. 'blog/archive/%d-%s.html'
  210. );
  211. $router->addRoute('blogArchive', $route);
  212. ]]></programlisting>
  213. <para>
  214. Wie man sieht, fügt das ein enormes Potential von Flexibilität zur Stnadardroute hinzu.
  215. </para>
  216. </sect3>
  217. <!--
  218. vim:se ts=4 sw=4 et:
  219. -->