Download the PHP package adinan-cenci/router without Composer

A small PHP router library

A simple PHP router to handle http requests.

This library is PSR-15 compliant and therefore works with PSR-7 messages and makes use of PSR-17 factories.

Instantiating

Adding routes

You may add routes by informing the http method, the regex pattern to be matched against the the path and the associated controller:

Http method

Regex patterns

A simple regex pattern. Capture groups will be passed to the controller as attributes.

Obs: The route accepts multiple patterns as an array.

Controllers

The controller will receive two paramaters: an instance of Psr\Http\Message\ServerRequestInterface and Psr\Http\Server\RequestHandlerInterface respectively.

The routes accept various arguments as controllers:

Obs: If the controller does not exist or cannot be called because of some reason or another, an exception will be thrown.

See the contents of the "examples" directory for more details.

::add() shorthands

Executing

Calling ::run() will execute the router and send a respose.

PSR compliance

This library is PSR-15 compliant, as such your controllers may tailor the response in details as specified in the PSR-7. The handler make PSR-17 factories available to use.

IMPORTANT

If your controller does not return an instance of ResponseInterface, the router will create one based out of whatever was outputed through echo and print.

Niceties

Besides being PSR-17 compliant, the response factory comes with some methods to make things easier:

Adding cookies to a response object is made easier with ::withAddedCookie():

Middlewares

Middlewares will be processed before the routes. Middlewares are very similar to routes but unlike routes more than one middleware may be executed.

Errors

Exceptions

By default catched exceptions will be rendered in a 500 response object, you may customize it by setting your own handler.

Not found

By default when no route is found, the router will render a 404 response object, you may customize it by setting your own handler.

::setDefaultNamespace($namespace)

Set the default namespace, so there will be no need to write the entire class name of the controller when defining routes.

Working inside sub-directories

The router will automatically work inside sub-directories.

Consider the example: Your URL: http://yourwebsite.com/foobar/about

Your document root is
/var/www/html/ and your router is inside of
/var/www/html/foobar/.

The router will match the routes against about and NOT foobar/about.

Still, if you really need to work with foobar/about , then you must pass /var/www/html/ as your base directory to the Router class' constructor.

Server configuration

In order for it to work, we need to rewrite the requests to the file containing our router. Below are some examples:

Apache

Here is the example of a .htaccess for Apache:

Nginx

Here is the example for nginx:

IIS

Here is the example of a web.config for Microsoft IIS:

Installing

Use composer

License

MIT