Download the PHP package berlioz/router without Composer
On this page you can find all versions of the php package berlioz/router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download berlioz/router
More information about berlioz/router
Files in berlioz/router
Package router
Short Description Berlioz Router is a PHP library for manage HTTP routes, respecting PSR-7 (HTTP message interfaces) standard.
License MIT
Homepage https://getberlioz.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package router
Berlioz Router
Berlioz Router is a PHP library for manage HTTP routes, respecting PSR-7 (HTTP message interfaces) standard.
Installation
Composer
You can install Berlioz Router with Composer, it's the recommended installation.
Dependencies
- PHP ^8.0
- Packages:
- berlioz/http-message
- psr/log
Usage
Routes
Create route
You can create simple route like this:
Constructor arguments are:
- defaults: an associated array to set default values of attributes when route is generated
- requirements: an associated array to restrict the format of attributes. Key is the name of attribute and value is the validation regex
- name: name of route
- method: an array of allowed HTTP methods, or just a method
- host: an array of allowed hosts, or just a host
- priority: you can specify the priority for a route (default: -1)
Route group
A route can be transformed to a group, only associate another route to them.
Children routes inherit parent route attributes, requirements, ...
Attributes
Route accept optional attributes, you need to wrap the optional part by brackets.
You can also define requirements directly in the path :
- Add a regular expression after the name of attribute (separate by ":").
- Add a type name after the name of attribute (separate by "::").
Supported defined types:
int(equivalent of\d+)float(equivalent of\d+(\.\d+))uuid4(equivalent of[0-9A-Fa-f]{8}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{12})slug(equivalent of[a-z0-9]+(?:-[a-z0-9]+)*)md5(equivalent of[0-9a-fA-F]{32})sha1(equivalent of[0-9a-fA-F]{40})domain(equivalent of([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6})
Router
The router is the main functionality in the package, it is defined by Router class. He is able to find the
good Route object according to a ServerRequestInterface object (see PSR-7).
Options
| Options | Type | Description |
|---|---|---|
| X-Forwarded-Prefix | boolean/string | Default to false, true to use "X-Forwarded-Prefix" value or custom name of header |
Generate path
You can generate a path with some parameters directly with Router object.
The return of method, is the path in string format or thrown an exception if not able to generate path (not all required parameters for example).
Valid path
You can be valid a ServerRequestInterface to known if a path can be treated by a route.
The return of method is a boolean value.
All versions of router with dependencies
berlioz/http-message Version ^2.0
psr/http-message Version ^1.0 || ^2.0
psr/log Version ^1.0 || ^2.0 || ^3.0