Skip to content
PHP Ecosystem
Explore

GridColumnRenderer

API reference › Yii3 Debug › Web › GridColumnRenderer

final classYii3\Debug\Web\GridColumnRenderer
ImplementsYiisoft\Yii\DataView\GridView\Column\FilterableColumnRendererInterface
Sourcesrc/Web/GridColumnRenderer.php

Renders GridColumn cells, applying the column classes and the pre-built content to the header, filter, and body cells, and encoding the body content only when the column requests it.

GridView resolves this renderer from GridColumn::getRenderer(), so callers never instantiate it.

MethodDescriptionDefined by
makeFilter()Declines to build a reader filter: the panels filter their rows before the grid renders.GridColumnRenderer
renderBody()Applies the column classes and the pre-built content to a body cell, encoding it only on request.GridColumnRenderer
renderColumn()Applies the column classes to the column-level cell.GridColumnRenderer
renderFilter()Renders the filter cell, omitting it when the column declares no filter content.GridColumnRenderer
renderFooter()Returns the footer cell unchanged; the grids in this package render no footer content per column.GridColumnRenderer
renderHeader()Applies the column classes and the pre-built header content to the header cell.GridColumnRenderer
public function makeFilter(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\MakeFilterContext $context): Yiisoft\Data\Reader\FilterInterface|null

Declines to build a reader filter: the panels filter their rows before the grid renders.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$contextYiisoft\Yii\DataView\GridView\Column\Base\MakeFilterContextFilter state supplied by GridView.

Returns

Yiisoft\Data\Reader\FilterInterface|null: Always null.

public function renderBody(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\DataContext $context): Yiisoft\Yii\DataView\GridView\Column\Base\Cell

Applies the column classes and the pre-built content to a body cell, encoding it only on request.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$cellYiisoft\Yii\DataView\GridView\Column\Base\CellCell to decorate.
$contextYiisoft\Yii\DataView\GridView\Column\Base\DataContextRow state supplied by GridView.

Returns

Yiisoft\Yii\DataView\GridView\Column\Base\Cell: Decorated body cell.

public function renderColumn(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context): Yiisoft\Yii\DataView\GridView\Column\Base\Cell

Applies the column classes to the column-level cell.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$cellYiisoft\Yii\DataView\GridView\Column\Base\CellCell to decorate.
$contextYiisoft\Yii\DataView\GridView\Column\Base\GlobalContextGrid state supplied by GridView.

Returns

Yiisoft\Yii\DataView\GridView\Column\Base\Cell: Decorated column cell.

public function renderFilter(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\FilterContext $context): Yiisoft\Yii\DataView\GridView\Column\Base\Cell|null

Renders the filter cell, omitting it when the column declares no filter content.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$cellYiisoft\Yii\DataView\GridView\Column\Base\CellCell to decorate.
$contextYiisoft\Yii\DataView\GridView\Column\Base\FilterContextFilter state supplied by GridView.

Returns

Yiisoft\Yii\DataView\GridView\Column\Base\Cell|null: Decorated filter cell, or null when the column has no filter.

public function renderFooter(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context): Yiisoft\Yii\DataView\GridView\Column\Base\Cell

Returns the footer cell unchanged; the grids in this package render no footer content per column.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$cellYiisoft\Yii\DataView\GridView\Column\Base\CellCell to decorate.
$contextYiisoft\Yii\DataView\GridView\Column\Base\GlobalContextGrid state supplied by GridView.

Returns

Yiisoft\Yii\DataView\GridView\Column\Base\Cell: Decorated footer cell.

public function renderHeader(Yii3\Debug\Web\GridColumn<array<array-key, mixed>|object> $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context): Yiisoft\Yii\DataView\GridView\Column\Base\Cell

Applies the column classes and the pre-built header content to the header cell.

Parameters

ParameterTypeDescription
$columnGridColumn<array<array-key, mixed>|object>Column being rendered.
$cellYiisoft\Yii\DataView\GridView\Column\Base\CellCell to decorate.
$contextYiisoft\Yii\DataView\GridView\Column\Base\GlobalContextGrid state supplied by GridView.

Returns

Yiisoft\Yii\DataView\GridView\Column\Base\Cell: Decorated header cell.