A simple object-oriented PHP router. Developed by Erick Firmo (BR) https://erickfirmo.dev
- PHP >= 7.1
- URL rewriting
The router requires your web server to forward requests to your application's index.php entry point.
If you are using Apache, you can use mod_rewrite with a .htaccess file.
Example:
<IfModule mod_rewrite.c>
RewriteEngine on
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-l
RewriteRule ^(.*)$ /index.php/$1
</IfModule>If you are using Nginx, .htaccess is not supported. Instead, URL rewriting must be configured in your Nginx server configuration.
For example:
location / {
try_files $uri $uri/ /index.php/$uri;
}Make sure your PHP configuration is also set up to process the application's index.php file.
Install the package using Composer:
composer require erickfirmo/router<?php
// Require Composer's autoloader
require_once __DIR__ . '/vendor/autoload.php';
// Create the router instance
$router = new \ErickFirmo\Router;
// Define optional settings
// Load the routes file
require_once __DIR__ . '/routes/web.php';
// Run the router
$router->run();Example of a routes file:
<?php
$router->get('/examples', ExampleController::class, 'index', 'examples.index');
$router->get('/examples/{id}', ExampleController::class, 'show', 'examples.show');
$router->post('/examples/store', ExampleController::class, 'store', 'examples.store');
$router->put('/examples/update/{id}', ExampleController::class, 'update', 'examples.update');
$router->patch('/examples/update/{id}', ExampleController::class, 'update', 'examples.update');
$router->delete('/examples/destroy/{id}', ExampleController::class, 'delete', 'examples.destroy');To specify the HTTP verb in your form, add a hidden input named _method with the desired HTTP verb as its value.
The supported values are PUT, PATCH, and DELETE.
Example:
<input type="hidden" name="_method" value="PUT">This is not necessary when using GET or POST routes.
If all of your route-handling classes use the same namespace, you can define a default namespace for the router instance using the setNamespace(string $namespace) method:
<?php
$router->setNamespace('App\Controllers\\');By default, the router returns an error message when a requested route is not defined.
You can specify a custom 404 error page using the notFoundView(string $view) method:
<?php
// Define a custom 404 error page
$router->notFoundView(__DIR__.'/../views/errors/404.php');You can pass request data to the router using the setRequest(string $name, Object|array $request) method.
The provided value will be passed as the first argument to the matched controller method.
Example:
<?php
// Create an array containing the request data
$request = $_SERVER['REQUEST_METHOD'] == 'POST' ? $_POST : $_GET;
// Pass the request data to the router
$router->setRequest('request', $request);The request data can then be accessed from your controller:
<?php
class ExampleController
{
public function myMethod(array $request, int $id)
{
echo $request['name'];
echo $id;
}
}You can also pass an object as the request parameter:
<?php
class ExampleController
{
public function myMethod(Object $request, int $id)
{
echo $request->name;
echo $id;
}
}MIT License.
See LICENSE for details.