Selectable.php 3.13 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\jui;

use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;

/**
 * Selectable renders a selectable jQuery UI widget.
 *
 * For example:
 *
 * ```php
Alexander Makarov committed
20 21
 * echo Selectable::widget([
 *     'items' => [
22
 *         'Item 1',
Alexander Makarov committed
23
 *         [
24
 *             'content' => 'Item2',
Alexander Makarov committed
25 26
 *         ],
 *         [
27
 *             'content' => 'Item3',
Alexander Makarov committed
28
 *             'options' => [
29
 *                 'tag' => 'li',
Alexander Makarov committed
30 31
 *             ],
 *         ],
32
 *     ),
Alexander Makarov committed
33
 *     'options' => [
34
 *         'tag' => 'ul',
Alexander Makarov committed
35 36
 *     ],
 *     'itemOptions' => [
37
 *         'tag' => 'li',
Alexander Makarov committed
38 39
 *     ],
 *     'clientOptions' => [
40
 *         'tolerance' => 'fit',
Alexander Makarov committed
41 42
 *     ],
 * ]);
43 44 45 46 47 48 49 50 51 52 53
 * ```
 *
 * @see http://api.jqueryui.com/selectable/
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
class Selectable extends Widget
{
	/**
	 * @var array the HTML attributes for the widget container tag. The following special options are recognized:
	 *
54 55
	 * - tag: string, defaults to "ul", the tag name of the container tag of this widget.
	 *
56
	 * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
57
	 */
Alexander Makarov committed
58
	public $options = [];
59 60 61 62 63
	/**
	 * @var array list of selectable items. Each item can be a string representing the item content
	 * or an array of the following structure:
	 *
	 * ~~~
Alexander Makarov committed
64
	 * [
65 66
	 *     'content' => 'item content',
	 *     // the HTML attributes of the item container tag. This will overwrite "itemOptions".
Alexander Makarov committed
67 68
	 *     'options' => [],
	 * ]
69 70
	 * ~~~
	 */
Alexander Makarov committed
71
	public $items = [];
72 73 74 75 76
	/**
	 * @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.
77
	 *
78
	 * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
79
	 */
Alexander Makarov committed
80
	public $itemOptions = [];
81 82 83 84 85 86 87 88 89 90 91 92


	/**
	 * Renders the widget.
	 */
	public function run()
	{
		$options = $this->options;
		$tag = ArrayHelper::remove($options, 'tag', 'ul');
		echo Html::beginTag($tag, $options) . "\n";
		echo $this->renderItems() . "\n";
		echo Html::endTag($tag) . "\n";
Qiang Xue committed
93
		$this->registerWidget('selectable', SelectableAsset::className());
94 95 96 97 98 99 100 101 102
	}

	/**
	 * Renders selectable items as specified on [[items]].
	 * @return string the rendering result.
	 * @throws InvalidConfigException.
	 */
	public function renderItems()
	{
Alexander Makarov committed
103
		$items = [];
104 105 106 107 108 109 110
		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
111
				$options = array_merge($options, ArrayHelper::getValue($item, 'options', []));
112 113 114 115 116 117 118 119 120
				$tag = ArrayHelper::remove($options, 'tag', $tag);
				$items[] = Html::tag($tag, $item['content'], $options);
			} else {
				$items[] = Html::tag($tag, $item, $options);
			}
		}
		return implode("\n", $items);
	}
}