Interface Yiisoft\Yii\DataView\GridView\Column\FilterableColumnRendererInterface

All Classes | Methods

Extends	Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface
Implemented by	Yiisoft\Yii\DataView\GridView\Column\DataColumnRenderer

Interface for column renderers that support filtering functionality.

Public Methods

Method	Description	Defined By
makeFilter()	Creates a filter condition based on user input.	Yiisoft\Yii\DataView\GridView\Column\FilterableColumnRendererInterface
renderBody()	Configures a data row cell.	Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface
renderColumn()	Configures the column container cell.	Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface
renderFilter()	Renders the filter cell for a column.	Yiisoft\Yii\DataView\GridView\Column\FilterableColumnRendererInterface
renderFooter()	Configures the column footer cell.	Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface
renderHeader()	Configures the column header cell.	Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface

makeFilter() public abstract method

Creates a filter condition based on user input.

public abstract \Yiisoft\Data\Reader\FilterInterface\|null makeFilter ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\MakeFilterContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column to create the filter for.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\MakeFilterContext	Context containing filter parameters and validation state.
return	\Yiisoft\Data\Reader\FilterInterface\|null	The created filter condition, or null if no filter should be applied.
throws	Yiisoft\Yii\DataView\Filter\Factory\IncorrectValueException	When the filter value is invalid or cannot be processed.

                public function makeFilter(ColumnInterface $column, MakeFilterContext $context): ?FilterInterface;

renderBody() public abstract method

Defined in: Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface::renderBody()

Configures a data row cell.

This method is called for each row in the grid to render the column's data cell.

public abstract Yiisoft\Yii\DataView\GridView\Column\Base\Cell renderBody ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\DataContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column definition to render.
$cell	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The body cell to configure.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\DataContext	Row-specific data and rendering context.
return	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The configured data cell.

                public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell;

renderColumn() public abstract method

Defined in: Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface::renderColumn()

Configures the column container cell.

This method is called once per column to set up the container that will hold all the column's cells.

public abstract Yiisoft\Yii\DataView\GridView\Column\Base\Cell renderColumn ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column definition to render.
$cell	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The cell container to configure.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext	Global grid rendering context.
return	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The configured column container cell.

                public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell;

renderFilter() public abstract method

Renders the filter cell for a column.

public abstract Yiisoft\Yii\DataView\GridView\Column\Base\Cell\|null renderFilter ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\FilterContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column to render the filter for.
$cell	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The cell container to render into.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\FilterContext	Context containing filter state and validation results.
return	Yiisoft\Yii\DataView\GridView\Column\Base\Cell\|null	The rendered filter cell, or `null` if filtering is not applicable.

                public function renderFilter(ColumnInterface $column, Cell $cell, FilterContext $context): ?Cell;

renderFooter() public abstract method

Defined in: Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface::renderFooter()

Configures the column footer cell.

public abstract Yiisoft\Yii\DataView\GridView\Column\Base\Cell renderFooter ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column definition to render.
$cell	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The footer cell to configure.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext	Global grid rendering context.
return	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The configured footer cell.

                public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell;

renderHeader() public abstract method

Defined in: Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface::renderHeader()

Configures the column header cell.

public abstract Yiisoft\Yii\DataView\GridView\Column\Base\Cell\|null renderHeader ( Yiisoft\Yii\DataView\GridView\Column\ColumnInterface $column, Yiisoft\Yii\DataView\GridView\Column\Base\Cell $cell, Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext $context )
$column	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface	The column definition to render.
$cell	Yiisoft\Yii\DataView\GridView\Column\Base\Cell	The header cell to configure.
$context	Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext	Global grid rendering context.
return	Yiisoft\Yii\DataView\GridView\Column\Base\Cell\|null	The configured header cell, or `null` if no header should be shown.

                public function renderHeader(ColumnInterface $column, Cell $cell, GlobalContext $context): ?Cell;