array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-route-rewrite.route.php', 1 => 'Yaf_Route_Rewrite::route', 2 => 'Route a request', ), 'up' => array ( 0 => 'class.yaf-route-rewrite.php', 1 => 'Yaf_Route_Rewrite', ), 'prev' => array ( 0 => 'yaf-route-rewrite.construct.php', 1 => 'Yaf_Route_Rewrite::__construct', ), 'next' => array ( 0 => 'class.yaf-router.php', 1 => 'Yaf_Router', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_route_rewrite/route.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Route_Rewrite::route

(Yaf >=1.0.0)

Yaf_Route_Rewrite::route — Route a request

Description

public function Yaf_Route_Rewrite::route(Yaf_Request_Abstract $request): bool

Route the request by matching the URI against the match pattern given to the constructor. When it matches, the module, controller and action are taken from the route array, where a value starting with a colon is resolved from the matched variables.

Parameters

request

The Yaf_Request_Abstract instance to route.

Return Values

Returns true if the URI matches, false otherwise, which makes the router try the next route.

Examples

Example #1 Yaf_Route_Rewrite::route() example

<?php
/* assume the request URI is "/product/php-book" */
$request = new Yaf_Request_Http("/product/php-book");

$route = new Yaf_Route_Rewrite(
    "/product/:name",             // match a URI leading "/product"
    array(
        'controller' => "product", // route to the product controller
    ),
    array()                        // no default values
);

var_dump($route->route($request));

var_dump($request->getControllerName());
var_dump($request->getParam("name"));
?>

The above example will output something similar to:

bool(true)
string(7) "product"
string(8) "php-book"

See Also