Recommend this page to a friend! |
Download |
Info | Documentation | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Ratings | Unique User Downloads | Download Rankings | ||||
Not yet rated by the users | Total: 133 | All time: 9,318 This week: 673 |
Version | License | PHP version | Categories | |||
php-router 1.0.9 | MIT/X Consortium ... | 5.6 | HTTP, PHP 5, Design Patterns |
Description | Author | |
This package can manage routes and dispatch requests to classes. |
Library for handling routes.
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
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 in this library:
Router::setSingletonName($method);
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $method | Singleton method name. | string | Yes | |
# Return (boolean)
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)
Router::getMethod($route);
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $route | Route. | string | Yes | |
# Return (string|null) ? route or null
Router::error($callback);
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $callback | Callback. | callable | Yes | |
# Return (boolean true)
Also can specify the number of total routes to process.
Router::keepLooking($value);
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $value | Value. | boolean|int | Yes | true |
# Return (boolean true)
Router::dispatch();
# Return (call response|false)
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;
Example of use for this library:
Router::add([
'services' => 'Josantonius\Router\Example@services'
]);
$routes = [
'services' => 'Josantonius\Router\Example@services',
'home' => 'Josantonius\Router\Example@home',
];
Router::add($routes);
Router::dispatch(); // Response from services method
Router::add([
'blog/:all' => 'Josantonius\Router\Example@blog'
]);
Router::dispatch(); // Response from services method
Router::add([
'blog/:any/:any/' => 'Josantonius\Router\Example@blog',
]);
Router::dispatch(); // Response from blog method: games | Minecraft
Router::add([
blog/:any/:num/' => 'Josantonius\Router\Example@blog',
]);
Router::dispatch(); // Response from blog method: development | 1
Router::add([
'blog/:any/:hex/' => 'Josantonius\Router\Example@blog',
]);
Router::dispatch(); // Response from blog method: color | e0a060
Router::add([
'blog/:any/:uuidV4/' => 'Josantonius\Router\Example@blog',
]);
Router::dispatch(); // Response from blog method: uuid | 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000
Router::setSingletonName('newSingleton');
Router::getMethod('services'); // Josantonius\Router\Example@services
Router::error('Josantonius\Router\Example@error');
Router::dispatch('unknown'); // Response from error method
Router::keepLooking();
Router::keepLooking(3);
Router::keepLooking(false);
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
If you would like to help, please take a look at the list of issues or the To Do checklist.
Pull requests
The file structure from this repository was created with PHP-Skeleton.
This project is licensed under MIT license. See the LICENSE file for more info.
2016 - 2018 Josantonius, josantonius.com
If you find it useful, let me know :wink:
Files (15) |
File | Role | Description | ||
---|---|---|---|---|
src (1 file) | ||||
tests (2 files) | ||||
.editorconfig | Data | Auxiliary data | ||
.php_cs.dist | Example | Example script | ||
.travis.yml | Data | Auxiliary data | ||
CHANGELOG.md | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
CONDUCT.md | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
phpcs.xml | Data | Auxiliary data | ||
phpmd.xml | Data | Auxiliary data | ||
phpunit.xml | Data | Auxiliary data | ||
README-ES.md | Doc. | Documentation | ||
README.md | Doc. | Documentation |
Files (15) | / | tests |
File | Role | Description |
---|---|---|
Example.php | Class | Class source |
RouterTest.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.