https://github.com/ahmard/quick-route

Simple http router designed to look just like Laravel's router
https://github.com/ahmard/quick-route

fast-route http-router laravel php quick-route quickroute router routing

Last synced: 2 months ago
JSON representation

Simple http router designed to look just like Laravel's router

• Host: GitHub
• URL: https://github.com/ahmard/quick-route
• Owner: Ahmard
• License: mit
• Created: 2020-10-26T23:10:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T00:36:12.000Z (over 3 years ago)
• Last Synced: 2025-03-15T16:36:50.673Z (2 months ago)
• Topics: fast-route, http-router, laravel, php, quick-route, quickroute, router, routing
• Language: PHP
• Homepage:
• Size: 270 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# QuickRoute

An elegant http router built on top of [FastRoute](https://github.com/nikic/FastRoute) to provide more easy of use.

## Upgrade Guide

Check [ChangeLog](CHANGELOG.md) file

## Installation

```bash

composer require ahmard/quick-route

```

## Usage

Simple example

```php

use QuickRoute\Route;

use QuickRoute\Router\Dispatcher;

require('vendor/autoload.php');

Route::get('/', function () {

    echo 'Hello world';

});

$method = $_SERVER['REQUEST_METHOD'];

$path = $_SERVER['REQUEST_URI'];

//create route dispatcher

$dispatcher = Dispatcher::collectRoutes()

    ->dispatch($method, $path);

//determine dispatch result

switch (true) {

    case $dispatcher->isFound():

        $controller = $dispatcher->getRoute()->getController();

        $controller($dispatcher->getUrlParameters());

        break;

    case $dispatcher->isNotFound():

        echo "Page not found";

        break;

    case $dispatcher->isMethodNotAllowed():

        echo "Request method not allowed";

        break;

}

```

#### Controller-like example

```php

use QuickRoute\Route;

Route::get('/home', 'MainController@home');

```

#### Advance usage

```php

use QuickRoute\Route;

Route::prefix('user')->name('user.')

    ->namespace('User')

    ->middleware('UserMiddleware')

    ->group(function (){

        Route::get('profile', 'UserController@profile');

        Route::put('update', 'UserController@update');

    });

```

#### More Advance Usage

```php

use QuickRoute\Route;

Route::prefix('user')

    ->prepend('api')

    ->append('{token}')

    ->middleware('UserMiddleware')

    ->group(function (){

        Route::get('profile', 'UserController@profile');

        Route::put('update', 'UserController@update');

    });

// => /api/user/{token}

```

#### Defining route param types

```php

use QuickRoute\Route;

// id => must be number

Route::get('users/{id}', 'Controller@index')->whereNumber('id');

// name => must be alphabetic

Route::get('users/{name}', 'Controller@profile')->whereAlpha('name');

// username => must be alphanumeric

Route::get('users/{username}', 'Controller@profile')->whereAlphaNumeric('username');

// Manually provide regular expression pattern to match parameter with

Route::get('/users/{id}', 'a')->where('id', '[0-9]+');

Route::get('/users/{user}/posts/{post}', 'Ctrl@method')->where([

    'user' => '[a-zA-Z]+',

    'post' => '[0-9]+'

]);

```

#### Route Fields

Fields help to add more description to route or group of routes

```php

use QuickRoute\Route;

Route::prefix('user')

    ->middleware('User')

    ->addField('specie', 'human')

    ->group(function (){

        Route::get('type', 'admin')->addField('permissions', 'all');

        Route::get('g', fn() => print('Hello world'));

    });

```

#### Route::match()

```php

use QuickRoute\Route;

use QuickRoute\Router\Collector;

use QuickRoute\Router\Dispatcher;

require 'vendor/autoload.php';

$controller = fn() => print time();

Route::match(['get', 'post'], '/user', $controller)

    ->middleware('auth')

    ->namespace('App')

    ->name('home');

$collector = Collector::create()->collect();

$dispatchResult = Dispatcher::create($collector)

    ->dispatch('get', '/user/hello');

var_export($dispatchResult->getRoute());

```

#### Route::match() with named routes

```php

use QuickRoute\Route;

Route::match(['get', 'post'], 'login', 'AuthController@login')->name('login.');

//Will generate below routes

Route::get('login', 'AuthController@login')->name('login.get');

Route::post('login', 'AuthController@login')->name('login.post');

```

#### Route::any()

```php

use QuickRoute\Route;

use QuickRoute\Router\Collector;

use QuickRoute\Router\Dispatcher;

$controller = fn() => print time();

Route::any(['/login', '/admin/login'], 'get', $controller);

$collector = Collector::create()->collect();

$dispatchResult1 = Dispatcher::create($collector)

    ->dispatch('get', '/login');

    

$dispatchResult2 = Dispatcher::create($collector)

    ->dispatch('get', '/admin/login');

```

#### Route::matchAny()

```php

use QuickRoute\Route;

Route::matchAny(

    ['get', 'post'], 

    ['/customer/login', '/admin/login'],

    'MainController@index'

);

//Which is equivalent to:

Route::get('/customer/login', 'MainController@index');

Route::post('/customer/login', 'MainController@index');

Route::get('/admin/login', 'MainController@index');

Route::post('/admin/login', 'MainController@index');

```

#### Route::resource()

```php

use QuickRoute\Route;

Route::resource('photos', 'App\Http\Controller\PhotoController');

```

Code above will produce below routes 


![alt text](resource-http-verbs.png)

#### Crud::create()

```php

use QuickRoute\Crud;

Crud::create('/', 'Controller')->go();

```

Code above will produce below routes 


![alt text](crud-definition.png)




**Why not use Route::resource()?**


Crud creator generates 6 routes, one of the routes which deletes all record in the endpoint.


With Crud creator you can choose which routes to create or not.

```php

use QuickRoute\Crud;

//Disabling route creation

Crud::create('/', 'Controller')

    ->disableIndexRoute()

    ->disableStoreRoute()

    ->disableDestroyAllRoute()

    ->disableShowRoute()

    ->disableUpdateRoute()

    ->disableDestroyRoute()

    ->go();

//Specifying custom route parameter name 

Crud::create('/', 'Controller')->parameter('userId');

//Specify parameter type 

Crud::create('/', 'Controller')->numericParameter();

Crud::create('/', 'Controller')->alphabeticParameter();

Crud::create('/', 'Controller')->alphaNumericParameter();

```

#### Routes as configuration

```php

//routes.php

use QuickRoute\Route;

Route::get('/', 'MainController@index');

Route::get('/help', 'MainController@help');

//server.php

use QuickRoute\Router\Collector;

$collector = Collector::create()

    ->collectFile('routes.php')

    ->register();

$routes = $collector->getCollectedRoutes();

```

#### Caching

Cache routes so that they don't have to be collected every time.

```php

use QuickRoute\Router\Collector;

$collector = Collector::create()

    ->collectFile('routes.php')

    ->cache('path/to/save/cache.php', false)

    ->register();

$routes = $collector->getCollectedRoutes();

```

Caching routes with closure

```php

use QuickRoute\Route;

use QuickRoute\Router\Collector;

Route::get('/', function (){

    echo uniqid();

});

$collector = Collector::create()

    ->collect()

    ->cache('path/to/save/cache.php', true)

    ->register();

$routes = $collector->getCollectedRoutes();

```

**Note that you must specify that your routes contains closure**

#### Passing Default Data

You can alternatively pass data to be prepended to all routes.




Cached routes must be cleared manually after setting/updating default route data.

```php

use QuickRoute\Router\Collector;

$collector = Collector::create();

$collector->collectFile('api-routes.php', [

    'prefix' => 'api',

    'name' => 'api.',

    'namespace' => 'Api\\'

]);

$collector->register();

```

#### Changing Delimiter

For usage outside of web context, a function to change default delimiter which is "**/**" has been provided.

```php

use QuickRoute\Route;

use QuickRoute\Router\Collector;

use QuickRoute\Router\Dispatcher;

require 'vendor/autoload.php';

Route::prefix('hello')

    ->group(function () {

        Route::get('world', fn() => print('Hello World'));

    });

$collector = Collector::create()

    ->prefixDelimiter('.')

    ->collect()

    ->register();

$dispatchResult = Dispatcher::create($collector)

    ->dispatch('get', 'hello.world');

var_export($dispatchResult);

```

#### Finding route & generating route uri

```php

use QuickRoute\Route;

use QuickRoute\Router\Collector;

Route::get('/users', 'Controller@method')->name('users.index');

$collector = Collector::create()->collect();

echo $collector->uri('users.index');  // => /users

$collector->route('users.index'); // => Instance of QuickRoute\Route\RouteData

```

#### Note

- You must be careful when using **Collector::collect()** and **Collector::collectFile()** together, 

as collectFile method will clear previously collected routes before it starts collecting.


Make sure that you call **Collector::collect()** first, before calling **Collector::collectFile()**.

## Licence

_Route http verbs image is owned by [Riptutorial](https://riptutorial.com)_.

**QuickRoute** is **MIT** licenced.