RouteDefinitionExtractor
API reference › Yii3 Debug › Routing › RouteDefinitionExtractor
Extracts persistence-safe route definitions from Yii router state.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
find() static | Safely resolves one named route from the collection. | RouteDefinitionExtractor |
fromCollection() static | Normalizes the current route collection for diagnostic presentation. | RouteDefinitionExtractor |
fromCurrentRoute() static | Builds a partial definition from matched-route metadata when the route collection is unavailable. | RouteDefinitionExtractor |
fromRoute() static | Builds a complete definition from a Yii route without retaining handler objects or configuration values. | RouteDefinitionExtractor |
Method details
Section titled “Method details”find()
Section titled “find() ”public static function find(string $name, Yiisoft\Router\RouteCollectionInterface|null $routes): PHPForge\Debug\Panel\Request\Routing\RouteDefinition|nullSafely resolves one named route from the collection.
Parameters
| Parameter | Type | Description |
|---|---|---|
$name | string | Route name to look up. |
$routes | Yiisoft\ | Live route collection, or null when it cannot be resolved. |
Returns
PHPForge\Debug\Panel\Request\Routing\RouteDefinition|null: Matching definition, or null when the route cannot be resolved.
fromCollection()
Section titled “fromCollection() ”public static function fromCollection(Yiisoft\Router\RouteCollectionInterface|null $routes): list<PHPForge\Debug\Panel\Request\Routing\RouteDefinition>Normalizes the current route collection for diagnostic presentation.
Collection failures intentionally propagate so presentation code can distinguish them from an empty collection.
Parameters
| Parameter | Type | Description |
|---|---|---|
$routes | Yiisoft\ | Live route collection, or null when it cannot be resolved. |
Returns
list<PHPForge\Debug\Panel\Request\Routing\RouteDefinition>: Definitions in declaration order; empty when no collection is available.
fromCurrentRoute()
Section titled “fromCurrentRoute() ”public static function fromCurrentRoute(Yiisoft\Router\CurrentRoute $currentRoute): PHPForge\Debug\Panel\Request\Routing\RouteDefinition|nullBuilds a partial definition from matched-route metadata when the route collection is unavailable.
Parameters
| Parameter | Type | Description |
|---|---|---|
$currentRoute | Yiisoft\ | Route matched for the captured request. |
Returns
PHPForge\Debug\Panel\Request\Routing\RouteDefinition|null: Partial definition, or null when the match carries no name.
fromRoute()
Section titled “fromRoute() ”public static function fromRoute(Yiisoft\Router\Route $route): PHPForge\Debug\Panel\Request\Routing\RouteDefinitionBuilds a complete definition from a Yii route without retaining handler objects or configuration values.
Parameters
| Parameter | Type | Description |
|---|---|---|
$route | Yiisoft\ | Route declared by the application. |
Returns
PHPForge\Debug\Panel\Request\Routing\RouteDefinition: Definition carrying only persistence-safe scalars.