ProfileSearch
API reference › Yii3 Debug › Search › ProfileSearch
Filters captured profile rows for the unified Profiling timeline and table.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$activeFilters readonly constructor | array<string, | Submitted filter values kept for this group, keyed by attribute. | ProfileSearch |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
category() | Returns the submitted category filter value. | ProfileSearch |
duration() | Returns the submitted duration filter value. | ProfileSearch |
filter() | Keeps only the spans matching every active filter. | ProfileSearch |
fromQueryParams() static | Builds the search model from the submitted filter values. | ProfileSearch |
info() | Returns the submitted info filter value. | ProfileSearch |
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.
duration()
Section titled “duration() ”public function duration(): stringReturns the submitted duration filter value.
Returns
string: Submitted duration filter value, or '' when the filter is not active.
filter()
Section titled “filter() ”public function filter(list<PHPForge\Debug\Panel\Profile\ProfileRow> $rows): list<PHPForge\Debug\Panel\Profile\ProfileRow>Keeps only the spans matching every active filter.
Parameters
| Parameter | Type | Description |
|---|---|---|
$rows | list<PHPForge\ | Captured spans to filter. |
Returns
list<PHPForge\Debug\Panel\Profile\ProfileRow>: 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 span filters.
info()
Section titled “info() ”public function info(): stringReturns the submitted info filter value.
Returns
string: Submitted info filter value, or '' when the filter is not active.