allmarkedup/super-sharp-router

A sharp little routing library for PHP 5.4+

v0.2 2014-10-30 10:28 UTC

Requires

• symfony/http-foundation: ~2.5
• symfony/http-kernel: ~2.5
• symfony/routing: ~2.5

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.3

MIT

• Mark Perkins

README

A simple, elegant routing library for PHP 5.4+.

Inspired by (and largely extracted from) Silex routing and built on Symfony components.

• Installation
• Examples

Installation

Using Composer:

$ composer require allmarkedup/super-sharp-router

Examples

The hello world example:

<?php
$router = new Amu\SuperSharp\Router();

$router->get('/hello', function(){
    return 'Hello world!';
});

echo $router->match('/hello'); // Prints: Hello World!

Matching against the current request and returning a response object:

<?php
use Amu\SuperSharp\Http\Response;
use Symfony\Component\Routing\Exception\RouteNotFoundException;

$router = new Amu\SuperSharp\Router();
$router->get('/', function(){
    return new Response('This is the homepage');
});

try {
    $response = $router->match(); // matches against the current request
} catch (ResourceNotFoundException $e) {
    $response = new Response('No matching route found', 404);
}

$response->send();

HTTP-verb based methods, dynamic route parameters and fluent route configuration:

<?php

$router->post('/articles', function(){
    return 'Article added!';
});

$router->get('/articles/{slug}', function($slug){
    return Example::find($slug);
});

$router->get('/users/{id}', function($id){
    return Example::find($id);
})
->assert('id', '\d') // $id route parameter must be a digit
->requireHttps();    // Must be HTTPS

Running tests

Tests can be run using PHP Unit from the command line:

$ vendor/bin/phpunit

The project also includes a Grunt watch task to run the PHP Unit tests when files are updated which you can use for your convenience.