GridView.php 13.1 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
namespace yii\grid;
Qiang Xue committed
9 10 11 12 13 14

use Yii;
use Closure;
use yii\base\Formatter;
use yii\base\InvalidConfigException;
use yii\helpers\Html;
15
use yii\helpers\Json;
16
use yii\widgets\BaseListView;
Qiang Xue committed
17 18

/**
19 20 21 22
 * The GridView widget is used to display data in a grid.
 *
 * It provides features like sorting, paging and also filtering the data.
 *
Qiang Xue committed
23 24 25
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
26
class GridView extends BaseListView
Qiang Xue committed
27 28 29 30 31
{
	const FILTER_POS_HEADER = 'header';
	const FILTER_POS_FOOTER = 'footer';
	const FILTER_POS_BODY = 'body';

32 33 34 35
	/**
	 * @var string the default data column class if the class name is not explicitly specified when configuring a data column.
	 * Defaults to 'yii\grid\DataColumn'.
	 */
Qiang Xue committed
36
	public $dataColumnClass;
37 38 39 40
	/**
	 * @var string the caption of the grid table
	 * @see captionOptions
	 */
Qiang Xue committed
41
	public $caption;
42 43 44 45
	/**
	 * @var array the HTML attributes for the caption element
	 * @see caption
	 */
Alexander Makarov committed
46
	public $captionOptions = [];
47 48 49
	/**
	 * @var array the HTML attributes for the grid table element
	 */
Alexander Makarov committed
50
	public $tableOptions = ['class' => 'table table-striped table-bordered'];
51 52 53
	/**
	 * @var array the HTML attributes for the table header row
	 */
Alexander Makarov committed
54
	public $headerRowOptions = [];
55 56 57
	/**
	 * @var array the HTML attributes for the table footer row
	 */
Alexander Makarov committed
58
	public $footerRowOptions = [];
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
	/**
	 * @var array|Closure the HTML attributes for the table body rows. This can be either an array
	 * specifying the common HTML attributes for all body rows, or an anonymous function that
	 * returns an array of the HTML attributes. The anonymous function will be called once for every
	 * data model returned by [[dataProvider]]. It should have the following signature:
	 *
	 * ~~~php
	 * function ($model, $key, $index, $grid)
	 * ~~~
	 *
	 * - `$model`: the current data model being rendered
	 * - `$key`: the key value associated with the current data model
	 * - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]]
	 * - `$grid`: the GridView object
	 */
Alexander Makarov committed
74
	public $rowOptions = [];
75 76 77 78 79
	/**
	 * @var Closure an anonymous function that is called once BEFORE rendering each data model.
	 * It should have the similar signature as [[rowOptions]]. The return result of the function
	 * will be rendered directly.
	 */
Qiang Xue committed
80
	public $beforeRow;
81 82 83 84 85
	/**
	 * @var Closure an anonymous function that is called once AFTER rendering each data model.
	 * It should have the similar signature as [[rowOptions]]. The return result of the function
	 * will be rendered directly.
	 */
Qiang Xue committed
86
	public $afterRow;
87 88 89
	/**
	 * @var boolean whether to show the header section of the grid table.
	 */
Qiang Xue committed
90 91
	public $showHeader = true;
	/**
92
	 * @var boolean whether to show the footer section of the grid table.
Qiang Xue committed
93
	 */
94
	public $showFooter = false;
95
	/**
96
	 * @var boolean whether to show the grid view if [[dataProvider]] returns no data.
97
	 */
98
	public $showOnEmpty = true;
Qiang Xue committed
99 100 101 102 103 104 105 106
	/**
	 * @var array|Formatter the formatter used to format model attribute values into displayable texts.
	 * This can be either an instance of [[Formatter]] or an configuration array for creating the [[Formatter]]
	 * instance. If this property is not set, the "formatter" application component will be used.
	 */
	public $formatter;
	/**
	 * @var array grid column configuration. Each array element represents the configuration
107
	 * for one particular grid column. For example,
Qiang Xue committed
108
	 *
109
	 * ~~~php
Alexander Makarov committed
110 111 112
	 * [
	 *     ['class' => SerialColumn::className()],
	 *     [
113 114 115
	 *         'class' => DataColumn::className(),
	 *         'attribute' => 'name',
	 *         'format' => 'text',
116
	 *         'label' => 'Name',
Alexander Makarov committed
117 118 119
	 *     ],
	 *     ['class' => CheckboxColumn::className()],
	 * ]
120
	 * ~~~
Qiang Xue committed
121
	 *
122 123 124
	 * If a column is of class [[DataColumn]], the "class" element can be omitted.
	 *
	 * As a shortcut format, a string may be used to specify the configuration of a data column
125
	 * which only contains "attribute", "format", and/or "label" options: `"attribute:format:label"`.
126
	 * For example, the above "name" column can also be specified as: `"name:text:Name"`.
127
	 * Both "format" and "label" are optional. They will take default values if absent.
Qiang Xue committed
128
	 */
Alexander Makarov committed
129
	public $columns = [];
Qiang Xue committed
130 131
	public $emptyCell = '&nbsp;';
	/**
132
	 * @var \yii\base\Model the model that keeps the user-entered filter data. When this property is set,
Qiang Xue committed
133 134
	 * the grid view will enable column-based filtering. Each data column by default will display a text field
	 * at the top that users can fill in to filter the data.
135 136 137 138 139
	 *
	 * Note that in order to show an input field for filtering, a column must have its [[DataColumn::attribute]]
	 * property set or have [[DataColumn::filter]] set as the HTML code for the input field.
	 *
	 * When this property is not set (null) the filtering feature is disabled.
Qiang Xue committed
140 141
	 */
	public $filterModel;
142 143 144 145 146 147 148 149
	/**
	 * @var string|array the URL for returning the filtering result. [[Html::url()]] will be called to
	 * normalize the URL. If not set, the current controller action will be used.
	 * When the user makes change to any filter input, the current filtering inputs will be appended
	 * as GET parameters to this URL.
	 */
	public $filterUrl;
	public $filterSelector;
Qiang Xue committed
150 151
	/**
	 * @var string whether the filters should be displayed in the grid view. Valid values include:
152 153 154 155 156 157 158 159
	 *
	 * - [[FILTER_POS_HEADER]]: the filters will be displayed on top of each column's header cell.
	 * - [[FILTER_POS_BODY]]: the filters will be displayed right below each column's header cell.
	 * - [[FILTER_POS_FOOTER]]: the filters will be displayed below each column's footer cell.
	 */
	public $filterPosition = self::FILTER_POS_BODY;
	/**
	 * @var array the HTML attributes for the filter row element
Qiang Xue committed
160
	 */
Alexander Makarov committed
161
	public $filterRowOptions = ['class' => 'filters'];
Qiang Xue committed
162 163 164

	/**
	 * Initializes the grid view.
Qiang Xue committed
165
	 * This method will initialize required property values and instantiate [[columns]] objects.
Qiang Xue committed
166 167 168 169 170 171 172 173 174 175 176 177
	 */
	public function init()
	{
		parent::init();
		if ($this->formatter == null) {
			$this->formatter = Yii::$app->getFormatter();
		} elseif (is_array($this->formatter)) {
			$this->formatter = Yii::createObject($this->formatter);
		}
		if (!$this->formatter instanceof Formatter) {
			throw new InvalidConfigException('The "formatter" property must be either a Format object or a configuration array.');
		}
Qiang Xue committed
178 179 180
		if (!isset($this->options['id'])) {
			$this->options['id'] = $this->getId();
		}
181 182 183
		if (!isset($this->filterRowOptions['id'])) {
			$this->filterRowOptions['id'] = $this->options['id'] . '-filters';
		}
Qiang Xue committed
184 185 186 187

		$this->initColumns();
	}

Qiang Xue committed
188 189 190 191 192 193
	/**
	 * Runs the widget.
	 */
	public function run()
	{
		$id = $this->options['id'];
194
		$options = Json::encode($this->getClientOptions());
Qiang Xue committed
195 196
		$view = $this->getView();
		GridViewAsset::register($view);
197
		$view->registerJs("jQuery('#$id').yiiGridView($options);");
Qiang Xue committed
198 199 200
		parent::run();
	}

201 202 203 204 205 206 207

	/**
	 * Returns the options for the grid view JS widget.
	 * @return array the options
	 */
	protected function getClientOptions()
	{
Alexander Makarov committed
208
		$filterUrl = isset($this->filterUrl) ? $this->filterUrl : [Yii::$app->controller->action->id];
209 210 211 212 213 214
		$id = $this->filterRowOptions['id'];
		$filterSelector = "#$id input, #$id select";
		if (isset($this->filterSelector)) {
			$filterSelector .= ', ' . $this->filterSelector;
		}

Alexander Makarov committed
215
		return [
216 217
			'filterUrl' => Html::url($filterUrl),
			'filterSelector' => $filterSelector,
Alexander Makarov committed
218
		];
219 220
	}

Qiang Xue committed
221
	/**
222
	 * Renders the data models for the grid view.
Qiang Xue committed
223 224 225
	 */
	public function renderItems()
	{
Alexander Makarov committed
226
		$content = array_filter([
Qiang Xue committed
227 228 229 230 231
			$this->renderCaption(),
			$this->renderColumnGroup(),
			$this->showHeader ? $this->renderTableHeader() : false,
			$this->showFooter ? $this->renderTableFooter() : false,
			$this->renderTableBody(),
Alexander Makarov committed
232
		]);
Qiang Xue committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
		return Html::tag('table', implode("\n", $content), $this->tableOptions);
	}

	public function renderCaption()
	{
		if (!empty($this->caption)) {
			return Html::tag('caption', $this->caption, $this->captionOptions);
		} else {
			return false;
		}
	}

	public function renderColumnGroup()
	{
		$requireColumnGroup = false;
		foreach ($this->columns as $column) {
249
			/** @var Column $column */
Qiang Xue committed
250 251 252 253 254 255
			if (!empty($column->options)) {
				$requireColumnGroup = true;
				break;
			}
		}
		if ($requireColumnGroup) {
Alexander Makarov committed
256
			$cols = [];
Qiang Xue committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
			foreach ($this->columns as $column) {
				$cols[] = Html::tag('col', '', $column->options);
			}
			return Html::tag('colgroup', implode("\n", $cols));
		} else {
			return false;
		}
	}

	/**
	 * Renders the table header.
	 * @return string the rendering result
	 */
	public function renderTableHeader()
	{
Alexander Makarov committed
272
		$cells = [];
Qiang Xue committed
273
		foreach ($this->columns as $column) {
274
			/** @var Column $column */
Qiang Xue committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
			$cells[] = $column->renderHeaderCell();
		}
		$content = implode('', $cells);
		if ($this->filterPosition == self::FILTER_POS_HEADER) {
			$content = $this->renderFilters() . $content;
		} elseif ($this->filterPosition == self::FILTER_POS_BODY) {
			$content .= $this->renderFilters();
		}
		return "<thead>\n" . Html::tag('tr', $content, $this->headerRowOptions) . "\n</thead>";
	}

	/**
	 * Renders the table footer.
	 * @return string the rendering result
	 */
	public function renderTableFooter()
	{
Alexander Makarov committed
292
		$cells = [];
Qiang Xue committed
293
		foreach ($this->columns as $column) {
294
			/** @var Column $column */
Qiang Xue committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
			$cells[] = $column->renderFooterCell();
		}
		$content = implode('', $cells);
		if ($this->filterPosition == self::FILTER_POS_FOOTER) {
			$content .= $this->renderFilters();
		}
		return "<tfoot>\n" . Html::tag('tr', $content, $this->footerRowOptions) . "\n</tfoot>";
	}

	/**
	 * Renders the filter.
	 */
	public function renderFilters()
	{
		if ($this->filterModel !== null) {
Alexander Makarov committed
310
			$cells = [];
Qiang Xue committed
311
			foreach ($this->columns as $column) {
312
				/** @var Column $column */
Qiang Xue committed
313 314
				$cells[] = $column->renderFilterCell();
			}
315
			return Html::tag('tr', implode('', $cells), $this->filterRowOptions);
Qiang Xue committed
316 317 318 319 320 321 322 323 324 325 326
		} else {
			return '';
		}
	}

	/**
	 * Renders the table body.
	 * @return string the rendering result
	 */
	public function renderTableBody()
	{
327
		$models = array_values($this->dataProvider->getModels());
Qiang Xue committed
328
		$keys = $this->dataProvider->getKeys();
Alexander Makarov committed
329
		$rows = [];
330
		foreach ($models as $index => $model) {
Qiang Xue committed
331 332
			$key = $keys[$index];
			if ($this->beforeRow !== null) {
333
				$row = call_user_func($this->beforeRow, $model, $key, $index, $this);
Qiang Xue committed
334 335 336 337 338
				if (!empty($row)) {
					$rows[] = $row;
				}
			}

339
			$rows[] = $this->renderTableRow($model, $key, $index);
Qiang Xue committed
340 341

			if ($this->afterRow !== null) {
342
				$row = call_user_func($this->afterRow, $model, $key, $index, $this);
Qiang Xue committed
343 344 345 346 347
				if (!empty($row)) {
					$rows[] = $row;
				}
			}
		}
348 349 350 351

		if (empty($rows)) {
			$colspan = count($this->columns);
			return "<tbody>\n<tr><td colspan=\"$colspan\">" . $this->renderEmpty() . "</td></tr>\n</tbody>";
Qiang Xue committed
352 353
		} else {
			return "<tbody>\n" . implode("\n", $rows) . "\n</tbody>";
354
		}
Qiang Xue committed
355 356 357
	}

	/**
358 359 360 361
	 * Renders a table row with the given data model and key.
	 * @param mixed $model the data model to be rendered
	 * @param mixed $key the key associated with the data model
	 * @param integer $index the zero-based index of the data model among the model array returned by [[dataProvider]].
Qiang Xue committed
362 363
	 * @return string the rendering result
	 */
364
	public function renderTableRow($model, $key, $index)
Qiang Xue committed
365
	{
Alexander Makarov committed
366
		$cells = [];
367
		/** @var Column $column */
Qiang Xue committed
368
		foreach ($this->columns as $column) {
369
			$cells[] = $column->renderDataCell($model, $key, $index);
Qiang Xue committed
370 371
		}
		if ($this->rowOptions instanceof Closure) {
372
			$options = call_user_func($this->rowOptions, $model, $key, $index, $this);
Qiang Xue committed
373 374 375
		} else {
			$options = $this->rowOptions;
		}
376
		$options['data-key'] = is_array($key) ? json_encode($key) : $key;
Qiang Xue committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
		return Html::tag('tr', implode('', $cells), $options);
	}

	/**
	 * Creates column objects and initializes them.
	 */
	protected function initColumns()
	{
		if (empty($this->columns)) {
			$this->guessColumns();
		}
		foreach ($this->columns as $i => $column) {
			if (is_string($column)) {
				$column = $this->createDataColumn($column);
			} else {
Alexander Makarov committed
392
				$column = Yii::createObject(array_merge([
Qiang Xue committed
393
					'class' => $this->dataColumnClass ?: DataColumn::className(),
Qiang Xue committed
394
					'grid' => $this,
Alexander Makarov committed
395
				], $column));
Qiang Xue committed
396 397 398 399 400 401 402 403 404 405
			}
			if (!$column->visible) {
				unset($this->columns[$i]);
				continue;
			}
			$this->columns[$i] = $column;
		}
	}

	/**
406
	 * Creates a [[DataColumn]] object based on a string in the format of "attribute:format:label".
Qiang Xue committed
407 408 409 410 411 412
	 * @param string $text the column specification string
	 * @return DataColumn the column instance
	 * @throws InvalidConfigException if the column specification is invalid
	 */
	protected function createDataColumn($text)
	{
413
		if (!preg_match('/^([\w\.]+)(:(\w*))?(:(.*))?$/', $text, $matches)) {
414
			throw new InvalidConfigException('The column must be specified in the format of "attribute", "attribute:format" or "attribute:format:label');
Qiang Xue committed
415
		}
Alexander Makarov committed
416
		return Yii::createObject([
Qiang Xue committed
417
			'class' => $this->dataColumnClass ?: DataColumn::className(),
Qiang Xue committed
418 419
			'grid' => $this,
			'attribute' => $matches[1],
420
			'format' => isset($matches[3]) ? $matches[3] : 'text',
421
			'label' => isset($matches[5]) ? $matches[5] : null,
Alexander Makarov committed
422
		]);
Qiang Xue committed
423 424 425 426
	}

	protected function guessColumns()
	{
427 428 429 430
		$models = $this->dataProvider->getModels();
		$model = reset($models);
		if (is_array($model) || is_object($model)) {
			foreach ($model as $name => $value) {
Qiang Xue committed
431 432 433 434 435 436 437
				$this->columns[] = $name;
			}
		} else {
			throw new InvalidConfigException('Unable to generate columns from data.');
		}
	}
}