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");
        }
    }
}
?>

Yaf_Request_Abstract::setDispatched

Description

Parameters

Return Values

Examples

See Also