Skip to content
PHP Ecosystem
Explore

ExtensionPanelInterface

API reference › Yii3 Debug › Panel › ExtensionPanelInterface

interfaceYii3\Debug\Panel\ExtensionPanelInterface
Sourcesrc/Panel/ExtensionPanelInterface.php
Implemented by 1 type

Defines a stateless presenter for an optional debug panel.

MethodDescriptionDefined by
hasContent() abstractReturns whether a captured payload contains activity worth exposing in the sidebar.ExtensionPanelInterface
icon() abstractReturns the shared Debug Core icon key.ExtensionPanelInterface
id() abstractReturns the stable panel identifier used in captured payloads and debug URLs.ExtensionPanelInterface
name() abstractReturns the human-readable panel name.ExtensionPanelInterface
render() abstractRenders the detail content for a captured payload.ExtensionPanelInterface
abstract public function hasContent(array<string, mixed> $payload): bool

Returns whether a captured payload contains activity worth exposing in the sidebar.

Parameters

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

Returns

bool: true when the capture holds activity worth listing; false otherwise.

abstract public function icon(): string

Returns the shared Debug Core icon key.

Returns

string: Icon key for the toolbar chip.

abstract public function id(): string

Returns the stable panel identifier used in captured payloads and debug URLs.

Returns

string: Stable panel ID.

abstract public function name(): string

Returns the human-readable panel name.

Returns

string: Panel display name.

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

Renders the detail content for a captured payload.

Parameters

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

Returns

string: Rendered detail content.