superatom/routing

The Superatom Routing package.

Superatom Routing

This library provides a regular expression based fast routing., _(*1)

Acknowledgment

Original regex matching implementation by nikic/FastRoute.
Very thanks to nikic and other contributors., _(*2)

Install

Require this package in your composer.json, _(*3)

"superatom/routing": "1.*"

Usage

Hello world example

<?php
require_once '/path/to/vendor/autoload.php';

$handler = new \Superatom\Routing\RouteHandler();
$generator = new \Superatom\Routing\RouteDataGenerator();
$router = new \Superatom\Routing\Router($handler, $generator);
$router->get('/', function()
{
    return 'Hello world!';
});

echo $router->handle($_SERVER['REQUEST_METHOD'], $_SERVER['REQUEST_URI']);

Save as hello.php
And run in terminal php -S localhost:8080 hello.php
Open localhost:8080/ in browser., _(*4)

Route with parameter

$router->get('/hello/:name', function($name)
{
    return "Hello {$name}!";
}, $name_for_this_route = 'hello');

Open localhost:8080/hello/atom in browser., _(*5)

Reverse routing

$router->get('/:var1/:var2', function($var1, $var2)
{
    return "got {$var1} and {$var2}";
}, 'route1');

echo $router->urlFor('route1', ['var1' => 'hoge', 'var2' => 'piyo']);

Custom route handler

use \Superatom\Routing\Route;

class ControllerHandler implements \Superatom\Routing\RouteHandlerInterface
{
    /**
     * @param Route $route
     * @return mixed
     */
    public function handleRoute(Route $route)
    {
        list($class, $method) = explode('@', $route->getHandler());
        $controller = new $class();

        // controller setup...
        // e.g. Dependency injection

        $handler = [$controller, $method];

        return call_user_func_array($handler, $route->getVariables());
    }
}

class HelloController
{
    public function greeting($name)
    {
        return "Hello {$name}!";
    }
}

$handler = new ControllerHandler();
$generator = new \Superatom\Routing\RouteDataGenerator();
$router = new \Superatom\Routing\Router($handler, $generator);
$router->get('/hello/:name', 'HelloController@greeting');

echo $router->handle($_SERVER['REQUEST_METHOD'], $_SERVER['REQUEST_URI']);

Open localhost:8080/hello/atom in browser., _(*6)

License

MIT, _(*7)