PHP 8.5.10 Released!

Yaf_Plugin_Abstract::preDispatch

(Yaf >=1.0.0)

Yaf_Plugin_Abstract::preDispatchHook 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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top