HCE Project DC service web UI  0.2
Hierarchical Cluster Engine DC service web UI
 All Classes Namespaces Files Functions Variables Pages
Booster Class Reference

Public Member Functions

 init ()
 registerYiiCss ()
 registerJQueryCss ()
 getVersion ()
 registerPackage ($name)
 registerAssetCss ($name, $media= '')
 registerAssetJs ($name, $position=CClientScript::POS_END)
 getAssetsUrl ()
 registerBootstrapCss ()
 registerFontAwesomeCss ()
 registerPopoverJs ()
 registerTooltipJs ()
 getUniqueScriptId ()

Static Public Member Functions

static setBooster ($value)
static getBooster ()

Public Attributes

 $enableCdn = false
 $coreCss = true
 $bootstrapCss = true
 $responsiveCss = true
 $disableZooming = false
 $fontAwesomeCss = false
 $minify = true
 $yiiCss = true
 $jqueryCss = true
 $enableJS = true
 $enableBootboxJS = true
 $enableNotifierJS = true
 $ajaxCssLoad = false
 $ajaxJsLoad = false
 $forceCopyAssets = false
 $enablePopover = true
 $enableTooltip = true
 $popoverSelector = '[data-toggle=popover]'
 $tooltipSelector = '[data-toggle=tooltip]'
 $packages = array()
 $cs
 $_assetsUrl

Protected Member Functions

 isInConsoleMode ()
 isInTests ()
 setRootAliasIfUndefined ()
 includeAssets ()
 appendUserSuppliedPackagesToOurs ()
 addOurPackagesToYii ()
 registerCssPackagesIfEnabled ()
 registerJsPackagesIfEnabled ()
 setAssetsRegistryIfNotDefined ()
 createBootstrapCssPackage ()
 createSelect2Package ()
 registerMetadataForResponsive ()
 tryGetSelectorForPlugin ($name)
 tryGetOptionsForPlugin ($name)

Static Private Attributes

static $_instance

Detailed Description

Definition at line 42 of file Booster.php.

Member Function Documentation

Booster::addOurPackagesToYii ( )
protected

Definition at line 273 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::appendUserSuppliedPackagesToOurs ( )
protected

Definition at line 258 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::createBootstrapCssPackage ( )
protected

We use the values of $this->responsiveCss, $this->fontAwesomeCss, $this->minify and $this->enableCdn to construct the proper package definition and install and register it.

Returns
array

Definition at line 435 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::createSelect2Package ( )
protected

Make select2 package definition

Returns
array

Definition at line 447 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::getAssetsUrl ( )

Returns the URL to the published assets folder.

Returns
string an absolute URL to the published asset

Definition at line 408 of file Booster.php.

Here is the caller graph for this function:

static Booster::getBooster ( )
static
Returns
Bootstrap
Since
2.1.0

Definition at line 546 of file Booster.php.

Here is the caller graph for this function:

Booster::getUniqueScriptId ( )

Generates a "somewhat" random id string.

Returns
string
Since
1.1.0

Definition at line 508 of file Booster.php.

Here is the caller graph for this function:

Booster::getVersion ( )

Returns the extension version number.

Returns
string the version

Definition at line 359 of file Booster.php.

Booster::includeAssets ( )
protected

Definition at line 244 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::init ( )

Initializes the component.

Definition at line 202 of file Booster.php.

Here is the call graph for this function:

Booster::isInConsoleMode ( )
protected
Returns
bool

Definition at line 220 of file Booster.php.

Here is the caller graph for this function:

Booster::isInTests ( )
protected
Returns
bool

Definition at line 226 of file Booster.php.

Here is the caller graph for this function:

Booster::registerAssetCss (   $name,
  $media = '' 
)

Registers a CSS file in the asset's css folder

Parameters
string$namethe css file name to register
string$mediamedia that the CSS file should be applied to. If empty, it means all media types.
See Also
CClientScript::registerCssFile

Definition at line 386 of file Booster.php.

Here is the call graph for this function:

Booster::registerAssetJs (   $name,
  $position = CClientScript::POS_END 
)

Register a javascript file in the asset's js folder

Parameters
string$namethe js file name to register
int$positionthe position of the JavaScript code.
See Also
CClientScript::registerScriptFile

Definition at line 399 of file Booster.php.

Here is the call graph for this function:

Booster::registerBootstrapCss ( )

Definition at line 424 of file Booster.php.

Here is the caller graph for this function:

Booster::registerCssPackagesIfEnabled ( )
protected

If we did not disabled registering CSS packages, register them.

Definition at line 284 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerFontAwesomeCss ( )

Registers the Font Awesome CSS.

Since
1.0.6

Definition at line 490 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerJQueryCss ( )

Register the compatibility layer for jQuery UI + Twitter Bootstrap 2.3 combo

Definition at line 321 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerJsPackagesIfEnabled ( )
protected

If enableJS is not false, register our Javascript packages

Definition at line 330 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerMetadataForResponsive ( )
protected

Required metadata for responsive CSS to work.

Definition at line 479 of file Booster.php.

Here is the caller graph for this function:

Booster::registerPackage (   $name)

Registers a script package that is listed in packages.

Parameters
string$namethe name of the script package.
Returns
CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
See Also
CClientScript::registerPackage
Since
1.0.7

Definition at line 373 of file Booster.php.

Here is the caller graph for this function:

Booster::registerPopoverJs ( )

Definition at line 495 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerTooltipJs ( )

Definition at line 499 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::registerYiiCss ( )

Register our overrides for jQuery UI + Twitter Bootstrap 2.3 combo

Since
0.9.11

Definition at line 313 of file Booster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Booster::setAssetsRegistryIfNotDefined ( )
protected

Definition at line 417 of file Booster.php.

Here is the caller graph for this function:

static Booster::setBooster (   $value)
static
Parameters
Bootstrap$value
Since
2.1.0

Definition at line 535 of file Booster.php.

Here is the caller graph for this function:

Booster::setRootAliasIfUndefined ( )
protected

Definition at line 234 of file Booster.php.

Here is the caller graph for this function:

Booster::tryGetOptionsForPlugin (   $name)
protected
Parameters
$name
Returns
mixed

Definition at line 526 of file Booster.php.

Booster::tryGetSelectorForPlugin (   $name)
protected
Parameters
$name
Returns
mixed

Definition at line 517 of file Booster.php.

Member Data Documentation

Booster::$_assetsUrl

Definition at line 192 of file Booster.php.

Booster::$_instance
staticprivate

Definition at line 197 of file Booster.php.

Booster::$ajaxCssLoad = false

Definition at line 128 of file Booster.php.

Booster::$ajaxJsLoad = false

Definition at line 134 of file Booster.php.

Booster::$bootstrapCss = true

Definition at line 63 of file Booster.php.

Booster::$coreCss = true

Definition at line 57 of file Booster.php.

Booster::$cs

Definition at line 187 of file Booster.php.

Booster::$disableZooming = false

Definition at line 76 of file Booster.php.

Booster::$enableBootboxJS = true

Definition at line 114 of file Booster.php.

Booster::$enableCdn = false

Definition at line 51 of file Booster.php.

Booster::$enableJS = true

Definition at line 108 of file Booster.php.

Booster::$enableNotifierJS = true

Definition at line 122 of file Booster.php.

Booster::$enablePopover = true

Definition at line 145 of file Booster.php.

Booster::$enableTooltip = true

Definition at line 147 of file Booster.php.

Booster::$fontAwesomeCss = false

Definition at line 84 of file Booster.php.

Booster::$forceCopyAssets = false

Definition at line 143 of file Booster.php.

Booster::$jqueryCss = true

Definition at line 102 of file Booster.php.

Booster::$minify = true

Definition at line 89 of file Booster.php.

Booster::$packages = array()

Definition at line 181 of file Booster.php.

Booster::$popoverSelector = '[data-toggle=popover]'

Definition at line 158 of file Booster.php.

Booster::$responsiveCss = true

Definition at line 69 of file Booster.php.

Booster::$tooltipSelector = '[data-toggle=tooltip]'

Definition at line 171 of file Booster.php.

Booster::$yiiCss = true

Definition at line 97 of file Booster.php.


The documentation for this class was generated from the following file: