0

Final Class Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig

All Classes | Properties | Methods
InheritanceYiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig

Configuration class for generating URLs in action columns.

Public Properties

Hide inherited properties

Property Type Description Defined By
$arguments array Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig
$baseRouteName ?string Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig
$primaryKey ?string Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig
$primaryKeyParameterType ?\Yiisoft\Yii\DataView\Url\UrlParameterType Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig
$queryParameters array Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Creates a new URL configuration instance. Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig

Property Details

Hide inherited properties

$arguments public property
public array $arguments = []
$baseRouteName public property
public ?string $baseRouteName = null
$primaryKey public property
public ?string $primaryKey = null
$primaryKeyParameterType public property
public ?\Yiisoft\Yii\DataView\Url\UrlParameterType $primaryKeyParameterType = null
$queryParameters public property
public array $queryParameters = []

Method Details

Hide inherited methods

__construct() public method

Creates a new URL configuration instance.

public mixed __construct ( string|null $primaryKey = null, string|null $baseRouteName = null, array $arguments = [], array $queryParameters = [], \Yiisoft\Yii\DataView\Url\UrlParameterType|null $primaryKeyParameterType = null )
$primaryKey string|null

The primary key field name used to generate URLs.
$baseRouteName string|null

The base route name for generating URLs.
$arguments array

Additional route arguments to include in the URL.
$queryParameters array

Additional query parameters to append to the URL.
$primaryKeyParameterType \Yiisoft\Yii\DataView\Url\UrlParameterType|null

How to include the primary key in the URL.

 

                public function __construct(
    public readonly ?string $primaryKey = null,
    public readonly ?string $baseRouteName = null,
    public readonly array $arguments = [],
    public readonly array $queryParameters = [],
    public readonly ?UrlParameterType $primaryKeyParameterType = null,
) {}