DataColumn.php 5.84 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8 9
namespace yii\grid;

Qiang Xue committed
10 11
use yii\base\Model;
use yii\data\ActiveDataProvider;
12
use yii\db\ActiveQueryInterface;
Qiang Xue committed
13 14 15 16 17
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use yii\helpers\Inflector;

/**
18 19 20 21
 * DataColumn is the default column type for the [[GridView]] widget.
 *
 * It is used to show data columns and allows sorting them.
 *
Qiang Xue committed
22 23 24 25 26
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class DataColumn extends Column
{
27 28 29 30 31 32
	/**
	 * @var string the attribute name associated with this column. When neither [[content]] nor [[value]]
	 * is specified, the value of the specified attribute will be retrieved from each data model and displayed.
	 *
	 * Also, if [[header]] is not specified, the label associated with the attribute will be displayed.
	 */
Qiang Xue committed
33
	public $attribute;
34 35 36 37
	/**
	 * @var string label to be displayed in the [[header|header cell]] and also to be used as the sorting
	 * link label when sorting is enabled for this column.
	 * If it is not set and the models provided by the GridViews data provider are instances
38 39
	 * of [[\yii\db\ActiveRecord]], the label will be determined using [[\yii\db\ActiveRecord::getAttributeLabel()]].
	 * Otherwise [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
40 41
	 */
	public $label;
42
	/**
Thiago Talma committed
43 44
	 * @var string|\Closure the attribute name to be displayed in this column or an anonymous function that returns 
	 * the value to be displayed for every data model.
Carsten Brandt committed
45
	 * The signature of this function is `function ($model, $index, $widget)`.
46 47
	 * If this is not set, `$model[$attribute]` will be used to obtain the value.
	 */
Qiang Xue committed
48
	public $value;
49
	/**
Alexander Makarov committed
50 51 52 53
	 * @var string|array in which format should the value of each data model be displayed as (e.g. "text", "html",
	 * ['date', 'Y-m-d']). Supported formats are determined by the [[GridView::formatter|formatter]] used by
	 * the [[GridView]]. Default format is "text" which will format the value as an HTML-encoded plain text when
	 * [[\yii\base\Formatter::format()]] or [[\yii\i18n\Formatter::format()]] is used.
54
	 */
55
	public $format = 'text';
Qiang Xue committed
56 57 58 59 60 61
	/**
	 * @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;
62 63
	/**
	 * @var array the HTML attributes for the link tag in the header cell
64
	 * generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
65
	 */
Alexander Makarov committed
66
	public $sortLinkOptions = [];
Qiang Xue committed
67
	/**
68 69 70 71 72 73 74
	 * @var string|array|boolean the HTML code representing a filter input (e.g. a text field, a dropdown list)
	 * that is used for this data column. This property is effective only when [[GridView::filterModel]] 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 be false.
Qiang Xue committed
75 76
	 */
	public $filter;
Qiang Xue committed
77 78 79 80 81
	/**
	 * @var array the HTML attributes for the filter input fields. This property is used in combination with
	 * the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
	 * render the HTML attributes for the generated filter input fields.
	 */
Alexander Makarov committed
82
	public $filterInputOptions = ['class' => 'form-control', 'id' => null];
Qiang Xue committed
83 84 85 86


	protected function renderHeaderCellContent()
	{
87 88 89 90 91
		if ($this->header !== null || $this->label === null && $this->attribute === null) {
			return parent::renderHeaderCellContent();
		}

		$provider = $this->grid->dataProvider;
92

93
		if ($this->label === null) {
94
			if ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
95 96 97 98 99 100
				/** @var Model $model */
				$model = new $provider->query->modelClass;
				$label = $model->getAttributeLabel($this->attribute);
			} else {
				$models = $provider->getModels();
				if (($model = reset($models)) instanceof Model) {
101 102 103
					/** @var Model $model */
					$label = $model->getAttributeLabel($this->attribute);
				} else {
104
					$label = Inflector::camel2words($this->attribute);
105 106
				}
			}
107 108 109
		} else {
			$label = $this->label;
		}
110

111 112
		if ($this->attribute !== null && $this->enableSorting &&
			($sort = $provider->getSort()) !== false && $sort->hasAttribute($this->attribute)) {
113

Alexander Makarov committed
114
			return $sort->link($this->attribute, array_merge($this->sortLinkOptions, ['label' => Html::encode($label)]));
Qiang Xue committed
115
		} else {
116
			return Html::encode($label);
Qiang Xue committed
117 118 119 120 121 122 123
		}
	}

	protected function renderFilterCellContent()
	{
		if (is_string($this->filter)) {
			return $this->filter;
124 125 126
		} elseif ($this->filter !== false && $this->grid->filterModel instanceof Model &&
				  $this->attribute !== null && $this->grid->filterModel->isAttributeActive($this->attribute))
		{
Qiang Xue committed
127
			if (is_array($this->filter)) {
Alexander Makarov committed
128
				$options = array_merge(['prompt' => ''], $this->filterInputOptions);
Qiang Xue committed
129
				return Html::activeDropDownList($this->grid->filterModel, $this->attribute, $this->filter, $options);
Qiang Xue committed
130
			} else {
Qiang Xue committed
131
				return Html::activeTextInput($this->grid->filterModel, $this->attribute, $this->filterInputOptions);
Qiang Xue committed
132 133 134 135 136 137
			}
		} else {
			return parent::renderFilterCellContent();
		}
	}

138 139 140 141
	/**
	 * @inheritdoc
	 */
	protected function renderDataCellContent($model, $key, $index)
Qiang Xue committed
142 143
	{
		if ($this->value !== null) {
Thiago Talma committed
144
			if (is_string($this->value)) {
145
				$value = ArrayHelper::getValue($model, $this->value);
Thiago Talma committed
146 147
			} else {
				$value = call_user_func($this->value, $model, $index, $this);
148
			}
Qiang Xue committed
149
		} elseif ($this->content === null && $this->attribute !== null) {
150
			$value = ArrayHelper::getValue($model, $this->attribute);
Qiang Xue committed
151
		} else {
152
			return parent::renderDataCellContent($model, $key, $index);
Qiang Xue committed
153
		}
154
		return $this->grid->formatter->format($value, $this->format);
Qiang Xue committed
155 156
	}
}