Skip to content
PHP Ecosystem
Explore

RouteDefinitionExtractor

API reference › Yii3 Debug › Routing › RouteDefinitionExtractor

final classYii3\Debug\Routing\RouteDefinitionExtractor
Sourcesrc/Routing/RouteDefinitionExtractor.php

Extracts persistence-safe route definitions from Yii router state.

MethodDescriptionDefined by
find() staticSafely resolves one named route from the collection.RouteDefinitionExtractor
fromCollection() staticNormalizes the current route collection for diagnostic presentation.RouteDefinitionExtractor
fromCurrentRoute() staticBuilds a partial definition from matched-route metadata when the route collection is unavailable.RouteDefinitionExtractor
fromRoute() staticBuilds a complete definition from a Yii route without retaining handler objects or configuration values.RouteDefinitionExtractor
public static function find(string $name, Yiisoft\Router\RouteCollectionInterface|null $routes): PHPForge\Debug\Panel\Request\Routing\RouteDefinition|null

Safely resolves one named route from the collection.

Parameters

ParameterTypeDescription
$namestringRoute name to look up.
$routesYiisoft\Router\RouteCollectionInterface|nullLive 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.

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

ParameterTypeDescription
$routesYiisoft\Router\RouteCollectionInterface|nullLive 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.

public static function fromCurrentRoute(Yiisoft\Router\CurrentRoute $currentRoute): PHPForge\Debug\Panel\Request\Routing\RouteDefinition|null

Builds a partial definition from matched-route metadata when the route collection is unavailable.

Parameters

ParameterTypeDescription
$currentRouteYiisoft\Router\CurrentRouteRoute matched for the captured request.

Returns

PHPForge\Debug\Panel\Request\Routing\RouteDefinition|null: Partial definition, or null when the match carries no name.

public static function fromRoute(Yiisoft\Router\Route $route): PHPForge\Debug\Panel\Request\Routing\RouteDefinition

Builds a complete definition from a Yii route without retaining handler objects or configuration values.

Parameters

ParameterTypeDescription
$routeYiisoft\Router\RouteRoute declared by the application.

Returns

PHPForge\Debug\Panel\Request\Routing\RouteDefinition: Definition carrying only persistence-safe scalars.