Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
This library allows to find an appropriated route and extracts data from a request. Conversely, given a route and data, this library is able to build a request.
For now, we have two routers: HTTP (routes understand URI and subdomains) and CLI (routes understand a full command-line).
With Composer, to include this library into
your dependencies, you need to
require hoa/router
:
$ composer require hoa/router '~3.0'
For more installation procedures, please read the Source page.
Before running the test suites, the development dependencies must be installed:
$ composer install
Then, to run all the test suites:
$ vendor/bin/hoa test:run
For more information, please read the contributor guide.
We propose a quick overview of two usages: in a HTTP context and in a CLI context.
We consider the following routes:
/hello
, only accessible with the GET
and POST
method;/bye
, only accessible with the GET
method;/hello_<nick>
only accessible with the GET
method.There are different ways to declare routes but the more usual is as follows:
$router = new Hoa\Router\Http();
$router
->get('u', '/hello', function () {
echo 'world!', "\n";
})
->post('v', '/hello', function (Array $_request) {
echo $_request['a'] + $_request['b'], "\n";
})
->get('w', '/bye', function () {
echo 'ohh :-(', "\n";
})
->get('x', '/hello_(?<nick>\w+)', function ($nick) {
echo 'Welcome ', ucfirst($nick), '!', "\n";
});
We can use a basic dispatcher to call automatically the associated callable of the appropriated rule:
$dispatcher = new Hoa\Dispatcher\Basic();
$dispatcher->dispatch($router);
Now, we will use cURL to test our program that listens
on 127.0.0.1:8888
:
$ curl 127.0.0.1:8888/hello
world!
$ curl -X POST -d a=3\&b=39 127.0.0.1:8888/hello
42
$ curl 127.0.0.1:8888/bye
ohh :-(
$ curl -X POST 127.0.0.1:8888/bye
// error
$ curl 127.0.0.1:8888/hello_gordon
Welcome Gordon!
$ curl 127.0.0.1:8888/hello_alyx
Welcome Alyx!
This simple API hides a modular mechanism that can be foreseen by typing
print_r($router->getTheRule())
.
To unroute, i.e. make the opposite operation, we can do this:
var_dump($router->unroute('x', array('nick' => 'gordon')));
// string(13) "/hello_gordon"
We would like to recognize the following route `[