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

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

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActiveField extends Component
{
	/**
Qiang Xue committed
22
	 * @var ActiveForm the form that this field is associated with.
Qiang Xue committed
23 24 25
	 */
	public $form;
	/**
Qiang Xue committed
26
	 * @var Model the data model that this field is associated with
Qiang Xue committed
27 28 29
	 */
	public $model;
	/**
Qiang Xue committed
30
	 * @var string the model attribute that this field is associated with
Qiang Xue committed
31 32
	 */
	public $attribute;
Qiang Xue committed
33 34 35 36
	/**
	 * @var string the tag name for the field container.
	 */
	public $tag = 'div';
Qiang Xue committed
37
	/**
Qiang Xue committed
38 39 40
	 * @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
41
	 */
Qiang Xue committed
42
	public $options = array(
Qiang Xue committed
43
		'class' => 'control-group',
Qiang Xue committed
44 45
	);
	/**
Qiang Xue committed
46 47
	 * @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
48
	 */
Qiang Xue committed
49
	public $template = "{label}\n<div class=\"controls\">\n{input}\n{error}\n</div>";
Qiang Xue committed
50
	/**
51 52 53 54 55 56 57
	 * @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
58
	 */
Qiang Xue committed
59
	public $errorOptions = array('tag' => 'span', 'class' => 'help-inline');
Qiang Xue committed
60
	/**
61 62
	 * @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
63 64
	 */
	public $labelOptions = array('class' => 'control-label');
Qiang Xue committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
	/**
	 * @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
87 88
	 * @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
89 90 91 92 93 94 95 96
	 * 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
97 98
	 * 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
99 100 101 102
	 *
	 * You normally do not need to set this property as the default selectors should work well for most cases.
	 */
	public $selectors;
Qiang Xue committed
103

Qiang Xue committed
104 105
	public function begin()
	{
Qiang Xue committed
106
		$options = $this->getClientOptions();
107
		if (!empty($options)) {
Qiang Xue committed
108
			$this->form->attributes[$this->attribute] = $options;
Qiang Xue committed
109 110
		}

Qiang Xue committed
111 112
		$inputID = Html::getInputId($this->model, $this->attribute);
		$attribute = Html::getAttributeName($this->attribute);
Qiang Xue committed
113
		$options = $this->options;
Qiang Xue committed
114
		$class = isset($options['class']) ? array($options['class']) : array();
Qiang Xue committed
115 116
		$class[] = "field-$inputID";
		if ($this->model->isAttributeRequired($attribute)) {
Qiang Xue committed
117
			$class[] = $this->form->requiredCssClass;
Qiang Xue committed
118
		}
Qiang Xue committed
119
		if ($this->model->hasErrors($attribute)) {
Qiang Xue committed
120
			$class[] = $this->form->errorCssClass;
Qiang Xue committed
121
		}
Qiang Xue committed
122
		$options['class'] = implode(' ', $class);
Qiang Xue committed
123

Qiang Xue committed
124
		return Html::beginTag($this->tag, $options);
Qiang Xue committed
125
	}
126

Qiang Xue committed
127 128
	public function end()
	{
Qiang Xue committed
129 130 131
		return Html::endTag($this->tag);
	}

Qiang Xue committed
132 133
	protected function getClientOptions()
	{
Qiang Xue committed
134 135 136
		$enableClientValidation = $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
		$enableAjaxValidation = $this->enableAjaxValidation || $this->enableAjaxValidation === null && $this->form->enableAjaxValidation;
		if ($enableClientValidation) {
Qiang Xue committed
137 138 139 140
			$attribute = Html::getAttributeName($this->attribute);
			$validators = array();
			foreach ($this->model->getActiveValidators($attribute) as $validator) {
				/** @var \yii\validators\Validator $validator */
141
				$js = $validator->clientValidateAttribute($this->model, $attribute, $this->form->getView());
Qiang Xue committed
142 143 144 145
				if ($validator->enableClientValidation && $js != '') {
					$validators[] = $js;
				}
			}
146
			if (!empty($validators)) {
resurtm committed
147
				$options['validate'] = new JsExpression("function(attribute, value, messages) {" . implode('', $validators) . '}');
Qiang Xue committed
148 149 150
			}
		}

Qiang Xue committed
151
		if ($enableAjaxValidation) {
Qiang Xue committed
152 153 154
			$options['enableAjaxValidation'] = 1;
		}

155
		if ($enableClientValidation && !empty($options['validate']) || $enableAjaxValidation) {
Qiang Xue committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
			$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
179 180 181
	/**
	 * Generates a label tag for [[attribute]].
	 * The label text is the label associated with the attribute, obtained via [[Model::getAttributeLabel()]].
182
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[labelOptions]].
Qiang Xue committed
183 184 185 186 187 188 189 190 191 192 193
	 * 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
	 */
194
	public function label($options = array())
Qiang Xue committed
195
	{
196
		$options = array_merge($this->labelOptions, $options);
Qiang Xue committed
197
		return Html::activeLabel($this->model, $this->attribute, $options);
Qiang Xue committed
198 199
	}

Qiang Xue committed
200 201
	/**
	 * Generates a tag that contains the first validation error of [[attribute]].
Qiang Xue committed
202
	 * Note that even if there is no validation error, this method will still return an empty error tag.
203
	 * @param array $options the tag options in terms of name-value pairs. It will be merged with [[errorOptions]].
Qiang Xue committed
204 205 206 207 208 209 210 211 212
	 * 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
	 */
213
	public function error($options = array())
Qiang Xue committed
214
	{
215
		$options = array_merge($this->errorOptions, $options);
Qiang Xue committed
216 217
		$attribute = Html::getAttributeName($this->attribute);
		$error = $this->model->getFirstError($attribute);
Qiang Xue committed
218 219
		$tag = isset($options['tag']) ? $options['tag'] : 'span';
		unset($options['tag']);
Qiang Xue committed
220 221 222
		return Html::tag($tag, Html::encode($error), $options);
	}

Qiang Xue committed
223 224 225 226 227 228 229 230
	/**
	 * 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
231
	{
Qiang Xue committed
232
		return $this->begin() . "\n" . strtr($this->template, array(
Qiang Xue committed
233 234 235
			'{input}' => $input,
			'{label}' => $this->label(),
			'{error}' => $this->error(),
Qiang Xue committed
236
		)) . "\n" . $this->end();
Qiang Xue committed
237 238 239 240 241 242 243 244 245 246 247
	}

	/**
	 * Generates an input tag for the given model attribute.
	 * @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())
	{
248
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
249
		return $this->render(Html::activeInput($type, $this->model, $this->attribute, $options));
Qiang Xue committed
250 251 252 253 254 255 256 257 258 259 260 261
	}

	/**
	 * Generates a text input tag for the given model attribute.
	 * 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()]].
	 * @return string the generated input tag
	 */
	public function textInput($options = array())
	{
262
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
263
		return $this->render(Html::activeTextInput($this->model, $this->attribute, $options));
Qiang Xue committed
264 265 266 267 268 269 270 271 272 273 274 275
	}

	/**
	 * Generates a hidden input tag for the given model attribute.
	 * 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()]].
	 * @return string the generated input tag
	 */
	public function hiddenInput($options = array())
	{
276
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
277
		return $this->render(Html::activeHiddenInput($this->model, $this->attribute, $options));
Qiang Xue committed
278 279 280 281 282 283 284 285 286 287 288 289
	}

	/**
	 * Generates a password input tag for the given model attribute.
	 * 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()]].
	 * @return string the generated input tag
	 */
	public function passwordInput($options = array())
	{
290
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
291
		return $this->render(Html::activePasswordInput($this->model, $this->attribute, $options));
Qiang Xue committed
292 293 294 295 296 297 298 299 300 301 302 303
	}

	/**
	 * Generates a file input tag for the given model attribute.
	 * 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()]].
	 * @return string the generated input tag
	 */
	public function fileInput($options = array())
	{
304
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
305
		return $this->render(Html::activeFileInput($this->model, $this->attribute, $options));
Qiang Xue committed
306 307 308 309 310 311 312 313 314 315 316
	}

	/**
	 * Generates a textarea tag for the given model attribute.
	 * 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()]].
	 * @return string the generated textarea tag
	 */
	public function textarea($options = array())
	{
317
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
318
		return $this->render(Html::activeTextarea($this->model, $this->attribute, $options));
Qiang Xue committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
	}

	/**
	 * Generates a radio button tag for the given model attribute.
	 * 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
334 335 336
	 * @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
337 338
	 * @return string the generated radio button tag
	 */
Qiang Xue committed
339
	public function radio($options = array(), $enclosedByLabel = true)
Qiang Xue committed
340
	{
341
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
		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
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
	}

	/**
	 * Generates a checkbox tag for the given model attribute.
	 * 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
373 374 375
	 * @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
376 377
	 * @return string the generated checkbox tag
	 */
Qiang Xue committed
378
	public function checkbox($options = array(), $enclosedByLabel = true)
Qiang Xue committed
379
	{
380
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
		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
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
	}

	/**
	 * Generates a drop-down list for the given model attribute.
	 * 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.
	 *
	 * @return string the generated drop-down list tag
	 */
Qiang Xue committed
431
	public function dropDownList($items, $options = array())
Qiang Xue committed
432
	{
433
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
434
		return $this->render(Html::activeDropDownList($this->model, $this->attribute, $items, $options));
Qiang Xue committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
	}

	/**
	 * Generates a list box.
	 * 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.
	 *
	 * @return string the generated list box tag
	 */
	public function listBox($items, $options = array())
	{
474
		$options = array_merge($this->inputOptions, $options);
Qiang Xue committed
475
		return $this->render(Html::activeListBox($this->model, $this->attribute, $items, $options));
Qiang Xue committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
	}

	/**
	 * Generates a list of checkboxes.
	 * 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.
	 * @return string the generated checkbox list
	 */
	public function checkboxList($items, $options = array())
	{
Qiang Xue committed
505 506 507 508 509
		return $this->render(
			'<div id="' . Html::getInputId($this->model, $this->attribute) . '">'
			. Html::activeCheckboxList($this->model, $this->attribute, $items, $options)
			. '</div>'
		);
Qiang Xue committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
	}

	/**
	 * Generates a list of radio buttons.
	 * 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.
	 * @return string the generated radio button list
	 */
	public function radioList($items, $options = array())
	{
Qiang Xue committed
538 539 540 541 542
		return $this->render(
			'<div id="' . Html::getInputId($this->model, $this->attribute) . '">'
			. Html::activeRadioList($this->model, $this->attribute, $items, $options)
			. '</div>'
		);
Qiang Xue committed
543
	}
Zander Baldwin committed
544
}