array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-request-abstract.setdispatched.php', 1 => 'Yaf_Request_Abstract::setDispatched', 2 => 'Mark the request as dispatched', ), 'up' => array ( 0 => 'class.yaf-request-abstract.php', 1 => 'Yaf_Request_Abstract', ), 'prev' => array ( 0 => 'yaf-request-abstract.setcontrollername.php', 1 => 'Yaf_Request_Abstract::setControllerName', ), 'next' => array ( 0 => 'yaf-request-abstract.setmodulename.php', 1 => 'Yaf_Request_Abstract::setModuleName', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_request_abstract/setdispatched.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Request_Abstract::setDispatched

(Yaf >=1.0.0)

Yaf_Request_Abstract::setDispatched — Mark the request as dispatched

Description

final public function Yaf_Request_Abstract::setDispatched(bool $flag = true): Yaf_Request_Abstract

Mark the request as dispatched

This is called by the dispatcher after an action is executed; it stops the dispatch loop. It can be called manually, e.g. to skip the remaining dispatch iterations.

Parameters

flag

The state to set. Defaults to true.

Return Values

Returns the request object itself.

Examples

Example #1 Yaf_Request_Abstract::setDispatched() example

<?php
class AuthPlugin extends Yaf_Plugin_Abstract
{
    public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response)
    {
        if (empty($_SESSION["user_id"])) {
            // Skip the requested action and redirect to the login page
            $request->setDispatched();
            $response->setRedirect("/account/login");
        }
    }
}
?>

See Also