A classe Yaf_Plugin_Abstract

(Yaf >=1.0.0)

Introdução

Os plugins permitem fácil extensibilidade e personalização da estrutura.

Plugins são classes. A definição real da classe irá variar de acordo com o componente - pode ser necessário implementar esta interface, mas o fato é que o próprio plugin é uma classe.

Um plugin pode ser carregado no Yaf usando Yaf_Dispatcher::registerPlugin(). Após o registro, todos os métodos que o plugin implementou de acordo com esta interface serão chamados no momento apropriado.

Exemplos

Exemplo #1 Exemplo de plugin

<?php
   /* A classe Bootstrap deve ser definida em ./application/Bootstrap.php */
   class Bootstrap extends Yaf_Bootstrap_Abstract {
        public function _initPlugin(Yaf_Dispatcher $dispatcher) {
            /* registrar um plugin */
            $dispatcher->registerPlugin(new TestPlugin());
        }
   }

   /* a classe do plugin deve ser colocada em ./application/plugins/ */
   class TestPlugin extends Yaf_Plugin_Abstract {
        public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            /* Antes do roteamento.
               Neste gancho, o usuário pode reescrever o URL. */
            var_dump("routerStartup");
        }
        public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            /* Roteamento completo.
               Neste gancho, o usuário pode verificar o login. */
            var_dump("routerShutdown");
        }
        public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            var_dump("dispatchLoopStartup");
        }
        public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            var_dump("preDispatch");
        }
        public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            var_dump("postDispatch");
        }
        public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            /* Gancho final.
               Neste gancho o usuário pode fazer log ou implementar layout. */
            var_dump("dispatchLoopShutdown");
        }
   }

   Class IndexController extends Yaf_Controller_Abstract {
        public function indexAction() {
            return FALSE; // evita a renderização
        }
   }

   $config = array(
       "application" => array(
           "directory" => dirname(__FILE__) . "/application/",
       ),
   );

   $app = new Yaf_Application($config);
   $app->bootstrap()->run();
?>

O exemplo acima produzirá algo semelhante a:

string(13) "routerStartup"
string(14) "routerShutdown"
string(19) "dispatchLoopStartup"
string(11) "preDispatch"
string(12) "postDispatch"
string(20) "dispatchLoopShutdown"

Resumo da classe

class Yaf_Plugin_Abstract {

/* Métodos */

public dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public preResponse(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

public routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response): void

}

Índice

Yaf_Plugin_Abstract::dispatchLoopShutdown — dispatchLoopShutdown
Yaf_Plugin_Abstract::dispatchLoopStartup — Gancho antes do loop de despacho
Yaf_Plugin_Abstract::postDispatch — postDispatch
Yaf_Plugin_Abstract::preDispatch — preDispatch
Yaf_Plugin_Abstract::preResponse — preResponse
Yaf_Plugin_Abstract::routerShutdown — routerShutdown
Yaf_Plugin_Abstract::routerStartup — Gancho RouterStartup