# CaptureToolbarProviderInterface

> Defines a toolbar panel whose metrics depend on which capture the toolbar describes, not only on its payload.

[API reference](/docs/api/index.md) › [Yii3 Debug](/docs/extensions/yii3-debug/reference/index.md) › [Panel](/docs/extensions/yii3-debug/reference/panel/index.md) › CaptureToolbarProviderInterface

| interface | `Yii3\Debug\Panel\CaptureToolbarProviderInterface` |
| --- | --- |
| Extends | [`ToolbarPanelProviderInterface`](/docs/extensions/yii3-debug/reference/panel/toolbarpanelproviderinterface/index.md) |
| Source | [`src/Panel/CaptureToolbarProviderInterface.php`](https://github.com/yii3/debug/blob/main/src/Panel/CaptureToolbarProviderInterface.php#L16) |

Implemented by 1 type:

- [`MailPanel`](/docs/extensions/yii3-debug/reference/panel/mailpanel/index.md)

Defines a toolbar panel whose metrics depend on which capture the toolbar describes, not only on its payload.

[`ToolbarDataFactory`](/docs/extensions/yii3-debug/reference/toolbardatafactory/index.md) calls [`toolbarItemsForCapture()`](/docs/extensions/yii3-debug/reference/panel/capturetoolbarproviderinterface/index.md#method-toolbarItemsForCapture) instead of
[`ToolbarPanelProviderInterface::toolbarItems()`](/docs/extensions/yii3-debug/reference/panel/toolbarpanelproviderinterface/index.md#method-toolbarItems), so a panel can look the capture up in the history, for
example to point at the request that preceded a redirect.

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-hasContent"></span>[`hasContent()`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md#method-hasContent) abstract | Returns whether a captured payload contains activity worth exposing in the sidebar. | [`ExtensionPanelInterface`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md) |
| <span id="method-icon"></span>[`icon()`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md#method-icon) abstract | Returns the shared Debug Core icon key. | [`ExtensionPanelInterface`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md) |
| <span id="method-id"></span>[`id()`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md#method-id) abstract | Returns the stable panel identifier used in captured payloads and debug URLs. | [`ExtensionPanelInterface`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md) |
| <span id="method-name"></span>[`name()`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md#method-name) abstract | Returns the human-readable panel name. | [`ExtensionPanelInterface`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md) |
| <span id="method-render"></span>[`render()`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md#method-render) abstract | Renders the detail content for a captured payload. | [`ExtensionPanelInterface`](/docs/extensions/yii3-debug/reference/panel/extensionpanelinterface/index.md) |
| <span id="method-toolbarItems"></span>[`toolbarItems()`](/docs/extensions/yii3-debug/reference/panel/toolbarpanelproviderinterface/index.md#method-toolbarItems) abstract | Returns the toolbar metrics for a captured payload. | [`ToolbarPanelProviderInterface`](/docs/extensions/yii3-debug/reference/panel/toolbarpanelproviderinterface/index.md) |
| [`toolbarItemsForCapture()`](#method-toolbarItemsForCapture) abstract | Returns the toolbar metrics for a captured payload of a known capture. | `CaptureToolbarProviderInterface` |

## Method details

### toolbarItemsForCapture() <span id="method-toolbarItemsForCapture"></span>

```php
abstract public function toolbarItemsForCapture(string $tag, array<string, mixed> $payload): list<PHPForge\Debug\Toolbar\ToolbarItem>
```

Returns the toolbar metrics for a captured payload of a known capture.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$tag` | `string` | Tag of the capture the toolbar describes. |
| `$payload` | `array<string, mixed>` | Serialized panel payload of that capture. |

**Returns**

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