ZF Zend Framework

Behind the Site

Programmer's Reference Guide

Диспетчер
Zend_Controller
Руководство разработчика

Контроллеры действий

Введение

Zend_Controller_Action - абстрактный класс, который можно использовать для реализации контроллеров действий для последующего их использования с фронт-контроллером при разработке сайта, основанного на паттерне Model-View-Controller (MVC).

Для того, чтобы использовать Zend_Controller_Action, нужно создать его подкласс в своей действующей директории контроллеров (или расширить его для создания своего базового класса контроллеров действий). Работа с ним в основном сводится к созданию его подкласса и написании методов действий, соответствующих различным действиям, которые должен обрабатывать этот контроллер. Маршрутизатор и диспетчер компоненты Zend_Controller будут считать за методы действий все методы в классе контроллера с именем, заканчивающимся на 'Action'.

Для примера предположим, что ваш класс определен следующим образом:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // делает что-нибудь
  6.     }
  7.  
  8.     public function bazAction()
  9.     {
  10.         // делает что-нибудь
  11.     }
  12. }

Приведенный выше класс FooController (контроллер foo) определяет два действия - bar и baz.

Класс может быть дополнен инициализирующим методом, методом действия по умолчанию (если не был вызван метод, либо вызван несуществующий метод), перехватчиками pre- и post-dispatch и различными вспомогательными методами. Этот раздел служит обзором функционала контроллера действий.

Замечание: Поведение по умолчанию
 По умолчанию фронт-контроллер активирует помощника действий ViewRenderer. Этот помощник обеспечивает добавление объекта вида в контроллер и автоматический рендеринг видов. Вы можете отключить его в своем контроллере действия, используя один из следующих методов:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         // Локально, только для данного контроллера:
  6.         $this->_invokeArgs['noViewRenderer'] = true;
  7.  
  8.         // Глобально:
  9.         $this->_helper->removeHelper('viewRenderer');
  10.  
  11.         // Тоже глобально, но должен использоваться вместе
  12.         // с локальной версией для того, чтобы распространить
  13.         // действие на данный контроллер:
  14.         Zend_Controller_Front::getInstance()
  15.             ->setParam('noViewRenderer', true);
  16.     }
  17. }
initView(), getViewScript(), render() и renderScript() служат посредниками для ViewRenderer, пока этот помощник находится в брокере помощников и не установлен флаг noViewRenderer.
Вы можете также отключить рендеринг для отдельного вида посредством установки флага noRender в ViewRenderer:
  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // отключение авторендеринга для этого действия:
  6.         $this->_helper->viewRenderer->setNoRender();
  7.     }
  8. }
Основные причины для отключения ViewRenderer - вам просто не нужен объект вида или если вы не производите рендеринг через скрипты вида (например, когда используется контроллер действий для обслуживания протоколов веб-сервисов, таких, как SOAP, XML-RPC, или REST). В большинстве случаев не нужно будет глобально отключать ViewRenderer, только избирательно в отдельных контроллерах или действиях.

Инициализация объекта

Несмотря на то, что вы всегда можете переопределить конструктор контроллера действий, мы не рекомендуем делать это. Zend_Controller_Action::__construct() выполняет некоторые важные задачи, такие, как регистрация объектов запроса и ответа, аргументов вызова, переданных из фронт-контроллера. Если необходимо переопределить контроллер, то всегда вызывайте конструктор родительского класса parent::__construct($request, $response, $invokeArgs) в конструкторе подкласса.

Более подходящим способом настройки инстанцирования является использование метода init(), который вызывается в конце выполнения __construct(). Например, если вы хотите устанавливать соединение с БД при инстанцировании:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $this->db = Zend_Db::factory('Pdo_Mysql', array(
  6.             'host'     => 'myhost',
  7.             'username' => 'user',
  8.             'password' => 'XXXXXXX',
  9.             'dbname'   => 'website'
  10.         ));
  11.     }
  12. }

Перехватчики Pre- и Post-Dispatch

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

Аксессоры

С объектом контроллера регистрируется несколько объектов и переменных, они имеют свои методы-аксессоры.

  • Объект запроса: через метод getRequest() извлекается объект запроса, который использовался для вызова данного действия.

  • Объект ответа: через метод getResponse() извлекается объект ответа, объединяющий в себе заголовки и содержимое ответа. Некоторые типичные вызовы могут выглядеть следующим образом:

    1. $this->getResponse()->setHeader('Content-Type', 'text/xml');
    2. $this->getResponse()->appendBody($content);

  • Аргументы вызова: фронт-контроллер может добавлять параметры в маршрутизатор, диспетчер и контроллер действий. Для их получения используйте getInvokeArg($key), можно также извлечь весь список аргументов, используя метод getInvokeArgs().

  • Параметры запроса: Объект запроса заключает в себе параметры запроса, такие, как значения _GET, _POST, или пользовательские параметры, определенные в пути URL. Для их получения используйте _getParam($key) или _getAllParams(). Вы можете также установить параметры запроса, используя метод _setParam(), это полезно при перенаправлении на другие действия через метод _forward().

    Для определения того, существует ли параметр или нет (полезно для логического ветвления), используйте _hasParam($key).

    Замечание: _getParam() может принимать опциональный второй аргумент, содержащий значение по умолчанию, которое используется, если параметр не установлен или пустой. Его использование устраняет необходимость вызова _hasParam() до получения значения:

    1. // Используется значение по умолчанию 1, если id не установлен
    2. $id = $this->_getParam('id', 1);
    3.  
    4. // Вместо:
    5. if ($this->_hasParam('id') {
    6.     $id = $this->_getParam('id');
    7. } else {
    8.     $id = 1;
    9. }

Интеграция вида

Замечание: По умолчанию интеграция вида производится через ViewRenderer
 Изложенное в этом разделе действительно только в том случае, если вы явным образом отключили ViewRenderer. Иначе вы можете спокойно пропустить этот раздел.

Zend_Controller_Action предоставляет простейший и гибкий механизм интеграции видов. Два метода осуществляют это: initView() и render(). Первый метод выполняет отложенную загрузку открытого свойства $view, второй выполняет рендеринг вида, основываясь на запрошенном в данный момент действии, используя иерархию директорий для определения пути к скрипту.

Инициализация вида

initView() инициализирует объект вида. render() вызывает initView() для извлечения объекта вида, но этот объект может быть инициализирован в любое время. По умолчанию initView() заполняет свойство $view объектом Zend_View, но может также использоваться любой класс, реализующий интерфейс Zend_View_Interface. Если $view уже инициализирован, то просто возвращается это свойство.

Реализация, используемая по умолчанию, делает следующие предположения по структуре директорий:

  1. applicationOrModule/
  2.     controllers/
  3.         IndexController.php
  4.     views/
  5.         scripts/
  6.             index/
  7.                 index.phtml
  8.         helpers/
  9.         filters/

Другими словами, предполагается, что скрипты вида находятся в поддиректории views/scripts/ и поддиректория views должна содержать родственный функционал того же уровня (это могут быть помощники, фильтры). Когда определяется имя и путь к скрипту вида, то в качестве базового пути используется директория views/scripts/ с директориями, именованными в соответствии с отдельными контроллерами, что дает иерархию скриптов вида.

Рендеринг видов

render() имеет следующую сигнатуру:

  1. string render(string $action = null,
  2.               string $name = null,
  3.               bool $noController = false);

render() рендерит скрипт вида. Если не были переданы аргументы, то предполагается, что запрашивается скрипт [controller]/[action].phtml (где .phtml - значение свойства $viewSuffix). Передача значения для $action вызовет генерацию этого шаблона в поддиректории [controller]. Для того, чтобы отменить использование поддиректории [controller], передавайте значение true для $noController. Шаблоны рендерятся в объект ответа, если же вы хотите сохранить результат в именованный сегмент объекта ответа, то передавайте значение для $name.

Замечание: Поскольку имена контроллера и действия могут содержать символы-ограничители слов, такие, как '_', '.', и '-', то render() нормализует их к '-', когда определяет имя скрипта. Внутри себя для такой нормализации он использует ограничители слов и путей для диспетчера. Таким образом, запрос к /foo.bar/baz-bat приведет к рендерингу скрипта foo-bar/baz-bat.phtml. Если ваш метод действия содержит camelCase, то следует иметь в виду, что при определении имени скрипта вида результатом будут разделенные '-' слова.

Некоторые примеры:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function fooAction()
  4.     {
  5.         // Рендеринг my/foo.phtml
  6.         $this->render();
  7.  
  8.         // Рендеринг my/bar.phtml
  9.         $this->render('bar');
  10.  
  11.         // Рендеринг baz.phtml
  12.         $this->render('baz', null, true);
  13.  
  14.         // Рендеринг my/login.phtml в сегмент 'form' объекта ответа
  15.         $this->render('login', 'form');
  16.  
  17.         // Рендеринг site.phtml в сегмент 'page' объекта ответа,
  18.         // при этом не используется поддиректория 'my/'
  19.         $this->render('site', 'page', true);
  20.     }
  21.  
  22.     public function bazBatAction()
  23.     {
  24.         // Рендеринг my/baz-bat.phtml
  25.         $this->render();
  26.     }
  27. }

Сервисные методы

Кроме аксессоров и методов интеграции видов, Zend_Controller_Action имеет несколько сервисных методов для выполнения распространенных зачач в методах действий (или в методах pre- и post-dispatch).

  • _forward($action, $controller = null, $module = null, array $params = null): выполяет другое действие. Если был вызван в preDispatch(), то запрошенноое в данный момент действие будет пропущено в пользу нового. Иначе действие, запрошенное в _forward(), будет выполнено после того, как было выполнено текущее действие.

  • _redirect($url, array $options = array()): производит перенаправление по другому адресу. Этот метод принимает URL и опционально набор опций. По умолчанию он производит перенаправление HTTP 302.

    Опции могут включать в себя одну или более из следующих:

    • exit: производить или нет выход после этого. Если установлена, то будет произведены надлежащее закрытие всех открытых сессий и перенаправление.

      Вы можете установить эту опцию глобально в контроллере, используя аксессор setRedirectExit().

    • prependBase: добавлять или нет базовый URL из объекта запроса в начало данного URL.

      Вы можете установить эту опцию глобально в контроллере, используя аксессор setRedirectPrependBase().

    • code: какой код HTTP использовать при перенаправлении. По умолчанию используется HTTP 302. Могут использоваться любые коды от 301 до 306.

      Вы можете установить эту опцию глобально в контроллере, используя аксессор setRedirectCode().

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

Задумано, что в порядке создания контроллеров действий должны создаваться подклассы от Zend_Controller_Action. Как минимум, вам нужно будет определить методы действий, которые может вызывать контроллер.

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

Пример #1 Обрабаботка обращений к несуществующим действиям

Если сделан запрос к контроллеру, который содержит в себе не определенный в контроллере метод действия, то вызывается метод Zend_Controller_Action::__call(). __call() является магическим методом для перегрузки методов в PHP.

По умолчанию этот метод бросает исключение Zend_Controller_Action_Exception, означающее, что требуемый метод не найден в контроллере. Если требуемый метод заканчивается строкой 'Action', то предполагается, что было запрошено действие и оно не существует; такая ошибка приводит к исключению с кодом 404. В остальных случаях бросается исключение с кодом 500. Это позволяет легко дифференцировать в обработчике ошибок случаи, когда страница не найдена, и когда произошла ошибка приложения.

Например, если вы хотите выводить сообщение об ошибке, то можете написать нечто подобное:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function __call($method, $args)
  4.     {
  5.         if ('Action' == substr($method, -6)) {
  6.             // Если метод действия не найден, то рендерится шаблон ошибки
  7.             return $this->render('error');
  8.         }
  9.  
  10.         // все другие методы бросают исключение
  11.         throw new Exception('Invalid method "'
  12.                             . $method
  13.                             . '" called',
  14.                             500);
  15.     }
  16. }

Другая возможность состоит в том, что вы можете производить переход на страницу контроллера по умолчанию:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function indexAction()
  4.     {
  5.         $this->render();
  6.     }
  7.  
  8.     public function __call($method, $args)
  9.     {
  10.         if ('Action' == substr($method, -6)) {
  11.             // Если метод действия не был найден, то производится
  12.             // переход к действию index
  13.             return $this->_forward('index');
  14.         }
  15.  
  16.         // все другие методы бросают исключение
  17.         throw new Exception('Invalid method "'
  18.                             . $method
  19.                             . '" called',
  20.                             500);
  21.     }
  22. }

Как и метод __call(), любые аксессоры, сервисные методы, методы инициализации, вида и перехвата, упомянутые ранее в этом разделе, могут быть переопределены для того, чтобы приспособить свои контроллеры под конкретные нужды. Например, если вы храните свои объекты вида в реестре, то можете модифицировать свой метод initView():

  1. abstract class My_Base_Controller extends Zend_Controller_Action
  2. {
  3.     public function initView()
  4.     {
  5.         if (null === $this->view) {
  6.             if (Zend_Registry::isRegistered('view')) {
  7.                 $this->view = Zend_Registry::get('view');
  8.             } else {
  9.                 $this->view = new Zend_View();
  10.                 $this->view->setBasePath(dirname(__FILE__) . '/../views');
  11.             }
  12.         }
  13.  
  14.         return $this->view;
  15.     }
  16. }

Надеемся, из написанного в этом разделе вы смогли увидеть, насколько гибка эта компонента, и как можно заточить ее под нужды своего приложения или сайта.

Диспетчер
Zend_Controller
Руководство разработчика
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual

    • Navigation