LimeSurvey API - Master branch

TbHtml extends CHtml
in package

Bootstrap HTML helper.

Table of Contents

Constants

AFFIX_POSITION_BOTTOM  = 'bottom'
AFFIX_POSITION_TOP  = 'top'
ALERT_COLOR_DANGER  = 'danger'
ALERT_COLOR_DEFAULT  = ''
ALERT_COLOR_INFO  = 'info'
ALERT_COLOR_SUCCESS  = 'success'
ALERT_COLOR_WARNING  = 'warning'
BADGE_COLOR_DEFAULT  = ''
BADGE_COLOR_IMPORTANT  = 'important'
BADGE_COLOR_INFO  = 'info'
BADGE_COLOR_INVERSE  = 'inverse'
BADGE_COLOR_SUCCESS  = 'success'
BADGE_COLOR_WARNING  = 'warning'
BUTTON_COLOR_DANGER  = 'danger'
BUTTON_COLOR_DEFAULT  = 'default'
BUTTON_COLOR_INFO  = 'info'
BUTTON_COLOR_INVERSE  = 'inverse'
BUTTON_COLOR_LINK  = 'link'
BUTTON_COLOR_PRIMARY  = 'primary'
BUTTON_COLOR_SUCCESS  = 'success'
BUTTON_COLOR_WARNING  = 'warning'
BUTTON_SIZE_DEFAULT  = 'default'
BUTTON_SIZE_LARGE  = 'lg'
BUTTON_SIZE_LG  = 'lg'
BUTTON_SIZE_MINI  = 'xs'
BUTTON_SIZE_SM  = 'sm'
BUTTON_SIZE_SMALL  = 'sm'
BUTTON_SIZE_XS  = 'xs'
BUTTON_TOGGLE_CHECKBOX  = 'checkbox'
BUTTON_TOGGLE_RADIO  = 'radio'
BUTTON_TYPE_AJAXBUTTON  = 'ajaxButton'
BUTTON_TYPE_AJAXLINK  = 'ajaxLink'
BUTTON_TYPE_HTML  = 'htmlButton'
BUTTON_TYPE_IMAGE  = 'imageButton'
BUTTON_TYPE_INPUTBUTTON  = 'inputButton'
BUTTON_TYPE_INPUTSUBMIT  = 'inputSubmit'
BUTTON_TYPE_LINK  = 'link'
BUTTON_TYPE_LINKBUTTON  = 'linkButton'
BUTTON_TYPE_RESET  = 'resetButton'
BUTTON_TYPE_SUBMIT  = 'submitButton'
CLOSE_DISMISS_ALERT  = 'alert'
CLOSE_DISMISS_MODAL  = 'modal'
CLOSE_TEXT  = ''
COLUMN_SIZE_EXTRA_SMALL  = 'xs'
COLUMN_SIZE_LARGE  = 'lg'
COLUMN_SIZE_LG  = 'lg'
COLUMN_SIZE_MD  = 'md'
COLUMN_SIZE_MEDIUM  = 'md'
COLUMN_SIZE_SM  = 'sm'
COLUMN_SIZE_SMALL  = 'sm'
COLUMN_SIZE_XS  = 'xs'
DETAIL_TYPE_BORDERED  = 'bordered'
DETAIL_TYPE_CONDENSED  = 'condensed'
DETAIL_TYPE_HOVER  = 'hover'
DETAIL_TYPE_STRIPED  = 'striped'
FORM_LAYOUT_HORIZONTAL  = 'horizontal'
FORM_LAYOUT_INLINE  = 'inline'
FORM_LAYOUT_SEARCH  = 'search'
FORM_LAYOUT_VERTICAL  = 'vertical'
GRID_TYPE_BORDERED  = 'bordered'
GRID_TYPE_CONDENSED  = 'condensed'
GRID_TYPE_HOVER  = 'hover'
GRID_TYPE_STRIPED  = 'striped'
HELP_TYPE_BLOCK  = 'block'
HELP_TYPE_INLINE  = 'inline'
ICON_ADJUST  = 'fa-adjust'
ICON_ALIGN_CENTER  = 'fa-align-center'
ICON_ALIGN_JUSTIFY  = 'fa-align-justify'
ICON_ALIGN_LEFT  = 'fa-align-left'
ICON_ALIGN_RIGHT  = 'fa-align-right'
ICON_ARROW_DOWN  = 'fa-arrow-down'
ICON_ARROW_LEFT  = 'fa-arrow-left'
ICON_ARROW_RIGHT  = 'fa-arrow-right'
ICON_ARROW_UP  = 'fa-arrow-up'
ICON_ASTERISK  = 'fa-asterisk'
ICON_BACKWARD  = 'fa-backward'
ICON_BAN_CIRCLE  = 'fa-ban-circle'
ICON_BARCODE  = 'fa-barcode'
ICON_BELL  = 'fa-bell'
ICON_BOLD  = 'fa-bold'
ICON_BOOK  = 'fa-book'
ICON_BOOKMARK  = 'fa-bookmark'
ICON_BRIEFCASE  = 'fa-briefcase'
ICON_BULLHORN  = 'fa-bullhorn'
ICON_CALENDAR  = 'fa-calendar'
ICON_CAMERA  = 'fa-camera'
ICON_CERTIFICATE  = 'fa-certificate'
ICON_CHECK  = 'fa-check'
ICON_CHEVRON_DOWN  = 'fa-chevron-down'
ICON_CHEVRON_LEFT  = 'fa-chevron-left'
ICON_CHEVRON_RIGHT  = 'fa-chevron-right'
ICON_CHEVRON_UP  = 'fa-chevron-up'
ICON_CIRCLE_ARROW_DOWN  = 'fa-circle-arrow-down'
ICON_CIRCLE_ARROW_LEFT  = 'fa-circle-arrow-left'
ICON_CIRCLE_ARROW_RIGHT  = 'fa-circle-arrow-right'
ICON_CIRCLE_ARROW_UP  = 'fa-circle-arrow-up'
ICON_CLOUD  = 'fa-cloud'
ICON_CLOUD_DOWNLOAD  = 'fa-cloud-download'
ICON_CLOUD_UPLOAD  = 'fa-cloud-upload'
ICON_COG  = 'fa-cog'
ICON_COLLAPSE_DOWN  = 'fa-collapse-down'
ICON_COLLAPSE_UP  = 'fa-collapse-up'
ICON_COLOR_DEFAULT  = ''
ICON_COLOR_WHITE  = 'fa-white'
ICON_COMMENT  = 'fa-comment'
ICON_COMPRESSED  = 'fa-compressed'
ICON_COPYRIGHT_MARK  = 'fa-copyright-mark'
ICON_CREDIT_CARD  = 'fa-credit-card'
ICON_CUTLERY  = 'fa-cutlery'
ICON_DASHBOARD  = 'fa-dashboard'
ICON_DOWNLOAD  = 'fa-download'
ICON_DOWNLOAD_ALT  = 'fa-download-alt'
ICON_EARPHONE  = 'fa-earphone'
ICON_EDIT  = 'fa-edit'
ICON_EJECT  = 'fa-eject'
ICON_ENVELOPE  = 'fa-envelope'
ICON_EURO  = 'fa-euro'
ICON_EXCLAMATION_SIGN  = 'fa-exclamation-sign'
ICON_EXPAND  = 'fa-expand'
ICON_EXPORT  = 'fa-export'
ICON_EYE_CLOSE  = 'fa-eye-close'
ICON_EYE_OPEN  = 'fa-eye'
ICON_FACETIME_VIDEO  = 'fa-facetime-video'
ICON_FAST_BACKWARD  = 'fa-fast-backward'
ICON_FAST_FORWARD  = 'fa-fast-forward'
ICON_FILE  = 'fa-file'
ICON_FILM  = 'fa-film'
ICON_FILTER  = 'fa-filter'
ICON_FIRE  = 'fa-fire'
ICON_FLAG  = 'fa-flag'
ICON_FLASH  = 'fa-flash'
ICON_FLOPPY_DISK  = 'fa-floppy-disk'
ICON_FLOPPY_OPEN  = 'fa-floppy-open'
ICON_FLOPPY_REMOVE  = 'fa-floppy-remove'
ICON_FLOPPY_SAVE  = 'fa-floppy-save'
ICON_FLOPPY_SAVED  = 'fa-floppy-saved'
ICON_FOLDER_CLOSE  = 'fa-folder-close'
ICON_FOLDER_OPEN  = 'fa-folder-open'
ICON_FONT  = 'fa-font'
ICON_FORWARD  = 'fa-forward'
ICON_FULLSCREEN  = 'fa-fullscreen'
ICON_GBP  = 'fa-gbp'
ICON_GIFT  = 'fa-gift'
ICON_GLASS  = 'fa-glass'
ICON_GLOBE  = 'fa-globe'
ICON_HAND_DOWN  = 'fa-hand-down'
ICON_HAND_LEFT  = 'fa-hand-left'
ICON_HAND_RIGHT  = 'fa-hand-right'
ICON_HAND_UP  = 'fa-hand-up'
ICON_HD_VIDEO  = 'fa-hd-video'
ICON_HDD  = 'fa-hdd'
ICON_HEADER  = 'fa-header'
ICON_HEADPHONES  = 'fa-headphones'
ICON_HEART  = 'fa-heart'
ICON_HEART_EMPTY  = 'fa-heart-empty'
ICON_HOME  = 'fa-home'
ICON_IMPORT  = 'fa-import'
ICON_INBOX  = 'fa-inbox'
ICON_INDENT_LEFT  = 'fa-indent-left'
ICON_INDENT_RIGHT  = 'fa-indent-right'
ICON_INFO_SIGN  = 'fa-info-sign'
ICON_ITALIC  = 'fa-italic'
ICON_LEAF  = 'fa-leaf'
ICON_LINK  = 'fa-link'
ICON_LIST  = 'fa-list'
ICON_LIST_ALT  = 'fa-list-alt'
ICON_LOCK  = 'fa-lock'
ICON_LOG_IN  = 'fa-log-in'
ICON_LOG_OUT  = 'fa-log-out'
ICON_MAGNET  = 'fa-magnet'
ICON_MAP_MARKER  = 'fa-map-marker'
ICON_MINUS  = 'fa-minus'
ICON_MINUS_SIGN  = 'fa-minus-sign'
ICON_MOVE  = 'fa-bars bigIcons'
ICON_MUSIC  = 'fa-music'
ICON_NEW_WINDOW  = 'fa-new-window'
ICON_OFF  = 'fa-off'
ICON_OK  = 'fa-ok'
ICON_OK_CIRCLE  = 'fa-ok-circle'
ICON_OK_SIGN  = 'fa-ok-sign'
ICON_OPEN  = 'fa-open'
ICON_PAPERCLIP  = 'fa-paperclip'
ICON_PAUSE  = 'fa-pause'
ICON_PENCIL  = 'fa-pencil'
ICON_PHONE  = 'fa-phone'
ICON_PHONE_ALT  = 'fa-phone-alt'
ICON_PICTURE  = 'fa-picture'
ICON_PLANE  = 'fa-plane'
ICON_PLAY  = 'fa-play'
ICON_PLAY_CIRCLE  = 'fa-play-circle'
ICON_PLUS  = 'fa-plus'
ICON_PLUS_SIGN  = 'fa-plus-sign'
ICON_PRINT  = 'fa-print'
ICON_PUSHPIN  = 'fa-pushpin'
ICON_QRCODE  = 'fa-qrcode'
ICON_QUESTION_SIGN  = 'fa-question-sign'
ICON_RANDOM  = 'fa-random'
ICON_RECORD  = 'fa-record'
ICON_REFRESH  = 'fa-refresh'
ICON_REGISTRATION_MARK  = 'fa-registration-mark'
ICON_REMOVE  = 'fa-remove'
ICON_REMOVE_CIRCLE  = 'fa-remove-circle'
ICON_REMOVE_SIGN  = 'fa-remove-sign'
ICON_REPEAT  = 'fa-repeat'
ICON_RESIZE_FULL  = 'fa-resize-full'
ICON_RESIZE_HORIZONTAL  = 'fa-resize-horizontal'
ICON_RESIZE_SMALL  = 'fa-resize-small'
ICON_RESIZE_VERTICAL  = 'fa-resize-vertical'
ICON_RETWEET  = 'fa-retweet'
ICON_ROAD  = 'fa-road'
ICON_SAVE  = 'fa-save'
ICON_SAVED  = 'fa-saved'
ICON_SCREENSHOT  = 'fa-screenshot'
ICON_SD_VIDEO  = 'fa-sd-video'
ICON_SEARCH  = 'fa-search'
ICON_SEND  = 'fa-send'
ICON_SHARE  = 'fa-share'
ICON_SHARE_ALT  = 'fa-share-alt'
ICON_SHOPPING_CART  = 'fa-shopping-cart'
ICON_SIGNAL  = 'fa-signal'
ICON_SORT  = 'fa-sort'
ICON_SORT_BY_ALPHABET  = 'fa-sort-by-alphabet'
ICON_SORT_BY_ALPHABET_ALT  = 'fa-sort-by-alphabet-alt'
ICON_SORT_BY_ATTRIBUTES  = 'fa-sort-by-attributes'
ICON_SORT_BY_ATTRIBUTES_ALT  = 'fa-sort-by-attributes-alt'
ICON_SORT_BY_ORDER  = 'fa-sort-by-order'
ICON_SORT_BY_ORDER_ALT  = 'fa-sort-by-order-alt'
ICON_SOUND_5_1  = 'fa-sound-5-1'
ICON_SOUND_6_1  = 'fa-sound-6-1'
ICON_SOUND_7_1  = 'fa-sound-7-1'
ICON_SOUND_DOLBY  = 'fa-sound-dolby'
ICON_SOUND_STEREO  = 'fa-sound-stereo'
ICON_STAR  = 'fa-star'
ICON_STAR_EMPTY  = 'fa-star-empty'
ICON_STATS  = 'fa-bar-chart'
ICON_STEP_BACKWARD  = 'fa-step-backward'
ICON_STEP_FORWARD  = 'fa-step-forward'
ICON_STOP  = 'fa-stop'
ICON_SUBTITLES  = 'fa-subtitles'
ICON_TAG  = 'fa-tag'
ICON_TAGS  = 'fa-tags'
ICON_TASKS  = 'fa-tasks'
ICON_TEXT_HEIGHT  = 'fa-text-height'
ICON_TEXT_WIDTH  = 'fa-text-width'
ICON_TH  = 'fa-th'
ICON_TH_LARGE  = 'fa-th-large'
ICON_TH_LIST  = 'fa-th-list'
ICON_THUMBS_DOWN  = 'fa-thumbs-down'
ICON_THUMBS_UP  = 'fa-thumbs-up'
ICON_TIME  = 'fa-time'
ICON_TINT  = 'fa-tint'
ICON_TOWER  = 'fa-tower'
ICON_TRANSFER  = 'fa-transfer'
ICON_TRASH  = 'fa-trash'
ICON_TREE_CONIFER  = 'fa-tree-conifer'
ICON_TREE_DECIDUOUS  = 'fa-tree-deciduous'
ICON_UNCHECKED  = 'fa-unchecked'
ICON_UPLOAD  = 'fa-upload'
ICON_USD  = 'fa-usd'
ICON_USER  = 'fa-user'
ICON_VOLUME_DOWN  = 'fa-volume-down'
ICON_VOLUME_OFF  = 'fa-volume-off'
ICON_VOLUME_UP  = 'fa-volume-up'
ICON_WARNING_SIGN  = 'fa-warning-sign'
ICON_WRENCH  = 'fa-wrench'
ICON_ZOOM_IN  = 'fa-zoom-in'
ICON_ZOOM_OUT  = 'fa-zoom-out'
IMAGE_TYPE_CIRCLE  = 'circle'
IMAGE_TYPE_POLAROID  = 'thumbnail'
IMAGE_TYPE_ROUNDED  = 'rounded'
IMAGE_TYPE_THUMBNAIL  = 'thumbnail'
INPUT_COLOR_DEFAULT  = ''
INPUT_COLOR_ERROR  = 'has-error'
INPUT_COLOR_SUCCESS  = 'has-success'
INPUT_COLOR_WARNING  = 'has-warning'
INPUT_HEIGHT_DEFAULT  = ''
INPUT_HEIGHT_LARGE  = 'lg'
INPUT_HEIGHT_SMALL  = 'sm'
INPUT_SIZE_DEFAULT  = ''
INPUT_SIZE_LARGE  = 'large'
INPUT_SIZE_MEDIUM  = 'medium'
INPUT_SIZE_MINI  = 'mini'
INPUT_SIZE_SMALL  = 'small'
INPUT_SIZE_XLARGE  = 'xlarge'
INPUT_SIZE_XXLARGE  = 'xxlarge'
INPUT_TYPE_CHECKBOX  = 'checkBox'
INPUT_TYPE_CHECKBOXLIST  = 'checkBoxList'
INPUT_TYPE_CUSTOM  = 'widget'
INPUT_TYPE_DATE  = 'dateField'
INPUT_TYPE_DROPDOWNLIST  = 'dropDownList'
INPUT_TYPE_EMAIL  = 'emailField'
INPUT_TYPE_FILE  = 'fileField'
INPUT_TYPE_HIDDEN  = 'hidden'
INPUT_TYPE_INLINECHECKBOXLIST  = 'inlineCheckBoxList'
INPUT_TYPE_INLINERADIOBUTTONLIST  = 'inlineRadioButtonList'
INPUT_TYPE_LISTBOX  = 'listBox'
INPUT_TYPE_NUMBER  = 'numberField'
INPUT_TYPE_PASSWORD  = 'passwordField'
INPUT_TYPE_RADIOBUTTON  = 'radioButton'
INPUT_TYPE_RADIOBUTTONLIST  = 'radioButtonList'
INPUT_TYPE_RANGE  = 'rangeField'
INPUT_TYPE_SEARCH  = 'searchQuery'
INPUT_TYPE_TEXT  = 'textField'
INPUT_TYPE_TEXTAREA  = 'textArea'
INPUT_TYPE_UNEDITABLE  = 'uneditableField'
INPUT_TYPE_URL  = 'urlField'
LABEL_COLOR_DANGER  = 'danger'
LABEL_COLOR_DEFAULT  = 'default'
LABEL_COLOR_INFO  = 'info'
LABEL_COLOR_PRIMARY  = 'primary'
LABEL_COLOR_SUCCESS  = 'success'
LABEL_COLOR_WARNING  = 'warning'
MODAL_SIZE_DEFAULT  = ''
MODAL_SIZE_LARGE  = ' modal-lg'
MODAL_SIZE_SMALL  = ' modal-sm'
NAV_TYPE_LIST  = 'list'
NAV_TYPE_NONE  = ''
NAV_TYPE_PILLS  = 'pills'
NAV_TYPE_TABS  = 'tabs'
NAVBAR_COLOR_INVERSE  = 'inverse'
NAVBAR_DISPLAY_FIXEDBOTTOM  = 'fixed-bottom'
NAVBAR_DISPLAY_FIXEDTOP  = 'fixed-top'
NAVBAR_DISPLAY_NONE  = ''
NAVBAR_DISPLAY_STATICTOP  = 'static-top'
PAGINATION_ALIGN_CENTER  = 'centered'
PAGINATION_ALIGN_LEFT  = 'left'
PAGINATION_ALIGN_RIGHT  = 'right'
PAGINATION_SIZE_DEFAULT  = ''
PAGINATION_SIZE_LARGE  = 'lg'
PAGINATION_SIZE_LG  = 'lg'
PAGINATION_SIZE_MINI  = 'mini'
PAGINATION_SIZE_SM  = 'sm'
PAGINATION_SIZE_SMALL  = 'sm'
POPOVER_PLACEMENT_BOTTOM  = 'bottom'
POPOVER_PLACEMENT_LEFT  = 'left'
POPOVER_PLACEMENT_RIGHT  = 'right'
POPOVER_PLACEMENT_TOP  = 'top'
POPOVER_TRIGGER_CLICK  = 'click'
POPOVER_TRIGGER_FOCUS  = 'focus'
POPOVER_TRIGGER_HOVER  = 'hover'
POPOVER_TRIGGER_MANUAL  = 'manual'
PROGRESS_COLOR_DANGER  = 'danger'
PROGRESS_COLOR_DEFAULT  = ''
PROGRESS_COLOR_INFO  = 'info'
PROGRESS_COLOR_SUCCESS  = 'success'
PROGRESS_COLOR_WARNING  = 'warning'
PULL_LEFT  = 'left'
PULL_RIGHT  = 'right'
TABS_PLACEMENT_ABOVE  = ''
TABS_PLACEMENT_BELOW  = 'below'
TABS_PLACEMENT_LEFT  = 'left'
TABS_PLACEMENT_RIGHT  = 'right'
TEXT_ALIGN_CENTER  = 'center'
TEXT_ALIGN_JUSTIFY  = 'justify'
TEXT_ALIGN_LEFT  = 'left'
TEXT_ALIGN_NOWRAP  = 'nowrap'
TEXT_ALIGN_RIGHT  = 'right'
TEXT_COLOR_DEFAULT  = ''
TEXT_COLOR_ERROR  = 'error'
TEXT_COLOR_INFO  = 'info'
TEXT_COLOR_SUCCESS  = 'success'
TEXT_COLOR_WARNING  = 'warning'
TOOLTIP_PLACEMENT_BOTTOM  = 'bottom'
TOOLTIP_PLACEMENT_LEFT  = 'left'
TOOLTIP_PLACEMENT_RIGHT  = 'right'
TOOLTIP_PLACEMENT_TOP  = 'top'
TOOLTIP_TRIGGER_CLICK  = 'click'
TOOLTIP_TRIGGER_FOCUS  = 'focus'
TOOLTIP_TRIGGER_HOVER  = 'hover'
TOOLTIP_TRIGGER_MANUAL  = 'manual'
WELL_SIZE_DEFAULT  = ''
WELL_SIZE_LARGE  = 'large'
WELL_SIZE_SMALL  = 'small'

Properties

$errorCss  : string
$errorSummaryCss  : string
$iconVendor  : string
$defaultFormControlWidthClass  : string
$defaultFormLabelWidthClass  : string

Methods

abbr()  : string
Generates an abbreviation with a help text.
activeCheckBox()  : string
Generates a check box for a model attribute.
activeCheckBoxControlGroup()  : string
Generates a control group with a check box for a model attribute.
activeCheckBoxList()  : string
Generates a check box list for a model attribute.
activeCheckBoxListControlGroup()  : string
Generates a control group with a check box list for a model attribute.
activeControlGroup()  : string
Generates an active form row.
activeDateField()  : string
Generates a date field input for a model attribute.
activeDateFieldControlGroup()  : string
Generates a control group with a date field for a model attribute.
activeDropDownList()  : string
Generates a drop down list for a model attribute.
activeDropDownListControlGroup()  : string
Generates a control group with a drop down list for a model attribute.
activeEmailField()  : string
Generates an email field input for a model attribute.
activeEmailFieldControlGroup()  : string
Generates a control group with a email field for a model attribute.
activeFileField()  : string
Generates a file field input for a model attribute.
activeFileFieldControlGroup()  : string
Generates a control group with a file field for a model attribute.
activeInlineCheckBoxList()  : string
Generates an inline check box list for a model attribute.
activeInlineCheckBoxListControlGroup()  : string
Generates a control group with an inline check box list for a model attribute.
activeInlineRadioButtonList()  : string
Generates an inline radio button list for a model attribute.
activeInlineRadioButtonListControlGroup()  : string
Generates a control group with an inline radio button list for a model attribute.
activeListBox()  : string
Generates a list box for a model attribute.
activeListBoxControlGroup()  : string
Generates a control group with a list box for a model attribute.
activeNumberField()  : string
Generates a number field input for a model attribute.
activeNumberFieldControlGroup()  : string
Generates a control group with a number field for a model attribute.
activePasswordField()  : string
Generates a password field input for a model attribute.
activePasswordFieldControlGroup()  : string
Generates a control group with a password field for a model attribute.
activeRadioButton()  : string
Generates a radio button for a model attribute.
activeRadioButtonControlGroup()  : string
Generates a control group with a radio button for a model attribute.
activeRadioButtonList()  : string
Generates a radio button list for a model attribute.
activeRadioButtonListControlGroup()  : string
Generates a control group with a radio button list for a model attribute.
activeRangeField()  : string
Generates a range field input for a model attribute.
activeRangeFieldControlGroup()  : string
Generates a control group with a range field for a model attribute.
activeSearchQueryControlGroup()  : string
Generates a control group with a search field for a model attribute.
activeSearchQueryField()  : string
Generates a search query input for a model attribute.
activeTextArea()  : string
Generates a text area input for a model attribute.
activeTextAreaControlGroup()  : string
Generates a control group with a text area for a model attribute.
activeTextField()  : string
Generates a text field input for a model attribute.
activeTextFieldControlGroup()  : string
Generates a control group with a text field for a model attribute.
activeUneditableField()  : string
Generates an uneditable input for a model attribute.
activeUneditableFieldControlGroup()  : string
Generates a control group with a uneditable field for a model attribute.
activeUrlField()  : string
Generates an url field input for a model attribute.
activeUrlFieldControlGroup()  : string
Generates a control group with a url field for a model attribute.
addCssClass()  : array<string|int, mixed>
Appends new class names to the given options.
addCssStyle()  : array<string|int, mixed>
Appends a CSS style string to the given options.
address()  : string
Generates an address block.
ajaxButton()  : string
Generates a push button that can initiate AJAX requests.
ajaxLink()  : string
Generates a link that can initiate AJAX requests.
ajaxSubmitButton()  : string
Generates a push button that can submit the current form in POST method.
alert()  : string
Generates an alert.
animatedProgressBar()  : string
Generates an animated progress bar.
b()  : string
Generates bold text.
badge()  : string
Generates a badge span.
beginFormTb()  : string
Generates an open form tag.
blockAlert()  : string
Generates an alert block.
breadcrumbs()  : string
Generates a breadcrumb menu.
btn()  : string
Generates a button.
button()  : string
Generates an button.
buttonDropdown()  : string
Generates a button with a dropdown menu.
buttonGroup()  : string
Generates a button group.
buttonToolbar()  : string
Generates a button toolbar.
carousel()  : string
Generates an image carousel.
carouselIndicators()  : string
Generates an indicator for the carousel.
carouselItem()  : string
Generates a carousel item.
carouselNextLink()  : string
Generates a next link for the carousel.
carouselPrevLink()  : string
Generates a previous link for the carousel.
checkBox()  : string
Generates a check box.
checkBoxControlGroup()  : string
Generates a control group with a check box.
checkBoxList()  : string
Generates a check box list.
checkBoxListControlGroup()  : string
Generates a control group with a check box list.
closeButton()  : string
Generates a close button.
closeLink()  : string
Generates a close link.
code()  : string
Generates inline code.
codeBlock()  : string
Generates a code block.
collapseLink()  : string
Generates a collapse link.
controlGroup()  : string
Generates a form group.
controls()  : string
Generates form controls.
controlsRow()  : string
Generates form controls row.
createActiveInput()  : string
Creates an active form input of the given type.
createInput()  : string
Creates a form input of the given type.
customActiveControlGroup()  : string
Generates a custom (pre-rendered) active form control group.
customControlGroup()  : string
Generates a custom (pre-rendered) form control group.
dateField()  : string
Generates a date field input.
dateFieldControlGroup()  : string
Generates a control group with a file field.
dropDownList()  : string
Generates a drop down list.
dropDownListControlGroup()  : string
Generates a control group with a drop down list.
dropdownToggleButton()  : string
Generates a dropdown toggle button.
dropdownToggleLink()  : string
Generates a dropdown toggle link.
dropdownToggleMenuLink()  : string
Generates a dropdown toggle menu item.
em()  : string
Generates an emphasized text.
emailField()  : string
Generates an email field input.
emailFieldControlGroup()  : string
Generates a control group with an email field.
error()  : string
Displays the first validation error for a model attribute.
errorSummary()  : string
Displays a summary of validation errors for one or several models.
fileField()  : string
Generates a file field input.
fileFieldControlGroup()  : string
Generates a control group with a file field.
formActions()  : string
Generates form actions div. This is no longer necessary in Bootstrap 3, but it is still useful to use for horizontal forms. When used with a horizontal form, it will appropriately align the actions below other form controls.
formTb()  : string
Generates a form tag.
help()  : string
Generates a help text.
helpBlock()  : string
Generates a help block.
heroUnit()  : string
Generates a jumbotron unit.
htmlButton()  : string
Generates an image submit button.
i()  : string
Generates italic text.
icon()  : string
Generates an icon.
image()  : string
Generates an image tag.
imageButton()  : string
Generates an image submit button.
imageCircle()  : string
Generates an image tag with circle.
imagePolaroid()  : string
Generates an image tag within polaroid frame.
imageRounded()  : string
Generates an image tag with rounded corners.
imageThumbnail()  : string
Generates an image tag within thumbnail frame.
inlineCheckBoxList()  : string
Generates an inline check box list.
inlineCheckBoxListControlGroup()  : string
Generates a control group with an inline check box list.
inlineRadioButtonList()  : string
Generates an inline radio button list.
inlineRadioButtonListControlGroup()  : string
Generates a control group with an inline radio button list.
inputButton()  : string
Generates a form input push button.
inputSubmit()  : string
Generates a form input submit push button.
labelTb()  : string
Generates a label span.
lead()  : string
Generates a paragraph that stands out.
link()  : string
Generates a hyperlink tag.
linkButton()  : string
Generates a link submit button.
listBox()  : string
Generates a list box.
listBoxControlGroup()  : string
Generates a control group with a list box.
media()  : string
Generates a single media object.
mediaList()  : string
Generates a list of media objects.
medias()  : string
Generates multiple media objects.
menu()  : string
Generates a menu.
menuDivider()  : string
Generates a menu divider.
menuHeader()  : string
Generates a menu header.
menuLink()  : string
Generates a menu link.
modalBody()  : string
Generates a modal body.
modalFooter()  : string
Generates a modal footer.
modalHeader()  : string
Generates a modal header.
muted()  : string
Generates a muted text block.
mutedSpan()  : string
Generates a muted span.
nav()  : string
Generates a navigation menu.
navbar()  : string
Generates a navbar.
navbarBrandLink()  : string
Generates a brand link for the navbar.
navbarCollapseLink()  : string
Generates a collapse element.
navbarForm()  : string
Generates a navbar form.
navbarMenuDivider()  : string
Generates a menu divider for the navbar.
navbarSearchForm()  : string
Generates a navbar search form.
navbarText()  : string
Generates a text for the navbar.
navList()  : string
Generates a list navigation.
numberField()  : string
Generates a number field input.
numberFieldControlGroup()  : string
Generates a control group with a number field.
openTag()  : string
Generates an open HTML element.
pageHeader()  : string
Generates a pager header.
pager()  : string
Generates a pager.
pagerLink()  : string
Generates a pager link.
pagination()  : string
Generates a pagination.
paginationLink()  : string
Generates a pagination link.
passwordField()  : string
Generates a password field input.
passwordFieldControlGroup()  : string
Generates a control group with a password field.
pills()  : string
Generates a pills navigation.
popover()  : string
Generates a popover.
progressBar()  : string
Generates a progress bar.
quote()  : string
Generates a quote.
radioButton()  : string
Generates a radio button.
radioButtonControlGroup()  : string
Generates a control group with a radio button.
radioButtonList()  : string
Generates a radio button list.
radioButtonListControlGroup()  : string
Generates a control group with a radio button list.
rangeField()  : string
Generates a range field input.
rangeFieldControlGroup()  : string
Generates a control group with a range field.
resetButton()  : string
Generates a reset button.
searchForm()  : string
Generates a search form.
searchQueryControlGroup()  : string
Generates a control group with a search field.
searchQueryField()  : string
Generates a search input.
small()  : string
Generates small text.
smallAbbr()  : string
Generates a small abbreviation with a help text.
splitButtonDropdown()  : string
Generates a button with a split dropdown menu.
stackedPills()  : string
Generates a stacked pills navigation.
stackedProgressBar()  : string
Generates a stacked progress bar.
stackedTabs()  : string
Generates a stacked tab navigation.
statefulFormTb()  : string
Generates a stateful form tag.
stripedProgressBar()  : string
Generates a striped progress bar.
submitButton()  : string
Generates a submit button.
tabbable()  : string
Generates a tabbable menu.
tabbableTabs()  : string
Generates a tabbable tabs menu.
tabs()  : string
Generates a tab navigation.
tag()  : string
Generates an HTML element.
textArea()  : string
Generates a text area input.
textAreaControlGroup()  : string
Generates a control group with a text area.
textField()  : string
Generates a text field input.
textFieldControlGroup()  : string
Generates a control group with a text field.
thumbnail()  : string
Generates a thumbnail.
thumbnailLink()  : string
Generates a link thumbnail.
thumbnails()  : string
Generates a list of thumbnails.
tooltip()  : string
Generates a tooltip.
uneditableField()  : string
Generates an uneditable input.
uneditableFieldControlGroup()  : string
Generates a control group with an uneditable field.
urlField()  : string
Generates an url field input.
urlFieldControlGroup()  : string
Generates a control group with an url field.
verticalButtonGroup()  : string
Generates a vertical button group.
well()  : string
Generates a well element.
activeTextInputField()  : string
Generates an input HTML tag for a model attribute.
addColClass()  : mixed
Adds the appropriate column class to the given options applicable. The available columns are 'xs', 'sm', 'md', 'lg' for extra small, small, medium, and large to be used for the appropriate screen sizes. It is also possible to prevent your columns from stacking on smaller devices by combining a small column with a larger column: <code> $htmlOptions = array( 'xs' => 12, 'md' => 8, ) </code> Both classes will be applied.
addPullClass()  : mixed
Adds the pull class to the given options is applicable.
addSpanClass()  : mixed
Adds the grid span class to the given options is applicable. BS3 no longer use span classes. During the BS3 transition, this will use the col-md-* CSS class.
addTextAlignClass()  : mixed
Adds the text align class to the given options if applicable.
bar()  : string
Generates a progress bar.
btnDropdown()  : string
Generates a button dropdown.
close()  : string
Generates a close element.
createButton()  : string
Creates a button the of given type.
createCheckBoxAndRadioButtonLabel()  : string
Generates a label for a checkbox or radio input by wrapping the input.
dropdown()  : string
Generates a dropdown menu.
dropdownToggle()  : string
Generates a dropdown toggle element.
getAddOnClasses()  : string
Returns the add-on classes based on the given options.
getColClasses()  : string
Returns the col-* classes
inputAddOn()  : string
Generates an add-on for an input field.
inputHelp()  : string
Generates a help text for an input field.
menuDropdown()  : string
Generates a menu dropdown.
normalizeCheckBoxAndRadio()  : array<string|int, mixed>
Normalizes the inputs in the given string by splitting them up into an array.
normalizeInputOptions()  : array<string|int, mixed>
Normalizes input options.
normalizeTabs()  : array<string|int, mixed>
Normalizes the tab configuration.
popColClasses()  : string
Returns the col-* classes and removes the classes from $htmlOptions['class']
switchColToOffset()  : string
Nearly identical to {@link switchOffsetCol()} except it forces the class to be returned as its offset counterpart. It is also safe to pass in a class that is already an offset and it will just re-return it. For example, passing in col-md-2 will return col-md-offset-2. Passing in col-md-offset-4 will still return col-md-offset-4.
switchOffsetCol()  : string
Switches the column class to and from the col width itself to its offset counterpart. For example, passing in col-md-2 would be switched to col-md-offset-2
switchOffsetToCol()  : string
Nearly identical to {@link switchOffsetCol()} except it forces teh class to be returned as its column (e.g. "span") width counterpart. It is also safe to pass in a class that is already the column width and it will re-return it. For example, passing in col-md-offset-2 will return col-md-2. Passing in col-md-4 will still return col-md-4.
textInputField()  : string
Generates an input HTML tag.
tooltipPopover()  : string
Generates a base tooltip.

Constants

AFFIX_POSITION_BOTTOM

public mixed AFFIX_POSITION_BOTTOM = 'bottom'

AFFIX_POSITION_TOP

public mixed AFFIX_POSITION_TOP = 'top'

ALERT_COLOR_DANGER

public mixed ALERT_COLOR_DANGER = 'danger'

ALERT_COLOR_DEFAULT

public mixed ALERT_COLOR_DEFAULT = ''

ALERT_COLOR_INFO

public mixed ALERT_COLOR_INFO = 'info'

ALERT_COLOR_SUCCESS

public mixed ALERT_COLOR_SUCCESS = 'success'

ALERT_COLOR_WARNING

public mixed ALERT_COLOR_WARNING = 'warning'

BADGE_COLOR_DEFAULT

public mixed BADGE_COLOR_DEFAULT = ''

BADGE_COLOR_IMPORTANT

public mixed BADGE_COLOR_IMPORTANT = 'important'

BADGE_COLOR_INFO

public mixed BADGE_COLOR_INFO = 'info'

BADGE_COLOR_INVERSE

public mixed BADGE_COLOR_INVERSE = 'inverse'

BADGE_COLOR_SUCCESS

public mixed BADGE_COLOR_SUCCESS = 'success'

BADGE_COLOR_WARNING

public mixed BADGE_COLOR_WARNING = 'warning'

BUTTON_COLOR_DANGER

public mixed BUTTON_COLOR_DANGER = 'danger'

BUTTON_COLOR_DEFAULT

public mixed BUTTON_COLOR_DEFAULT = 'default'

BUTTON_COLOR_INFO

public mixed BUTTON_COLOR_INFO = 'info'

BUTTON_COLOR_INVERSE

public mixed BUTTON_COLOR_INVERSE = 'inverse'
public mixed BUTTON_COLOR_LINK = 'link'

BUTTON_COLOR_PRIMARY

public mixed BUTTON_COLOR_PRIMARY = 'primary'

BUTTON_COLOR_SUCCESS

public mixed BUTTON_COLOR_SUCCESS = 'success'

BUTTON_COLOR_WARNING

public mixed BUTTON_COLOR_WARNING = 'warning'

BUTTON_SIZE_DEFAULT

public mixed BUTTON_SIZE_DEFAULT = 'default'

BUTTON_SIZE_LARGE

public mixed BUTTON_SIZE_LARGE = 'lg'

BUTTON_SIZE_LG

public mixed BUTTON_SIZE_LG = 'lg'

BUTTON_SIZE_MINI

public mixed BUTTON_SIZE_MINI = 'xs'

BUTTON_SIZE_SM

public mixed BUTTON_SIZE_SM = 'sm'

BUTTON_SIZE_SMALL

public mixed BUTTON_SIZE_SMALL = 'sm'

BUTTON_SIZE_XS

public mixed BUTTON_SIZE_XS = 'xs'

BUTTON_TOGGLE_CHECKBOX

public mixed BUTTON_TOGGLE_CHECKBOX = 'checkbox'

BUTTON_TOGGLE_RADIO

public mixed BUTTON_TOGGLE_RADIO = 'radio'

BUTTON_TYPE_AJAXBUTTON

public mixed BUTTON_TYPE_AJAXBUTTON = 'ajaxButton'
public mixed BUTTON_TYPE_AJAXLINK = 'ajaxLink'

BUTTON_TYPE_HTML

public mixed BUTTON_TYPE_HTML = 'htmlButton'

BUTTON_TYPE_IMAGE

public mixed BUTTON_TYPE_IMAGE = 'imageButton'

BUTTON_TYPE_INPUTBUTTON

public mixed BUTTON_TYPE_INPUTBUTTON = 'inputButton'

BUTTON_TYPE_INPUTSUBMIT

public mixed BUTTON_TYPE_INPUTSUBMIT = 'inputSubmit'
public mixed BUTTON_TYPE_LINK = 'link'

BUTTON_TYPE_LINKBUTTON

public mixed BUTTON_TYPE_LINKBUTTON = 'linkButton'

BUTTON_TYPE_RESET

public mixed BUTTON_TYPE_RESET = 'resetButton'

BUTTON_TYPE_SUBMIT

public mixed BUTTON_TYPE_SUBMIT = 'submitButton'

CLOSE_DISMISS_ALERT

public mixed CLOSE_DISMISS_ALERT = 'alert'

CLOSE_DISMISS_MODAL

public mixed CLOSE_DISMISS_MODAL = 'modal'

CLOSE_TEXT

public mixed CLOSE_TEXT = ''

COLUMN_SIZE_EXTRA_SMALL

public mixed COLUMN_SIZE_EXTRA_SMALL = 'xs'

COLUMN_SIZE_LARGE

public mixed COLUMN_SIZE_LARGE = 'lg'

COLUMN_SIZE_LG

public mixed COLUMN_SIZE_LG = 'lg'

COLUMN_SIZE_MD

public mixed COLUMN_SIZE_MD = 'md'

COLUMN_SIZE_MEDIUM

public mixed COLUMN_SIZE_MEDIUM = 'md'

COLUMN_SIZE_SM

public mixed COLUMN_SIZE_SM = 'sm'

COLUMN_SIZE_SMALL

public mixed COLUMN_SIZE_SMALL = 'sm'

COLUMN_SIZE_XS

public mixed COLUMN_SIZE_XS = 'xs'

DETAIL_TYPE_BORDERED

public mixed DETAIL_TYPE_BORDERED = 'bordered'

DETAIL_TYPE_CONDENSED

public mixed DETAIL_TYPE_CONDENSED = 'condensed'

DETAIL_TYPE_HOVER

public mixed DETAIL_TYPE_HOVER = 'hover'

DETAIL_TYPE_STRIPED

public mixed DETAIL_TYPE_STRIPED = 'striped'

FORM_LAYOUT_HORIZONTAL

public mixed FORM_LAYOUT_HORIZONTAL = 'horizontal'

FORM_LAYOUT_INLINE

public mixed FORM_LAYOUT_INLINE = 'inline'
public mixed FORM_LAYOUT_SEARCH = 'search'

FORM_LAYOUT_VERTICAL

public mixed FORM_LAYOUT_VERTICAL = 'vertical'

GRID_TYPE_BORDERED

public mixed GRID_TYPE_BORDERED = 'bordered'

GRID_TYPE_CONDENSED

public mixed GRID_TYPE_CONDENSED = 'condensed'

GRID_TYPE_HOVER

public mixed GRID_TYPE_HOVER = 'hover'

GRID_TYPE_STRIPED

public mixed GRID_TYPE_STRIPED = 'striped'

HELP_TYPE_BLOCK

public mixed HELP_TYPE_BLOCK = 'block'

HELP_TYPE_INLINE

public mixed HELP_TYPE_INLINE = 'inline'

ICON_ADJUST

public mixed ICON_ADJUST = 'fa-adjust'

ICON_ALIGN_CENTER

public mixed ICON_ALIGN_CENTER = 'fa-align-center'

ICON_ALIGN_JUSTIFY

public mixed ICON_ALIGN_JUSTIFY = 'fa-align-justify'

ICON_ALIGN_LEFT

public mixed ICON_ALIGN_LEFT = 'fa-align-left'

ICON_ALIGN_RIGHT

public mixed ICON_ALIGN_RIGHT = 'fa-align-right'

ICON_ARROW_DOWN

public mixed ICON_ARROW_DOWN = 'fa-arrow-down'

ICON_ARROW_LEFT

public mixed ICON_ARROW_LEFT = 'fa-arrow-left'

ICON_ARROW_RIGHT

public mixed ICON_ARROW_RIGHT = 'fa-arrow-right'

ICON_ARROW_UP

public mixed ICON_ARROW_UP = 'fa-arrow-up'

ICON_ASTERISK

public mixed ICON_ASTERISK = 'fa-asterisk'

ICON_BACKWARD

public mixed ICON_BACKWARD = 'fa-backward'

ICON_BAN_CIRCLE

public mixed ICON_BAN_CIRCLE = 'fa-ban-circle'

ICON_BARCODE

public mixed ICON_BARCODE = 'fa-barcode'

ICON_BELL

public mixed ICON_BELL = 'fa-bell'

ICON_BOLD

public mixed ICON_BOLD = 'fa-bold'

ICON_BOOK

public mixed ICON_BOOK = 'fa-book'

ICON_BOOKMARK

public mixed ICON_BOOKMARK = 'fa-bookmark'

ICON_BRIEFCASE

public mixed ICON_BRIEFCASE = 'fa-briefcase'

ICON_BULLHORN

public mixed ICON_BULLHORN = 'fa-bullhorn'

ICON_CALENDAR

public mixed ICON_CALENDAR = 'fa-calendar'

ICON_CAMERA

public mixed ICON_CAMERA = 'fa-camera'

ICON_CERTIFICATE

public mixed ICON_CERTIFICATE = 'fa-certificate'

ICON_CHECK

public mixed ICON_CHECK = 'fa-check'

ICON_CHEVRON_DOWN

public mixed ICON_CHEVRON_DOWN = 'fa-chevron-down'

ICON_CHEVRON_LEFT

public mixed ICON_CHEVRON_LEFT = 'fa-chevron-left'

ICON_CHEVRON_RIGHT

public mixed ICON_CHEVRON_RIGHT = 'fa-chevron-right'

ICON_CHEVRON_UP

public mixed ICON_CHEVRON_UP = 'fa-chevron-up'

ICON_CIRCLE_ARROW_DOWN

public mixed ICON_CIRCLE_ARROW_DOWN = 'fa-circle-arrow-down'

ICON_CIRCLE_ARROW_LEFT

public mixed ICON_CIRCLE_ARROW_LEFT = 'fa-circle-arrow-left'

ICON_CIRCLE_ARROW_RIGHT

public mixed ICON_CIRCLE_ARROW_RIGHT = 'fa-circle-arrow-right'

ICON_CIRCLE_ARROW_UP

public mixed ICON_CIRCLE_ARROW_UP = 'fa-circle-arrow-up'

ICON_CLOUD

public mixed ICON_CLOUD = 'fa-cloud'

ICON_CLOUD_DOWNLOAD

public mixed ICON_CLOUD_DOWNLOAD = 'fa-cloud-download'

ICON_CLOUD_UPLOAD

public mixed ICON_CLOUD_UPLOAD = 'fa-cloud-upload'

ICON_COG

public mixed ICON_COG = 'fa-cog'

ICON_COLLAPSE_DOWN

public mixed ICON_COLLAPSE_DOWN = 'fa-collapse-down'

ICON_COLLAPSE_UP

public mixed ICON_COLLAPSE_UP = 'fa-collapse-up'

ICON_COLOR_DEFAULT

public mixed ICON_COLOR_DEFAULT = ''

ICON_COLOR_WHITE

public mixed ICON_COLOR_WHITE = 'fa-white'

ICON_COMMENT

public mixed ICON_COMMENT = 'fa-comment'

ICON_COMPRESSED

public mixed ICON_COMPRESSED = 'fa-compressed'
public mixed ICON_COPYRIGHT_MARK = 'fa-copyright-mark'

ICON_CREDIT_CARD

public mixed ICON_CREDIT_CARD = 'fa-credit-card'

ICON_CUTLERY

public mixed ICON_CUTLERY = 'fa-cutlery'

ICON_DASHBOARD

public mixed ICON_DASHBOARD = 'fa-dashboard'

ICON_DOWNLOAD

public mixed ICON_DOWNLOAD = 'fa-download'

ICON_DOWNLOAD_ALT

public mixed ICON_DOWNLOAD_ALT = 'fa-download-alt'

ICON_EARPHONE

public mixed ICON_EARPHONE = 'fa-earphone'

ICON_EDIT

public mixed ICON_EDIT = 'fa-edit'

ICON_EJECT

public mixed ICON_EJECT = 'fa-eject'

ICON_ENVELOPE

public mixed ICON_ENVELOPE = 'fa-envelope'

ICON_EURO

public mixed ICON_EURO = 'fa-euro'

ICON_EXCLAMATION_SIGN

public mixed ICON_EXCLAMATION_SIGN = 'fa-exclamation-sign'

ICON_EXPAND

public mixed ICON_EXPAND = 'fa-expand'

ICON_EXPORT

public mixed ICON_EXPORT = 'fa-export'

ICON_EYE_CLOSE

public mixed ICON_EYE_CLOSE = 'fa-eye-close'

ICON_EYE_OPEN

public mixed ICON_EYE_OPEN = 'fa-eye'

ICON_FACETIME_VIDEO

public mixed ICON_FACETIME_VIDEO = 'fa-facetime-video'

ICON_FAST_BACKWARD

public mixed ICON_FAST_BACKWARD = 'fa-fast-backward'

ICON_FAST_FORWARD

public mixed ICON_FAST_FORWARD = 'fa-fast-forward'

ICON_FILE

public mixed ICON_FILE = 'fa-file'

ICON_FILM

public mixed ICON_FILM = 'fa-film'

ICON_FILTER

public mixed ICON_FILTER = 'fa-filter'

ICON_FIRE

public mixed ICON_FIRE = 'fa-fire'

ICON_FLAG

public mixed ICON_FLAG = 'fa-flag'

ICON_FLASH

public mixed ICON_FLASH = 'fa-flash'

ICON_FLOPPY_DISK

public mixed ICON_FLOPPY_DISK = 'fa-floppy-disk'

ICON_FLOPPY_OPEN

public mixed ICON_FLOPPY_OPEN = 'fa-floppy-open'

ICON_FLOPPY_REMOVE

public mixed ICON_FLOPPY_REMOVE = 'fa-floppy-remove'

ICON_FLOPPY_SAVE

public mixed ICON_FLOPPY_SAVE = 'fa-floppy-save'

ICON_FLOPPY_SAVED

public mixed ICON_FLOPPY_SAVED = 'fa-floppy-saved'

ICON_FOLDER_CLOSE

public mixed ICON_FOLDER_CLOSE = 'fa-folder-close'

ICON_FOLDER_OPEN

public mixed ICON_FOLDER_OPEN = 'fa-folder-open'

ICON_FONT

public mixed ICON_FONT = 'fa-font'

ICON_FORWARD

public mixed ICON_FORWARD = 'fa-forward'

ICON_FULLSCREEN

public mixed ICON_FULLSCREEN = 'fa-fullscreen'

ICON_GBP

public mixed ICON_GBP = 'fa-gbp'

ICON_GIFT

public mixed ICON_GIFT = 'fa-gift'

ICON_GLASS

public mixed ICON_GLASS = 'fa-glass'

ICON_GLOBE

public mixed ICON_GLOBE = 'fa-globe'

ICON_HAND_DOWN

public mixed ICON_HAND_DOWN = 'fa-hand-down'

ICON_HAND_LEFT

public mixed ICON_HAND_LEFT = 'fa-hand-left'

ICON_HAND_RIGHT

public mixed ICON_HAND_RIGHT = 'fa-hand-right'

ICON_HAND_UP

public mixed ICON_HAND_UP = 'fa-hand-up'

ICON_HD_VIDEO

public mixed ICON_HD_VIDEO = 'fa-hd-video'

ICON_HDD

public mixed ICON_HDD = 'fa-hdd'

ICON_HEADER

public mixed ICON_HEADER = 'fa-header'

ICON_HEADPHONES

public mixed ICON_HEADPHONES = 'fa-headphones'

ICON_HEART

public mixed ICON_HEART = 'fa-heart'

ICON_HEART_EMPTY

public mixed ICON_HEART_EMPTY = 'fa-heart-empty'

ICON_HOME

public mixed ICON_HOME = 'fa-home'

ICON_IMPORT

public mixed ICON_IMPORT = 'fa-import'

ICON_INBOX

public mixed ICON_INBOX = 'fa-inbox'

ICON_INDENT_LEFT

public mixed ICON_INDENT_LEFT = 'fa-indent-left'

ICON_INDENT_RIGHT

public mixed ICON_INDENT_RIGHT = 'fa-indent-right'

ICON_INFO_SIGN

public mixed ICON_INFO_SIGN = 'fa-info-sign'

ICON_ITALIC

public mixed ICON_ITALIC = 'fa-italic'

ICON_LEAF

public mixed ICON_LEAF = 'fa-leaf'
public mixed ICON_LINK = 'fa-link'

ICON_LIST

public mixed ICON_LIST = 'fa-list'

ICON_LIST_ALT

public mixed ICON_LIST_ALT = 'fa-list-alt'

ICON_LOCK

public mixed ICON_LOCK = 'fa-lock'

ICON_LOG_IN

public mixed ICON_LOG_IN = 'fa-log-in'

ICON_LOG_OUT

public mixed ICON_LOG_OUT = 'fa-log-out'

ICON_MAGNET

public mixed ICON_MAGNET = 'fa-magnet'

ICON_MAP_MARKER

public mixed ICON_MAP_MARKER = 'fa-map-marker'

ICON_MINUS

public mixed ICON_MINUS = 'fa-minus'

ICON_MINUS_SIGN

public mixed ICON_MINUS_SIGN = 'fa-minus-sign'

ICON_MOVE

public mixed ICON_MOVE = 'fa-bars bigIcons'

ICON_MUSIC

public mixed ICON_MUSIC = 'fa-music'

ICON_NEW_WINDOW

public mixed ICON_NEW_WINDOW = 'fa-new-window'

ICON_OFF

public mixed ICON_OFF = 'fa-off'

ICON_OK

public mixed ICON_OK = 'fa-ok'

ICON_OK_CIRCLE

public mixed ICON_OK_CIRCLE = 'fa-ok-circle'

ICON_OK_SIGN

public mixed ICON_OK_SIGN = 'fa-ok-sign'

ICON_OPEN

public mixed ICON_OPEN = 'fa-open'

ICON_PAPERCLIP

public mixed ICON_PAPERCLIP = 'fa-paperclip'

ICON_PAUSE

public mixed ICON_PAUSE = 'fa-pause'

ICON_PENCIL

public mixed ICON_PENCIL = 'fa-pencil'

ICON_PHONE

public mixed ICON_PHONE = 'fa-phone'

ICON_PHONE_ALT

public mixed ICON_PHONE_ALT = 'fa-phone-alt'

ICON_PICTURE

public mixed ICON_PICTURE = 'fa-picture'

ICON_PLANE

public mixed ICON_PLANE = 'fa-plane'

ICON_PLAY

public mixed ICON_PLAY = 'fa-play'

ICON_PLAY_CIRCLE

public mixed ICON_PLAY_CIRCLE = 'fa-play-circle'

ICON_PLUS

public mixed ICON_PLUS = 'fa-plus'

ICON_PLUS_SIGN

public mixed ICON_PLUS_SIGN = 'fa-plus-sign'

ICON_PRINT

public mixed ICON_PRINT = 'fa-print'

ICON_PUSHPIN

public mixed ICON_PUSHPIN = 'fa-pushpin'

ICON_QRCODE

public mixed ICON_QRCODE = 'fa-qrcode'

ICON_QUESTION_SIGN

public mixed ICON_QUESTION_SIGN = 'fa-question-sign'

ICON_RANDOM

public mixed ICON_RANDOM = 'fa-random'

ICON_RECORD

public mixed ICON_RECORD = 'fa-record'

ICON_REFRESH

public mixed ICON_REFRESH = 'fa-refresh'

ICON_REGISTRATION_MARK

public mixed ICON_REGISTRATION_MARK = 'fa-registration-mark'

ICON_REMOVE

public mixed ICON_REMOVE = 'fa-remove'

ICON_REMOVE_CIRCLE

public mixed ICON_REMOVE_CIRCLE = 'fa-remove-circle'

ICON_REMOVE_SIGN

public mixed ICON_REMOVE_SIGN = 'fa-remove-sign'

ICON_REPEAT

public mixed ICON_REPEAT = 'fa-repeat'

ICON_RESIZE_FULL

public mixed ICON_RESIZE_FULL = 'fa-resize-full'

ICON_RESIZE_HORIZONTAL

public mixed ICON_RESIZE_HORIZONTAL = 'fa-resize-horizontal'

ICON_RESIZE_SMALL

public mixed ICON_RESIZE_SMALL = 'fa-resize-small'

ICON_RESIZE_VERTICAL

public mixed ICON_RESIZE_VERTICAL = 'fa-resize-vertical'

ICON_RETWEET

public mixed ICON_RETWEET = 'fa-retweet'

ICON_ROAD

public mixed ICON_ROAD = 'fa-road'

ICON_SAVE

public mixed ICON_SAVE = 'fa-save'

ICON_SAVED

public mixed ICON_SAVED = 'fa-saved'

ICON_SCREENSHOT

public mixed ICON_SCREENSHOT = 'fa-screenshot'

ICON_SD_VIDEO

public mixed ICON_SD_VIDEO = 'fa-sd-video'
public mixed ICON_SEARCH = 'fa-search'

ICON_SEND

public mixed ICON_SEND = 'fa-send'

ICON_SHARE

public mixed ICON_SHARE = 'fa-share'

ICON_SHARE_ALT

public mixed ICON_SHARE_ALT = 'fa-share-alt'

ICON_SHOPPING_CART

public mixed ICON_SHOPPING_CART = 'fa-shopping-cart'

ICON_SIGNAL

public mixed ICON_SIGNAL = 'fa-signal'

ICON_SORT

public mixed ICON_SORT = 'fa-sort'

ICON_SORT_BY_ALPHABET

public mixed ICON_SORT_BY_ALPHABET = 'fa-sort-by-alphabet'

ICON_SORT_BY_ALPHABET_ALT

public mixed ICON_SORT_BY_ALPHABET_ALT = 'fa-sort-by-alphabet-alt'

ICON_SORT_BY_ATTRIBUTES

public mixed ICON_SORT_BY_ATTRIBUTES = 'fa-sort-by-attributes'

ICON_SORT_BY_ATTRIBUTES_ALT

public mixed ICON_SORT_BY_ATTRIBUTES_ALT = 'fa-sort-by-attributes-alt'

ICON_SORT_BY_ORDER

public mixed ICON_SORT_BY_ORDER = 'fa-sort-by-order'

ICON_SORT_BY_ORDER_ALT

public mixed ICON_SORT_BY_ORDER_ALT = 'fa-sort-by-order-alt'

ICON_SOUND_5_1

public mixed ICON_SOUND_5_1 = 'fa-sound-5-1'

ICON_SOUND_6_1

public mixed ICON_SOUND_6_1 = 'fa-sound-6-1'

ICON_SOUND_7_1

public mixed ICON_SOUND_7_1 = 'fa-sound-7-1'

ICON_SOUND_DOLBY

public mixed ICON_SOUND_DOLBY = 'fa-sound-dolby'

ICON_SOUND_STEREO

public mixed ICON_SOUND_STEREO = 'fa-sound-stereo'

ICON_STAR

public mixed ICON_STAR = 'fa-star'

ICON_STAR_EMPTY

public mixed ICON_STAR_EMPTY = 'fa-star-empty'

ICON_STATS

public mixed ICON_STATS = 'fa-bar-chart'

ICON_STEP_BACKWARD

public mixed ICON_STEP_BACKWARD = 'fa-step-backward'

ICON_STEP_FORWARD

public mixed ICON_STEP_FORWARD = 'fa-step-forward'

ICON_STOP

public mixed ICON_STOP = 'fa-stop'

ICON_SUBTITLES

public mixed ICON_SUBTITLES = 'fa-subtitles'

ICON_TAG

public mixed ICON_TAG = 'fa-tag'

ICON_TAGS

public mixed ICON_TAGS = 'fa-tags'

ICON_TASKS

public mixed ICON_TASKS = 'fa-tasks'

ICON_TEXT_HEIGHT

public mixed ICON_TEXT_HEIGHT = 'fa-text-height'

ICON_TEXT_WIDTH

public mixed ICON_TEXT_WIDTH = 'fa-text-width'

ICON_TH

public mixed ICON_TH = 'fa-th'

ICON_TH_LARGE

public mixed ICON_TH_LARGE = 'fa-th-large'

ICON_TH_LIST

public mixed ICON_TH_LIST = 'fa-th-list'

ICON_THUMBS_DOWN

public mixed ICON_THUMBS_DOWN = 'fa-thumbs-down'

ICON_THUMBS_UP

public mixed ICON_THUMBS_UP = 'fa-thumbs-up'

ICON_TIME

public mixed ICON_TIME = 'fa-time'

ICON_TINT

public mixed ICON_TINT = 'fa-tint'

ICON_TOWER

public mixed ICON_TOWER = 'fa-tower'

ICON_TRANSFER

public mixed ICON_TRANSFER = 'fa-transfer'

ICON_TRASH

public mixed ICON_TRASH = 'fa-trash'

ICON_TREE_CONIFER

public mixed ICON_TREE_CONIFER = 'fa-tree-conifer'

ICON_TREE_DECIDUOUS

public mixed ICON_TREE_DECIDUOUS = 'fa-tree-deciduous'

ICON_UNCHECKED

public mixed ICON_UNCHECKED = 'fa-unchecked'

ICON_UPLOAD

public mixed ICON_UPLOAD = 'fa-upload'

ICON_USD

public mixed ICON_USD = 'fa-usd'

ICON_USER

public mixed ICON_USER = 'fa-user'

ICON_VOLUME_DOWN

public mixed ICON_VOLUME_DOWN = 'fa-volume-down'

ICON_VOLUME_OFF

public mixed ICON_VOLUME_OFF = 'fa-volume-off'

ICON_VOLUME_UP

public mixed ICON_VOLUME_UP = 'fa-volume-up'

ICON_WARNING_SIGN

public mixed ICON_WARNING_SIGN = 'fa-warning-sign'

ICON_WRENCH

public mixed ICON_WRENCH = 'fa-wrench'

ICON_ZOOM_IN

public mixed ICON_ZOOM_IN = 'fa-zoom-in'

ICON_ZOOM_OUT

public mixed ICON_ZOOM_OUT = 'fa-zoom-out'

IMAGE_TYPE_CIRCLE

public mixed IMAGE_TYPE_CIRCLE = 'circle'

IMAGE_TYPE_POLAROID

public mixed IMAGE_TYPE_POLAROID = 'thumbnail'

IMAGE_TYPE_ROUNDED

public mixed IMAGE_TYPE_ROUNDED = 'rounded'

IMAGE_TYPE_THUMBNAIL

public mixed IMAGE_TYPE_THUMBNAIL = 'thumbnail'

INPUT_COLOR_DEFAULT

public mixed INPUT_COLOR_DEFAULT = ''

INPUT_COLOR_ERROR

public mixed INPUT_COLOR_ERROR = 'has-error'

INPUT_COLOR_SUCCESS

public mixed INPUT_COLOR_SUCCESS = 'has-success'

INPUT_COLOR_WARNING

public mixed INPUT_COLOR_WARNING = 'has-warning'

INPUT_HEIGHT_DEFAULT

public mixed INPUT_HEIGHT_DEFAULT = ''

INPUT_HEIGHT_LARGE

public mixed INPUT_HEIGHT_LARGE = 'lg'

INPUT_HEIGHT_SMALL

public mixed INPUT_HEIGHT_SMALL = 'sm'

INPUT_SIZE_DEFAULT

public mixed INPUT_SIZE_DEFAULT = ''

INPUT_SIZE_LARGE

public mixed INPUT_SIZE_LARGE = 'large'

INPUT_SIZE_MEDIUM

public mixed INPUT_SIZE_MEDIUM = 'medium'

INPUT_SIZE_MINI

public mixed INPUT_SIZE_MINI = 'mini'

INPUT_SIZE_SMALL

public mixed INPUT_SIZE_SMALL = 'small'

INPUT_SIZE_XLARGE

public mixed INPUT_SIZE_XLARGE = 'xlarge'

INPUT_SIZE_XXLARGE

public mixed INPUT_SIZE_XXLARGE = 'xxlarge'

INPUT_TYPE_CHECKBOX

public mixed INPUT_TYPE_CHECKBOX = 'checkBox'

INPUT_TYPE_CHECKBOXLIST

public mixed INPUT_TYPE_CHECKBOXLIST = 'checkBoxList'

INPUT_TYPE_CUSTOM

public mixed INPUT_TYPE_CUSTOM = 'widget'

INPUT_TYPE_DATE

public mixed INPUT_TYPE_DATE = 'dateField'

INPUT_TYPE_DROPDOWNLIST

public mixed INPUT_TYPE_DROPDOWNLIST = 'dropDownList'

INPUT_TYPE_EMAIL

public mixed INPUT_TYPE_EMAIL = 'emailField'

INPUT_TYPE_FILE

public mixed INPUT_TYPE_FILE = 'fileField'

INPUT_TYPE_HIDDEN

public mixed INPUT_TYPE_HIDDEN = 'hidden'

INPUT_TYPE_INLINECHECKBOXLIST

public mixed INPUT_TYPE_INLINECHECKBOXLIST = 'inlineCheckBoxList'

INPUT_TYPE_INLINERADIOBUTTONLIST

public mixed INPUT_TYPE_INLINERADIOBUTTONLIST = 'inlineRadioButtonList'

INPUT_TYPE_LISTBOX

public mixed INPUT_TYPE_LISTBOX = 'listBox'

INPUT_TYPE_NUMBER

public mixed INPUT_TYPE_NUMBER = 'numberField'

INPUT_TYPE_PASSWORD

public mixed INPUT_TYPE_PASSWORD = 'passwordField'

INPUT_TYPE_RADIOBUTTON

public mixed INPUT_TYPE_RADIOBUTTON = 'radioButton'

INPUT_TYPE_RADIOBUTTONLIST

public mixed INPUT_TYPE_RADIOBUTTONLIST = 'radioButtonList'

INPUT_TYPE_RANGE

public mixed INPUT_TYPE_RANGE = 'rangeField'
public mixed INPUT_TYPE_SEARCH = 'searchQuery'

INPUT_TYPE_TEXT

public mixed INPUT_TYPE_TEXT = 'textField'

INPUT_TYPE_TEXTAREA

public mixed INPUT_TYPE_TEXTAREA = 'textArea'

INPUT_TYPE_UNEDITABLE

public mixed INPUT_TYPE_UNEDITABLE = 'uneditableField'

INPUT_TYPE_URL

public mixed INPUT_TYPE_URL = 'urlField'

LABEL_COLOR_DANGER

public mixed LABEL_COLOR_DANGER = 'danger'

LABEL_COLOR_DEFAULT

public mixed LABEL_COLOR_DEFAULT = 'default'

LABEL_COLOR_INFO

public mixed LABEL_COLOR_INFO = 'info'

LABEL_COLOR_PRIMARY

public mixed LABEL_COLOR_PRIMARY = 'primary'

LABEL_COLOR_SUCCESS

public mixed LABEL_COLOR_SUCCESS = 'success'

LABEL_COLOR_WARNING

public mixed LABEL_COLOR_WARNING = 'warning'

MODAL_SIZE_DEFAULT

public mixed MODAL_SIZE_DEFAULT = ''

MODAL_SIZE_LARGE

public mixed MODAL_SIZE_LARGE = ' modal-lg'

MODAL_SIZE_SMALL

public mixed MODAL_SIZE_SMALL = ' modal-sm'

NAV_TYPE_LIST

public mixed NAV_TYPE_LIST = 'list'

NAV_TYPE_NONE

public mixed NAV_TYPE_NONE = ''

NAV_TYPE_PILLS

public mixed NAV_TYPE_PILLS = 'pills'

NAV_TYPE_TABS

public mixed NAV_TYPE_TABS = 'tabs'

NAVBAR_COLOR_INVERSE

public mixed NAVBAR_COLOR_INVERSE = 'inverse'

NAVBAR_DISPLAY_FIXEDBOTTOM

public mixed NAVBAR_DISPLAY_FIXEDBOTTOM = 'fixed-bottom'

NAVBAR_DISPLAY_FIXEDTOP

public mixed NAVBAR_DISPLAY_FIXEDTOP = 'fixed-top'

NAVBAR_DISPLAY_NONE

public mixed NAVBAR_DISPLAY_NONE = ''

NAVBAR_DISPLAY_STATICTOP

public mixed NAVBAR_DISPLAY_STATICTOP = 'static-top'

PAGINATION_ALIGN_CENTER

public mixed PAGINATION_ALIGN_CENTER = 'centered'

PAGINATION_ALIGN_LEFT

public mixed PAGINATION_ALIGN_LEFT = 'left'

PAGINATION_ALIGN_RIGHT

public mixed PAGINATION_ALIGN_RIGHT = 'right'

PAGINATION_SIZE_DEFAULT

public mixed PAGINATION_SIZE_DEFAULT = ''

PAGINATION_SIZE_LARGE

public mixed PAGINATION_SIZE_LARGE = 'lg'

PAGINATION_SIZE_LG

public mixed PAGINATION_SIZE_LG = 'lg'

PAGINATION_SIZE_MINI

public mixed PAGINATION_SIZE_MINI = 'mini'

PAGINATION_SIZE_SM

public mixed PAGINATION_SIZE_SM = 'sm'

PAGINATION_SIZE_SMALL

public mixed PAGINATION_SIZE_SMALL = 'sm'

POPOVER_PLACEMENT_BOTTOM

public mixed POPOVER_PLACEMENT_BOTTOM = 'bottom'

POPOVER_PLACEMENT_LEFT

public mixed POPOVER_PLACEMENT_LEFT = 'left'

POPOVER_PLACEMENT_RIGHT

public mixed POPOVER_PLACEMENT_RIGHT = 'right'

POPOVER_PLACEMENT_TOP

public mixed POPOVER_PLACEMENT_TOP = 'top'

POPOVER_TRIGGER_CLICK

public mixed POPOVER_TRIGGER_CLICK = 'click'

POPOVER_TRIGGER_FOCUS

public mixed POPOVER_TRIGGER_FOCUS = 'focus'

POPOVER_TRIGGER_HOVER

public mixed POPOVER_TRIGGER_HOVER = 'hover'

POPOVER_TRIGGER_MANUAL

public mixed POPOVER_TRIGGER_MANUAL = 'manual'

PROGRESS_COLOR_DANGER

public mixed PROGRESS_COLOR_DANGER = 'danger'

PROGRESS_COLOR_DEFAULT

public mixed PROGRESS_COLOR_DEFAULT = ''

PROGRESS_COLOR_INFO

public mixed PROGRESS_COLOR_INFO = 'info'

PROGRESS_COLOR_SUCCESS

public mixed PROGRESS_COLOR_SUCCESS = 'success'

PROGRESS_COLOR_WARNING

public mixed PROGRESS_COLOR_WARNING = 'warning'

PULL_LEFT

public mixed PULL_LEFT = 'left'

PULL_RIGHT

public mixed PULL_RIGHT = 'right'

TABS_PLACEMENT_ABOVE

public mixed TABS_PLACEMENT_ABOVE = ''

TABS_PLACEMENT_BELOW

public mixed TABS_PLACEMENT_BELOW = 'below'

TABS_PLACEMENT_LEFT

public mixed TABS_PLACEMENT_LEFT = 'left'

TABS_PLACEMENT_RIGHT

public mixed TABS_PLACEMENT_RIGHT = 'right'

TEXT_ALIGN_CENTER

public mixed TEXT_ALIGN_CENTER = 'center'

TEXT_ALIGN_JUSTIFY

public mixed TEXT_ALIGN_JUSTIFY = 'justify'

TEXT_ALIGN_LEFT

public mixed TEXT_ALIGN_LEFT = 'left'

TEXT_ALIGN_NOWRAP

public mixed TEXT_ALIGN_NOWRAP = 'nowrap'

TEXT_ALIGN_RIGHT

public mixed TEXT_ALIGN_RIGHT = 'right'

TEXT_COLOR_DEFAULT

public mixed TEXT_COLOR_DEFAULT = ''

TEXT_COLOR_ERROR

public mixed TEXT_COLOR_ERROR = 'error'

TEXT_COLOR_INFO

public mixed TEXT_COLOR_INFO = 'info'

TEXT_COLOR_SUCCESS

public mixed TEXT_COLOR_SUCCESS = 'success'

TEXT_COLOR_WARNING

public mixed TEXT_COLOR_WARNING = 'warning'

TOOLTIP_PLACEMENT_BOTTOM

public mixed TOOLTIP_PLACEMENT_BOTTOM = 'bottom'

TOOLTIP_PLACEMENT_LEFT

public mixed TOOLTIP_PLACEMENT_LEFT = 'left'

TOOLTIP_PLACEMENT_RIGHT

public mixed TOOLTIP_PLACEMENT_RIGHT = 'right'

TOOLTIP_PLACEMENT_TOP

public mixed TOOLTIP_PLACEMENT_TOP = 'top'

TOOLTIP_TRIGGER_CLICK

public mixed TOOLTIP_TRIGGER_CLICK = 'click'

TOOLTIP_TRIGGER_FOCUS

public mixed TOOLTIP_TRIGGER_FOCUS = 'focus'

TOOLTIP_TRIGGER_HOVER

public mixed TOOLTIP_TRIGGER_HOVER = 'hover'

TOOLTIP_TRIGGER_MANUAL

public mixed TOOLTIP_TRIGGER_MANUAL = 'manual'

WELL_SIZE_DEFAULT

public mixed WELL_SIZE_DEFAULT = ''

WELL_SIZE_LARGE

public mixed WELL_SIZE_LARGE = 'large'

WELL_SIZE_SMALL

public mixed WELL_SIZE_SMALL = 'small'

Properties

$errorCss

public static string $errorCss = 'has-error'

the CSS class for displaying error inputs

$errorSummaryCss

public static string $errorSummaryCss = 'alert alert-block alert-danger'

the CSS class for displaying error summaries.

$iconVendor

public static string $iconVendor = 'fa'

the icon vendor

$defaultFormControlWidthClass

protected static string $defaultFormControlWidthClass = 'col-sm-10'

default form control width

$defaultFormLabelWidthClass

protected static string $defaultFormLabelWidthClass = 'col-sm-2'

default form label width

Methods

abbr()

Generates an abbreviation with a help text.

public static abbr(string $text, string $word[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the abbreviation.

$word : string

the word the abbreviation is for.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated abbreviation.

activeCheckBox()

Generates a check box for a model attribute.

public static activeCheckBox(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated check box.

activeCheckBoxControlGroup()

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

public static activeCheckBoxControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeCheckBoxList()

Generates a check box list for a model attribute.

public static activeCheckBoxList(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

$data value-label pairs used to generate the check box list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

activeCheckBoxListControlGroup()

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

public static activeCheckBoxListControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeControlGroup()

Generates an active form row.

public static activeControlGroup(string $type, CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ][, array<string|int, mixed> $data = array() ]) : string
Parameters
$type : string

the input type.

$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$data : array<string|int, mixed> = array()

data for multiple select inputs.

Return values
string

the generated control group.

activeDateField()

Generates a date field input for a model attribute.

public static activeDateField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeDateFieldControlGroup()

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

public static activeDateFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeDropDownList()

Generates a drop down list for a model attribute.

public static activeDropDownList(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes

Return values
string

the generated drop down list.

activeDropDownListControlGroup()

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

public static activeDropDownListControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeEmailField()

Generates an email field input for a model attribute.

public static activeEmailField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeEmailFieldControlGroup()

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

public static activeEmailFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeFileField()

Generates a file field input for a model attribute.

public static activeFileField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
CHtml::activeFileField
Return values
string

the generated input field.

activeFileFieldControlGroup()

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

public static activeFileFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeInlineCheckBoxList()

Generates an inline check box list for a model attribute.

public static activeInlineCheckBoxList(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

$data value-label pairs used to generate the check box list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

activeInlineCheckBoxListControlGroup()

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

public static activeInlineCheckBoxListControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeInlineRadioButtonList()

Generates an inline radio button list for a model attribute.

public static activeInlineRadioButtonList(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

$data value-label pairs used to generate the radio button list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

activeInlineRadioButtonListControlGroup()

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

public static activeInlineRadioButtonListControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeListBox()

Generates a list box for a model attribute.

public static activeListBox(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list box

activeListBoxControlGroup()

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

public static activeListBoxControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeNumberField()

Generates a number field input for a model attribute.

public static activeNumberField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeNumberFieldControlGroup()

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

public static activeNumberFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activePasswordField()

Generates a password field input for a model attribute.

public static activePasswordField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activePasswordFieldControlGroup()

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

public static activePasswordFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeRadioButton()

Generates a radio button for a model attribute.

public static activeRadioButton(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated radio button.

activeRadioButtonControlGroup()

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

public static activeRadioButtonControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeRadioButtonList()

Generates a radio button list for a model attribute.

public static activeRadioButtonList(CModel $model, string $attribute, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed>

$data value-label pairs used to generate the radio button list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

activeRadioButtonListControlGroup()

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

public static activeRadioButtonListControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeRangeField()

Generates a range field input for a model attribute.

public static activeRangeField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeRangeFieldControlGroup()

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

public static activeRangeFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeSearchQueryControlGroup()

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

public static activeSearchQueryControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeSearchQueryField()

Generates a search query input for a model attribute.

public static activeSearchQueryField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated input.

activeTextArea()

Generates a text area input for a model attribute.

public static activeTextArea(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text area.

activeTextAreaControlGroup()

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

public static activeTextAreaControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeTextField()

Generates a text field input for a model attribute.

public static activeTextField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeTextFieldControlGroup()

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

public static activeTextFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeUneditableField()

Generates an uneditable input for a model attribute.

public static activeUneditableField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated input.

activeUneditableFieldControlGroup()

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

public static activeUneditableFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

activeUrlField()

Generates an url field input for a model attribute.

public static activeUrlField(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeTextInputField
Return values
string

the generated input field.

activeUrlFieldControlGroup()

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

public static activeUrlFieldControlGroup(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::activeControlGroup
Return values
string

the generated control group.

addCssClass()

Appends new class names to the given options.

public static addCssClass(mixed $className, array<string|int, mixed> &$htmlOptions) : array<string|int, mixed>

.

Parameters
$className : mixed

the class(es) to append.

$htmlOptions : array<string|int, mixed>

the options.

Return values
array<string|int, mixed>

the options.

addCssStyle()

Appends a CSS style string to the given options.

public static addCssStyle(string $style, array<string|int, mixed> &$htmlOptions) : array<string|int, mixed>
Parameters
$style : string

the CSS style string.

$htmlOptions : array<string|int, mixed>

the options.

Return values
array<string|int, mixed>

the options.

address()

Generates an address block.

public static address( $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text :
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated block.

ajaxButton()

Generates a push button that can initiate AJAX requests.

public static ajaxButton(string $label, mixed $url[, array<string|int, mixed> $ajaxOptions = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the button label.

$url : mixed

the URL for the AJAX request.

$ajaxOptions : array<string|int, mixed> = array()

AJAX options.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

Generates a link that can initiate AJAX requests.

public static ajaxLink(string $text, mixed $url[, array<string|int, mixed> $ajaxOptions = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the link body (it will NOT be HTML-encoded.)

$url : mixed

the URL for the AJAX request.

$ajaxOptions : array<string|int, mixed> = array()

AJAX options.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

ajaxSubmitButton()

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

public static ajaxSubmitButton(string $label, mixed $url[, array<string|int, mixed> $ajaxOptions = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the button label

$url : mixed

the URL for the AJAX request.

$ajaxOptions : array<string|int, mixed> = array()

AJAX options.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

alert()

Generates an alert.

public static alert(string $color, string $message[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$color : string

the color of the alert.

$message : string

the message to display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated alert.

animatedProgressBar()

Generates an animated progress bar.

public static animatedProgressBar([int $width = 0 ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$width : int = 0

the progress in percent.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated progress bar.

b()

Generates bold text.

public static b(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the text to style.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text.

badge()

Generates a badge span.

public static badge(string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the badge text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated span.

beginFormTb()

Generates an open form tag.

public static beginFormTb([string $layout = self::FORM_LAYOUT_VERTICAL ][, string $action = '' ][, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$layout : string = self::FORM_LAYOUT_VERTICAL

the form layout.

$action : string = ''

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated tag.

blockAlert()

Generates an alert block.

public static blockAlert(string $color, string $message[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$color : string

the color of the alert.

$message : string

the message to display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated alert.

breadcrumbs()

Generates a breadcrumb menu.

public static breadcrumbs(array<string|int, mixed> $links[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$links : array<string|int, mixed>

the breadcrumb links.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated breadcrumb.

btn()

Generates a button.

public static btn(string $type, string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$type : string

the button type.

$label : string

the button label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

button()

Generates an button.

public static button([string $label = 'Button' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Button'

the button label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

buttonDropdown()

Generates a button with a dropdown menu.

public static buttonDropdown(string $label, array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the button label text.

$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

buttonGroup()

Generates a button group.

public static buttonGroup(array<string|int, mixed> $buttons[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$buttons : array<string|int, mixed>

the button configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated button group.

buttonToolbar()

Generates a button toolbar.

public static buttonToolbar(array<string|int, mixed> $groups[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$groups : array<string|int, mixed>

the button group configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated button toolbar.

Generates an image carousel.

public static carousel(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the item configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated carousel.

carouselIndicators()

Generates an indicator for the carousel.

public static carouselIndicators(string $target, int $numSlides[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$target : string

the CSS selector for the target element.

$numSlides : int

the number of slides.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated indicators.

carouselItem()

Generates a carousel item.

public static carouselItem(string $content, string $label, string $caption[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the content.

$label : string

the item label text.

$caption : string

the item caption text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated item.

Generates a next link for the carousel.

public static carouselNextLink(string $label[, mixed $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$url : mixed = '#'

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

Generates a previous link for the carousel.

public static carouselPrevLink(string $label[, mixed $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$url : mixed = '#'

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

checkBox()

Generates a check box.

public static checkBox(string $name[, bool $checked = false ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$checked : bool = false

whether the check box is checked.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated check box.

checkBoxControlGroup()

Generates a control group with a check box.

public static checkBoxControlGroup(string $name[, bool|string $checked = false ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$checked : bool|string = false

whether the check box is checked.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

checkBoxList()

Generates a check box list.

public static checkBoxList(string $name, mixed $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

name of the check box list.

$select : mixed

selection of the check boxes.

$data : array<string|int, mixed>

$data value-label pairs used to generate the check box list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

checkBoxListControlGroup()

Generates a control group with a check box list.

public static checkBoxListControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

closeButton()

Generates a close button.

public static closeButton([string $label = self::CLOSE_TEXT ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = self::CLOSE_TEXT

the button label text.

$htmlOptions : array<string|int, mixed> = array()

the HTML options for the button.

Return values
string

the generated button.

Generates a close link.

public static closeLink([string $label = self::CLOSE_TEXT ][, mixed $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = self::CLOSE_TEXT

the link label text.

$url : mixed = '#'

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

code()

Generates inline code.

public static code(string $code[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$code : string

the code.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated code.

codeBlock()

Generates a code block.

public static codeBlock(string $code[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$code : string

the code.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated block.

Generates a collapse link.

public static collapseLink(string $label, string $target[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label.

$target : string

the CSS selector.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

controlGroup()

Generates a form group.

public static controlGroup(string $type, string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ][, array<string|int, mixed> $data = array() ]) : string
Parameters
$type : string

the input type.

$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$data : array<string|int, mixed> = array()

data for multiple select inputs.

Return values
string

the generated control group.

controls()

Generates form controls.

public static controls(mixed $controls[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$controls : mixed

the controls.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated controls.

controlsRow()

Generates form controls row.

public static controlsRow(mixed $controls[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$controls : mixed

the controls.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
deprecated

BS3 only requires a div.row container for all inputs if you want a controls row

Return values
string

the generated controls.

createActiveInput()

Creates an active form input of the given type.

public static createActiveInput(string $type, CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ][, array<string|int, mixed> $data = array() ]) : string
Parameters
$type : string

the input type.

$model : CModel

the model instance.

$attribute : string

the attribute name.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$data : array<string|int, mixed> = array()

data for multiple select inputs.

Tags
throws
CException

if the input type is invalid.

Return values
string

the input.

createInput()

Creates a form input of the given type.

public static createInput(string $type, string $name, string $value[, array<string|int, mixed> $htmlOptions = array() ][, array<string|int, mixed> $data = array() ]) : string
Parameters
$type : string

the input type.

$name : string

the input name.

$value : string

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$data : array<string|int, mixed> = array()

data for multiple select inputs.

Tags
throws
CException

if the input type is invalid.

Return values
string

the input.

customActiveControlGroup()

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

public static customActiveControlGroup(string $input, CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$input : string

the rendered input.

$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated control group.

customControlGroup()

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

public static customControlGroup(string $input, string $name[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$input : string

the rendered input.

$name : string

the input name.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated control group.

dateField()

Generates a date field input.

public static dateField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

dateFieldControlGroup()

Generates a control group with a file field.

public static dateFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

dropDownList()

Generates a drop down list.

public static dropDownList(string $name, string $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string

the selected value.

$data : array<string|int, mixed>

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()
Return values
string

the generated drop down list.

dropDownListControlGroup()

Generates a control group with a drop down list.

public static dropDownListControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

dropdownToggleButton()

Generates a dropdown toggle button.

public static dropdownToggleButton([string $label = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = ''

the button label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

Generates a dropdown toggle link.

public static dropdownToggleLink(string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

Generates a dropdown toggle menu item.

public static dropdownToggleMenuLink(string $label[, string $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ][, int $depth = 0 ]) : string
Parameters
$label : string

the menu item text.

$url : string = '#'

the menu item URL.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$depth : int = 0

the menu depth at which this link is located

Return values
string

the generated menu item.

em()

Generates an emphasized text.

public static em(string $text[, array<string|int, mixed> $htmlOptions = array() ][, string $tag = 'p' ]) : string
Parameters
$text : string

the text to emphasize.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$tag : string = 'p'

the HTML tag.

Return values
string

the generated text.

emailField()

Generates an email field input.

public static emailField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

emailFieldControlGroup()

Generates a control group with an email field.

public static emailFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

error()

Displays the first validation error for a model attribute.

public static error(CModel $model, string $attribute[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : CModel

the data model.

$attribute : string

the attribute name.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the rendered error. Empty if no errors are found.

errorSummary()

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

public static errorSummary(mixed $model[, string $header = null ][, string $footer = null ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$model : mixed

the models whose input errors are to be displayed.

$header : string = null

a piece of HTML code that appears in front of the errors.

$footer : string = null

a piece of HTML code that appears at the end of the errors.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes to be rendered in the container div tag.

Return values
string

the error summary. Empty if no errors are found.

fileField()

Generates a file field input.

public static fileField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
CHtml::fileField
Return values
string

the generated input field.

fileFieldControlGroup()

Generates a control group with a file field.

public static fileFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

formActions()

Generates form actions div. This is no longer necessary in Bootstrap 3, but it is still useful to use for horizontal forms. When used with a horizontal form, it will appropriately align the actions below other form controls.

public static formActions(mixed $actions[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$actions : mixed

the actions.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated actions.

formTb()

Generates a form tag.

public static formTb([string $layout = self::FORM_LAYOUT_VERTICAL ][, string $action = '' ][, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$layout : string = self::FORM_LAYOUT_VERTICAL

the form layout.

$action : string = ''

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated tag.

help()

Generates a help text.

public static help(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the help text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text.

helpBlock()

Generates a help block.

public static helpBlock(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the help text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
deprecated
Return values
string

the generated block.

heroUnit()

Generates a jumbotron unit.

public static heroUnit(string $heading, string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$heading : string

the heading text.

$content : string

the content text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated hero unit.

htmlButton()

Generates an image submit button.

public static htmlButton([string $label = 'Button' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Button'
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

i()

Generates italic text.

public static i(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the text to style.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text.

icon()

Generates an icon.

public static icon(string $icon[, array<string|int, mixed> $htmlOptions = array() ][, string $tagName = 'span' ]) : string
Parameters
$icon : string

the icon type.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$tagName : string = 'span'

the icon HTML tag.

Return values
string

the generated icon.

image()

Generates an image tag.

public static image(string $src[, string $alt = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL.

$alt : string = ''

the alternative text display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated image tag.

imageButton()

Generates an image submit button.

public static imageButton(string $src[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

imageCircle()

Generates an image tag with circle.

public static imageCircle(string $src[, string $alt = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL.

$alt : string = ''

the alternative text display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated image tag.

imagePolaroid()

Generates an image tag within polaroid frame.

public static imagePolaroid(string $src[, string $alt = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL.

$alt : string = ''

the alternative text display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
deprecated

See

Return values
string

the generated image tag.

imageRounded()

Generates an image tag with rounded corners.

public static imageRounded(string $src[, string $alt = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL.

$alt : string = ''

the alternative text display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated image tag.

imageThumbnail()

Generates an image tag within thumbnail frame.

public static imageThumbnail(string $src[, string $alt = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$src : string

the image URL.

$alt : string = ''

the alternative text display.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated image tag.

inlineCheckBoxList()

Generates an inline check box list.

public static inlineCheckBoxList(string $name, mixed $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

name of the check box list.

$select : mixed

selection of the check boxes.

$data : array<string|int, mixed>

$data value-label pairs used to generate the check box list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

inlineCheckBoxListControlGroup()

Generates a control group with an inline check box list.

public static inlineCheckBoxListControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

inlineRadioButtonList()

Generates an inline radio button list.

public static inlineRadioButtonList(string $name, mixed $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

name of the radio button list.

$select : mixed

selection of the radio buttons.

$data : array<string|int, mixed>

$data value-label pairs used to generate the radio button list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

inlineRadioButtonListControlGroup()

Generates a control group with an inline radio button list.

public static inlineRadioButtonListControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

inputButton()

Generates a form input push button.

public static inputButton(string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the button label

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

inputSubmit()

Generates a form input submit push button.

public static inputSubmit([string $label = 'Submit' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Submit'

the button label

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

labelTb()

Generates a label span.

public static labelTb(string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated span.

lead()

Generates a paragraph that stands out.

public static lead(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the lead text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated paragraph.

Generates a hyperlink tag.

public static link(string $text[, mixed $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

link body. It will NOT be HTML-encoded.

$url : mixed = '#'

a URL or an action route that can be used to create a URL.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated hyperlink

linkButton()

Generates a link submit button.

public static linkButton([string $label = 'Submit' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Submit'

the button label.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button tag.

listBox()

Generates a list box.

public static listBox(string $name, mixed $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : mixed

the selected value(s).

$data : array<string|int, mixed>

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list box

listBoxControlGroup()

Generates a control group with a list box.

public static listBoxControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

media()

Generates a single media object.

public static media(string $image, string $heading, string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$image : string

the image url.

$heading : string

the heading text.

$content : string

the content text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the media object.

mediaList()

Generates a list of media objects.

public static mediaList(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

item configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

generated list.

medias()

Generates multiple media objects.

public static medias(array<string|int, mixed> $items[, string $tag = 'div' ]) : string
Parameters
$items : array<string|int, mixed>

item configurations.

$tag : string = 'div'

the item tag name.

Return values
string

generated objects.

menu()

Generates a menu.

public static menu(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ][, int $depth = 0 ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$depth : int = 0

the current depth.

Return values
string

the generated menu.

menuDivider()

Generates a menu divider.

public static menuDivider([array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu item.

menuHeader()

Generates a menu header.

public static menuHeader(string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the header text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated header.

Generates a menu link.

public static menuLink(string $label, array<string|int, mixed> $url[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label.

$url : array<string|int, mixed>

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu item.

modalBody()

Generates a modal body.

public static modalBody(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the body content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated body.

modalFooter()

Generates a modal footer.

public static modalFooter(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the footer content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated footer.

modalHeader()

Generates a modal header.

public static modalHeader(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the header content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated header.

muted()

Generates a muted text block.

public static muted(string $text[, array<string|int, mixed> $htmlOptions = array() ][, string $tag = 'p' ]) : string
Parameters
$text : string

the text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$tag : string = 'p'

the HTML tag.

Return values
string

the generated text block.

mutedSpan()

Generates a muted span.

public static mutedSpan(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated span.

nav()

Generates a navigation menu.

public static nav(string $type, array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$type : string

the menu type.

$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

navbar()

Generates a navbar.

public static navbar(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the navbar content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated navbar.

Generates a brand link for the navbar.

public static navbarBrandLink(string $label, string $url[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$url : string

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

Generates a collapse element.

public static navbarCollapseLink(string $target[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$target : string

the CSS selector for the target element.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated icon.

navbarForm()

Generates a navbar form.

public static navbarForm(mixed $action[, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$action : mixed

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes

Return values
string

the generated form.

navbarMenuDivider()

Generates a menu divider for the navbar.

public static navbarMenuDivider([array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated divider.

navbarSearchForm()

Generates a navbar search form.

public static navbarSearchForm(mixed $action[, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$action : mixed

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes

Return values
string

the generated form.

navbarText()

Generates a text for the navbar.

public static navbarText(string $text[, array<string|int, mixed> $htmlOptions = array() ][, string $tag = 'p' ]) : string
Parameters
$text : string

the text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

$tag : string = 'p'

the HTML tag.

Return values
string

the generated text block.

navList()

Generates a list navigation.

public static navList(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

numberField()

Generates a number field input.

public static numberField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

numberFieldControlGroup()

Generates a control group with a number field.

public static numberFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated control group.

openTag()

Generates an open HTML element.

public static openTag(string $tag[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$tag : string

the tag name.

$htmlOptions : array<string|int, mixed> = array()

the element attributes.

Return values
string

the generated HTML element tag.

pageHeader()

Generates a pager header.

public static pageHeader(string $heading, string $subtext[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$heading : string

the heading text.

$subtext : string

the subtext.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated pager header.

pager()

Generates a pager.

public static pager(array<string|int, mixed> $links[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$links : array<string|int, mixed>

the pager buttons.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated pager.

Generates a pager link.

public static pagerLink(string $label, mixed $url[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$url : mixed

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

pagination()

Generates a pagination.

public static pagination(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the pagination buttons.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated pagination.

Generates a pagination link.

public static paginationLink(string $label, mixed $url[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the link label text.

$url : mixed

the link url.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated link.

passwordField()

Generates a password field input.

public static passwordField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

passwordFieldControlGroup()

Generates a control group with a password field.

public static passwordFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated control group.

pills()

Generates a pills navigation.

public static pills(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

popover()

Generates a popover.

public static popover(string $label, string $title, string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the popover link label text.

$title : string

the popover title text.

$content : string

the popover content text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated popover.

progressBar()

Generates a progress bar.

public static progressBar([int $width = 0 ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$width : int = 0

the progress in percent.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated progress bar.

quote()

Generates a quote.

public static quote(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the quoted text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated quote.

radioButton()

Generates a radio button.

public static radioButton(string $name[, bool $checked = false ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$checked : bool = false

whether the radio button is checked.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated radio button.

radioButtonControlGroup()

Generates a control group with a radio button.

public static radioButtonControlGroup(string $name[, bool|string $checked = false ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$checked : bool|string = false

whether the radio button is checked.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

radioButtonList()

Generates a radio button list.

public static radioButtonList(string $name, mixed $select, array<string|int, mixed> $data[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

name of the radio button list.

$select : mixed

selection of the radio buttons.

$data : array<string|int, mixed>

$data value-label pairs used to generate the radio button list.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated list.

radioButtonListControlGroup()

Generates a control group with a radio button list.

public static radioButtonListControlGroup(string $name[, string $select = '' ][, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$select : string = ''

the selected value.

$data : array<string|int, mixed> = array()

data for generating the list options (value=>display).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

rangeField()

Generates a range field input.

public static rangeField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

rangeFieldControlGroup()

Generates a control group with a range field.

public static rangeFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name

$value : string = ''

the input value

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

resetButton()

Generates a reset button.

public static resetButton([string $label = 'Reset' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Reset'

the button label

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

searchForm()

Generates a search form.

public static searchForm(mixed $action[, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$action : mixed

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated form.

searchQueryControlGroup()

Generates a control group with a search field.

public static searchQueryControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

searchQueryField()

Generates a search input.

public static searchQueryField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated input.

small()

Generates small text.

public static small(string $text[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the text to style.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text.

smallAbbr()

Generates a small abbreviation with a help text.

public static smallAbbr(string $text, string $word[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$text : string

the abbreviation.

$word : string

the word the abbreviation is for.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated abbreviation.

splitButtonDropdown()

Generates a button with a split dropdown menu.

public static splitButtonDropdown(string $label, array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the button label text.

$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

stackedPills()

Generates a stacked pills navigation.

public static stackedPills(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

stackedProgressBar()

Generates a stacked progress bar.

public static stackedProgressBar(array<string|int, mixed> $bars[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$bars : array<string|int, mixed>

the bar configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated progress bar.

stackedTabs()

Generates a stacked tab navigation.

public static stackedTabs(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
deprecated

Style does not exist in BS3

Return values
string

the generated menu.

statefulFormTb()

Generates a stateful form tag.

public static statefulFormTb([mixed $layout = self::FORM_LAYOUT_VERTICAL ][, mixed $action = '' ][, string $method = 'post' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$layout : mixed = self::FORM_LAYOUT_VERTICAL
$action : mixed = ''

the form action URL.

$method : string = 'post'

form method (e.g. post, get).

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated form tag.

stripedProgressBar()

Generates a striped progress bar.

public static stripedProgressBar([int $width = 0 ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$width : int = 0

the progress in percent.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated progress bar.

submitButton()

Generates a submit button.

public static submitButton([string $label = 'Submit' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string = 'Submit'

the button label

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated button.

tabbable()

Generates a tabbable menu.

public static tabbable(string $type, array<string|int, mixed> $tabs[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$type : string

the menu type.

$tabs : array<string|int, mixed>

the tab configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

tabbableTabs()

Generates a tabbable tabs menu.

public static tabbableTabs(array<string|int, mixed> $tabs[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$tabs : array<string|int, mixed>

the tab configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

tabs()

Generates a tab navigation.

public static tabs(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

tag()

Generates an HTML element.

public static tag(string $tag[, array<string|int, mixed> $htmlOptions = array() ][, mixed $content = false ][, bool $closeTag = true ]) : string
Parameters
$tag : string

the tag name.

$htmlOptions : array<string|int, mixed> = array()

the element attributes.

$content : mixed = false

the content to be enclosed between open and close element tags.

$closeTag : bool = true

whether to generate the close tag.

Return values
string

the generated HTML element tag.

textArea()

Generates a text area input.

public static textArea(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated text area.

textAreaControlGroup()

Generates a control group with a text area.

public static textAreaControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

textField()

Generates a text field input.

public static textField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

textFieldControlGroup()

Generates a control group with a text field.

public static textFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

thumbnail()

Generates a thumbnail.

public static thumbnail(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the thumbnail content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated thumbnail.

Generates a link thumbnail.

public static thumbnailLink(string $content[, mixed $url = '#' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the thumbnail content.

$url : mixed = '#'

the url that the thumbnail links to.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated thumbnail.

thumbnails()

Generates a list of thumbnails.

public static thumbnails(array<string|int, mixed> $thumbnails[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$thumbnails : array<string|int, mixed>

the list configuration.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated thumbnails.

tooltip()

Generates a tooltip.

public static tooltip(string $label, mixed $url, string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$label : string

the tooltip link label text.

$url : mixed

the link url.

$content : string

the tooltip content text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated tooltip.

uneditableField()

Generates an uneditable input.

public static uneditableField(string $value[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$value : string

the value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated input.

uneditableFieldControlGroup()

Generates a control group with an uneditable field.

public static uneditableFieldControlGroup([string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$value : string = ''
$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

urlField()

Generates an url field input.

public static urlField(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::textInputField
Return values
string

the generated input field.

urlFieldControlGroup()

Generates a control group with an url field.

public static urlFieldControlGroup(string $name[, string $value = '' ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$name : string

the input name.

$value : string = ''

the input value.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Tags
see
self::controlGroup
Return values
string

the generated control group.

verticalButtonGroup()

Generates a vertical button group.

public static verticalButtonGroup(array<string|int, mixed> $buttons[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$buttons : array<string|int, mixed>

the button configurations.

$htmlOptions : array<string|int, mixed> = array()

additional HTML options.

Return values
string

the generated button group.

well()

Generates a well element.

public static well(string $content[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$content : string

the well content.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated well.

activeTextInputField()

Generates an input HTML tag for a model attribute.

protected static activeTextInputField(string $type, CModel $model, string $attribute, array<string|int, mixed> $htmlOptions) : string

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

Parameters
$type : string

the input type.

$model : CModel

the data model.

$attribute : string

the attribute.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated input tag.

addColClass()

Adds the appropriate column class to the given options applicable. The available columns are 'xs', 'sm', 'md', 'lg' for extra small, small, medium, and large to be used for the appropriate screen sizes. It is also possible to prevent your columns from stacking on smaller devices by combining a small column with a larger column: <code> $htmlOptions = array( 'xs' => 12, 'md' => 8, ) </code> Both classes will be applied.

protected static addColClass( &$htmlOptions) : mixed
Parameters
$htmlOptions :

addPullClass()

Adds the pull class to the given options is applicable.

protected static addPullClass(array<string|int, mixed> &$htmlOptions) : mixed
Parameters
$htmlOptions : array<string|int, mixed>

the HTML attributes.

addSpanClass()

Adds the grid span class to the given options is applicable. BS3 no longer use span classes. During the BS3 transition, this will use the col-md-* CSS class.

protected static addSpanClass(array<string|int, mixed> &$htmlOptions) : mixed
Parameters
$htmlOptions : array<string|int, mixed>

the HTML attributes.

Tags
deprecated

addTextAlignClass()

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

protected static addTextAlignClass(array<string|int, mixed> &$htmlOptions) : mixed
Parameters
$htmlOptions : array<string|int, mixed>

the HTML attributes.

bar()

Generates a progress bar.

protected static bar([int $width = 0 ][, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$width : int = 0

the progress in percent.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated bar.

btnDropdown()

Generates a button dropdown.

protected static btnDropdown(string $type, string $label, array<string|int, mixed> $items, array<string|int, mixed> $htmlOptions) : string
Parameters
$type : string

the button type.

$label : string

the button label text.

$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated button.

close()

Generates a close element.

protected static close(string $tag, string $label[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$tag : string

the tag name.

$label : string

the element label text.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated element.

createButton()

Creates a button the of given type.

protected static createButton(string $type, string $label, array<string|int, mixed> $htmlOptions) : string
Parameters
$type : string

the button type.

$label : string

the button label.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Tags
throws
CException

if the button type is valid.

Return values
string

the button.

createCheckBoxAndRadioButtonLabel()

Generates a label for a checkbox or radio input by wrapping the input.

protected static createCheckBoxAndRadioButtonLabel(string $label, string $input, array<string|int, mixed> $htmlOptions) : string
Parameters
$label : string

the label text.

$input : string

the input.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated label.

dropdown()

Generates a dropdown menu.

protected static dropdown(array<string|int, mixed> $items[, array<string|int, mixed> $htmlOptions = array() ]) : string
Parameters
$items : array<string|int, mixed>

the menu items.

$htmlOptions : array<string|int, mixed> = array()

additional HTML attributes.

Return values
string

the generated menu.

dropdownToggle()

Generates a dropdown toggle element.

protected static dropdownToggle(string $type, string $label, array<string|int, mixed> $htmlOptions) : string
Parameters
$type : string

the type of dropdown.

$label : string

the element text.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated element.

getAddOnClasses()

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

protected static getAddOnClasses(array<string|int, mixed> $htmlOptions) : string
Parameters
$htmlOptions : array<string|int, mixed>

the options.

Return values
string

the classes.

getColClasses()

Returns the col-* classes

protected static getColClasses(array<string|int, mixed> $htmlOptions) : string
Parameters
$htmlOptions : array<string|int, mixed>

with "class" set

Return values
string

inputAddOn()

Generates an add-on for an input field.

protected static inputAddOn(string|array<string|int, mixed> $addOns, array<string|int, mixed> $htmlOptions[, string $position = 'prepend' ]) : string
Parameters
$addOns : string|array<string|int, mixed>

the add-on.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

$position : string = 'prepend'

either 'prepend' or 'append'. Position is only important if you are passing multiple addons and it's a mixture of text/radio/checkboxes or buttons. The current styling needs buttons at the ends.

Return values
string

the generated add-on.

inputHelp()

Generates a help text for an input field.

protected static inputHelp(string $help, array<string|int, mixed> $htmlOptions) : string
Parameters
$help : string

the help text.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated help text.

menuDropdown()

Generates a menu dropdown.

protected static menuDropdown(string $label, string $url, array<string|int, mixed> $items, array<string|int, mixed> $htmlOptions[, int $depth = 0 ]) : string
Parameters
$label : string

the link label.

$url : string

the link URL.

$items : array<string|int, mixed>

the menu configuration.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

$depth : int = 0

the current depth.

Return values
string

the generated dropdown.

normalizeCheckBoxAndRadio()

Normalizes the inputs in the given string by splitting them up into an array.

protected static normalizeCheckBoxAndRadio(string $input) : array<string|int, mixed>
Parameters
$input : string

the inputs.

Return values
array<string|int, mixed>

an array with the following structure: array($hidden, $input)

normalizeInputOptions()

Normalizes input options.

protected static normalizeInputOptions(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed>

the options.

Return values
array<string|int, mixed>

the normalized options.

normalizeTabs()

Normalizes the tab configuration.

protected static normalizeTabs(array<string|int, mixed> $tabs, array<string|int, mixed> &$panes[, int $i = 0 ]) : array<string|int, mixed>
Parameters
$tabs : array<string|int, mixed>

the tab configuration.

$panes : array<string|int, mixed>

a reference to the panes array.

$i : int = 0

the running index.

Return values
array<string|int, mixed>

the items.

popColClasses()

Returns the col-* classes and removes the classes from $htmlOptions['class']

protected static popColClasses(string &$htmlOptions) : string
Parameters
$htmlOptions : string

with class set

Return values
string

switchColToOffset()

Nearly identical to {@link switchOffsetCol()} except it forces the class to be returned as its offset counterpart. It is also safe to pass in a class that is already an offset and it will just re-return it. For example, passing in col-md-2 will return col-md-offset-2. Passing in col-md-offset-4 will still return col-md-offset-4.

protected static switchColToOffset(string $class) : string
Parameters
$class : string
Return values
string

switchOffsetCol()

Switches the column class to and from the col width itself to its offset counterpart. For example, passing in col-md-2 would be switched to col-md-offset-2

protected static switchOffsetCol(string $class) : string
Parameters
$class : string
Return values
string

switchOffsetToCol()

Nearly identical to {@link switchOffsetCol()} except it forces teh class to be returned as its column (e.g. "span") width counterpart. It is also safe to pass in a class that is already the column width and it will re-return it. For example, passing in col-md-offset-2 will return col-md-2. Passing in col-md-4 will still return col-md-4.

protected static switchOffsetToCol(string $class) : string
Parameters
$class : string
Return values
string

textInputField()

Generates an input HTML tag.

protected static textInputField(string $type, string $name, string $value, array<string|int, mixed> $htmlOptions) : string

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

Parameters
$type : string

the input type.

$name : string

the input name.

$value : string

the input value.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated input tag.

tooltipPopover()

Generates a base tooltip.

protected static tooltipPopover(string $label, mixed $url, string $title, array<string|int, mixed> $htmlOptions) : string
Parameters
$label : string

the tooltip link label text.

$url : mixed

the link url.

$title : string

the tooltip title text.

$htmlOptions : array<string|int, mixed>

additional HTML attributes.

Return values
string

the generated tooltip.


        
On this page

Search results