LogSearch
API reference › Yii3 Debug › Search › LogSearch
Applies the Yii2-compatible Log[attribute] filters to captured log and dump 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. | LogSearch |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
category() | Returns the submitted category filter value. | LogSearch |
filter() | Keeps only the rows matching every active filter. | LogSearch |
fromQueryParams() static | Builds the search model from the submitted filter values. | LogSearch |
level() | Returns the submitted level filter value. | LogSearch |
message() | Returns the submitted message filter value. | LogSearch |
Method details
Section titled “Method details”category()
Section titled “category() ”public function category(): stringReturns the submitted category filter value.
Returns
string: Submitted category filter value, or '' when the filter is not active.
filter()
Section titled “filter() ”public function filter(list<Yii3\Debug\Search\TRow> $rows): list<Yii3\Debug\Search\TRow>Keeps only the rows matching every active filter.
Dump rows carry the level, category, and message fields of log rows, so the Dump grid filters through the
same Log[...] group, as it does in Yii2.
Parameters
| Parameter | Type | Description |
|---|---|---|
$rows | list<Yii3\ | Captured rows to filter. |
Returns
list<Yii3\Debug\Search\TRow>: 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 message filters.
level()
Section titled “level() ”public function level(): stringReturns the submitted level filter value.
Returns
string: Submitted level filter value, or '' when the filter is not active.
message()
Section titled “message() ”public function message(): stringReturns the submitted message filter value.
Returns
string: Submitted message filter value, or '' when the filter is not active.