RouterCollector

API reference › Debug › collectors › RouterCollector

class	`yii\debug\collectors\RouterCollector`
Extends	`Collector`
Implements	`CollectorInterface`
Source	`src/collectors/RouterCollector.php`

Captures the routing trace of the request for the Router panel.

Properties

Property	Type	Description	Defined by
`$module`	`yii\debug\Module\|null`	Debug module supplying the log target and sibling collectors, assigned by the module on registration. Default: `null`.	`Collector`

Method	Description	Defined by
`capture()` final	Encodes the typed snapshot built by the subclass into the payload persisted for the panel.	`Collector`
`getCategories()`	Returns the log categories scanned for routing trace messages.	`RouterCollector`
`id()`	Returns the stable ID pairing this collector with the Router panel.	`RouterCollector`
`instrument()`	Installs low-level instrumentation as soon as the module registers the collector, before the panels are built.	`Collector`
`setCategories()`	Appends one or more log categories to `$categories`.	`RouterCollector`
`shutdown()` final	Deactivates the collector once, releasing any subscription created by `start()`.	`Collector`
`startup()` final	Activates the collector once at the start of the request lifecycle.	`Collector`
`getLogMessages()` protected	Returns the accumulated log messages, optionally filtered by level, category, and exclusion lists.	`Collector`
`getLogTarget()` protected	Returns the initialized log target of the owning debug module.	`Collector`
`isStarted()` protected	Returns whether the collector is active for the current request.	`Collector`
`snapshot()` protected	Snapshots the routing trace, the resolved route, and the dispatched action.	`RouterCollector`
`start()` protected	Hook invoked once when the collector activates; subclasses subscribe to framework events here.	`Collector`
`stop()` protected	Hook invoked once when the collector deactivates; subclasses detach subscriptions and clear state here.	`Collector`

public function getCategories(): list<string>

Returns the log categories scanned for routing trace messages.

Returns

list<string>: Category names in declaration order.

public function id(): string

Returns the stable ID pairing this collector with the Router panel.

Returns

string: Stable collector ID.

public function setCategories(list<string>|string $values): void

Appends one or more log categories to $categories.

Parameters

Parameter	Type	Description
`$values`	`list<string>\|string`	Single category, or list of categories.

protected function snapshot(): PHPForge\Debug\Panel\Router\RouterSnapshot|null

Snapshots the routing trace, the resolved route, and the dispatched action.

Returns

PHPForge\Debug\Panel\Router\RouterSnapshot|null: Captured routing payload; null when the collector never started.