Skip to content
PHP Ecosystem
Explore

ToolbarPanelProviderInterface

API reference › Yii3 Debug › Panel › ToolbarPanelProviderInterface

interfaceYii3\Debug\Panel\ToolbarPanelProviderInterface
ExtendsExtensionPanelInterface
Sourcesrc/Panel/ToolbarPanelProviderInterface.php
Implemented by 8 types

Defines an extension panel that can contribute captured metrics to the debug toolbar.

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
toolbarItems() abstractReturns the toolbar metrics for a captured payload.ToolbarPanelProviderInterface
abstract public function toolbarItems(array<string, mixed> $payload): list<PHPForge\Debug\Toolbar\ToolbarItem>

Returns the toolbar metrics for a captured payload.

Parameters

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

Returns

list<PHPForge\Debug\Toolbar\ToolbarItem>: Toolbar metrics, or an empty list when the panel should stay hidden.