# EventCollector

> Captures framework events reaching the global listener during the request for the Events panel.

[API reference](/docs/api/index.md) › [Debug](/docs/extensions/debug/reference/index.md) › [collectors](/docs/extensions/debug/reference/collectors/index.md) › EventCollector

| class | `yii\debug\collectors\EventCollector` |
| --- | --- |
| Extends | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| Implements | [`CollectorInterface`](https://github.com/php-forge/debug/blob/e4fbb8c3238a4d011ceef5e0094344abd50deaf4/src/CollectorInterface.php) |
| Source | [`src/collectors/EventCollector.php`](https://github.com/yii2-extensions/debug/blob/main/src/collectors/EventCollector.php#L20) |

Captures framework events reaching the global listener during the request for the Events panel.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-captureContext"></span>`$captureContext` | `bool` | Opt-in capture of selected action/view metadata; event values and rendered output are never dumped. Default: `false`. | `EventCollector` |
| <span id="property-module"></span>[`$module`](/docs/extensions/debug/reference/collectors/collector/index.md#property-module) | [`yii\debug\Module`](/docs/extensions/debug/reference/module/index.md)`\|null` | Debug module supplying the log target and sibling collectors, assigned by the module on registration. Default: `null`. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="property-traceLimit"></span>`$traceLimit` | `int` | Opt-in argument-free trace depth; zero disables capture, and sixteen is the hard maximum. Default: `0`. | `EventCollector` |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-capture"></span>[`capture()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-capture) final | Encodes the typed snapshot built by the subclass into the payload persisted for the panel. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| [`id()`](#method-id) | Returns the stable ID pairing this collector with the Events panel. | `EventCollector` |
| <span id="method-instrument"></span>[`instrument()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-instrument) | Installs low-level instrumentation as soon as the module registers the collector, before the panels are built. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="method-shutdown"></span>[`shutdown()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-shutdown) final | Deactivates the collector once, releasing any subscription created by [`start()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-start). | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="method-startup"></span>[`startup()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-startup) final | Activates the collector once at the start of the request lifecycle. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="method-getLogMessages"></span>[`getLogMessages()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-getLogMessages) protected | Returns the accumulated log messages, optionally filtered by level, category, and exclusion lists. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="method-getLogTarget"></span>[`getLogTarget()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-getLogTarget) protected | Returns the initialized log target of the owning debug module. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| <span id="method-isStarted"></span>[`isStarted()`](/docs/extensions/debug/reference/collectors/collector/index.md#method-isStarted) protected | Returns whether the collector is active for the current request. | [`Collector`](/docs/extensions/debug/reference/collectors/collector/index.md) |
| [`snapshot()`](#method-snapshot) protected | Returns the captured events as a typed snapshot. | `EventCollector` |
| [`start()`](#method-start) protected | Registers the wildcard event listener that records every fired event into [`$events`](https://github.com/yii2-extensions/debug/blob/main/src/collectors/EventCollector.php#L34). | `EventCollector` |
| [`stop()`](#method-stop) protected | Detaches the wildcard listener and clears the accumulated events, so a reused worker process starts clean. | `EventCollector` |

## Method details

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

```php
public function id(): string
```

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

**Returns**

`string`: Stable collector ID.

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

```php
protected function snapshot(): PHPForge\Debug\Panel\Event\EventSnapshot|null
```

Returns the captured events as a typed snapshot.

**Returns**

`PHPForge\Debug\Panel\Event\EventSnapshot|null`: Captured event payload; `null` when the collector never started.

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

```php
protected function start(): void
```

Registers the wildcard event listener that records every fired event into [`$events`](https://github.com/yii2-extensions/debug/blob/main/src/collectors/EventCollector.php#L34).

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

```php
protected function stop(): void
```

Detaches the wildcard listener and clears the accumulated events, so a reused worker process starts clean.