quantum-php / quantum-php/framework
Add first-class special route token support for framework-owned URL segments such as @lang and @version
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 36
- Forks
- 22
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Summary
Add first-class router support for framework-owned special route tokens such as:
@lang@version
so route definitions can explicitly declare special URL segments in a clear, semantic, and framework-native way.
Why
Quantum currently handles special routing concerns inconsistently.
For example:
- language URL handling relies on config-driven segment position detection
- API versioning has no clean framework-level model yet
This makes special URL segments feel implicit, positional, and harder to reason about than ordinary route structure.
A better model is to let routes explicitly declare framework-owned special segments in the route pattern itself.
Examples:
$route->get('@lang/posts', 'PostController', 'posts');
$route->get('@version/posts', 'PostController', 'posts');
$route->get('@version/@lang/posts', 'PostController', 'posts');
This makes route semantics explicit while allowing the framework to treat those segments differently from ordinary user-defined route parameters.
Goal
Introduce a routing foundation that supports reserved special route tokens for framework-level concerns.
This foundation should make it possible for Quantum to support explicit special URL segments without relying on brittle positional config or ad hoc route conventions.
Proposed Direction
Support reserved route tokens inside route patterns, beginning with the concept of framework-owned segments such as:
@lang@version
These tokens should be recognized by the router as special routing constructs rather than ordinary route parameters.
The framework should be able to:
- recognize these tokens during route compilation
- match them correctly during request routing
- attach their resolved values to framework route context
- keep them distinct from normal action parameters unless explicitly intended otherwise
Important behavior
Special route tokens should be treated differently from ordinary route params.
They should be:
- framework-reserved
- semantically meaningful
- available to framework internals such as language detection or version-aware controller resolution
- prevented from behaving like ordinary positional controller action arguments by default
Initial scope
This ticket is the router foundation only.
It should establish the special-token mechanism itself, not fully implement every feature that may use it.
Follow-up features can then build on this foundation, including:
- explicit
@langrouting support - explicit
@versionAPI routing support
Acceptance Criteria
- the router supports reserved special tokens inside route patterns
- special tokens are recognized during route compilation and matching
- matched special-token values are available to framework internals as route context
- special-token values are kept distinct from ordinary controller action parameter binding by default
- the routing system can support multiple special tokens in one path, such as
@version/@lang/posts - tests cover special-token parsing, matching, and route context behavior
- existing ordinary route parameter behavior remains intact
Notes
Relevant code:
src/Router/PatternCompiler.phpsrc/Router/RouteBuilder.phpsrc/Router/Route.phpsrc/Router/MatchedRoute.phpsrc/Router/RouteDispatcher.phpsrc/Http/Traits/Request/Route.php
This ticket should be treated as the routing foundation for future explicit @lang and @version support.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen von src/Router/PatternCompiler.php und src/Router/RouteBuilder.php und verfolge anschließend, wie src/Router/Route.php, MatchedRoute.php, RouteDispatcher.php und src/Http/Traits/Request/Route.php Routenwerte kompilieren, abgleichen und bereitstellen. Als abgeschlossen gilt die Arbeit, wenn reservierte Tokens wie @version/@lang in einem Pattern koexistieren können, den Routen-Kontext ohne standardmäßige Aktionsbindung erreichen und gewöhnliche Parameter unverändert bleiben, mit Tests für Parsing, Matching und das Kontextverhalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- backend
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100