niltonduarte/route

A lightweight, simple and easy request router for your application.

v1.0.2 2022-07-12 19:27 UTC

Requires

• php: >=7.4

BSD-3-Clause

• José Nilton

• routing
• mvc
• controller
• router
• psr-7

README

For more details, see the examples folder inside the library. It has no dependencies. Use this with any server, including PHP's built-in server. Inside the folder where you downloaded the component open the terminal and run the command:

php -S localhost:80 -t .

or

php -S localhost:80

If you have a problem, just change the 80 to another port number. For more details on PHP's built-in web server see https://www.php.net/manual/en/features.commandline.webserver.php

Its use is ridiculously easy!

I recommend that you create an index.php file in the root of the public folder that will be accessed by the server when it receives a request from some page of your application and call composer autoload to load Route like this:

<?php
require __DIR__ . '/path/to/vendor/autoload.php';

Start by instantiating the Route\Route\Route class that implements the Route\Route\RouteInterface interface.

$route = new Route\Route\Route();

The Route component supports the five most common HTTP methods in applications, GET, POST, PUT, PATCH and DELETE.

To define a route, call one of the methods of the Route\Route\RouteInterface interface, passing a route and a handle as a parameter:

$route->get('/route-name', 'handler');

The handler can be a method of a class or a callback function.

Passing parameters via URL

Route works with friendly URL and you can pass parameters via URL between curly braces without using querystring. Remembering that you can still use them if you prefer.

$route->get('/route-name/{foo}/{bar}', function (array $params) {
    print_r($params);
    echo '<p>Page content</p>';
});

Respond to other HTTP methods

If the handler is a class with a method, you must write in the second parameter as a string the fully qualified name of the class as recommended by PSR-4, separated from the method by the character @.

$route->get('/route-one', 'VendorNamespace\SubNamespace\ControllerName@methodA');
$route->post('/route-two', 'VendorNamespace\SubNamespace\ControllerName@methodB');
$route->put('/route-three', 'VendorNamespace\SubNamespace\ControllerName@methodC');
$route->patch('/route-four', 'VendorNamespace\SubNamespace\ControllerName@methodD');
$route->delete('/route-five', 'VendorNamespace\SubNamespace\ControllerName@methodE');

dispatching the route

After defining all the routes of your web application, call the run() method which will do the routing based on the accessed URI.

$route->run();

To catch errors, just call the getError() method after run(), which will return an object with the error information. As in the case of a non-existent route.

if ($error = $route->getError()) {
    // Handle errors here.
    $code = $error->getHttpErrorCode();
    $message = $error->getHttpErrorMessage();
    echo "Error {$code}, {$message}!";
}

See the examples folder