LinkSorter.php 1.71 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 30 31 32
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;
	/**
	 * @var array HTML attributes for the sorter container tag.
	 */
33 34 35 36 37 38
	public $options = array('class' => 'sorter');
	/**
	 * @var string the template used to render the content within the sorter container.
	 * The token "{links}" will be replaced with the actual sort links.
	 */
	public $template;
Qiang Xue committed
39 40 41 42 43 44 45 46 47

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

		if ($this->template === null) {
			$this->template = '<label>' . Yii::t('yii', 'Sort by:') . '</label> {links}';
		}
Qiang Xue committed
52 53 54 55 56 57 58
	}

	/**
	 * Executes the widget.
	 * This method renders the sort links.
	 */
	public function run()
59 60 61 62 63 64 65 66 67 68 69 70
	{
		$links = strtr($this->template, array(
			'{links}' => $this->renderSortLinks(),
		));
		echo Html::tag('div', $links, $this->options);
	}

	/**
	 * Renders the sort links.
	 * @return string the rendering result
	 */
	protected function renderSortLinks()
Qiang Xue committed
71 72 73 74 75
	{
		$links = array();
		foreach (array_keys($this->sort->attributes) as $name) {
			$links[] = $this->sort->link($name);
		}
76
		return Html::ul($links, array('encode' => false));
Qiang Xue committed
77 78
	}
}