ActiveField.php 24.9 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\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
	 */
	public $attribute;
Qiang Xue committed
34 35 36 37
	/**
	 * @var string the tag name for the field container.
	 */
	public $tag = 'div';
Qiang Xue committed
38
	/**
Qiang Xue committed
39 40 41
	 * @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
42
	 */
Qiang Xue committed
43
	public $options = array(
Qiang Xue committed
44
		'class' => 'control-group',
Qiang Xue committed
45 46
	);
	/**
Qiang Xue committed
47 48
	 * @var string the template that is used to arrange the label, the input and the error message.
	 * The following tokens will be replaced when [[render()]] is called: `{label}`, `{input}` and `{error}`.
Qiang Xue committed
49
	 */
Qiang Xue committed
50
	public $template = "{label}\n<div class=\"controls\">\n{input}\n{error}\n</div>";
Qiang Xue committed
51
	/**
52 53 54 55 56 57 58
	 * @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.
	 */
	public $inputOptions = array();
	/**
	 * @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
	 */
Qiang Xue committed
60
	public $errorOptions = array('tag' => 'span', 'class' => 'help-inline');
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 65
	 */
	public $labelOptions = array('class' => 'control-label');
Qiang Xue committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
	/**
	 * @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
88 89
	 * @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
90 91 92 93 94 95 96 97
	 * 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
98 99
	 * 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
100 101 102 103
	 *
	 * You normally do not need to set this property as the default selectors should work well for most cases.
	 */
	public $selectors;
Qiang Xue committed
104

Qiang Xue committed
105 106 107 108 109

	/**
	 * Renders the opening tag of the field container.
	 * @return string the rendering result.
	 */
Qiang Xue committed
110 111
	public function begin()
	{
Qiang Xue committed
112
		$options = $this->getClientOptions();
113
		if (!empty($options)) {
Qiang Xue committed
114
			$this->form->attributes[$this->attribute] = $options;
Qiang Xue committed
115 116
		}

Qiang Xue committed
117 118
		$inputID = Html::getInputId($this->model, $this->attribute);
		$attribute = Html::getAttributeName($this->attribute);
Qiang Xue committed
119
		$options = $this->options;
Qiang Xue committed
120
		$class = isset($options['class']) ? array($options['class']) : array();
Qiang Xue committed
121 122
		$class[] = "field-$inputID";
		if ($this->model->isAttributeRequired($attribute)) {
Qiang Xue committed
123
			$class[] = $this->form->requiredCssClass;
Qiang Xue committed
124
		}
Qiang Xue committed
125
		if ($this->model->hasErrors($attribute)) {
Qiang Xue committed
126
			$class[] = $this->form->errorCssClass;
Qiang Xue committed
127
		}
Qiang Xue committed
128
		$options['class'] = implode(' ', $class);
Qiang Xue committed
129

Qiang Xue committed
130
		return Html::beginTag($this->tag, $options);
Qiang Xue committed
131
	}
132

Qiang Xue committed
133 134 135 136
	/**
	 * Renders the closing tag of the field container.
	 * @return string the rendering result.
	 */
Qiang Xue committed
137 138
	public function end()
	{
Qiang Xue committed
139 140 141
		return Html::endTag($this->tag);
	}

Qiang Xue committed
142 143 144 145
	/**
	 * Returns the JS options for the field.
	 * @return array the JS options
	 */
Qiang Xue committed
146 147
	protected function getClientOptions()
	{
Qiang Xue committed
148 149 150
		$enableClientValidation = $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
		$enableAjaxValidation = $this->enableAjaxValidation || $this->enableAjaxValidation === null && $this->form->enableAjaxValidation;
		if ($enableClientValidation) {
Qiang Xue committed
151 152 153 154
			$attribute = Html::getAttributeName($this->attribute);
			$validators = array();
			foreach ($this->model->getActiveValidators($attribute) as $validator) {
				/** @var \yii\validators\Validator $validator */
155
				$js = $validator->clientValidateAttribute($this->model, $attribute, $this->form->getView());
Qiang Xue committed
156 157 158 159
				if ($validator->enableClientValidation && $js != '') {
					$validators[] = $js;
				}
			}
160
			if (!empty($validators)) {
resurtm committed
161
				$options['validate'] = new JsExpression("function(attribute, value, messages) {" . implode('', $validators) . '}');
Qiang Xue committed
162 163 164
			}
		}

Qiang Xue committed
165
		if ($enableAjaxValidation) {
Qiang Xue committed
166 167 168
			$options['enableAjaxValidation'] = 1;
		}

169
		if ($enableClientValidation && !empty($options['validate']) || $enableAjaxValidation) {
Qiang Xue committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
			$inputID = Html::getInputId($this->model, $this->attribute);
			$options['name'] = $inputID;
			$names = array(
				'validateOnChange',
				'validateOnType',
				'validationDelay',
			);
			foreach ($names 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'] : 'span';
			}
			return $options;
		} else {
			return array();
		}
	}

Qiang Xue committed
193 194 195
	/**
	 * Generates a label tag for [[attribute]].
	 * The label text is the label associated with the attribute, obtained via [[Model::getAttributeLabel()]].
196
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[labelOptions]].
Qiang Xue committed
197 198 199 200 201 202 203 204 205 206 207
	 * The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
	 * using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
	 * 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).
	 *
	 * @return string the generated label tag
	 */
208
	public function label($options = array())
Qiang Xue committed
209
	{
210
		$options = array_merge($this->labelOptions, $options);
Qiang Xue committed
211
		return Html::activeLabel($this->model, $this->attribute, $options);
Qiang Xue committed
212 213
	}

Qiang Xue committed
214 215
	/**
	 * Generates a tag that contains the first validation error of [[attribute]].
Qiang Xue committed
216
	 * Note that even if there is no validation error, this method will still return an empty error tag.
217
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[errorOptions]].
Qiang Xue committed
218 219 220 221 222 223 224 225 226
	 * The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded
	 * using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
	 * The following options are specially handled:
	 *
	 * - tag: this specifies the tag name. If not set, "span" will be used.
	 *
	 * @return string the generated label tag
	 */
227
	public function error($options = array())
Qiang Xue committed
228
	{
229
		$options = array_merge($this->errorOptions, $options);
Qiang Xue committed
230 231
		$attribute = Html::getAttributeName($this->attribute);
		$error = $this->model->getFirstError($attribute);
Qiang Xue committed
232 233
		$tag = isset($options['tag']) ? $options['tag'] : 'span';
		unset($options['tag']);
Qiang Xue committed
234 235 236
		return Html::tag($tag, Html::encode($error), $options);
	}

Qiang Xue committed
237 238 239 240 241 242 243 244
	/**
	 * Renders the field with the given input HTML.
	 * This method will generate the label and error tags, and return them together with the given
	 * input HTML according to [[template]].
	 * @param string $input the input HTML
	 * @return string the rendering result
	 */
	public function render($input)
Qiang Xue committed
245
	{
Qiang Xue committed
246
		return $this->begin() . "\n" . strtr($this->template, array(
Qiang Xue committed
247 248 249
			'{input}' => $input,
			'{label}' => $this->label(),
			'{error}' => $this->error(),
Qiang Xue committed
250
		)) . "\n" . $this->end();
Qiang Xue committed
251 252 253
	}

	/**
Qiang Xue committed
254
	 * Renders a field containing an input field.
Qiang Xue committed
255 256 257 258 259 260 261
	 * @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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
	 * @return string the generated input tag
	 */
	public function input($type, $options = array())
	{
262
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
263
		return $this->render(Html::activeInput($type, $this->model, $this->attribute, $options));
Qiang Xue committed
264 265 266
	}

	/**
Qiang Xue committed
267
	 * Renders a field containing a text input.
Qiang Xue committed
268 269 270 271
	 * 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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
Qiang Xue committed
272
	 * @return string the rendering result
Qiang Xue committed
273 274 275
	 */
	public function textInput($options = array())
	{
276
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
277
		return $this->render(Html::activeTextInput($this->model, $this->attribute, $options));
Qiang Xue committed
278 279 280
	}

	/**
Qiang Xue committed
281
	 * Renders a field containing a hidden input.
Qiang Xue committed
282 283 284 285
	 * 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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
Qiang Xue committed
286
	 * @return string the rendering result
Qiang Xue committed
287 288 289
	 */
	public function hiddenInput($options = array())
	{
290
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
291
		return $this->render(Html::activeHiddenInput($this->model, $this->attribute, $options));
Qiang Xue committed
292 293 294
	}

	/**
Qiang Xue committed
295
	 * Renders a field containing a password input.
Qiang Xue committed
296 297 298 299
	 * 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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
Qiang Xue committed
300
	 * @return string the rendering result
Qiang Xue committed
301 302 303
	 */
	public function passwordInput($options = array())
	{
304
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
305
		return $this->render(Html::activePasswordInput($this->model, $this->attribute, $options));
Qiang Xue committed
306 307 308
	}

	/**
Qiang Xue committed
309
	 * Renders a field containing a file input.
Qiang Xue committed
310 311 312 313
	 * 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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
Qiang Xue committed
314
	 * @return string the rendering result
Qiang Xue committed
315 316 317
	 */
	public function fileInput($options = array())
	{
318
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
319
		return $this->render(Html::activeFileInput($this->model, $this->attribute, $options));
Qiang Xue committed
320 321 322
	}

	/**
Qiang Xue committed
323
	 * Renders a field containing a text area.
Qiang Xue committed
324 325 326
	 * 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
	 * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
Qiang Xue committed
327
	 * @return string the rendering result
Qiang Xue committed
328 329 330
	 */
	public function textarea($options = array())
	{
331
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
332
		return $this->render(Html::activeTextarea($this->model, $this->attribute, $options));
Qiang Xue committed
333 334 335
	}

	/**
Qiang Xue committed
336
	 * Renders a field containing a radio button.
Qiang Xue committed
337 338 339 340 341 342 343 344 345 346 347
	 * This method will generate the "name" tag attribute automatically unless it is explicitly specified in `$options`.
	 * 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.
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
348 349 350
	 * @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
351
	 * @return string the rendering result
Qiang Xue committed
352
	 */
Qiang Xue committed
353
	public function radio($options = array(), $enclosedByLabel = true)
Qiang Xue committed
354
	{
355
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
		if ($enclosedByLabel) {
			$hidden = '';
			$radio = Html::activeRadio($this->model, $this->attribute, $options);
			if (($pos = strpos($radio, '><')) !== false) {
				$hidden = substr($radio, 0, $pos + 1);
				$radio = substr($radio, $pos + 1);
			}
			$label = isset($this->labelOptions['label']) ? $this->labelOptions['label'] : Html::encode($this->model->getAttributeLabel($this->attribute));
			return $this->begin() . "\n" . $hidden . strtr($this->template, array(
				'{input}' => Html::label("$radio $label", null, array('class' => 'radio')),
				'{label}' => '',
				'{error}' => $this->error(),
			)) . "\n" . $this->end();
		} else {
			return $this->render(Html::activeRadio($this->model, $this->attribute, $options));
		}
Qiang Xue committed
372 373 374
	}

	/**
Qiang Xue committed
375
	 * Renders a field containing a checkbox.
Qiang Xue committed
376 377 378 379 380 381 382 383 384 385 386
	 * This method will generate the "name" tag attribute automatically unless it is explicitly specified in `$options`.
	 * 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.
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
Qiang Xue committed
387 388 389
	 * @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
390
	 * @return string the rendering result
Qiang Xue committed
391
	 */
Qiang Xue committed
392
	public function checkbox($options = array(), $enclosedByLabel = true)
Qiang Xue committed
393
	{
394
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
		if ($enclosedByLabel) {
			$hidden = '';
			$checkbox = Html::activeCheckbox($this->model, $this->attribute, $options);
			if (($pos = strpos($checkbox, '><')) !== false) {
				$hidden = substr($checkbox, 0, $pos + 1);
				$checkbox = substr($checkbox, $pos + 1);
			}
			$label = isset($this->labelOptions['label']) ? $this->labelOptions['label'] : Html::encode($this->model->getAttributeLabel($this->attribute));
			return $this->begin() . "\n" . $hidden . strtr($this->template, array(
				'{input}' => Html::label("$checkbox $label", null, array('class' => 'checkbox')),
				'{label}' => '',
				'{error}' => $this->error(),
			)) . "\n" . $this->end();
		} else {
			return $this->render(Html::activeCheckbox($this->model, $this->attribute, $options));
		}
Qiang Xue committed
411 412 413
	}

	/**
Qiang Xue committed
414
	 * Renders a field containing a drop-down list.
Qiang Xue committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
	 * 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
	 * [[\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.
	 *
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
Qiang Xue committed
443
	 * @return string the rendering result
Qiang Xue committed
444
	 */
Qiang Xue committed
445
	public function dropDownList($items, $options = array())
Qiang Xue committed
446
	{
447
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
448
		return $this->render(Html::activeDropDownList($this->model, $this->attribute, $items, $options));
Qiang Xue committed
449 450 451
	}

	/**
Qiang Xue committed
452
	 * Renders a field containing a list box.
Qiang Xue committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
	 * 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
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
Qiang Xue committed
484
	 * @return string the rendering result
Qiang Xue committed
485 486 487
	 */
	public function listBox($items, $options = array())
	{
488
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
489
		return $this->render(Html::activeListBox($this->model, $this->attribute, $items, $options));
Qiang Xue committed
490 491 492
	}

	/**
Qiang Xue committed
493
	 * Renders a field containing a list of checkboxes.
Qiang Xue committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
	 * 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
515
	 * @return string the rendering result
Qiang Xue committed
516 517 518
	 */
	public function checkboxList($items, $options = array())
	{
Qiang Xue committed
519 520 521 522 523
		return $this->render(
			'<div id="' . Html::getInputId($this->model, $this->attribute) . '">'
			. Html::activeCheckboxList($this->model, $this->attribute, $items, $options)
			. '</div>'
		);
Qiang Xue committed
524 525 526
	}

	/**
Qiang Xue committed
527
	 * Renders a field containing a list of radio buttons.
Qiang Xue committed
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
	 * 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
548
	 * @return string the rendering result
Qiang Xue committed
549 550 551
	 */
	public function radioList($items, $options = array())
	{
Qiang Xue committed
552 553 554 555 556
		return $this->render(
			'<div id="' . Html::getInputId($this->model, $this->attribute) . '">'
			. Html::activeRadioList($this->model, $this->attribute, $items, $options)
			. '</div>'
		);
Qiang Xue committed
557
	}
Qiang Xue committed
558 559

	/**
560 561 562 563 564 565 566 567
	 * Renders a field containing an input widget.
	 *
	 * 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
568 569 570 571 572 573 574
	 * @param string $class the widget class name
	 * @param array $config name-value pairs that will be used to initialize the widget
	 * @return string the rendering result
	 */
	public function widget($class, $config = array())
	{
		/** @var \yii\base\Widget $class */
575 576 577
		$config['model'] = $this->model;
		$config['attribute'] = $this->attribute;
		$config['view'] = $this->form->getView();
Qiang Xue committed
578 579
		return $this->render($class::widget($config));
	}
Zander Baldwin committed
580
}