Merge pull request #355 from creocoder/jqueryui-widgets

[WIP] jQuery UI widgets

framework/yii/jui/AutoComplete.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\jui;
+
+use Yii;
+use yii\base\InvalidConfigException;
+use yii\base\Model;
+use yii\helpers\Html;
+
+/**
+ * AutoComplete renders an autocomplete jQuery UI widget.
+ *
+ * For example:
+ *
+ * ```php
+ * echo AutoComplete::widget(array(
+ *     'model' => $model,
+ *     'attribute' => 'country',
+ *     'clientOptions' => array(
+ *         'source' => array('USA', 'RUS'),
+ *     ),
+ * ));
+ * ```
+ *
+ * The following example will use the name property instead:
+ *
+ * ```php
+ * echo AutoComplete::widget(array(
+ *     'name'  => 'country',
+ *     'clientOptions' => array(
+ *         'source' => array('USA', 'RUS'),
+ *     ),
+ * ));
+ *```
+ *
+ * @see http://api.jqueryui.com/autocomplete/
+ * @author Alexander Kochetov <creocoder@gmail.com>
+ * @since 2.0
+ */
+class AutoComplete extends Widget
+{
+	/**
+	 * @var \yii\base\Model the data model that this widget is associated with.
+	 */
+	public $model;
+	/**
+	 * @var string the model attribute that this widget is associated with.
+	 */
+	public $attribute;
+	/**
+	 * @var string the input name. This must be set if [[model]] and [[attribute]] are not set.
+	 */
+	public $name;
+	/**
+	 * @var string the input value.
+	 */
+	public $value;
+
+
+	/**
+	 * Renders the widget.
+	 */
+	public function run()
+	{
+		echo $this->renderField();
+		$this->registerWidget('autocomplete');
+	}
+
+	/**
+	 * Renders the AutoComplete field. If [[model]] has been specified then it will render an active field.
+	 * If [[model]] is null or not from an [[Model]] instance, then the field will be rendered according to
+	 * the [[name]] attribute.
+	 * @return string the rendering result.
+	 * @throws InvalidConfigException when none of the required attributes are set to render the textInput.
+	 * That is, if [[model]] and [[attribute]] are not set, then [[name]] is required.
+	 */
+	public function renderField()
+	{
+		if ($this->model instanceof Model && $this->attribute !== null) {
+			return Html::activeTextInput($this->model, $this->attribute, $this->options);
+		} elseif ($this->name !== null) {
+			return Html::textInput($this->name, $this->value, $this->options);
+		} else {
+			throw new InvalidConfigException("Either 'name' or 'model' and 'attribute' properties must be specified.");
+		}
+	}
+}

framework/yii/jui/Widget.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\jui;
+
+use Yii;
+use yii\base\View;
+use yii\helpers\Json;
+
+
+/**
+ * \yii\jui\Widget is the base class for all jQuery UI widgets.
+ *
+ * @author Alexander Kochetov <creocoder@gmail.com>
+ * @since 2.0
+ */
+class Widget extends \yii\base\Widget
+{
+	/**
+	 * @var string the jQuery UI theme bundle.
+	 */
+	public static $theme = 'yii/jui/theme/base';
+	/**
+	 * @var array the HTML attributes for the widget container tag.
+	 */
+	public $options = array();
+	/**
+	 * @var array the options for the underlying jQuery UI widget.
+	 * Please refer to the corresponding jQuery UI widget Web page for possible options.
+	 * For example, [this page](http://api.jqueryui.com/accordion/) shows
+	 * how to use the "Accordion" widget and the supported options (e.g. "header").
+	 */
+	public $clientOptions = array();
+	/**
+	 * @var array the event handlers for the underlying jQuery UI widget.
+	 * Please refer to the corresponding jQuery UI widget Web page for possible events.
+	 * For example, [this page](http://api.jqueryui.com/accordion/) shows
+	 * how to use the "Accordion" widget and the supported events (e.g. "create").
+	 */
+	public $clientEvents = array();
+
+
+	/**
+	 * Initializes the widget.
+	 * If you override this method, make sure you call the parent implementation first.
+	 */
+	public function init()
+	{
+		parent::init();
+		if (!isset($this->options['id'])) {
+			$this->options['id'] = $this->getId();
+		}
+	}
+
+	/**
+	 * Registers a specific jQuery UI widget and the related events
+	 * @param string $name the name of the jQuery UI widget
+	 */
+	protected function registerWidget($name)
+	{
+		$id = $this->options['id'];
+		$view = $this->getView();
+		$view->registerAssetBundle("yii/jui/$name");
+		$view->registerAssetBundle(static::$theme . "/$name");
+
+		if ($this->clientOptions !== false) {
+			$options = empty($this->clientOptions) ? '' : Json::encode($this->clientOptions);
+			$js = "jQuery('#$id').$name($options);";
+			$view->registerJs($js);
+		}
+
+		if (!empty($this->clientEvents)) {
+			$js = array();
+			foreach ($this->clientEvents as $event => $handler) {
+				$js[] = "jQuery('#$id').on('$name$event', $handler);";
+			}
+			$view->registerJs(implode("\n", $js));
+		}
+	}
+}