ExtensionPanelInterface
API reference › Yii3 Debug › Panel › ExtensionPanelInterface
Implemented by 1 type
Defines a stateless presenter for an optional debug panel.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
hasContent() abstract | Returns whether a captured payload contains activity worth exposing in the sidebar. | ExtensionPanelInterface |
icon() abstract | Returns the shared Debug Core icon key. | ExtensionPanelInterface |
id() abstract | Returns the stable panel identifier used in captured payloads and debug URLs. | ExtensionPanelInterface |
name() abstract | Returns the human-readable panel name. | ExtensionPanelInterface |
render() abstract | Renders the detail content for a captured payload. | ExtensionPanelInterface |
Method details
Section titled “Method details”hasContent()
Section titled “hasContent() ”abstract public function hasContent(array<string, mixed> $payload): boolReturns whether a captured payload contains activity worth exposing in the sidebar.
Parameters
| Parameter | Type | Description |
|---|---|---|
$payload | array<string, | Serialized panel payload. |
Returns
bool: true when the capture holds activity worth listing; false otherwise.
icon()
Section titled “icon() ”abstract public function icon(): stringReturns the shared Debug Core icon key.
Returns
string: Icon key for the toolbar chip.
abstract public function id(): stringReturns the stable panel identifier used in captured payloads and debug URLs.
Returns
string: Stable panel ID.
name()
Section titled “name() ”abstract public function name(): stringReturns the human-readable panel name.
Returns
string: Panel display name.
render()
Section titled “render() ”abstract public function render(Yii3\Debug\Panel\PanelRenderInput $input): stringRenders the detail content for a captured payload.
Parameters
| Parameter | Type | Description |
|---|---|---|
$input | PanelRenderInput | Payload, request context, and request summary of the page being rendered. |
Returns
string: Rendered detail content.