istok/router

Basic routing component

0.0.3 2022-05-06 17:59 UTC

Requires

• php: ^8.1
• phpunit/phpunit: ^9.5
• vimeo/psalm: ^4.22

MIT

• programmer

README

composer require istok/router

Basic router

• matching given Request (essentially array<string,string>) to mixed $handler
• comes with implementation suitable for http request
• Support variables, like /post/{id}/
• build to play with istok/container
• (I hope) it can be easily extended to route something else than http (console, queue)

Usage (currently no sugar provided)

Working example in example.com, don't forget to install dependencies first.

use Istok\Router\Router;
use Istok\Router\Route;
use Istok\Router\Http\HttpTemplate;
use Istok\Router\Http\HttpRequest;

// define single router entry
$route = new Route(
    // provide template interface
    new HttpTemplate('/post/{id}/show', 'GET', '{user}.example.com'),
    // provide handler
    fn($id, $user) => print "User: $user, id: $id"
);

// setup router, add our single route
$router = new Router($route);

// special http-oriented implementation of Request interface
$request = new HttpRequest('/post/abc/show', 'GET', 'user1.example.com');

// match route to request
$result = $router->find($request);

// execute result,
// $result->arguments contains ['user' => 'user1', 'id' => 'abc']  
($result->route->handler)(...$result->arguments); // User: user1, id: abc 

How to capture rest part of template

Last one in path

$template =  new HttpTemplate('/post/{url*}'),

will match /post/abc/def, with arguments ['url' => 'abc/def']

Similar in host

$template =  new HttpTemplate('/', host: '{subdomain*}.example.com'),

will match abc.def.example.com, with arguments ['subdomain' => 'abc.def']