The Yaf_Plugin_Abstract class

(Yaf >=1.0.0)

Introduction

Plugins allow for easy extensibility and customization of the framework. A plugin is a class extending Yaf_Plugin_Abstract that overrides one or more hook methods, which are called automatically at fixed points of the dispatch cycle: before and after routing, before and after the dispatch loop, and before and after each single dispatch.

A plugin is attached to the dispatcher with Yaf_Dispatcher::registerPlugin(), typically in the Bootstrap; after registration, all the hook methods the plugin implements are called at the proper time, each receiving the current Yaf_Request_Abstract and Yaf_Response_Abstract instances.

Examples

Example #1 Plugin example

<?php
   /* bootstrap class should be defined under ./application/Bootstrap.php */
   class Bootstrap extends Yaf_Bootstrap_Abstract {
        public function _initPlugin(Yaf_Dispatcher $dispatcher) {
            /* register a plugin */
            $dispatcher->registerPlugin(new TestPlugin());
        }
   }

   /* plugin class should be placed under ./application/plugins/ */
   class TestPlugin extends Yaf_Plugin_Abstract {
        public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            /* before router 
               in this hook,  user can do some url rewrite */
            var_dump("routerStartup");
        }
        public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {
            /* router complete 
               in this hook, user can do login check */
            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) {
            /* final hook
               in this hook user can do logging or implement layout */
            var_dump("dispatchLoopShutdown");
        }
   }

   Class IndexController extends Yaf_Controller_Abstract {
        public function indexAction() {
            return FALSE; //prevent rendering
        }
   }

   $config = array(
       "application" => array(
           "directory" => dirname(__FILE__) . "/application/",
       ),
   );
 
   $app = new Yaf_Application($config);
   $app->bootstrap()->run();
?>

The above example will output something similar to:

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

Class synopsis

class Yaf_Plugin_Abstract {

/* Methods */

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

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

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

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

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

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

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

}

Yaf_Plugin_Abstract::dispatchLoopShutdown — Hook after dispatch loop
Yaf_Plugin_Abstract::dispatchLoopStartup — Hook before dispatch loop
Yaf_Plugin_Abstract::postDispatch — Hook after each dispatch
Yaf_Plugin_Abstract::preDispatch — Hook before each dispatch
Yaf_Plugin_Abstract::preResponse — Hook before the response is sent
Yaf_Plugin_Abstract::routerShutdown — Hook after routing
Yaf_Plugin_Abstract::routerStartup — Hook before routing

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

gianjason#gmail.com ¶

13 years ago

All the methods which the plugin implemented according to this interface, will be called at the proper time automatically.