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

Yaf_Plugin_Abstract::routerShutdown

(Yaf >=1.0.0)

Yaf_Plugin_Abstract::routerShutdown — Hook after routing

Description

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

This hook is triggered after the routing process has finished and the controller and action names have been resolved, but before the dispatch loop starts. It is usually used for access control checks such as a login check, because the target controller and action are already known.

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::routerShutdown() example

<?php
class AuthPlugin extends Yaf_Plugin_Abstract
{
    public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response)
    {
        /* routing is done, so the target controller and action are
         * known: check whether the user may access them */
        $public = array("Index" => array("index"), "User" => array("login"));

        $controller = $request->getControllerName();
        $action = $request->getActionName();

        if (isset($public[$controller]) && in_array($action, $public[$controller])) {
            return;
        }

        if (!Yaf_Session::getInstance()->has("login")) {
            $response->setRedirect("/user/login");
            $request->setDispatched(true); // do not dispatch the request
        }
    }
}

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

See Also