documentation/manual/ru/module_specs/Zend_Controller-Dispatcher.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.controller.dispatcher">
   4     <title>Диспетчер</title>
   5
   6     <sect2 id="zend.controller.dispatcher.overview">
   7         <title>Обзор</title>
   8
   9         <para>
  10             Диспетчеризация — это процесс принятия объекта запроса
  11             (<classname>Zend_Controller_Request_Abstract</classname>), извлечения
  12             содержащихся в нем имени модуля, имени контроллера, имени действия и
  13             необязательных параметров, затем инстанцирования контроллера и
  14             вызова действия в нем. Если не найдены модуль, контроллер или
  15             действие, то будут использоваться значения по умолчанию.
  16             <classname>Zend_Controller_Dispatcher_Standard</classname> определяет
  17             <code>index</code> как значение по умолчанию для контроллера и
  18             действия, и <code>default</code> - для модуля, но позволяет
  19             разработчику изменять эти значения, используя
  20             <code>setDefaultController()</code>,
  21             <code>setDefaultAction()</code> и <code>setDefaultModule()</code>,
  22             соответственно.
  23         </para>
  24
  25         <note>
  26             <title>Модуль, используемый по умолчанию</title>
  27
  28             <para>
  29                 При создании приложения, состоящего из модулей, вы можете
  30                 захотеть, чтобы для вашего модуля, используемого по умолчанию,
  31                 тоже использовалось свое пространство имен (по умолчанию для
  32                 этого модуля оно не используется). Начиная с
  33                 версии 1.5.0, вы можете устанавливать параметр
  34                 <code>prefixDefaultModule</code> в true, используя
  35                 фронт-контроллер или диспетчер.
  36             </para>
  37
  38             <programlisting language="php"><![CDATA[
  39 // Через фронт-контроллер:
  40 $front->setParam('prefixDefaultModule', true);
  41
  42 // Через диспетчер:
  43 $dispatcher->setParam('prefixDefaultModule', true);
  44 ]]></programlisting>
  45
  46             <para>
  47                 Это позволяет повторно использовать существующий модуль в
  48                 качестве используемого по умолчанию в вашем приложении.
  49             </para>
  50         </note>
  51
  52         <para>
  53             Диспетчеризация производится циклически во фронт-контроллере.
  54             До того, как будет запущен процесс диспетчеризации,
  55             фронт-контроллер выполняет маршрутизацию запроса для нахождения
  56             пользовательских значений модуля, контроллера, действия и
  57             необязательных параметров. Затем он входит в цикл диспетчеризации,
  58             обрабатывая запрос.
  59         </para>
  60
  61         <para>
  62             В начале каждой итерации цикла он устанавливает флаг в объекте
  63             запроса, означающий, что действие было запущено. Если
  64             действие или методы pre/postDispatch установленного плагина сбросят
  65             этот флаг, то цикл диспетчеризации продолжится и будет произведена
  66             попытка обработать новый запрос. Изменяя контроллер и/или действие в
  67             запросе и сбрасывая флаг диспетчеризации, разработчик может
  68             задавать цепочку запросов для обработки.
  69         </para>
  70
  71         <para>
  72             Метод действия в контроллере, который таким образом управляет
  73             диспетчеризацией, называется <code>_forward()</code>; вызывайте
  74             этот метод из любых методов pre/postDispatch() или методов действий,
  75             указывая действие, контроллер, модуль и опционально любые
  76             дополнительные параметры, которые хотите передать новому
  77             действию.
  78         </para>
  79
  80         <programlisting language="php"><![CDATA[
  81 public function fooAction()
  82 {
  83     // переход к другому действию в текущем контроллере и модуле:
  84     $this->_forward('bar', null, null, array('baz' => 'bogus'));
  85 }
  86
  87 public function barAction()
  88 {
  89     // переход к действию в другом контроллере FooController::bazAction()
  90     // в текущем модуле:
  91     $this->_forward('baz', 'foo', null, array('baz' => 'bogus'));
  92 }
  93
  94 public function bazAction()
  95 {
  96     // переход к действию в другом контроллере в другом модуле
  97     // Foo_BarController::bazAction():
  98     $this->_forward('baz', 'bar', 'foo', array('baz' => 'bogus'));
  99 }
 100 ]]></programlisting>
 101     </sect2>
 102
 103     <sect2 id="zend.controller.dispatcher.subclassing">
 104         <title>Создание подклассов диспетчера</title>
 105
 106         <para>
 107             <classname>Zend_Controller_Front</classname> сначала вызывает
 108             маршрутизатор для получения первого действия в запросе. Затем он
 109             входит в цикл диспетчеризации, в котором вызывается диспетчер для
 110             запуска действия.
 111         </para>
 112
 113         <para>
 114             Диспетчеру для своей работы требуются различные данные - ему нужно
 115             "знать", как формировать имена контроллеров
 116             и действий, где искать файлы классов контроллеров, является ли
 117             допустимым или нет предоставленное имя модуля, и API для
 118             определения на основе другой доступной информации того, возможна
 119             ли диспетчеризация данного запроса.
 120         </para>
 121
 122         <para>
 123             <classname>Zend_Controller_Dispatcher_Interface</classname> определяет
 124             следующие методы, которые требуется использовать во всех реализациях
 125             диспетчера:
 126         </para>
 127
 128         <programlisting language="php"><![CDATA[
 129 interface Zend_Controller_Dispatcher_Interface
 130 {
 131     /**
 132      * Формирует из данной строки имя класса контроллера.
 133      *
 134      * @param string $unformatted
 135      * @return string
 136      */
 137     public function formatControllerName($unformatted);
 138
 139     /**
 140      * Формирует из данной строки имя метода действия.
 141      *
 142      * @param string $unformatted
 143      * @return string
 144      */
 145     public function formatActionName($unformatted);
 146
 147     /**
 148      * Определяет, доступен ли для диспетчеризации запрос
 149      *
 150      * @param  Zend_Controller_Request_Abstract $request
 151      * @return boolean
 152      */
 153     public function isDispatchable(Zend_Controller_Request_Abstract $request);
 154
 155     /**
 156      * Устанавливает пользовательский параметр
 157      * (через фронт-контроллер или для локального использования)
 158      *
 159      * @param string $name
 160      * @param mixed $value
 161      * @return Zend_Controller_Dispatcher_Interface
 162      */
 163     public function setParam($name, $value);
 164
 165     /**
 166      * Устанавливает массив пользовательских параметров
 167      *
 168      * @param array $params
 169      * @return Zend_Controller_Dispatcher_Interface
 170      */
 171     public function setParams(array $params);
 172
 173     /**
 174      * Возвращает один пользовательский параметр
 175      *
 176      * @param string $name
 177      * @return mixed
 178      */
 179     public function getParam($name);
 180
 181     /**
 182      * Возвращает все пользовательские параметры
 183      *
 184      * @return array
 185      */
 186     public function getParams();
 187
 188     /**
 189      * Очищает весь стек пользовательских параметров
 190      * или удаляет один пользовательский параметр
 191      *
 192      * @param null|string|array один ключ или массив ключей для удаления
 193      * @return Zend_Controller_Dispatcher_Interface
 194      */
 195     public function clearParams($name = null);
 196
 197     /**
 198      * Устанавливает объект ответа для использования, если есть
 199      *
 200      * @param Zend_Controller_Response_Abstract|null $response
 201      * @return void
 202      */
 203     public function setResponse(Zend_Controller_Response_Abstract $response = null);
 204
 205     /**
 206      * Возвращает объект ответа, если есть
 207      *
 208      * @return Zend_Controller_Response_Abstract|null
 209      */
 210     public function getResponse();
 211
 212     /**
 213      * Добавляет директорию в стек директорий контроллеров
 214      *
 215      * @param string $path
 216      * @param string $args
 217      * @return Zend_Controller_Dispatcher_Interface
 218      */
 219     public function addControllerDirectory($path, $args = null);
 220
 221     /**
 222      * Устанавливает директорию(-ии), в которой хранятся файлы контроллеров
 223      *
 224      * @param string|array $dir
 225      * @return Zend_Controller_Dispatcher_Interface
 226      */
 227     public function setControllerDirectory($path);
 228
 229     /**
 230      * Возвращает установленную в данное время директорию(-ии) для поиска
 231      * файлов контроллеров
 232      *
 233      * @return array
 234      */
 235     public function getControllerDirectory();
 236
 237     /**
 238      * Направляет запрос (модулю/)контроллеру/действию.
 239      *
 240      * @param  Zend_Controller_Request_Abstract $request
 241      * @param  Zend_Controller_Response_Abstract $response
 242      * @return Zend_Controller_Request_Abstract|boolean
 243      */
 244     public function dispatch(Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response);
 245
 246     /**
 247      * Валиден или нет данный модуль
 248      *
 249      * @param string $module
 250      * @return boolean
 251      */
 252     public function isValidModule($module);
 253
 254     /**
 255      * Возвращает используемое по умолчанию имя модуля
 256      *
 257      * @return string
 258      */
 259     public function getDefaultModule();
 260
 261     /**
 262      * Возвращает используемое по умолчанию имя контроллера
 263      *
 264      * @return string
 265      */
 266     public function getDefaultControllerName();
 267
 268     /**
 269      * Возвращает имя используемого по умолчанию действия
 270      *
 271      * @return string
 272      */
 273     public function getDefaultAction();
 274 }
 275 ]]></programlisting>
 276
 277         <para>
 278             Однако в большинстве случаев вам достаточно будет только расширить
 279             абстрактный класс <classname>Zend_Controller_Dispatcher_Abstract</classname>,
 280             в котором уже определены все эти методы или класс
 281             <classname>Zend_Controller_Dispatcher_Standard</classname> для изменения
 282             функционала стандартного диспетчера.
 283         </para>
 284
 285         <para>
 286             Основаниями для создания подклассов диспетчера могут быть
 287             желание использовать иную схему именования в своих контроллерах
 288             действий, либо другую парадигму диспетчеризации -
 289             например, файлы действий в директориях контроллеров вместо методов
 290             действий в классах контроллеров.
 291         </para>
 292     </sect2>
 293 </sect1>
 294 <!--
 295 vim:se ts=4 sw=4 et:
 296 -->