Contents

URL route patterns follow an easy to read syntax and use in-place named parameters, so there is no need to use regular expressions in most cases.

Creating a route

You should prepare your route like so:

$router = new Router;

// New route with ID: myRouteId
$router->route('myRouteId', '/post/:id');

// New route with ID: anotherRouteId
$router->route('anotherRouteId', '/profile/:username');

Route matching

Once you have prepared your route you can match it like this:

if ($router->match('/post/2')) {

    // Returns: [id => 2]
    $params = $router->getParameters(); 

    // Returns: myRouteId
    $routeId = $router->matchedRoute(); 
}

Reverse matching

You can also reverse match a route by it's identifier:

// Returns: /post/2
$url = $router->url('myRouteId', ['id' => 2]);

Compiled route caching

Routes compile automatically on the first match into optimized lookup structures (a hash map for static routes and a combined regex for dynamic routes). The compiled state can be stored and restored to skip compilation entirely, similar to Laravel's route caching:

// Store the routes with their compiled state
$cached = $router->toArray();

// Restore later, no recompilation needed
$router = new Router;
$router->fromArray($cached);

// Alternatively, save to and load from a PHP file
$router->saveCompiledRoutes('/path/to/routes.php');
$router = Router::loadCompiledRoutes('/path/to/routes.php');