Download the PHP package josantonius/router without Composer
On this page you can find all versions of the php package josantonius/router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/router
More information about josantonius/router
Files in josantonius/router
Informations about the package router
PHP Router library
Versión en español
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
- Installation
- Available Methods
- Quick Start
- Usage
- Tests
- Sponsor
- License
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
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$method | Singleton method name. | string | Yes |
# Return (boolean)
- Add route/s
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
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$route | Route. | string | Yes |
# Return (string|null) → route or null
- Defines callback if route is not found
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.
Attribute | Description | Type | Required | Default | |
---|---|---|---|---|---|
$value | Value. | boolean | int | Yes | true |
# Return (boolean true)
- Runs the callback for the given request
# Return (call response|false)
Quick Start
To use this library with Composer:
Or If you installed it manually, use it:
Usage
Example of use for this library:
- Add route
- Add routes
- Execute route simulating 'services'
- Add route with regular expressions (:all)
- Execute route simulating 'language/PHP/'
- Add route with regular expressions (:any) and params
- Execute route simulating 'blog/games/Minecraft/'
- Add route with regular expressions (:num) and params
- Execute route simulating 'blog/development/1/'
- Add route with regular expressions (:hex) and params
- Execute route simulating 'blog/color/e0a060/'
- Add route with regular expressions (:uuidV4) and params
- Execute route simulating 'blog/uuid/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000/'
- Set method name for use singleton pattern
- Get method
- Defines callback if route is not found
- Execute wrong routes with custom error callback
- Continue processing after match
- Keep Lookin up to three coincidences
- Stopping processing after match
Tests
To run 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 :blush:
License
This repository is licensed under the MIT License.
Copyright © 2016-2022, Josantonius