middlewares/fast-route

PSR-15 middleware to use FastRoute

middlewares/fast-route

Middleware to use FastRoute for handler discovery.

Requirements

• PHP >= 7.2
• A PSR-7 http library
• A PSR-15 middleware dispatcher

Installation

This package is installable and autoloadable via Composer as middlewares/fast-route.

composer require middlewares/fast-route

You may also want to install middlewares/request-handler.

Example

This example uses middlewares/request-handler to execute the route handler:

//Create the router dispatcher
$dispatcher = FastRoute\simpleDispatcher(function (FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/hello/{name}', function ($request) {
        //The route parameters are stored as attributes
        $name = $request->getAttribute('name');

        //You can echo the output (it will be captured and written into the body)
        echo sprintf('Hello %s', $name);

        //Or return a string
        return sprintf('Hello %s', $name);

        //Or return a response
        return new Response();
    });
});

$dispatcher = new Dispatcher([
    new Middlewares\FastRoute($dispatcher),
    new Middlewares\RequestHandler()
]);

$response = $dispatcher->dispatch(new ServerRequest('/hello/world'));

FastRoute allows anything to be defined as the router handler (a closure, callback, action object, controller class, etc). The middleware will store this handler in a request attribute.

Usage

Create the middleware with a FastRoute\Dispatcher instance:

$route = new Middlewares\FastRoute($dispatcher);

Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface as the second argument, that will be used to create the error responses (404 or 405). If it's not defined, Middleware\Utils\Factory will be used to detect it automatically.

$responseFactory = new MyOwnResponseFactory();

$route = new Middlewares\FastRoute($dispatcher, $responseFactory);

attribute

Changes the attribute name used to store the handler in the server request. The default name is request-handler.

$dispatcher = new Dispatcher([
    //Save the route handler in an attribute called "route"
    (new Middlewares\FastRoute($dispatcher))->attribute('route'),

    //Execute the route handler
    (new Middlewares\RequestHandler())->handlerAttribute('route')
]);

---

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.

fast-route's Issues

Deprecated: Non-static method should not be called statically in...

How can I make working for example this route?
['GET', '/article/{id}', ['SuperBlog\Controller\ArticleController', 'show']] ?

It works with FastRoute but in middle ore I get this error:

Deprecated: Non-static method SuperBlog\Controller\ArticleController::show() should not be called statically in.

ArticleController constructor has 3 params and I am using php-di and Relay packages.

PHP 8.0

Any timelines or guesstimates for PHP 8.0 support? Do you want help regarding this?

Thanks.

Extend the middleware

Could you please change the class properties as protected, so we can extend midleware . For example, I'm trying to override the 'process' method and set exceptions to be thrown: HttpNotFoundException, HttpMethodNotAllowedException, but an error occurs because I can't access the $this->router property.

Allow to access the matched route in the request or response

I could not find a way to access the matched route pattern for a given request or its consequent response. Being able to access to it would be good for observability purposes.

404 and 405

Are there any code examples of how to implement the 404 and 405 custom errors? Also are there any examples are how to implement things like 301 redirect responses in connection with the return?

Support array callables with resolver

Currently if the callable is an array the resolver will be called with this array as the id.

Callable arrays with fast route usually look like this:

[\Namespace\To\Controller::class, 'methodName']

I propose adding an extra check and only try to resolve the first element of the array here

WDYT?