README

Description : Implementation of Http Router classes for PHP7.1 or higher.

This library is mainly composed of 4 classes.

Router

The Router class handles request by calling the request(string $method, string $url) method which must return a route action response.

Can be instantiate by passing a route file and a type (json, yaml... extend if you want to add new ones).

The Router::request($method, $url) method allows to execute a route action based on the method and the url parameters.

Example of route files here.

The RouteManager parses route files. You can then get Route objects by calling the getRoutes() method.

This class is abstract, so you have to extend it in order to add new route file types (See JsonRouteManager or YamlRouteManager for examples).

A Route object is composed of these attributes :

array $_methods : An array of HTTP methods handled by the route
string $_url : The url of the route
string $_pattern : A regexp representing the urls handled by the route
array $_action : A two items array. The first is the FQN of a class (namespaces separated by ':'). The second one is the name of the method you want to call for this route. When setting the action attribute you have to pass a string which respects this syntax classname::method.

Finally, the Route::call() method execute the route action which has to return a Response object.

A Response object is composed of :

The class is abstract, so you have to extend in order to add new response types