PHPackages                             ahmard/quick-route - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. ahmard/quick-route

ActiveLibrary[HTTP & Networking](/categories/http)

ahmard/quick-route
==================

Simple http router designed to look just like Laravel router

3.9.0(4y ago)111.5kMITPHPPHP >=7.4

Since Oct 26Pushed 4y ago1 watchersCompare

[ Source](https://github.com/Ahmard/quick-route)[ Packagist](https://packagist.org/packages/ahmard/quick-route)[ RSS](/packages/ahmard-quick-route/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (5)Versions (57)Used By (0)

QuickRoute
==========

[](#quickroute)

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

Upgrade Guide
-------------

[](#upgrade-guide)

Check [ChangeLog](CHANGELOG.md) file

Installation
------------

[](#installation)

```
composer require ahmard/quick-route
```

Usage
-----

[](#usage)

Simple example

```
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

[](#controller-like-example)

```
use QuickRoute\Route;

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

#### Advance usage

[](#advance-usage)

```
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

[](#more-advance-usage)

```
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

[](#defining-route-param-types)

```
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

[](#route-fields)

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

```
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()

[](#routematch)

```
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

[](#routematch-with-named-routes)

```
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()

[](#routeany)

```
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()

[](#routematchany)

```
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()

[](#routeresource)

```
use QuickRoute\Route;

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

Code above will produce below routes
[![alt text](resource-http-verbs.png)](resource-http-verbs.png)

#### Crud::create()

[](#crudcreate)

```
use QuickRoute\Crud;

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

Code above will produce below routes
[![alt text](crud-definition.png)](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.

```
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

[](#routes-as-configuration)

```
//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

[](#caching)

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

```
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

```
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

[](#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.

```
use QuickRoute\Router\Collector;

$collector = Collector::create();
$collector->collectFile('api-routes.php', [
    'prefix' => 'api',
    'name' => 'api.',
    'namespace' => 'Api\\'
]);
$collector->register();
```

#### Changing Delimiter

[](#changing-delimiter)

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

```
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

[](#finding-route--generating-route-uri)

```
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

[](#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
-------

[](#licence)

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

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

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~9 days

Recently: every ~62 days

Total

54

Last Release

1603d ago

Major Versions

1.0.2 → 2.0.02020-10-28

2.5.6 → 3.0.02021-02-14

PHP version history (4 changes)2.1.0PHP ^7.4

2.3.0PHP ^7.4|8.0

2.5.0PHP ^7.4 || ^8.0

3.8.3PHP >=7.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b69fe34bd6492697a19cd8f33bde7a381cab0b7f8c0a01dcc7505f482458887?d=identicon)[Ahmard](/maintainers/Ahmard)

---

Top Contributors

[![Ahmard](https://avatars.githubusercontent.com/u/44737217?v=4)](https://github.com/Ahmard "Ahmard (27 commits)")

---

Tags

fast-routehttp-routerlaravelphpquick-routequickrouterouterrouting

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ahmard-quick-route/health.svg)

```
[![Health](https://phpackages.com/badges/ahmard-quick-route/health.svg)](https://phpackages.com/packages/ahmard-quick-route)
```

###  Alternatives

[league/route

Fast routing and dispatch component including PSR-15 middleware, built on top of FastRoute.

6683.3M145](/packages/league-route)[hyperf/http-server

A HTTP Server for Hyperf.

103.0M368](/packages/hyperf-http-server)[middlewares/fast-route

Middleware to use FastRoute

98205.1k15](/packages/middlewares-fast-route)[mezzio/mezzio-fastroute

FastRoute integration for Mezzio

172.9M66](/packages/mezzio-mezzio-fastroute)[amphp/http-server-router

Routes to request handlers based on HTTP method and path for amphp/http-server.

39539.2k37](/packages/amphp-http-server-router)[flarum/core

Delightfully simple forum software.

201.4M2.3k](/packages/flarum-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)