0 follower

Final Class Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn

All Classes | Properties | Methods

Inheritance	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
Implements	Yiisoft\Yii\DataView\GridView\Column\ColumnInterface

CheckboxColumn displays a column of checkboxes in a grid view.

Psalm Types

Name	Value
TContentClosure	callable

Public Properties

Hide inherited properties

Property	Type	Defined By
$bodyAttributes	array	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$columnAttributes	array	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$content	Closure\|null	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$footer	string\|null	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$header	string\|null	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$headerAttributes	array	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$inputAttributes	array	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
$multiple	boolean	Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
getRenderer()		Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn
isVisible()		Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn

Property Details

Hide inherited properties

$bodyAttributes public property

public array $bodyAttributes = []

$columnAttributes public property

public array $columnAttributes = []

$content public property

public Closure|null $content = null

$header public property

public string|null $header = null

$headerAttributes public property

public array $headerAttributes = []

$inputAttributes public property

public array $inputAttributes = []

$multiple public property

public boolean $multiple = true

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string\|null $header = null, string\|null $footer = null, array $columnAttributes = [], array $headerAttributes = [], array $bodyAttributes = [], array $inputAttributes = [], string\|null $name = null, boolean $multiple = true, Closure\|null $content = null, boolean $visible = true )
$header	string\|null	The header cell content.
$footer	string\|null	The footer cell content.
$columnAttributes	array	HTML attributes for the column cells.
$headerAttributes	array	HTML attributes for the header cell.
$bodyAttributes	array	HTML attributes for the body cells.
$inputAttributes	array	HTML attributes for the checkbox input elements.
$name	string\|null	The name attribute of the checkboxes. If specified, it will be assigned to the "name" attribute of the checkbox input.
$multiple	boolean	Whether to allow multiple selection. If true, checkbox names will be an array like `name[]`; if false, checkbox names will be single strings.
$content	Closure\|null	Closure for generating custom checkbox content. If set, it should have the signature: `function(Checkbox $input, DataContext $context): string\|Stringable`.
$visible	boolean	Whether the column is visible.

Source code

                public function __construct(
    public readonly ?string $header = null,
    public readonly ?string $footer = null,
    public readonly array $columnAttributes = [],
    public readonly array $headerAttributes = [],
    public readonly array $bodyAttributes = [],
    public array $inputAttributes = [],
    ?string $name = null,
    public readonly bool $multiple = true,
    public ?Closure $content = null,
    private readonly bool $visible = true,
) {
    if ($name !== null) {
        $this->inputAttributes['name'] = $name;
    }
}

getRenderer() public method

public string getRenderer ( )

Source code

                public function getRenderer(): string
{
    return CheckboxColumnRenderer::class;
}

isVisible() public method

public boolean isVisible ( )

Source code

                public function isVisible(): bool
{
    return $this->visible;
}