EventSearch
API reference › Yii3 Debug › Search › EventSearch
Applies the Yii2-compatible Event[attribute] filters to captured event rows.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$activeFilters readonly constructor | array<string, | Submitted filter values kept for this group, keyed by attribute. | EventSearch |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
class() | Returns the submitted class filter value. | EventSearch |
filter() | Keeps only the events matching every active filter. | EventSearch |
fromQueryParams() static | Builds 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 |
Method details
Section titled “Method details”class()
Section titled “class() ”public function class(): stringReturns the submitted class filter value.
Returns
string: Submitted class filter value, or '' when the filter is not active.
filter()
Section titled “filter() ”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
| Parameter | Type | Description |
|---|---|---|
$rows | list<PHPForge\ | Captured events to filter. |
Returns
list<PHPForge\Debug\Panel\Event\EventRow>: Rows matching every active filter, reindexed.
fromQueryParams()
Section titled “fromQueryParams() ”public static function fromQueryParams(array<array-key, mixed> $queryParams): selfBuilds the search model from the submitted filter values.
Parameters
| Parameter | Type | Description |
|---|---|---|
$queryParams | array<array-key, | Raw query parameters of the debugger request. |
Returns
self: Search model holding the active event filters.
isStatic()
Section titled “isStatic() ”public function isStatic(): stringReturns the submitted isStatic filter value.
Returns
string: Submitted isStatic filter value, or '' when the filter is not active.
name()
Section titled “name() ”public function name(): stringReturns the submitted name filter value.
Returns
string: Submitted name filter value, or '' when the filter is not active.
senderClass()
Section titled “senderClass() ”public function senderClass(): stringReturns the submitted senderClass filter value.
Returns
string: Submitted senderClass filter value, or '' when the filter is not active.