Implement Route grouping

[arhimede]

Feature Request

Q	A
New Feature	yes
RFC	yes
BC Break	yes/no ?

Summary

Investigate how to implement Route grouping

• there are groups in fastroute but not in Mezzio router interface

[alexmerlin]

@arhimede @MarioRadu @pinclau
See RoutesDelegator.php for a concept implementation of the route grouping feature.

Note

This implementation might not support (at least, it wasn't tested with) inline handlers/middlewares.

[arhimede]

@alexmerlin Please create a separate package for this
Maybe somebody will not want such a complex route logic.

[alexmerlin]

@alexmerlin Please create a separate package for this Maybe somebody will not want such a complex route logic.

@arhimede Created https://github.com/dotkernel/dot-router

[arhimede]

This dot-router package will be used in the apps that do not need route groups

Or only "on-demand*

[alexmerlin]

So the main DK projects (API, Admin, Frontend, Light) will not ship with it already implemented by default?

[arhimede]

Well, main dk projects will have it by default
It ia presumable that will need it anyway from the beginning

Only light will not get it

[alexmerlin]

There's one issue, though:
Regarding dotkernel/dot-router, we need to decide on which package it will be based on.

The obvious choice would be to use mezzio/mezzio-fastroute or mezzio/mezzio-router in order to have access to the RouteCollector.
The problem with this is that a key functionality - the ability to register multiple handlers with a route - comes from mezzio/mezzio's MiddlewareFactory.php which, in turn, uses components from laminas-stratigility.
So, we can either "borrow" MiddlewareFactory from mezzio/mezzio OR base our package on mezzio/mezzio.

[alexmerlin]

@MarioRadu @pinclau Thoughts on this style of registering routes?

class RoutesDelegator
{
    public function __invoke(ContainerInterface $container, string $serviceName, callable $callback): Application
    {
        // Get dot-router's RouteCollector from the container
        $routeCollector = $container->get(\Dot\Router\RouteCollectorInterface::class);

        /**
         * Register routes
         * Method arguments:
         * - route path
         * - handler or array of handlers
         * - route name
         * - array of request methods (available only with: ->route(...))
         */
        $routeCollector
            ->any('/route/any', GetIndexResourceHandler::class, 'route::any')
            ->delete('/route/delete', GetIndexResourceHandler::class, 'route::delete')
            ->get('/route/get', GetIndexResourceHandler::class, 'route::get')
            ->patch('/route/patch', GetIndexResourceHandler::class, 'route::patch')
            ->post('/route/post', GetIndexResourceHandler::class, 'route::post')
            ->put('/route/put', GetIndexResourceHandler::class, 'route::put')
            ->route('/route/route', GetIndexResourceHandler::class, 'route::route');

        /**
         * Register route group
         * `group` method arguments:
         * - route prefix
         * - middleware or array of middlewares to be applied to all child routes
         * Arguments for the rest of the methods:
         * - route path
         * - handler or array of handlers
         * - route name
         * - array of request methods (available only with method ->route(...))
         * - middleware or array of middlewares to be excluded for specific child route
         */
        $routeCollector->group('/group', [FirstMiddleware::class, SecondMiddleware::class, ThirdMiddleware::class])
            ->any('/any', GetIndexResourceHandler::class, 'group::any')
            ->delete('/delete', GetIndexResourceHandler::class, 'route::delete', ThirdMiddleware::class)
            ->get('/get', GetIndexResourceHandler::class, 'route::get', [FirstMiddleware::class, SecondMiddleware::class])
            ->patch('/patch', GetIndexResourceHandler::class, 'route::patch')
            ->post('/post', GetIndexResourceHandler::class, 'route::post')
            ->put('/put', GetIndexResourceHandler::class, 'route::put')
            ->route('/route', GetIndexResourceHandler::class, 'group::route');

        return $callback();
    }
}

[pinclau]

@alexmerlin LGTM