芝麻web文件管理V1.00
编辑当前文件:/home2/sdektunc/airport-back/vendor/yiisoft/yii2/grid/CheckboxColumn.php
[ * // ... * [ * '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 * ``` * * For more details and usage information on CheckboxColumn, see the [guide article on data widgets](guide:output-data-widgets). * * @author Qiang Xue
* @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 bool whether it is possible to select multiple rows. Defaults to `true`. */ public $multiple = true; /** * @var string the css class that will be used to find the checkboxes. * @since 2.0.9 */ public $cssClass; /** * {@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 .= '[]'; } $this->registerClientScript(); } /** * 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() { if ($this->header !== null || !$this->multiple) { return parent::renderHeaderCellContent(); } return Html::checkbox($this->getHeaderCheckBoxName(), false, ['class' => 'select-on-check-all']); } /** * {@inheritdoc} */ 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); } /** * Returns header checkbox name. * @return string header checkbox name * @since 2.0.8 */ 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; } /** * Registers the needed JavaScript. * @since 2.0.8 */ 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);"); } }