Skip to content
PHP Ecosystem
Explore

ProfilingPanel

API reference › Yii3 Debug › Panel › ProfilingPanel

final readonly classYii3\Debug\Panel\ProfilingPanel
ImplementsToolbarPanelProviderInterface, ToolbarTitleProviderInterface
Sourcesrc/Panel/ProfilingPanel.php

Presents captured profiling spans and contributes the processing-time and peak-memory toolbar metrics.

MethodDescriptionDefined 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
public function hasContent(array<string, mixed> $payload): bool

Reports 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

ParameterTypeDescription
$payloadarray<string, mixed>Serialized panel payload.

Returns

bool: Always true.

public function icon(): string

Returns the shared Debug Core icon key.

Returns

string: Icon key for the toolbar chip.

public function id(): string

Returns the stable identifier of this panel.

Returns

string: Stable panel ID.

public function name(): string

Returns the human-readable panel name.

Returns

string: Panel display name.

public function render(Yii3\Debug\Panel\PanelRenderInput $input): string

Renders the unified Timeline and profiling details with navigation, filters, sorting, and pagination.

Parameters

ParameterTypeDescription
$inputPanelRenderInputPayload, request context, and request summary of the page being rendered.

Returns

string: Rendered detail content.

public function toolbarItems(array<string, mixed> $payload): list<PHPForge\Debug\Toolbar\ToolbarItem>

Builds the toolbar metrics shown for this panel.

Parameters

ParameterTypeDescription
$payloadarray<string, mixed>Serialized panel payload.

Returns

list<PHPForge\Debug\Toolbar\ToolbarItem>: Processing time and peak memory of the capture.

public function toolbarTitle(): string

Returns the toolbar title, hidden so the gauge icon stands alone.

Returns

string: Empty string, keeping the gauge icon while hiding the text label.