array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-plugin-abstract.predispatch.php', 1 => 'Yaf_Plugin_Abstract::preDispatch', 2 => 'Hook before each dispatch', ), 'up' => array ( 0 => 'class.yaf-plugin-abstract.php', 1 => 'Yaf_Plugin_Abstract', ), 'prev' => array ( 0 => 'yaf-plugin-abstract.postdispatch.php', 1 => 'Yaf_Plugin_Abstract::postDispatch', ), 'next' => array ( 0 => 'yaf-plugin-abstract.preresponse.php', 1 => 'Yaf_Plugin_Abstract::preResponse', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_plugin_abstract/predispatch.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Plugin_Abstract::preDispatch

(Yaf >=1.0.0)

Yaf_Plugin_Abstract::preDispatch — Hook before each dispatch

Description

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

This hook is triggered before each dispatch iteration in the dispatch loop. A dispatch loop may run several iterations, so this hook may be called more than once per request.

Parameters

request

The Yaf_Request_Abstract instance being dispatched.

response

The Yaf_Response_Abstract instance.

Return Values

No value is returned.

Examples

Example #1 Yaf_Plugin_Abstract::preDispatch() example

<?php
class LayoutPlugin extends Yaf_Plugin_Abstract
{
    public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response)
    {
        /* pick the template directory based on the module, right
         * before the action is dispatched */
        $view = Yaf_Dispatcher::getInstance()->getView();
        if ($request->getModuleName() == "Admin") {
            $view->setScriptPath(APPLICATION_PATH . "/modules/admin/views");
        }
    }
}

/* plugins are registered in the bootstrap */
class Bootstrap extends Yaf_Bootstrap_Abstract
{
    public function _initPlugin(Yaf_Dispatcher $dispatcher)
    {
        $dispatcher->registerPlugin(new LayoutPlugin());
    }
}
?>

See Also