Yaf_Router::getRoute

(Yaf >=1.0.0)

Yaf_Router::getRoute — Retrieve a route by name

Description

public function Yaf_Router::getRoute(string $name): Yaf_Route_Interface

Retrieve a route by name, see also Yaf_Router::getCurrentRoute()

Parameters

This function has no parameters.

Return Values

Examples

Example #1 Yaf_Router::getRoute() example

<?php
class Bootstrap extends Yaf_Bootstrap_Abstract
{
    public function _initRoutes(Yaf_Dispatcher $dispatcher)
    {
        $router = $dispatcher->getRouter();

        $router->addRoute("rewrite", new Yaf_Route_Rewrite(
            "/product/:id",
            ["controller" => "product", "action" => "detail"]
        ));

        /* check what was registered under a given name */
        var_dump($router->getRoute("rewrite"));

        /* an unknown name returns NULL */
        var_dump($router->getRoute("unknown"));
    }
}
?>

The above example will output something similar to:

object(Yaf_Route_Rewrite)#7 (0) {
}
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.