Complex classes like BaseHtml often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use BaseHtml, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
25 | class BaseHtml |
||
26 | { |
||
27 | /** |
||
28 | * @var array list of void elements (element name => 1) |
||
29 | * @see http://www.w3.org/TR/html-markup/syntax.html#void-element |
||
30 | */ |
||
31 | public static $voidElements = [ |
||
32 | 'area' => 1, |
||
33 | 'base' => 1, |
||
34 | 'br' => 1, |
||
35 | 'col' => 1, |
||
36 | 'command' => 1, |
||
37 | 'embed' => 1, |
||
38 | 'hr' => 1, |
||
39 | 'img' => 1, |
||
40 | 'input' => 1, |
||
41 | 'keygen' => 1, |
||
42 | 'link' => 1, |
||
43 | 'meta' => 1, |
||
44 | 'param' => 1, |
||
45 | 'source' => 1, |
||
46 | 'track' => 1, |
||
47 | 'wbr' => 1, |
||
48 | ]; |
||
49 | /** |
||
50 | * @var array the preferred order of attributes in a tag. This mainly affects the order of the attributes |
||
51 | * that are rendered by [[renderTagAttributes()]]. |
||
52 | */ |
||
53 | public static $attributeOrder = [ |
||
54 | 'type', |
||
55 | 'id', |
||
56 | 'class', |
||
57 | 'name', |
||
58 | 'value', |
||
59 | |||
60 | 'href', |
||
61 | 'src', |
||
62 | 'action', |
||
63 | 'method', |
||
64 | |||
65 | 'selected', |
||
66 | 'checked', |
||
67 | 'readonly', |
||
68 | 'disabled', |
||
69 | 'multiple', |
||
70 | |||
71 | 'size', |
||
72 | 'maxlength', |
||
73 | 'width', |
||
74 | 'height', |
||
75 | 'rows', |
||
76 | 'cols', |
||
77 | |||
78 | 'alt', |
||
79 | 'title', |
||
80 | 'rel', |
||
81 | 'media', |
||
82 | ]; |
||
83 | /** |
||
84 | * @var array list of tag attributes that should be specially handled when their values are of array type. |
||
85 | * In particular, if the value of the `data` attribute is `['name' => 'xyz', 'age' => 13]`, two attributes |
||
86 | * will be generated instead of one: `data-name="xyz" data-age="13"`. |
||
87 | * @since 2.0.3 |
||
88 | */ |
||
89 | public static $dataAttributes = ['data', 'data-ng', 'ng']; |
||
90 | |||
91 | |||
92 | /** |
||
93 | * Encodes special characters into HTML entities. |
||
94 | * The [[\yii\base\Application::charset|application charset]] will be used for encoding. |
||
95 | * @param string $content the content to be encoded |
||
96 | * @param boolean $doubleEncode whether to encode HTML entities in `$content`. If false, |
||
97 | * HTML entities in `$content` will not be further encoded. |
||
98 | * @return string the encoded content |
||
99 | * @see decode() |
||
100 | * @see http://www.php.net/manual/en/function.htmlspecialchars.php |
||
101 | */ |
||
102 | 134 | public static function encode($content, $doubleEncode = true) |
|
106 | |||
107 | /** |
||
108 | * Decodes special HTML entities back to the corresponding characters. |
||
109 | * This is the opposite of [[encode()]]. |
||
110 | * @param string $content the content to be decoded |
||
111 | * @return string the decoded content |
||
112 | * @see encode() |
||
113 | * @see http://www.php.net/manual/en/function.htmlspecialchars-decode.php |
||
114 | */ |
||
115 | 1 | public static function decode($content) |
|
119 | |||
120 | /** |
||
121 | * Generates a complete HTML tag. |
||
122 | * @param string|boolean|null $name the tag name. If $name is `null` or `false`, the corresponding content will be rendered without any tag. |
||
123 | * @param string $content the content to be enclosed between the start and end tags. It will not be HTML-encoded. |
||
124 | * If this is coming from end users, you should consider [[encode()]] it to prevent XSS attacks. |
||
125 | * @param array $options the HTML tag attributes (HTML options) in terms of name-value pairs. |
||
126 | * These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
127 | * If a value is null, the corresponding attribute will not be rendered. |
||
128 | * |
||
129 | * For example when using `['class' => 'my-class', 'target' => '_blank', 'value' => null]` it will result in the |
||
130 | * html attributes rendered like this: `class="my-class" target="_blank"`. |
||
131 | * |
||
132 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
133 | * |
||
134 | * @return string the generated HTML tag |
||
135 | * @see beginTag() |
||
136 | * @see endTag() |
||
137 | */ |
||
138 | 128 | public static function tag($name, $content = '', $options = []) |
|
146 | |||
147 | /** |
||
148 | * Generates a start tag. |
||
149 | * @param string|boolean|null $name the tag name. If $name is `null` or `false`, the corresponding content will be rendered without any tag. |
||
150 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
151 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
152 | * If a value is null, the corresponding attribute will not be rendered. |
||
153 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
154 | * @return string the generated start tag |
||
155 | * @see endTag() |
||
156 | * @see tag() |
||
157 | */ |
||
158 | 29 | public static function beginTag($name, $options = []) |
|
165 | |||
166 | /** |
||
167 | * Generates an end tag. |
||
168 | * @param string|boolean|null $name the tag name. If $name is `null` or `false`, the corresponding content will be rendered without any tag. |
||
169 | * @return string the generated end tag |
||
170 | * @see beginTag() |
||
171 | * @see tag() |
||
172 | */ |
||
173 | 8 | public static function endTag($name) |
|
180 | |||
181 | /** |
||
182 | * Generates a style tag. |
||
183 | * @param string $content the style content |
||
184 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
185 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
186 | * If a value is null, the corresponding attribute will not be rendered. |
||
187 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
188 | * @return string the generated style tag |
||
189 | */ |
||
190 | 1 | public static function style($content, $options = []) |
|
194 | |||
195 | /** |
||
196 | * Generates a script tag. |
||
197 | * @param string $content the script content |
||
198 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
199 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
200 | * If a value is null, the corresponding attribute will not be rendered. |
||
201 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
202 | * @return string the generated script tag |
||
203 | */ |
||
204 | 1 | public static function script($content, $options = []) |
|
208 | |||
209 | /** |
||
210 | * Generates a link tag that refers to an external CSS file. |
||
211 | * @param array|string $url the URL of the external CSS file. This parameter will be processed by [[Url::to()]]. |
||
212 | * @param array $options the tag options in terms of name-value pairs. The following option is specially handled: |
||
213 | * |
||
214 | * - condition: specifies the conditional comments for IE, e.g., `lt IE 9`. When this is specified, |
||
215 | * the generated `link` tag will be enclosed within the conditional comments. This is mainly useful |
||
216 | * for supporting old versions of IE browsers. |
||
217 | * - noscript: if set to true, `link` tag will be wrapped into `<noscript>` tags. |
||
218 | * |
||
219 | * The rest of the options will be rendered as the attributes of the resulting link tag. The values will |
||
220 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
221 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
222 | * @return string the generated link tag |
||
223 | * @see Url::to() |
||
224 | */ |
||
225 | 19 | public static function cssFile($url, $options = []) |
|
243 | |||
244 | /** |
||
245 | * Generates a script tag that refers to an external JavaScript file. |
||
246 | * @param string $url the URL of the external JavaScript file. This parameter will be processed by [[Url::to()]]. |
||
247 | * @param array $options the tag options in terms of name-value pairs. The following option is specially handled: |
||
248 | * |
||
249 | * - condition: specifies the conditional comments for IE, e.g., `lt IE 9`. When this is specified, |
||
250 | * the generated `script` tag will be enclosed within the conditional comments. This is mainly useful |
||
251 | * for supporting old versions of IE browsers. |
||
252 | * |
||
253 | * The rest of the options will be rendered as the attributes of the resulting script tag. The values will |
||
254 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
255 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
256 | * @return string the generated script tag |
||
257 | * @see Url::to() |
||
258 | */ |
||
259 | 21 | public static function jsFile($url, $options = []) |
|
270 | |||
271 | /** |
||
272 | * Wraps given content into conditional comments for IE, e.g., `lt IE 9`. |
||
273 | * @param string $content raw HTML content. |
||
274 | * @param string $condition condition string. |
||
275 | * @return string generated HTML. |
||
276 | */ |
||
277 | 2 | private static function wrapIntoCondition($content, $condition) |
|
284 | |||
285 | /** |
||
286 | * Generates the meta tags containing CSRF token information. |
||
287 | * @return string the generated meta tags |
||
288 | * @see Request::enableCsrfValidation |
||
289 | */ |
||
290 | public static function csrfMetaTags() |
||
300 | |||
301 | /** |
||
302 | * Generates a form start tag. |
||
303 | * @param array|string $action the form action URL. This parameter will be processed by [[Url::to()]]. |
||
304 | * @param string $method the form submission method, such as "post", "get", "put", "delete" (case-insensitive). |
||
305 | * Since most browsers only support "post" and "get", if other methods are given, they will |
||
306 | * be simulated using "post", and a hidden input will be added which contains the actual method type. |
||
307 | * See [[\yii\web\Request::methodParam]] for more details. |
||
308 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
309 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
310 | * If a value is null, the corresponding attribute will not be rendered. |
||
311 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
312 | * |
||
313 | * Special options: |
||
314 | * |
||
315 | * - `csrf`: whether to generate the CSRF hidden input. Defaults to true. |
||
316 | * |
||
317 | * @return string the generated form start tag. |
||
318 | * @see endForm() |
||
319 | */ |
||
320 | 28 | public static function beginForm($action = '', $method = 'post', $options = []) |
|
365 | |||
366 | /** |
||
367 | * Generates a form end tag. |
||
368 | * @return string the generated tag |
||
369 | * @see beginForm() |
||
370 | */ |
||
371 | 27 | public static function endForm() |
|
375 | |||
376 | /** |
||
377 | * Generates a hyperlink tag. |
||
378 | * @param string $text link body. It will NOT be HTML-encoded. Therefore you can pass in HTML code |
||
379 | * such as an image tag. If this is coming from end users, you should consider [[encode()]] |
||
380 | * it to prevent XSS attacks. |
||
381 | * @param array|string|null $url the URL for the hyperlink tag. This parameter will be processed by [[Url::to()]] |
||
382 | * and will be used for the "href" attribute of the tag. If this parameter is null, the "href" attribute |
||
383 | * will not be generated. |
||
384 | * |
||
385 | * If you want to use an absolute url you can call [[Url::to()]] yourself, before passing the URL to this method, |
||
386 | * like this: |
||
387 | * |
||
388 | * ```php |
||
389 | * Html::a('link text', Url::to($url, true)) |
||
390 | * ``` |
||
391 | * |
||
392 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
393 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
394 | * If a value is null, the corresponding attribute will not be rendered. |
||
395 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
396 | * @return string the generated hyperlink |
||
397 | * @see \yii\helpers\Url::to() |
||
398 | */ |
||
399 | 10 | public static function a($text, $url = null, $options = []) |
|
406 | |||
407 | /** |
||
408 | * Generates a mailto hyperlink. |
||
409 | * @param string $text link body. It will NOT be HTML-encoded. Therefore you can pass in HTML code |
||
410 | * such as an image tag. If this is coming from end users, you should consider [[encode()]] |
||
411 | * it to prevent XSS attacks. |
||
412 | * @param string $email email address. If this is null, the first parameter (link body) will be treated |
||
413 | * as the email address and used. |
||
414 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
415 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
416 | * If a value is null, the corresponding attribute will not be rendered. |
||
417 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
418 | * @return string the generated mailto link |
||
419 | */ |
||
420 | 3 | public static function mailto($text, $email = null, $options = []) |
|
425 | |||
426 | /** |
||
427 | * Generates an image tag. |
||
428 | * @param array|string $src the image URL. This parameter will be processed by [[Url::to()]]. |
||
429 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
430 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
431 | * If a value is null, the corresponding attribute will not be rendered. |
||
432 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
433 | * @return string the generated image tag |
||
434 | */ |
||
435 | 2 | public static function img($src, $options = []) |
|
443 | |||
444 | /** |
||
445 | * Generates a label tag. |
||
446 | * @param string $content label text. It will NOT be HTML-encoded. Therefore you can pass in HTML code |
||
447 | * such as an image tag. If this is is coming from end users, you should [[encode()]] |
||
448 | * it to prevent XSS attacks. |
||
449 | * @param string $for the ID of the HTML element that this label is associated with. |
||
450 | * If this is null, the "for" attribute will not be generated. |
||
451 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
452 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
453 | * If a value is null, the corresponding attribute will not be rendered. |
||
454 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
455 | * @return string the generated label tag |
||
456 | */ |
||
457 | 13 | public static function label($content, $for = null, $options = []) |
|
462 | |||
463 | /** |
||
464 | * Generates a button tag. |
||
465 | * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded. |
||
466 | * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users, |
||
467 | * you should consider [[encode()]] it to prevent XSS attacks. |
||
468 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
469 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
470 | * If a value is null, the corresponding attribute will not be rendered. |
||
471 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
472 | * @return string the generated button tag |
||
473 | */ |
||
474 | 3 | public static function button($content = 'Button', $options = []) |
|
481 | |||
482 | /** |
||
483 | * Generates a submit button tag. |
||
484 | * |
||
485 | * Be careful when naming form elements such as submit buttons. According to the [jQuery documentation](https://api.jquery.com/submit/) there |
||
486 | * are some reserved names that can cause conflicts, e.g. `submit`, `length`, or `method`. |
||
487 | * |
||
488 | * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded. |
||
489 | * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users, |
||
490 | * you should consider [[encode()]] it to prevent XSS attacks. |
||
491 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
492 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
493 | * If a value is null, the corresponding attribute will not be rendered. |
||
494 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
495 | * @return string the generated submit button tag |
||
496 | */ |
||
497 | 1 | public static function submitButton($content = 'Submit', $options = []) |
|
502 | |||
503 | /** |
||
504 | * Generates a reset button tag. |
||
505 | * @param string $content the content enclosed within the button tag. It will NOT be HTML-encoded. |
||
506 | * Therefore you can pass in HTML code such as an image tag. If this is is coming from end users, |
||
507 | * you should consider [[encode()]] it to prevent XSS attacks. |
||
508 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
509 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
510 | * If a value is null, the corresponding attribute will not be rendered. |
||
511 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
512 | * @return string the generated reset button tag |
||
513 | */ |
||
514 | 1 | public static function resetButton($content = 'Reset', $options = []) |
|
519 | |||
520 | /** |
||
521 | * Generates an input type of the given type. |
||
522 | * @param string $type the type attribute. |
||
523 | * @param string $name the name attribute. If it is null, the name attribute will not be generated. |
||
524 | * @param string $value the value attribute. If it is null, the value attribute will not be generated. |
||
525 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
526 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
527 | * If a value is null, the corresponding attribute will not be rendered. |
||
528 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
529 | * @return string the generated input tag |
||
530 | */ |
||
531 | 47 | public static function input($type, $name = null, $value = null, $options = []) |
|
540 | |||
541 | /** |
||
542 | * Generates an input button. |
||
543 | * @param string $label the value attribute. If it is null, the value attribute will not be generated. |
||
544 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
545 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
546 | * If a value is null, the corresponding attribute will not be rendered. |
||
547 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
548 | * @return string the generated button tag |
||
549 | */ |
||
550 | 1 | public static function buttonInput($label = 'Button', $options = []) |
|
556 | |||
557 | /** |
||
558 | * Generates a submit input button. |
||
559 | * |
||
560 | * Be careful when naming form elements such as submit buttons. According to the [jQuery documentation](https://api.jquery.com/submit/) there |
||
561 | * are some reserved names that can cause conflicts, e.g. `submit`, `length`, or `method`. |
||
562 | * |
||
563 | * @param string $label the value attribute. If it is null, the value attribute will not be generated. |
||
564 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
565 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
566 | * If a value is null, the corresponding attribute will not be rendered. |
||
567 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
568 | * @return string the generated button tag |
||
569 | */ |
||
570 | 1 | public static function submitInput($label = 'Submit', $options = []) |
|
576 | |||
577 | /** |
||
578 | * Generates a reset input button. |
||
579 | * @param string $label the value attribute. If it is null, the value attribute will not be generated. |
||
580 | * @param array $options the attributes of the button tag. The values will be HTML-encoded using [[encode()]]. |
||
581 | * Attributes whose value is null will be ignored and not put in the tag returned. |
||
582 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
583 | * @return string the generated button tag |
||
584 | */ |
||
585 | 1 | public static function resetInput($label = 'Reset', $options = []) |
|
591 | |||
592 | /** |
||
593 | * Generates a text input field. |
||
594 | * @param string $name the name attribute. |
||
595 | * @param string $value the value attribute. If it is null, the value attribute will not be generated. |
||
596 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
597 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
598 | * If a value is null, the corresponding attribute will not be rendered. |
||
599 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
600 | * @return string the generated text input tag |
||
601 | */ |
||
602 | 1 | public static function textInput($name, $value = null, $options = []) |
|
606 | |||
607 | /** |
||
608 | * Generates a hidden input field. |
||
609 | * @param string $name the name attribute. |
||
610 | * @param string $value the value attribute. If it is null, the value attribute will not be generated. |
||
611 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
612 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
613 | * If a value is null, the corresponding attribute will not be rendered. |
||
614 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
615 | * @return string the generated hidden input tag |
||
616 | */ |
||
617 | 32 | public static function hiddenInput($name, $value = null, $options = []) |
|
621 | |||
622 | /** |
||
623 | * Generates a password input field. |
||
624 | * @param string $name the name attribute. |
||
625 | * @param string $value the value attribute. If it is null, the value attribute will not be generated. |
||
626 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
627 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
628 | * If a value is null, the corresponding attribute will not be rendered. |
||
629 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
630 | * @return string the generated password input tag |
||
631 | */ |
||
632 | 1 | public static function passwordInput($name, $value = null, $options = []) |
|
636 | |||
637 | /** |
||
638 | * Generates a file input field. |
||
639 | * To use a file input field, you should set the enclosing form's "enctype" attribute to |
||
640 | * be "multipart/form-data". After the form is submitted, the uploaded file information |
||
641 | * can be obtained via $_FILES[$name] (see PHP documentation). |
||
642 | * @param string $name the name attribute. |
||
643 | * @param string $value the value attribute. If it is null, the value attribute will not be generated. |
||
644 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
645 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
646 | * If a value is null, the corresponding attribute will not be rendered. |
||
647 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
648 | * @return string the generated file input tag |
||
649 | */ |
||
650 | 1 | public static function fileInput($name, $value = null, $options = []) |
|
654 | |||
655 | /** |
||
656 | * Generates a text area input. |
||
657 | * @param string $name the input name |
||
658 | * @param string $value the input value. Note that it will be encoded using [[encode()]]. |
||
659 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
660 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
661 | * If a value is null, the corresponding attribute will not be rendered. |
||
662 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
663 | * @return string the generated text area tag |
||
664 | */ |
||
665 | 5 | public static function textarea($name, $value = '', $options = []) |
|
670 | |||
671 | /** |
||
672 | * Generates a radio button input. |
||
673 | * @param string $name the name attribute. |
||
674 | * @param boolean $checked whether the radio button should be checked. |
||
675 | * @param array $options the tag options in terms of name-value pairs. |
||
676 | * See [[booleanInput()]] for details about accepted attributes. |
||
677 | * |
||
678 | * @return string the generated radio button tag |
||
679 | */ |
||
680 | 2 | public static function radio($name, $checked = false, $options = []) |
|
684 | |||
685 | /** |
||
686 | * Generates a checkbox input. |
||
687 | * @param string $name the name attribute. |
||
688 | * @param boolean $checked whether the checkbox should be checked. |
||
689 | * @param array $options the tag options in terms of name-value pairs. |
||
690 | * See [[booleanInput()]] for details about accepted attributes. |
||
691 | * |
||
692 | * @return string the generated checkbox tag |
||
693 | */ |
||
694 | 4 | public static function checkbox($name, $checked = false, $options = []) |
|
698 | |||
699 | /** |
||
700 | * Generates a boolean input. |
||
701 | * @param string $type the input type. This can be either `radio` or `checkbox`. |
||
702 | * @param string $name the name attribute. |
||
703 | * @param boolean $checked whether the checkbox should be checked. |
||
704 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
705 | * |
||
706 | * - uncheck: string, the value associated with the uncheck state of the checkbox. When this attribute |
||
707 | * is present, a hidden input will be generated so that if the checkbox is not checked and is submitted, |
||
708 | * the value of this attribute will still be submitted to the server via the hidden input. |
||
709 | * - label: string, a label displayed next to the checkbox. It will NOT be HTML-encoded. Therefore you can pass |
||
710 | * in HTML code such as an image tag. If this is is coming from end users, you should [[encode()]] it to prevent XSS attacks. |
||
711 | * When this option is specified, the checkbox will be enclosed by a label tag. |
||
712 | * - labelOptions: array, the HTML attributes for the label tag. Do not set this option unless you set the "label" option. |
||
713 | * |
||
714 | * The rest of the options will be rendered as the attributes of the resulting checkbox tag. The values will |
||
715 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
716 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
717 | * |
||
718 | * @return string the generated checkbox tag |
||
719 | * @since 2.0.9 |
||
720 | */ |
||
721 | 6 | protected static function booleanInput($type, $name, $checked = false, $options = []) |
|
742 | |||
743 | /** |
||
744 | * Generates a drop-down list. |
||
745 | * @param string $name the input name |
||
746 | * @param string $selection the selected value |
||
747 | * @param array $items the option data items. The array keys are option values, and the array values |
||
748 | * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). |
||
749 | * For each sub-array, an option group will be generated whose label is the key associated with the sub-array. |
||
750 | * If you have a list of data models, you may convert them into the format described above using |
||
751 | * [[\yii\helpers\ArrayHelper::map()]]. |
||
752 | * |
||
753 | * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in |
||
754 | * the labels will also be HTML-encoded. |
||
755 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
756 | * |
||
757 | * - prompt: string, a prompt text to be displayed as the first option; |
||
758 | * - options: array, the attributes for the select option tags. The array keys must be valid option values, |
||
759 | * and the array values are the extra attributes for the corresponding option tags. For example, |
||
760 | * |
||
761 | * ```php |
||
762 | * [ |
||
763 | * 'value1' => ['disabled' => true], |
||
764 | * 'value2' => ['label' => 'value 2'], |
||
765 | * ]; |
||
766 | * ``` |
||
767 | * |
||
768 | * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', |
||
769 | * except that the array keys represent the optgroup labels specified in $items. |
||
770 | * - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. |
||
771 | * Defaults to false. |
||
772 | * - encode: bool, whether to encode option prompt and option value characters. |
||
773 | * Defaults to `true`. This option is available since 2.0.3. |
||
774 | * |
||
775 | * The rest of the options will be rendered as the attributes of the resulting tag. The values will |
||
776 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
777 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
778 | * |
||
779 | * @return string the generated drop-down list tag |
||
780 | */ |
||
781 | 1 | public static function dropDownList($name, $selection = null, $items = [], $options = []) |
|
791 | |||
792 | /** |
||
793 | * Generates a list box. |
||
794 | * @param string $name the input name |
||
795 | * @param string|array $selection the selected value(s) |
||
796 | * @param array $items the option data items. The array keys are option values, and the array values |
||
797 | * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). |
||
798 | * For each sub-array, an option group will be generated whose label is the key associated with the sub-array. |
||
799 | * If you have a list of data models, you may convert them into the format described above using |
||
800 | * [[\yii\helpers\ArrayHelper::map()]]. |
||
801 | * |
||
802 | * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in |
||
803 | * the labels will also be HTML-encoded. |
||
804 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
805 | * |
||
806 | * - prompt: string, a prompt text to be displayed as the first option; |
||
807 | * - options: array, the attributes for the select option tags. The array keys must be valid option values, |
||
808 | * and the array values are the extra attributes for the corresponding option tags. For example, |
||
809 | * |
||
810 | * ```php |
||
811 | * [ |
||
812 | * 'value1' => ['disabled' => true], |
||
813 | * 'value2' => ['label' => 'value 2'], |
||
814 | * ]; |
||
815 | * ``` |
||
816 | * |
||
817 | * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', |
||
818 | * except that the array keys represent the optgroup labels specified in $items. |
||
819 | * - unselect: string, the value that will be submitted when no option is selected. |
||
820 | * When this attribute is set, a hidden field will be generated so that if no option is selected in multiple |
||
821 | * mode, we can still obtain the posted unselect value. |
||
822 | * - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. |
||
823 | * Defaults to false. |
||
824 | * - encode: bool, whether to encode option prompt and option value characters. |
||
825 | * Defaults to `true`. This option is available since 2.0.3. |
||
826 | * |
||
827 | * The rest of the options will be rendered as the attributes of the resulting tag. The values will |
||
828 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
829 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
830 | * |
||
831 | * @return string the generated list box tag |
||
832 | */ |
||
833 | 3 | public static function listBox($name, $selection = null, $items = [], $options = []) |
|
855 | |||
856 | /** |
||
857 | * Generates a list of checkboxes. |
||
858 | * A checkbox list allows multiple selection, like [[listBox()]]. |
||
859 | * As a result, the corresponding submitted value is an array. |
||
860 | * @param string $name the name attribute of each checkbox. |
||
861 | * @param string|array $selection the selected value(s). |
||
862 | * @param array $items the data item used to generate the checkboxes. |
||
863 | * The array keys are the checkbox values, while the array values are the corresponding labels. |
||
864 | * @param array $options options (name => config) for the checkbox list container tag. |
||
865 | * The following options are specially handled: |
||
866 | * |
||
867 | * - tag: string|false, the tag name of the container element. False to render checkbox without container. |
||
868 | * See also [[tag()]]. |
||
869 | * - unselect: string, the value that should be submitted when none of the checkboxes is selected. |
||
870 | * By setting this option, a hidden input will be generated. |
||
871 | * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. |
||
872 | * This option is ignored if `item` option is set. |
||
873 | * - separator: string, the HTML code that separates items. |
||
874 | * - itemOptions: array, the options for generating the checkbox tag using [[checkbox()]]. |
||
875 | * - item: callable, a callback that can be used to customize the generation of the HTML code |
||
876 | * corresponding to a single item in $items. The signature of this callback must be: |
||
877 | * |
||
878 | * ```php |
||
879 | * function ($index, $label, $name, $checked, $value) |
||
880 | * ``` |
||
881 | * |
||
882 | * where $index is the zero-based index of the checkbox in the whole list; $label |
||
883 | * is the label for the checkbox; and $name, $value and $checked represent the name, |
||
884 | * value and the checked status of the checkbox input, respectively. |
||
885 | * |
||
886 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
887 | * |
||
888 | * @return string the generated checkbox list |
||
889 | */ |
||
890 | 1 | public static function checkboxList($name, $selection = null, $items = [], $options = []) |
|
936 | |||
937 | /** |
||
938 | * Generates a list of radio buttons. |
||
939 | * A radio button list is like a checkbox list, except that it only allows single selection. |
||
940 | * @param string $name the name attribute of each radio button. |
||
941 | * @param string|array $selection the selected value(s). |
||
942 | * @param array $items the data item used to generate the radio buttons. |
||
943 | * The array keys are the radio button values, while the array values are the corresponding labels. |
||
944 | * @param array $options options (name => config) for the radio button list container tag. |
||
945 | * The following options are specially handled: |
||
946 | * |
||
947 | * - tag: string|false, the tag name of the container element. False to render radio buttons without container. |
||
948 | * See also [[tag()]]. |
||
949 | * - unselect: string, the value that should be submitted when none of the radio buttons is selected. |
||
950 | * By setting this option, a hidden input will be generated. |
||
951 | * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. |
||
952 | * This option is ignored if `item` option is set. |
||
953 | * - separator: string, the HTML code that separates items. |
||
954 | * - itemOptions: array, the options for generating the radio button tag using [[radio()]]. |
||
955 | * - item: callable, a callback that can be used to customize the generation of the HTML code |
||
956 | * corresponding to a single item in $items. The signature of this callback must be: |
||
957 | * |
||
958 | * ```php |
||
959 | * function ($index, $label, $name, $checked, $value) |
||
960 | * ``` |
||
961 | * |
||
962 | * where $index is the zero-based index of the radio button in the whole list; $label |
||
963 | * is the label for the radio button; and $name, $value and $checked represent the name, |
||
964 | * value and the checked status of the radio button input, respectively. |
||
965 | * |
||
966 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
967 | * |
||
968 | * @return string the generated radio button list |
||
969 | */ |
||
970 | 1 | public static function radioList($name, $selection = null, $items = [], $options = []) |
|
1005 | |||
1006 | /** |
||
1007 | * Generates an unordered list. |
||
1008 | * @param array|\Traversable $items the items for generating the list. Each item generates a single list item. |
||
1009 | * Note that items will be automatically HTML encoded if `$options['encode']` is not set or true. |
||
1010 | * @param array $options options (name => config) for the radio button list. The following options are supported: |
||
1011 | * |
||
1012 | * - encode: boolean, whether to HTML-encode the items. Defaults to true. |
||
1013 | * This option is ignored if the `item` option is specified. |
||
1014 | * - separator: string, the HTML code that separates items. Defaults to a simple newline (`"\n"`). |
||
1015 | * This option is available since version 2.0.7. |
||
1016 | * - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified. |
||
1017 | * - item: callable, a callback that is used to generate each individual list item. |
||
1018 | * The signature of this callback must be: |
||
1019 | * |
||
1020 | * ```php |
||
1021 | * function ($item, $index) |
||
1022 | * ``` |
||
1023 | * |
||
1024 | * where $index is the array key corresponding to `$item` in `$items`. The callback should return |
||
1025 | * the whole list item tag. |
||
1026 | * |
||
1027 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1028 | * |
||
1029 | * @return string the generated unordered list. An empty list tag will be returned if `$items` is empty. |
||
1030 | */ |
||
1031 | 4 | public static function ul($items, $options = []) |
|
1058 | |||
1059 | /** |
||
1060 | * Generates an ordered list. |
||
1061 | * @param array|\Traversable $items the items for generating the list. Each item generates a single list item. |
||
1062 | * Note that items will be automatically HTML encoded if `$options['encode']` is not set or true. |
||
1063 | * @param array $options options (name => config) for the radio button list. The following options are supported: |
||
1064 | * |
||
1065 | * - encode: boolean, whether to HTML-encode the items. Defaults to true. |
||
1066 | * This option is ignored if the `item` option is specified. |
||
1067 | * - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified. |
||
1068 | * - item: callable, a callback that is used to generate each individual list item. |
||
1069 | * The signature of this callback must be: |
||
1070 | * |
||
1071 | * ```php |
||
1072 | * function ($item, $index) |
||
1073 | * ``` |
||
1074 | * |
||
1075 | * where $index is the array key corresponding to `$item` in `$items`. The callback should return |
||
1076 | * the whole list item tag. |
||
1077 | * |
||
1078 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1079 | * |
||
1080 | * @return string the generated ordered list. An empty string is returned if `$items` is empty. |
||
1081 | */ |
||
1082 | 1 | public static function ol($items, $options = []) |
|
1087 | |||
1088 | /** |
||
1089 | * Generates a label tag for the given model attribute. |
||
1090 | * The label text is the label associated with the attribute, obtained via [[Model::getAttributeLabel()]]. |
||
1091 | * @param Model $model the model object |
||
1092 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1093 | * about attribute expression. |
||
1094 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1095 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1096 | * If a value is null, the corresponding attribute will not be rendered. |
||
1097 | * The following options are specially handled: |
||
1098 | * |
||
1099 | * - label: this specifies the label to be displayed. Note that this will NOT be [[encode()|encoded]]. |
||
1100 | * If this is not set, [[Model::getAttributeLabel()]] will be called to get the label for display |
||
1101 | * (after encoding). |
||
1102 | * |
||
1103 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1104 | * |
||
1105 | * @return string the generated label tag |
||
1106 | */ |
||
1107 | 8 | public static function activeLabel($model, $attribute, $options = []) |
|
1114 | |||
1115 | /** |
||
1116 | * Generates a hint tag for the given model attribute. |
||
1117 | * The hint text is the hint associated with the attribute, obtained via [[Model::getAttributeHint()]]. |
||
1118 | * If no hint content can be obtained, method will return an empty string. |
||
1119 | * @param Model $model the model object |
||
1120 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1121 | * about attribute expression. |
||
1122 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1123 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1124 | * If a value is null, the corresponding attribute will not be rendered. |
||
1125 | * The following options are specially handled: |
||
1126 | * |
||
1127 | * - hint: this specifies the hint to be displayed. Note that this will NOT be [[encode()|encoded]]. |
||
1128 | * If this is not set, [[Model::getAttributeHint()]] will be called to get the hint for display |
||
1129 | * (without encoding). |
||
1130 | * |
||
1131 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1132 | * |
||
1133 | * @return string the generated hint tag |
||
1134 | * @since 2.0.4 |
||
1135 | */ |
||
1136 | 8 | public static function activeHint($model, $attribute, $options = []) |
|
1147 | |||
1148 | /** |
||
1149 | * Generates a summary of the validation errors. |
||
1150 | * If there is no validation error, an empty error summary markup will still be generated, but it will be hidden. |
||
1151 | * @param Model|Model[] $models the model(s) whose validation errors are to be displayed. |
||
1152 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
1153 | * |
||
1154 | * - header: string, the header HTML for the error summary. If not set, a default prompt string will be used. |
||
1155 | * - footer: string, the footer HTML for the error summary. Defaults to empty string. |
||
1156 | * - encode: boolean, if set to false then the error messages won't be encoded. Defaults to `true`. |
||
1157 | * - showAllErrors: boolean, if set to true every error message for each attribute will be shown otherwise |
||
1158 | * only the first error message for each attribute will be shown. Defaults to `false`. |
||
1159 | * Option is available since 2.0.10. |
||
1160 | * |
||
1161 | * The rest of the options will be rendered as the attributes of the container tag. |
||
1162 | * |
||
1163 | * @return string the generated error summary |
||
1164 | */ |
||
1165 | 7 | public static function errorSummary($models, $options = []) |
|
1201 | |||
1202 | /** |
||
1203 | * Generates a tag that contains the first validation error of the specified model attribute. |
||
1204 | * Note that even if there is no validation error, this method will still return an empty error tag. |
||
1205 | * @param Model $model the model object |
||
1206 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1207 | * about attribute expression. |
||
1208 | * @param array $options the tag options in terms of name-value pairs. The values will be HTML-encoded |
||
1209 | * using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
1210 | * |
||
1211 | * The following options are specially handled: |
||
1212 | * |
||
1213 | * - tag: this specifies the tag name. If not set, "div" will be used. |
||
1214 | * See also [[tag()]]. |
||
1215 | * - encode: boolean, if set to false then the error message won't be encoded. |
||
1216 | * |
||
1217 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1218 | * |
||
1219 | * @return string the generated label tag |
||
1220 | */ |
||
1221 | 6 | public static function error($model, $attribute, $options = []) |
|
1229 | |||
1230 | /** |
||
1231 | * Generates an input tag for the given model attribute. |
||
1232 | * This method will generate the "name" and "value" tag attributes automatically for the model attribute |
||
1233 | * unless they are explicitly specified in `$options`. |
||
1234 | * @param string $type the input type (e.g. 'text', 'password') |
||
1235 | * @param Model $model the model object |
||
1236 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1237 | * about attribute expression. |
||
1238 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1239 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1240 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1241 | * @return string the generated input tag |
||
1242 | */ |
||
1243 | 16 | public static function activeInput($type, $model, $attribute, $options = []) |
|
1252 | |||
1253 | /** |
||
1254 | * If `maxlength` option is set true and the model attribute is validated by a string validator, |
||
1255 | * the `maxlength` option will take the value of [[\yii\validators\StringValidator::max]]. |
||
1256 | * @param Model $model the model object |
||
1257 | * @param string $attribute the attribute name or expression. |
||
1258 | * @param array $options the tag options in terms of name-value pairs. |
||
1259 | */ |
||
1260 | 16 | private static function normalizeMaxLength($model, $attribute, &$options) |
|
1273 | |||
1274 | /** |
||
1275 | * Generates a text input tag for the given model attribute. |
||
1276 | * This method will generate the "name" and "value" tag attributes automatically for the model attribute |
||
1277 | * unless they are explicitly specified in `$options`. |
||
1278 | * @param Model $model the model object |
||
1279 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1280 | * about attribute expression. |
||
1281 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1282 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1283 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1284 | * The following special options are recognized: |
||
1285 | * |
||
1286 | * - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated |
||
1287 | * by a string validator, the `maxlength` option will take the value of [[\yii\validators\StringValidator::max]]. |
||
1288 | * This is available since version 2.0.3. |
||
1289 | * |
||
1290 | * @return string the generated input tag |
||
1291 | */ |
||
1292 | 9 | public static function activeTextInput($model, $attribute, $options = []) |
|
1297 | |||
1298 | /** |
||
1299 | * Generates a hidden input tag for the given model attribute. |
||
1300 | * This method will generate the "name" and "value" tag attributes automatically for the model attribute |
||
1301 | * unless they are explicitly specified in `$options`. |
||
1302 | * @param Model $model the model object |
||
1303 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1304 | * about attribute expression. |
||
1305 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1306 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1307 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1308 | * @return string the generated input tag |
||
1309 | */ |
||
1310 | 2 | public static function activeHiddenInput($model, $attribute, $options = []) |
|
1314 | |||
1315 | /** |
||
1316 | * Generates a password input tag for the given model attribute. |
||
1317 | * This method will generate the "name" and "value" tag attributes automatically for the model attribute |
||
1318 | * unless they are explicitly specified in `$options`. |
||
1319 | * @param Model $model the model object |
||
1320 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1321 | * about attribute expression. |
||
1322 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1323 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1324 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1325 | * The following special options are recognized: |
||
1326 | * |
||
1327 | * - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated |
||
1328 | * by a string validator, the `maxlength` option will take the value of [[\yii\validators\StringValidator::max]]. |
||
1329 | * This option is available since version 2.0.6. |
||
1330 | * |
||
1331 | * @return string the generated input tag |
||
1332 | */ |
||
1333 | 3 | public static function activePasswordInput($model, $attribute, $options = []) |
|
1338 | |||
1339 | /** |
||
1340 | * Generates a file input tag for the given model attribute. |
||
1341 | * This method will generate the "name" and "value" tag attributes automatically for the model attribute |
||
1342 | * unless they are explicitly specified in `$options`. |
||
1343 | * @param Model $model the model object |
||
1344 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1345 | * about attribute expression. |
||
1346 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1347 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1348 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1349 | * @return string the generated input tag |
||
1350 | */ |
||
1351 | 1 | public static function activeFileInput($model, $attribute, $options = []) |
|
1362 | |||
1363 | /** |
||
1364 | * Generates a textarea tag for the given model attribute. |
||
1365 | * The model attribute value will be used as the content in the textarea. |
||
1366 | * @param Model $model the model object |
||
1367 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1368 | * about attribute expression. |
||
1369 | * @param array $options the tag options in terms of name-value pairs. These will be rendered as |
||
1370 | * the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. |
||
1371 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1372 | * The following special options are recognized: |
||
1373 | * |
||
1374 | * - maxlength: integer|boolean, when `maxlength` is set true and the model attribute is validated |
||
1375 | * by a string validator, the `maxlength` option will take the value of [[\yii\validators\StringValidator::max]]. |
||
1376 | * This option is available since version 2.0.6. |
||
1377 | * |
||
1378 | * @return string the generated textarea tag |
||
1379 | */ |
||
1380 | 4 | public static function activeTextarea($model, $attribute, $options = []) |
|
1395 | |||
1396 | /** |
||
1397 | * Generates a radio button tag together with a label for the given model attribute. |
||
1398 | * This method will generate the "checked" tag attribute according to the model attribute value. |
||
1399 | * @param Model $model the model object |
||
1400 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1401 | * about attribute expression. |
||
1402 | * @param array $options the tag options in terms of name-value pairs. |
||
1403 | * See [[booleanInput()]] for details about accepted attributes. |
||
1404 | * |
||
1405 | * @return string the generated radio button tag |
||
1406 | */ |
||
1407 | public static function activeRadio($model, $attribute, $options = []) |
||
1411 | |||
1412 | /** |
||
1413 | * Generates a checkbox tag together with a label for the given model attribute. |
||
1414 | * This method will generate the "checked" tag attribute according to the model attribute value. |
||
1415 | * @param Model $model the model object |
||
1416 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1417 | * about attribute expression. |
||
1418 | * @param array $options the tag options in terms of name-value pairs. |
||
1419 | * See [[booleanInput()]] for details about accepted attributes. |
||
1420 | * |
||
1421 | * @return string the generated checkbox tag |
||
1422 | */ |
||
1423 | public static function activeCheckbox($model, $attribute, $options = []) |
||
1427 | |||
1428 | /** |
||
1429 | * Generates a boolean input |
||
1430 | * This method is mainly called by [[activeCheckbox()]] and [[activeRadio()]]. |
||
1431 | * @param string $type the input type. This can be either `radio` or `checkbox`. |
||
1432 | * @param Model $model the model object |
||
1433 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1434 | * about attribute expression. |
||
1435 | * @param array $options the tag options in terms of name-value pairs. |
||
1436 | * See [[booleanInput()]] for details about accepted attributes. |
||
1437 | * @return string the generated input element |
||
1438 | * @since 2.0.9 |
||
1439 | */ |
||
1440 | protected static function activeBooleanInput($type, $model, $attribute, $options = []) |
||
1463 | |||
1464 | /** |
||
1465 | * Generates a drop-down list for the given model attribute. |
||
1466 | * The selection of the drop-down list is taken from the value of the model attribute. |
||
1467 | * @param Model $model the model object |
||
1468 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1469 | * about attribute expression. |
||
1470 | * @param array $items the option data items. The array keys are option values, and the array values |
||
1471 | * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). |
||
1472 | * For each sub-array, an option group will be generated whose label is the key associated with the sub-array. |
||
1473 | * If you have a list of data models, you may convert them into the format described above using |
||
1474 | * [[\yii\helpers\ArrayHelper::map()]]. |
||
1475 | * |
||
1476 | * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in |
||
1477 | * the labels will also be HTML-encoded. |
||
1478 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
1479 | * |
||
1480 | * - prompt: string, a prompt text to be displayed as the first option; |
||
1481 | * - options: array, the attributes for the select option tags. The array keys must be valid option values, |
||
1482 | * and the array values are the extra attributes for the corresponding option tags. For example, |
||
1483 | * |
||
1484 | * ```php |
||
1485 | * [ |
||
1486 | * 'value1' => ['disabled' => true], |
||
1487 | * 'value2' => ['label' => 'value 2'], |
||
1488 | * ]; |
||
1489 | * ``` |
||
1490 | * |
||
1491 | * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', |
||
1492 | * except that the array keys represent the optgroup labels specified in $items. |
||
1493 | * - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. |
||
1494 | * Defaults to false. |
||
1495 | * - encode: bool, whether to encode option prompt and option value characters. |
||
1496 | * Defaults to `true`. This option is available since 2.0.3. |
||
1497 | * |
||
1498 | * The rest of the options will be rendered as the attributes of the resulting tag. The values will |
||
1499 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
1500 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1501 | * |
||
1502 | * @return string the generated drop-down list tag |
||
1503 | */ |
||
1504 | public static function activeDropDownList($model, $attribute, $items, $options = []) |
||
1512 | |||
1513 | /** |
||
1514 | * Generates a list box. |
||
1515 | * The selection of the list box is taken from the value of the model attribute. |
||
1516 | * @param Model $model the model object |
||
1517 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1518 | * about attribute expression. |
||
1519 | * @param array $items the option data items. The array keys are option values, and the array values |
||
1520 | * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). |
||
1521 | * For each sub-array, an option group will be generated whose label is the key associated with the sub-array. |
||
1522 | * If you have a list of data models, you may convert them into the format described above using |
||
1523 | * [[\yii\helpers\ArrayHelper::map()]]. |
||
1524 | * |
||
1525 | * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in |
||
1526 | * the labels will also be HTML-encoded. |
||
1527 | * @param array $options the tag options in terms of name-value pairs. The following options are specially handled: |
||
1528 | * |
||
1529 | * - prompt: string, a prompt text to be displayed as the first option; |
||
1530 | * - options: array, the attributes for the select option tags. The array keys must be valid option values, |
||
1531 | * and the array values are the extra attributes for the corresponding option tags. For example, |
||
1532 | * |
||
1533 | * ```php |
||
1534 | * [ |
||
1535 | * 'value1' => ['disabled' => true], |
||
1536 | * 'value2' => ['label' => 'value 2'], |
||
1537 | * ]; |
||
1538 | * ``` |
||
1539 | * |
||
1540 | * - groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options', |
||
1541 | * except that the array keys represent the optgroup labels specified in $items. |
||
1542 | * - unselect: string, the value that will be submitted when no option is selected. |
||
1543 | * When this attribute is set, a hidden field will be generated so that if no option is selected in multiple |
||
1544 | * mode, we can still obtain the posted unselect value. |
||
1545 | * - encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character. |
||
1546 | * Defaults to false. |
||
1547 | * - encode: bool, whether to encode option prompt and option value characters. |
||
1548 | * Defaults to `true`. This option is available since 2.0.3. |
||
1549 | * |
||
1550 | * The rest of the options will be rendered as the attributes of the resulting tag. The values will |
||
1551 | * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered. |
||
1552 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1553 | * |
||
1554 | * @return string the generated list box tag |
||
1555 | */ |
||
1556 | 2 | public static function activeListBox($model, $attribute, $items, $options = []) |
|
1560 | |||
1561 | /** |
||
1562 | * Generates a list of checkboxes. |
||
1563 | * A checkbox list allows multiple selection, like [[listBox()]]. |
||
1564 | * As a result, the corresponding submitted value is an array. |
||
1565 | * The selection of the checkbox list is taken from the value of the model attribute. |
||
1566 | * @param Model $model the model object |
||
1567 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1568 | * about attribute expression. |
||
1569 | * @param array $items the data item used to generate the checkboxes. |
||
1570 | * The array keys are the checkbox values, and the array values are the corresponding labels. |
||
1571 | * Note that the labels will NOT be HTML-encoded, while the values will. |
||
1572 | * @param array $options options (name => config) for the checkbox list container tag. |
||
1573 | * The following options are specially handled: |
||
1574 | * |
||
1575 | * - tag: string|false, the tag name of the container element. False to render checkbox without container. |
||
1576 | * See also [[tag()]]. |
||
1577 | * - unselect: string, the value that should be submitted when none of the checkboxes is selected. |
||
1578 | * You may set this option to be null to prevent default value submission. |
||
1579 | * If this option is not set, an empty string will be submitted. |
||
1580 | * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. |
||
1581 | * This option is ignored if `item` option is set. |
||
1582 | * - separator: string, the HTML code that separates items. |
||
1583 | * - itemOptions: array, the options for generating the checkbox tag using [[checkbox()]]. |
||
1584 | * - item: callable, a callback that can be used to customize the generation of the HTML code |
||
1585 | * corresponding to a single item in $items. The signature of this callback must be: |
||
1586 | * |
||
1587 | * ```php |
||
1588 | * function ($index, $label, $name, $checked, $value) |
||
1589 | * ``` |
||
1590 | * |
||
1591 | * where $index is the zero-based index of the checkbox in the whole list; $label |
||
1592 | * is the label for the checkbox; and $name, $value and $checked represent the name, |
||
1593 | * value and the checked status of the checkbox input. |
||
1594 | * |
||
1595 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1596 | * |
||
1597 | * @return string the generated checkbox list |
||
1598 | */ |
||
1599 | public static function activeCheckboxList($model, $attribute, $items, $options = []) |
||
1603 | |||
1604 | /** |
||
1605 | * Generates a list of radio buttons. |
||
1606 | * A radio button list is like a checkbox list, except that it only allows single selection. |
||
1607 | * The selection of the radio buttons is taken from the value of the model attribute. |
||
1608 | * @param Model $model the model object |
||
1609 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1610 | * about attribute expression. |
||
1611 | * @param array $items the data item used to generate the radio buttons. |
||
1612 | * The array keys are the radio values, and the array values are the corresponding labels. |
||
1613 | * Note that the labels will NOT be HTML-encoded, while the values will. |
||
1614 | * @param array $options options (name => config) for the radio button list container tag. |
||
1615 | * The following options are specially handled: |
||
1616 | * |
||
1617 | * - tag: string|false, the tag name of the container element. False to render radio button without container. |
||
1618 | * See also [[tag()]]. |
||
1619 | * - unselect: string, the value that should be submitted when none of the radio buttons is selected. |
||
1620 | * You may set this option to be null to prevent default value submission. |
||
1621 | * If this option is not set, an empty string will be submitted. |
||
1622 | * - encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. |
||
1623 | * This option is ignored if `item` option is set. |
||
1624 | * - separator: string, the HTML code that separates items. |
||
1625 | * - itemOptions: array, the options for generating the radio button tag using [[radio()]]. |
||
1626 | * - item: callable, a callback that can be used to customize the generation of the HTML code |
||
1627 | * corresponding to a single item in $items. The signature of this callback must be: |
||
1628 | * |
||
1629 | * ```php |
||
1630 | * function ($index, $label, $name, $checked, $value) |
||
1631 | * ``` |
||
1632 | * |
||
1633 | * where $index is the zero-based index of the radio button in the whole list; $label |
||
1634 | * is the label for the radio button; and $name, $value and $checked represent the name, |
||
1635 | * value and the checked status of the radio button input. |
||
1636 | * |
||
1637 | * See [[renderTagAttributes()]] for details on how attributes are being rendered. |
||
1638 | * |
||
1639 | * @return string the generated radio button list |
||
1640 | */ |
||
1641 | public static function activeRadioList($model, $attribute, $items, $options = []) |
||
1645 | |||
1646 | /** |
||
1647 | * Generates a list of input fields. |
||
1648 | * This method is mainly called by [[activeListBox()]], [[activeRadioList()]] and [[activeCheckBoxList()]]. |
||
1649 | * @param string $type the input type. This can be 'listBox', 'radioList', or 'checkBoxList'. |
||
1650 | * @param Model $model the model object |
||
1651 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for the format |
||
1652 | * about attribute expression. |
||
1653 | * @param array $items the data item used to generate the input fields. |
||
1654 | * The array keys are the input values, and the array values are the corresponding labels. |
||
1655 | * Note that the labels will NOT be HTML-encoded, while the values will. |
||
1656 | * @param array $options options (name => config) for the input list. The supported special options |
||
1657 | * depend on the input type specified by `$type`. |
||
1658 | * @return string the generated input list |
||
1659 | */ |
||
1660 | 2 | protected static function activeListInput($type, $model, $attribute, $items, $options = []) |
|
1672 | |||
1673 | /** |
||
1674 | * Renders the option tags that can be used by [[dropDownList()]] and [[listBox()]]. |
||
1675 | * @param string|array $selection the selected value(s). This can be either a string for single selection |
||
1676 | * or an array for multiple selections. |
||
1677 | * @param array $items the option data items. The array keys are option values, and the array values |
||
1678 | * are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). |
||
1679 | * For each sub-array, an option group will be generated whose label is the key associated with the sub-array. |
||
1680 | * If you have a list of data models, you may convert them into the format described above using |
||
1681 | * [[\yii\helpers\ArrayHelper::map()]]. |
||
1682 | * |
||
1683 | * Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in |
||
1684 | * the labels will also be HTML-encoded. |
||
1685 | * @param array $tagOptions the $options parameter that is passed to the [[dropDownList()]] or [[listBox()]] call. |
||
1686 | * This method will take out these elements, if any: "prompt", "options" and "groups". See more details |
||
1687 | * in [[dropDownList()]] for the explanation of these elements. |
||
1688 | * |
||
1689 | * @return string the generated list options |
||
1690 | */ |
||
1691 | 5 | public static function renderSelectOptions($selection, $items, &$tagOptions = []) |
|
1737 | |||
1738 | /** |
||
1739 | * Renders the HTML tag attributes. |
||
1740 | * |
||
1741 | * Attributes whose values are of boolean type will be treated as |
||
1742 | * [boolean attributes](http://www.w3.org/TR/html5/infrastructure.html#boolean-attributes). |
||
1743 | * |
||
1744 | * Attributes whose values are null will not be rendered. |
||
1745 | * |
||
1746 | * The values of attributes will be HTML-encoded using [[encode()]]. |
||
1747 | * |
||
1748 | * The "data" attribute is specially handled when it is receiving an array value. In this case, |
||
1749 | * the array will be "expanded" and a list data attributes will be rendered. For example, |
||
1750 | * if `'data' => ['id' => 1, 'name' => 'yii']`, then this will be rendered: |
||
1751 | * `data-id="1" data-name="yii"`. |
||
1752 | * Additionally `'data' => ['params' => ['id' => 1, 'name' => 'yii'], 'status' => 'ok']` will be rendered as: |
||
1753 | * `data-params='{"id":1,"name":"yii"}' data-status="ok"`. |
||
1754 | * |
||
1755 | * @param array $attributes attributes to be rendered. The attribute values will be HTML-encoded using [[encode()]]. |
||
1756 | * @return string the rendering result. If the attributes are not empty, they will be rendered |
||
1757 | * into a string with a leading white space (so that it can be directly appended to the tag name |
||
1758 | * in a tag. If there is no attribute, an empty string will be returned. |
||
1759 | */ |
||
1760 | 129 | public static function renderTagAttributes($attributes) |
|
1807 | |||
1808 | /** |
||
1809 | * Adds a CSS class (or several classes) to the specified options. |
||
1810 | * If the CSS class is already in the options, it will not be added again. |
||
1811 | * If class specification at given options is an array, and some class placed there with the named (string) key, |
||
1812 | * overriding of such key will have no effect. For example: |
||
1813 | * |
||
1814 | * ```php |
||
1815 | * $options = ['class' => ['persistent' => 'initial']]; |
||
1816 | * Html::addCssClass($options, ['persistent' => 'override']); |
||
1817 | * var_dump($options['class']); // outputs: array('persistent' => 'initial'); |
||
1818 | * ``` |
||
1819 | * |
||
1820 | * @param array $options the options to be modified. |
||
1821 | * @param string|array $class the CSS class(es) to be added |
||
1822 | */ |
||
1823 | 3 | public static function addCssClass(&$options, $class) |
|
1836 | |||
1837 | /** |
||
1838 | * Merges already existing CSS classes with new one. |
||
1839 | * This method provides the priority for named existing classes over additional. |
||
1840 | * @param array $existingClasses already existing CSS classes. |
||
1841 | * @param array $additionalClasses CSS classes to be added. |
||
1842 | * @return array merge result. |
||
1843 | */ |
||
1844 | 2 | private static function mergeCssClasses(array $existingClasses, array $additionalClasses) |
|
1855 | |||
1856 | /** |
||
1857 | * Removes a CSS class from the specified options. |
||
1858 | * @param array $options the options to be modified. |
||
1859 | * @param string|array $class the CSS class(es) to be removed |
||
1860 | */ |
||
1861 | 1 | public static function removeCssClass(&$options, $class) |
|
1882 | |||
1883 | /** |
||
1884 | * Adds the specified CSS style to the HTML options. |
||
1885 | * |
||
1886 | * If the options already contain a `style` element, the new style will be merged |
||
1887 | * with the existing one. If a CSS property exists in both the new and the old styles, |
||
1888 | * the old one may be overwritten if `$overwrite` is true. |
||
1889 | * |
||
1890 | * For example, |
||
1891 | * |
||
1892 | * ```php |
||
1893 | * Html::addCssStyle($options, 'width: 100px; height: 200px'); |
||
1894 | * ``` |
||
1895 | * |
||
1896 | * @param array $options the HTML options to be modified. |
||
1897 | * @param string|array $style the new style string (e.g. `'width: 100px; height: 200px'`) or |
||
1898 | * array (e.g. `['width' => '100px', 'height' => '200px']`). |
||
1899 | * @param boolean $overwrite whether to overwrite existing CSS properties if the new style |
||
1900 | * contain them too. |
||
1901 | * @see removeCssStyle() |
||
1902 | * @see cssStyleFromArray() |
||
1903 | * @see cssStyleToArray() |
||
1904 | */ |
||
1905 | 1 | public static function addCssStyle(&$options, $style, $overwrite = true) |
|
1921 | |||
1922 | /** |
||
1923 | * Removes the specified CSS style from the HTML options. |
||
1924 | * |
||
1925 | * For example, |
||
1926 | * |
||
1927 | * ```php |
||
1928 | * Html::removeCssStyle($options, ['width', 'height']); |
||
1929 | * ``` |
||
1930 | * |
||
1931 | * @param array $options the HTML options to be modified. |
||
1932 | * @param string|array $properties the CSS properties to be removed. You may use a string |
||
1933 | * if you are removing a single property. |
||
1934 | * @see addCssStyle() |
||
1935 | */ |
||
1936 | 1 | public static function removeCssStyle(&$options, $properties) |
|
1946 | |||
1947 | /** |
||
1948 | * Converts a CSS style array into a string representation. |
||
1949 | * |
||
1950 | * For example, |
||
1951 | * |
||
1952 | * ```php |
||
1953 | * print_r(Html::cssStyleFromArray(['width' => '100px', 'height' => '200px'])); |
||
1954 | * // will display: 'width: 100px; height: 200px;' |
||
1955 | * ``` |
||
1956 | * |
||
1957 | * @param array $style the CSS style array. The array keys are the CSS property names, |
||
1958 | * and the array values are the corresponding CSS property values. |
||
1959 | * @return string the CSS style string. If the CSS style is empty, a null will be returned. |
||
1960 | */ |
||
1961 | 4 | public static function cssStyleFromArray(array $style) |
|
1970 | |||
1971 | /** |
||
1972 | * Converts a CSS style string into an array representation. |
||
1973 | * |
||
1974 | * The array keys are the CSS property names, and the array values |
||
1975 | * are the corresponding CSS property values. |
||
1976 | * |
||
1977 | * For example, |
||
1978 | * |
||
1979 | * ```php |
||
1980 | * print_r(Html::cssStyleToArray('width: 100px; height: 200px;')); |
||
1981 | * // will display: ['width' => '100px', 'height' => '200px'] |
||
1982 | * ``` |
||
1983 | * |
||
1984 | * @param string $style the CSS style string |
||
1985 | * @return array the array representation of the CSS style |
||
1986 | */ |
||
1987 | 3 | public static function cssStyleToArray($style) |
|
1998 | |||
1999 | /** |
||
2000 | * Returns the real attribute name from the given attribute expression. |
||
2001 | * |
||
2002 | * An attribute expression is an attribute name prefixed and/or suffixed with array indexes. |
||
2003 | * It is mainly used in tabular data input and/or input of array type. Below are some examples: |
||
2004 | * |
||
2005 | * - `[0]content` is used in tabular data input to represent the "content" attribute |
||
2006 | * for the first model in tabular input; |
||
2007 | * - `dates[0]` represents the first array element of the "dates" attribute; |
||
2008 | * - `[0]dates[0]` represents the first array element of the "dates" attribute |
||
2009 | * for the first model in tabular input. |
||
2010 | * |
||
2011 | * If `$attribute` has neither prefix nor suffix, it will be returned back without change. |
||
2012 | * @param string $attribute the attribute name or expression |
||
2013 | * @return string the attribute name without prefix and suffix. |
||
2014 | * @throws InvalidParamException if the attribute name contains non-word characters. |
||
2015 | */ |
||
2016 | 22 | public static function getAttributeName($attribute) |
|
2024 | |||
2025 | /** |
||
2026 | * Returns the value of the specified attribute name or expression. |
||
2027 | * |
||
2028 | * For an attribute expression like `[0]dates[0]`, this method will return the value of `$model->dates[0]`. |
||
2029 | * See [[getAttributeName()]] for more details about attribute expression. |
||
2030 | * |
||
2031 | * If an attribute value is an instance of [[ActiveRecordInterface]] or an array of such instances, |
||
2032 | * the primary value(s) of the AR instance(s) will be returned instead. |
||
2033 | * |
||
2034 | * @param Model $model the model object |
||
2035 | * @param string $attribute the attribute name or expression |
||
2036 | * @return string|array the corresponding attribute value |
||
2037 | * @throws InvalidParamException if the attribute name contains non-word characters. |
||
2038 | */ |
||
2039 | 21 | public static function getAttributeValue($model, $attribute) |
|
2072 | |||
2073 | /** |
||
2074 | * Generates an appropriate input name for the specified attribute name or expression. |
||
2075 | * |
||
2076 | * This method generates a name that can be used as the input name to collect user input |
||
2077 | * for the specified attribute. The name is generated according to the [[Model::formName|form name]] |
||
2078 | * of the model and the given attribute name. For example, if the form name of the `Post` model |
||
2079 | * is `Post`, then the input name generated for the `content` attribute would be `Post[content]`. |
||
2080 | * |
||
2081 | * See [[getAttributeName()]] for explanation of attribute expression. |
||
2082 | * |
||
2083 | * @param Model $model the model object |
||
2084 | * @param string $attribute the attribute name or expression |
||
2085 | * @return string the generated input name |
||
2086 | * @throws InvalidParamException if the attribute name contains non-word characters. |
||
2087 | */ |
||
2088 | 32 | public static function getInputName($model, $attribute) |
|
2105 | |||
2106 | /** |
||
2107 | * Generates an appropriate input ID for the specified attribute name or expression. |
||
2108 | * |
||
2109 | * This method converts the result [[getInputName()]] into a valid input ID. |
||
2110 | * For example, if [[getInputName()]] returns `Post[content]`, this method will return `post-content`. |
||
2111 | * @param Model $model the model object |
||
2112 | * @param string $attribute the attribute name or expression. See [[getAttributeName()]] for explanation of attribute expression. |
||
2113 | * @return string the generated input ID |
||
2114 | * @throws InvalidParamException if the attribute name contains non-word characters. |
||
2115 | */ |
||
2116 | 30 | public static function getInputId($model, $attribute) |
|
2121 | |||
2122 | /** |
||
2123 | * Escapes regular expression to use in JavaScript |
||
2124 | * @param string $regexp the regular expression to be escaped. |
||
2125 | * @return string the escaped result. |
||
2126 | * @since 2.0.6 |
||
2127 | */ |
||
2128 | public static function escapeJsRegularExpression($regexp) |
||
2145 | } |
||
2146 |
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: