LogCollector
API reference › Debug › collectors › LogCollector
Captures error, warning, info, and trace log messages emitted during the request for the Logs panel.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$module | yii\| | Debug module supplying the log target and sibling collectors, assigned by the module on registration. Default: null. | Collector |
Methods
Section titled “Methods”| 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 Logs panel. | LogCollector |
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 |
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 | Captures every error/warning/info/trace log message, excluding the categories owned by the Router collector. | LogCollector |
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 |
Method details
Section titled “Method details”public function id(): stringReturns the stable ID pairing this collector with the Logs panel.
Returns
string: Stable collector ID.
snapshot()
Section titled “snapshot() ”protected function snapshot(): PHPForge\Debug\Panel\Log\LogSnapshot|nullCaptures every error/warning/info/trace log message, excluding the categories owned by the Router collector.
Returns
PHPForge\Debug\Panel\Log\LogSnapshot|null: Captured log payload; null when the collector never started.