ActiveField.php 26.8 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\helpers\ArrayHelper;
Qiang Xue committed
12
use yii\helpers\Html;
Qiang Xue committed
13
use yii\base\Model;
Qiang Xue committed
14
use yii\web\JsExpression;
Qiang Xue committed
15 16 17 18 19 20 21 22

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActiveField extends Component
{
	/**
Qiang Xue committed
23
	 * @var ActiveForm the form that this field is associated with.
Qiang Xue committed
24 25 26
	 */
	public $form;
	/**
Qiang Xue committed
27
	 * @var Model the data model that this field is associated with
Qiang Xue committed
28 29 30
	 */
	public $model;
	/**
Qiang Xue committed
31
	 * @var string the model attribute that this field is associated with
Qiang Xue committed
32 33 34
	 */
	public $attribute;
	/**
Qiang Xue committed
35 36 37
	 * @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
38 39 40
	 * The following special options are recognized:
	 *
	 * - tag: the tag name of the container element. Defaults to "div".
Qiang Xue committed
41
	 */
Alexander Makarov committed
42
	public $options = ['class' => 'form-group'];
Qiang Xue committed
43
	/**
Qiang Xue committed
44 45
	 * @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
46
	 */
Qiang Xue committed
47
	public $template = "{label}\n{input}\n{error}\n{hint}";
Qiang Xue committed
48
	/**
49 50 51
	 * @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.
	 */
Alexander Makarov committed
52
	public $inputOptions = ['class' => 'form-control'];
53 54 55
	/**
	 * @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
56 57 58
	 * The following special options are recognized:
	 *
	 * - tag: the tag name of the container element. Defaults to "div".
Qiang Xue committed
59
	 */
Alexander Makarov committed
60
	public $errorOptions = ['class' => 'help-block'];
Qiang Xue committed
61
	/**
62 63
	 * @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
64
	 */
Alexander Makarov committed
65
	public $labelOptions = ['class' => 'control-label'];
Qiang Xue committed
66 67 68 69 70 71 72
	/**
	 * @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".
	 */
Alexander Makarov committed
73
	public $hintOptions = ['class' => 'hint-block'];
Qiang Xue committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
	/**
	 * @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
96 97
	 * @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
98 99 100 101 102 103
	 * 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
Alexander Makarov committed
104
	 * are the corresponding selectors. For example, `['input' => '#my-input']`.
Qiang Xue committed
105
	 *
Qiang Xue committed
106 107
	 * 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
108 109 110 111
	 *
	 * You normally do not need to set this property as the default selectors should work well for most cases.
	 */
	public $selectors;
Qiang Xue committed
112 113 114 115 116 117 118
	/**
	 * @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.
	 */
Alexander Makarov committed
119
	public $parts = [];
Qiang Xue committed
120

Qiang Xue committed
121

Qiang Xue committed
122 123 124 125 126 127
	/**
	 * PHP magic method that returns the string representation of this object.
	 * @return string the string representation of this object.
	 */
	public function __toString()
	{
128 129 130 131 132 133 134 135
		// __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
136 137 138 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
	}

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

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

Qiang Xue committed
202
		return Html::beginTag($tag, $options);
Qiang Xue committed
203
	}
204

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

Qiang Xue committed
214 215
	/**
	 * Generates a label tag for [[attribute]].
216 217
	 * @param string $label the label to use. If null, it will be generated via [[Model::getAttributeLabel()]].
	 * Note that this will NOT be [[Html::encode()|encoded]].
218
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[labelOptions]].
Qiang Xue committed
219
	 * The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
Qiang Xue committed
220
	 * using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
221
	 * @return static the field object itself
Qiang Xue committed
222
	 */
Alexander Makarov committed
223
	public function label($label = null, $options = [])
Qiang Xue committed
224
	{
225
		$options = array_merge($this->labelOptions, $options);
226 227 228
		if ($label !== null) {
			$options['label'] = $label;
		}
Qiang Xue committed
229 230
		$this->parts['{label}'] = Html::activeLabel($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
231 232
	}

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

Qiang Xue committed
253
	/**
Qiang Xue committed
254 255 256 257 258 259 260 261 262
	 * 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.
	 *
263
	 * @return static the field object itself
Qiang Xue committed
264
	 */
Alexander Makarov committed
265
	public function hint($content, $options = [])
Qiang Xue committed
266
	{
Qiang Xue committed
267 268 269 270
		$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
271 272 273
	}

	/**
Qiang Xue committed
274
	 * Renders an input tag.
Qiang Xue committed
275 276
	 * @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
277
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
278
	 * @return static the field object itself
Qiang Xue committed
279
	 */
Alexander Makarov committed
280
	public function input($type, $options = [])
Qiang Xue committed
281
	{
282
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
283 284
		$this->parts['{input}'] = Html::activeInput($type, $this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
285 286 287
	}

	/**
Qiang Xue committed
288
	 * Renders a text input.
Qiang Xue committed
289 290 291
	 * 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
292
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
293
	 * @return static the field object itself
Qiang Xue committed
294
	 */
Alexander Makarov committed
295
	public function textInput($options = [])
Qiang Xue committed
296
	{
297
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
298 299
		$this->parts['{input}'] = Html::activeTextInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
300 301 302
	}

	/**
Qiang Xue committed
303
	 * Renders a password input.
Qiang Xue committed
304 305 306
	 * 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
307
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
308
	 * @return static the field object itself
Qiang Xue committed
309
	 */
Alexander Makarov committed
310
	public function passwordInput($options = [])
Qiang Xue committed
311
	{
312
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
313 314
		$this->parts['{input}'] = Html::activePasswordInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
315 316 317
	}

	/**
Qiang Xue committed
318
	 * Renders a file input.
Qiang Xue committed
319 320 321
	 * 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
322
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
323
	 * @return static the field object itself
Qiang Xue committed
324
	 */
Alexander Makarov committed
325
	public function fileInput($options = [])
Qiang Xue committed
326
	{
Alexander Makarov committed
327
		if ($this->inputOptions !== ['class' => 'form-control']) {
328 329
			$options = array_merge($this->inputOptions, $options);
		}
Qiang Xue committed
330 331
		$this->parts['{input}'] = Html::activeFileInput($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
332 333 334
	}

	/**
Qiang Xue committed
335
	 * Renders a text area.
Qiang Xue committed
336 337
	 * 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
338
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[Html::encode()]].
339
	 * @return static the field object itself
Qiang Xue committed
340
	 */
Alexander Makarov committed
341
	public function textarea($options = [])
Qiang Xue committed
342
	{
343
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
344 345
		$this->parts['{input}'] = Html::activeTextarea($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
346 347 348
	}

	/**
Qiang Xue committed
349
	 * Renders a radio button.
Qiang Xue committed
350 351 352 353 354 355 356
	 * 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.
357
	 * - label: string, a label displayed next to the radio button.  It will NOT be HTML-encoded. Therefore you can pass
Qiang Xue committed
358
	 *   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.
359 360
	 *   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
361 362
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
363
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
364 365 366
	 * @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.
367
	 * @return static the field object itself
Qiang Xue committed
368
	 */
Alexander Makarov committed
369
	public function radio($options = [], $enclosedByLabel = true)
Qiang Xue committed
370
	{
Qiang Xue committed
371
		if ($enclosedByLabel) {
372 373
			if (!isset($options['label'])) {
				$options['label'] = Html::encode($this->model->getAttributeLabel($this->attribute));
Qiang Xue committed
374
			}
Qiang Xue committed
375 376
			$this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
			$this->parts['{label}'] = '';
Qiang Xue committed
377
		} else {
Qiang Xue committed
378
			$this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
Qiang Xue committed
379
		}
Qiang Xue committed
380
		return $this;
Qiang Xue committed
381 382 383
	}

	/**
Qiang Xue committed
384
	 * Renders a checkbox.
Qiang Xue committed
385 386 387 388 389 390 391
	 * 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.
392
	 * - label: string, a label displayed next to the checkbox.  It will NOT be HTML-encoded. Therefore you can pass
Qiang Xue committed
393
	 *   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.
394 395
	 *   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
396 397
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
398
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
399 400 401
	 * @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.
402
	 * @return static the field object itself
Qiang Xue committed
403
	 */
Alexander Makarov committed
404
	public function checkbox($options = [], $enclosedByLabel = true)
Qiang Xue committed
405
	{
Qiang Xue committed
406
		if ($enclosedByLabel) {
407 408
			if (!isset($options['label'])) {
				$options['label'] = Html::encode($this->model->getAttributeLabel($this->attribute));
Qiang Xue committed
409
			}
Qiang Xue committed
410 411
			$this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
			$this->parts['{label}'] = '';
Qiang Xue committed
412
		} else {
Qiang Xue committed
413
			$this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
Qiang Xue committed
414
		}
Qiang Xue committed
415
		return $this;
Qiang Xue committed
416 417 418
	}

	/**
Qiang Xue committed
419
	 * Renders a drop-down list.
Qiang Xue committed
420 421 422 423 424
	 * 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
425
	 * [[ArrayHelper::map()]].
Qiang Xue committed
426 427 428 429 430 431 432 433 434 435
	 *
	 * 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,
	 *
	 * ~~~
Alexander Makarov committed
436 437 438 439
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
440 441 442 443 444 445
	 * ~~~
	 *
	 * - 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
446
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
447
	 *
448
	 * @return static the field object itself
Qiang Xue committed
449
	 */
Alexander Makarov committed
450
	public function dropDownList($items, $options = [])
Qiang Xue committed
451
	{
452
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
453 454
		$this->parts['{input}'] = Html::activeDropDownList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
455 456 457
	}

	/**
Qiang Xue committed
458
	 * Renders a list box.
Qiang Xue committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
	 * 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,
	 *
	 * ~~~
Alexander Makarov committed
475 476 477 478
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
479 480 481 482 483 484 485 486 487
	 * ~~~
	 *
	 * - 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
488
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
489
	 *
490
	 * @return static the field object itself
Qiang Xue committed
491
	 */
Alexander Makarov committed
492
	public function listBox($items, $options = [])
Qiang Xue committed
493
	{
494
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
495 496
		$this->parts['{input}'] = Html::activeListBox($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
497 498 499
	}

	/**
Qiang Xue committed
500
	 * Renders a list of checkboxes.
Qiang Xue committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
	 * 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.
522
	 * @return static the field object itself
Qiang Xue committed
523
	 */
Alexander Makarov committed
524
	public function checkboxList($items, $options = [])
Qiang Xue committed
525
	{
Qiang Xue committed
526 527
		$this->parts['{input}'] = Html::activeCheckboxList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
528 529 530
	}

	/**
Qiang Xue committed
531
	 * Renders a list of radio buttons.
Qiang Xue committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
	 * 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.
552
	 * @return static the field object itself
Qiang Xue committed
553
	 */
Alexander Makarov committed
554
	public function radioList($items, $options = [])
Qiang Xue committed
555
	{
Qiang Xue committed
556 557
		$this->parts['{input}'] = Html::activeRadioList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
558
	}
Qiang Xue committed
559 560

	/**
Qiang Xue committed
561
	 * Renders a widget as the input of the field.
562 563 564 565 566 567 568
	 *
	 * 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
569 570
	 * @param string $class the widget class name
	 * @param array $config name-value pairs that will be used to initialize the widget
571
	 * @return static the field object itself
Qiang Xue committed
572
	 */
Alexander Makarov committed
573
	public function widget($class, $config = [])
Qiang Xue committed
574 575
	{
		/** @var \yii\base\Widget $class */
576 577 578
		$config['model'] = $this->model;
		$config['attribute'] = $this->attribute;
		$config['view'] = $this->form->getView();
Qiang Xue committed
579 580 581 582 583 584 585 586 587 588
		$this->parts['{input}'] = $class::widget($config);
		return $this;
	}

	/**
	 * Returns the JS options for the field.
	 * @return array the JS options
	 */
	protected function getClientOptions()
	{
589 590
		$attribute = Html::getAttributeName($this->attribute);
		if (!in_array($attribute, $this->model->activeAttributes(), true)) {
Alexander Makarov committed
591
			return [];
592 593
		}

Qiang Xue committed
594 595
		$enableClientValidation = $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
		if ($enableClientValidation) {
Alexander Makarov committed
596
			$validators = [];
Qiang Xue committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
			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;
Alexander Makarov committed
617
			foreach (['validateOnChange', 'validateOnType', 'validationDelay'] as $name) {
Qiang Xue committed
618 619 620 621 622 623 624 625 626 627 628
				$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 {
Alexander Makarov committed
629
			return [];
Qiang Xue committed
630
		}
Qiang Xue committed
631
	}
Zander Baldwin committed
632
}