rkr/simple-router

A simple wildcard matcher

dev-master 2015-12-07 14:31 UTC

Requires

• php: >= 5.4.0
• psr/http-message: 1.*
• rkr/php-ioc-contract: *
• rkr/recursive-array-accessor: 3.*

Requires (Dev)

• phpunit/phpunit: 3.7.*
• rkr/php-di-ioc-adapter: *

MIT

• Ron Kirschler

README

A simple, nearly unopinionated routing approach.

Workflow:

1.) Define some routes. Routes are some arrays identified by a unique key. The data-part is completely up to you. If you want something special in you data-part, go on and define it there.

2.) Instantiate Router and pass the routes-array to it. The router does nothing more than lookup a data-array who's key is matching the incoming REQUEST_URI (for example). So the return-value of $router->lookup() is the value-part of the matching key.

3.) Do something with the data-array. For example, you can merge the $_GET- or $_POST-params into some data-key, do some post-processing, whatever.

4.) Optionally utilize a Dispatcher to call some arbitrary class.

This is what the bootstrap could look like:

// Setup some test-request-parameters
$_SERVER['REQUEST_URI'] = '/some/path/10';
$_SERVER['REQUEST_METHOD'] = 'GET';

// Should get overwritten by the /10 above
$_GET['start'] = 20;

$_SERVER = array_merge(['REQUEST_URI' => '/', 'REQUEST_METHOD' => 'GET'], $_SERVER);

$routes = [
  'GET /' => ['class' => IndexCtrl::class, 'method' => 'start'],
  'GET /some/path' => ['class' => LoginCtrl::class, 'method' => 'test'],
  'GET /some/path/:start' => ['class' => 'UserCtrl::class', 'method' => 'test'],
  'GET /list:start?type=gallery' => ['class' => 'ProductsCtrl::class', 'method' => 'showGallery'],
];

$router = new Router($routes);
$data = $router->lookup($_SERVER['REQUEST_URI'], $_SERVER['REQUEST_METHOD'], $_REQUEST);

print_r($data); // ['data' => ['class' => IndexCtrl::class, 'method' => 'start'], 'params' => []]