Overview

Packages

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

Classes

  • TbApi
  • Overview
  • Package
  • Class
  • Tree

Class TbApi

Bootstrap API component.

CApplicationComponent
Extended by TbApi
Package: bootstrap\components
Copyright: Copyright © Christoffer Niska 2013-
License: New BSD License
Author: Christoffer Niska <christoffer.niska@gmail.com>
Located at components/TbApi.php
Methods summary
public
# registerCoreCss( string $url = null )

Registers the Bootstrap CSS.

Registers the Bootstrap CSS.

Parameters

$url
string
$url the URL to the CSS file to register.
public
# registerResponsiveCss( string $url = null )

Registers the responsive Bootstrap CSS.

Registers the responsive Bootstrap CSS.

Parameters

$url
string
$url the URL to the CSS file to register.
public
# registerYiistrapCss( string $url = null )

Registers the Yiistrap CSS.

Registers the Yiistrap CSS.

Parameters

$url
string
$url the URL to the CSS file to register.
public
# registerAllCss( )

Registers all Bootstrap CSS files.

Registers all Bootstrap CSS files.

public
# registerCoreScripts( string $url = null, integer $position = CClientScript::POS_END )

Registers jQuery and Bootstrap JavaScript.

Registers jQuery and Bootstrap JavaScript.

Parameters

$url
string
$url the URL to the JavaScript file to register.
$position
integer
$position the position of the JavaScript code.
public
# registerTooltipAndPopover( )

Registers the Tooltip and Popover plugins.

Registers the Tooltip and Popover plugins.

public
# registerAllScripts( )

Registers all Bootstrap JavaScript files.

Registers all Bootstrap JavaScript files.

public
# register( )

Registers all assets.

Registers all assets.

public
# registerPopover( string $selector = 'body', array $options = array() )

Registers the Bootstrap Popover plugin.

Registers the Bootstrap Popover plugin.

Parameters

$selector
string
$selector the CSS selector.
$options
array
$options the JavaScript options for the plugin.

See

http://twitter.github.com/bootstrap/javascript.html#popover
public
# registerTooltip( string $selector = 'body', array $options = array() )

Registers the Bootstrap Tooltip plugin.

Registers the Bootstrap Tooltip plugin.

Parameters

$selector
string
$selector the CSS selector.
$options
array
$options the JavaScript options for the plugin.

See

http://twitter.github.com/bootstrap/javascript.html#tooltip
public
# registerPlugin( string $name, string $selector, array $options = array(), integer $position = CClientScript::POS_END )

Registers a specific Bootstrap plugin using the given selector and options.

Registers a specific Bootstrap plugin using the given selector and options.

Parameters

$name
string
$name the plugin name.
$selector
string
$selector the CSS selector.
$options
array
$options the JavaScript options for the plugin.
$position
integer
$position the position of the JavaScript code.
public
# registerEvents( string $selector, string[] $events, integer $position = CClientScript::POS_END )

Registers events using the given selector.

Registers events using the given selector.

Parameters

$selector
string
$selector the CSS selector.
$events
string[]
$events the JavaScript event configuration (name=>handler).
$position
integer
$position the position of the JavaScript code.
protected string
# getAssetsUrl( )

Returns the url to the published assets folder.

Returns the url to the published assets folder.

Returns

string
the url.
Constants summary
string PLUGIN_AFFIX 'affix'
#
string PLUGIN_ALERT 'alert'
#
string PLUGIN_BUTTON 'button'
#
string PLUGIN_CAROUSEL 'carousel'
#
string PLUGIN_COLLAPSE 'collapse'
#
string PLUGIN_DROPDOWN 'dropdown'
#
string PLUGIN_MODAL 'modal'
#
string PLUGIN_POPOVER 'popover'
#
string PLUGIN_SCROLLSPY 'scrollspy'
#
string PLUGIN_TAB 'tab'
#
string PLUGIN_TOOLTIP 'tooltip'
#
string PLUGIN_TRANSITION 'transition'
#
string PLUGIN_TYPEAHEAD 'typeahead'
#
Properties summary
public static integer $counter 0
#

static counter, used for determining script identifiers

static counter, used for determining script identifiers

public boolean $forceCopyAssets false
#

whether we should copy the asset file or directory even if it is already published before.

whether we should copy the asset file or directory even if it is already published before.

Yiistrap API documentation generated by ApiGen 2.8.0