Sortable.php 2.78 KB
Newer Older
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\jui;

Alexander Kochetov committed
10 11
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;
12 13 14
use yii\helpers\Html;

/**
Alexander Kochetov committed
15
 * Sortable renders a sortable jQuery UI widget.
16 17 18 19
 *
 * For example:
 *
 * ```php
Alexander Makarov committed
20 21
 * echo Sortable::widget([
 *     'items' => [
Alexander Kochetov committed
22
 *         'Item 1',
Alexander Makarov committed
23 24
 *         ['content' => 'Item2'],
 *         [
25
 *             'content' => 'Item3',
Alexander Makarov committed
26 27 28 29 30 31
 *             'options' => ['tag' => 'li'],
 *         ],
 *     ],
 *     'options' => ['tag' => 'ul'],
 *     'itemOptions' => ['tag' => 'li'],
 *     'clientOptions' => ['cursor' => 'move'],
32 33 34 35 36 37 38 39 40
 * ));
 * ```
 *
 * @see http://api.jqueryui.com/sortable/
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
class Sortable extends Widget
{
Alexander Kochetov committed
41
	/**
Qiang Xue committed
42 43 44 45
	 * @var array the HTML attributes for the widget container tag. The following special options are recognized:
	 *
	 * - tag: string, defaults to "ul", the tag name of the container tag of this widget
	 */
Alexander Makarov committed
46
	public $options = [];
Qiang Xue committed
47 48 49 50 51
	/**
	 * @var array list of sortable items. Each item can be a string representing the item content
	 * or an array of the following structure:
	 *
	 * ~~~
Alexander Makarov committed
52
	 * [
Qiang Xue committed
53 54
	 *     'content' => 'item content',
	 *     // the HTML attributes of the item container tag. This will overwrite "itemOptions".
Alexander Makarov committed
55 56
	 *     'options' => [],
	 * ]
Qiang Xue committed
57
	 * ~~~
Alexander Kochetov committed
58
	 */
Alexander Makarov committed
59
	public $items = [];
Alexander Kochetov committed
60
	/**
Qiang Xue committed
61 62 63 64
	 * @var array list of HTML attributes for the item container tags. This will be overwritten
	 * by the "options" set in individual [[items]]. The following special options are recognized:
	 *
	 * - tag: string, defaults to "li", the tag name of the item container tags.
Alexander Kochetov committed
65
	 */
Alexander Makarov committed
66
	public $itemOptions = [];
Alexander Kochetov committed
67 68


69
	/**
70
	 * Renders the widget.
71
	 */
72
	public function run()
73 74
	{
		$options = $this->options;
Alexander Kochetov committed
75
		$tag = ArrayHelper::remove($options, 'tag', 'ul');
76
		echo Html::beginTag($tag, $options) . "\n";
Alexander Kochetov committed
77
		echo $this->renderItems() . "\n";
Alexander Kochetov committed
78
		echo Html::endTag($tag) . "\n";
Qiang Xue committed
79
		$this->registerWidget('sortable', SortableAsset::className());
80
	}
Alexander Kochetov committed
81 82 83

	/**
	 * Renders sortable items as specified on [[items]].
Alexander Kochetov committed
84 85
	 * @return string the rendering result.
	 * @throws InvalidConfigException.
Alexander Kochetov committed
86 87 88
	 */
	public function renderItems()
	{
Alexander Makarov committed
89
		$items = [];
Alexander Kochetov committed
90 91 92 93 94 95 96
		foreach ($this->items as $item) {
			$options = $this->itemOptions;
			$tag = ArrayHelper::remove($options, 'tag', 'li');
			if (is_array($item)) {
				if (!isset($item['content'])) {
					throw new InvalidConfigException("The 'content' option is required.");
				}
Alexander Makarov committed
97
				$options = array_merge($options, ArrayHelper::getValue($item, 'options', []));
Alexander Kochetov committed
98
				$tag = ArrayHelper::remove($options, 'tag', $tag);
Alexander Kochetov committed
99 100 101 102 103 104
				$items[] = Html::tag($tag, $item['content'], $options);
			} else {
				$items[] = Html::tag($tag, $item, $options);
			}
		}
		return implode("\n", $items);
Alexander Kochetov committed
105
	}
106
}