PHP Class YiiWheels

Author: Antonio Ramirez ([email protected])
Inheritance: extends CApplicationComponent
Show file Open project: 2amigos/yiiwheels

Public Properties

Property Type Description
$assetsCss array of style library names to be registered when initializing the library.
$assetsJs array of javascript library names to be registered when initializing the library.
$htmlOptions the HTML options for the view container tag.

Protected Properties

Property Type Description
$_api TbApi
$_assetsUrl holds the published assets

Public Methods

Method Description
getApi ( ) : TbApi Returns the core library (yiistrap) component
getAssetsUrl ( ) : string Returns the assets URL.
init ( ) Widget's initialization
registerAssetCss ( string $cssFile, string $media = '' ) Registers a specific css in the asset's css folder
registerAssetJs ( string $jsFile, integer $position = CClientScript::POS_END ) Register a specific js file in the asset's js folder

Method Details

getApi() public method

Returns the core library (yiistrap) component
public getApi ( ) : TbApi
return TbApi

getAssetsUrl() public method

Assets folder has few orphan and very useful utility libraries.
public getAssetsUrl ( ) : string
return string

init() public method

Widget's initialization
public init ( )

registerAssetCss() public method

Registers a specific css in the asset's css folder
public registerAssetCss ( string $cssFile, string $media = '' )
$cssFile string the css file name to register
$media string the media that the CSS file should be applied to. If empty, it means all media types.

registerAssetJs() public method

Register a specific js file in the asset's js folder
See also: CClientScript::registerScriptFile
public registerAssetJs ( string $jsFile, integer $position = CClientScript::POS_END )
$jsFile string
$position integer the position of the JavaScript code.

Property Details

$_api protected property

protected TbApi $_api
return TbApi

$_assetsUrl protected property

holds the published assets
protected $_assetsUrl

$assetsCss public property

of style library names to be registered when initializing the library.
public array $assetsCss
return array

$assetsJs public property

of javascript library names to be registered when initializing the library.
public array $assetsJs
return array

$htmlOptions public property

the HTML options for the view container tag.
public $htmlOptions