ConfigCollector

API reference › Debug › collectors › ConfigCollector

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

Captures the application configuration and runtime environment for the Configuration 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`
`id()`	Returns the stable ID pairing this collector with the Configuration panel.	`ConfigCollector`
`instrument()`	Installs low-level instrumentation as soon as the module registers the collector, before the panels are built.	`Collector`
`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`
`getApplication()` protected	Returns the active application instance, or `null` when the framework slot does not contain an object.	`ConfigCollector`
`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 framework/PHP/application identity and the installed-extensions roster.	`ConfigCollector`
`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 id(): string

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

Returns

string: Stable collector ID.

protected function getApplication(): object|null

Returns the active application instance, or null when the framework slot does not contain an object.

Returns

object|null: Active application, or null when the framework slot holds no object.

protected function snapshot(): PHPForge\Debug\Panel\Config\ConfigSnapshot|null

Snapshots the framework/PHP/application identity and the installed-extensions roster.

Returns

PHPForge\Debug\Panel\Config\ConfigSnapshot|null: Captured configuration payload; null when the collector never started.