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

namespace yii\widgets;

10
use Yii;
Qiang Xue committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\data\Sort;
use yii\helpers\Html;

/**
 * LinkSorter renders a list of sort links for the given sort definition.
 *
 * LinkSorter will generate a hyperlink for every attribute declared in [[sort]].
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class LinkSorter extends Widget
{
	/**
	 * @var Sort the sort definition
	 */
	public $sort;
30 31 32 33 34
	/**
	 * @var array list of the attributes that support sorting. If not set, it will be determined
	 * using [[Sort::attributes]].
	 */
	public $attributes;
Qiang Xue committed
35 36 37
	/**
	 * @var array HTML attributes for the sorter container tag.
	 */
Alexander Makarov committed
38
	public $options = ['class' => 'sorter'];
39

Qiang Xue committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

	/**
	 * Initializes the sorter.
	 */
	public function init()
	{
		if ($this->sort === null) {
			throw new InvalidConfigException('The "sort" property must be set.');
		}
	}

	/**
	 * Executes the widget.
	 * This method renders the sort links.
	 */
	public function run()
56
	{
57
		echo $this->renderSortLinks();
58 59 60 61 62 63 64
	}

	/**
	 * Renders the sort links.
	 * @return string the rendering result
	 */
	protected function renderSortLinks()
Qiang Xue committed
65
	{
66
		$attributes = empty($this->atttributes) ? array_keys($this->sort->attributes) : $this->attributes;
Alexander Makarov committed
67
		$links = [];
68
		foreach ($attributes as $name) {
Qiang Xue committed
69 70
			$links[] = $this->sort->link($name);
		}
Alexander Makarov committed
71
		return Html::ul($links, ['encode' => false]);
Qiang Xue committed
72 73
	}
}