Simple PHP Router

A real simple PHP Router for PHP 7.1+ inspired on PHP Router and Klein.php

Features

• Pre defined regular expression routing.
• Flexible to add new custom regular expressions.
• Use URL segments as parameters.
• Get request data and processes as parameters.
• Pass parameters to the controller.
• Get child routes from the current url (optional).

Usage

Router in action

In order to have the Router working, you just need to instantiate the Router and add all your Routes to it.

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

use SimplePHPRouter\Router;
use SimplePHPRouter\Route;

// Load routes from a file.
$router = new Router();

// Add routes.
$router->addRoute('/', [Controllers\Controller::class, 'myAction']);
$router->addRoute('/news/[s:slug]', [Controllers\Controller::class, 'myAction']);
$router->addRoute('/news/[i:id]', [Controllers\Controller::class, 'myAction'], 'POST');

// Execute router.
$r = $router->run();

In case the request match with a route, the run() method will return the Route object and execute the callback defined on the Route.

Load routes from a yaml file

In some cases, is better for maintenance and scalability to keep routes outside the code, so this is a method to initialize the Router with a set of rules defined on a yaml file.

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

use SimplePHPRouter\Router;
use SimplePHPRouter\Route;

// Load routes from a file.
$router = Router::loadFromFile('routes.yaml');

// Get controller
$controller = new Controller();

// You can even add more routes
$router->addRoute('/another/[s:slug]', [Controllers\Controller::class, 'myAction']);

// Execute router.
$r = $router->run();

The format for the yaml file should be as follow

routes:
  - [/index, someClass, indexAction, GET]
  - [/contact, someClass, contactAction, POST]
  - [/about, someClass, aboutAction, GET]

Controllers in action

The controller classes can be on any namespace and be build as you need.
The Router have the ability to pass to the controller methods the Request object.

namespace Controllers;

use SimplePHPRouter\Request;

class Controller
{
    public function myAction(Request $req)
    {
        // include here all your logic according the route matched.
    }
}

Add new custom regular expressions

To make flexible the router, you can create your own regular expressions and add them to the Validator class.
Make sure to include a identifier and the regex in the MATCH_TYPES array.

/**
 * The regex for match types on routes.
 * @var array
 */
const MATCH_TYPES = [
    'i'  => '[0-9]++',
    'a'  => '[0-9A-Za-z]++',
    'h'  => '[0-9A-Fa-f]++',
    's'  => '[0-9A-Za-z-_\-]++',
    '*'  => '.+?',
    '**' => '.++',
    ''   => '[^/\.]++'
];

Get the child routes from the current URL

This will return an array with the different sub routes. Similar to the getRouteParts method but this one retrieve more information.

// Get a key -> value array with 'url' and 'name' where name is a properly formatted
// slug value from the URL
Router::getChildRoutes();

//We can override the home name by passing a parameter
Router::getChildRoutes('Home');