BaseHtml.php 72.8 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\helpers;
Qiang Xue committed
9 10 11

use Yii;
use yii\base\InvalidParamException;
12
use yii\db\ActiveRecordInterface;
13
use yii\web\Request;
Qiang Xue committed
14
use yii\base\Model;
Qiang Xue committed
15 16

/**
17
 * BaseHtml provides concrete implementation for [[Html]].
18
 *
19
 * Do not use BaseHtml. Use [[Html]] instead.
Qiang Xue committed
20 21 22 23
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
24
class BaseHtml
Qiang Xue committed
25 26 27 28 29
{
	/**
	 * @var array list of void elements (element name => 1)
	 * @see http://www.w3.org/TR/html-markup/syntax.html#void-element
	 */
Alexander Makarov committed
30
	public static $voidElements = [
Qiang Xue committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
		'area' => 1,
		'base' => 1,
		'br' => 1,
		'col' => 1,
		'command' => 1,
		'embed' => 1,
		'hr' => 1,
		'img' => 1,
		'input' => 1,
		'keygen' => 1,
		'link' => 1,
		'meta' => 1,
		'param' => 1,
		'source' => 1,
		'track' => 1,
		'wbr' => 1,
Alexander Makarov committed
47
	];
Qiang Xue committed
48 49
	/**
	 * @var array the preferred order of attributes in a tag. This mainly affects the order of the attributes
resurtm committed
50
	 * that are rendered by [[renderTagAttributes()]].
Qiang Xue committed
51
	 */
Alexander Makarov committed
52
	public static $attributeOrder = [
Qiang Xue committed
53 54
		'type',
		'id',
Qiang Xue committed
55
		'class',
Qiang Xue committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
		'name',
		'value',

		'href',
		'src',
		'action',
		'method',

		'selected',
		'checked',
		'readonly',
		'disabled',
		'multiple',

		'size',
		'maxlength',
		'width',
		'height',
		'rows',
		'cols',

		'alt',
		'title',
		'rel',
		'media',
Alexander Makarov committed
81
	];
Qiang Xue committed
82 83 84

	/**
	 * Encodes special characters into HTML entities.
85
	 * The [[\yii\base\Application::charset|application charset]] will be used for encoding.
Qiang Xue committed
86
	 * @param string $content the content to be encoded
Qiang Xue committed
87 88
	 * @param boolean $doubleEncode whether to encode HTML entities in `$content`. If false,
	 * HTML entities in `$content` will not be further encoded.
Qiang Xue committed
89
	 * @return string the encoded content
90
	 * @see decode()
Qiang Xue committed
91 92
	 * @see http://www.php.net/manual/en/function.htmlspecialchars.php
	 */
Qiang Xue committed
93
	public static function encode($content, $doubleEncode = true)
Qiang Xue committed
94
	{
Qiang Xue committed
95
		return htmlspecialchars($content, ENT_QUOTES, Yii::$app->charset, $doubleEncode);
Qiang Xue committed
96 97 98 99 100 101 102
	}

	/**
	 * Decodes special HTML entities back to the corresponding characters.
	 * This is the opposite of [[encode()]].
	 * @param string $content the content to be decoded
	 * @return string the decoded content
103
	 * @see encode()
Qiang Xue committed
104 105 106 107 108 109 110 111 112 113 114 115
	 * @see http://www.php.net/manual/en/function.htmlspecialchars-decode.php
	 */
	public static function decode($content)
	{
		return htmlspecialchars_decode($content, ENT_QUOTES);
	}

	/**
	 * Generates a complete HTML tag.
	 * @param string $name the tag name
	 * @param string $content the content to be enclosed between the start and end tags. It will not be HTML-encoded.
	 * If this is coming from end users, you should consider [[encode()]] it to prevent XSS attacks.
116 117
	 * @param array $options the HTML tag attributes (HTML 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
118
	 * If a value is null, the corresponding attribute will not be rendered.
119 120 121
	 *
	 * For example when using `['class' => 'my-class', 'target' => '_blank', 'value' => null]` it will result in the
	 * html attributes rendered like this: `class="my-class" target="_blank"`.
Qiang Xue committed
122
	 * @return string the generated HTML tag
123 124
	 * @see beginTag()
	 * @see endTag()
Qiang Xue committed
125
	 */
Alexander Makarov committed
126
	public static function tag($name, $content = '', $options = [])
Qiang Xue committed
127
	{
Alexander Kochetov committed
128 129
		$html = "<$name" . static::renderTagAttributes($options) . '>';
		return isset(static::$voidElements[strtolower($name)]) ? $html : "$html$content</$name>";
Qiang Xue committed
130 131 132 133 134 135 136 137 138
	}

	/**
	 * Generates a start tag.
	 * @param string $name the tag name
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated start tag
139 140
	 * @see endTag()
	 * @see tag()
Qiang Xue committed
141
	 */
Alexander Makarov committed
142
	public static function beginTag($name, $options = [])
Qiang Xue committed
143
	{
144
		return "<$name" . static::renderTagAttributes($options) . '>';
Qiang Xue committed
145 146 147 148 149 150
	}

	/**
	 * Generates an end tag.
	 * @param string $name the tag name
	 * @return string the generated end tag
151 152
	 * @see beginTag()
	 * @see tag()
Qiang Xue committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
	 */
	public static function endTag($name)
	{
		return "</$name>";
	}

	/**
	 * Generates a style tag.
	 * @param string $content the style content
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * If the options does not contain "type", a "type" attribute with value "text/css" will be used.
	 * @return string the generated style tag
	 */
Alexander Makarov committed
168
	public static function style($content, $options = [])
Qiang Xue committed
169
	{
170
		return static::tag('style', $content, $options);
Qiang Xue committed
171 172 173 174 175 176 177 178 179 180 181
	}

	/**
	 * Generates a script tag.
	 * @param string $content the script content
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * If the options does not contain "type", a "type" attribute with value "text/javascript" will be rendered.
	 * @return string the generated script tag
	 */
Alexander Makarov committed
182
	public static function script($content, $options = [])
Qiang Xue committed
183
	{
184
		return static::tag('script', $content, $options);
Qiang Xue committed
185 186 187 188 189 190 191 192 193
	}

	/**
	 * Generates a link tag that refers to an external CSS file.
	 * @param array|string $url the URL of the external CSS file. This parameter will be processed by [[url()]].
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated link tag
194
	 * @see url()
Qiang Xue committed
195
	 */
Alexander Makarov committed
196
	public static function cssFile($url, $options = [])
Qiang Xue committed
197
	{
198 199 200
		if (!isset($options['rel'])) {
			$options['rel'] = 'stylesheet';
		}
Qiang Xue committed
201 202 203 204 205 206 207 208 209 210 211
		$options['href'] = static::url($url);
		return static::tag('link', '', $options);
	}

	/**
	 * Generates a script tag that refers to an external JavaScript file.
	 * @param string $url the URL of the external JavaScript file. This parameter will be processed by [[url()]].
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated script tag
212
	 * @see url()
Qiang Xue committed
213
	 */
Alexander Makarov committed
214
	public static function jsFile($url, $options = [])
Qiang Xue committed
215 216 217 218 219 220 221 222
	{
		$options['src'] = static::url($url);
		return static::tag('script', '', $options);
	}

	/**
	 * Generates a form start tag.
	 * @param array|string $action the form action URL. This parameter will be processed by [[url()]].
223 224 225
	 * @param string $method the form submission method, such as "post", "get", "put", "delete" (case-insensitive).
	 * Since most browsers only support "post" and "get", if other methods are given, they will
	 * be simulated using "post", and a hidden input will be added which contains the actual method type.
226
	 * See [[\yii\web\Request::methodVar]] for more details.
Qiang Xue committed
227 228 229 230
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated form start tag.
231
	 * @see endForm()
Qiang Xue committed
232
	 */
Alexander Makarov committed
233
	public static function beginForm($action = '', $method = 'post', $options = [])
Qiang Xue committed
234 235 236
	{
		$action = static::url($action);

Alexander Makarov committed
237
		$hiddenInputs = [];
238

Qiang Xue committed
239 240 241 242
		$request = Yii::$app->getRequest();
		if ($request instanceof Request) {
			if (strcasecmp($method, 'get') && strcasecmp($method, 'post')) {
				// simulate PUT, DELETE, etc. via POST
243
				$hiddenInputs[] = static::hiddenInput($request->methodVar, $method);
244 245
				$method = 'post';
			}
Qiang Xue committed
246
			if ($request->enableCsrfValidation && !strcasecmp($method, 'post')) {
247
				$hiddenInputs[] = static::hiddenInput($request->csrfVar, $request->getCsrfToken());
Qiang Xue committed
248
			}
249 250
		}

Qiang Xue committed
251
		if (!strcasecmp($method, 'get') && ($pos = strpos($action, '?')) !== false) {
252 253
			// query parameters in the action are ignored for GET method
			// we use hidden fields to add them back
Qiang Xue committed
254 255
			foreach (explode('&', substr($action, $pos + 1)) as $pair) {
				if (($pos1 = strpos($pair, '=')) !== false) {
256 257 258 259
					$hiddenInputs[] = static::hiddenInput(
						urldecode(substr($pair, 0, $pos1)),
						urldecode(substr($pair, $pos1 + 1))
					);
Qiang Xue committed
260
				} else {
261
					$hiddenInputs[] = static::hiddenInput(urldecode($pair), '');
Qiang Xue committed
262 263 264 265 266 267 268 269
				}
			}
			$action = substr($action, 0, $pos);
		}

		$options['action'] = $action;
		$options['method'] = $method;
		$form = static::beginTag('form', $options);
270
		if (!empty($hiddenInputs)) {
271
			$form .= "\n" . implode("\n", $hiddenInputs);
Qiang Xue committed
272 273 274 275 276 277 278 279
		}

		return $form;
	}

	/**
	 * Generates a form end tag.
	 * @return string the generated tag
280
	 * @see beginForm()
Qiang Xue committed
281 282 283 284 285 286 287 288 289
	 */
	public static function endForm()
	{
		return '</form>';
	}

	/**
	 * Generates a hyperlink tag.
	 * @param string $text link body. It will NOT be HTML-encoded. Therefore you can pass in HTML code
Carsten Brandt committed
290
	 * such as an image tag. If this is coming from end users, you should consider [[encode()]]
Qiang Xue committed
291 292 293 294 295 296 297 298
	 * it to prevent XSS attacks.
	 * @param array|string|null $url the URL for the hyperlink tag. This parameter will be processed by [[url()]]
	 * and will be used for the "href" attribute of the tag. If this parameter is null, the "href" attribute
	 * will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated hyperlink
299
	 * @see url()
Qiang Xue committed
300
	 */
Alexander Makarov committed
301
	public static function a($text, $url = null, $options = [])
Qiang Xue committed
302 303 304 305 306 307 308 309 310 311
	{
		if ($url !== null) {
			$options['href'] = static::url($url);
		}
		return static::tag('a', $text, $options);
	}

	/**
	 * Generates a mailto hyperlink.
	 * @param string $text link body. It will NOT be HTML-encoded. Therefore you can pass in HTML code
Carsten Brandt committed
312
	 * such as an image tag. If this is coming from end users, you should consider [[encode()]]
Qiang Xue committed
313 314 315 316 317 318 319 320
	 * it to prevent XSS attacks.
	 * @param string $email email address. If this is null, the first parameter (link body) will be treated
	 * as the email address and used.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated mailto link
	 */
Alexander Makarov committed
321
	public static function mailto($text, $email = null, $options = [])
Qiang Xue committed
322
	{
Qiang Xue committed
323 324
		$options['href'] = 'mailto:' . ($email === null ? $text : $email);
		return static::tag('a', $text, $options);
Qiang Xue committed
325 326 327 328 329 330 331 332 333 334
	}

	/**
	 * Generates an image tag.
	 * @param string $src the image URL. This parameter will be processed by [[url()]].
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated image tag
	 */
Alexander Makarov committed
335
	public static function img($src, $options = [])
Qiang Xue committed
336 337 338 339 340
	{
		$options['src'] = static::url($src);
		if (!isset($options['alt'])) {
			$options['alt'] = '';
		}
341
		return static::tag('img', '', $options);
Qiang Xue committed
342 343 344 345 346
	}

	/**
	 * Generates a label tag.
	 * @param string $content label text. It will NOT be HTML-encoded. Therefore you can pass in HTML code
Qiang Xue committed
347
	 * such as an image tag. If this is is coming from end users, you should [[encode()]]
Qiang Xue committed
348 349 350 351 352 353 354 355
	 * it to prevent XSS attacks.
	 * @param string $for the ID of the HTML element that this label is associated with.
	 * If this is null, the "for" attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated label tag
	 */
Alexander Makarov committed
356
	public static function label($content, $for = null, $options = [])
Qiang Xue committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
	{
		$options['for'] = $for;
		return static::tag('label', $content, $options);
	}

	/**
	 * Generates a button tag.
	 * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded.
	 * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users,
	 * you should consider [[encode()]] it to prevent XSS attacks.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
372
	public static function button($content = 'Button', $options = [])
Qiang Xue committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386
	{
		return static::tag('button', $content, $options);
	}

	/**
	 * Generates a submit button tag.
	 * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded.
	 * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users,
	 * you should consider [[encode()]] it to prevent XSS attacks.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated submit button tag
	 */
Alexander Makarov committed
387
	public static function submitButton($content = 'Submit', $options = [])
Qiang Xue committed
388 389
	{
		$options['type'] = 'submit';
Qiang Xue committed
390
		return static::button($content, $options);
Qiang Xue committed
391 392 393 394 395 396 397 398 399 400 401 402
	}

	/**
	 * Generates a reset button tag.
	 * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded.
	 * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users,
	 * you should consider [[encode()]] it to prevent XSS attacks.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated reset button tag
	 */
Alexander Makarov committed
403
	public static function resetButton($content = 'Reset', $options = [])
Qiang Xue committed
404 405
	{
		$options['type'] = 'reset';
Qiang Xue committed
406
		return static::button($content, $options);
Qiang Xue committed
407 408 409 410 411 412 413 414 415 416 417 418
	}

	/**
	 * Generates an input type of the given type.
	 * @param string $type the type attribute.
	 * @param string $name the name attribute. If it is null, the name attribute will not be generated.
	 * @param string $value the value attribute. If it is null, the value attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated input tag
	 */
Alexander Makarov committed
419
	public static function input($type, $name = null, $value = null, $options = [])
Qiang Xue committed
420 421 422
	{
		$options['type'] = $type;
		$options['name'] = $name;
423
		$options['value'] = $value === null ? null : (string)$value;
424
		return static::tag('input', '', $options);
Qiang Xue committed
425 426 427 428
	}

	/**
	 * Generates an input button.
Qiang Xue committed
429
	 * @param string $label the value attribute. If it is null, the value attribute will not be generated.
Qiang Xue committed
430 431 432 433 434
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
435
	public static function buttonInput($label = 'Button', $options = [])
Qiang Xue committed
436
	{
Qiang Xue committed
437 438
		$options['type'] = 'button';
		$options['value'] = $label;
439
		return static::tag('input', '', $options);
Qiang Xue committed
440 441 442 443
	}

	/**
	 * Generates a submit input button.
Qiang Xue committed
444
	 * @param string $label the value attribute. If it is null, the value attribute will not be generated.
Qiang Xue committed
445 446 447 448 449
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
450
	public static function submitInput($label = 'Submit', $options = [])
Qiang Xue committed
451
	{
Qiang Xue committed
452 453
		$options['type'] = 'submit';
		$options['value'] = $label;
454
		return static::tag('input', '', $options);
Qiang Xue committed
455 456 457 458
	}

	/**
	 * Generates a reset input button.
Qiang Xue committed
459
	 * @param string $label the value attribute. If it is null, the value attribute will not be generated.
Qiang Xue committed
460 461 462 463
	 * @param array $options the attributes of the button tag. The values will be HTML-encoded using [[encode()]].
	 * Attributes whose value is null will be ignored and not put in the tag returned.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
464
	public static function resetInput($label = 'Reset', $options = [])
Qiang Xue committed
465
	{
Qiang Xue committed
466 467
		$options['type'] = 'reset';
		$options['value'] = $label;
468
		return static::tag('input', '', $options);
Qiang Xue committed
469 470 471 472 473 474 475 476 477 478 479
	}

	/**
	 * Generates a text input field.
	 * @param string $name the name attribute.
	 * @param string $value the value attribute. If it is null, the value attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
480
	public static function textInput($name, $value = null, $options = [])
Qiang Xue committed
481 482 483 484 485 486 487 488 489 490 491 492 493
	{
		return static::input('text', $name, $value, $options);
	}

	/**
	 * Generates a hidden input field.
	 * @param string $name the name attribute.
	 * @param string $value the value attribute. If it is null, the value attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
494
	public static function hiddenInput($name, $value = null, $options = [])
Qiang Xue committed
495 496 497 498 499 500 501 502 503 504 505 506 507
	{
		return static::input('hidden', $name, $value, $options);
	}

	/**
	 * Generates a password input field.
	 * @param string $name the name attribute.
	 * @param string $value the value attribute. If it is null, the value attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
508
	public static function passwordInput($name, $value = null, $options = [])
Qiang Xue committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	{
		return static::input('password', $name, $value, $options);
	}

	/**
	 * Generates a file input field.
	 * To use a file input field, you should set the enclosing form's "enctype" attribute to
	 * be "multipart/form-data". After the form is submitted, the uploaded file information
	 * can be obtained via $_FILES[$name] (see PHP documentation).
	 * @param string $name the name attribute.
	 * @param string $value the value attribute. If it is null, the value attribute will not be generated.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated button tag
	 */
Alexander Makarov committed
525
	public static function fileInput($name, $value = null, $options = [])
Qiang Xue committed
526 527 528 529 530 531 532 533 534 535 536 537 538
	{
		return static::input('file', $name, $value, $options);
	}

	/**
	 * Generates a text area input.
	 * @param string $name the input name
	 * @param string $value the input value. Note that it will be encoded using [[encode()]].
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated text area tag
	 */
Alexander Makarov committed
539
	public static function textarea($name, $value = '', $options = [])
Qiang Xue committed
540 541 542 543 544 545 546 547 548
	{
		$options['name'] = $name;
		return static::tag('textarea', static::encode($value), $options);
	}

	/**
	 * Generates a radio button input.
	 * @param string $name the name attribute.
	 * @param boolean $checked whether the radio button should be checked.
Qiang Xue committed
549
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
Qiang Xue committed
550 551 552 553
	 *
	 * - uncheck: string, the value associated with the uncheck state of the radio button. When this attribute
	 *   is present, a hidden input will be generated 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.
554 555 556 557
	 * - label: string, a label displayed next to the radio button.  It will NOT be HTML-encoded. Therefore you can pass
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[encode()]] it to prevent XSS attacks.
	 *   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.
558 559 560
	 * - container: array|boolean, the HTML attributes for the container tag. This is only used when the "label" option is specified.
	 *   If it is false, no container will be rendered. If it is an array or not, a "div" container will be rendered
	 *   around the the radio button.
Qiang Xue committed
561
	 *
562
	 * The rest of the options will be rendered as the attributes of the resulting radio button tag. The values will
Qiang Xue committed
563 564 565 566
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
	 * @return string the generated radio button tag
	 */
Alexander Makarov committed
567
	public static function radio($name, $checked = false, $options = [])
Qiang Xue committed
568
	{
Qiang Xue committed
569
		$options['checked'] = (boolean)$checked;
570
		$value = array_key_exists('value', $options) ? $options['value'] : '1';
Qiang Xue committed
571 572 573 574 575 576 577
		if (isset($options['uncheck'])) {
			// add a hidden field so that if the radio button is not selected, it still submits a value
			$hidden = static::hiddenInput($name, $options['uncheck']);
			unset($options['uncheck']);
		} else {
			$hidden = '';
		}
578 579
		if (isset($options['label'])) {
			$label = $options['label'];
Alexander Makarov committed
580
			$labelOptions = isset($options['labelOptions']) ? $options['labelOptions'] : [];
581 582
			$container = isset($options['container']) ? $options['container'] : ['class' => 'radio'];
			unset($options['label'], $options['labelOptions'], $options['container']);
583
			$content = static::label(static::input('radio', $name, $value, $options) . ' ' . $label, null, $labelOptions);
584 585 586 587 588
			if (is_array($container)) {
				return $hidden . static::tag('div', $content, $container);
			} else {
				return $hidden . $content;
			}
589 590 591
		} else {
			return $hidden . static::input('radio', $name, $value, $options);
		}
Qiang Xue committed
592 593 594 595 596 597
	}

	/**
	 * Generates a checkbox input.
	 * @param string $name the name attribute.
	 * @param boolean $checked whether the checkbox should be checked.
Qiang Xue committed
598
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
Qiang Xue committed
599 600 601 602
	 *
	 * - uncheck: string, the value associated with the uncheck state of the checkbox. When this attribute
	 *   is present, a hidden input will be generated so that if the checkbox is not checked and is submitted,
	 *   the value of this attribute will still be submitted to the server via the hidden input.
603 604 605 606
	 * - label: string, a label displayed next to the checkbox.  It will NOT be HTML-encoded. Therefore you can pass
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[encode()]] it to prevent XSS attacks.
	 *   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.
607 608 609
	 * - container: array|boolean, the HTML attributes for the container tag. This is only used when the "label" option is specified.
	 *   If it is false, no container will be rendered. If it is an array or not, a "div" container will be rendered
	 *   around the the radio button.
Qiang Xue committed
610
	 *
611
	 * The rest of the options will be rendered as the attributes of the resulting checkbox tag. The values will
Qiang Xue committed
612 613 614 615
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 *
	 * @return string the generated checkbox tag
	 */
Alexander Makarov committed
616
	public static function checkbox($name, $checked = false, $options = [])
Qiang Xue committed
617
	{
Qiang Xue committed
618
		$options['checked'] = (boolean)$checked;
619
		$value = array_key_exists('value', $options) ? $options['value'] : '1';
Qiang Xue committed
620 621 622 623 624 625 626
		if (isset($options['uncheck'])) {
			// add a hidden field so that if the checkbox is not selected, it still submits a value
			$hidden = static::hiddenInput($name, $options['uncheck']);
			unset($options['uncheck']);
		} else {
			$hidden = '';
		}
627 628
		if (isset($options['label'])) {
			$label = $options['label'];
Alexander Makarov committed
629
			$labelOptions = isset($options['labelOptions']) ? $options['labelOptions'] : [];
630 631
			$container = isset($options['container']) ? $options['container'] : ['class' => 'checkbox'];
			unset($options['label'], $options['labelOptions'], $options['container']);
632
			$content = static::label(static::input('checkbox', $name, $value, $options) . ' ' . $label, null, $labelOptions);
633 634 635 636 637
			if (is_array($container)) {
				return $hidden . static::tag('div', $content, $container);
			} else {
				return $hidden . $content;
			}
638 639 640
		} else {
			return $hidden . static::input('checkbox', $name, $value, $options);
		}
Qiang Xue committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654
	}

	/**
	 * Generates a drop-down list.
	 * @param string $name the input name
	 * @param string $selection the selected value
	 * @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.
Qiang Xue committed
655
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
Qiang Xue committed
656 657 658 659 660 661
	 *
	 * - 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
662 663 664 665
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
666 667 668 669 670
	 * ~~~
	 *
	 * - 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.
	 *
671
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
672
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
673
	 *
Qiang Xue committed
674 675
	 * @return string the generated drop-down list tag
	 */
Alexander Makarov committed
676
	public static function dropDownList($name, $selection = null, $items = [], $options = [])
Qiang Xue committed
677
	{
Qiang Xue committed
678 679 680
		if (!empty($options['multiple'])) {
			return static::listBox($name, $selection, $items, $options);
		}
Qiang Xue committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
		$options['name'] = $name;
		$selectOptions = static::renderSelectOptions($selection, $items, $options);
		return static::tag('select', "\n" . $selectOptions . "\n", $options);
	}

	/**
	 * Generates a list box.
	 * @param string $name the input name
	 * @param string|array $selection the selected value(s)
	 * @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.
Qiang Xue committed
698
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
Qiang Xue committed
699 700 701 702 703 704
	 *
	 * - 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
705 706 707 708
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
709 710 711 712 713 714 715 716
	 * ~~~
	 *
	 * - 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.
	 *
717
	 * The rest of the options will be rendered as the attributes of the resulting tag. The values will
Qiang Xue committed
718
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
719
	 *
Qiang Xue committed
720 721
	 * @return string the generated list box tag
	 */
Alexander Makarov committed
722
	public static function listBox($name, $selection = null, $items = [], $options = [])
Qiang Xue committed
723
	{
724
		if (!array_key_exists('size', $options)) {
725 726
			$options['size'] = 4;
		}
Alexander Makarov committed
727
		if (!empty($options['multiple']) && substr($name, -2) !== '[]') {
Qiang Xue committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
			$name .= '[]';
		}
		$options['name'] = $name;
		if (isset($options['unselect'])) {
			// add a hidden field so that if the list box has no option being selected, it still submits a value
			if (substr($name, -2) === '[]') {
				$name = substr($name, 0, -2);
			}
			$hidden = static::hiddenInput($name, $options['unselect']);
			unset($options['unselect']);
		} else {
			$hidden = '';
		}
		$selectOptions = static::renderSelectOptions($selection, $items, $options);
		return $hidden . static::tag('select', "\n" . $selectOptions . "\n", $options);
	}

	/**
	 * Generates a list of checkboxes.
	 * A checkbox list allows multiple selection, like [[listBox()]].
	 * As a result, the corresponding submitted value is an array.
	 * @param string $name the name attribute of each checkbox.
	 * @param string|array $selection the selected value(s).
	 * @param array $items the data item used to generate the checkboxes.
752
	 * The array values are the labels, while the array keys are the corresponding checkbox values.
Qiang Xue committed
753 754
	 * @param array $options options (name => config) for the checkbox list container tag.
	 * The following options are specially handled:
Qiang Xue committed
755
	 *
Qiang Xue committed
756
	 * - tag: string, the tag name of the container element.
Qiang Xue committed
757 758
	 * - 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.
759 760
	 * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true.
	 *   This option is ignored if `item` option is set.
Qiang Xue committed
761
	 * - separator: string, the HTML code that separates items.
762
	 * - itemOptions: array, the options for generating the radio button tag using [[checkbox()]].
Qiang Xue committed
763 764 765 766 767 768 769 770 771
	 * - 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,
Qiang Xue committed
772
	 * value and the checked status of the checkbox input, respectively.
Qiang Xue committed
773 774
	 * @return string the generated checkbox list
	 */
Alexander Makarov committed
775
	public static function checkboxList($name, $selection = null, $items = [], $options = [])
Qiang Xue committed
776 777 778 779 780 781
	{
		if (substr($name, -2) !== '[]') {
			$name .= '[]';
		}

		$formatter = isset($options['item']) ? $options['item'] : null;
782
		$itemOptions = isset($options['itemOptions']) ? $options['itemOptions'] : [];
783
		$encode = !isset($options['encode']) || $options['encode'];
Alexander Makarov committed
784
		$lines = [];
Qiang Xue committed
785 786 787 788 789 790 791 792
		$index = 0;
		foreach ($items as $value => $label) {
			$checked = $selection !== null &&
				(!is_array($selection) && !strcmp($value, $selection)
					|| is_array($selection) && in_array($value, $selection));
			if ($formatter !== null) {
				$lines[] = call_user_func($formatter, $index, $label, $name, $checked, $value);
			} else {
793
				$lines[] = static::checkbox($name, $checked, array_merge($itemOptions, [
Qiang Xue committed
794 795
					'value' => $value,
					'label' => $encode ? static::encode($label) : $label,
796
				]));
Qiang Xue committed
797 798 799 800 801 802 803 804 805 806 807 808 809
			}
			$index++;
		}

		if (isset($options['unselect'])) {
			// add a hidden field so that if the list box has no option being selected, it still submits a value
			$name2 = substr($name, -2) === '[]' ? substr($name, 0, -2) : $name;
			$hidden = static::hiddenInput($name2, $options['unselect']);
		} else {
			$hidden = '';
		}
		$separator = isset($options['separator']) ? $options['separator'] : "\n";

Qiang Xue committed
810
		$tag = isset($options['tag']) ? $options['tag'] : 'div';
811
		unset($options['tag'], $options['unselect'], $options['encode'], $options['separator'], $options['item'], $options['itemOptions']);
Qiang Xue committed
812 813

		return $hidden . static::tag($tag, implode($separator, $lines), $options);
Qiang Xue committed
814 815 816 817 818 819 820 821
	}

	/**
	 * Generates a list of radio buttons.
	 * A radio button list is like a checkbox list, except that it only allows single selection.
	 * @param string $name the name attribute of each radio button.
	 * @param string|array $selection the selected value(s).
	 * @param array $items the data item used to generate the radio buttons.
Qiang Xue committed
822
	 * The array values are the labels, while the array keys are the corresponding radio button values.
Qiang Xue committed
823
	 * @param array $options options (name => config) for the radio button list. The following options are supported:
Qiang Xue committed
824 825 826
	 *
	 * - 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.
827 828
	 * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true.
	 *   This option is ignored if `item` option is set.
Qiang Xue committed
829
	 * - separator: string, the HTML code that separates items.
830
	 * - itemOptions: array, the options for generating the radio button tag using [[radio()]].
Qiang Xue committed
831 832 833 834 835 836 837 838 839
	 * - 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,
Qiang Xue committed
840
	 * value and the checked status of the radio button input, respectively.
Qiang Xue committed
841 842
	 * @return string the generated radio button list
	 */
Alexander Makarov committed
843
	public static function radioList($name, $selection = null, $items = [], $options = [])
Qiang Xue committed
844
	{
845
		$encode = !isset($options['encode']) || $options['encode'];
Qiang Xue committed
846
		$formatter = isset($options['item']) ? $options['item'] : null;
847
		$itemOptions = isset($options['itemOptions']) ? $options['itemOptions'] : [];
Alexander Makarov committed
848
		$lines = [];
Qiang Xue committed
849 850 851 852 853 854 855 856
		$index = 0;
		foreach ($items as $value => $label) {
			$checked = $selection !== null &&
				(!is_array($selection) && !strcmp($value, $selection)
					|| is_array($selection) && in_array($value, $selection));
			if ($formatter !== null) {
				$lines[] = call_user_func($formatter, $index, $label, $name, $checked, $value);
			} else {
857
				$lines[] = static::radio($name, $checked, array_merge($itemOptions, [
Qiang Xue committed
858 859
					'value' => $value,
					'label' => $encode ? static::encode($label) : $label,
860
				]));
Qiang Xue committed
861 862 863 864 865 866 867 868 869 870 871 872
			}
			$index++;
		}

		$separator = isset($options['separator']) ? $options['separator'] : "\n";
		if (isset($options['unselect'])) {
			// add a hidden field so that if the list box has no option being selected, it still submits a value
			$hidden = static::hiddenInput($name, $options['unselect']);
		} else {
			$hidden = '';
		}

Qiang Xue committed
873
		$tag = isset($options['tag']) ? $options['tag'] : 'div';
874
		unset($options['tag'], $options['unselect'], $options['encode'], $options['separator'], $options['item'], $options['itemOptions']);
Qiang Xue committed
875 876

		return $hidden . static::tag($tag, implode($separator, $lines), $options);
Qiang Xue committed
877 878
	}

879 880 881 882 883 884 885
	/**
	 * Generates an unordered list.
	 * @param array|\Traversable $items the items for generating the list. Each item generates a single list item.
	 * Note that items will be automatically HTML encoded if `$options['encode']` is not set or true.
	 * @param array $options options (name => config) for the radio button list. The following options are supported:
	 *
	 * - encode: boolean, whether to HTML-encode the items. Defaults to true.
886 887
	 *   This option is ignored if the `item` option is specified.
	 * - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified.
888 889 890 891
	 * - item: callable, a callback that is used to generate each individual list item.
	 *   The signature of this callback must be:
	 *
	 * ~~~
Qiang Xue committed
892
	 * function ($item, $index)
893 894 895 896 897 898 899
	 * ~~~
	 *
	 * where $index is the array key corresponding to `$item` in `$items`. The callback should return
	 * the whole list item tag.
	 *
	 * @return string the generated unordered list. An empty string is returned if `$items` is empty.
	 */
Alexander Makarov committed
900
	public static function ul($items, $options = [])
901 902 903 904 905 906 907
	{
		if (empty($items)) {
			return '';
		}
		$tag = isset($options['tag']) ? $options['tag'] : 'ul';
		$encode = !isset($options['encode']) || $options['encode'];
		$formatter = isset($options['item']) ? $options['item'] : null;
Alexander Makarov committed
908
		$itemOptions = isset($options['itemOptions']) ? $options['itemOptions'] : [];
909
		unset($options['tag'], $options['encode'], $options['item'], $options['itemOptions']);
Alexander Makarov committed
910
		$results = [];
911 912
		foreach ($items as $index => $item) {
			if ($formatter !== null) {
Qiang Xue committed
913
				$results[] = call_user_func($formatter, $item, $index);
914
			} else {
915
				$results[] = static::tag('li', $encode ? static::encode($item) : $item, $itemOptions);
916 917 918 919 920 921 922 923 924 925 926 927
			}
		}
		return static::tag($tag, "\n" . implode("\n", $results) . "\n", $options);
	}

	/**
	 * Generates an ordered list.
	 * @param array|\Traversable $items the items for generating the list. Each item generates a single list item.
	 * Note that items will be automatically HTML encoded if `$options['encode']` is not set or true.
	 * @param array $options options (name => config) for the radio button list. The following options are supported:
	 *
	 * - encode: boolean, whether to HTML-encode the items. Defaults to true.
928 929
	 *   This option is ignored if the `item` option is specified.
	 * - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified.
930 931 932 933
	 * - item: callable, a callback that is used to generate each individual list item.
	 *   The signature of this callback must be:
	 *
	 * ~~~
Qiang Xue committed
934
	 * function ($item, $index)
935 936 937 938 939 940 941
	 * ~~~
	 *
	 * where $index is the array key corresponding to `$item` in `$items`. The callback should return
	 * the whole list item tag.
	 *
	 * @return string the generated ordered list. An empty string is returned if `$items` is empty.
	 */
Alexander Makarov committed
942
	public static function ol($items, $options = [])
943 944 945 946 947
	{
		$options['tag'] = 'ol';
		return static::ul($items, $options);
	}

Qiang Xue committed
948 949 950 951 952 953 954 955 956 957 958
	/**
	 * Generates a label tag for the given model attribute.
	 * The label text is the label associated with the attribute, obtained via [[Model::getAttributeLabel()]].
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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()]].
	 * If a value is null, the corresponding attribute will not be rendered.
	 * The following options are specially handled:
	 *
959
	 * - label: this specifies the label to be displayed. Note that this will NOT be [[encode()|encoded]].
Qiang Xue committed
960 961
	 *   If this is not set, [[Model::getAttributeLabel()]] will be called to get the label for display
	 *   (after encoding).
Qiang Xue committed
962 963 964
	 *
	 * @return string the generated label tag
	 */
Alexander Makarov committed
965
	public static function activeLabel($model, $attribute, $options = [])
Qiang Xue committed
966
	{
967
		$for = array_key_exists('for', $options) ? $options['for'] : static::getInputId($model, $attribute);
Qiang Xue committed
968 969
		$attribute = static::getAttributeName($attribute);
		$label = isset($options['label']) ? $options['label'] : static::encode($model->getAttributeLabel($attribute));
Qiang Xue committed
970
		unset($options['label'], $options['for']);
Qiang Xue committed
971 972 973
		return static::label($label, $for, $options);
	}

Qiang Xue committed
974 975 976 977 978 979 980 981 982 983 984
	/**
	 * Generates a tag that contains the first validation error of the specified model attribute.
	 * Note that even if there is no validation error, this method will still return an empty error tag.
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @param array $options the tag options in terms of name-value pairs. 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:
	 *
Qiang Xue committed
985
	 * - tag: this specifies the tag name. If not set, "div" will be used.
Qiang Xue committed
986 987 988
	 *
	 * @return string the generated label tag
	 */
Alexander Makarov committed
989
	public static function error($model, $attribute, $options = [])
Qiang Xue committed
990 991 992
	{
		$attribute = static::getAttributeName($attribute);
		$error = $model->getFirstError($attribute);
Qiang Xue committed
993
		$tag = isset($options['tag']) ? $options['tag'] : 'div';
Qiang Xue committed
994 995 996 997
		unset($options['tag']);
		return Html::tag($tag, Html::encode($error), $options);
	}

Qiang Xue committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	/**
	 * Generates an 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 string $type the input type (e.g. 'text', 'password')
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1010
	public static function activeInput($type, $model, $attribute, $options = [])
Qiang Xue committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
		$value = isset($options['value']) ? $options['value'] : static::getAttributeValue($model, $attribute);
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
		return static::input($type, $name, $value, $options);
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1031
	public static function activeTextInput($model, $attribute, $options = [])
Qiang Xue committed
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
	{
		return static::activeInput('text', $model, $attribute, $options);
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1047
	public static function activeHiddenInput($model, $attribute, $options = [])
Qiang Xue committed
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
	{
		return static::activeInput('hidden', $model, $attribute, $options);
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1063
	public static function activePasswordInput($model, $attribute, $options = [])
Qiang Xue committed
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	{
		return static::activeInput('password', $model, $attribute, $options);
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1079
	public static function activeFileInput($model, $attribute, $options = [])
Qiang Xue committed
1080
	{
1081 1082
		// add a hidden field so that if a model only has a file field, we can
		// still use isset($_POST[$modelClass]) to detect if the input is submitted
Alexander Makarov committed
1083
		return static::activeHiddenInput($model, $attribute, ['id' => null, 'value' => ''])
1084
			. static::activeInput('file', $model, $attribute, $options);
Qiang Xue committed
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
	}

	/**
	 * Generates a textarea tag for the given model attribute.
	 * The model attribute value will be used as the content in the textarea.
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
	 */
Alexander Makarov committed
1097
	public static function activeTextarea($model, $attribute, $options = [])
Qiang Xue committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
	{
		$name = static::getInputName($model, $attribute);
		$value = static::getAttributeValue($model, $attribute);
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
		return static::textarea($name, $value, $options);
	}

	/**
	 * Generates a radio button tag for the given model attribute.
	 * This method will generate the "checked" tag attribute according to the model attribute value.
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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.
1119 1120 1121 1122
	 * - label: string, a label displayed next to the radio button.  It will NOT be HTML-encoded. Therefore you can pass
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[encode()]] it to prevent XSS attacks.
	 *   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
1123 1124 1125 1126 1127 1128
	 *
	 * 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 radio button tag
	 */
Alexander Makarov committed
1129
	public static function activeRadio($model, $attribute, $options = [])
Qiang Xue committed
1130 1131
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1132 1133 1134 1135 1136
		$value = static::getAttributeValue($model, $attribute);

		if (!array_key_exists('value', $options)) {
			$options['value'] = '1';
		}
Qiang Xue committed
1137
		if (!array_key_exists('uncheck', $options)) {
1138
			$options['uncheck'] = '0';
Qiang Xue committed
1139
		}
1140

Qiang Xue committed
1141
		$checked = "$value" === "{$options['value']}";
1142

Qiang Xue committed
1143 1144 1145
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1146
		return static::radio($name, $checked, $options);
Qiang Xue committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
	}

	/**
	 * Generates a checkbox tag for the given model attribute.
	 * This method will generate the "checked" tag attribute according to the model attribute value.
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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.
1161 1162 1163 1164
	 * - label: string, a label displayed next to the checkbox.  It will NOT be HTML-encoded. Therefore you can pass
	 *   in HTML code such as an image tag. If this is is coming from end users, you should [[encode()]] it to prevent XSS attacks.
	 *   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
1165 1166 1167 1168 1169 1170
	 *
	 * 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 checkbox tag
	 */
Alexander Makarov committed
1171
	public static function activeCheckbox($model, $attribute, $options = [])
Qiang Xue committed
1172 1173
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1174 1175
		$value = static::getAttributeValue($model, $attribute);

1176 1177 1178
		if (!array_key_exists('value', $options)) {
			$options['value'] = '1';
		}
Qiang Xue committed
1179
		if (!array_key_exists('uncheck', $options)) {
1180
			$options['uncheck'] = '0';
Qiang Xue committed
1181
		}
1182

Qiang Xue committed
1183
		$checked = "$value" === "{$options['value']}";
1184

Qiang Xue committed
1185 1186 1187
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1188
		return static::checkbox($name, $checked, $options);
Qiang Xue committed
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
1212 1213 1214 1215
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
	 * ~~~
	 *
	 * - 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
	 */
Alexander Makarov committed
1226
	public static function activeDropDownList($model, $attribute, $items, $options = [])
Qiang Xue committed
1227
	{
1228 1229 1230
		if (!empty($options['multiple'])) {
			return static::activeListBox($model, $attribute, $items, $options);
		}
Qiang Xue committed
1231
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1232
		$selection = static::getAttributeValue($model, $attribute);
Qiang Xue committed
1233 1234 1235
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1236
		return static::dropDownList($name, $selection, $items, $options);
Qiang Xue committed
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
	}

	/**
	 * Generates a list box.
	 * The selection of the list box is taken from the value of the model attribute.
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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
1260 1261 1262 1263
	 * [
	 *     'value1' => ['disabled' => true],
	 *     'value2' => ['label' => 'value 2'],
	 * ];
Qiang Xue committed
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
	 * ~~~
	 *
	 * - 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
	 */
Alexander Makarov committed
1277
	public static function activeListBox($model, $attribute, $items, $options = [])
Qiang Xue committed
1278 1279
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1280
		$selection = static::getAttributeValue($model, $attribute);
Qiang Xue committed
1281
		if (!array_key_exists('unselect', $options)) {
1282
			$options['unselect'] = '';
Qiang Xue committed
1283 1284 1285 1286
		}
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1287
		return static::listBox($name, $selection, $items, $options);
Qiang Xue committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @param array $items the data item used to generate the checkboxes.
1299
	 * The array values are the labels, while the array keys are the corresponding checkbox values.
Qiang Xue committed
1300 1301 1302 1303
	 * 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.
1304 1305
	 *   You may set this option to be null to prevent default value submission.
	 *   If this option is not set, an empty string will be submitted.
Qiang Xue committed
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
	 * - 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
	 */
Alexander Makarov committed
1319
	public static function activeCheckboxList($model, $attribute, $items, $options = [])
Qiang Xue committed
1320 1321
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1322
		$selection = static::getAttributeValue($model, $attribute);
Qiang Xue committed
1323
		if (!array_key_exists('unselect', $options)) {
1324
			$options['unselect'] = '';
Qiang Xue committed
1325
		}
Qiang Xue committed
1326 1327 1328
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1329
		return static::checkboxList($name, $selection, $items, $options);
Qiang Xue committed
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
	}

	/**
	 * 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 Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format
	 * about attribute expression.
	 * @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.
1345 1346
	 *   You may set this option to be null to prevent default value submission.
	 *   If this option is not set, an empty string will be submitted.
Qiang Xue committed
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
	 * - 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
	 */
Alexander Makarov committed
1360
	public static function activeRadioList($model, $attribute, $items, $options = [])
Qiang Xue committed
1361 1362
	{
		$name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute);
1363
		$selection = static::getAttributeValue($model, $attribute);
Qiang Xue committed
1364
		if (!array_key_exists('unselect', $options)) {
1365
			$options['unselect'] = '';
Qiang Xue committed
1366
		}
Qiang Xue committed
1367 1368 1369
		if (!array_key_exists('id', $options)) {
			$options['id'] = static::getInputId($model, $attribute);
		}
1370
		return static::radioList($name, $selection, $items, $options);
Qiang Xue committed
1371 1372
	}

Qiang Xue committed
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
	/**
	 * Renders the option tags that can be used by [[dropDownList()]] and [[listBox()]].
	 * @param string|array $selection the selected value(s). This can be either a string for single selection
	 * or an array for multiple selections.
	 * @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 $tagOptions the $options parameter that is passed to the [[dropDownList()]] or [[listBox()]] call.
	 * This method will take out these elements, if any: "prompt", "options" and "groups". See more details
	 * in [[dropDownList()]] for the explanation of these elements.
	 *
	 * @return string the generated list options
	 */
Alexander Makarov committed
1391
	public static function renderSelectOptions($selection, $items, &$tagOptions = [])
Qiang Xue committed
1392
	{
Alexander Makarov committed
1393
		$lines = [];
Qiang Xue committed
1394 1395
		if (isset($tagOptions['prompt'])) {
			$prompt = str_replace(' ', '&nbsp;', static::encode($tagOptions['prompt']));
Alexander Makarov committed
1396
			$lines[] = static::tag('option', $prompt, ['value' => '']);
Qiang Xue committed
1397 1398
		}

Alexander Makarov committed
1399 1400
		$options = isset($tagOptions['options']) ? $tagOptions['options'] : [];
		$groups = isset($tagOptions['groups']) ? $tagOptions['groups'] : [];
Qiang Xue committed
1401 1402 1403 1404
		unset($tagOptions['prompt'], $tagOptions['options'], $tagOptions['groups']);

		foreach ($items as $key => $value) {
			if (is_array($value)) {
Alexander Makarov committed
1405
				$groupAttrs = isset($groups[$key]) ? $groups[$key] : [];
Qiang Xue committed
1406
				$groupAttrs['label'] = $key;
Alexander Makarov committed
1407
				$attrs = ['options' => $options, 'groups' => $groups];
Qiang Xue committed
1408 1409 1410
				$content = static::renderSelectOptions($selection, $value, $attrs);
				$lines[] = static::tag('optgroup', "\n" . $content . "\n", $groupAttrs);
			} else {
Alexander Makarov committed
1411
				$attrs = isset($options[$key]) ? $options[$key] : [];
1412
				$attrs['value'] = (string)$key;
Qiang Xue committed
1413
				$attrs['selected'] = $selection !== null &&
Qiang Xue committed
1414
						(!is_array($selection) && !strcmp($key, $selection)
Qiang Xue committed
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
						|| is_array($selection) && in_array($key, $selection));
				$lines[] = static::tag('option', str_replace(' ', '&nbsp;', static::encode($value)), $attrs);
			}
		}

		return implode("\n", $lines);
	}

	/**
	 * Renders the HTML tag attributes.
1425
	 *
resurtm committed
1426 1427
	 * Attributes whose values are of boolean type will be treated as
	 * [boolean attributes](http://www.w3.org/TR/html5/infrastructure.html#boolean-attributes).
1428 1429 1430 1431 1432 1433 1434 1435
	 *
	 * Attributes whose values are null will not be rendered.
	 *
	 * The "data" attribute is specially handled when it is receiving an array value. In this case,
	 * the array will be "expanded" and a list data attributes will be rendered. For example,
	 * if `'data' => ['id' => 1, 'name' => 'yii']`, then this will be rendered:
	 * `data-id="1" data-name="yii"`.
	 *
Qiang Xue committed
1436 1437
	 * @param array $attributes attributes to be rendered. The attribute values will be HTML-encoded using [[encode()]].
	 * @return string the rendering result. If the attributes are not empty, they will be rendered
1438
	 * into a string with a leading white space (so that it can be directly appended to the tag name
Qiang Xue committed
1439 1440 1441 1442 1443
	 * in a tag. If there is no attribute, an empty string will be returned.
	 */
	public static function renderTagAttributes($attributes)
	{
		if (count($attributes) > 1) {
Alexander Makarov committed
1444
			$sorted = [];
Qiang Xue committed
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
			foreach (static::$attributeOrder as $name) {
				if (isset($attributes[$name])) {
					$sorted[$name] = $attributes[$name];
				}
			}
			$attributes = array_merge($sorted, $attributes);
		}

		$html = '';
		foreach ($attributes as $name => $value) {
1455 1456
			if (is_bool($value)) {
				if ($value) {
1457
					$html .= " $name";
Qiang Xue committed
1458
				}
1459 1460
			} elseif (is_array($value) && $name === 'data') {
				foreach ($value as $n => $v) {
Qiang Xue committed
1461
					$html .= " $name-$n=\"" . static::encode($v) . '"';
1462
				}
Qiang Xue committed
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
			} elseif ($value !== null) {
				$html .= " $name=\"" . static::encode($value) . '"';
			}
		}
		return $html;
	}

	/**
	 * Normalizes the input parameter to be a valid URL.
	 *
	 * If the input parameter
	 *
	 * - is an empty string: the currently requested URL will be returned;
Qiang Xue committed
1476
	 * - is a non-empty string: it will first be processed by [[Yii::getAlias()]]. If the result
1477
	 *   is an absolute URL, it will be returned without any change further; Otherwise, the result
Qiang Xue committed
1478
	 *   will be prefixed with [[\yii\web\Request::baseUrl]] and returned.
Qiang Xue committed
1479 1480
	 * - is an array: the first array element is considered a route, while the rest of the name-value
	 *   pairs are treated as the parameters to be used for URL creation using [[\yii\web\Controller::createUrl()]].
Alexander Makarov committed
1481
	 *   For example: `['post/index', 'page' => 2]`, `['index']`.
1482
	 *   In case there is no controller, [[\yii\web\UrlManager::createUrl()]] will be used.
Qiang Xue committed
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
	 *
	 * @param array|string $url the parameter to be used to generate a valid URL
	 * @return string the normalized URL
	 * @throws InvalidParamException if the parameter is invalid.
	 */
	public static function url($url)
	{
		if (is_array($url)) {
			if (isset($url[0])) {
				$route = $url[0];
				$params = array_splice($url, 1);
1494
				if (Yii::$app->controller instanceof \yii\web\Controller) {
Qiang Xue committed
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
					return Yii::$app->controller->createUrl($route, $params);
				} else {
					return Yii::$app->getUrlManager()->createUrl($route, $params);
				}
			} else {
				throw new InvalidParamException('The array specifying a URL must contain at least one element.');
			}
		} elseif ($url === '') {
			return Yii::$app->getRequest()->getUrl();
		} else {
Qiang Xue committed
1505
			$url = Yii::getAlias($url);
Carsten Brandt committed
1506
			if ($url !== '' && ($url[0] === '/' || $url[0] === '#' || strpos($url, '://') || !strncmp($url, './', 2))) {
Qiang Xue committed
1507 1508 1509 1510
				return $url;
			} else {
				return Yii::$app->getRequest()->getBaseUrl() . '/' . $url;
			}
Qiang Xue committed
1511 1512
		}
	}
Qiang Xue committed
1513

1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
	/**
	 * Adds a CSS class to the specified options.
	 * If the CSS class is already in the options, it will not be added again.
	 * @param array $options the options to be modified.
	 * @param string $class the CSS class to be added
	 */
	public static function addCssClass(&$options, $class)
	{
		if (isset($options['class'])) {
			$classes = ' ' . $options['class'] . ' ';
			if (($pos = strpos($classes, ' ' . $class . ' ')) === false) {
				$options['class'] .= ' ' . $class;
			}
		} else {
			$options['class'] = $class;
		}
	}

	/**
	 * Removes a CSS class from the specified options.
	 * @param array $options the options to be modified.
	 * @param string $class the CSS class to be removed
	 */
	public static function removeCssClass(&$options, $class)
	{
		if (isset($options['class'])) {
			$classes = array_unique(preg_split('/\s+/', $options['class'] . ' ' . $class, -1, PREG_SPLIT_NO_EMPTY));
			if (($index = array_search($class, $classes)) !== false) {
				unset($classes[$index]);
			}
			if (empty($classes)) {
				unset($options['class']);
			} else {
				$options['class'] = implode(' ', $classes);
			}
		}
	}

Qiang Xue committed
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
	/**
	 * Returns the real attribute name from the given attribute expression.
	 *
	 * An attribute expression is an attribute name prefixed and/or suffixed with array indexes.
	 * It is mainly used in tabular data input and/or input of array type. Below are some examples:
	 *
	 * - `[0]content` is used in tabular data input to represent the "content" attribute
	 *   for the first model in tabular input;
	 * - `dates[0]` represents the first array element of the "dates" attribute;
	 * - `[0]dates[0]` represents the first array element of the "dates" attribute
	 *   for the first model in tabular input.
	 *
	 * If `$attribute` has neither prefix nor suffix, it will be returned back without change.
	 * @param string $attribute the attribute name or expression
	 * @return string the attribute name without prefix and suffix.
	 * @throws InvalidParamException if the attribute name contains non-word characters.
	 */
	public static function getAttributeName($attribute)
	{
		if (preg_match('/(^|.*\])(\w+)(\[.*|$)/', $attribute, $matches)) {
			return $matches[2];
		} else {
			throw new InvalidParamException('Attribute name must contain word characters only.');
		}
	}

	/**
	 * Returns the value of the specified attribute name or expression.
	 *
	 * For an attribute expression like `[0]dates[0]`, this method will return the value of `$model->dates[0]`.
	 * See [[getAttributeName()]] for more details about attribute expression.
	 *
1584 1585 1586
	 * If an attribute value is an instance of [[ActiveRecordInterface]] or an array of such instances,
	 * the primary value(s) of the AR instance(s) will be returned instead.
	 *
Qiang Xue committed
1587 1588
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression
1589
	 * @return string|array the corresponding attribute value
Qiang Xue committed
1590 1591 1592 1593 1594 1595 1596 1597
	 * @throws InvalidParamException if the attribute name contains non-word characters.
	 */
	public static function getAttributeValue($model, $attribute)
	{
		if (!preg_match('/(^|.*\])(\w+)(\[.*|$)/', $attribute, $matches)) {
			throw new InvalidParamException('Attribute name must contain word characters only.');
		}
		$attribute = $matches[2];
1598 1599 1600
		$value = $model->$attribute;
		if ($matches[3] !== '') {
			foreach (explode('][', trim($matches[3], '[]')) as $id) {
Qiang Xue committed
1601 1602 1603 1604 1605 1606 1607
				if ((is_array($value) || $value instanceof \ArrayAccess) && isset($value[$id])) {
					$value = $value[$id];
				} else {
					return null;
				}
			}
		}
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621

		// https://github.com/yiisoft/yii2/issues/1457
		if (is_array($value)) {
			foreach ($value as $i => $v) {
				if ($v instanceof ActiveRecordInterface) {
					$v = $v->getPrimaryKey(false);
					$value[$i] = is_array($v) ? json_encode($v) : $v;
				}
			}
		} elseif ($value instanceof ActiveRecordInterface) {
			$value = $value->getPrimaryKey(false);
			return is_array($value) ? json_encode($value) : $value;
		}
		return $value;
Qiang Xue committed
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
	}

	/**
	 * Generates an appropriate input name for the specified attribute name or expression.
	 *
	 * This method generates a name that can be used as the input name to collect user input
	 * for the specified attribute. The name is generated according to the [[Model::formName|form name]]
	 * of the model and the given attribute name. For example, if the form name of the `Post` model
	 * is `Post`, then the input name generated for the `content` attribute would be `Post[content]`.
	 *
	 * See [[getAttributeName()]] for explanation of attribute expression.
	 *
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression
	 * @return string the generated input name
	 * @throws InvalidParamException if the attribute name contains non-word characters.
	 */
	public static function getInputName($model, $attribute)
	{
		$formName = $model->formName();
		if (!preg_match('/(^|.*\])(\w+)(\[.*|$)/', $attribute, $matches)) {
			throw new InvalidParamException('Attribute name must contain word characters only.');
		}
		$prefix = $matches[1];
		$attribute = $matches[2];
		$suffix = $matches[3];
		if ($formName === '' && $prefix === '') {
			return $attribute . $suffix;
		} elseif ($formName !== '') {
			return $formName . $prefix . "[$attribute]" . $suffix;
		} else {
			throw new InvalidParamException(get_class($model) . '::formName() cannot be empty for tabular inputs.');
		}
	}

	/**
	 * Generates an appropriate input ID for the specified attribute name or expression.
	 *
	 * This method converts the result [[getInputName()]] into a valid input ID.
Qiang Xue committed
1661
	 * For example, if [[getInputName()]] returns `Post[content]`, this method will return `post-content`.
Qiang Xue committed
1662 1663 1664 1665 1666 1667 1668
	 * @param Model $model the model object
	 * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for explanation of attribute expression.
	 * @return string the generated input ID
	 * @throws InvalidParamException if the attribute name contains non-word characters.
	 */
	public static function getInputId($model, $attribute)
	{
1669
		$name = strtolower(static::getInputName($model, $attribute));
Alexander Makarov committed
1670
		return str_replace(['[]', '][', '[', ']', ' '], ['', '-', '-', '', '-'], $name);
Qiang Xue committed
1671
	}
Qiang Xue committed
1672
}