Bootstrap

Utility class for Bootstrap elements.

abstract
since

3.0

Methods

addSlide

Begins the display of a new accordion slide.

addSlide(string $selector, string $text, string $id, string $class = '') : string
static
since

3.0

Arguments

$selector

stringIdentifier of the accordion group.

$text

stringText to display.

$id

stringIdentifier of the slide.

$class

stringClass of the accordion group.

Response

stringHTML to add the slide

addTab

Begins the display of a new tab content panel.

addTab(string $selector, string $id, string $title) : string
static
since

3.1

Arguments

$selector

stringIdentifier of the panel. Expects a valid ID without the #!

$id

stringThe ID of the div element. Expects a valid ID without the #!

$title

stringThe title text for the new UL tab

Response

stringHTML to start a new panel

alert

Add javascript support for Bootstrap alerts

alert(string $selector = '') : void
static
throws

\Exception

since

3.0

Arguments

$selector

stringCommon class for the alerts

button

Add javascript support for Bootstrap buttons

button(string $selector = '') : void
static
throws

\Exception

since

3.1

Arguments

$selector

stringCommon class for the buttons

collapse

Add javascript support for Bootstrap collapse

collapse(string $selector = '', array<mixed,string> $params = array()) : void
static
throws

\Exception

since

4.0.0

Arguments

$selector

stringCommon class for the collapse

$params

array<mixed,string>Additional parameters - see below

dropdown

Add javascript support for Bootstrap dropdowns

dropdown(string $selector = '', array $params = array()) : void
static
since

4.0.0

Arguments

$selector

stringCommon class for the dropdowns

$params

arrayThe options for the dropdowns

endAccordion

Close the current accordion

endAccordion() : string
static
since

3.0

Response

stringHTML to close the accordion

endSlide

Close the current slide

endSlide() : string
static
since

3.0

Response

stringHTML to close the slide

endTab

Close the current tab content panel

endTab() : string
static
since

3.1

Response

stringHTML to close the pane

endTabSet

Close the current tab pane

endTabSet() : string
static
since

3.1

Response

stringHTML to close the pane

framework

Method to load the ALL the Bootstrap Components

framework(mixed $debug = null) : void
static deprecated

If debugging mode is on an uncompressed version of Bootstrap is included for easier debugging.

since

3.0

deprecated

5.0

Arguments

$debug

mixedIs debugging mode on? [optional]

loadCss

Loads CSS files needed by Bootstrap

loadCss(boolean $includeMainCss = true, string $direction = 'ltr', array $attribs = array()) : void
static
since

3.0

Arguments

$includeMainCss

booleanIf true, main bootstrap.css files are loaded

$direction

stringrtl or ltr direction. If empty, ltr is assumed

$attribs

arrayOptional array of attributes to be passed to HTMLHelper::_('stylesheet')

modal

Add javascript support for Bootstrap modal

modal(string $selector = '', array $options = array()) : void
static
since

4.0.0

Arguments

$selector

stringThe ID selector for the modal.

$options

arrayAn array of options for the modal.

offcanvas

Add javascript support for Bootstrap offcanvas

offcanvas(string $selector = '', array $options = array()) : void
static
since

4.0.0

Arguments

$selector

stringThe ID selector for the offcanvas.

$options

arrayAn array of options for the offcanvas.

popover

Add javascript support for Bootstrap popovers

popover(string $selector = '', array $options = array()) : void
static

Use element's Title as popover content

since

3.0

Arguments

$selector

stringSelector for the popover

$options

arrayThe options for the popover

renderModal

Method to render a Bootstrap modal

renderModal(string $selector = 'modal', array $options = array(), string $body = '') : string
static
since

3.0

Arguments

$selector

stringThe ID selector for the modal. Expects a valid ID without the #!

$options

arrayAn array of options for the modal.

$body

stringMarkup for the modal body. Appended after the <iframe> if the URL option is set

Response

stringHTML markup for a modal

scrollspy

Add javascript support for Bootstrap Scrollspy

scrollspy(string $selector = '', array $options = array()) : void
static
since

3.0

Arguments

$selector

stringThe ID selector for the ScrollSpy element.

$options

arrayAn array of options for the ScrollSpy.

startAccordion

Add javascript support for Bootstrap accordions and insert the accordion

startAccordion(string $selector = 'myAccordian', array $options = array()) : string
static
since

3.0

Arguments

$selector

stringThe ID selector for the tooltip. Expects a valid ID without the #!

$options

arrayAn array of options for the tooltip.

Response

stringHTML for the accordion

startTabSet

Creates a tab pane

startTabSet(string $selector = 'myTab', array $params = array()) : string
static
since

3.1

Arguments

$selector

stringThe pane identifier. Expects a valid ID without the #!

$params

arrayThe parameters for the pane

Response

string

tab

Add javascript support for Bootstrap tab

tab(string $selector = '', array $options = array()) : void
static
throws

\Exception

since

4.0.0

Arguments

$selector

stringCommon class for the tabs

$options

arrayOptions for the tabs

toast

Add javascript support for Bootstrap toasts

toast(string $selector = '', array $options = array()) : void
static
throws

\Exception

since

4.0.0

Arguments

$selector

stringCommon class for the toasts

$options

arrayOptions for the toasts

tooltip

Add javascript support for Bootstrap tooltips

tooltip(string $selector = '', array $options = array()) : void
static

Add a title attribute to any element in the form title="title::text"

since

3.0

Arguments

$selector

stringThe ID selector for the tooltip.

$options

arrayAn array of options for the tooltip.

Properties

loaded

Array containing information for loaded files

static
since

3.0

Type(s)

array