php-router

This router is designed to help you easily and efficiently handle HTTP requests and responses in your PHP applications. It is inspired by the popular Laravel framework, and aims to provide a similar experience and functionality.

Getting Started

• Installation
• The Router class
• Route parameters
• Regular Expression Constraints
• Named Routes
• Grouping routes
• Route redirects
• Generating URLs
• Middlewares
• Example
• TODO

Installation

You may use composer to intall MrF0o/php-router by running this command:

composer require mrf0o/php-router

The Router class

After the installation is complete you can start using the router by including The Router class. for example this route will fire whenever /hello is hit:

use Mrfoo\PHPRouter\Router;

Router::get('/hello', function () {
	echo  '<h1>hello there</h1>';
});

Router::run();

You can see that each request is represented as a static method of the Router class, thus you can change the get with each of these methods: post, put, patch and delete.

Make sure to run the Router using the run static method.

Route parameters

To capture a segment in your url you can use route parameters, these parameters will be passed to the handler function in order.

Router::get('/hello/{name}', function ($name) {
	echo  '<h1>hello '.$name.'</h1>';
})

optional parameters aren't implemented yet, so this route will be matched only if the parameter {name} is present, otherwise it will give a 404 error

Regular Expression Constraints

Sometimes, you may need to constrain a parameter using regular expression, you can do this using the where method on the Route instance.

Router::get('/user/{name}', function ($name) {
	// ...
})->where('name', '[A-Za-z]+');

Router::get('/user/{id}/{name}', function  (string  $id, string  $name) {
	// ...
})->where(['id'  =>  '[0-9]+', 'name'  =>  '[a-z]+']);

Named Routes

You may give names to your routes using the name method on Route instance, this will make it easier to reference your routes elsewhere in your code using the route helper method later.

Router::get('/user/profile', function  () {
	// ...
})->name('profile');

Grouping routes

Also, you can create route groups using the group method of the router class, each Route registered in the callback will share the properties passed to the group method.

Router::group(['prefix' => '/user'], function () {
	// here all routes will be prefixed with /user
    Router::get('/update', fn () => die('not implemented')); /* /user/update */
});

Route redirects

You can redirect a route to another route using the redirect method on the Router class.

Router::redirect('/old', '/new');

by default the redirect will be a 302 redirect, but you can change that by passing the status code as the third argument.

Router::redirect('/old', '/new', 301);

or if you would like a permanent redirect you can use the permanentRedirect method, this will send a 301 redirect.

Router::permanentRedirect('/old', '/new');

Generating URLs

You can generate URLs for your routes using the route helper method, this method accepts the name of the route and a variable count of parameters to be passed to the route.

Router::get('/user/{id}', function ($id) {
	// ...
})->name('user.profile');

$url = route('user.profile', 1);
// $url = 'http://example.com/user/1'

Middlewares

Middlewares are a great way to filter requests before they reach your route handler, in this router library Middlewares are represented as classes that Overrides the handle method in the \Mrfoo\PHPRouter\Middleware class.

<?php
namespace Middlewares;

use Mrfoo\PHPRouter\Core\Middleware;

class AuthMiddleware extends Middleware
{
	public function handle()
	{
		if (!isset($_SESSION['user_id'])) {
			// redirect to login page
			header('Location: /login');
			exit;
		}
	}
}

the handle method will be called before the route handler, so you can do any checks you want and redirect the user if needed.

Then you can use the middleware in your routes like this:

Router::get('/user/profile', function () {
	// ...
})->name('user.profile')->middleware(AuthMiddleware::class);

and you may assign multiple middlewares to a route like this:

Router::get('/user/profile', function () {
	// ...
})->name('user.profile')->middleware([AuthMiddleware::class, AnotherMiddleware::class]);

you can override the terminate method to do any cleanup after the route handler is called.

<?php
namespace Middlewares;

use Mrfoo\PHPRouter\Core\Middleware;

class AuthMiddleware extends Middleware
{
	public function handle()
	{
		if (!isset($_SESSION['user_id'])) {
			// redirect to login page
			header('Location: /login');
			exit;
		}
	}

	public function terminate()
	{
		// do some cleanup
	}
}

Quick Example

<?php
include './vendor/autoload.php';
use Mrfoo\PHPRouter\Router;
use Controllers\UserController;

Router::get('/greet', function () {
    echo 'hello everyone';
})->name('greeting');

Router::post('/user/create', function () {
    // ...
    $id = $_POST['user_id']; // make sure to sanitize your inputs!
})->name('user.create');

Router::patch('/user/profile', [UserController::class, 'update'])->name('user.profile.update');

// make it bun dem!
Router::run();

Here I used UserController class as an example to demonstrate, the other convention to use route handlers besides the callback function.

TODO

• Route Grouping
• Route redirects
• route helper function, this should be globally available
• helper methods for routes constraints
• Middlewares
• Rate limiting