josantonius / router
Library for handling routes.
Fund package maintenance!
Josantonius
Requires
- php: ^5.6 || ^7.0
- josantonius/url: ^1.1.9
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.3 || ^2.8
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^5.7 || ^6.0
- squizlabs/php_codesniffer: ^3.0
README
Library for handling routes.
This documentation refers to version 1.1.1. Changes made in version 1.1.2 (which archived the repository) were not documented or tested.
Requirements
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
Installation
The preferred way to install this extension is through Composer.
To install PHP Router library, simply:
composer require Josantonius/Router
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
composer require Josantonius/Router --prefer-source
You can also clone the complete repository with Git:
$ git clone https://github.com/Josantonius/PHP-Router.git
Or install it manually:
Download Router.php and Url.php:
wget https://raw.githubusercontent.com/Josantonius/PHP-Router/master/src/Router.php
wget https://raw.githubusercontent.com/Josantonius/PHP-Url/master/src/Url.php
Available Methods
Available methods in this library:
- Set method name for use singleton pattern
Router::setSingletonName($method);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$method | Singleton method name. | string | Yes |
# Return (boolean)
- Add route/s
Router::add($routes);
Attribute | Key | Description | Type | Required | Default |
---|---|---|---|---|---|
$routes | Route/s to add. | array | Yes | ||
0 | Route. | string | Yes | ||
1 | Method 'class@method'. | string | Yes |
# Return (boolean)
- Get method to call from URI
Router::getMethod($route);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$route | Route. | string | Yes |
# Return (string|null) → route or null
- Defines callback if route is not found
Router::error($callback);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$callback | Callback. | callable | Yes |
# Return (boolean true)
- Continue processing after match or stop it
Also can specify the number of total routes to process.
Router::keepLooking($value);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$value | Value. | boolean | int | Yes |
# Return (boolean true)
- Runs the callback for the given request
Router::dispatch();
# Return (call response|false)
Quick Start
To use this library with Composer:
require __DIR__ . '/vendor/autoload.php'; use Josantonius\Router\Router;
Or If you installed it manually, use it:
require_once __DIR__ . '/Router.php'; require_once __DIR__ . '/Url.php'; use Josantonius\Router\Router;
Usage
Example of use for this library:
- Add route
Router::add([ 'services' => 'Josantonius\Router\Example@services' ]);
- Add routes
$routes = [ 'services' => 'Josantonius\Router\Example@services', 'home' => 'Josantonius\Router\Example@home', ]; Router::add($routes);
- Execute route simulating 'services'
Router::dispatch(); // Response from services method
- Add route with regular expressions (:all)
Router::add([ 'blog/:all' => 'Josantonius\Router\Example@blog' ]);
- Execute route simulating 'language/PHP/'
Router::dispatch(); // Response from services method
- Add route with regular expressions (:any) and params
Router::add([ 'blog/:any/:any/' => 'Josantonius\Router\Example@blog', ]);
- Execute route simulating 'blog/games/Minecraft/'
Router::dispatch(); // Response from blog method: games | Minecraft
- Add route with regular expressions (:num) and params
Router::add([ blog/:any/:num/' => 'Josantonius\Router\Example@blog', ]);
- Execute route simulating 'blog/development/1/'
Router::dispatch(); // Response from blog method: development | 1
- Add route with regular expressions (:hex) and params
Router::add([ 'blog/:any/:hex/' => 'Josantonius\Router\Example@blog', ]);
- Execute route simulating 'blog/color/e0a060/'
Router::dispatch(); // Response from blog method: color | e0a060
- Add route with regular expressions (:uuidV4) and params
Router::add([ 'blog/:any/:uuidV4/' => 'Josantonius\Router\Example@blog', ]);
- Execute route simulating 'blog/uuid/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000/'
Router::dispatch(); // Response from blog method: uuid | 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000
- Set method name for use singleton pattern
Router::setSingletonName('newSingleton');
- Get method
Router::getMethod('services'); // Josantonius\Router\Example@services
- Defines callback if route is not found
Router::error('Josantonius\Router\Example@error');
- Execute wrong routes with custom error callback
Router::dispatch('unknown'); // Response from error method
- Continue processing after match
Router::keepLooking();
- Keep Lookin up to three coincidences
Router::keepLooking(3);
- Stopping processing after match
Router::keepLooking(false);
Tests
To run tests you just need composer and to execute the following:
git clone https://github.com/Josantonius/PHP-Router.git
cd PHP-Router
composer install
Run unit tests with PHPUnit:
composer phpunit
Run PSR2 code standard tests with PHPCS:
composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
composer phpmd
Run all previous tests:
composer tests
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊
License
This repository is licensed under the MIT License.
Copyright © 2016-2022, Josantonius