Class yii\grid\CheckboxColumn
Inheritance | yii\grid\CheckboxColumn » yii\grid\Column » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/grid/CheckboxColumn.php |
CheckboxColumn displays a column of checkboxes in a grid view.
To add a CheckboxColumn to the yii\grid\GridView, add it to the columns configuration as follows:
'columns' => [
// ...
[
'class' => 'yii\grid\CheckboxColumn',
// you may configure additional properties here
],
]
Users may click on the checkboxes to select rows of the grid. The selected rows may be obtained by calling the following JavaScript code:
var keys = $('#grid').yiiGridView('getSelectedRows');
// keys is an array consisting of the keys associated with the selected rows
For more details and usage information on CheckboxColumn, see the guide article on data widgets.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$checkboxOptions | array|Closure | The HTML attributes for checkboxes. | yii\grid\CheckboxColumn |
$content | callable | This is a callable that will be used to generate the content of each cell. | yii\grid\Column |
$contentOptions | array|Closure | The HTML attributes for the data cell tag. | yii\grid\Column |
$cssClass | string | The css class that will be used to find the checkboxes. | yii\grid\CheckboxColumn |
$filterOptions | array | The HTML attributes for the filter cell tag. | yii\grid\Column |
$footer | string | The footer cell content. | yii\grid\Column |
$footerOptions | array | The HTML attributes for the footer cell tag. | yii\grid\Column |
$grid | yii\grid\GridView | The grid view object that owns this column. | yii\grid\Column |
$header | string|null | The header cell content. | yii\grid\Column |
$headerOptions | array | The HTML attributes for the header cell tag. | yii\grid\Column |
$multiple | boolean | Whether it is possible to select multiple rows. | yii\grid\CheckboxColumn |
$name | string | The name of the input checkbox input fields. | yii\grid\CheckboxColumn |
$options | array | The HTML attributes for the column group tag. | yii\grid\Column |
$visible | boolean | Whether this column is visible. | yii\grid\Column |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() | Initializes the object. | yii\grid\CheckboxColumn |
registerClientScript() | Registers the needed JavaScript. | yii\grid\CheckboxColumn |
renderDataCell() | Renders a data cell. | yii\grid\Column |
renderFilterCell() | Renders the filter cell. | yii\grid\Column |
renderFooterCell() | Renders the footer cell. | yii\grid\Column |
renderHeaderCell() | Renders the header cell. | yii\grid\Column |
Protected Methods
Method | Description | Defined By |
---|---|---|
getHeaderCellLabel() | Returns header cell label. | yii\grid\Column |
getHeaderCheckBoxName() | Returns header checkbox name. | yii\grid\CheckboxColumn |
renderDataCellContent() | Renders the data cell content. | yii\grid\CheckboxColumn |
renderFilterCellContent() | Renders the filter cell content. | yii\grid\Column |
renderFooterCellContent() | Renders the footer cell content. | yii\grid\Column |
renderHeaderCellContent() | Renders the header cell content. | yii\grid\CheckboxColumn |
Property Details
The HTML attributes for checkboxes. This can either be an array of
attributes or an anonymous function (Closure) that returns such an array.
The signature of the function should be the following: function ($model, $key, $index, $column)
.
Where $model
, $key
, and $index
refer to the model, key and index of the row currently being rendered
and $column
is a reference to the yii\grid\CheckboxColumn object.
A function may be used to assign different attributes to different rows based on the data in that row.
Specifically if you want to set a different value for the checkbox
you can use this option in the following way (in this example using the name
attribute of the model):
'checkboxOptions' => function ($model, $key, $index, $column) {
return ['value' => $model->name];
}
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The css class that will be used to find the checkboxes.
Whether it is possible to select multiple rows. Defaults to true
.
Method Details
Defined in: yii\base\BaseObject::__call()
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\BaseObject::__get()
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only |
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);
}
Defined in: yii\base\BaseObject::__isset()
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property)
.
Note that if the property is not defined, false will be returned.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set (not null). |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in: yii\base\BaseObject::__set()
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only |
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);
}
}
Defined in: yii\base\BaseObject::__unset()
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property)
.
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
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);
}
}
Defined in: yii\base\BaseObject::canGetProperty()
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in: yii\base\BaseObject::canSetProperty()
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Defined in: yii\grid\Column::getHeaderCellLabel()
Returns header cell label.
This method may be overridden to customize the label of the header cell.
protected string getHeaderCellLabel ( ) | ||
return | string |
Label |
---|
protected function getHeaderCellLabel()
{
return $this->grid->emptyCell;
}
Returns header checkbox name.
protected string getHeaderCheckBoxName ( ) | ||
return | string |
Header checkbox name |
---|
protected function getHeaderCheckBoxName()
{
$name = $this->name;
if (substr_compare($name, '[]', -2, 2) === 0) {
$name = substr($name, 0, -2);
}
if (substr_compare($name, ']', -1, 1) === 0) {
$name = substr($name, 0, -1) . '_all]';
} else {
$name .= '_all';
}
return $name;
}
Defined in: yii\base\BaseObject::hasMethod()
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists()
.
You may override this method when you implemented the php magic method __call()
.
public boolean hasMethod ( $name ) | ||
$name | string |
The method name |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in: yii\base\BaseObject::hasProperty()
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also:
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) | ||
throws | yii\base\InvalidConfigException |
if $name is not set. |
---|
public function init()
{
parent::init();
if (empty($this->name)) {
throw new InvalidConfigException('The "name" property must be set.');
}
if (substr_compare($this->name, '[]', -2, 2)) {
$this->name .= '[]';
}
$this->registerClientScript();
}
Registers the needed JavaScript.
public void registerClientScript ( ) |
public function registerClientScript()
{
$id = $this->grid->options['id'];
$options = Json::encode([
'name' => $this->name,
'class' => $this->cssClass,
'multiple' => $this->multiple,
'checkAll' => $this->grid->showHeader ? $this->getHeaderCheckBoxName() : null,
]);
$this->grid->getView()->registerJs("jQuery('#$id').yiiGridView('setSelectionColumn', $options);");
}
Defined in: yii\grid\Column::renderDataCell()
Renders a data cell.
public string renderDataCell ( $model, $key, $index ) | ||
$model | mixed |
The data model being rendered |
$key | mixed |
The key associated with the data model |
$index | integer |
The zero-based index of the data item among the item array returned by yii\grid\GridView::$dataProvider. |
return | string |
The rendering result |
---|
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);
}
Renders the data cell content.
protected string renderDataCellContent ( $model, $key, $index ) | ||
$model | mixed |
The data model |
$key | mixed |
The key associated with the data model |
$index | integer |
The zero-based index of the data model among the models array returned by yii\grid\GridView::$dataProvider. |
return | string |
The rendering result |
---|
protected function renderDataCellContent($model, $key, $index)
{
if ($this->content !== null) {
return parent::renderDataCellContent($model, $key, $index);
}
if ($this->checkboxOptions instanceof Closure) {
$options = call_user_func($this->checkboxOptions, $model, $key, $index, $this);
} else {
$options = $this->checkboxOptions;
}
if (!isset($options['value'])) {
$options['value'] = is_array($key) ? Json::encode($key) : $key;
}
if ($this->cssClass !== null) {
Html::addCssClass($options, $this->cssClass);
}
return Html::checkbox($this->name, !empty($options['checked']), $options);
}
Defined in: yii\grid\Column::renderFilterCell()
Renders the filter cell.
public void renderFilterCell ( ) |
public function renderFilterCell()
{
return Html::tag('td', $this->renderFilterCellContent(), $this->filterOptions);
}
Defined in: yii\grid\Column::renderFilterCellContent()
Renders the filter cell content.
The default implementation simply renders a space. This method may be overridden to customize the rendering of the filter cell (if any).
protected string renderFilterCellContent ( ) | ||
return | string |
The rendering result |
---|
protected function renderFilterCellContent()
{
return $this->grid->emptyCell;
}
Defined in: yii\grid\Column::renderHeaderCell()
Renders the header cell.
public void renderHeaderCell ( ) |
public function renderHeaderCell()
{
return Html::tag('th', $this->renderHeaderCellContent(), $this->headerOptions);
}
Renders the header cell content.
The default implementation simply renders $header. This method may be overridden to customize the rendering of the header cell.
protected string renderHeaderCellContent ( ) | ||
return | string |
The rendering result |
---|
protected function renderHeaderCellContent()
{
if ($this->header !== null || !$this->multiple) {
return parent::renderHeaderCellContent();
}
return Html::checkbox($this->getHeaderCheckBoxName(), false, ['class' => 'select-on-check-all']);
}
Signup or Login in order to comment.