codeinc/router

Code Inc. PSR7 & PSR15 router library

Monday, May 7, 2018
by joanfabregat
Repository
1 Watchers
2 Stars
18 Installations

PHP
0 Dependents
6 Suggesters
0 Forks
1 Open issues
59 Versions
6 % Grown

The README.md

PSR-7 & PSR-15 router library

This library provides a PSR-7 and PSR-15 compatible router. The router is a component in charge or selecting the appropriate controller (implementing ControllerInterface). It behaves as a PSR-15 middleware (MiddlewareInterface)., _(*1)

Resolvers

In order to select a controller, the router relies on a resolver (implementing ResolverInterface). Resolvers are in charge of matching a URI path (called a route) to a controller and vice versa, mapping a controller to a route. Two resolvers are provided, StaticResolver which uses a list of preset patterns (shell patterns resolved by fnmatch()) matching handler's classes and DynamicResolver which dynamically calculates the routes of namespaces base on a PHP namespace and a base URI. You can pair multiple resolvers using ResolverAggregator. External packages provides resolvers based on Doctrine's annotations or on interfaces., _(*2)

Usage

Basic usage

<?php
use CodeInc\Router\Router;
use CodeInc\Router\ControllerInterface;
use CodeInc\Router\Resolvers\StaticResolver;

// dummy classes 
final class MyInstantiator implements ControllerInterface {}
final class HomePage implements ControllerInterface {}
final class License implements ControllerInterface {}
final class Article implements ControllerInterface {}

// instantiating the router
$myRouter = new Router(
    new StaticResolver([
        '/' => HomePage::class,
        '/license.txt' => License::class,
        '/article-[0-9]/*' => Article::class
    ])
);

// controller lookup (assuming the URI of the request is "/article-2456/a-great-article.html") 
$myRouter->process($aPsr7ServerRequest, $aFallbackHandler); // <-- returns 'ArticleController'

Working with multiple resolvers and multiple instantiators

<?php
use CodeInc\Router\Router;
use CodeInc\Router\ControllerInterface;
use Doctrine\Instantiator\InstantiatorInterface;
use CodeInc\Router\Resolvers\ResolverAggregator;
use CodeInc\Router\Resolvers\StaticResolver;
use CodeInc\Router\Resolvers\DynamicResolver;

// dummy classes 
final class MyFirstInstantiator implements InstantiatorInterface {}
final class MySecondInstantiator implements InstantiatorInterface {}
final class HomePage implements ControllerInterface {}
final class License implements ControllerInterface {}
final class Article implements ControllerInterface {}

// instantiating the router
$myRouter = new Router(
    new ResolverAggregator([
        new StaticResolver([
            '/' => HomePage::class,
            '/license.txt' => License::class,
            '/article-[0-9]/*' => Article::class
        ]),
        new DynamicResolver(
            'MyApp\\MyHandlers', // <-- handlers base namespace
            '/my-app/' // <-- handlers base URI
        )
    ])
);

// processing the response
$myRouter->process($aPsr7ServerRequest, $aFallbackHandler);

Installation

This library is available through Packagist and can be installed using Composer:, _(*3)

composer require codeinc/router

License

This library is published under the MIT license (see the LICENSE file)., _(*4)

The Versions

07/05 2018

dev-master

9999999-dev https://github.com/CodeIncHQ/Router

Code Inc. PSR7 & PSR15 router library

library router

Code Inc. PSR7 & PSR15 router library

codeinc/router

The README.md

PSR-7 & PSR-15 router library

Resolvers

Usage

Basic usage

Working with multiple resolvers and multiple instantiators

Installation

License

The Versions

dev-master

The Requires

The Development Requires

by Joan Fabrégat

2.3.1

The Requires

The Development Requires

by Joan Fabrégat

2.x-dev

The Requires

The Development Requires

by Joan Fabrégat

2.3.1-beta.1

The Requires

The Development Requires

by Joan Fabrégat

2.3.0

The Requires

The Development Requires

by Joan Fabrégat

2.2.0

The Requires

The Development Requires

by Joan Fabrégat

2.1.0

The Requires

The Development Requires

by Joan Fabrégat

2.0.0

The Requires

The Development Requires

by Joan Fabrégat

2.0.0-beta.5

The Requires

The Development Requires

by Joan Fabrégat

2.0.0-beta.4

The Requires

The Development Requires

by Joan Fabrégat

2.0.0-beta.3

The Requires

The Development Requires

by Joan Fabrégat

2.0.0-beta.2

The Requires

The Development Requires

by Joan Fabrégat

2.0.0-beta.1

The Requires

The Development Requires

by Joan Fabrégat

1.5.1

The Requires

The Development Requires

by Joan Fabrégat

1.5.0

The Requires

The Development Requires

by Joan Fabrégat

1.4.0

The Requires

The Development Requires

by Joan Fabrégat

1.x-dev

The Requires

The Development Requires

by Joan Fabrégat