ProfilingPanel
API reference › Yii3 Debug › Panel › ProfilingPanel
Presents captured profiling spans and contributes the processing-time and peak-memory toolbar metrics.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
hasContent() | Reports the panel as listable for every capture. | ProfilingPanel |
icon() | Returns the shared Debug Core icon key. | ProfilingPanel |
id() | Returns the stable identifier of this panel. | ProfilingPanel |
name() | Returns the human-readable panel name. | ProfilingPanel |
render() | Renders the unified Timeline and profiling details with navigation, filters, sorting, and pagination. | ProfilingPanel |
toolbarItems() | Builds the toolbar metrics shown for this panel. | ProfilingPanel |
toolbarTitle() | Returns the toolbar title, hidden so the gauge icon stands alone. | ProfilingPanel |
Method details
Section titled “Method details”hasContent()
Section titled “hasContent() ”public function hasContent(array<string, mixed> $payload): boolReports the panel as listable for every capture.
The collector records timing for every request, so the panel stays reachable from the sidebar even when the capture holds no span.
Parameters
| Parameter | Type | Description |
|---|---|---|
$payload | array<string, | Serialized panel payload. |
Returns
bool: Always true.
icon()
Section titled “icon() ”public function icon(): stringReturns the shared Debug Core icon key.
Returns
string: Icon key for the toolbar chip.
public function id(): stringReturns the stable identifier of this panel.
Returns
string: Stable panel ID.
name()
Section titled “name() ”public function name(): stringReturns the human-readable panel name.
Returns
string: Panel display name.
render()
Section titled “render() ”public function render(Yii3\Debug\Panel\PanelRenderInput $input): stringRenders the unified Timeline and profiling details with navigation, filters, sorting, and pagination.
Parameters
| Parameter | Type | Description |
|---|---|---|
$input | PanelRenderInput | Payload, request context, and request summary of the page being rendered. |
Returns
string: Rendered detail content.
toolbarItems()
Section titled “toolbarItems() ”public function toolbarItems(array<string, mixed> $payload): list<PHPForge\Debug\Toolbar\ToolbarItem>Builds the toolbar metrics shown for this panel.
Parameters
| Parameter | Type | Description |
|---|---|---|
$payload | array<string, | Serialized panel payload. |
Returns
list<PHPForge\Debug\Toolbar\ToolbarItem>: Processing time and peak memory of the capture.
toolbarTitle()
Section titled “toolbarTitle() ”public function toolbarTitle(): stringReturns the toolbar title, hidden so the gauge icon stands alone.
Returns
string: Empty string, keeping the gauge icon while hiding the text label.