PHP Classes

PHP Route Library: Route requests to registered callback functions

Recommend this page to a friend!
  Info   View files Example   View files View files (10)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-06-15 (1 month ago) RSS 2.0 feedNot enough user ratingsTotal: 114 All time: 8,628 This week: 657Up
Version License PHP version Categories
route 1.0.7Custom (specified...5HTTP, PHP 5
Collaborate with this project Author

Route -


This package can route requests to registered callback functions.

It can register the URI patterns of different types if requests and calls given callback functions.

Different callback functions may be registered to handle each URI pattern.

The patterns may have parameter markers that are passed to the callback functions are parameters.

Name: Mahmoud Elnezamy <contact>
Classes: 1 package by
Country: Egypt Egypt
Age: 28
All time rank: 403547 in Egypt Egypt
Week rank: 1078 Up14 in Egypt Egypt Up


Route v1.0.3

Route - Fast, flexible routing for PHP, enabling you to quickly and easily build RESTful web applications.


You can download it and using it without any changes.

OR use Composer.

It's recommended that you use Composer to install Route.

$ composer require nezamy/route

Route requires PHP 5.4.0 or newer.


Only if using composer create index.php in root.

Create an index.php file with the following contents:

define('DS', DIRECTORY_SEPARATOR, true);
define('BASE_PATH', __DIR__ . DS, TRUE);

require BASE_PATH.'vendor/autoload.php';

$app            = System\App::instance();
$app->request   = System\Request::instance();
$app->route     = System\Route::instance($app->request);

$route          = $app->route;

$route->any('/', function() {
    echo 'Hello World';


If using apache make sure the .htaccess file has exists beside index.php

How it works

Routing is done by matching a URL pattern with a callback function.


$route->any('/', function() {
    echo 'Hello World';

$route->any('/about', function() {
    echo 'About';

The callback can be any object that is callable. So you can use a regular function:

function pages() {
    echo 'Page Content';
$route->get('/', 'pages');

Or a class method:

class home
    function pages() {
        echo 'Home page Content';
$route->get('/', ['home', 'pages']);
// OR
$home = new home;
$route->get('/', [$home, 'pages']);
// OR
$route->get('/', 'home@pages');

Method Routing

$route->any('/', function() {
    // Any method requests

$route->get('/', function() {
    // Only GET requests

$route->post('/', function() {
    // Only POST requests

$route->put('/', function() {
    // Only PUT requests

$route->patch('/', function() {
    // Only PATCH requests

$route->delete('/', function() {
    // Only DELETE requests

// You can use multiple methods. Just add _ between method names
$route->get_post('/', function() {
    // Only GET and POST requests

Multiple Routing (All in one)

$route->get(['/', 'index', 'home'], function() {
    // Will match 3 page in one


// This example will match any page name
$route->get('/?', function($page) {
    echo "you are in $page";

// This example will match anything after post/ - limited to 1 argument
$route->get('/post/?', function($id) {
    // Will match anything like post/hello or post/5 ...
    // But not match /post/5/title
    echo "post id $id";

// more than parameters
$route->get('/post/?/?', function($id, $title) {
    echo "post id $id and title $title";

For ?unlimited? optional parameters, you can do this:

// This example will match anything after blog/ - unlimited arguments
$route->get('/blog/*', function() {
    // [$this] instanceof ArrayObject so you can get all args by getArrayCopy()

Named Parameters

You can specify named parameters in your routes which will be passed along to your callback function.

$route->get('/{username}/{page}', function($username, $page) {
    echo "Username $username and Page $page <br>";
    // OR
    echo "Username {$this['username']} and Page {$this['page']}";

Regular Expressions

You can validate the args by regular expressions.

// Validate args by regular expressions uses :(your pattern here)
function($username, $id)
    echo "author $username post id $id";

// You can add named regex pattern in routes
    'username' => '/([0-9a-z_.-]+)',
    'id' => '/([0-9]+)'

// Now you can use named regex
$route->get('/{username}:username/post/{id}:id', function($username, $id) {
    echo "author $username post id $id";

Some named regex patterns already registered in routes

    'int'               => '/([0-9]+)',
    'multiInt'          => '/([0-9,]+)',
    'title'             => '/([a-z_-]+)',
    'key'               => '/([a-z0-9_]+)',
    'multiKey'          => '/([a-z0-9_,]+)',
    'isoCode2'          => '/([a-z]{2})',
    'isoCode3'          => '/([a-z]{3})',
    'multiIsoCode2'     => '/([a-z,]{2,})',
    'multiIsoCode3'     => '/([a-z,]{3,})'

Optional parameters

You can specify named parameters that are optional for matching by adding (?)

function($title, $date) {
    if ($title) {
        echo "<h1>$title</h1>";
        echo "<h1>Posts List</h1>";

    if ($date) {
        echo "<small>Published $date</small>";


$route->group('/admin', function()
    // /admin/
    $this->get('/', function() {
        echo 'welcome to admin panel';

    // /admin/settings
    $this->get('/settings', function() {
        echo 'list of settings';

    // nested group
    $this->group('/users', function()
        // /admin/users
        $this->get('/', function() {
            echo 'list of users';

        // /admin/users/add
        $this->get('/add', function() {
            echo 'add new user';

    // Anything else
    $this->any('/*', function() {
        pre("Page ( {$this->app->request->path} ) Not Found", 6);

Groups with parameters

$route->group('/{lang}?:isoCode2', function($lang)
    $default = $lang;

    if (!in_array($lang, ['ar', 'en'])) {
        $default = 'en';

    $this->get('/', function($lang) use($default) {
        echo "lang in request is $lang<br>";
        echo "include page_{$default}.php";

    $this->get('/page/{name}/', function($lang, $name)

Full examples here

  Files folder image Files  
File Role Description
Files folder imagesystem (5 files)
Accessible without login Plain text file .htaccess Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file index.php Example Example script
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file Doc. Documantion

  Files folder image Files  /  system  
File Role Description
  Plain text file App.php Class Class source
  Accessible without login Plain text file function.php Example Example script
  Plain text file Request.php Class Class source
  Plain text file Route.php Class Class source
  Accessible without login Plain text file startup.php Example Example script

 Version Control Unique User Downloads Download Rankings  
This week:0
All time:8,628
This week:657Up