thruster/http-router

Thruster HttpRouter Component (PSR-7 and FastRoute based router)

1.1.0 2016-05-31 12:04 UTC

This package is auto-updated.

Last update: 2024-06-14 02:24:35 UTC


README

[Latest Version] (https://github.com/ThrusterIO/http-router/releases) [Software License] (LICENSE) [Build Status] (https://travis-ci.org/ThrusterIO/http-router) [Code Coverage] (https://scrutinizer-ci.com/g/ThrusterIO/http-router) [Quality Score] (https://scrutinizer-ci.com/g/ThrusterIO/http-router) [Total Downloads] (https://packagist.org/packages/thruster/http-router)

[Email] (mailto:team@thruster.io)

The Thruster HttpRoute Component. PSR-7 and FastRoute based simple router.

Install

Via Composer

$ composer require thruster/http-router

Usage

Standalone usage

<?php

use Psr\Http\Message\RequestInterface;
use Thruster\Component\HttpRouter\Router;
use Thruster\Component\HttpRouter\RouteProvider;

$application = new class implements RouteProvider {
    public function getRoutes() : array
    {
        return [
            'hello_world' => ['GET', '/', 'hello'],
            ['POST', '/', [$this, 'foo']]
        ];
    }

    public function hello(ServerRequestInterface $request)
    {
        // return new Response(200, [], 'Hello world');
    }

    public function foo(ServerRequestInterface $request)
    {
        // return new Response(404, [], 'Foo Bar');
    }
};


$router = new Router($application);
$response = $router->handleRequest(ServerRequest::fromGlobals()); // PSR-7 Response

PSR-7 style middleware

<?php

use Psr\Http\Message\RequestInterface;
use Thruster\Component\HttpRouter\Router;
use Thruster\Component\HttpRouter\RouteProvider;
use Thruster\Component\HttpRouter\RouteHandler;

$application = new class implements RouteProvider, RouteHandler {
    public function getRoutes() : array
    {
        return [
            'hello_world' => ['GET', '/', 'hello'],
            ['POST', '/', [$this, 'foo']]
        ];
    }

    public function handleRoute(
    	ServerRequestInterface $request,
    	ResponseInterface $response,
    	callable $actionHandler
    ) : ResponseInterface {
    	// ... call actionHandler and return ResponseInterface
    }

    public function handleRouteMethodNotAllowed(
    	ServerRequestInterface $request,
    	ResponseInterface $response,
    	array $allowedMethods
    ) : ResponseInterface {
    	// ... handle method not allowed error
    }

    public function handleRouteNotFound(
    	ServerRequestInterface $request,
    	ResponseInterface $response
    ) : ResponseInterface {
    	// ... handle route not found (404)
    }
};


$router = new Router($application, $application);
$response = $router(ServerRequest::fromGlobals(), new Response()); // PSR-7 Response

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

License

Please see License File for more information.