Skip to content
PHP Ecosystem
Explore

PanelGrid

API reference › Yii3 Debug › Web › PanelGrid

final classYii3\Debug\Web\PanelGrid
Sourcesrc/Web/PanelGrid.php

Builds the DataView grid with the layout, table, and empty-cell conventions shared by every debug panel.

The grid creates no application URLs: the debugger serves its pages from its own middleware, outside the router, so an application widget theme binding GridView to a router-aware URL creator must not reach the debug panels. A panel that needs real page links applies its own urlCreator() afterwards.

MethodDescriptionDefined by
create() staticReturns the grid rendering only its items, keeping the column classes on body cells that resolve to no content and letting DataView add the accessibility attributes of the table.PanelGrid
filterable() staticReturns the grid of create() with the filter row wired to the hidden form that submits the controls.PanelGrid
public static function create(Yiisoft\Data\Reader\ReadableDataInterface<array-key, Yii3\Debug\Web\TRow> $dataReader): Yiisoft\Yii\DataView\GridView\GridView<Yii3\Debug\Web\TRow>

Returns the grid rendering only its items, keeping the column classes on body cells that resolve to no content and letting DataView add the accessibility attributes of the table.

Parameters

ParameterTypeDescription
$dataReaderYiisoft\Data\Reader\ReadableDataInterface<array-key, Yii3\Debug\Web\TRow>Rows the grid renders.

Returns

Yiisoft\Yii\DataView\GridView\GridView<Yii3\Debug\Web\TRow>: Grid carrying the shared panel configuration.

public static function filterable(Yiisoft\Data\Reader\ReadableDataInterface<array-key, Yii3\Debug\Web\TRow> $dataReader, string $formId): Yiisoft\Yii\DataView\GridView\GridView<Yii3\Debug\Web\TRow>

Returns the grid of create() with the filter row wired to the hidden form that submits the controls.

Parameters

ParameterTypeDescription
$dataReaderYiisoft\Data\Reader\ReadableDataInterface<array-key, Yii3\Debug\Web\TRow>Rows the grid renders.
$formIdstringIdentifier of the hidden form the filter controls submit.

Returns

Yiisoft\Yii\DataView\GridView\GridView<Yii3\Debug\Web\TRow>: Grid carrying the shared panel and filter row configuration.