Главная / Zend Manual Core
Стандартный маршрутизатор

Диспетчер

Обзор

Диспетчеризация — это процесс принятия объекта запроса (Zend_Controller_Request_Abstract), извлечения содержащихся в нем имени модуля, имени контроллера, имени действия и необязательных параметров, затем инстанцирования контроллера и вызова действия в нем. Если не найдены модуль, контроллер или действие, то будут использоваться значения по умолчанию. Zend_Controller_Dispatcher_Standard определяет index как значение по умолчанию для контроллера и действия, и default - для модуля, но позволяет разработчику изменять эти значения, используя setDefaultController(), setDefaultAction() и setDefaultModule(), соответственно.

Note: Модуль, используемый по умолчанию
При создании приложения, состоящего из модулей, вы можете захотеть, чтобы для вашего модуля, используемого по умолчанию, тоже использовалось свое пространство имен (по умолчанию для этого модуля оно не используется). Начиная с версии 1.5.0, вы можете устанавливать параметр prefixDefaultModule в true, используя фронт-контроллер или диспетчер.

  1. // Через фронт-контроллер:
  2. $front->setParam('prefixDefaultModule', true);
  3.  
  4. // Через диспетчер:
  5. $dispatcher->setParam('prefixDefaultModule', true);
Это позволяет повторно использовать существующий модуль в качестве используемого по умолчанию в вашем приложении.

Диспетчеризация производится циклически во фронт-контроллере. До того, как будет запущен процесс диспетчеризации, фронт-контроллер выполняет маршрутизацию запроса для нахождения пользовательских значений модуля, контроллера, действия и необязательных параметров. Затем он входит в цикл диспетчеризации, обрабатывая запрос.

В начале каждой итерации цикла он устанавливает флаг в объекте запроса, означающий, что действие было запущено. Если действие или методы pre/postDispatch установленного плагина сбросят этот флаг, то цикл диспетчеризации продолжится и будет произведена попытка обработать новый запрос. Изменяя контроллер и/или действие в запросе и сбрасывая флаг диспетчеризации, разработчик может задавать цепочку запросов для обработки.

Метод действия в контроллере, который таким образом управляет диспетчеризацией, называется _forward(); вызывайте этот метод из любых методов pre/postDispatch() или методов действий, указывая действие, контроллер, модуль и опционально любые дополнительные параметры, которые хотите передать новому действию.

  1. public function fooAction()
  2. {
  3.     // переход к другому действию в текущем контроллере и модуле:
  4.     $this->_forward('bar', null, null, array('baz' => 'bogus'));
  5. }
  6.  
  7. public function barAction()
  8. {
  9.     // переход к действию в другом контроллере FooController::bazAction()
  10.     // в текущем модуле:
  11.     $this->_forward('baz', 'foo', null, array('baz' => 'bogus'));
  12. }
  13.  
  14. public function bazAction()
  15. {
  16.     // переход к действию в другом контроллере в другом модуле
  17.     // Foo_BarController::bazAction():
  18.     $this->_forward('baz', 'bar', 'foo', array('baz' => 'bogus'));
  19. }

Создание подклассов диспетчера

Zend_Controller_Front сначала вызывает маршрутизатор для получения первого действия в запросе. Затем он входит в цикл диспетчеризации, в котором вызывается диспетчер для запуска действия.

Диспетчеру для своей работы требуются различные данные - ему нужно "знать", как формировать имена контроллеров и действий, где искать файлы классов контроллеров, является ли допустимым или нет предоставленное имя модуля, и API для определения на основе другой доступной информации того, возможна ли диспетчеризация данного запроса.

Zend_Controller_Dispatcher_Interface определяет следующие методы, которые требуется использовать во всех реализациях диспетчера:

  1. interface Zend_Controller_Dispatcher_Interface
  2. {
  3.     /**
  4.      * Формирует из данной строки имя класса контроллера.
  5.      *
  6.      * @param string $unformatted
  7.      * @return string
  8.      */
  9.     public function formatControllerName($unformatted);
  10.  
  11.     /**
  12.      * Формирует из данной строки имя метода действия.
  13.      *
  14.      * @param string $unformatted
  15.      * @return string
  16.      */
  17.     public function formatActionName($unformatted);
  18.  
  19.     /**
  20.      * Определяет, доступен ли для диспетчеризации запрос
  21.      *
  22.      * @param  Zend_Controller_Request_Abstract $request
  23.      * @return boolean
  24.      */
  25.     public function isDispatchable(Zend_Controller_Request_Abstract $request);
  26.  
  27.     /**
  28.      * Устанавливает пользовательский параметр
  29.      * (через фронт-контроллер или для локального использования)
  30.      *
  31.      * @param string $name
  32.      * @param mixed $value
  33.      * @return Zend_Controller_Dispatcher_Interface
  34.      */
  35.     public function setParam($name, $value);
  36.  
  37.     /**
  38.      * Устанавливает массив пользовательских параметров
  39.      *
  40.      * @param array $params
  41.      * @return Zend_Controller_Dispatcher_Interface
  42.      */
  43.     public function setParams(array $params);
  44.  
  45.     /**
  46.      * Возвращает один пользовательский параметр
  47.      *
  48.      * @param string $name
  49.      * @return mixed
  50.      */
  51.     public function getParam($name);
  52.  
  53.     /**
  54.      * Возвращает все пользовательские параметры
  55.      *
  56.      * @return array
  57.      */
  58.     public function getParams();
  59.  
  60.     /**
  61.      * Очищает весь стек пользовательских параметров
  62.      * или удаляет один пользовательский параметр
  63.      *
  64.      * @param null|string|array один ключ или массив ключей для удаления
  65.      * @return Zend_Controller_Dispatcher_Interface
  66.      */
  67.     public function clearParams($name = null);
  68.  
  69.     /**
  70.      * Устанавливает объект ответа для использования, если есть
  71.      *
  72.      * @param Zend_Controller_Response_Abstract|null $response
  73.      * @return void
  74.      */
  75.     public function setResponse(Zend_Controller_Response_Abstract $response = null);
  76.  
  77.     /**
  78.      * Возвращает объект ответа, если есть
  79.      *
  80.      * @return Zend_Controller_Response_Abstract|null
  81.      */
  82.     public function getResponse();
  83.  
  84.     /**
  85.      * Добавляет директорию в стек директорий контроллеров
  86.      *
  87.      * @param string $path
  88.      * @param string $args
  89.      * @return Zend_Controller_Dispatcher_Interface
  90.      */
  91.     public function addControllerDirectory($path, $args = null);
  92.  
  93.     /**
  94.      * Устанавливает директорию(-ии), в которой хранятся файлы контроллеров
  95.      *
  96.      * @param string|array $dir
  97.      * @return Zend_Controller_Dispatcher_Interface
  98.      */
  99.     public function setControllerDirectory($path);
  100.  
  101.     /**
  102.      * Возвращает установленную в данное время директорию(-ии) для поиска
  103.      * файлов контроллеров
  104.      *
  105.      * @return array
  106.      */
  107.     public function getControllerDirectory();
  108.  
  109.     /**
  110.      * Направляет запрос (модулю/)контроллеру/действию.
  111.      *
  112.      * @param  Zend_Controller_Request_Abstract $request
  113.      * @param  Zend_Controller_Response_Abstract $response
  114.      * @return Zend_Controller_Request_Abstract|boolean
  115.      */
  116.     public function dispatch(Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response);
  117.  
  118.     /**
  119.      * Валиден или нет данный модуль
  120.      *
  121.      * @param string $module
  122.      * @return boolean
  123.      */
  124.     public function isValidModule($module);
  125.  
  126.     /**
  127.      * Возвращает используемое по умолчанию имя модуля
  128.      *
  129.      * @return string
  130.      */
  131.     public function getDefaultModule();
  132.  
  133.     /**
  134.      * Возвращает используемое по умолчанию имя контроллера
  135.      *
  136.      * @return string
  137.      */
  138.     public function getDefaultControllerName();
  139.  
  140.     /**
  141.      * Возвращает имя используемого по умолчанию действия
  142.      *
  143.      * @return string
  144.      */
  145.     public function getDefaultAction();
  146. }

Однако в большинстве случаев вам достаточно будет только расширить абстрактный класс Zend_Controller_Dispatcher_Abstract, в котором уже определены все эти методы или класс Zend_Controller_Dispatcher_Standard для изменения функционала стандартного диспетчера.

Основаниями для создания подклассов диспетчера могут быть желание использовать иную схему именования в своих контроллерах действий, либо другую парадигму диспетчеризации - например, файлы действий в директориях контроллеров вместо методов действий в классах контроллеров.


Стандартный маршрутизатор