Support nested module-relative controller resolution in routes while preserving explicit controller class references
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 64/100
Línea de trabajo
Comienza rastreando la resolución del controlador a través de src/Router/RouteBuilder.php y src/Router/RouteDispatcher.php; después, inspecciona src/Router/Route.php y los metadatos de la ruta de la request y las rutas de listado de rutas. Verifica cadenas de controlador planas, anidadas relativas al módulo y explícitamente totalmente cualificadas durante el dispatch, el listado de rutas y los metadatos; añade pruebas para cada caso y confirma que el comportamiento plano existente se mantiene intacto.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
Enhance Quantum route controller resolution so route definitions can reference controllers in nested subnamespaces/folders within the current module, while preserving existing support for explicit fully qualified controller class references.
This should allow controller route strings such as:
PostControllerV1\PostControllerAdmin\UserController
to resolve relative to the current module’s Controllers namespace, without breaking the ability to use explicit FQCN controller class strings where intentionally supported.
Why
Current route controller resolution in Quantum is too limited for deeper controller organization.
Today, flat shorthand works for controllers that live directly under:
{Module}\Controllers\...
However, the current resolution logic uses a simple backslash check to decide whether a handler should be prefixed with the module controller namespace.
That means a nested relative controller path such as:
V1\PostController
is currently treated the same way as an explicitly qualified controller class string, even though those are different use cases.
As a result, Quantum lacks a clean way to organize controllers inside nested subnamespaces within the current module.
Goal
Allow nested controller organization inside a module while preserving both:
- current flat controller shorthand
- intentional explicit FQCN controller class references
Proposed Direction
Update route controller resolution so it can distinguish between:
Module-relative controller shorthand
Examples:
PostControllerV1\PostControllerAdmin\UserController
These should resolve relative to the current module’s Controllers namespace.
Examples:
-
PostController
resolves to:{ModuleBaseNamespace}\{CurrentModule}\Controllers\PostController
-
V1\PostController
resolves to:{ModuleBaseNamespace}\{CurrentModule}\Controllers\V1\PostController
-
Admin\UserController
resolves to:{ModuleBaseNamespace}\{CurrentModule}\Controllers\Admin\UserController
Explicit FQCN controller references
If the route handler is intentionally written as an explicit fully qualified controller class string, that behavior should remain supported.
Examples:
\Modules\Api\Controllers\V1\PostControllerModules\Api\Controllers\V1\PostController
The resolution logic should therefore no longer use “contains backslash” as the only distinction between shorthand and explicit controller references.
Instead, it should distinguish properly between:
- nested module-relative controller paths
- explicit FQCN controller class references
Why this matters
This is a prerequisite for cleaner future work such as:
- API major versioning within a single module
- better controller organization in larger modules
- route-set mounting with version-specific controller subnamespaces
without forcing:
- flat controller folders
- duplicated route definitions
- awkward controller naming workarounds
Acceptance Criteria
- flat controller shorthand continues to work
- nested controller shorthand such as
V1\PostControllerandAdmin\UserControllerresolves correctly within the current module - explicit FQCN controller class references remain supported if intentionally provided
- route listing, dispatch, and request route metadata continue to work with nested resolved controllers
- controller resolution no longer relies solely on “contains backslash” to decide whether a handler is relative or explicit
- tests verify flat controller shorthand resolution such as
PostController - tests verify nested module-relative controller shorthand such as
V1\PostController - tests verify explicit FQCN controller class references continue to resolve correctly
Notes
Relevant code:
src/Router/RouteBuilder.phpsrc/Router/RouteDispatcher.phpsrc/Router/Route.phpsrc/Http/Traits/Request/Route.phpsrc/Console/Commands/RouteListCommand.php
This ticket should be treated as a routing foundation improvement and a prerequisite for cleaner API versioning support inside a single module.
- Lenguaje dominante
- PHP
- Estrellas
- 36
- Forks
- 22
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de quantum-php/framework
-
routing testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
quantum-php/framework#547 ·
-
view
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
quantum-php/framework#542 ·
-
enhancement http
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
quantum-php/framework#565 · 1 comentario ·
-
components view
Dificultad 5/5 Más de una semana Aptitud para principiantes 42/100
quantum-php/framework#551 ·
-
Add explicit @version special route token support for API major versioning within a single moduleAbiertorouting
Dificultad 5/5 Más de una semana Aptitud para principiantes 45/100
quantum-php/framework#550 ·
Todos los issues de quantum-php/framework
Issues similares
-
[Sync EN] Fix session read handler docs: false reports a failure, not a missing session (#5902)Abiertosync-en
Dificultad 2/5 1-2 días Aptitud para principiantes 84/100
Los mantenedores suelen responder en 2 días
-
feature-request needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
aws/aws-sdk-php#3365 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 90/100
-
bug status: unverified
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
woocommerce/google-listings-and-ads#3884 ·
Los mantenedores suelen responder en 1 día