mRouter

A simple routing class build with PHP.

Quick install

Include the mRouter class into your PHP file

require_once( 'class/mRouter.class.php' );

Create an instance of the mRouter class

$router = new mRouter();

After adding the routing functions, it is time to let mRoute do its magic! At the following code:

$router->open();

HTTP Methods

mRouter supports 5 https methods: GET, POST, PUT, PATH, DELETE

Add a route

You can use any HTTP method to create a new route. We will use a GET method for this example, however it can be replaced by POST, PUT, PATH or DELETE. To make a GET request to https://yoursite.com/contact/ use the following code:

$router->get( 'contact', function( $response ) {
  // add your actions
});

Using variables in requests

You are also able to use one or multiple variables in your request. To use a variable in a request you have to use the {variable} format

$router->get( 'user/{id}', function( $response ) {
  // get the value of the 'id' variable
  $id = $response->getParameter( 'id' );
  include( 'view/user.php' );
});

Status route

Not only can you create routes based on HTTP methods and URLs, you can also create routes based on status codes. This can be usefull to create a 'Page not found' route when no HTTP Method and URL is found. To create a 'Page not found' route, use the following code:

$router->status( '404', function() {
  // 404 Not Found;
  include( 'view/404.php' );
});

Full example

require_once( 'class/mrouter.class.php' );

$router = new mRouter();

$router->get( '', function( $response ) {
    include( 'view/home.php' );
});

$router->get( 'user/{id}', function( $response ) {
    $id = $response->getParameter( 'id' );
    include( 'view/user.php' );
});

$router->get( 'project/{project}/subject/{subject}', function( $response ) {
    $project = $response->getParameter( 'project' );
    $subject = $response->getParameter( 'subject' );
    include( 'view/project.php' );
});

$router->status( '404', function() {
    include( 'view/404.php' );
});

$router->open();