delolmo/symfony-router

PSR-15 middleware to use the symfony/routing component and store the route attributes in the request.

Requirements

• PHP ^8.1
• A PSR-7 http library
• A PSR-17 http factory

Installation

This package is installable and autoloadable via Composer as delolmo/symfony-router.

composer require delolmo/symfony-router

You may also want to install php-http/discovery to autodetect well-known PSR-17 HTTP factory implementations.

Example

Consider Symfony's PhpFileLoader to load route definitions from the following file:

# routes.php

use App\Controller\BlogController;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

$routes = new RouteCollection();
$routes->add('blog_list', new Route('/blog', array(
    'request-handler' => [BlogController::class, 'list']
)));
$routes->add('blog_show', new Route('/blog/{slug}', array(
    'request-handler' => [BlogController::class, 'show']
)));

return $routes;

For this example, we will be using middlewares/utils for a PSR-15 compliant dispatcher. See link for more PSR-15 implementations.

This example uses a basic anonymous function to print the route's attributes:

use Laminas\Diactoros\Response\HtmlResponse;
use Laminas\Diactoros\ServerRequest;
use Middlewares\Utils\Dispatcher;
use Middlewares\Utils\Factory;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Routing\Loader\PhpFileLoader;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\Router;

$fileLocator = new FileLocator(array(__DIR__));

$router = new Router(
    new PhpFileLoader($fileLocator),
    'routes.php',
    array('cache_dir' => __DIR__ . '/cache'),
    new RequestContext('/')
);

$factory = Factory::getRequestFactory();

$dispatcher = new Dispatcher([
    new DelOlmo\Middleware\SymfonyRouterMiddleware($router, $factory),
    function($request, $next) {
        return new HtmlResponse(json_encode($request->getAttributes()));
    }
]);

// Try matching a /blog request
$response = $dispatcher->dispatch(new ServerRequest([], [], '/blog'));

// Will return {"_route": "blog_list", "request-handler" => ["App\Controller\BlogController", "list"]}
$c->get('emitter')->emit($response);

// Try matching a /blog/hello-world request
$response = $dispatcher->dispatch(new ServerRequest([], [], '/blog/hello-world'));

// Will return {"_route": "blog_show", "request-handler" => ["App\Controller\BlogController", "show"], "slug" => "hello-world"}
$c->get('emitter')->emit($response);

Options

The constructor takes two arguments:

__construct(
    \Symfony\Component\Routing\Router $router,
    \Psr\Http\Message\ResponseFactoryInterface $responseFactory
)

The router instance to use and a PSR-17 factory to create the error responses (404 or 405).