Class yii\bootstrap\BaseHtml

Inheritanceyii\bootstrap\BaseHtml » yii\helpers\Html » yii\helpers\BaseHtml
Subclassesyii\bootstrap\Html
Available since version2.0.5
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/BaseHtml.php

BaseHtml provides concrete implementation for yii\bootstrap\Html.

Do not use BaseHtml. Use yii\bootstrap\Html instead.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attributeOrder array The preferred order of attributes in a tag. yii\helpers\BaseHtml
$attributeRegex string Regular expression used for attribute name validation. yii\helpers\BaseHtml
$dataAttributes array List of tag attributes that should be specially handled when their values are of array type. yii\helpers\BaseHtml
$voidElements array List of void elements (element name => 1) yii\helpers\BaseHtml

Public Methods

Hide inherited methods

MethodDescriptionDefined By
a() Generates a hyperlink tag. yii\helpers\BaseHtml
activeCheckbox() Generates a checkbox tag together with a label for the given model attribute. yii\helpers\BaseHtml
activeCheckboxList() Generates a list of checkboxes. yii\helpers\BaseHtml
activeDropDownList() Generates a drop-down list for the given model attribute. yii\helpers\BaseHtml
activeFileInput() Generates a file input tag for the given model attribute. yii\helpers\BaseHtml
activeHiddenInput() Generates a hidden input tag for the given model attribute. yii\helpers\BaseHtml
activeHint() Generates a hint tag for the given model attribute. yii\helpers\BaseHtml
activeInput() Generates an input tag for the given model attribute. yii\helpers\BaseHtml
activeLabel() Generates a label tag for the given model attribute. yii\helpers\BaseHtml
activeListBox() Generates a list box. yii\helpers\BaseHtml
activePasswordInput() Generates a password input tag for the given model attribute. yii\helpers\BaseHtml
activeRadio() Generates a radio button tag together with a label for the given model attribute. yii\helpers\BaseHtml
activeRadioList() Generates a list of radio buttons. yii\helpers\BaseHtml
activeStaticControl() Generates a Bootstrap static form control for the given model attribute. yii\bootstrap\BaseHtml
activeTextInput() Generates a text input tag for the given model attribute. yii\helpers\BaseHtml
activeTextarea() Generates a textarea tag for the given model attribute. yii\helpers\BaseHtml
addCssClass() Adds a CSS class (or several classes) to the specified options. yii\helpers\BaseHtml
addCssStyle() Adds the specified CSS style to the HTML options. yii\helpers\BaseHtml
beginForm() Generates a form start tag. yii\helpers\BaseHtml
beginTag() Generates a start tag. yii\helpers\BaseHtml
button() Generates a button tag. yii\helpers\BaseHtml
buttonInput() Generates an input button. yii\helpers\BaseHtml
checkbox() Generates a checkbox input. yii\helpers\BaseHtml
checkboxList() Generates a list of checkboxes. yii\helpers\BaseHtml
csrfMetaTags() Generates the meta tags containing CSRF token information. yii\helpers\BaseHtml
cssFile() Generates a link tag that refers to an external CSS file. yii\helpers\BaseHtml
cssStyleFromArray() Converts a CSS style array into a string representation. yii\helpers\BaseHtml
cssStyleToArray() Converts a CSS style string into an array representation. yii\helpers\BaseHtml
decode() Decodes special HTML entities back to the corresponding characters. yii\helpers\BaseHtml
encode() Encodes special characters into HTML entities. yii\helpers\BaseHtml
endForm() Generates a form end tag. yii\helpers\BaseHtml
endTag() Generates an end tag. yii\helpers\BaseHtml
error() Generates a tag that contains the first validation error of the specified model attribute. yii\helpers\BaseHtml
errorSummary() Generates a summary of the validation errors. yii\helpers\BaseHtml
escapeJsRegularExpression() Escapes regular expression to use in JavaScript. yii\helpers\BaseHtml
fileInput() Generates a file input field. yii\helpers\BaseHtml
getAttributeName() Returns the real attribute name from the given attribute expression. yii\helpers\BaseHtml
getAttributeValue() Returns the value of the specified attribute name or expression. yii\helpers\BaseHtml
getInputId() Generates an appropriate input ID for the specified attribute name or expression. yii\helpers\BaseHtml
getInputName() Generates an appropriate input name for the specified attribute name or expression. yii\helpers\BaseHtml
hiddenInput() Generates a hidden input field. yii\helpers\BaseHtml
icon() Composes icon HTML for bootstrap Glyphicons. yii\bootstrap\BaseHtml
img() Generates an image tag. yii\helpers\BaseHtml
input() Generates an input type of the given type. yii\helpers\BaseHtml
jsFile() Generates a script tag that refers to an external JavaScript file. yii\helpers\BaseHtml
label() Generates a label tag. yii\helpers\BaseHtml
listBox() Generates a list box. yii\helpers\BaseHtml
mailto() Generates a mailto hyperlink. yii\helpers\BaseHtml
ol() Generates an ordered list. yii\helpers\BaseHtml
passwordInput() Generates a password input field. yii\helpers\BaseHtml
radio() Generates a radio button input. yii\helpers\BaseHtml
radioList() Generates a list of radio buttons. yii\helpers\BaseHtml
removeCssClass() Removes a CSS class from the specified options. yii\helpers\BaseHtml
removeCssStyle() Removes the specified CSS style from the HTML options. yii\helpers\BaseHtml
renderSelectOptions() Renders the option tags that can be used by dropDownList() and listBox(). yii\helpers\BaseHtml
renderTagAttributes() Renders the HTML tag attributes. yii\helpers\BaseHtml
resetButton() Generates a reset button tag. yii\helpers\BaseHtml
resetInput() Generates a reset input button. yii\helpers\BaseHtml
script() Generates a script tag. yii\helpers\BaseHtml
staticControl() Renders Bootstrap static form control. yii\bootstrap\BaseHtml
style() Generates a style tag. yii\helpers\BaseHtml
submitButton() Generates a submit button tag. yii\helpers\BaseHtml
submitInput() Generates a submit input button. yii\helpers\BaseHtml
tag() Generates a complete HTML tag. yii\helpers\BaseHtml
textInput() Generates a text input field. yii\helpers\BaseHtml
textarea() Generates a text area input. yii\helpers\BaseHtml
ul() Generates an unordered list. yii\helpers\BaseHtml

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
activeBooleanInput() Generates a boolean input This method is mainly called by activeCheckbox() and activeRadio(). yii\helpers\BaseHtml
activeListInput() Generates a list of input fields. yii\helpers\BaseHtml
booleanInput() Generates a boolean input. yii\helpers\BaseHtml

Method Details

activeStaticControl() public static method

Generates a Bootstrap static form control for the given model attribute.

See also staticControl().

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

The model object.

$attribute string

The attribute name or expression. See getAttributeName() for the format about attribute expression.

$options array

The tag options in terms of name-value pairs. See staticControl() for details.

return string

Generated HTML

icon() public static method

Composes icon HTML for bootstrap Glyphicons.

See also http://getbootstrap.com/components/#glyphicons.

public static string icon ( $name, $options = [] )
$name string

Icon short name, for example: 'star'

$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. There are also a special options:

  • tag: string, tag to be rendered, by default 'span' is used.
  • prefix: string, prefix which should be used to compose tag class, by default 'glyphicon glyphicon-' is used.
return string

Icon HTML.

staticControl() public static method

Renders Bootstrap static form control.

By default value will be HTML-encoded using encode(), you may control this behavior via 'encode' option.

See also http://getbootstrap.com/css/#forms-controls-static.

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

Static control value.

$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. There are also a special options:

  • encode: boolean, whether value should be HTML-encoded or not.
return string

Generated HTML