diff --git a/framework/yii/assets/yii.gridView.js b/framework/yii/assets/yii.gridView.js new file mode 100644 index 0000000..b07ece2 --- /dev/null +++ b/framework/yii/assets/yii.gridView.js @@ -0,0 +1,78 @@ +/** + * Yii GridView widget. + * + * This is the JavaScript widget used by the yii\grid\GridView widget. + * + * @link http://www.yiiframework.com/ + * @copyright Copyright (c) 2008 Yii Software LLC + * @license http://www.yiiframework.com/license/ + * @author Qiang Xue + * @since 2.0 + */ +(function ($) { + $.fn.yiiGridView = function (method) { + if (methods[method]) { + return methods[method].apply(this, Array.prototype.slice.call(arguments, 1)); + } else if (typeof method === 'object' || !method) { + return methods.init.apply(this, arguments); + } else { + $.error('Method ' + method + ' does not exist on jQuery.yiiGridView'); + return false; + } + }; + + var defaults = { + }; + + var methods = { + init: function (options) { + return this.each(function () { + var $e = $(this); + var settings = $.extend({}, defaults, options || {}); + $e.data('yiiGridView', { + settings: settings + }); + }); + }, + + setSelectionColumn: function (options) { + var $grid = $(this); + var data = $grid.data('yiiGridView'); + data.selectionColumn = options.name; + if (!options.multiple) { + return; + } + $grid.on('click.yiiGridView', "input[name='" + options.checkAll + "']", function () { + $grid.find("input[name='" + options.name + "']:enabled").prop('checked', this.checked); + }); + $grid.on('click.yiiGridView', "input[name='" + options.name + "']:enabled", function () { + var all = $grid.find("input[name='" + options.name + "']").length == $grid.find("input[name='" + options.name + "']:checked").length; + $grid.find("input[name='" + options.checkAll + "']").prop('checked', all); + }); + }, + + getSelectedRows: function () { + var $grid = $(this); + var data = $grid.data('yiiGridView'); + var keys = []; + if (data.selectionColumn) { + $grid.find("input[name='" + data.selectionColumn + "']:checked").each(function () { + keys.push($(this).parent().closest('tr').data('key')); + }); + } + return keys; + }, + + destroy: function () { + return this.each(function () { + $(window).unbind('.yiiGridView'); + $(this).removeData('yiiGridView'); + }); + }, + + data: function() { + return this.data('yiiGridView'); + } + }; +})(window.jQuery); + diff --git a/framework/yii/widgets/GridView.php b/framework/yii/widgets/GridView.php index cdfa782..a831ab8 100644 --- a/framework/yii/widgets/GridView.php +++ b/framework/yii/widgets/GridView.php @@ -15,6 +15,7 @@ use yii\base\Widget; use yii\db\ActiveRecord; use yii\helpers\Html; use yii\widgets\grid\DataColumn; +use yii\widgets\grid\GridViewAsset; /** * @author Qiang Xue @@ -26,7 +27,7 @@ class GridView extends ListViewBase const FILTER_POS_FOOTER = 'footer'; const FILTER_POS_BODY = 'body'; - public $dataColumnClass = 'yii\widgets\grid\DataColumn'; + public $dataColumnClass; public $caption; public $captionOptions = array(); public $tableOptions = array('class' => 'table table-striped table-bordered'); @@ -70,7 +71,7 @@ class GridView extends ListViewBase * - `{sorter}`: the sorter. See [[renderSorter()]]. * - `{pager}`: the pager. See [[renderPager()]]. */ - public $layout = "{summary}\n{pager}{items}\n{pager}"; + public $layout = "{items}\n{summary}\n{pager}"; public $emptyCell = ' '; /** * @var \yii\base\Model the model instance that keeps the user-entered filter data. When this property is set, @@ -107,11 +108,26 @@ class GridView extends ListViewBase if (!$this->formatter instanceof Formatter) { throw new InvalidConfigException('The "formatter" property must be either a Format object or a configuration array.'); } + if (!isset($this->options['id'])) { + $this->options['id'] = $this->getId(); + } $this->initColumns(); } /** + * Runs the widget. + */ + public function run() + { + $id = $this->options['id']; + $view = $this->getView(); + GridViewAsset::register($view); + $view->registerJs("jQuery('#$id').yiiGridView();"); + parent::run(); + } + + /** * Renders the data models for the grid view. */ public function renderItems() @@ -272,13 +288,12 @@ class GridView extends ListViewBase if (empty($this->columns)) { $this->guessColumns(); } - $id = $this->getId(); foreach ($this->columns as $i => $column) { if (is_string($column)) { $column = $this->createDataColumn($column); } else { $column = Yii::createObject(array_merge(array( - 'class' => $this->dataColumnClass, + 'class' => $this->dataColumnClass ?: DataColumn::className(), 'grid' => $this, ), $column)); } @@ -286,9 +301,6 @@ class GridView extends ListViewBase unset($this->columns[$i]); continue; } - if ($column->id === null) { - $column->id = $id . '_c' . $i; - } $this->columns[$i] = $column; } } @@ -305,7 +317,7 @@ class GridView extends ListViewBase throw new InvalidConfigException('The column must be specified in the format of "Attribute", "Attribute:Format" or "Attribute:Format:Header'); } return Yii::createObject(array( - 'class' => $this->dataColumnClass, + 'class' => $this->dataColumnClass ?: DataColumn::className(), 'grid' => $this, 'attribute' => $matches[1], 'format' => isset($matches[3]) ? $matches[3] : 'text', diff --git a/framework/yii/widgets/ListViewBase.php b/framework/yii/widgets/ListViewBase.php index fe318c4..6be704d 100644 --- a/framework/yii/widgets/ListViewBase.php +++ b/framework/yii/widgets/ListViewBase.php @@ -135,10 +135,6 @@ abstract class ListViewBase extends Widget $totalCount = $this->dataProvider->getTotalCount(); $begin = $pagination->getPage() * $pagination->pageSize + 1; $end = $begin + $count - 1; - if ($end > $totalCount) { - $end = $totalCount; - $begin = $end - $count + 1; - } $page = $pagination->getPage() + 1; $pageCount = $pagination->pageCount; if (($summaryContent = $this->summary) === null) { diff --git a/framework/yii/widgets/grid/CheckboxColumn.php b/framework/yii/widgets/grid/CheckboxColumn.php index e6bb327..5d1dc0c 100644 --- a/framework/yii/widgets/grid/CheckboxColumn.php +++ b/framework/yii/widgets/grid/CheckboxColumn.php @@ -7,185 +7,69 @@ namespace yii\widgets\grid; +use Closure; +use yii\base\InvalidConfigException; +use yii\helpers\Html; + /** * @author Qiang Xue * @since 2.0 */ class CheckboxColumn extends Column { - public $checked; - /** - * @var string a PHP expression that will be evaluated for every data cell and whose result will - * determine if checkbox for each data cell is disabled. In this expression, you can use the following variables: - *
    - *
  • $row the row number (zero-based)
    • - *
  • $data the data model for the row
    • - *
  • $this the column object
    • - *
- * The PHP expression will be evaluated using {@link evaluateExpression}. - * - * A PHP expression can be any PHP code that has a value. To learn more about what an expression is, - * please refer to the {@link http://www.php.net/manual/en/language.expressions.php php manual}. - * - * Note that expression result will overwrite value set with checkBoxHtmlOptions['disabled']. - * @since 1.1.13 - */ - public $disabled; - /** - * @var array the HTML options for the data cell tags. - */ - public $htmlOptions = array('class' => 'checkbox-column'); - /** - * @var array the HTML options for the header cell tag. - */ - public $headerHtmlOptions = array('class' => 'checkbox-column'); - /** - * @var array the HTML options for the footer cell tag. - */ - public $footerHtmlOptions = array('class' => 'checkbox-column'); - /** - * @var array the HTML options for the checkboxes. - */ - public $checkBoxHtmlOptions = array(); - /** - * @var integer the number of rows that can be checked. - * Possible values: - *
    - *
  • 0 - the state of the checkbox cannot be changed (read-only mode)
    • - *
  • 1 - only one row can be checked. Checking a checkbox has nothing to do with selecting the row
    • - *
  • 2 or more - multiple checkboxes can be checked. Checking a checkbox has nothing to do with selecting the row
    • - *
  • null - {@link CGridView::selectableRows} is used to control how many checkboxes can be checked. - * Checking a checkbox will also select the row.
    • - *
- * You may also call the JavaScript function $(gridID).yiiGridView('getChecked', columnID) - * to retrieve the key values of the checked rows. - * @since 1.1.6 - */ - public $selectableRows = null; - /** - * @var string the template to be used to control the layout of the header cell. - * The token "{item}" is recognized and it will be replaced with a "check all" checkbox. - * By default if in multiple checking mode, the header cell will display an additional checkbox, - * clicking on which will check or uncheck all of the checkboxes in the data cells. - * See {@link selectableRows} for more details. - * @since 1.1.11 - */ - public $headerTemplate = '{item}'; + public $name; + public $checkboxOptions = array(); + public $multiple = true; + - /** - * Initializes the column. - * This method registers necessary client script for the checkbox column. - */ public function init() { - if (isset($this->checkBoxHtmlOptions['name'])) { - $name = $this->checkBoxHtmlOptions['name']; - } else { - $name = $this->id; - if (substr($name, -2) !== '[]') { - $name .= '[]'; - } - $this->checkBoxHtmlOptions['name'] = $name; + parent::init(); + if (empty($this->name)) { + throw new InvalidConfigException('The "name" property must be set.'); } - $name = strtr($name, array('[' => "\\[", ']' => "\\]")); - - if ($this->selectableRows === null) { - if (isset($this->checkBoxHtmlOptions['class'])) { - $this->checkBoxHtmlOptions['class'] .= ' select-on-check'; - } else { - $this->checkBoxHtmlOptions['class'] = 'select-on-check'; - } - return; - } - - $cball = $cbcode = ''; - if ($this->selectableRows == 0) { - //.. read only - $cbcode = "return false;"; - } elseif ($this->selectableRows == 1) { - //.. only one can be checked, uncheck all other - $cbcode = "jQuery(\"input:not(#\"+this.id+\")[name='$name']\").prop('checked',false);"; - } elseif (strpos($this->headerTemplate, '{item}') !== false) { - //.. process check/uncheck all - $cball = <<id}_all',function() { - var checked=this.checked; - jQuery("input[name='$name']:enabled").each(function() {this.checked=checked;}); -}); - -CBALL; - $cbcode = "jQuery('#{$this->id}_all').prop('checked', jQuery(\"input[name='$name']\").length==jQuery(\"input[name='$name']:checked\").length);"; - } - - if ($cbcode !== '') { - $js = $cball; - $js .= <<getClientScript()->registerScript(__CLASS__ . '#' . $this->id, $js); + if (substr($this->name, -2) !== '[]') { + $this->name .= '[]'; } } /** * Renders the header cell content. - * This method will render a checkbox in the header when {@link selectableRows} is greater than 1 - * or in case {@link selectableRows} is null when {@link CGridView::selectableRows} is greater than 1. + * The default implementation simply renders {@link header}. + * This method may be overridden to customize the rendering of the header cell. + * @return string the rendering result */ protected function renderHeaderCellContent() { - if (trim($this->headerTemplate) === '') { - echo $this->grid->blankDisplay; - return; - } + $name = rtrim($this->name, '[]') . '_all'; + $id = $this->grid->options['id']; + $options = json_encode(array( + 'name' => $this->name, + 'multiple' => $this->multiple, + 'checkAll' => $name, + )); + $this->grid->getView()->registerJs("jQuery('#$id').yiiGridView('setSelectionColumn', $options);"); - $item = ''; - if ($this->selectableRows === null && $this->grid->selectableRows > 1) { - $item = CHtml::checkBox($this->id . '_all', false, array('class' => 'select-on-check-all')); - } elseif ($this->selectableRows > 1) { - $item = CHtml::checkBox($this->id . '_all', false); + if ($this->header !== null || !$this->multiple) { + return parent::renderHeaderCellContent(); } else { - ob_start(); - parent::renderHeaderCellContent(); - $item = ob_get_clean(); + return Html::checkBox($name, false, array('class' => 'select-on-check-all')); } - - echo strtr($this->headerTemplate, array( - '{item}' => $item, - )); } /** * Renders the data cell content. - * This method renders a checkbox in the data cell. - * @param integer $row the row number (zero-based) - * @param mixed $data the data associated with the row + * @param mixed $model the data model + * @param integer $index the zero-based index of the data model among the models array returned by [[dataProvider]]. + * @return string the rendering result */ - protected function renderDataCellContent($row, $data) + protected function renderDataCellContent($model, $index) { - if ($this->value !== null) { - $value = $this->evaluateExpression($this->value, array('data' => $data, 'row' => $row)); - } elseif ($this->name !== null) { - $value = CHtml::value($data, $this->name); + if ($this->checkboxOptions instanceof Closure) { + $options = call_user_func($this->checkboxOptions, $model, $index, $this); } else { - $value = $this->grid->dataProvider->keys[$row]; - } - - $checked = false; - if ($this->checked !== null) { - $checked = $this->evaluateExpression($this->checked, array('data' => $data, 'row' => $row)); - } - - $options = $this->checkBoxHtmlOptions; - if ($this->disabled !== null) { - $options['disabled'] = $this->evaluateExpression($this->disabled, array('data' => $data, 'row' => $row)); + $options = $this->checkboxOptions; } - - $name = $options['name']; - unset($options['name']); - $options['value'] = $value; - $options['id'] = $this->id . '_' . $row; - echo CHtml::checkBox($name, $checked, $options); + return Html::checkbox($this->name, !empty($options['checked']), $options); } } diff --git a/framework/yii/widgets/grid/Column.php b/framework/yii/widgets/grid/Column.php index 939904a..11e3d3d 100644 --- a/framework/yii/widgets/grid/Column.php +++ b/framework/yii/widgets/grid/Column.php @@ -20,11 +20,6 @@ use yii\widgets\GridView; class Column extends Object { /** - * @var string the ID of this column. This value should be unique among all grid view columns. - * If this is not set, it will be assigned one automatically. - */ - public $id; - /** * @var GridView the grid view object that owns this column. */ public $grid; @@ -49,7 +44,7 @@ class Column extends Object /** * @var array|\Closure */ - public $bodyOptions = array(); + public $contentOptions = array(); public $footerOptions = array(); /** * @var array the HTML attributes for the filter cell tag. @@ -81,10 +76,10 @@ class Column extends Object */ public function renderDataCell($model, $index) { - if ($this->bodyOptions instanceof Closure) { - $options = call_user_func($this->bodyOptions, $model, $index, $this); + if ($this->contentOptions instanceof Closure) { + $options = call_user_func($this->contentOptions, $model, $index, $this); } else { - $options = $this->bodyOptions; + $options = $this->contentOptions; } return Html::tag('td', $this->renderDataCellContent($model, $index), $options); } diff --git a/framework/yii/widgets/grid/GridViewAsset.php b/framework/yii/widgets/grid/GridViewAsset.php new file mode 100644 index 0000000..f0c2432 --- /dev/null +++ b/framework/yii/widgets/grid/GridViewAsset.php @@ -0,0 +1,26 @@ + + * @since 2.0 + */ +class GridViewAsset extends AssetBundle +{ + public $sourcePath = '@yii/assets'; + public $js = array( + 'yii.gridView.js', + ); + public $depends = array( + 'yii\web\YiiAsset', + ); +}