Zend_Controller-Router-Route-Regex.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect3 id="zend.controller.router.routes.regex">
  4. <title>Zend_Controller_Router_Route_Regex</title>
  5. <para>
  6. Кроме описанных ранее типов маршрутов - используемого по умолчанию и
  7. статического - есть маршруты на регулярных выражениях. Этот маршрут
  8. дает больше мощности и гибкости, чем другие типы маршрутов, но
  9. ценой некоторой дополнительной сложности. В то же время он должен быть
  10. более быстрым, чем стандартный маршрут.
  11. </para>
  12. <para>
  13. Как и в случае стандартного, такой маршрут должен быть
  14. проинициализирован с определением маршрута и некоторыми значениями по
  15. умолчанию. Давайте в качестве примера создадим маршрут для архива, такой
  16. же, как в предыдущих примерах, но на этот раз с использованием маршрута
  17. Regex:
  18. </para>
  19. <programlisting language="php"><![CDATA[
  20. $route = new Zend_Controller_Router_Route_Regex(
  21. 'archive/(\d+)',
  22. array(
  23. 'controller' => 'archive',
  24. 'action' => 'show'
  25. )
  26. );
  27. $router->addRoute('archive', $route);
  28. ]]></programlisting>
  29. <para>
  30. Каждый определенный подшаблон регулярного выражения будет внедрен в
  31. объект запроса. В нашем примере после успешного сопоставления с
  32. <code>http://domain.com/archive/2006</code> результирующий массив
  33. значений может выглядеть следующим образом:
  34. </para>
  35. <programlisting language="php"><![CDATA[
  36. $values = array(
  37. 1 => '2006',
  38. 'controller' => 'archive',
  39. 'action' => 'show'
  40. );
  41. ]]></programlisting>
  42. <note>
  43. <para>
  44. Ведущая и замыкающая косые черты удаляются из URL в маршрутизаторе
  45. до сопоставления. Поэтому URL-у
  46. <code>http://domain.com/foo/bar/</code> будет соответствовать
  47. регулярное выражение <code>foo/bar</code>, но не
  48. <code>/foo/bar</code>.
  49. </para>
  50. </note>
  51. <note>
  52. <para>
  53. Указатели начала и конца строки ('^' и '$' соответственно)
  54. автоматически добавляются в начало и конец всех выражений. Поэтому
  55. вы не должны использовать их в своих регулярных выражениях, кроме
  56. этого, следует передавать строку выражения целиком.
  57. </para>
  58. </note>
  59. <note>
  60. <para>
  61. Этот класс маршрута использует символ <code>#</code> в качестве
  62. ограничителя. Это означает, что нужно экранировать символы хэша
  63. ('#'), но не прямой косой черты ('/') в своем определении маршрута.
  64. Поскольку символ '#' (называемый анкером) редко передается
  65. веб-серверу, вам нечасто придется использовать этот символ в своем
  66. регулярном выражении.
  67. </para>
  68. </note>
  69. <para>
  70. Вы можете получать содержимое заданного подшаблона обычным способом:
  71. </para>
  72. <programlisting language="php"><![CDATA[
  73. public function showAction()
  74. {
  75. $request = $this->getRequest();
  76. $year = $request->getParam(1); // $year = '2006';
  77. }
  78. ]]></programlisting>
  79. <note>
  80. <para>
  81. Обратите внимание, что ключ является целым числом (1), а не строкой ('1').
  82. </para>
  83. </note>
  84. <para>
  85. Этот маршрут не будет работать в точности так же, как и аналогичный ему
  86. стандартный маршрут, потому что еще не определено значение по умолчанию
  87. для 'year'. Есть еще неочевидная проблема с замыкающей косой чертой,
  88. которая остается даже в том случае, если мы объявим значение по
  89. умолчанию для 'year' и сделаем подшаблон опциональным. Решение состоит в
  90. том, чтобы сделать часть 'year' опциональной вместе с косой чертой, но
  91. отлавливать только число:
  92. </para>
  93. <programlisting language="php"><![CDATA[
  94. $route = new Zend_Controller_Router_Route_Regex(
  95. 'archive(?:/(\d+))?',
  96. array(
  97. 1 => '2006',
  98. 'controller' => 'archive',
  99. 'action' => 'show'
  100. )
  101. );
  102. $router->addRoute('archive', $route);
  103. ]]></programlisting>
  104. <para>
  105. А теперь давайте обратимся к проблеме, которую вы, должно быть, заметили
  106. сами. Использование целочисленных ключей для параметров не является
  107. легко управляемым решением и потенциально проблематично в долговременном
  108. использовании. Вот тут на сцену выходит третий параметр. Этот параметр
  109. является ассоциативным массивом, представляющий соответствие подшаблонов
  110. регулярного выражения именованным ключам параметров. Доработаем наш
  111. простой пример:
  112. </para>
  113. <programlisting language="php"><![CDATA[
  114. $route = new Zend_Controller_Router_Route_Regex(
  115. 'archive/(\d+)',
  116. array(
  117. 'controller' => 'archive',
  118. 'action' => 'show'
  119. ),
  120. array(
  121. 1 => 'year'
  122. )
  123. );
  124. $router->addRoute('archive', $route);
  125. ]]></programlisting>
  126. <para>
  127. Это приведет к тому, что в объект запроса будут добавлены следующие
  128. значения:
  129. </para>
  130. <programlisting language="php"><![CDATA[
  131. $values = array(
  132. 'year' => '2006',
  133. 'controller' => 'archive',
  134. 'action' => 'show'
  135. );
  136. ]]></programlisting>
  137. <para>
  138. Для того, чтобы соответствия работали в любом окружении, они могут быть
  139. определены в любом направлении. Ключи массива могут содержать как имена
  140. переменных, так и индексы подшаблонов:
  141. </para>
  142. <programlisting language="php"><![CDATA[
  143. $route = new Zend_Controller_Router_Route_Regex(
  144. 'archive/(\d+)',
  145. array( ... ),
  146. array(1 => 'year')
  147. );
  148. // ИЛИ
  149. $route = new Zend_Controller_Router_Route_Regex(
  150. 'archive/(\d+)',
  151. array( ... ),
  152. array('year' => 1)
  153. );
  154. ]]></programlisting>
  155. <note>
  156. <para>
  157. Ключи подшаблонов должны быть представлены целыми числами.
  158. </para>
  159. </note>
  160. <para>
  161. Обратите внимание, что числовой индекс в значениях объекта запроса
  162. теперь отсутствует и вместо него присутствует именованная переменная.
  163. Конечно, при желании вы можете смешивать числовые и именованные ключи:
  164. </para>
  165. <programlisting language="php"><![CDATA[
  166. $route = new Zend_Controller_Router_Route_Regex(
  167. 'archive/(\d+)/page/(\d+)',
  168. array( ... ),
  169. array('year' => 1)
  170. );
  171. ]]></programlisting>
  172. <para>
  173. Это приведет к тому, что в объекте запроса будут значения с разными
  174. ключами. Например, при URL
  175. <code>http://domain.com/archive/2006/page/10</code> результатом будут
  176. следующие значения:
  177. </para>
  178. <programlisting language="php"><![CDATA[
  179. $values = array(
  180. 'year' => '2006',
  181. 2 => 10,
  182. 'controller' => 'archive',
  183. 'action' => 'show'
  184. );
  185. ]]></programlisting>
  186. <para>
  187. Поскольку регулярные выражения трудно реверсировать, то вам нужно будет
  188. подготовить реверсный URL, если хотите использовать хелпер для URL, или
  189. даже написать метод этого класса. Реверсный путь представляется строкой,
  190. оформленной для использования с функцией sprintf(), и определенной как
  191. четвертый параметр конструктора:
  192. </para>
  193. <programlisting language="php"><![CDATA[
  194. $route = new Zend_Controller_Router_Route_Regex(
  195. 'archive/(\d+)',
  196. array( ... ),
  197. array('year' => 1),
  198. 'archive/%s'
  199. );
  200. ]]></programlisting>
  201. <para>
  202. Все это можно реализовать через объект стандартного маршрута, поэтому вы
  203. спросите - какие преимущества дает использование маршрута Regex? Главным
  204. образом, он позволяет описывать любые типы URL без всяких ограничений.
  205. Предположим, у вас есть свой блог, вы хотите создавать URL вида
  206. <code>http://domain.com/blog/archive/01-Using_the_Regex_Router.html</code>
  207. и должны разлагать последний элемент пути
  208. <code>01-Using_the_Regex_Router.html</code> на ID статьи и ее
  209. заголовок/описание. Это невозможно реализовать с помощью стандартного
  210. маршрута. С маршрутом Regex вы можете сделать нечто подобное для решения
  211. этой задачи:
  212. </para>
  213. <programlisting language="php"><![CDATA[
  214. $route = new Zend_Controller_Router_Route_Regex(
  215. 'blog/archive/(\d+)-(.+)\.html',
  216. array(
  217. 'controller' => 'blog',
  218. 'action' => 'view'
  219. ),
  220. array(
  221. 1 => 'id',
  222. 2 => 'description'
  223. ),
  224. 'blog/archive/%d-%s.html'
  225. );
  226. $router->addRoute('blogArchive', $route);
  227. ]]></programlisting>
  228. <para>
  229. Как вы можете видеть, маршруты Regex дают несравненно большую гибкость
  230. по сравнению со стандартными маршрутами.
  231. </para>
  232. </sect3>
  233. <!--
  234. vim:se ts=4 sw=4 et:
  235. -->