dionchaika/router

The PSR RESTful Router Library

dev-master 2019-05-20 12:29 UTC

Requires

• php: ^7.0
• dionchaika/container: dev-master
• dionchaika/http: dev-master

MIT

• Dion Chaika

• php
• http
• rest
• router
• psr
• psr-7
• http-message
• psr-17
• psr-15
• http-factory
• http-server-middleware
• http-server-handler

README

The PSR RESTful Router Library

Installation

composer require dionchaika/router:dev-master

<?php

require_once 'vendor/autoload.php';

For pretty URLs create an .htaccess file (for Apache) in your server public directory:

<IfModule mod_rewrite.c>

    <IfModule mod_negotiation.c>
        Options -MultiViews -Indexes
    </IfModule>

    RewriteEngine On

    RewriteCond %{HTTP:Authorization} .
    RewriteRule ^ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_URI} (.+)/$
    RewriteRule ^ %1 [L,R=301]

    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^ index.php [L]

</IfModule>

Configuration

<?php

use Dionchaika\Router\Route;
use Dionchaika\Router\Router;
use Dionchaika\Http\ServerRequest;
use Dionchaika\Http\Utils\Emitter;
use Dionchaika\Router\RouteCollection;

$routes = new RouteCollection([

    new Route('GET', '/', '\\App\\Controllers\\Home'),
    new Route('GET', '/about', '\\App\\Controllers\\About'),
    new Route('GET', '/contact', '\\App\\Controllers\\Contact')

]);

$router = new Router($routes);

Emitter::emit($router->match(ServerRequest::createFromGlobals()));

Basic usage

1. Registering routes:

<?php

use Dionchaika\Http\Factory\ResponseFactory;

$router->get('/', function ($request) {
    return (new ResponseFactory)
        ->createPlainTextResponse('Welcome!');
});

//
// Allowed request methods:
//
// $router->get( pattern, handler );
// $router->put( pattern, handler );
// $router->head( pattern, handler );
// $router->post( pattern, handler );
// $router->patch( pattern, handler );
// $router->delete( pattern, handler );
// $router->options( pattern, handler );
//