Overview

Packages

  • bootstrap
    • behaviors
    • components
    • form
    • gii
    • helpers
    • widgets

Classes

  • TbArray
  • TbHtml
  • Overview
  • Package
  • Class
  • Tree

Class TbHtml

Bootstrap HTML helper.

CHtml
Extended by TbHtml
Package: bootstrap\helpers
Copyright: Copyright © Christoffer Niska 2013-
License: New BSD License
Author: Antonio Ramirez <ramirez.cobos@gmail.com>
Author: Christoffer Niska <christoffer.niska@gmail.com>
Located at helpers/TbHtml.php
Methods summary
public static string
# lead( string $text, array $htmlOptions = array() )

Generates a paragraph that stands out.

Generates a paragraph that stands out.

Parameters

$text
string
$text the lead text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated paragraph.
public static string
# small( string $text, array $htmlOptions = array() )

Generates small text.

Generates small text.

Parameters

$text
string
$text the text to style.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text.
public static string
# b( string $text, array $htmlOptions = array() )

Generates bold text.

Generates bold text.

Parameters

$text
string
$text the text to style.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text.
public static string
# i( string $text, array $htmlOptions = array() )

Generates italic text.

Generates italic text.

Parameters

$text
string
$text the text to style.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text.
public static string
# em( string $text, string $htmlOptions = array(), array $tag = 'p' )

Generates an emphasized text.

Generates an emphasized text.

Parameters

$text
string
$style the text style.
$htmlOptions
string
$text the text to emphasize.
$tag
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text.
public static string
# muted( string $text, array $htmlOptions = array(), string $tag = 'p' )

Generates a muted text block.

Generates a muted text block.

Parameters

$text
string
$text the text.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$tag
string
$tag the HTML tag.

Returns

string
the generated text block.
public static string
# mutedSpan( string $text, array $htmlOptions = array() )

Generates a muted span.

Generates a muted span.

Parameters

$text
string
$text the text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated span.
public static string
# abbr( string $text, string $word, array $htmlOptions = array() )

Generates an abbreviation with a help text.

Generates an abbreviation with a help text.

Parameters

$text
string
$text the abbreviation.
$word
string
$word the word the abbreviation is for.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated abbreviation.
public static string
# smallAbbr( string $text, string $word, array $htmlOptions = array() )

Generates a small abbreviation with a help text.

Generates a small abbreviation with a help text.

Parameters

$text
string
$text the abbreviation.
$word
string
$word the word the abbreviation is for.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated abbreviation.
public static string
# address( string $text, array $htmlOptions = array() )

Generates an address block.

Generates an address block.

Parameters

$text
string
$quote the address text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated block.
public static string
# quote( string $text, array $htmlOptions = array() )

Generates a quote.

Generates a quote.

Parameters

$text
string
$text the quoted text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated quote.
public static string
# help( string $text, array $htmlOptions = array() )

Generates a help text.

Generates a help text.

Parameters

$text
string
$text the help text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text.
public static string
# helpBlock( string $text, array $htmlOptions = array() )

Generates a help block.

Generates a help block.

Parameters

$text
string
$text the help text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated block.
public static string
# code( string $code, array $htmlOptions = array() )

Generates inline code.

Generates inline code.

Parameters

$code
string
$code the code.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated code.
public static string
# codeBlock( string $code, array $htmlOptions = array() )

Generates a code block.

Generates a code block.

Parameters

$code
string
$code the code.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated block.
public static string
# tag( string $tag, array $htmlOptions = array(), mixed $content = false, boolean $closeTag = true )

Generates an HTML element.

Generates an HTML element.

Parameters

$tag
string
$tag the tag name.
$htmlOptions
array
$htmlOptions the element attributes.
$content
mixed
$content the content to be enclosed between open and close element tags.
$closeTag
boolean
$closeTag whether to generate the close tag.

Returns

string
the generated HTML element tag.
public static string
# openTag( string $tag, array $htmlOptions = array() )

Generates an open HTML element.

Generates an open HTML element.

Parameters

$tag
string
$tag the tag name.
$htmlOptions
array
$htmlOptions the element attributes.

Returns

string
the generated HTML element tag.
public static string
# formTb( string $layout = TbHtml::FORM_LAYOUT_VERTICAL, string $action = '', string $method = 'post', array $htmlOptions = array() )

Generates a form tag.

Generates a form tag.

Parameters

$layout
string
$layout the form layout.
$action
string
$action the form action URL.
$method
string
$method form method (e.g. post, get).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated tag.
public static string
# beginFormTb( string $layout = TbHtml::FORM_LAYOUT_VERTICAL, string $action = '', string $method = 'post', array $htmlOptions = array() )

Generates an open form tag.

Generates an open form tag.

Parameters

$layout
string
$layout the form layout.
$action
string
$action the form action URL.
$method
string
$method form method (e.g. post, get).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated tag.
public static string
# statefulFormTb( mixed $layout = TbHtml::FORM_LAYOUT_VERTICAL, string $action = '', array $method = 'post', mixed $htmlOptions = array() )

Generates a stateful form tag.

Generates a stateful form tag.

Parameters

$layout
mixed
$action the form action URL.
$action
string
$method form method (e.g. post, get).
$method
array
$htmlOptions additional HTML attributes.
$htmlOptions

Returns

string
the generated form tag.
public static string
# textField( string $name, string $value = '', array $htmlOptions = array() )

Generates a text field input.

Generates a text field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# passwordField( string $name, string $value = '', array $htmlOptions = array() )

Generates a password field input.

Generates a password field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# urlField( string $name, string $value = '', array $htmlOptions = array() )

Generates an url field input.

Generates an url field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# emailField( string $name, string $value = '', array $htmlOptions = array() )

Generates an email field input.

Generates an email field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# numberField( string $name, string $value = '', array $htmlOptions = array() )

Generates a number field input.

Generates a number field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# rangeField( string $name, string $value = '', array $htmlOptions = array() )

Generates a range field input.

Generates a range field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# dateField( string $name, string $value = '', array $htmlOptions = array() )

Generates a date field input.

Generates a date field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::textInputField()
public static string
# fileField( string $name, string $value = '', array $htmlOptions = array() )

Generates a file field input.

Generates a file field input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

CHtml::fileField
public static string
# textArea( string $name, string $value = '', array $htmlOptions = array() )

Generates a text area input.

Generates a text area input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text area.
public static string
# radioButton( string $name, boolean $checked = false, array $htmlOptions = array() )

Generates a radio button.

Generates a radio button.

Parameters

$name
string
$name the input name.
$checked
boolean
$checked whether the radio button is checked.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated radio button.
public static string
# checkBox( string $name, boolean $checked = false, array $htmlOptions = array() )

Generates a check box.

Generates a check box.

Parameters

$name
string
$name the input name.
$checked
boolean
$checked whether the check box is checked.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated check box.
public static string
# dropDownList( string $name, string $select, array $data, mixed $htmlOptions = array() )

Generates a drop down list.

Generates a drop down list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions

Returns

string
the generated drop down list.
public static string
# listBox( string $name, mixed $select, array $data, array $htmlOptions = array() )

Generates a list box.

Generates a list box.

Parameters

$name
string
$name the input name.
$select
mixed
$select the selected value(s).
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list box
public static string
# radioButtonList( string $name, mixed $select, array $data, array $htmlOptions = array() )

Generates a radio button list.

Generates a radio button list.

Parameters

$name
string
$name name of the radio button list.
$select
mixed
$select selection of the radio buttons.
$data
array
$data $data value-label pairs used to generate the radio button list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# inlineRadioButtonList( string $name, mixed $select, array $data, array $htmlOptions = array() )

Generates an inline radio button list.

Generates an inline radio button list.

Parameters

$name
string
$name name of the radio button list.
$select
mixed
$select selection of the radio buttons.
$data
array
$data $data value-label pairs used to generate the radio button list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# checkBoxList( string $name, mixed $select, array $data, array $htmlOptions = array() )

Generates a check box list.

Generates a check box list.

Parameters

$name
string
$name name of the check box list.
$select
mixed
$select selection of the check boxes.
$data
array
$data $data value-label pairs used to generate the check box list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# inlineCheckBoxList( string $name, mixed $select, array $data, array $htmlOptions = array() )

Generates an inline check box list.

Generates an inline check box list.

Parameters

$name
string
$name name of the check box list.
$select
mixed
$select selection of the check boxes.
$data
array
$data $data value-label pairs used to generate the check box list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# uneditableField( string $value, array $htmlOptions = array() )

Generates an uneditable input.

Generates an uneditable input.

Parameters

$value
string
$value the value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input.
public static string
# searchQueryField( string $name, string $value = '', array $htmlOptions = array() )

Generates a search input.

Generates a search input.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input.
public static string
# textFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a text field.

Generates a control group with a text field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# passwordFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a password field.

Generates a control group with a password field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::textInputField()
public static string
# urlFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with an url field.

Generates a control group with an url field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# emailFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with an email field.

Generates a control group with an email field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# numberFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a number field.

Generates a control group with a number field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::textInputField()
public static string
# rangeFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a range field.

Generates a control group with a range field.

Parameters

$name
string
$name the input name
$value
string
$value the input value
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# dateFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a file field.

Generates a control group with a file field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# textAreaControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a text area.

Generates a control group with a text area.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# fileFieldControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a file field.

Generates a control group with a file field.

Parameters

$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# radioButtonControlGroup( string $name, string $checked = false, array $htmlOptions = array() )

Generates a control group with a radio button.

Generates a control group with a radio button.

Parameters

$name
string
$name the input name.
$checked
string
$checked whether the radio button is checked.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# checkBoxControlGroup( string $name, string $checked = false, array $htmlOptions = array() )

Generates a control group with a check box.

Generates a control group with a check box.

Parameters

$name
string
$name the input name.
$checked
string
$checked whether the check box is checked.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# dropDownListControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with a drop down list.

Generates a control group with a drop down list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# listBoxControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with a list box.

Generates a control group with a list box.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# radioButtonListControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with a radio button list.

Generates a control group with a radio button list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# inlineRadioButtonListControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with an inline radio button list.

Generates a control group with an inline radio button list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# checkBoxListControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with a check box list.

Generates a control group with a check box list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# inlineCheckBoxListControlGroup( string $name, string $select = '', array $data = array(), array $htmlOptions = array() )

Generates a control group with an inline check box list.

Generates a control group with an inline check box list.

Parameters

$name
string
$name the input name.
$select
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# uneditableFieldControlGroup( string $value = '', array $htmlOptions = array() )

Generates a control group with an uneditable field.

Generates a control group with an uneditable field.

Parameters

$value
string
$select the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# searchQueryControlGroup( string $name, string $value = '', array $htmlOptions = array() )

Generates a control group with a search field.

Generates a control group with a search field.

Parameters

$name
string
$name the input name.
$value
string
$select the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::controlGroup()
public static string
# controlGroup( string $type, string $name, string $value = '', array $htmlOptions = array(), array $data = array() )

Generates a form control group.

Generates a form control group.

Parameters

$type
string
$type the input type.
$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$data
array
$data data for multiple select inputs.

Returns

string
the generated control group.
public static string
# customControlGroup( string $input, string $name, array $htmlOptions = array() )

Generates a custom (pre-rendered) form control group.

Generates a custom (pre-rendered) form control group.

Parameters

$input
string
$input the rendered input.
$name
string
$name the input name.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.
public static string
# createInput( string $type, string $name, string $value, array $htmlOptions = array(), array $data = array() )

Creates a form input of the given type.

Creates a form input of the given type.

Parameters

$type
string
$type the input type.
$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$data
array
$data data for multiple select inputs.

Returns

string
the input.

Throws

CException
if the input type is invalid.
protected static string
# textInputField( string $type, string $name, string $value, array $htmlOptions )

Generates an input HTML tag. This method generates an input HTML tag based on the given input name and value.

Generates an input HTML tag. This method generates an input HTML tag based on the given input name and value.

Parameters

$type
string
$type the input type.
$name
string
$name the input name.
$value
string
$value the input value.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input tag.
public static string
# activeTextField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a text field input for a model attribute.

Generates a text field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activePasswordField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a password field input for a model attribute.

Generates a password field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeUrlField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates an url field input for a model attribute.

Generates an url field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeEmailField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates an email field input for a model attribute.

Generates an email field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeNumberField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a number field input for a model attribute.

Generates a number field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeRangeField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a range field input for a model attribute.

Generates a range field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeDateField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a date field input for a model attribute.

Generates a date field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

TbHtml::activeTextInputField()
public static string
# activeFileField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a file field input for a model attribute.

Generates a file field input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input field.

See

CHtml::activeFileField
public static string
# activeTextArea( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a text area input for a model attribute.

Generates a text area input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated text area.
public static string
# activeRadioButton( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a radio button for a model attribute.

Generates a radio button for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated radio button.
public static string
# activeCheckBox( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a check box for a model attribute.

Generates a check box for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated check box.
public static string
# activeDropDownList( CModel $model, string $attribute, array $data, mixed $htmlOptions = array() )

Generates a drop down list for a model attribute.

Generates a drop down list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions

Returns

string
the generated drop down list.
public static string
# activeListBox( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Generates a list box for a model attribute.

Generates a list box for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list box
public static string
# activeRadioButtonList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Generates a radio button list for a model attribute.

Generates a radio button list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data $data value-label pairs used to generate the radio button list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# activeInlineRadioButtonList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Generates an inline radio button list for a model attribute.

Generates an inline radio button list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data $data value-label pairs used to generate the radio button list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# activeCheckBoxList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Generates a check box list for a model attribute.

Generates a check box list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data $data value-label pairs used to generate the check box list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# activeInlineCheckBoxList( CModel $model, string $attribute, array $data, array $htmlOptions = array() )

Generates an inline check box list for a model attribute.

Generates an inline check box list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data $data value-label pairs used to generate the check box list.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated list.
public static string
# activeUneditableField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates an uneditable input for a model attribute.

Generates an uneditable input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input.
public static string
# activeSearchQueryField( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a search query input for a model attribute.

Generates a search query input for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input.
public static string
# activeTextFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a text field for a model attribute.

Generates a control group with a text field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activePasswordFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a password field for a model attribute.

Generates a control group with a password field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeUrlFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a url field for a model attribute.

Generates a control group with a url field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeEmailFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a email field for a model attribute.

Generates a control group with a email field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeNumberFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a number field for a model attribute.

Generates a control group with a number field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeRangeFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a range field for a model attribute.

Generates a control group with a range field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeDateFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a date field for a model attribute.

Generates a control group with a date field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeTextAreaControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a text area for a model attribute.

Generates a control group with a text area for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeFileFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a file field for a model attribute.

Generates a control group with a file field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeRadioButtonControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a radio button for a model attribute.

Generates a control group with a radio button for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeCheckBoxControlGroup( string $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a check box for a model attribute.

Generates a control group with a check box for a model attribute.

Parameters

$model
string
$name the input name.
$attribute
string
$checked whether the check box is checked.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeDropDownListControlGroup( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with a drop down list for a model attribute.

Generates a control group with a drop down list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeListBoxControlGroup( string $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with a list box for a model attribute.

Generates a control group with a list box for a model attribute.

Parameters

$model
string
$name the input name.
$attribute
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeRadioButtonListControlGroup( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with a radio button list for a model attribute.

Generates a control group with a radio button list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeInlineRadioButtonListControlGroup( string $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with an inline radio button list for a model attribute.

Generates a control group with an inline radio button list for a model attribute.

Parameters

$model
string
$name the input name.
$attribute
string
$select the selected value.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeCheckBoxListControlGroup( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with a check box list for a model attribute.

Generates a control group with a check box list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeInlineCheckBoxListControlGroup( CModel $model, string $attribute, array $data = array(), array $htmlOptions = array() )

Generates a control group with an inline check box list for a model attribute.

Generates a control group with an inline check box list for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$data
array
$data data for generating the list options (value=>display).
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeUneditableFieldControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a uneditable field for a model attribute.

Generates a control group with a uneditable field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeSearchQueryControlGroup( CModel $model, string $attribute, array $htmlOptions = array() )

Generates a control group with a search field for a model attribute.

Generates a control group with a search field for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.

See

TbHtml::activeControlGroup()
public static string
# activeControlGroup( string $type, CModel $model, string $attribute, array $htmlOptions = array(), array $data = array() )

Generates an active form row.

Generates an active form row.

Parameters

$type
string
$type the input type.
$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$data
array
$data data for multiple select inputs.

Returns

string
the generated control group.
public static string
# customActiveControlGroup( string $input, CModel $model, string $attribute, array $htmlOptions = array() )

Generates a custom (pre-rendered) active form control group.

Generates a custom (pre-rendered) active form control group.

Parameters

$input
string
$input the rendered input.
$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated control group.
public static string
# createActiveInput( string $type, CModel $model, string $attribute, array $htmlOptions = array(), array $data = array() )

Creates an active form input of the given type.

Creates an active form input of the given type.

Parameters

$type
string
$type the input type.
$model
CModel
$model the model instance.
$attribute
string
$attribute the attribute name.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$data
array
$data data for multiple select inputs.

Returns

string
the input.

Throws

CException
if the input type is invalid.
public static string
# errorSummary( mixed $model, string $header = null, string $footer = null, array $htmlOptions = array() )

Displays a summary of validation errors for one or several models.

Displays a summary of validation errors for one or several models.

Parameters

$model
mixed
$model the models whose input errors are to be displayed.
$header
string
$header a piece of HTML code that appears in front of the errors.
$footer
string
$footer a piece of HTML code that appears at the end of the errors.
$htmlOptions
array
$htmlOptions additional HTML attributes to be rendered in the container div tag.

Returns

string
the error summary. Empty if no errors are found.
public static string
# error( CModel $model, string $attribute, array $htmlOptions = array() )

Displays the first validation error for a model attribute.

Displays the first validation error for a model attribute.

Parameters

$model
CModel
$model the data model.
$attribute
string
$attribute the attribute name.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the rendered error. Empty if no errors are found.
protected static string
# activeTextInputField( string $type, CModel $model, string $attribute, array $htmlOptions )

Generates an input HTML tag for a model attribute. This method generates an input HTML tag based on the given input name and value.

Generates an input HTML tag for a model attribute. This method generates an input HTML tag based on the given input name and value.

Parameters

$type
string
$type the input type.
$model
CModel
$model the data model.
$attribute
string
$attribute the attribute.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated input tag.
protected static string
# getAddOnClasses( array $htmlOptions )

Returns the add-on classes based on the given options.

Returns the add-on classes based on the given options.

Parameters

$htmlOptions
array
$htmlOptions the options.

Returns

string
the classes.
protected static string
# inputAddOn( string $addOn, array $htmlOptions )

Generates an add-on for an input field.

Generates an add-on for an input field.

Parameters

$addOn
string
$addOn the add-on.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated add-on.
protected static string
# inputHelp( string $help, array $htmlOptions )

Generates a help text for an input field.

Generates a help text for an input field.

Parameters

$help
string
$help the help text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated help text.
protected static array
# normalizeInputOptions( array $options )

Normalizes input options.

Normalizes input options.

Parameters

$options
array
$options the options.

Returns

array
the normalized options.
public static string
# controls( mixed $controls, array $htmlOptions = array() )

Generates form controls.

Generates form controls.

Parameters

$controls
mixed
$controls the controls.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated controls.
public static string
# controlsRow( mixed $controls, array $htmlOptions = array() )

Generates form controls row.

Generates form controls row.

Parameters

$controls
mixed
$controls the controls.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated controls.
public static string
# formActions( mixed $actions, array $htmlOptions = array() )

Generates form actions.

Generates form actions.

Parameters

$actions
mixed
$actions the actions.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated actions.
public static string
# searchForm( mixed $action, string $method = 'post', array $htmlOptions = array() )

Generates a search form.

Generates a search form.

Parameters

$action
mixed
$action the form action URL.
$method
string
$method form method (e.g. post, get).
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated form.
public static string
# link( string $text, mixed $url = '#', array $htmlOptions = array() )

Generates a hyperlink tag.

Generates a hyperlink tag.

Parameters

$text
string
$text link body. It will NOT be HTML-encoded.
$url
mixed
$url a URL or an action route that can be used to create a URL.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated hyperlink
public static string
# button( string $label = 'Button', array $htmlOptions = array() )

Generates an button.

Generates an button.

Parameters

$label
string
$label the button label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# htmlButton( string $label = 'Button', array $htmlOptions = array() )

Generates an image submit button.

Generates an image submit button.

Parameters

$label
string
$src the image URL
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# submitButton( string $label = 'Submit', array $htmlOptions = array() )

Generates a submit button.

Generates a submit button.

Parameters

$label
string
$label the button label
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# resetButton( string $label = 'Reset', array $htmlOptions = array() )

Generates a reset button.

Generates a reset button.

Parameters

$label
string
$label the button label
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# imageButton( string $src, array $htmlOptions = array() )

Generates an image submit button.

Generates an image submit button.

Parameters

$src
string
$src the image URL
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# linkButton( string $label = 'Submit', array $htmlOptions = array() )

Generates a link submit button.

Generates a link submit button.

Parameters

$label
string
$label the button label.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button tag.
public static string
# ajaxLink( string $text, mixed $url, array $ajaxOptions = array(), array $htmlOptions = array() )

Generates a link that can initiate AJAX requests.

Generates a link that can initiate AJAX requests.

Parameters

$text
string
$text the link body (it will NOT be HTML-encoded.)
$url
mixed
$url the URL for the AJAX request.
$ajaxOptions
array
$ajaxOptions AJAX options.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# ajaxButton( string $label, mixed $url, array $ajaxOptions = array(), array $htmlOptions = array() )

Generates a push button that can initiate AJAX requests.

Generates a push button that can initiate AJAX requests.

Parameters

$label
string
$label the button label.
$url
mixed
$url the URL for the AJAX request.
$ajaxOptions
array
$ajaxOptions AJAX options.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# ajaxSubmitButton( string $label, mixed $url, array $ajaxOptions = array(), array $htmlOptions = array() )

Generates a push button that can submit the current form in POST method.

Generates a push button that can submit the current form in POST method.

Parameters

$label
string
$label the button label
$url
mixed
$url the URL for the AJAX request.
$ajaxOptions
array
$ajaxOptions AJAX options.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# btn( string $type, string $label, array $htmlOptions = array() )

Generates a button.

Generates a button.

Parameters

$type
string
$type the button type.
$label
string
$label the button label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
protected static string
# btnDropdown( string $type, string $label, array $items, array $htmlOptions )

Generates a button dropdown.

Generates a button dropdown.

Parameters

$type
string
$type the button type.
$label
string
$label the button label text.
$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
protected static string
# createButton( string $type, string $label, array $htmlOptions )

Creates a button the of given type.

Creates a button the of given type.

Parameters

$type
string
$type the button type.
$label
string
$label the button label.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the button.

Throws

CException
if the button type is valid.
public static string
# imageRounded( string $src, string $alt = '', array $htmlOptions = array() )

Generates an image tag with rounded corners.

Generates an image tag with rounded corners.

Parameters

$src
string
$src the image URL.
$alt
string
$alt the alternative text display.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated image tag.
public static string
# imageCircle( string $src, string $alt = '', array $htmlOptions = array() )

Generates an image tag with circle.

Generates an image tag with circle.

Parameters

$src
string
$src the image URL.
$alt
string
$alt the alternative text display.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated image tag.
public static string
# imagePolaroid( string $src, string $alt = '', array $htmlOptions = array() )

Generates an image tag within polaroid frame.

Generates an image tag within polaroid frame.

Parameters

$src
string
$src the image URL.
$alt
string
$alt the alternative text display.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated image tag.
public static string
# image( string $src, string $alt = '', array $htmlOptions = array() )

Generates an image tag.

Generates an image tag.

Parameters

$src
string
$src the image URL.
$alt
string
$alt the alternative text display.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated image tag.
public static string
# icon( string $icon, array $htmlOptions = array(), string $tagName = 'i' )

Generates an icon.

Generates an icon.

Parameters

$icon
string
$icon the icon type.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$tagName
string
$tagName the icon HTML tag.

Returns

string
the generated icon.
protected static string
# dropdown( array $items, array $htmlOptions = array() )

Generates a dropdown menu.

Generates a dropdown menu.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# dropdownToggleLink( string $label, array $htmlOptions = array() )

Generates a dropdown toggle link.

Generates a dropdown toggle link.

Parameters

$label
string
$label the link label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# dropdownToggleButton( string $label = '', array $htmlOptions = array() )

Generates a dropdown toggle button.

Generates a dropdown toggle button.

Parameters

$label
string
$label the button label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
protected static string
# dropdownToggle( string $type, string $label, array $htmlOptions )

Generates a dropdown toggle element.

Generates a dropdown toggle element.

Parameters

$type
string
$tag the HTML tag.
$label
string
$label the element text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated element.
public static string
# dropdownToggleMenuLink( string $label, string $url = '#', array $htmlOptions = array(), integer $depth = 0 )

Generates a dropdown toggle menu item.

Generates a dropdown toggle menu item.

Parameters

$label
string
$label the menu item text.
$url
string
$url the menu item URL.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$depth
integer
$depth the menu depth at which this link is located

Returns

string
the generated menu item.
public static string
# buttonGroup( array $buttons, array $htmlOptions = array() )

Generates a button group.

Generates a button group.

Parameters

$buttons
array
$buttons the button configurations.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated button group.
public static string
# verticalButtonGroup( array $buttons, array $htmlOptions = array() )

Generates a vertical button group.

Generates a vertical button group.

Parameters

$buttons
array
$buttons the button configurations.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated button group.
public static string
# buttonToolbar( array $groups, array $htmlOptions = array() )

Generates a button toolbar.

Generates a button toolbar.

Parameters

$groups
array
$groups the button group configurations.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated button toolbar.
public static string
# buttonDropdown( string $label, array $items, array $htmlOptions = array() )

Generates a button with a dropdown menu.

Generates a button with a dropdown menu.

Parameters

$label
string
$label the button label text.
$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# splitButtonDropdown( string $label, array $items, array $htmlOptions = array() )

Generates a button with a split dropdown menu.

Generates a button with a split dropdown menu.

Parameters

$label
string
$label the button label text.
$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated button.
public static string
# tabs( array $items, array $htmlOptions = array() )

Generates a tab navigation.

Generates a tab navigation.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# stackedTabs( array $items, array $htmlOptions = array() )

Generates a stacked tab navigation.

Generates a stacked tab navigation.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# pills( array $items, array $htmlOptions = array() )

Generates a pills navigation.

Generates a pills navigation.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# stackedPills( array $items, array $htmlOptions = array() )

Generates a stacked pills navigation.

Generates a stacked pills navigation.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# navList( array $items, array $htmlOptions = array() )

Generates a list navigation.

Generates a list navigation.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# nav( string $type, array $items, array $htmlOptions = array() )

Generates a navigation menu.

Generates a navigation menu.

Parameters

$type
string
$type the menu type.
$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# menu( array $items, array $htmlOptions = array(), integer $depth = 0 )

Generates a menu.

Generates a menu.

Parameters

$items
array
$items the menu items.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$depth
integer
$depth the current depth.

Returns

string
the generated menu.
public static string
# menuLink( string $label, array $url, array $htmlOptions = array() )

Generates a menu link.

Generates a menu link.

Parameters

$label
string
$label the link label.
$url
array
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu item.
protected static string
# menuDropdown( string $label, string $url, array $items, array $htmlOptions, integer $depth = 0 )

Generates a menu dropdown.

Generates a menu dropdown.

Parameters

$label
string
$label the link label.
$url
string
$url the link URL.
$items
array
$items the menu configuration.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$depth
integer
$depth the current depth.

Returns

string
the generated dropdown.
public static string
# menuHeader( string $label, array $htmlOptions = array() )

Generates a menu header.

Generates a menu header.

Parameters

$label
string
$label the header text.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated header.
public static string
# menuDivider( array $htmlOptions = array() )

Generates a menu divider.

Generates a menu divider.

Parameters

$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu item.
public static string
# tabbableTabs( array $tabs, array $htmlOptions = array() )

Generates a tabbable tabs menu.

Generates a tabbable tabs menu.

Parameters

$tabs
array
$tabs the tab configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# tabbablePills( array $pills, array $htmlOptions = array() )

Generates a tabbable pills menu.

Generates a tabbable pills menu.

Parameters

$pills
array
$tabs the tab configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
public static string
# tabbable( string $type, array $tabs, array $htmlOptions = array() )

Generates a tabbable menu.

Generates a tabbable menu.

Parameters

$type
string
$type the menu type.
$tabs
array
$tabs the tab configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated menu.
protected static array
# normalizeTabs( array $tabs, array & $panes, integer $i = 0 )

Normalizes the tab configuration.

Normalizes the tab configuration.

Parameters

$tabs
array
$tabs the tab configuration.
$panes
array
$panes a reference to the panes array.
$i
integer
$i the running index.

Returns

array
the items.
public static string
# navbar( string $content, array $htmlOptions = array() )

Generates a navbar.

Generates a navbar.

Parameters

$content
string
$content the navbar content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated navbar.
public static string
# navbarBrandLink( string $label, string $url, array $htmlOptions = array() )

Generates a brand link for the navbar.

Generates a brand link for the navbar.

Parameters

$label
string
$label the link label text.
$url
string
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# navbarText( string $text, array $htmlOptions = array(), string $tag = 'p' )

Generates a text for the navbar.

Generates a text for the navbar.

Parameters

$text
string
$text the text.
$htmlOptions
array
$htmlOptions additional HTML attributes.
$tag
string
$tag the HTML tag.

Returns

string
the generated text block.
public static string
# navbarMenuDivider( array $htmlOptions = array() )

Generates a menu divider for the navbar.

Generates a menu divider for the navbar.

Parameters

$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated divider.
public static string
# navbarForm( mixed $action, string $method = 'post', array $htmlOptions = array() )

Generates a navbar form.

Generates a navbar form.

Parameters

$action
mixed
$action the form action URL.
$method
string
$method form method (e.g. post, get).
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated form.
public static string
# navbarSearchForm( mixed $action, string $method = 'post', array $htmlOptions = array() )

Generates a navbar search form.

Generates a navbar search form.

Parameters

$action
mixed
$action the form action URL.
$method
string
$method form method (e.g. post, get).
$htmlOptions
array
$htmlOptions additional HTML attributes

Returns

string
the generated form.
public static string
# navbarCollapseLink( string $target, array $htmlOptions = array() )

Generates a collapse element.

Generates a collapse element.

Parameters

$target
string
$target the CSS selector for the target element.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated icon.
public static string
# breadcrumbs( array $links, array $htmlOptions = array() )

Generates a breadcrumb menu.

Generates a breadcrumb menu.

Parameters

$links
array
$links the breadcrumb links.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated breadcrumb.
public static string
# pagination( array $items, array $htmlOptions = array() )

Generates a pagination.

Generates a pagination.

Parameters

$items
array
$items the pagination buttons.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated pagination.
public static string
# paginationLink( string $label, mixed $url, array $htmlOptions = array() )

Generates a pagination link.

Generates a pagination link.

Parameters

$label
string
$label the link label text.
$url
mixed
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# pager( array $links, array $htmlOptions = array() )

Generates a pager.

Generates a pager.

Parameters

$links
array
$links the pager buttons.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated pager.
public static string
# pagerLink( string $label, mixed $url, array $htmlOptions = array() )

Generates a pager link.

Generates a pager link.

Parameters

$label
string
$label the link label text.
$url
mixed
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# labelTb( string $label, array $htmlOptions = array() )

Generates a label span.

Generates a label span.

Parameters

$label
string
$label the label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated span.
public static string
# badge( string $label, array $htmlOptions = array() )

Generates a badge span.

Generates a badge span.

Parameters

$label
string
$label the badge text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated span.
public static string
# heroUnit( string $heading, string $content, array $htmlOptions = array() )

Generates a hero unit.

Generates a hero unit.

Parameters

$heading
string
$heading the heading text.
$content
string
$content the content text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated hero unit.
public static string
# pageHeader( string $heading, string $subtext, array $htmlOptions = array() )

Generates a pager header.

Generates a pager header.

Parameters

$heading
string
$heading the heading text.
$subtext
string
$subtext the subtext.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated pager header.
public static string
# thumbnails( array $thumbnails, array $htmlOptions = array() )

Generates a list of thumbnails.

Generates a list of thumbnails.

Parameters

$thumbnails
array
$thumbnails the list configuration.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated thumbnails.
public static string
# thumbnail( string $content, array $htmlOptions = array() )

Generates a thumbnail.

Generates a thumbnail.

Parameters

$content
string
$content the thumbnail content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated thumbnail.
public static string
# thumbnailLink( string $content, mixed $url = '#', array $htmlOptions = array() )

Generates a link thumbnail.

Generates a link thumbnail.

Parameters

$content
string
$content the thumbnail content.
$url
mixed
$url the url that the thumbnail links to.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated thumbnail.
public static string
# alert( string $color, string $message, array $htmlOptions = array() )

Generates an alert.

Generates an alert.

Parameters

$color
string
$color the color of the alert.
$message
string
$message the message to display.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated alert.
public static string
# blockAlert( string $color, string $message, array $htmlOptions = array() )

Generates an alert block.

Generates an alert block.

Parameters

$color
string
$color the color of the alert.
$message
string
$message the message to display.
$htmlOptions
array
$htmlOptions additional HTML options.

Returns

string
the generated alert.
public static string
# progressBar( integer $width = 0, array $htmlOptions = array() )

Generates a progress bar.

Generates a progress bar.

Parameters

$width
integer
$width the progress in percent.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated progress bar.
public static string
# stripedProgressBar( integer $width = 0, array $htmlOptions = array() )

Generates a striped progress bar.

Generates a striped progress bar.

Parameters

$width
integer
$width the progress in percent.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated progress bar.
public static string
# animatedProgressBar( integer $width = 0, array $htmlOptions = array() )

Generates an animated progress bar.

Generates an animated progress bar.

Parameters

$width
integer
$width the progress in percent.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated progress bar.
public static string
# stackedProgressBar( array $bars, array $htmlOptions = array() )

Generates a stacked progress bar.

Generates a stacked progress bar.

Parameters

$bars
array
$bars the bar configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated progress bar.
protected static string
# bar( integer $width = 0, array $htmlOptions = array() )

Generates a progress bar.

Generates a progress bar.

Parameters

$width
integer
$width the progress in percent.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated bar.
public static string
# mediaList( array $items, array $htmlOptions = array() )

Generates a list of media objects.

Generates a list of media objects.

Parameters

$items
array
$items item configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
generated list.
public static string
# medias( array $items, string $tag = 'div' )

Generates multiple media objects.

Generates multiple media objects.

Parameters

$items
array
$items item configurations.
$tag
string
$tag the item tag name.

Returns

string
generated objects.
public static string
# media( string $image, string $heading, string $content, array $htmlOptions = array() )

Generates a single media object.

Generates a single media object.

Parameters

$image
string
$image the image url.
$heading
string
$heading the heading text.
$content
string
$content the content text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the media object.
public static string
# well( string $content, array $htmlOptions = array() )

Generates a well element.

Generates a well element.

Parameters

$content
string
$content the well content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated well.
public static string
# closeLink( string $label = TbHtml::CLOSE_TEXT, mixed $url = '#', array $htmlOptions = array() )

Generates a close link.

Generates a close link.

Parameters

$label
string
$label the link label text.
$url
mixed
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# closeButton( string $label = TbHtml::CLOSE_TEXT, array $htmlOptions = array() )

Generates a close button.

Generates a close button.

Parameters

$label
string
$label the button label text.
$htmlOptions
array
$htmlOptions the HTML options for the button.

Returns

string
the generated button.
protected static string
# close( string $tag, string $label, array $htmlOptions = array() )

Generates a close element.

Generates a close element.

Parameters

$tag
string
$tag the tag name.
$label
string
$label the element label text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated element.
public static string
# collapseLink( string $label, string $target, array $htmlOptions = array() )

Generates a collapse link.

Generates a collapse link.

Parameters

$label
string
$label the link label.
$target
string
$target the CSS selector.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# modalHeader( string $content, array $htmlOptions = array() )

Generates a modal header.

Generates a modal header.

Parameters

$content
string
$content the header content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated header.
public static string
# modalBody( string $content, array $htmlOptions = array() )

Generates a modal body.

Generates a modal body.

Parameters

$content
string
$content the body content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated body.
public static string
# modalFooter( string $content, array $htmlOptions = array() )

Generates a modal footer.

Generates a modal footer.

Parameters

$content
string
$content the footer content.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated footer.
public static string
# tooltip( string $label, mixed $url, string $content, array $htmlOptions = array() )

Generates a tooltip.

Generates a tooltip.

Parameters

$label
string
$label the tooltip link label text.
$url
mixed
$url the link url.
$content
string
$content the tooltip content text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated tooltip.
public static string
# popover( string $label, string $title, string $content, array $htmlOptions = array() )

Generates a popover.

Generates a popover.

Parameters

$label
string
$label the popover link label text.
$title
string
$title the popover title text.
$content
string
$content the popover content text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated popover.
protected static string
# tooltipPopover( string $label, mixed $url, string $title, array $htmlOptions )

Generates a base tooltip.

Generates a base tooltip.

Parameters

$label
string
$label the tooltip link label text.
$url
mixed
$url the link url.
$title
string
$title the tooltip title text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated tooltip.
public static string
# carousel( array $items, array $htmlOptions = array() )

Generates an image carousel.

Generates an image carousel.

Parameters

$items
array
$items the item configurations.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated carousel.
public static string
# carouselItem( string $content, string $label, string $caption, array $htmlOptions = array() )

Generates a carousel item.

Generates a carousel item.

Parameters

$content
string
$content the content.
$label
string
$label the item label text.
$caption
string
$caption the item caption text.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated item.
public static string
# carouselPrevLink( string $label, mixed $url = '#', array $htmlOptions = array() )

Generates a previous link for the carousel.

Generates a previous link for the carousel.

Parameters

$label
string
$label the link label text.
$url
mixed
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# carouselNextLink( string $label, mixed $url = '#', array $htmlOptions = array() )

Generates a next link for the carousel.

Generates a next link for the carousel.

Parameters

$label
string
$label the link label text.
$url
mixed
$url the link url.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated link.
public static string
# carouselIndicators( string $target, integer $numSlides, array $htmlOptions = array() )

Generates an indicator for the carousel.

Generates an indicator for the carousel.

Parameters

$target
string
$target the CSS selector for the target element.
$numSlides
integer
$numSlides the number of slides.
$htmlOptions
array
$htmlOptions additional HTML attributes.

Returns

string
the generated indicators.
public static array
# addCssClass( mixed $className, array & $htmlOptions )

Appends new class names to the given options..

Appends new class names to the given options..

Parameters

$className
mixed
$className the class(es) to append.
$htmlOptions
array
$htmlOptions the options.

Returns

array
the options.
public static array
# addCssStyle( string $style, array & $htmlOptions )

Appends a CSS style string to the given options.

Appends a CSS style string to the given options.

Parameters

$style
string
$style the CSS style string.
$htmlOptions
array
$htmlOptions the options.

Returns

array
the options.
protected static
# addSpanClass( array & $htmlOptions )

Adds the grid span class to the given options is applicable.

Adds the grid span class to the given options is applicable.

Parameters

$htmlOptions
array
$htmlOptions the HTML attributes.
protected static
# addPullClass( array & $htmlOptions )

Adds the pull class to the given options is applicable.

Adds the pull class to the given options is applicable.

Parameters

$htmlOptions
array
$htmlOptions the HTML attributes.
protected static
# addTextAlignClass( array & $htmlOptions )

Adds the text align class to the given options if applicable.

Adds the text align class to the given options if applicable.

Parameters

$htmlOptions
array
$htmlOptions the HTML attributes.
Constants summary
string TEXT_ALIGN_LEFT 'left'
#
string TEXT_ALIGN_CENTER 'center'
#
string TEXT_ALIGN_RIGHT 'right'
#
string TEXT_COLOR_DEFAULT ''
#
string TEXT_COLOR_WARNING 'warning'
#
string TEXT_COLOR_ERROR 'error'
#
string TEXT_COLOR_INFO 'info'
#
string TEXT_COLOR_SUCCESS 'success'
#
string HELP_TYPE_INLINE 'inline'
#
string HELP_TYPE_BLOCK 'block'
#
string FORM_LAYOUT_VERTICAL 'vertical'
#
string FORM_LAYOUT_HORIZONTAL 'horizontal'
#
string FORM_LAYOUT_INLINE 'inline'
#
string FORM_LAYOUT_SEARCH 'search'
#
string INPUT_TYPE_TEXT 'textField'
#
string INPUT_TYPE_PASSWORD 'passwordField'
#
string INPUT_TYPE_URL 'urlField'
#
string INPUT_TYPE_EMAIL 'emailField'
#
string INPUT_TYPE_NUMBER 'numberField'
#
string INPUT_TYPE_RANGE 'rangeField'
#
string INPUT_TYPE_DATE 'dateField'
#
string INPUT_TYPE_TEXTAREA 'textArea'
#
string INPUT_TYPE_FILE 'fileField'
#
string INPUT_TYPE_RADIOBUTTON 'radioButton'
#
string INPUT_TYPE_CHECKBOX 'checkBox'
#
string INPUT_TYPE_DROPDOWNLIST 'dropDownList'
#
string INPUT_TYPE_LISTBOX 'listBox'
#
string INPUT_TYPE_CHECKBOXLIST 'checkBoxList'
#
string INPUT_TYPE_INLINECHECKBOXLIST 'inlineCheckBoxList'
#
string INPUT_TYPE_RADIOBUTTONLIST 'radioButtonList'
#
string INPUT_TYPE_INLINERADIOBUTTONLIST 'inlineRadioButtonList'
#
string INPUT_TYPE_UNEDITABLE 'uneditableField'
#
string INPUT_TYPE_SEARCH 'searchQuery'
#
string INPUT_TYPE_CUSTOM 'widget'
#
string INPUT_SIZE_MINI 'mini'
#
string INPUT_SIZE_SMALL 'small'
#
string INPUT_SIZE_DEFAULT ''
#
string INPUT_SIZE_MEDIUM 'medium'
#
string INPUT_SIZE_LARGE 'large'
#
string INPUT_SIZE_XLARGE 'xlarge'
#
string INPUT_SIZE_XXLARGE 'xxlarge'
#
string INPUT_COLOR_DEFAULT ''
#
string INPUT_COLOR_WARNING 'warning'
#
string INPUT_COLOR_ERROR 'error'
#
string INPUT_COLOR_INFO 'info'
#
string INPUT_COLOR_SUCCESS 'success'
#
string BUTTON_TYPE_LINK 'link'
#
string BUTTON_TYPE_HTML 'htmlButton'
#
string BUTTON_TYPE_SUBMIT 'submitButton'
#
string BUTTON_TYPE_RESET 'resetButton'
#
string BUTTON_TYPE_IMAGE 'imageButton'
#
string BUTTON_TYPE_LINKBUTTON 'linkButton'
#
string BUTTON_TYPE_AJAXLINK 'ajaxLink'
#
string BUTTON_TYPE_AJAXBUTTON 'ajaxButton'
#
string BUTTON_TYPE_INPUTBUTTON 'inputButton'
#
string BUTTON_TYPE_INPUTSUBMIT 'inputSubmit'
#
string BUTTON_COLOR_DEFAULT ''
#
string BUTTON_COLOR_PRIMARY 'primary'
#
string BUTTON_COLOR_INFO 'info'
#
string BUTTON_COLOR_SUCCESS 'success'
#
string BUTTON_COLOR_WARNING 'warning'
#
string BUTTON_COLOR_DANGER 'danger'
#
string BUTTON_COLOR_INVERSE 'inverse'
#
string BUTTON_COLOR_LINK 'link'
#
string BUTTON_SIZE_MINI 'mini'
#
string BUTTON_SIZE_SMALL 'small'
#
string BUTTON_SIZE_DEFAULT ''
#
string BUTTON_SIZE_LARGE 'large'
#
string BUTTON_TOGGLE_CHECKBOX 'checkbox'
#
string BUTTON_TOGGLE_RADIO 'radio'
#
string IMAGE_TYPE_ROUNDED 'rounded'
#
string IMAGE_TYPE_CIRCLE 'circle'
#
string IMAGE_TYPE_POLAROID 'polaroid'
#
string NAV_TYPE_NONE ''
#
string NAV_TYPE_TABS 'tabs'
#
string NAV_TYPE_PILLS 'pills'
#
string NAV_TYPE_LIST 'list'
#
string TABS_PLACEMENT_ABOVE ''
#
string TABS_PLACEMENT_BELOW 'below'
#
string TABS_PLACEMENT_LEFT 'left'
#
string TABS_PLACEMENT_RIGHT 'right'
#
string NAVBAR_DISPLAY_NONE ''
#
string NAVBAR_DISPLAY_FIXEDTOP 'fixed-top'
#
string NAVBAR_DISPLAY_FIXEDBOTTOM 'fixed-bottom'
#
string NAVBAR_DISPLAY_STATICTOP 'static-top'
#
string NAVBAR_COLOR_INVERSE 'inverse'
#
string PAGINATION_SIZE_MINI 'mini'
#
string PAGINATION_SIZE_SMALL 'small'
#
string PAGINATION_SIZE_DEFAULT ''
#
string PAGINATION_SIZE_LARGE 'large'
#
string PAGINATION_ALIGN_LEFT 'left'
#
string PAGINATION_ALIGN_CENTER 'centered'
#
string PAGINATION_ALIGN_RIGHT 'right'
#
string LABEL_COLOR_DEFAULT ''
#
string LABEL_COLOR_SUCCESS 'success'
#
string LABEL_COLOR_WARNING 'warning'
#
string LABEL_COLOR_IMPORTANT 'important'
#
string LABEL_COLOR_INFO 'info'
#
string LABEL_COLOR_INVERSE 'inverse'
#
string BADGE_COLOR_DEFAULT ''
#
string BADGE_COLOR_SUCCESS 'success'
#
string BADGE_COLOR_WARNING 'warning'
#
string BADGE_COLOR_IMPORTANT 'important'
#
string BADGE_COLOR_INFO 'info'
#
string BADGE_COLOR_INVERSE 'inverse'
#
string TOOLTIP_PLACEMENT_TOP 'top'
#
string TOOLTIP_PLACEMENT_BOTTOM 'bottom'
#
string TOOLTIP_PLACEMENT_LEFT 'left'
#
string TOOLTIP_PLACEMENT_RIGHT 'right'
#
string TOOLTIP_TRIGGER_CLICK 'click'
#
string TOOLTIP_TRIGGER_HOVER 'hover'
#
string TOOLTIP_TRIGGER_FOCUS 'focus'
#
string TOOLTIP_TRIGGER_MANUAL 'manual'
#
string POPOVER_PLACEMENT_TOP 'top'
#
string POPOVER_PLACEMENT_BOTTOM 'bottom'
#
string POPOVER_PLACEMENT_LEFT 'left'
#
string POPOVER_PLACEMENT_RIGHT 'right'
#
string POPOVER_TRIGGER_CLICK 'click'
#
string POPOVER_TRIGGER_HOVER 'hover'
#
string POPOVER_TRIGGER_FOCUS 'focus'
#
string POPOVER_TRIGGER_MANUAL 'manual'
#
string ALERT_COLOR_DEFAULT ''
#
string ALERT_COLOR_INFO 'info'
#
string ALERT_COLOR_SUCCESS 'success'
#
string ALERT_COLOR_WARNING 'warning'
#
string ALERT_COLOR_ERROR 'error'
#
string ALERT_COLOR_DANGER 'danger'
#
string PROGRESS_COLOR_DEFAULT ''
#
string PROGRESS_COLOR_INFO 'info'
#
string PROGRESS_COLOR_SUCCESS 'success'
#
string PROGRESS_COLOR_WARNING 'warning'
#
string PROGRESS_COLOR_DANGER 'danger'
#
string WELL_SIZE_SMALL 'small'
#
string WELL_SIZE_DEFAULT ''
#
string WELL_SIZE_LARGE 'large'
#
string PULL_LEFT 'left'
#
string PULL_RIGHT 'right'
#
string CLOSE_DISMISS_ALERT 'alert'
#
string CLOSE_DISMISS_MODAL 'modal'
#
string DETAIL_TYPE_STRIPED 'striped'
#
string DETAIL_TYPE_BORDERED 'bordered'
#
string DETAIL_TYPE_CONDENSED 'condensed'
#
string DETAIL_TYPE_HOVER 'hover'
#
string GRID_TYPE_STRIPED 'striped'
#
string GRID_TYPE_BORDERED 'bordered'
#
string GRID_TYPE_CONDENSED 'condensed'
#
string GRID_TYPE_HOVER 'hover'
#
string AFFIX_POSITION_TOP 'top'
#
string AFFIX_POSITION_BOTTOM 'bottom'
#
string ICON_COLOR_DEFAULT ''
#
string ICON_COLOR_WHITE 'white'
#
string ICON_GLASS 'icon-glass'
#
string ICON_MUSIC 'icon-music'
#
string ICON_SEARCH 'icon-search'
#
string ICON_ENVELOPE 'icon-envelope'
#
string ICON_HEART 'icon-heart'
#
string ICON_STAR 'icon-star'
#
string ICON_STAR_EMPTY 'icon-star-empty'
#
string ICON_USER 'icon-user'
#
string ICON_FILM 'icon-film'
#
string ICON_TH_LARGE 'icon-th-large'
#
string ICON_TH 'icon-th'
#
string ICON_TH_LIST 'icon-th-list'
#
string ICON_OK 'icon-ok'
#
string ICON_REMOVE 'icon-remove'
#
string ICON_ZOOM_IN 'icon-zoom-in'
#
string ICON_ZOOM_OUT 'icon-zoom-out'
#
string ICON_OFF 'icon-off'
#
string ICON_SIGNAL 'icon-signal'
#
string ICON_COG 'icon-cog'
#
string ICON_TRASH 'icon-trash'
#
string ICON_HOME 'icon-home'
#
string ICON_FILE 'icon-file'
#
string ICON_TIME 'icon-time'
#
string ICON_ROAD 'icon-road'
#
string ICON_DOWNLOAD_ALT 'icon-download-alt'
#
string ICON_DOWNLOAD 'icon-download'
#
string ICON_UPLOAD 'icon-upload'
#
string ICON_INBOX 'icon-inbox'
#
string ICON_PLAY_CIRCLE 'icon-play-circle'
#
string ICON_REPEAT 'icon-repeat'
#
string ICON_REFRESH 'icon-refresh'
#
string ICON_LIST_ALT 'icon-list-alt'
#
string ICON_LOCK 'icon-lock'
#
string ICON_FLAG 'icon-flag'
#
string ICON_HEADPHONES 'icon-headphones'
#
string ICON_VOLUME_OFF 'icon-volume-off'
#
string ICON_VOLUME_DOWN 'icon-volume-down'
#
string ICON_VOLUME_UP 'icon-volume-up'
#
string ICON_QRCODE 'icon-qrcode'
#
string ICON_BARCODE 'icon-barcode'
#
string ICON_TAG 'icon-tag'
#
string ICON_TAGS 'icon-tags'
#
string ICON_BOOK 'icon-book'
#
string ICON_BOOKMARK 'icon-bookmark'
#
string ICON_PRINT 'icon-print'
#
string ICON_CAMERA 'icon-camera'
#
string ICON_FONT 'icon-font'
#
string ICON_BOLD 'icon-bold'
#
string ICON_ITALIC 'icon-italic'
#
string ICON_TEXT_HEIGHT 'icon-text-height'
#
string ICON_TEXT_WIDTH 'icon-text-width'
#
string ICON_ALIGN_LEFT 'icon-align-left'
#
string ICON_ALIGN_CENTER 'icon-align-center'
#
string ICON_ALIGN_RIGHT 'icon-align-right'
#
string ICON_ALIGN_JUSTIFY 'icon-align-justify'
#
string ICON_LIST 'icon-list'
#
string ICON_INDENT_LEFT 'icon-indent-left'
#
string ICON_INDENT_RIGHT 'icon-indent-right'
#
string ICON_FACETIME_VIDEO 'icon-facetime-video'
#
string ICON_PICTURE 'icon-picture'
#
string ICON_PENCIL 'icon-pencil'
#
string ICON_MAP_MARKER 'icon-map-marker'
#
string ICON_ADJUST 'icon-adjust'
#
string ICON_TINT 'icon-tint'
#
string ICON_EDIT 'icon-edit'
#
string ICON_SHARE 'icon-share'
#
string ICON_CHECK 'icon-check'
#
string ICON_MOVE 'icon-move'
#
string ICON_STEP_BACKWARD 'icon-step-backward'
#
string ICON_FAST_BACKWARD 'icon-fast-backward'
#
string ICON_BACKWARD 'icon-backward'
#
string ICON_PLAY 'icon-play'
#
string ICON_PAUSE 'icon-pause'
#
string ICON_STOP 'icon-pause'
#
string ICON_FORWARD 'icon-forward'
#
string ICON_FAST_FORWARD 'icon-fast-forward'
#
string ICON_STEP_FORWARD 'icon-step-forward'
#
string ICON_EJECT 'icon-eject'
#
string ICON_CHEVRON_LEFT 'icon-chevron-left'
#
string ICON_CHEVRON_RIGHT 'icon-chevron-right'
#
string ICON_PLUS_SIGN 'icon-plus-sign'
#
string ICON_MINUS_SIGN 'icon-minus-sign'
#
string ICON_REMOVE_SIGN 'icon-remove-sign'
#
string ICON_OK_SIGN 'icon-ok-sign'
#
string ICON_QUESTION_SIGN 'icon-question-sign'
#
string ICON_INFO_SIGN 'icon-info-sign'
#
string ICON_SCREENSHOT 'icon-screenshot'
#
string ICON_REMOVE_CIRCLE 'icon-remove-circle'
#
string ICON_OK_CIRCLE 'icon-ok-circle'
#
string ICON_BAN_CIRCLE 'icon-ban-circle'
#
string ICON_ARROW_LEFT 'icon-arrow-left'
#
string ICON_ARROW_RIGHT 'icon-arrow-right'
#
string ICON_ARROW_UP 'icon-arrow-up'
#
string ICON_ARROW_DOWN 'icon-arrow-down'
#
string ICON_SHARE_ALT 'icon-share-alt'
#
string ICON_RESIZE_FULL 'icon-resize-full'
#
string ICON_RESIZE_SMALL 'icon-resize-small'
#
string ICON_PLUS 'icon-plus'
#
string ICON_MINUS 'icon-minus'
#
string ICON_ASTERISK 'icon-asterisk'
#
string ICON_EXCLAMATION_SIGN 'icon-exclamation-sign'
#
string ICON_GIFT 'icon-gift'
#
string ICON_LEAF 'icon-leaf'
#
string ICON_FIRE 'icon-fire'
#
string ICON_EYE_OPEN 'icon-eye-open'
#
string ICON_EYE_CLOSE 'icon-eye-close'
#
string ICON_WARNING_SIGN 'icon-warning-sign'
#
string ICON_PLANE 'icon-plane'
#
string ICON_CALENDAR 'icon-calendar'
#
string ICON_RANDOM 'icon-random'
#
string ICON_COMMENT 'icon-comment'
#
string ICON_MAGNET 'icon-magnet'
#
string ICON_CHEVRON_UP 'icon-chevron-up'
#
string ICON_CHEVRON_DOWN 'icon-chevron-down'
#
string ICON_RETWEET 'icon-retweet'
#
string ICON_SHOPPING_CART 'icon-shopping-cart'
#
string ICON_FOLDER_CLOSE 'icon-folder-close'
#
string ICON_FOLDER_OPEN 'icon-folder-open'
#
string ICON_RESIZE_VERTICAL 'icon-resize-vertical'
#
string ICON_RESIZE_HORIZONTAL 'icon-resize-horizontal'
#
string ICON_HDD 'icon-hdd'
#
string ICON_BULLHORN 'icon-bullhorn'
#
string ICON_BELL 'icon-bell'
#
string ICON_CERTFICATE 'icon-certificate'
#
string ICON_THUMBS_UP 'icon-thumbs-up'
#
string ICON_THUMBS_DOWN 'icon-thumbs-down'
#
string ICON_HAND_RIGHT 'icon-hand-right'
#
string ICON_HAND_LEFT 'icon-hand-left'
#
string ICON_HAND_UP 'icon-hand-up'
#
string ICON_HAND_DOWN 'icon-hand-down'
#
string ICON_CIRCLE_ARROW_RIGHT 'icon-circle-arrow-right'
#
string ICON_CIRCLE_ARROW_LEFT 'icon-circle-arrow-left'
#
string ICON_CIRCLE_ARROW_UP 'icon-circle-arrow-up'
#
string ICON_CIRCLE_ARROW_DOWN 'icon-circle-arrow-down'
#
string ICON_GLOBE 'icon-globe'
#
string ICON_WRENCH 'icon-wrench'
#
string ICON_TASKS 'icon-tasks'
#
string ICON_FILTER 'icon-filter'
#
string ICON_BRIEFCASE 'icon-briefcase'
#
string ICON_FULLSCREEN 'icon-fullscreen'
#
string CLOSE_TEXT '&times;'
#
Properties summary
public static string $errorSummaryCss 'alert alert-block alert-error'
#

the CSS class for displaying error summaries.

the CSS class for displaying error summaries.

Yiistrap API documentation generated by ApiGen 2.8.0