0 关注者

类 yii\grid\RadioButtonColumn

所有类 | 属性 | 方法
继承关系yii\grid\RadioButtonColumn » yii\grid\Column » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0.11
源代码 https://github.com/yiisoft/yii2/blob/master/framework/grid/RadioButtonColumn.php

RadioButtonColumn 在网格视图中显示一列单选按钮。

要将 RadioButtonColumn 添加到 yii\grid\GridView，请按如下所示将其添加到 columns 配置中

'columns' => [
    // ...
    [
        'class' => 'yii\grid\RadioButtonColumn',
        'radioOptions' => function ($model) {
             return [
                 'value' => $model['value'],
                 'checked' => $model['value'] == 2
             ];
         }
    ],
]

公共属性

隐藏继承属性

属性 类型 描述 定义于
$content callable 这是一个可调用对象，将用于生成每个单元格的内容。 yii\grid\Column
$contentOptions 数组|闭包 数据单元格标签的 HTML 属性。 yii\grid\Column
$filterOptions 数组 筛选单元格标签的 HTML 属性。 yii\grid\Column
$footer 字符串 页脚单元格内容。 yii\grid\Column
$footerOptions 数组 页脚单元格标签的 HTML 属性。 yii\grid\Column
$grid yii\grid\GridView 拥有此列的网格视图对象。 yii\grid\Column
$header 字符串|null 表头单元格内容。 yii\grid\Column
$headerOptions 数组 表头单元格标签的 HTML 属性。 yii\grid\Column
$name 字符串 输入单选按钮输入字段的名称。 yii\grid\RadioButtonColumn
$options 数组 列组标签的 HTML 属性。 yii\grid\Column
$radioOptions 数组|闭包 单选按钮的 HTML 属性。 yii\grid\RadioButtonColumn
$visible 布尔值 此列是否可见。 yii\grid\Column

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即定义且不为 null。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
canGetProperty() 返回一个值，指示属性是否可读。 yii\base\BaseObject
canSetProperty() 返回一个值，指示属性是否可写。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\grid\RadioButtonColumn
renderDataCell() 渲染数据单元格。 yii\grid\Column
renderFilterCell() 渲染筛选单元格。 yii\grid\Column
renderFooterCell() 渲染页脚单元格。 yii\grid\Column
renderHeaderCell() 渲染表头单元格。 yii\grid\Column

受保护方法

隐藏继承方法

方法 描述 定义于
getHeaderCellLabel() 返回表头单元格标签。 yii\grid\Column
renderDataCellContent() 渲染数据单元格内容。 yii\grid\RadioButtonColumn
renderFilterCellContent() 渲染筛选单元格内容。 yii\grid\Column
renderFooterCellContent() 渲染页脚单元格内容。 yii\grid\Column
renderHeaderCellContent() 渲染表头单元格内容。 yii\grid\Column

属性详情

隐藏继承属性

$name 公共属性

输入单选按钮输入字段的名称。

public 字符串 $name = 'radioButtonSelection'
$radioOptions 公共属性

单选按钮的 HTML 属性。这可以是属性数组或返回此类数组的匿名函数 (闭包)。

函数的签名应如下所示：function ($model, $key, $index, $column)，其中 $model、$key 和 $index 分别指当前正在渲染的行对应的模型、键和索引，$column 是对 yii\grid\RadioButtonColumn 对象的引用。

可以使用函数根据该行中的数据为不同的行分配不同的属性。具体来说，如果要为单选按钮设置不同的值，则可以按以下方式使用此选项（在此示例中使用模型的 name 属性）

'radioOptions' => function ($model, $key, $index, $column) {
    return ['value' => $model->attribute];
}

另请参阅 yii\helpers\Html::renderTagAttributes()，了解有关如何渲染属性的详细信息。

public 数组|闭包 $radioOptions = []

方法详情

隐藏继承方法

__call() 公共方法

定义于： yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public 混合 __call ( $name, $params )
$name 字符串

方法名
$params 数组

方法参数
返回值 混合

方法返回值
抛出异常 yii\base\UnknownMethodException

调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置$config初始化对象。
  • 调用 init()。

如果此方法在子类中被重写，建议

  • 构造函数的最后一个参数为配置数组，就像这里的$config一样。
  • 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] )
$config 数组

用于初始化对象属性的键值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

定义于： yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个PHP魔术方法，在执行$value = $object->property;时会被隐式调用。

另请参阅 __set()。

public mixed __get ( $name )
$name 字符串

属性名称
返回值 混合

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性为只写

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\BaseObject::__isset()

检查属性是否已设置，即定义且不为 null。

不要直接调用此方法，因为它是一个PHP魔术方法，在执行isset($object->property)时会被隐式调用。

请注意，如果属性未定义，则将返回false。

另请参阅 https://php.ac.cn/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称
返回值 布尔值

指定的属性是否已设置（非null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定义于： yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个PHP魔术方法，在执行$object->property = $value;时会被隐式调用。

另请参阅 __get()。

public void __set ( $name, $value )
$name 字符串

属性名称或事件名称
$value 混合

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性为只读

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

定义于： yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个PHP魔术方法，在执行unset($object->property)时会被隐式调用。

请注意，如果属性未定义，则此方法将不做任何操作。如果属性为只读，则会抛出异常。

另请参阅 https://php.ac.cn/manual/en/function.unset.php。

public void __unset ( $name )
$name 字符串

属性名称
抛出异常 yii\base\InvalidCallException

如果属性为只读。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() 公共方法

定义于： yii\base\BaseObject::canGetProperty()

返回一个值，指示属性是否可读。

如果属性可读，则

  • 该类具有与指定名称关联的getter方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相同的成员变量（当$checkVars为true时）；

另请参阅 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

定义于： yii\base\BaseObject::canSetProperty()

返回一个值，指示属性是否可写。

如果属性可写，则

  • 该类具有与指定名称关联的setter方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相同的成员变量（当$checkVars为true时）；

另请参阅 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 中，请改用 ::class。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 字符串

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
getHeaderCellLabel() 受保护方法 (自 2.0.8 版本起可用)

定义于： yii\grid\Column::getHeaderCellLabel()

返回表头单元格标签。

可以重写此方法来自定义表头单元格的标签。

protected string getHeaderCellLabel ( )
返回值 字符串

标签

 

                protected function getHeaderCellLabel()
{
    return $this->grid->emptyCell;
}
hasMethod() 公共方法

定义于： yii\base\BaseObject::hasMethod()

返回一个值，指示方法是否已定义。

默认实现是对php函数method_exists()的调用。当您实现php魔术方法__call()时，可以重写此方法。

public boolean hasMethod ( $name )
$name 字符串

方法名
返回值 布尔值

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于： yii\base\BaseObject::hasProperty()

返回一个值，指示属性是否已定义。

如果属性已定义，则

  • 该类具有与指定名称关联的getter或setter方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称相同的成员变量（当$checkVars为true时）；

另请参阅

public boolean hasProperty ( $name, $checkVars = true )
$name 字符串

属性名称
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

初始化对象。

此方法在对象使用给定配置初始化后，在构造函数的末尾调用。

public void init ( )
抛出异常 yii\base\InvalidConfigException

如果 $name 未设置。

 

                public function init()
{
    parent::init();
    if (empty($this->name)) {
        throw new InvalidConfigException('The "name" property must be set.');
    }
}
renderDataCell() 公共方法

定义于： yii\grid\Column::renderDataCell()

渲染数据单元格。

public string renderDataCell ( $model, $key, $index )
$model 混合

正在渲染的数据模型
$key 混合

与数据模型关联的键
$index 整数

数据项在 yii\grid\GridView::$dataProvider 返回的项数组中的从零开始的索引。
返回值 字符串

渲染结果

 

                public function renderDataCell($model, $key, $index)
{
    if ($this->contentOptions instanceof Closure) {
        $options = call_user_func($this->contentOptions, $model, $key, $index, $this);
    } else {
        $options = $this->contentOptions;
    }
    return Html::tag('td', $this->renderDataCellContent($model, $key, $index), $options);
}
renderDataCellContent() 受保护方法

渲染数据单元格内容。

protected string renderDataCellContent ( $model, $key, $index )
$model 混合

数据模型
$key 混合

与数据模型关联的键
$index 整数

数据模型在 yii\grid\GridView::$dataProvider 返回的模型数组中的从零开始的索引。
返回值 字符串

渲染结果

 

                protected function renderDataCellContent($model, $key, $index)
{
    if ($this->content !== null) {
        return parent::renderDataCellContent($model, $key, $index);
    }
    if ($this->radioOptions instanceof Closure) {
        $options = call_user_func($this->radioOptions, $model, $key, $index, $this);
    } else {
        $options = $this->radioOptions;
        if (!isset($options['value'])) {
            $options['value'] = is_array($key) ? json_encode($key, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) : $key;
        }
    }
    $checked = isset($options['checked']) ? $options['checked'] : false;
    return Html::radio($this->name, $checked, $options);
}
renderFilterCell() 公共方法

定义于： yii\grid\Column::renderFilterCell()

渲染筛选单元格。

public void renderFilterCell ( )

                public function renderFilterCell()
{
    return Html::tag('td', $this->renderFilterCellContent(), $this->filterOptions);
}
renderFilterCellContent() 受保护方法

定义于： yii\grid\Column::renderFilterCellContent()

渲染筛选单元格内容。

默认实现只是渲染一个空格。可以重写此方法来自定义过滤器单元格（如果有）的渲染。

protected string renderFilterCellContent ( )
返回值 字符串

渲染结果

 

                protected function renderFilterCellContent()
{
    return $this->grid->emptyCell;
}
renderFooterCell() 公共方法

定义于： yii\grid\Column::renderFooterCell()

渲染页脚单元格。

public void renderFooterCell ( )

                public function renderFooterCell()
{
    return Html::tag('td', $this->renderFooterCellContent(), $this->footerOptions);
}
renderFooterCellContent() 受保护方法

定义于： yii\grid\Column::renderFooterCellContent()

渲染页脚单元格内容。

默认实现只是渲染 $footer。可以重写此方法来自定义页脚单元格的渲染。

protected string renderFooterCellContent ( )
返回值 字符串

渲染结果

 

                protected function renderFooterCellContent()
{
    return $this->footer !== null && trim($this->footer) !== '' ? $this->footer : $this->grid->emptyCell;
}
renderHeaderCell() 公共方法

定义于： yii\grid\Column::renderHeaderCell()

渲染表头单元格。

public void renderHeaderCell ( )

                public function renderHeaderCell()
{
    return Html::tag('th', $this->renderHeaderCellContent(), $this->headerOptions);
}
renderHeaderCellContent() 受保护方法

定义于： yii\grid\Column::renderHeaderCellContent()

渲染表头单元格内容。

默认实现只是渲染 $header。可以重写此方法来自定义表头单元格的渲染。

protected string renderHeaderCellContent ( )
返回值 字符串

渲染结果

 

                protected function renderHeaderCellContent()
{
    return $this->header !== null && trim($this->header) !== '' ? $this->header : $this->getHeaderCellLabel();
}