Skip to content
PHP Ecosystem
Explore

LogCollector

API reference › Debug › collectors › LogCollector

classyii\debug\collectors\LogCollector
ExtendsCollector
ImplementsCollectorInterface
Sourcesrc/collectors/LogCollector.php

Captures error, warning, info, and trace log messages emitted during the request for the Logs panel.

PropertyTypeDescriptionDefined by
$moduleyii\debug\Module|nullDebug module supplying the log target and sibling collectors, assigned by the module on registration. Default: null.Collector
MethodDescriptionDefined by
capture() finalEncodes 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() finalDeactivates the collector once, releasing any subscription created by start().Collector
startup() finalActivates the collector once at the start of the request lifecycle.Collector
getLogMessages() protectedReturns the accumulated log messages, optionally filtered by level, category, and exclusion lists.Collector
getLogTarget() protectedReturns the initialized log target of the owning debug module.Collector
isStarted() protectedReturns whether the collector is active for the current request.Collector
snapshot() protectedCaptures every error/warning/info/trace log message, excluding the categories owned by the Router collector.LogCollector
start() protectedHook invoked once when the collector activates; subclasses subscribe to framework events here.Collector
stop() protectedHook 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 Logs panel.

Returns

string: Stable collector ID.

protected function snapshot(): PHPForge\Debug\Panel\Log\LogSnapshot|null

Captures 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.