0 follower

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

All Classes | Properties | Methods

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

ActionColumn is a column for the {@see GridView} widget that displays buttons for viewing and manipulating the items.

Psalm Types

Name	Value
UrlCreator	callable
ButtonRenderer	Yiisoft\Yii\DataView\GridView\Column\ActionButton\|callable
TContent	scalar\|\Stringable\|null\|callable

Public Properties

Hide inherited properties

Property	Type	Defined By
$after	string\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$before	string\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$bodyAttributes	array	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$buttons	array\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$columnAttributes	array	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$content	mixed	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$footer	string\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$footerAttributes	array	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$header	string\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$headerAttributes	array	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$template	string\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$urlConfig	mixed	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
$visibleButtons	array\|null	Yiisoft\Yii\DataView\GridView\Column\ActionColumn

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Yii\DataView\GridView\Column\ActionColumn
getRenderer()		Yiisoft\Yii\DataView\GridView\Column\ActionColumn
getUrlCreator()	Get the URL creator callback.	Yiisoft\Yii\DataView\GridView\Column\ActionColumn
isVisible()		Yiisoft\Yii\DataView\GridView\Column\ActionColumn

Property Details

Hide inherited properties

$after public property

public string|null $after = null

$before public property

public string|null $before = null

$bodyAttributes public property

public array $bodyAttributes = []

$buttons public property

public array|null $buttons = null

$columnAttributes public property

public array $columnAttributes = []

$content public property

public mixed $content = null

$footerAttributes public property

public array $footerAttributes = []

$header public property

public string|null $header = null

$headerAttributes public property

public array $headerAttributes = []

$template public property

public string|null $template = null

$urlConfig public property

public mixed $urlConfig = null

$visibleButtons public property

public array|null $visibleButtons = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string\|null $template = null, string\|null $before = null, string\|null $after = null, mixed $urlConfig = null, callable\|null $urlCreator = null, string\|null $header = null, string\|null $footer = null, mixed $content = null, array\|null $buttons = null, array\|null $visibleButtons = null, array $columnAttributes = [], array $headerAttributes = [], array $bodyAttributes = [], array $footerAttributes = [], boolean $visible = true )
$template	string\|null	The template used for composing each cell in the action column.
$before	string\|null	Content to be prepended to the action column content.
$after	string\|null	Content to be appended to the action column content.
$urlConfig	mixed	URL configuration for generating button URLs.
$urlCreator	callable\|null	A callback that creates a button URL using the specified data information.
$header	string\|null	The header cell content.
$footer	string\|null	The footer cell content.
$content	mixed	The content to be rendered in each data cell.
$buttons	array\|null	Array of buttons. Keys are button names. Values are either instances of {@see \Yiisoft\Yii\DataView\GridView\Column\ActionButton} or a callable with the following signature: `function(string $url): string`.
$visibleButtons	array\|null	Array of button visibility rules.
$columnAttributes	array	HTML attributes for the column cells.
$headerAttributes	array	HTML attributes for the header cell.
$bodyAttributes	array	HTML attributes for the body cells.
$footerAttributes	array	HTML attributes for the footer cell.
$visible	boolean	Whether the column is visible.

Source code

                public function __construct(
    public readonly ?string $template = null,
    public readonly ?string $before = null,
    public readonly ?string $after = null,
    public readonly mixed $urlConfig = null,
    ?callable $urlCreator = null,
    public readonly ?string $header = null,
    public readonly ?string $footer = null,
    public readonly mixed $content = null,
    public readonly ?array $buttons = null,
    public readonly ?array $visibleButtons = null,
    public readonly array $columnAttributes = [],
    public readonly array $headerAttributes = [],
    public readonly array $bodyAttributes = [],
    public readonly array $footerAttributes = [],
    private readonly bool $visible = true,
) {
    $this->urlCreator = $urlCreator;
}

getRenderer() public method

public string getRenderer ( )

Source code

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

getUrlCreator() public method

Get the URL creator callback.

public callable\|null getUrlCreator ( )
return	callable\|null	The URL creator callback.

Source code

                public function getUrlCreator(): ?callable
{
    return $this->urlCreator;
}

isVisible() public method

public boolean isVisible ( )

Source code

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