Yaf_Request_Abstract::setRouted

(Yaf >=1.0.0)

Yaf_Request_Abstract::setRouted — Mark the request as routed

Description

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

Mark the request as routed

This is called by the router once routing has succeeded. Calling it manually can prevent custom routers from being run afterwards.

Parameters

flag

The state to set. Defaults to true.

Return Values

Returns the request object itself.

Examples

Example #1 Yaf_Request_Abstract::setRouted() example

<?php
class ApiRouter extends Yaf_Route_Interface
{
    public function route(Yaf_Request_Abstract $request)
    {
        if (0 !== strpos($request->getRequestUri(), "/api/")) {
            return false;
        }

        $request->setControllerName("Api")
                ->setActionName("handle");

        // Prevent routers registered after this one from running
        $request->setRouted();

        return true;
    }

    public function assemble(array $info, array $query = null) {}
}
?>

See Also

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
＋add a note

User Contributed Notes

There are no user contributed notes for this page.