Meek-Routing Component

![Scrutinizer Build Status][build-image] ![Scrutinizer Coverage][code-coverage-image] , _(*1)

A simple framework for routing., _(*2)

Install

with Composer:, _(*3)

composer require nbish11/meek-routing

Usage

Using the router as a proxy will probably be the most common usage:, _(*4)

<?php
// bootstrapping...
error_reporting(-1);
date_default_timezone_set('Australia/Brisbane');

require_once 'vendor/autoload.php';

use Psr\Http\Message\ServerRequestInterface;
use Meek\Routing\Rule\MatchMethod;

// setup...
$request = Zend\Diactoros\ServerRequestFactory::fromGlobals();
$router = Meek\Routing\Router::create();

// adding `Route` objects manually.
$router->add(new Meek\Routing\Route(
    'api.users.retrieve',
    '/api/:version/users/:id',
    function (ServerRequestInterface $request) {
        return sprintf(
            'retrieving... %s... %s...',
            $request->getAttribute('version'),
            $request->getAttribute('id')
        );
    }
));

// using built-in rules.
$router->delete('/users/:id', function (ServerRequestInterface $request) {
    return sprintf('Deleting user: "%s"', $request->getAttribute('id'));
})->addRule(new MatchMethod());

// custom rules
$router->get('/admin', function (ServerRequestInterface $request) {
    return 'Admin Section...';
})->addRule(function () {
    // authentication logic goes here
});

// catch all route (without method matching).
$router->map('vanity', '/:username', function (ServerRequestInterface $request) {
    return sprintf('Hello, %s!', $request->getAttribute('username'));
});

$router->dispatch($request);

Testing

This project uses PHPUnit for assertions and Zend\Diactoros for mocking incoming requests, and such. To run unit tests simply run the following command:, _(*5)