7.5. Action Controllers

7.5.1. Wprowadzenie

Zend_Controller_Action jest klasą abstrakcyjną, której możesz użyć do implementacji kontrolerów akcji, których wraz z kontrolerem frontowym użyjesz do budowania aplikacji opartej na wzorcu Model-View-Controller (MVC).

Aby użyć klasy Zend_Controller_Action, powinieneś ją rozszerzyć w swoich kontrolerach akcji (lub rozszerzyć ją aby utworzyć swoją własną bazową klasę dla kontrolerów akcji). Najbardziej podstawową operacją jest rozszerzenie tej klasy oraz utworzenie metod akcji, które odpowiadają różnym akcjom jakie ma obsługiwać kontroler na twojej stronie. Obsługa routingu i uruchamiania w Zend_Controller automatycznie przeszuka wszystkie metody twojej klasy, których nazwa zakończona jest wyrazem 'Action', aby znaleźć odpowiednią akcję kontrolera.

Na przykład, załóżmy, że twoja klasa jest zdefiniowana w ten sposób:

class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // zrób coś
    }

    public function bazAction()
    {
        // zrób coś
    }
}

Powyższa klasa FooController (kontroler 'foo') definiuje dwie akcje, 'bar' oraz 'baz'.

Można tu osiągnąć dużo więcej, na przykład: utworzyć własne akcje inicjalizacyjne, utworzyć domyślne akcje do wywołania gdy nie ma określonej akcji (lub określona jest nieprawidłowa), użyć metod pre- oraz post-dispatch oraz użyć wielu różnych metod pomocników. Ten rozdział jest rozeznaniem w funkcjonalnościach kontrolera akcji.

7.5.2. Inicjalizacja obiektu

O ile zawsze możesz nadpisać konstruktor kontrolera akcji, nie zalecamy tego. Zend_Controller_Action::__construct() przeprowadza kilka ważnych zadań, takich jak zarejestrowanie obiektów żądania i odpowiedzi, oraz przekazanie argumentów wywołania przez kontroler frontowy. Jeśli musisz nadpisać konstruktor, upewnij się że wywołasz parent::__construct($request, $response, $invokeArgs).

Bardziej odpowiednim sposobem skonfigurowania instancji jest użycie metody init(), która jest wywoływana jako ostatnie zadanie konstruktora __construct(). Na przykład jeśli chcesz połączyć się z bazą danych:

class FooController extends Zend_Controller_Action
{
    public function init()
    {
        $this->db = Zend_Db::factory('Pdo_Mysql', array(
            'host'     => 'myhost',
            'username' => 'user',
            'password' => 'XXXXXXX',
            'dbname'   => 'website'
        ));
    }
}

7.5.3. Metody Pre-Dispatch oraz Post-Dispatch

Klasa Zend_Controller_Action definiuje dwie metody, preDispatch() oraz postDispatch(), które mogą być wywołane przed i po wywołaniu akcji. Mogą one być użyteczne w wielu sytuacjach: weryfikowanie autentykacji oraz kontroli dostępu ACL odnośnie uruchamianej akcji, (przez wywołanie metody _forward() w metodzie preDispatch(), dzięki czemu akcja może być pominięta), lub na przykład umieszczenie wygenerowanej zawartości w głównym szablonie (postDispatch()).

7.5.4. Metody dostępowe

W obiekcie zarejestrowanych jest wiele obiektów oraz zmiennych i wszystkie mają metody dostępowe..

  • Obiekt żądania: metoda getRequest() może być użyta do odebrania obiektu żądania używanego do wywoływania akcji.

  • Obiekt odpowiedzi: metoda getResponse() może być użyta do odebrania obiektu odpowiedzi przechowującego finalną odpowiedź. Niektóre typowe wywołania mogą wyglądać tak:

    $this->getResponse()->setHeader('Content-Type', 'text/xml');
    $this->getResponse()->appendBody($content);
    
  • Argumenty wywołania: kontroler frontowy może przekazać parametry do routera, obiektu uruchamiającego oraz do kontrolera akcji. Aby je odebrać użyj metody getInvokeArg($key); alternatywnie pobierz całą listę używając metody getInvokeArgs().

  • Parametry żądania: Obiekt żądania przechowuje parametry żądania takie jak dowolne parametry z tablic _GET lub _POST oraz parametry użytkownika zdefiniowane w ścieżce adresu URL. Aby je odebrać, użyj metody _getParam($key) lub _getAllParams(). Możesz także ustawić parametry żądania używając metody _setParam(); jest to użyteczne gdy przenosimy do innych akcji.

    Aby sprawdzić czy parametr istnieje czy nie (co jest użyteczne przy wywołaniach logicznych), użyj _hasParam($key).

7.5.5. Metody narzędziowe

Oprócz metod dostępowych, klasa Zend_Controller_Action posiada kilka metod narzędziowych używanych do przeprowadzania ważnych zadań wewnątrz twoich metod akcji (lub wewnątrz metod pre-/post-dispatch).

  • _forward($action, $controller = null, $module = null, array $params = null): wykonuje inną akcję. Jeśli zostanie wywołana w metodzie preDispatch(), obecnie zażądana akcja zostanie pominięta, na rzecz nowej akcji. W przeciwnym wypadku, po wykonaniu obecnej akcji, będzie wywołana akcja zażądana w metodzie _forward().

  • _redirect($url, array $options = array()): przekierowuje do innej lokacji. Ta metoda przyjmuje w parametrze URL oraz opcjonalny zestaw opcji. Domyślnie przeprowadzane jest przekierowanie HTTP 302.

    Zestaw opcji może zawierać jeden lub więcej z poniższych kluczy:

    • exit: określa czy skrypt ma zakończyć działanie od razu po przekierowaniu. Jeśli tak, to skrypt zamknie wszystkie otwarte sesje i przeprowadzi przekierowanie.

      Możesz ustawić tę opcję globalnie wewnątrz kontrolera używając metody dostępowej setRedirectExit().

    • prependBase: określa czy bazowy adres URL zarejestrowany w obiekcie żądania ma być dołączony do adresu URL przekierowania.

      Możesz ustawić tę opcję globalnie wewnątrz kontrolera używając metody dostępowej setRedirectPrependBase().

    • code: kod HTTP do użycia podczas przekierowania. Domyślnie użyty jest kod HTTP 302; może być użyty dowolny kod pomiędzy 301 a 306.

      Możesz ustawić tę opcję globalnie wewnątrz kontrolera używając metody dostępowej setRedirectCode().

  • render($action = null, $name = null, $noController = false): renderuje skrypt widoku. Jeśli nie zostały przekazane argumenty, zostanie założone, że zażądanym skryptem jest [kontroler]/[akcja].phtml (gdzie .phtml jest wartością właściwości $viewSuffix). Jeśli przekazano wartość dla parametru $action, zostanie zrenderowany szablon z podkatalogu [kontroler]. Aby nie używać podkatalogu [kontroler], przekaż logiczną wartość true dla parametru $noController. Na koniec szablony są renderowane do obiektu odpowiedzi; jeśli chcesz zrenderować szablon do konkretnego segmentu w obiekcie odpowiedzi, przekaż wartość w parametrze $name.

    Kilka przykładów:

    <?php
    class MyController extends Zend_Controller_Action
    {
        public function fooAction()
        {
            // Renderuje plik my/foo.phtml
            $this->render();
    
            // Renderuje plik my/bar.phtml
            $this->render('bar');
    
            // Renderuje plik baz.phtml
            $this->render('baz', null, true);
    
            // Renderuje plik foo/login.phtml do segmentu 'form' obiektu odpowiedzi
            $this->render('login', 'form');
            
            // Renderuje plik site.phtml do segmentu 'page' obiektu odpowiedzi
            $this->render('site', 'page', true);
        }
    }
    
  • initView(): inicjuje obiekt widoku. Metoda render() wywołuje initView() w celu odebrania obiektu widoku, ale może on być zainicjowany w dowolnym momencie; domyślnie zapisywany jest on we właściwości $view. Metoda domyślnie używa klasy Zend_View, ale może użyć dowolnej klasy implementującej interfejs Zend_View_Interface.

    Domyślna implementacja zakłada taką strukturę katalogów:

    applicationOrModule/
        controllers/
            IndexController.php
        views/
            scripts/
                index/
                    index.phtml
            helpers/
            filters/
    

    Innymi słowy, założone jest, że skrypty widoków znajdują się w podkatalogu views/scripts/, a podkatalog views znajduje się w tym samym katalogu co katalog kontrolerów.

    Wywołaj metodę initView() w metodzie init() lub w metodach akcji swojego kontrolera jeśli potrzebujesz przypisać zmienne, zarejestrować filtry itp. Na przykład:

    <?php
    class MyController extends Zend_Controller_Action
    {
        public function init()
        {
            // Inicjujemy obiekt widoku
            $this->initView();
        }
    
        public function fooAction()
        {
            // Inicjujemy zmienne
            $this->view->foo = 'bar';
            $this->view->bar = 'baz';
    
            // Renderuje widok z przypisanymi zmiennymi 'foo' oraz 'bar'
            $this->render();
        }
    }
    
    class FooController extends Zend_Controller_Action
    {
        public function barAction()
        {
            // Inicjujemy obiekt widoku w konkretnej akcji
            $view = $this->initView();
    
            // Inicjujemy zmienne
            $view->foo = 'bar';
            $view->bar = 'baz';
    
            // Renderuje widok z przypisanymi zmiennymi 'foo' oraz 'bar'
            $this->render();
        }
    }
    
  • getViewScript($action = null, $noController = false): pobiera ścieżkę skryptów widoków. Metoda głównie użwana przez metodę render(), możesz wywołać ją w dowolnej chwili aby pobrać ścieżkę skryptów widoków, lub nadpisać metodę aby zmienić sposób określania ścieżek do skryptów widoków.

    Jako opisano wyżej w dokumentacji metody render(), domyślną funkcjonalnością jesty poszukiwanie skryptu widoku nazwanego [kontroler]/[akcja].phtml. Podanie parametru $action nadpisze nazwę pliku skryptu widoku, a przekazanie logicznej wartości true w parametrze $noController spowoduje poszukiwanie pliku z pominięciem podkatalogu kontrolera. Możesz także nadpisać właściwość $viewSuffix aby zmienić używane rozszerzenie plików (domyślnie .phtml).

    Nadpisz tę metodę aby zapewnić alternatywną funkcjonalność określeającą nazwę pliku skryptu widoku oraz ścieżkę.