README

Obullo router is a standalone route package inspired by the Django Url Dispatcher.

Install

$ composer require obullo/router

Requirements

The following versions of PHP are supported by this version.

• 7.0
• 7.1
• 7.2

Testing

$ vendor/bin/phpunit

Quick start

require '../vendor/autoload.php';

use Obullo\Router\Route;
use Obullo\Router\RequestContext;
use Obullo\Router\RouteCollection;
use Obullo\Router\Router;
use Obullo\Router\Types\{
    StrType,
    IntType
};
$config = array(
    'types' => [
        new IntType('<int:id>'),
        new StrType('<str:name>'),
    ]
);

Psr7 Request

$request = Zend\Diactoros\ServerRequestFactory::fromGlobals();
$context = new RequestContext;
$context->fromRequest($request);

Route Collection

$collection = new RouteCollection($config);
$collection->setContext($context);
$collection->add('home', new Route(['path' => '/', 'handler' => 'App\Controller\DefaultController::index'));
$collection->add(
    'dummy',
    new Route(
        [
            'method' => 'GET',
            'path' => '/dummy/index/<int:id>/<str:name>',
            'handler' => 'App\Controller\DummyController::index'
            'middleware' => ['App\Middleware\Dummy::class']
        ]
    )
);

Route Class

$route = $collection->get('dummy');

echo $route->getHandler(); //  "App\Controller\DummyController::index"
echo $route->getMethods()[0]; // GET
echo $route->getPattern(); //  "/dummy/index/(?\d+)/(?\w+)"
echo $route->getStack()[0]; // App\Middleware\Dummy::class

Dispatching

$router = new Router($collection);

if ($route = $router->matchRequest()) {

    $handler = $route->getHandler();
    $args = array_merge(array('request' => $request), $route->getArguments());
    $response = null;
    if (is_callable($handler)) {
        $exp = explode('::', $handler);
        $class = new $exp[0];
        $method = $exp[1];
        $response = call_user_func_array(array($class, $method), $args);
    }
    if ($response instanceof Psr\Http\Message\ResponseInterface) {
        echo $response->getBody();  // DummyController::index
    }
}

App\Controller\DummyController

namespace App\Controller;

use Zend\Diactoros\Response\HtmlResponse;
use Psr\Http\Message\RequestInterface as Request;

class DummyController
{
    public function index(Request $request)
    {
        return new HtmlResponse('DummyController::index');
    }
}

YAML example

Yaml basic

home: 
    path: /
    handler: App\Controller\DefaultController::index
    $variable:
        - test_route_value

dummy:
     path: /<locale:locale>/dummy/<str:name>
     handler: App\Controller\DefaultController::dummy
     middleware: App\Middleware\Dummy

Yaml group

user/:
    $variable:
        - test_pipe_value
    host: router
    scheme: http
    middleware: 
        - App\Middleware\Auth
        - App\Middleware\Dummy
    dummy:
        path: /dummy/<str:name>
        handler: App\Controller\UserController::dummy
    dummy_with_id:
        path: /dummy/<str:name>/<int:id>
        handler: App\Controller\UserController::dummy
    lucky:
        path: /lucky/<str:name>/<slug:slug>
        handler: App\Controller\DefaultController::lucky

Parsing yaml

use Obullo\Router\Route;
use Obullo\Router\RequestContext;
use Obullo\Router\RouteCollection;
use Obullo\Router\Router;
use Obullo\Router\Builder;
use Obullo\Router\Generator;
use Obullo\Router\Types\{
    StrType,
    IntType,
    SlugType,
    TranslationType
};
$config = array(
    'patterns' => [
        new IntType('<int:id>'),
        new StrType('<str:name>'),
        new SlugType('<slug:slug>'),
        new TranslationType('<locale:locale>'),
    ]
);
$request = Zend\Diactoros\ServerRequestFactory::fromGlobals();
$context = new RequestContext;
$context->fromRequest($request);

$collection = new RouteCollection($config);
$collection->setContext($context);

use Symfony\Component\Yaml\Yaml;

$builder = new Builder($collection);
$collection = $builder->build(Yaml::parseFile('/var/www/myproject/App/routes.yaml'));

if ($route = $router->matchRequest()) {

    $handler = $route->getHandler();
    $methods = $route->getMethods();

    print_r($route->getAttribute('variable')); // test_route_value
}

Documentation

Documents are available at http://obullo.com/