razonyang/php-routing

a fast and flexible HTTP Router

PHP Routing

, _(*1)

A fast, flexible and scalable HTTP router for PHP., _(*2)

Features

• Easy to design RESTful API
• Full Tests
• Flexible and scalable: it allows you to define your own handler to deal with Not Found, Method Not Allowed and OPTIONS request.
• No third-party library dependencies
• Named Param Placeholder
• Detect all request methods of the specify path
• Straightforward documentation

Requirements

• PHP - 7.0, 7.1, 7.2 and master are supported.

Install

composer require razonyang/php-routing

Documentation

include '/path-to-vendor/autoload.php';

use RazonYang\Routing\Router;

// create an router instance
$router = new Router();

Register handler

Router::handle($method, $path, $handler);

• method - string or array, such as GET, GET|POST(split by |, without spaces), ['GET', 'POST']
• path - the path MUST start with slash /, such as /, /users, /users/<username>.
• handler - mixed, whatever you want.

Examples, _(*3)

It also provides a few shortcuts for registering handler:, _(*4)

• Router::delete
• Router::get
• Router::post
• Router::put

$router->get('/', 'handler');

$router->handle('GET|POST', '/users', 'handler');

$router->handle(['GET', 'POST'], '/merchants', 'handler');

$router->get('/users/<username>', 'handler');

$router->get('/orders/<order_id:\d+>', 'handler');

Dispatch request

Router::dispatch($method, $path);

• method - request method.
• path - URI path.

If matched, a Route instance will be returns, null otherwise or NotFoundException/MethodNotAllowedException will be thrown., _(*5)

$path = '/users/baz';
$route = $router->dispatch(Router::METHOD_GET, $path);

// handle requset
$handler = $route->handler; // 'handler'
$params = $route->params; // ['username' => 'baz']

Named Params Placeholder

As the examples shown above, Router has ability to detect the param's value of the path., _(*6)

In general, an placeholder pattern MUST be one of <name> and <name:regex>, it will be converted to ([^/]+) and (regex) respectively. You can also change it via replace the Router::$replacePatterns and Router::$replacements., _(*7)

RESTful API

As the examples shown above, it is obviously easy to design a RESTful API application., _(*8)

$router->get('/products', 'products');
$router->post('/products', 'create product');
$router->get('/products/<product_id:\d+>', 'product detail');
$router->put('/products/<product_id:\d+>', 'update product');
$router->delete('/products/<product_id:\d+>', 'delete product');

Not Found Handler

$router->notFoundHandler = function($method, $path) {
    throw new \Exception('404 Not Found');
};

Method Not Allowed Handler

$router->methodNotAllowedHandler = function($method, $path, $allowedMethods) {
    throw new \Exception('405 Method Not Allowed');
};

OPTIONS Handler

$router->optionsHandler = function($method, $path, $allowedMethods) {
    header('Allow: ' . implode(',', $allowedMethods));
};

FAQ

Package Not Found

Please add the following repository into repositories when composer complains about that Could not find package razonyang/php-routing ...., _(*9)

{
    "type": "git",
    "url": "https://github.com/razonyang/php-routing.git"
}