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

Qiang Xue committed
123

Qiang Xue committed
124 125 126 127 128 129
	/**
	 * PHP magic method that returns the string representation of this object.
	 * @return string the string representation of this object.
	 */
	public function __toString()
	{
130 131 132 133 134
		// __toString cannot throw exception
		// use trigger_error to bypass this limitation
		try {
			return $this->render();
		} catch (\Exception $e) {
135
			trigger_error($e->getMessage() . "\n\n" . $e->getTraceAsString());
136 137
			return '';
		}
Qiang Xue committed
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 177 178
	}

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

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

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

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

Qiang Xue committed
216 217
	/**
	 * Generates a label tag for [[attribute]].
218 219
	 * @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]].
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.
223
	 * @return static the field object itself
Qiang Xue committed
224
	 */
Alexander Makarov committed
225
	public function label($label = null, $options = [])
Qiang Xue committed
226
	{
227
		$options = array_merge($this->labelOptions, $options);
228 229 230
		if ($label !== null) {
			$options['label'] = $label;
		}
Qiang Xue committed
231 232
		$this->parts['{label}'] = Html::activeLabel($this->model, $this->attribute, $options);
		return $this;
Qiang Xue committed
233 234
	}

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

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

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

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

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

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

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

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

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

	/**
Qiang Xue committed
431
	 * Renders a drop-down list.
Qiang Xue committed
432 433 434 435 436
	 * 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
437
	 * [[ArrayHelper::map()]].
Qiang Xue committed
438 439 440 441 442 443 444 445 446 447
	 *
	 * 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
448 449 450 451
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
452 453 454 455 456 457
	 * ~~~
	 *
	 * - 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
458
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
459
	 *
460
	 * @return static the field object itself
Qiang Xue committed
461
	 */
Alexander Makarov committed
462
	public function dropDownList($items, $options = [])
Qiang Xue committed
463
	{
464
		$options = array_merge($this->inputOptions, $options);
465
		$this->adjustLabelFor($options);
Qiang Xue committed
466 467
		$this->parts['{input}'] = Html::activeDropDownList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
468 469 470
	}

	/**
Qiang Xue committed
471
	 * Renders a list box.
Qiang Xue committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
	 * 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
488 489 490 491
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
492 493 494 495 496 497 498 499 500
	 * ~~~
	 *
	 * - 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
501
	 * be HTML-encoded using [[Html::encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
502
	 *
503
	 * @return static the field object itself
Qiang Xue committed
504
	 */
Alexander Makarov committed
505
	public function listBox($items, $options = [])
Qiang Xue committed
506
	{
507
		$options = array_merge($this->inputOptions, $options);
508
		$this->adjustLabelFor($options);
Qiang Xue committed
509 510
		$this->parts['{input}'] = Html::activeListBox($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
511 512 513
	}

	/**
Qiang Xue committed
514
	 * Renders a list of checkboxes.
Qiang Xue committed
515 516 517 518
	 * 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.
519
	 * The array values are the labels, while the array keys are the corresponding checkbox values.
Qiang Xue committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	 * 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.
536
	 * @return static the field object itself
Qiang Xue committed
537
	 */
Alexander Makarov committed
538
	public function checkboxList($items, $options = [])
Qiang Xue committed
539
	{
540
		$this->adjustLabelFor($options);
Qiang Xue committed
541 542
		$this->parts['{input}'] = Html::activeCheckboxList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
543 544 545
	}

	/**
Qiang Xue committed
546
	 * Renders a list of radio buttons.
Qiang Xue committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
	 * 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.
567
	 * @return static the field object itself
Qiang Xue committed
568
	 */
Alexander Makarov committed
569
	public function radioList($items, $options = [])
Qiang Xue committed
570
	{
571
		$this->adjustLabelFor($options);
Qiang Xue committed
572 573
		$this->parts['{input}'] = Html::activeRadioList($this->model, $this->attribute, $items, $options);
		return $this;
Qiang Xue committed
574
	}
Qiang Xue committed
575 576

	/**
Qiang Xue committed
577
	 * Renders a widget as the input of the field.
578 579 580 581 582 583 584
	 *
	 * 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
585 586
	 * @param string $class the widget class name
	 * @param array $config name-value pairs that will be used to initialize the widget
587
	 * @return static the field object itself
Qiang Xue committed
588
	 */
Alexander Makarov committed
589
	public function widget($class, $config = [])
Qiang Xue committed
590 591
	{
		/** @var \yii\base\Widget $class */
592 593 594
		$config['model'] = $this->model;
		$config['attribute'] = $this->attribute;
		$config['view'] = $this->form->getView();
Qiang Xue committed
595 596 597 598
		$this->parts['{input}'] = $class::widget($config);
		return $this;
	}

599 600 601 602 603 604
	/**
	 * Adjusts the "for" attribute for the label based on the input options.
	 * @param array $options the input options
	 */
	protected function adjustLabelFor($options)
	{
Qiang Xue committed
605 606
		if (isset($options['id']) && !isset($this->labelOptions['for'])) {
			$this->labelOptions['for'] = $options['id'];
607 608 609
		}
	}

Qiang Xue committed
610 611 612 613 614 615
	/**
	 * Returns the JS options for the field.
	 * @return array the JS options
	 */
	protected function getClientOptions()
	{
616 617
		$attribute = Html::getAttributeName($this->attribute);
		if (!in_array($attribute, $this->model->activeAttributes(), true)) {
Alexander Makarov committed
618
			return [];
619 620
		}

621 622
		$options = [];

Qiang Xue committed
623 624
		$enableClientValidation = $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
		if ($enableClientValidation) {
Alexander Makarov committed
625
			$validators = [];
Qiang Xue committed
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
			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
646
			foreach (['validateOnChange', 'validateOnType', 'validationDelay'] as $name) {
Qiang Xue committed
647 648 649 650 651 652 653
				$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 {
654
				$options['error'] = isset($this->errorOptions['tag']) ? $this->errorOptions['tag'] : 'span';
Qiang Xue committed
655 656 657
			}
			return $options;
		} else {
Alexander Makarov committed
658
			return [];
Qiang Xue committed
659
		}
Qiang Xue committed
660
	}
Zander Baldwin committed
661
}