php8.5
Home/ Manual/ yaf / yaf_router/ Yaf_Router::getRoute

Yaf_Router::getRoute

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Retrieve a route by name

Description

Yaf_Router::getRoute(string $name): Yaf_Route_Interface

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

Parameters Parameters

Return Values

Examples

Yaf_Router::getRoute example

php
<?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:

output
object(Yaf_Route_Rewrite)#7 (0) {
}
NULL

See Also

  • Yaf_Bootstrap_Abstract
  • Yaf_Plugin_Abstract
  • Yaf_Router::addRoute
  • Yaf_Router::getCurrentRoute

Source: reference/yaf/yaf_router/getroute.xml · from the official PHP manual (php/doc-en)