ActiveField.php 27.2 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */
namespace yii\widgets;

Qiang Xue committed
9
use Yii;
Qiang Xue committed
10
use yii\base\Component;
Qiang Xue committed
11
use yii\db\ActiveRecord;
Qiang Xue committed
12
use yii\helpers\ArrayHelper;
Qiang Xue committed
13
use yii\helpers\Html;
Qiang Xue committed
14
use yii\base\Model;
Qiang Xue committed
15
use yii\web\JsExpression;
Qiang Xue committed
16 17 18 19 20 21 22 23

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActiveField extends Component
{
	/**
Qiang Xue committed
24
	 * @var ActiveForm the form that this field is associated with.
Qiang Xue committed
25 26 27
	 */
	public $form;
	/**
Qiang Xue committed
28
	 * @var Model the data model that this field is associated with
Qiang Xue committed
29 30 31
	 */
	public $model;
	/**
Qiang Xue committed
32
	 * @var string the model attribute that this field is associated with
Qiang Xue committed
33 34 35
	 */
	public $attribute;
	/**
Qiang Xue committed
36 37 38
	 * @var array the HTML attributes (name-value pairs) for the field container tag.
	 * The values will be HTML-encoded using [[Html::encode()]].
	 * If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
39 40 41
	 * The following special options are recognized:
	 *
	 * - tag: the tag name of the container element. Defaults to "div".
Qiang Xue committed
42
	 */
Qiang Xue committed
43
	public $options = array(
44
		'class' => 'form-group',
Qiang Xue committed
45 46
	);
	/**
Qiang Xue committed
47 48
	 * @var string the template that is used to arrange the label, the input field, the error message and the hint text.
	 * The following tokens will be replaced when [[render()]] is called: `{label}`, `{input}`, `{error}` and `{hint}`.
Qiang Xue committed
49
	 */
Qiang Xue committed
50
	public $template = "{label}\n{input}\n{error}\n{hint}";
Qiang Xue committed
51
	/**
52 53 54
	 * @var array the default options for the input tags. The parameter passed to individual input methods
	 * (e.g. [[textInput()]]) will be merged with this property when rendering the input tag.
	 */
55
	public $inputOptions = array('class' => 'form-control');
56 57 58
	/**
	 * @var array the default options for the error tags. The parameter passed to [[error()]] will be
	 * merged with this property when rendering the error tag.
Qiang Xue committed
59 60 61
	 * The following special options are recognized:
	 *
	 * - tag: the tag name of the container element. Defaults to "div".
Qiang Xue committed
62
	 */
Qiang Xue committed
63
	public $errorOptions = array('class' => 'help-block');
Qiang Xue committed
64
	/**
65 66
	 * @var array the default options for the label tags. The parameter passed to [[label()]] will be
	 * merged with this property when rendering the label tag.
Qiang Xue committed
67 68
	 */
	public $labelOptions = array('class' => 'control-label');
Qiang Xue committed
69 70 71 72 73 74 75 76
	/**
	 * @var array the default options for the hint tags. The parameter passed to [[hint()]] will be
	 * merged with this property when rendering the hint tag.
	 * The following special options are recognized:
	 *
	 * - tag: the tag name of the container element. Defaults to "div".
	 */
	public $hintOptions = array('class' => 'hint-block');
Qiang Xue committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
	/**
	 * @var boolean whether to enable client-side data validation.
	 * If not set, it will take the value of [[ActiveForm::enableClientValidation]].
	 */
	public $enableClientValidation;
	/**
	 * @var boolean whether to enable AJAX-based data validation.
	 * If not set, it will take the value of [[ActiveForm::enableAjaxValidation]].
	 */
	public $enableAjaxValidation;
	/**
	 * @var boolean whether to perform validation when the input field loses focus and its value is found changed.
	 * If not set, it will take the value of [[ActiveForm::validateOnChange]].
	 */
	public $validateOnChange;
	/**
	 * @var boolean whether to perform validation while the user is typing in the input field.
	 * If not set, it will take the value of [[ActiveForm::validateOnType]].
	 * @see validationDelay
	 */
	public $validateOnType;
	/**
Qiang Xue committed
99 100
	 * @var integer number of milliseconds that the validation should be delayed when the input field
	 * is changed or the user types in the field.
Qiang Xue committed
101 102 103 104 105 106 107 108
	 * If not set, it will take the value of [[ActiveForm::validationDelay]].
	 */
	public $validationDelay;
	/**
	 * @var array the jQuery selectors for selecting the container, input and error tags.
	 * The array keys should be "container", "input", and/or "error", and the array values
	 * are the corresponding selectors. For example, `array('input' => '#my-input')`.
	 *
Qiang Xue committed
109 110
	 * The container selector is used under the context of the form, while the input and the error
	 * selectors are used under the context of the container.
Qiang Xue committed
111 112 113 114
	 *
	 * You normally do not need to set this property as the default selectors should work well for most cases.
	 */
	public $selectors;
Qiang Xue committed
115 116 117 118 119 120 121 122
	/**
	 * @var array different parts of the field (e.g. input, label). This will be used together with
	 * [[template]] to generate the final field HTML code. The keys are the token names in [[template]],
	 * while the values are the corresponding HTML code. Valid tokens include `{input}`, `{label}`,
	 * `{error}`, and `{error}`. Note that you normally don't need to access this property directly as
	 * it is maintained by various methods of this class.
	 */
	public $parts = array();
Qiang Xue committed
123

Qiang Xue committed
124

Qiang Xue committed
125 126 127 128 129 130
	/**
	 * PHP magic method that returns the string representation of this object.
	 * @return string the string representation of this object.
	 */
	public function __toString()
	{
131 132 133 134 135 136 137 138
		// __toString cannot throw exception
		// use trigger_error to bypass this limitation
		try {
			return $this->render();
		} catch (\Exception $e) {
			trigger_error($e->getMessage());
			return '';
		}
Qiang Xue committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
	}

	/**
	 * Renders the whole field.
	 * This method will generate the label, error tag, input tag and hint tag (if any), and
	 * assemble them into HTML according to [[template]].
	 * @param string|callable $content the content within the field container.
	 * If null (not set), the default methods will be called to generate the label, error tag and input tag,
	 * and use them as the content.
	 * If a callable, it will be called to generate the content. The signature of the callable should be:
	 *
	 * ~~~
	 * function ($field) {
	 *     return $html;
	 * }
	 * ~~~
	 *
	 * @return string the rendering result
	 */
	public function render($content = null)
	{
		if ($content === null) {
			if (!isset($this->parts['{input}'])) {
				$this->parts['{input}'] = Html::activeTextInput($this->model, $this->attribute, $this->inputOptions);
			}
			if (!isset($this->parts['{label}'])) {
				$this->parts['{label}'] = Html::activeLabel($this->model, $this->attribute, $this->labelOptions);
			}
			if (!isset($this->parts['{error}'])) {
				$this->parts['{error}'] = Html::error($this->model, $this->attribute, $this->errorOptions);
			}
			if (!isset($this->parts['{hint}'])) {
				$this->parts['{hint}'] = '';
			}
			$content = strtr($this->template, $this->parts);
		} elseif (!is_string($content)) {
			$content = call_user_func($content, $this);
		}
		return $this->begin() . "\n" . $content . "\n" . $this->end();
	}

Qiang Xue committed
180 181 182 183
	/**
	 * Renders the opening tag of the field container.
	 * @return string the rendering result.
	 */
Qiang Xue committed
184 185
	public function begin()
	{
Qiang Xue committed
186 187 188
		$clientOptions = $this->getClientOptions();
		if (!empty($clientOptions)) {
			$this->form->attributes[$this->attribute] = $clientOptions;
Qiang Xue committed
189 190
		}

Qiang Xue committed
191 192
		$inputID = Html::getInputId($this->model, $this->attribute);
		$attribute = Html::getAttributeName($this->attribute);
Qiang Xue committed
193
		$options = $this->options;
Qiang Xue committed
194
		$class = isset($options['class']) ? array($options['class']) : array();
Qiang Xue committed
195 196
		$class[] = "field-$inputID";
		if ($this->model->isAttributeRequired($attribute)) {
Qiang Xue committed
197
			$class[] = $this->form->requiredCssClass;
Qiang Xue committed
198
		}
Qiang Xue committed
199
		if ($this->model->hasErrors($attribute)) {
Qiang Xue committed
200
			$class[] = $this->form->errorCssClass;
Qiang Xue committed
201
		}
Qiang Xue committed
202
		$options['class'] = implode(' ', $class);
Qiang Xue committed
203
		$tag = ArrayHelper::remove($options, 'tag', 'div');
Qiang Xue committed
204

Qiang Xue committed
205
		return Html::beginTag($tag, $options);
Qiang Xue committed
206
	}
207

Qiang Xue committed
208 209 210 211
	/**
	 * Renders the closing tag of the field container.
	 * @return string the rendering result.
	 */
Qiang Xue committed
212 213
	public function end()
	{
Qiang Xue committed
214
		return Html::endTag(isset($this->options['tag']) ? $this->options['tag'] : 'div');
Qiang Xue committed
215 216
	}

Qiang Xue committed
217 218 219
	/**
	 * Generates a label tag for [[attribute]].
	 * The label text is the label associated with the attribute, obtained via [[Model::getAttributeLabel()]].
220
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[labelOptions]].
Qiang Xue committed
221
	 * The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
Qiang Xue committed
222
	 * using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
223 224 225 226 227 228 229
	 *
	 * The following options are specially handled:
	 *
	 * - label: this specifies the label to be displayed. Note that this will NOT be [[encoded()]].
	 *   If this is not set, [[Model::getAttributeLabel()]] will be called to get the label for display
	 *   (after encoding).
	 *
Qiang Xue committed
230
	 * @return ActiveField the field object itself
Qiang Xue committed
231
	 */
232
	public function label($options = array())
Qiang Xue committed
233
	{
234
		$options = array_merge($this->labelOptions, $options);
Qiang Xue committed
235 236
		$this->parts['{label}'] = Html::activeLabel($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
237 238
	}

Qiang Xue committed
239 240
	/**
	 * Generates a tag that contains the first validation error of [[attribute]].
Qiang Xue committed
241
	 * Note that even if there is no validation error, this method will still return an empty error tag.
242
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[errorOptions]].
Qiang Xue committed
243
	 * The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
Qiang Xue committed
244
	 * using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
245 246 247
	 *
	 * The following options are specially handled:
	 *
Qiang Xue committed
248
	 * - tag: this specifies the tag name. If not set, "div" will be used.
Qiang Xue committed
249
	 *
Qiang Xue committed
250
	 * @return ActiveField the field object itself
Qiang Xue committed
251
	 */
252
	public function error($options = array())
Qiang Xue committed
253
	{
254
		$options = array_merge($this->errorOptions, $options);
Qiang Xue committed
255 256
		$this->parts['{error}'] = Html::error($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
257 258
	}

Qiang Xue committed
259
	/**
Qiang Xue committed
260 261 262 263 264 265 266 267 268 269
	 * Renders the hint tag.
	 * @param string $content the hint content. It will NOT be HTML-encoded.
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
	 * the attributes of the hint tag. The values will be HTML-encoded using [[Html::encode()]].
	 *
	 * The following options are specially handled:
	 *
	 * - tag: this specifies the tag name. If not set, "div" will be used.
	 *
	 * @return ActiveField the field object itself
Qiang Xue committed
270
	 */
Qiang Xue committed
271
	public function hint($content, $options = array())
Qiang Xue committed
272
	{
Qiang Xue committed
273 274 275 276
		$options = array_merge($this->hintOptions, $options);
		$tag = ArrayHelper::remove($options, 'tag', 'div');
		$this->parts['{hint}'] = Html::tag($tag, $content, $options);
		return $this;
Qiang Xue committed
277 278 279
	}

	/**
Qiang Xue committed
280
	 * Renders an input tag.
Qiang Xue committed
281 282
	 * @param string $type the input type (e.g. 'text', 'password')
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
Qiang Xue committed
283 284
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
	 * @return ActiveField the field object itself
Qiang Xue committed
285 286 287
	 */
	public function input($type, $options = array())
	{
288
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
289 290
		$this->parts['{input}'] = Html::activeInput($type, $this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
291 292 293
	}

	/**
Qiang Xue committed
294
	 * Renders a text input.
Qiang Xue committed
295 296 297
	 * This method will generate the "name" and "value" tag attributes automatically for the model attribute
	 * unless they are explicitly specified in `$options`.
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
Qiang Xue committed
298 299
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
	 * @return ActiveField the field object itself
Qiang Xue committed
300 301 302
	 */
	public function textInput($options = array())
	{
303
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
304 305
		$this->parts['{input}'] = Html::activeTextInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
306 307 308
	}

	/**
Qiang Xue committed
309
	 * Renders a password input.
Qiang Xue committed
310 311 312
	 * This method will generate the "name" and "value" tag attributes automatically for the model attribute
	 * unless they are explicitly specified in `$options`.
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
Qiang Xue committed
313 314
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
	 * @return ActiveField the field object itself
Qiang Xue committed
315 316 317
	 */
	public function passwordInput($options = array())
	{
318
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
319 320
		$this->parts['{input}'] = Html::activePasswordInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
321 322 323
	}

	/**
Qiang Xue committed
324
	 * Renders a file input.
Qiang Xue committed
325 326 327
	 * This method will generate the "name" and "value" tag attributes automatically for the model attribute
	 * unless they are explicitly specified in `$options`.
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
Qiang Xue committed
328 329
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
	 * @return ActiveField the field object itself
Qiang Xue committed
330 331 332
	 */
	public function fileInput($options = array())
	{
333 334 335
		if ($this->inputOptions !== array('class' => 'form-control')) {
			$options = array_merge($this->inputOptions, $options);
		}
Qiang Xue committed
336 337
		$this->parts['{input}'] = Html::activeFileInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
338 339 340
	}

	/**
Qiang Xue committed
341
	 * Renders a text area.
Qiang Xue committed
342 343
	 * The model attribute value will be used as the content in the textarea.
	 * @param array $options the tag options in terms of name-value pairs. These will be rendered as
Qiang Xue committed
344 345
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
	 * @return ActiveField the field object itself
Qiang Xue committed
346 347 348
	 */
	public function textarea($options = array())
	{
349
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
350 351
		$this->parts['{input}'] = Html::activeTextarea($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
352 353 354
	}

	/**
Qiang Xue committed
355
	 * Renders a radio button.
Qiang Xue committed
356 357 358 359 360 361 362
	 * This method will generate the "checked" tag attribute according to the model attribute value.
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
	 *
	 * - uncheck: string, the value associated with the uncheck state of the radio button. If not set,
	 *   it will take the default value '0'. This method will render a hidden input so that if the radio button
	 *   is not checked and is submitted, the value of this attribute will still be submitted to the server
	 *   via the hidden input.
363
	 * - label: string, a label displayed next to the radio button.  It will NOT be HTML-encoded. Therefore you can pass
Qiang Xue committed
364
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[Html::encode()]] it to prevent XSS attacks.
365 366
	 *   When this option is specified, the radio button will be enclosed by a label tag.
	 * - labelOptions: array, the HTML attributes for the label tag. This is only used when the "label" option is specified.
Qiang Xue committed
367 368
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
369
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
370 371 372
	 * @param boolean $enclosedByLabel whether to enclose the radio within the label.
	 * If true, the method will still use [[template]] to layout the checkbox and the error message
	 * except that the radio is enclosed by the label tag.
Qiang Xue committed
373
	 * @return ActiveField the field object itself
Qiang Xue committed
374
	 */
Qiang Xue committed
375
	public function radio($options = array(), $enclosedByLabel = true)
Qiang Xue committed
376
	{
377
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
378
		if ($enclosedByLabel) {
379 380
			if (!isset($options['label'])) {
				$options['label'] = Html::encode($this->model->getAttributeLabel($this->attribute));
Qiang Xue committed
381
			}
Qiang Xue committed
382 383
			$this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
			$this->parts['{label}'] = '';
Qiang Xue committed
384
		} else {
Qiang Xue committed
385
			$this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
Qiang Xue committed
386
		}
Qiang Xue committed
387
		return $this;
Qiang Xue committed
388 389 390
	}

	/**
Qiang Xue committed
391
	 * Renders a checkbox.
Qiang Xue committed
392 393 394 395 396 397 398
	 * This method will generate the "checked" tag attribute according to the model attribute value.
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
	 *
	 * - uncheck: string, the value associated with the uncheck state of the radio button. If not set,
	 *   it will take the default value '0'. This method will render a hidden input so that if the radio button
	 *   is not checked and is submitted, the value of this attribute will still be submitted to the server
	 *   via the hidden input.
399
	 * - label: string, a label displayed next to the checkbox.  It will NOT be HTML-encoded. Therefore you can pass
Qiang Xue committed
400
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[Html::encode()]] it to prevent XSS attacks.
401 402
	 *   When this option is specified, the checkbox will be enclosed by a label tag.
	 * - labelOptions: array, the HTML attributes for the label tag. This is only used when the "label" option is specified.
Qiang Xue committed
403 404
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
405
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
406 407 408
	 * @param boolean $enclosedByLabel whether to enclose the checkbox within the label.
	 * If true, the method will still use [[template]] to layout the checkbox and the error message
	 * except that the checkbox is enclosed by the label tag.
Qiang Xue committed
409
	 * @return ActiveField the field object itself
Qiang Xue committed
410
	 */
Qiang Xue committed
411
	public function checkbox($options = array(), $enclosedByLabel = true)
Qiang Xue committed
412
	{
Qiang Xue committed
413
		if ($enclosedByLabel) {
414 415
			if (!isset($options['label'])) {
				$options['label'] = Html::encode($this->model->getAttributeLabel($this->attribute));
Qiang Xue committed
416
			}
Qiang Xue committed
417 418
			$this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
			$this->parts['{label}'] = '';
Qiang Xue committed
419
		} else {
Qiang Xue committed
420
			$this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
Qiang Xue committed
421
		}
Qiang Xue committed
422
		return $this;
Qiang Xue committed
423 424 425
	}

	/**
Qiang Xue committed
426
	 * Renders a drop-down list.
Qiang Xue committed
427 428 429 430 431
	 * The selection of the drop-down list is taken from the value of the model attribute.
	 * @param array $items the option data items. The array keys are option values, and the array values
	 * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too).
	 * For each sub-array, an option group will be generated whose label is the key associated with the sub-array.
	 * If you have a list of data models, you may convert them into the format described above using
Qiang Xue committed
432
	 * [[ArrayHelper::map()]].
Qiang Xue committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
	 *
	 * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in
	 * the labels will also be HTML-encoded.
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
	 *
	 * - prompt: string, a prompt text to be displayed as the first option;
	 * - options: array, the attributes for the select option tags. The array keys must be valid option values,
	 *   and the array values are the extra attributes for the corresponding option tags. For example,
	 *
	 * ~~~
	 * array(
	 *     'value1' => array('disabled' => true),
	 *     'value2' => array('label' => 'value 2'),
	 * );
	 * ~~~
	 *
	 * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
	 *   except that the array keys represent the optgroup labels specified in $items.
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
453
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
454
	 *
Qiang Xue committed
455
	 * @return ActiveField the field object itself
Qiang Xue committed
456
	 */
Qiang Xue committed
457
	public function dropDownList($items, $options = array())
Qiang Xue committed
458
	{
459
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
460 461
		$this->parts['{input}'] = Html::activeDropDownList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
462 463 464
	}

	/**
Qiang Xue committed
465
	 * Renders a list box.
Qiang Xue committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
	 * The selection of the list box is taken from the value of the model attribute.
	 * @param array $items the option data items. The array keys are option values, and the array values
	 * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too).
	 * For each sub-array, an option group will be generated whose label is the key associated with the sub-array.
	 * If you have a list of data models, you may convert them into the format described above using
	 * [[\yii\helpers\ArrayHelper::map()]].
	 *
	 * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in
	 * the labels will also be HTML-encoded.
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
	 *
	 * - prompt: string, a prompt text to be displayed as the first option;
	 * - options: array, the attributes for the select option tags. The array keys must be valid option values,
	 *   and the array values are the extra attributes for the corresponding option tags. For example,
	 *
	 * ~~~
	 * array(
	 *     'value1' => array('disabled' => true),
	 *     'value2' => array('label' => 'value 2'),
	 * );
	 * ~~~
	 *
	 * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
	 *   except that the array keys represent the optgroup labels specified in $items.
	 * - unselect: string, the value that will be submitted when no option is selected.
	 *   When this attribute is set, a hidden field will be generated so that if no option is selected in multiple
	 *   mode, we can still obtain the posted unselect value.
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
495
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
496
	 *
Qiang Xue committed
497
	 * @return ActiveField the field object itself
Qiang Xue committed
498 499 500
	 */
	public function listBox($items, $options = array())
	{
501
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
502 503
		$this->parts['{input}'] = Html::activeListBox($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
504 505 506
	}

	/**
Qiang Xue committed
507
	 * Renders a list of checkboxes.
Qiang Xue committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
	 * A checkbox list allows multiple selection, like [[listBox()]].
	 * As a result, the corresponding submitted value is an array.
	 * The selection of the checkbox list is taken from the value of the model attribute.
	 * @param array $items the data item used to generate the checkboxes.
	 * The array keys are the labels, while the array values are the corresponding checkbox values.
	 * Note that the labels will NOT be HTML-encoded, while the values will.
	 * @param array $options options (name => config) for the checkbox list. The following options are specially handled:
	 *
	 * - unselect: string, the value that should be submitted when none of the checkboxes is selected.
	 *   By setting this option, a hidden input will be generated.
	 * - separator: string, the HTML code that separates items.
	 * - item: callable, a callback that can be used to customize the generation of the HTML code
	 *   corresponding to a single item in $items. The signature of this callback must be:
	 *
	 * ~~~
	 * function ($index, $label, $name, $checked, $value)
	 * ~~~
	 *
	 * where $index is the zero-based index of the checkbox in the whole list; $label
	 * is the label for the checkbox; and $name, $value and $checked represent the name,
	 * value and the checked status of the checkbox input.
Qiang Xue committed
529
	 * @return ActiveField the field object itself
Qiang Xue committed
530 531 532
	 */
	public function checkboxList($items, $options = array())
	{
Qiang Xue committed
533 534
		$this->parts['{input}'] = Html::activeCheckboxList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
535 536 537
	}

	/**
Qiang Xue committed
538
	 * Renders a list of radio buttons.
Qiang Xue committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
	 * A radio button list is like a checkbox list, except that it only allows single selection.
	 * The selection of the radio buttons is taken from the value of the model attribute.
	 * @param array $items the data item used to generate the radio buttons.
	 * The array keys are the labels, while the array values are the corresponding radio button values.
	 * Note that the labels will NOT be HTML-encoded, while the values will.
	 * @param array $options options (name => config) for the radio button list. The following options are specially handled:
	 *
	 * - unselect: string, the value that should be submitted when none of the radio buttons is selected.
	 *   By setting this option, a hidden input will be generated.
	 * - separator: string, the HTML code that separates items.
	 * - item: callable, a callback that can be used to customize the generation of the HTML code
	 *   corresponding to a single item in $items. The signature of this callback must be:
	 *
	 * ~~~
	 * function ($index, $label, $name, $checked, $value)
	 * ~~~
	 *
	 * where $index is the zero-based index of the radio button in the whole list; $label
	 * is the label for the radio button; and $name, $value and $checked represent the name,
	 * value and the checked status of the radio button input.
Qiang Xue committed
559
	 * @return ActiveField the field object itself
Qiang Xue committed
560 561 562
	 */
	public function radioList($items, $options = array())
	{
Qiang Xue committed
563 564
		$this->parts['{input}'] = Html::activeRadioList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
565
	}
Qiang Xue committed
566 567

	/**
Qiang Xue committed
568
	 * Renders a widget as the input of the field.
569 570 571 572 573 574 575
	 *
	 * Note that the widget must have both `model` and `attribute` properties. They will
	 * be initialized with [[model]] and [[attribute]] of this field, respectively.
	 *
	 * If you want to use a widget that does not have `model` and `attribute` properties,
	 * please use [[render()]] instead.
	 *
Qiang Xue committed
576 577
	 * @param string $class the widget class name
	 * @param array $config name-value pairs that will be used to initialize the widget
Qiang Xue committed
578
	 * @return ActiveField the field object itself
Qiang Xue committed
579 580 581 582
	 */
	public function widget($class, $config = array())
	{
		/** @var \yii\base\Widget $class */
583 584 585
		$config['model'] = $this->model;
		$config['attribute'] = $this->attribute;
		$config['view'] = $this->form->getView();
Qiang Xue committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
		$this->parts['{input}'] = $class::widget($config);
		return $this;
	}

	/**
	 * Returns the JS options for the field.
	 * @return array the JS options
	 */
	protected function getClientOptions()
	{
		$enableClientValidation = $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
		if ($enableClientValidation) {
			$attribute = Html::getAttributeName($this->attribute);
			$validators = array();
			foreach ($this->model->getActiveValidators($attribute) as $validator) {
				/** @var \yii\validators\Validator $validator */
				$js = $validator->clientValidateAttribute($this->model, $attribute, $this->form->getView());
				if ($validator->enableClientValidation && $js != '') {
					$validators[] = $js;
				}
			}
			if (!empty($validators)) {
				$options['validate'] = new JsExpression("function(attribute, value, messages) {" . implode('', $validators) . '}');
			}
		}

		$enableAjaxValidation = $this->enableAjaxValidation || $this->enableAjaxValidation === null && $this->form->enableAjaxValidation;
		if ($enableAjaxValidation) {
			$options['enableAjaxValidation'] = 1;
		}

		if ($enableClientValidation && !empty($options['validate']) || $enableAjaxValidation) {
			$inputID = Html::getInputId($this->model, $this->attribute);
			$options['name'] = $inputID;
			foreach (array('validateOnChange', 'validateOnType', 'validationDelay') as $name) {
				$options[$name] = $this->$name === null ? $this->form->$name : $this->$name;
			}
			$options['container'] = isset($this->selectors['container']) ? $this->selectors['container'] : ".field-$inputID";
			$options['input'] = isset($this->selectors['input']) ? $this->selectors['input'] : "#$inputID";
			if (isset($this->errorOptions['class'])) {
				$options['error'] = '.' . implode('.', preg_split('/\s+/', $this->errorOptions['class'], -1, PREG_SPLIT_NO_EMPTY));
			} else {
				$options['error'] = isset($this->errorOptions['tag']) ? $this->errorOptions['tag'] : 'div';
			}
			return $options;
		} else {
			return array();
		}
Qiang Xue committed
634
	}
Zander Baldwin committed
635
}