GridView WIP

framework/yii/widgets/grid/CheckboxColumn.php

+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\widgets\grid;
+
+/**
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @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:
+	 * <ul>
+	 *   <li><code>$row</code> the row number (zero-based)</li>
+	 *   <li><code>$data</code> the data model for the row</li>
+	 *   <li><code>$this</code> the column object</li>
+	 * </ul>
+	 * 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 <code>checkBoxHtmlOptions['disabled']</code>.
+	 * @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:
+	 * <ul>
+	 * <li>0 - the state of the checkbox cannot be changed (read-only mode)</li>
+	 * <li>1 - only one row can be checked. Checking a checkbox has nothing to do with selecting the row</li>
+	 * <li>2 or more - multiple checkboxes can be checked. Checking a checkbox has nothing to do with selecting the row</li>
+	 * <li>null - {@link CGridView::selectableRows} is used to control how many checkboxes can be checked.
+	 * Checking a checkbox will also select the row.</li>
+	 * </ul>
+	 * You may also call the JavaScript function <code>$(gridID).yiiGridView('getChecked', columnID)</code>
+	 * 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}';
+
+	/**
+	 * 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;
+		}
+		$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 = <<<CBALL
+jQuery(document).on('click','#{$this->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 .= <<<EOD
+jQuery(document).on('click', "input[name='$name']", function() {
+	$cbcode
+});
+EOD;
+			Yii::app()->getClientScript()->registerScript(__CLASS__ . '#' . $this->id, $js);
+		}
+	}
+
+	/**
+	 * 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.
+	 */
+	protected function renderHeaderCellContent()
+	{
+		if (trim($this->headerTemplate) === '') {
+			echo $this->grid->blankDisplay;
+			return;
+		}
+
+		$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);
+		} else {
+			ob_start();
+			parent::renderHeaderCellContent();
+			$item = ob_get_clean();
+		}
+
+		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
+	 */
+	protected function renderDataCellContent($row, $data)
+	{
+		if ($this->value !== null) {
+			$value = $this->evaluateExpression($this->value, array('data' => $data, 'row' => $row));
+		} elseif ($this->name !== null) {
+			$value = CHtml::value($data, $this->name);
+		} 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));
+		}
+
+		$name = $options['name'];
+		unset($options['name']);
+		$options['value'] = $value;
+		$options['id'] = $this->id . '_' . $row;
+		echo CHtml::checkBox($name, $checked, $options);
+	}
+}

framework/yii/widgets/grid/Column.php

+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\widgets\grid;
+
+use Closure;
+use yii\base\Object;
+use yii\helpers\Html;
+use yii\widgets\GridView;
+
+/**
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+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;
+	/**
+	 * @var string the header cell content. Note that it will not be HTML-encoded.
+	 */
+	public $header;
+	/**
+	 * @var string the footer cell content. Note that it will not be HTML-encoded.
+	 */
+	public $footer;
+	/**
+	 * @var callable
+	 */
+	public $content;
+	/**
+	 * @var boolean whether this column is visible. Defaults to true.
+	 */
+	public $visible = true;
+	public $options = array();
+	public $headerOptions = array();
+	/**
+	 * @var array|\Closure
+	 */
+	public $bodyOptions = array();
+	public $footerOptions = array();
+	/**
+	 * @var array the HTML attributes for the filter cell tag.
+	 */
+	public $filterOptions=array();
+
+
+	/**
+	 * Renders the header cell.
+	 */
+	public function renderHeaderCell()
+	{
+		return Html::tag('th', $this->renderHeaderCellContent(), $this->headerOptions);
+	}
+
+	/**
+	 * Renders the footer cell.
+	 */
+	public function renderFooterCell()
+	{
+		return Html::tag('td', $this->renderFooterCellContent(), $this->footerOptions);
+	}
+
+	/**
+	 * Renders a data cell.
+	 * @param mixed $item the data item
+	 * @param integer $index the zero-based index of the data item among the item array returned by [[dataProvider]].
+	 * @return string the rendering result
+	 */
+	public function renderDataCell($item, $index)
+	{
+		if ($this->bodyOptions instanceof Closure) {
+			$options = call_user_func($this->bodyOptions, $item, $index, $this);
+		} else {
+			$options = $this->bodyOptions;
+		}
+		return Html::tag('td', $this->renderDataCellContent($item, $index), $options);
+	}
+
+	/**
+	 * Renders the filter cell.
+	 */
+	public function renderFilterCell()
+	{
+		return Html::tag('td', $this->renderFilterCellContent(), $this->filterOptions);
+	}
+
+	/**
+	 * Renders the header cell content.
+	 * 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()
+	{
+		return trim($this->header) !== '' ? $this->header : $this->grid->emptyCell;
+	}
+
+	/**
+	 * Renders the footer cell content.
+	 * The default implementation simply renders {@link footer}.
+	 * This method may be overridden to customize the rendering of the footer cell.
+	 * @return string the rendering result
+	 */
+	protected function renderFooterCellContent()
+	{
+		return trim($this->footer) !== '' ? $this->footer : $this->grid->emptyCell;
+	}
+
+	/**
+	 * Renders the data cell content.
+	 * @param mixed $item the data item
+	 * @param integer $index the zero-based index of the data item among the item array returned by [[dataProvider]].
+	 * @return string the rendering result
+	 */
+	protected function renderDataCellContent($item, $index)
+	{
+		if ($this->content !== null) {
+			return call_user_func($this->content, $item, $index, $this);
+		} else {
+			return $this->grid->emptyCell;
+		}
+	}
+
+	/**
+	 * 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).
+	 * @return string the rendering result
+	 */
+	protected function renderFilterCellContent()
+	{
+		return $this->grid->emptyCell;
+	}
+}

framework/yii/widgets/grid/DataColumn.php

+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\widgets\grid;
+use yii\base\InvalidConfigException;
+use yii\base\Model;
+use yii\data\ActiveDataProvider;
+use yii\db\ActiveQuery;
+use yii\helpers\ArrayHelper;
+use yii\helpers\Html;
+use yii\helpers\Inflector;
+
+/**
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class DataColumn extends Column
+{
+	public $attribute;
+	public $value;
+	public $type;
+	/**
+	 * @var boolean whether to allow sorting by this column. If true and [[attribute]] is found in
+	 * the sort definition of [[GridView::dataProvider]], then the header cell of this column
+	 * will contain a link that may trigger the sorting when being clicked.
+	 */
+	public $enableSorting = true;
+	/**
+	 * @var string|array|boolean the HTML code representing a filter input (eg a text field, a dropdown list)
+	 * that is used for this data column. This property is effective only when
+	 * {@link CGridView::filter} is set.
+	 * If this property is not set, a text field will be generated as the filter input;
+	 * If this property is an array, a dropdown list will be generated that uses this property value as
+	 * the list options.
+	 * If you don't want a filter for this data column, set this value to false.
+	 * @since 1.1.1
+	 */
+	public $filter;
+
+
+	protected function renderHeaderCellContent()
+	{
+		if ($this->attribute !== null && $this->header === null) {
+			$provider = $this->grid->dataProvider;
+			if ($this->enableSorting && ($sort = $provider->getSort()) !== false && $sort->hasAttribute($this->attribute)) {
+				return $sort->link($this->attribute);
+			}
+			$items = $provider->getItems();
+			if (($item = reset($items)) instanceof Model) {
+				/** @var Model $item */
+				return $item->getAttributeLabel($this->attribute);
+			} elseif ($provider instanceof ActiveDataProvider) {
+				if ($provider->query instanceof ActiveQuery) {
+					/** @var Model $model */
+					$model = new $provider->query->modelClass;
+					return $model->getAttributeLabel($this->attribute);
+				}
+			}
+			return Inflector::camel2words($this->attribute);
+		} else {
+			return parent::renderHeaderCellContent();
+		}
+	}
+
+	protected function renderFilterCellContent()
+	{
+		if (is_string($this->filter)) {
+			return $this->filter;
+		} elseif ($this->filter !== false && $this->grid->filterModel instanceof Model && $this->attribute !== null) {
+			if (is_array($this->filter)) {
+				return Html::activeDropDownList($this->grid->filterModel, $this->attribute, $this->filter, array('prompt' => ''));
+			} else {
+				return Html::activeTextInput($this->grid->filterModel, $this->attribute);
+			}
+		} else {
+			return parent::renderFilterCellContent();
+		}
+	}
+
+	protected function renderDataCellContent($item, $index)
+	{
+		if ($this->value !== null) {
+			$value = call_user_func($this->value, $item, $index, $this);
+		} elseif ($this->content === null && $this->attribute !== null) {
+			$value = ArrayHelper::getValue($item, $this->attribute);
+		} else {
+			return parent::renderDataCellContent($item, $index);
+		}
+		return $this->grid->formatter->format($value, $this->type);
+	}
+}