# RouteDefinitionExtractor

> Extracts persistence-safe route definitions from Yii router state.

[API reference](/docs/api/index.md) › [Yii3 Debug](/docs/extensions/yii3-debug/reference/index.md) › [Routing](/docs/extensions/yii3-debug/reference/routing/index.md) › RouteDefinitionExtractor

| final class | `Yii3\Debug\Routing\RouteDefinitionExtractor` |
| --- | --- |
| Source | [`src/Routing/RouteDefinitionExtractor.php`](https://github.com/yii3/debug/blob/main/src/Routing/RouteDefinitionExtractor.php#L17) |

Extracts persistence-safe route definitions from Yii router state.

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`find()`](#method-find) static | Safely resolves one named route from the collection. | `RouteDefinitionExtractor` |
| [`fromCollection()`](#method-fromCollection) static | Normalizes the current route collection for diagnostic presentation. | `RouteDefinitionExtractor` |
| [`fromCurrentRoute()`](#method-fromCurrentRoute) static | Builds a partial definition from matched-route metadata when the route collection is unavailable. | `RouteDefinitionExtractor` |
| [`fromRoute()`](#method-fromRoute) static | Builds a complete definition from a Yii route without retaining handler objects or configuration values. | `RouteDefinitionExtractor` |

## Method details

### find() <span id="method-find"></span>

```php
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**

| Parameter | Type | Description |
| --- | --- | --- |
| `$name` | `string` | Route name to look up. |
| `$routes` | `Yiisoft\Router\RouteCollectionInterface\|null` | 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() <span id="method-fromCollection"></span>

```php
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\Router\RouteCollectionInterface\|null` | 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() <span id="method-fromCurrentRoute"></span>

```php
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**

| Parameter | Type | Description |
| --- | --- | --- |
| `$currentRoute` | `Yiisoft\Router\CurrentRoute` | 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() <span id="method-fromRoute"></span>

```php
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**

| Parameter | Type | Description |
| --- | --- | --- |
| `$route` | `Yiisoft\Router\Route` | Route declared by the application. |

**Returns**

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