Skip to content
PHP Ecosystem
Explore

EventSearch

API reference › Yii3 Debug › Search › EventSearch

final readonly classYii3\Debug\Search\EventSearch
Sourcesrc/Search/EventSearch.php

Applies the Yii2-compatible Event[attribute] filters to captured event rows.

PropertyTypeDescriptionDefined by
$activeFilters readonly constructorarray<string, string>Submitted filter values kept for this group, keyed by attribute.EventSearch
MethodDescriptionDefined by
class()Returns the submitted class filter value.EventSearch
filter()Keeps only the events matching every active filter.EventSearch
fromQueryParams() staticBuilds the search model from the submitted filter values.EventSearch
isStatic()Returns the submitted isStatic filter value.EventSearch
name()Returns the submitted name filter value.EventSearch
senderClass()Returns the submitted senderClass filter value.EventSearch
public function class(): string

Returns the submitted class filter value.

Returns

string: Submitted class filter value, or '' when the filter is not active.

public function filter(list<PHPForge\Debug\Panel\Event\EventRow> $rows): list<PHPForge\Debug\Panel\Event\EventRow>

Keeps only the events matching every active filter.

Parameters

ParameterTypeDescription
$rowslist<PHPForge\Debug\Panel\Event\EventRow>Captured events to filter.

Returns

list<PHPForge\Debug\Panel\Event\EventRow>: Rows matching every active filter, reindexed.

public static function fromQueryParams(array<array-key, mixed> $queryParams): self

Builds the search model from the submitted filter values.

Parameters

ParameterTypeDescription
$queryParamsarray<array-key, mixed>Raw query parameters of the debugger request.

Returns

self: Search model holding the active event filters.

public function isStatic(): string

Returns the submitted isStatic filter value.

Returns

string: Submitted isStatic filter value, or '' when the filter is not active.

public function name(): string

Returns the submitted name filter value.

Returns

string: Submitted name filter value, or '' when the filter is not active.

public function senderClass(): string

Returns the submitted senderClass filter value.

Returns

string: Submitted senderClass filter value, or '' when the filter is not active.