Roust
CAUTION:
This library has moved to fratily/router.
From now on plz use that., (*1)
Roust is the fastest (wishful) URI router., (*2)
NOTE:
I cant speak engilish. so I used GoogleTranslate.
The exact REDME is in README_origin., (*3)
Install
Before using Roust in your project, execute it command in your project:, (*4)
``` bash
$ composer require 'kento-oka/roust', (*5)
## Usage
First of all, create an instance of router.
```php
use Roust\Router;
$router = new Router();
Basic usage
use Roust\Router;
use Request; // Implemented Psr\Http\Message\ServerRequestInterface
$router = new Router();
$request = new Request();
// It matches GET http://example.com/
$router->addRoute("GET", "/", [
"controller" => "index",
"action" => "index"
]);
// It matches GET http://example.com/users/
$router->addRoute("GET", "/users/", [
"controller" => "user",
"action" => "index"
]);
// It matches GET http://example.com/users/my/ and POST http://example.com/users/my/
$router->addRoute(["GET", "POST"], "users/my/", [
"controller" => "user",
"action" => "mypage"
]);
// It matches GET http://example.com/users/123/
$router->addRoute("GET", "/users/{uid:[1-9][0-9]*}/", [
"controller" => "user",
"action" => "page"
]);
$result = $router->search($request->getMethod(), $request->getUri()->getPath());
switch($result["result"]){
case Router::NOT_FOUND:
// ... 404 Not Found
break;
case Router:METHOD_NOT_ALLOWED:
$allowedMethods = $result["allowed"];
// ... 405 Method Not Allowed
break;
case Router::FOUND:
$params = $resul["params"];
// Do something
break;
}
Defining route
Routing rules are defined by Router::addRoute()., (*6)
The first argument is an HTTP method to allow.
The second argument is a URI that matches.
And you can specify additional parameters for the third argument., (*7)
You can omit the leading slash in the second argument., (*8)
// It matches GET http://example.com/
$router->addRoute("GET", "/", [
"controller" => "index",
"action" => "index"
]);
// It matches GET http://example.com/users/
$router->addRoute("GET", "/users/", [
"controller" => "user",
"action" => "index"
]);
// It matches GET http://example.com/users/my/ and POST http://example.com/users/my/
$router->addRoute(["GET", "POST"], "users/my/", [
"controller" => "user",
"action" => "mypage"
]);
Methods such as Router::get(), Router::post(), Router::put(), and
Router::delete() are defined to omit specification of the HTTP method., (*9)
$router->get("/users/", [
"controller" => "user",
"action" => "index"
]);
Use regex
Use the {id:regex} syntax to embed regular expression.
id specifies the parameter name, regex specifies the regular expression
to be used in PHP's preg_match()., (*10)
$router->addRoute("GET", "/users/{uid:[1-9][0-9]*}/", [
"controller" => "user",
"action" => "page"
]);
Even if the same parameter name is specified with the third argument,
the value of second argument takes precedence., (*11)
Use short regex
For example, if you add a routing rule that matches IP address,
there would no one to write that regex in Router::addRoute().
Furthermore, if it is IPv4-mapped IPv6 address,
it is useful if it can be converted to IPv4 at the routing stage., (*12)
Short regex that makes it possible., (*13)
It is short regex that matches only natural numbers and convert to int type:, (*14)
$router->addShortRegex("d", new \Roust\Sregex\NaturalNumber());
$router->addroute("GET", "/users/{uid:|d}/", [
"controller" => "user",
"action" => "page"
]);
Short regex can be registered with Router::addShortRegex()., (*15)
The first argument is an qualified name.
The second argument will pass an instance of the class implementing
Roust\ShortRegexInterface., (*16)
Group
In the example so far, there were parts common to some rules., (*17)
Taking the rule related to the user as an example, the head of URI is
neccessarily '/users/' and the value of 'controller' is 'user'., (*18)
It is not hard to write common parts with the previous example.
But Actually more rules are needed., (*19)
In Roust you can summarize the grouping of rules in this way:, (*20)
$router->makePathGroup("/users", function($r){
$r->get("/", [
"controller" => "user",
"action" => "index"
]);
$r->makeParamsGroup(["Controller" => "user"], function($r){
$r->get("/my/", [
"action" => "mypage"
]);
$r->get("/{uid:[1-9][0-9]*}/", [
"action" => "page"
]);
});
});
Router::makePathGroup() adds value of the first argument to the
beginning of the URI of the rule added with Router::addRoute() only while
the second argument callback is executed., (*21)
In Router::makeParamsGroup(), add parameters.
This added parameters can be overwriten with Router::addRoute()., (*22)
Note
$route->addShortRegex("d", new NaturalNumber());
$router->get("/users/{id:[1-9][0-9]*}/", []);
$router->get("/users/{id:|d}/profile/", []);
$router->search("GET", "/users/123/"); // Not Found
$router->search("GET", "/users/123/profile"); // Found
String > Short Regex > Regex, (*23)
Wallogit.com
