BaseHtml

API reference › Bootstrap 6 › BaseHtml

abstract class	`yii2\extensions\bootstrap6\BaseHtml`
Extends	`yii\helpers\Html` » `yii\helpers\BaseHtml`
Source	`src/BaseHtml.php`

1 subclass

Html

Provides the Bootstrap 6 implementation of Html.

Checkboxes and radios render the .check and .radio classes, switches render the .switch wrapper, and error blocks default to .invalid-feedback.

Properties

Property	Type	Description	Defined by
`$attributeOrder` static	`array`	The preferred order of attributes in a tag. Default: `['type', 'id', 'class', 'name', 'value', 'href', 'src', 'srcset', 'form', 'action', 'method', 'selected', 'checked', 'readonly', 'disabled', 'multiple', 'size', 'maxlength', 'width', 'height', 'rows', 'cols', 'alt', 'title', 'rel', 'media']`.	`yii\helpers\BaseHtml`
`$attributeRegex` static	`string`	Regular expression used for attribute name validation. Default: `'/(^\|.\])([\w\.\+]+)(\[.\|$)/u'`. Available since 2.0.12.	`yii\helpers\BaseHtml`
`$autoIdPrefix` static	`string`	Prefix of the `id` values generated for checkbox and radio labels. Default: `'i'`.	`BaseHtml`
`$dataAttributes` static	`array`	List of tag attributes that should be specially handled when their values are of array type. Default: `['aria', 'data', 'data-ng', 'ng']`. Available since 2.0.3.	`yii\helpers\BaseHtml`
`$normalizeClassAttribute` static	`bool`	Whether to remove duplicated classes when rendering the `class` attribute. Default: `true`.	`BaseHtml`
`$voidElements` static	`array`	List of void elements (element name => 1) Default: `['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]`.	`yii\helpers\BaseHtml`

Methods

Method	Description	Defined by
`a()` static	Generates a hyperlink tag.	`yii\helpers\BaseHtml`
`activeCheckbox()` static	Generates a checkbox tag together with a label for the given model attribute.	`yii\helpers\BaseHtml`
`activeCheckboxList()` static	Generates a list of checkboxes.	`yii\helpers\BaseHtml`
`activeDropDownList()` static	Generates a drop-down list for the given model attribute.	`yii\helpers\BaseHtml`
`activeFileInput()` static	Generates a file input tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeHiddenInput()` static	Generates a hidden input tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeHint()` static	Generates a hint tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeInput()` static	Generates an input tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeLabel()` static	Generates a label tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeListBox()` static	Generates a list box.	`yii\helpers\BaseHtml`
`activePasswordInput()` static	Generates a password input tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeRadio()` static	Generates a radio button tag together with a label for the given model attribute.	`yii\helpers\BaseHtml`
`activeRadioList()` static	Generates a list of radio buttons.	`yii\helpers\BaseHtml`
`activeStaticControl()` static	Generates a static form control for the given model attribute.	`BaseHtml`
`activeTextarea()` static	Generates a textarea tag for the given model attribute.	`yii\helpers\BaseHtml`
`activeTextInput()` static	Generates a text input tag for the given model attribute.	`yii\helpers\BaseHtml`
`addCssClass()` static	Adds CSS classes to the options; enum cases are converted to their value (backed) or name (pure).	`BaseHtml`
`addCssStyle()` static	Adds the specified CSS style to the HTML options.	`yii\helpers\BaseHtml`
`badge()` static	Generates a badge.	`BaseHtml`
`beginForm()` static	Generates a form start tag.	`yii\helpers\BaseHtml`
`beginTag()` static	Generates a start tag.	`yii\helpers\BaseHtml`
`button()` static	Generates a button tag.	`yii\helpers\BaseHtml`
`buttonInput()` static	Generates an input button.	`yii\helpers\BaseHtml`
`checkbox()` static	Generates a checkbox input.	`yii\helpers\BaseHtml`
`checkboxList()` static	Generates a list of Bootstrap checkboxes, each wrapped in a `.form-field` element.	`BaseHtml`
`closeButton()` static	Generates a close button with a translated `aria-label`.	`BaseHtml`
`csrfMetaTags()` static	Generates the meta tags containing CSRF token information.	`yii\helpers\BaseHtml`
`cssFile()` static	Generates a link tag that refers to an external CSS file.	`yii\helpers\BaseHtml`
`cssStyleFromArray()` static	Converts a CSS style array into a string representation.	`yii\helpers\BaseHtml`
`cssStyleToArray()` static	Converts a CSS style string into an array representation.	`yii\helpers\BaseHtml`
`decode()` static	Decodes special HTML entities back to the corresponding characters.	`yii\helpers\BaseHtml`
`dropDownList()` static	Generates a drop-down list.	`yii\helpers\BaseHtml`
`encode()` static	Encodes special characters into HTML entities.	`yii\helpers\BaseHtml`
`endForm()` static	Generates a form end tag.	`yii\helpers\BaseHtml`
`endTag()` static	Generates an end tag.	`yii\helpers\BaseHtml`
`enumValue()` static	Returns the `string` value of an enum-typed value, validating strings against the enum.	`BaseHtml`
`error()` static		`BaseHtml`
`errorSummary()` static	Generates a summary of the validation errors.	`yii\helpers\BaseHtml`
`escapeCssIdentifier()` static	Escapes a string for use as a CSS identifier in a selector, as `CSS.escape()` does.	`BaseHtml`
`escapeJsRegularExpression()` static	Escapes regular expression to use in JavaScript.	`yii\helpers\BaseHtml`
`fileInput()` static	Generates a file input field.	`yii\helpers\BaseHtml`
`getAttributeName()` static	Returns the real attribute name from the given attribute expression.	`yii\helpers\BaseHtml`
`getAttributeValue()` static	Returns the value of the specified attribute name or expression.	`yii\helpers\BaseHtml`
`getInputId()` static	Generates an appropriate input ID for the specified attribute name or expression.	`yii\helpers\BaseHtml`
`getInputIdByName()` static	Converts input name to ID.	`yii\helpers\BaseHtml`
`getInputName()` static	Generates an appropriate input name for the specified attribute name or expression.	`yii\helpers\BaseHtml`
`hiddenInput()` static	Generates a hidden input field.	`yii\helpers\BaseHtml`
`img()` static	Generates an image tag.	`yii\helpers\BaseHtml`
`input()` static	Generates an input type of the given type.	`yii\helpers\BaseHtml`
`jsFile()` static	Generates a script tag that refers to an external JavaScript file.	`yii\helpers\BaseHtml`
`label()` static	Generates a label tag.	`yii\helpers\BaseHtml`
`listBox()` static	Generates a list box.	`yii\helpers\BaseHtml`
`mailto()` static	Generates a mailto hyperlink.	`yii\helpers\BaseHtml`
`ol()` static	Generates an ordered list.	`yii\helpers\BaseHtml`
`passwordInput()` static	Generates a password input field.	`yii\helpers\BaseHtml`
`radio()` static	Generates a radio button input.	`yii\helpers\BaseHtml`
`radioList()` static	Generates a list of Bootstrap radios, each wrapped in a `.form-field` element.	`BaseHtml`
`removeCssClass()` static	Removes a CSS class from the specified options.	`yii\helpers\BaseHtml`
`removeCssStyle()` static	Removes the specified CSS style from the HTML options.	`yii\helpers\BaseHtml`
`renderSelectOptions()` static	Renders the option tags that can be used by `dropDownList()` and `listBox()`.	`yii\helpers\BaseHtml`
`renderTagAttributes()` static	Renders the HTML tag attributes.	`yii\helpers\BaseHtml`
`resetButton()` static	Generates a reset button tag.	`yii\helpers\BaseHtml`
`resetInput()` static	Generates a reset input button.	`yii\helpers\BaseHtml`
`script()` static	Generates a script tag.	`yii\helpers\BaseHtml`
`staticControl()` static	Generates a read-only plain-text input.	`BaseHtml`
`style()` static	Generates a style tag.	`yii\helpers\BaseHtml`
`submitButton()` static	Generates a submit button tag.	`yii\helpers\BaseHtml`
`submitInput()` static	Generates a submit input button.	`yii\helpers\BaseHtml`
`tag()` static	Generates a complete HTML tag.	`yii\helpers\BaseHtml`
`textarea()` static	Generates a text area input.	`yii\helpers\BaseHtml`
`textInput()` static	Generates a text input field.	`yii\helpers\BaseHtml`
`theme()` static	Adds the `theme-{value}` class to the options.	`BaseHtml`
`ul()` static	Generates an unordered list.	`yii\helpers\BaseHtml`
`activeBooleanInput()` protected static	Generates a boolean input This method is mainly called by `activeCheckbox()` and `activeRadio()`.	`yii\helpers\BaseHtml`
`activeListInput()` protected static	Generates a list of input fields.	`yii\helpers\BaseHtml`
`booleanInput()` protected static	Generates a Bootstrap checkbox, switch, or radio.	`BaseHtml`
`getId()` protected static	Returns the next auto-generated `id` for checkbox and radio labels.	`BaseHtml`
`setActivePlaceholder()` protected static	Generate placeholder from model attribute label.	`yii\helpers\BaseHtml`

Method details

activeStaticControl()

public static function activeStaticControl(yii\base\Model $model, string $attribute, mixed[] $options = []): string

Generates a static form control for the given model attribute.

The value option, when present, replaces the attribute value.

Parameters

Parameter	Type	Description
`$model`	`yii\base\Model`	Model holding the attribute.
`$attribute`	`string`	Attribute name or expression.
`$options`	`mixed[]`	Tag attributes, see `staticControl()`.

Returns

string: Generated HTML.

addCssClass()

public static function addCssClass(array<yii2\extensions\bootstrap6\TKey, mixed> &$options, mixed[]|string|Stringable|UnitEnum $class): void

Adds CSS classes to the options; enum cases are converted to their value (backed) or name (pure).

Parameters

Parameter	Type	Description
`$options`	`array<yii2\extensions\bootstrap6\TKey, mixed>`	Tag attributes to modify.
`$class`	`mixed[]\|string\|Stringable\|UnitEnum`	Class, or list of classes (keys are kept), each a `string`, an enum case, or a `Stringable` value; `null` entries are ignored, and the options are left unchanged when no entry remains.

badge()

public static function badge(string|Stringable $label, string|yii2\extensions\bootstrap6\enum\Theme|null $theme = null, mixed[] $options = []): string

Generates a badge.

The encode option controls whether the label is HTML-encoded (default true).

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`	Badge content.
`$theme`	`string\|yii2\extensions\bootstrap6\enum\Theme\|null`	Theme color, or `null` for the default color.
`$options`	`mixed[]`	Tag attributes.

Returns

string: Generated HTML, for example <span class="badge theme-primary">New</span>.

See also

https://getbootstrap.com/docs/6.0/components/badge/

checkboxList()

public static function checkboxList(string $name, mixed[]|string|null $selection = null, mixed[] $items = [], mixed[] $options = []): string

Generates a list of Bootstrap checkboxes, each wrapped in a .form-field element.

Besides the core options (item, itemOptions, encode, separator, tag, unselect, strict), the following options are handled:

inline: bool, whether to lay out the items horizontally (d-flex flex-wrap gap-5 on the container instead of form-group).
itemOptions['wrapperOptions']: array, HTML attributes of each .form-field item wrapper, for example form-field-card.

When item is set, the callback renders each item and neither the wrapper nor the .form-field element is added to it.

Parameters

Parameter	Type	Description
`$name`	`string`	Input name; `[]` is appended when missing.
`$selection`	`mixed[]\|string\|null`	Selected value or values.
`$items`	`mixed[]`	Data items, value => label.
`$options`	`mixed[]`	Container attributes and the special options above.

Returns

string

See also

https://getbootstrap.com/docs/6.0/forms/field/#grouped

closeButton()

public static function closeButton(mixed[] $options = []): string

Generates a close button with a translated aria-label.

Parameters

Parameter	Type	Description
`$options`	`mixed[]`	Tag attributes.

Returns

string: Generated HTML, for example <button type="button" class="btn-close" aria-label="Close"></button>.

See also

https://getbootstrap.com/docs/6.0/components/close-button/

enumValue()

public static function enumValue(class-string<yii2\extensions\bootstrap6\T> $enum, string|yii2\extensions\bootstrap6\T|null $value, string $property, bool $responsive = false): string|null

Returns the string value of an enum-typed value, validating strings against the enum.

It is the single normalization point of the enum-typed widget properties: widgets call it from init() so that widget() and begin() fail fast, and again while rendering to obtain the value. Enum cases are converted with \UIAwesome\Html\Helper\Enum::normalizeStringValue(); null is returned unchanged.

With $responsive, a string may also be a space-separated list of values, each optionally prefixed with a Breakpoint value, for example bottom-start md:top-end.

Parameters

Parameter	Type	Description
`$enum`	`class-string<yii2\extensions\bootstrap6\T>`	String-backed enum the value belongs to.
`$value`	`string\|yii2\extensions\bootstrap6\T\|null`	Enum case, its `string` value, or `null`.
`$property`	`string`	Property name reported in the exception message.
`$responsive`	`bool`	Whether to accept breakpoint-prefixed values.

Returns

string|null: Value of the enum case, the validated string, or null.

Throws

yii\base\InvalidConfigException: if $value is a string that is not a value of $enum.

error()

public static function error(yii\base\Model $model, string $attribute, mixed[] $options = []): string

Parameters

Parameter	Type	Description
`$model`	`yii\base\Model`	Model holding the attribute.
`$attribute`	`string`	Attribute name or expression.
`$options`	`mixed[]`	Tag options; the `class` attribute defaults to `invalid-feedback`.

Returns

string

escapeCssIdentifier()

public static function escapeCssIdentifier(string $identifier): string

Escapes a string for use as a CSS identifier in a selector, as CSS.escape() does.

Bytes from 0x80 up are kept verbatim, so every non-ASCII character of a UTF-8 string passes through unchanged.

Parameters

Parameter	Type	Description
`$identifier`	`string`	Raw identifier, such as an element `id` or a class name.

Returns

string: Identifier safe to interpolate after # or ., for example account\:edit for account:edit.

See also

https://drafts.csswg.org/cssom/#serialize-an-identifier

radioList()

public static function radioList(string $name, mixed[]|string|null $selection = null, mixed[] $items = [], mixed[] $options = []): string

Generates a list of Bootstrap radios, each wrapped in a .form-field element.

Accepts the same options as checkboxList().

Parameters

Parameter	Type	Description
`$name`	`string`	Input name.
`$selection`	`mixed[]\|string\|null`	Selected value.
`$items`	`mixed[]`	Data items, value => label.
`$options`	`mixed[]`	Container attributes and the special options of `checkboxList()`.

Returns

string

See also

https://getbootstrap.com/docs/6.0/forms/field/#grouped

staticControl()

public static function staticControl(string $value, mixed[] $options = []): string

Generates a read-only plain-text input.

Parameters

Parameter	Type	Description
`$value`	`string`	Control value.
`$options`	`mixed[]`	Tag attributes.

Returns

string: Generated HTML, for example <input type="text" class="form-control-plaintext" value="x" readonly>.

See also

https://getbootstrap.com/docs/6.0/forms/form-control/#readonly-plain-text

theme()

public static function theme(mixed[] &$options, string|yii2\extensions\bootstrap6\enum\Theme|null $theme): void

Adds the theme-{value} class to the options.

Parameters

Parameter	Type	Description
`$options`	`mixed[]`	Tag attributes to modify.
`$theme`	`string\|yii2\extensions\bootstrap6\enum\Theme\|null`	Theme color, or `null` to leave the options unchanged.

Throws

yii\base\InvalidConfigException: if $theme is a string that is not a Theme value.

booleanInput()

protected static function booleanInput(string $type, string $name, bool $checked = false, mixed[] $options = []): string

Generates a Bootstrap checkbox, switch, or radio.

Besides the core options (uncheck, label, labelOptions), the following options are handled:

switch: bool, checkbox only. Renders <div class="switch"><input type="checkbox" role="switch" switch></div> instead of the .check class.
switchOptions: array, HTML attributes of the .switch wrapper, for example theme-success or switch-lg.
wrapInput: bool, whether to render the control inside the <label> instead of before it.

When label is set, the control receives an auto-generated id (see $autoIdPrefix) unless one is given, and the label is rendered as <label for="id">. The label is NOT HTML-encoded.

Parameters

Parameter	Type	Description
`$type`	`string`	Input type, either `checkbox` or `radio`.
`$name`	`string`	Input name.
`$checked`	`bool`	Whether the input is checked; the `checked` option takes precedence.
`$options`	`mixed[]`	Tag attributes and the special options above.

Returns

string

getId()

protected static function getId(): string

Returns the next auto-generated id for checkbox and radio labels.

Returns

string