You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
135 lines
4.5 KiB
135 lines
4.5 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\grid; |
|
|
|
use Closure; |
|
use yii\base\InvalidConfigException; |
|
use yii\helpers\Html; |
|
|
|
/** |
|
* CheckboxColumn displays a column of checkboxes in a grid view. |
|
* |
|
* To add a CheckboxColumn to the [[GridView]], add it to the [[GridView::columns|columns]] configuration as follows: |
|
* |
|
* ```php |
|
* '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: |
|
* |
|
* ```javascript |
|
* var keys = $('#grid').yiiGridView('getSelectedRows'); |
|
* // keys is an array consisting of the keys associated with the selected rows |
|
* ``` |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class CheckboxColumn extends Column |
|
{ |
|
/** |
|
* @var string the name of the input checkbox input fields. This will be appended with `[]` to ensure it is an array. |
|
*/ |
|
public $name = 'selection'; |
|
/** |
|
* @var array|\Closure 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 [[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): |
|
* |
|
* ```php |
|
* 'checkboxOptions' => function ($model, $key, $index, $column) { |
|
* return ['value' => $model->name]; |
|
* } |
|
* ``` |
|
* |
|
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered. |
|
*/ |
|
public $checkboxOptions = []; |
|
/** |
|
* @var boolean whether it is possible to select multiple rows. Defaults to `true`. |
|
*/ |
|
public $multiple = true; |
|
|
|
|
|
/** |
|
* @inheritdoc |
|
* @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 .= '[]'; |
|
} |
|
} |
|
|
|
/** |
|
* Renders the header cell content. |
|
* The default implementation simply renders [[header]]. |
|
* This method may be overridden to customize the rendering of the header cell. |
|
* @return string the rendering result |
|
*/ |
|
protected function renderHeaderCellContent() |
|
{ |
|
$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'; |
|
} |
|
|
|
$id = $this->grid->options['id']; |
|
$options = json_encode([ |
|
'name' => $this->name, |
|
'multiple' => $this->multiple, |
|
'checkAll' => $name, |
|
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); |
|
$this->grid->getView()->registerJs("jQuery('#$id').yiiGridView('setSelectionColumn', $options);"); |
|
|
|
if ($this->header !== null || !$this->multiple) { |
|
return parent::renderHeaderCellContent(); |
|
} else { |
|
return Html::checkBox($name, false, ['class' => 'select-on-check-all']); |
|
} |
|
} |
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
protected function 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, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) : $key; |
|
} |
|
} |
|
|
|
return Html::checkbox($this->name, !empty($options['checked']), $options); |
|
} |
|
}
|
|
|