PHP Class AssetManager

You can access this class instance via: Yii::app()->getAssetManager() or Yii::app()->assetManager.
Inheritance: extends CAssetManager
Show file Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property Type Description
$isAjaxRequest boolean Is the current request an AJAX request.
$isPrintRequest boolean Is the current request a print request.
$scriptMapping

Protected Properties

Property Type Description
$cacheBuster CacheBuster CacheBuster component reference.
$clientScript ClientScript ClientScript component reference.
$css array Pre-registered css files.
$cssPriority integer Default starting css priority.
$js array Pre-registered script files.
$jsPriority integer Default starting script priority.

Public Methods

Method Description
adjustScriptMapping ( ) Adjust the the client script mapping (for javascript and css files assets).
createUrl ( string $path = null, string $basePathAlias = null, $bustCache = true ) : string Creates an absolute URL to a published asset. Eg: '/path/to/hash/asset.gif?cachebusted'.
getClientScript ( ) : ClientScript
getPublishedPath ( string $path = '', null | string $alias = null ) : string Returns the absolute filesystem path to the published asset.
getPublishedPathOfAlias ( string $alias = null ) : string Returns the published asset path for a given asset directory alias.
init ( ) Initializes the component.
registerCoreCssFile ( string $style = '', null | integer $priority = null, OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL $output = self::OUTPUT_ALL, boolean $preRegister = true ) Register a core style.
registerCoreScript ( string $script = '' ) Register a core (framework) script.
registerCssFile ( string $style = '', null | string | false $basePathAlias = null, null | integer $priority = null, $output = self::OUTPUT_ALL, boolean $preRegister = true ) Register an application style.
registerFiles ( ) Register all assets that were preregistered by priority. This method is required to output the assets in the page.
registerScriptFile ( string $script = '', [type] $basePathAlias = null, [type] $priority = null, $output = self::OUTPUT_ALL, boolean $preRegister = true ) Register an application script.
reset ( )
setCacheBuster ( CacheBuster $cacheBuster ) Set the CacheBuster reference.
setClientScript ( ClientScript $clientScript ) Set the ClientScript reference.

Protected Methods

Method Description
addOrderedCssFile ( string $path, integer $priority = 200, $output = self::OUTPUT_ALL ) (Pre)register a CSS file with a priority to allow ordering.
addOrderedScriptFile ( string $path, integer $priority = 200, $output = self::OUTPUT_ALL ) (Pre)register a JS file with a priority to allow ordering.
canOutput ( OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL $output = null ) : boolean Determines whether an asset should be output for the current request.
registerOrderedCssFiles ( ) Registers all CSS files that were preregistered by priority.
registerOrderedScriptFiles ( ) Registers all JS files that were preregistered by priority.
sort ( array &$arr ) Sorts an array by priority.

Method Details

addOrderedCssFile() protected method

(Pre)register a CSS file with a priority to allow ordering.
protected addOrderedCssFile ( string $path, integer $priority = 200, $output = self::OUTPUT_ALL )
$path string
$priority integer

addOrderedScriptFile() protected method

(Pre)register a JS file with a priority to allow ordering.
protected addOrderedScriptFile ( string $path, integer $priority = 200, $output = self::OUTPUT_ALL )
$path string
$priority integer

adjustScriptMapping() public method

If a Yii widget is being used in an Ajax request, all dependent scripts and stylesheets will be outputted in the response. This method ensures the core scripts and stylesheets are not outputted in an Ajax response.
public adjustScriptMapping ( )

canOutput() protected method

Determines whether an asset should be output for the current request.
protected canOutput ( OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL $output = null ) : boolean
$output OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL The output type.
return boolean Whether the asset should be output.

createUrl() public method

Creates an absolute URL to a published asset. Eg: '/path/to/hash/asset.gif?cachebusted'.
public createUrl ( string $path = null, string $basePathAlias = null, $bustCache = true ) : string
$path string The path to the asset. Eg: 'img/cat.gif'
$basePathAlias string The alias path to the base location of the asset. Eg: 'application.modules.mymodule.assets'
return string The absolute path to the published asset.

getClientScript() public method

public getClientScript ( ) : ClientScript
return ClientScript

getPublishedPath() public method

Returns the absolute filesystem path to the published asset.
public getPublishedPath ( string $path = '', null | string $alias = null ) : string
$path string Relative path to asset.
$alias null | string Alias path to the base location of the asset.
return string The absolute path.

getPublishedPathOfAlias() public method

Returns the published asset path for a given asset directory alias.
public getPublishedPathOfAlias ( string $alias = null ) : string
$alias string The alias to the assets.
return string The publish assets path.

init() public method

Initializes the component.
public init ( )

registerCoreCssFile() public method

Register a core style.
public registerCoreCssFile ( string $style = '', null | integer $priority = null, OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL $output = self::OUTPUT_ALL, boolean $preRegister = true )
$style string The core style string to be registered. Eg: 'dir/file.css'
$priority null | integer The priority for the asset. Higher priority styles will be outputted in the page first.
$output OUTPUT_PRINT | OUTPUT_SCREEN | OUTPUT_AJAX | OUTPUT_ALL The output type.
$preRegister boolean Pre-register the asset (if set to false, priority will be ignored)

registerCoreScript() public method

Register a core (framework) script.
public registerCoreScript ( string $script = '' )
$script string The core script to be registered. Eg: 'jquery'

registerCssFile() public method

Register an application style.
public registerCssFile ( string $style = '', null | string | false $basePathAlias = null, null | integer $priority = null, $output = self::OUTPUT_ALL, boolean $preRegister = true )
$style string The style path. Eg: 'css/style.css'
$basePathAlias null | string | false The alias for the basepath. Eg: 'application.modules.mymodule.assets'
$priority null | integer The priority for the asset. Higher priority styles will be outputted in the page first.
$preRegister boolean Pre-register the asset (if set to false, priority and output will be ignored)

registerFiles() public method

Register all assets that were preregistered by priority. This method is required to output the assets in the page.
public registerFiles ( )

registerOrderedCssFiles() protected method

Registers all CSS files that were preregistered by priority.
protected registerOrderedCssFiles ( )

registerOrderedScriptFiles() protected method

Registers all JS files that were preregistered by priority.
protected registerOrderedScriptFiles ( )

registerScriptFile() public method

Register an application script.
public registerScriptFile ( string $script = '', [type] $basePathAlias = null, [type] $priority = null, $output = self::OUTPUT_ALL, boolean $preRegister = true )
$script string The script path. Eg: 'js/script.js'
$basePathAlias [type]
$priority [type]
$preRegister boolean Pre-register the asset (if set to false, priority and output will be ignored)

reset() public method

public reset ( )

setCacheBuster() public method

Set the CacheBuster reference.
public setCacheBuster ( CacheBuster $cacheBuster )
$cacheBuster CacheBuster The CacheBuster instance.

setClientScript() public method

Set the ClientScript reference.
public setClientScript ( ClientScript $clientScript )
$clientScript ClientScript The ClientScript instance.

sort() protected method

Sorts an array by priority.
protected sort ( array &$arr )
$arr array The array to sort.

Property Details

$cacheBuster protected property

CacheBuster component reference.
protected CacheBuster $cacheBuster
return CacheBuster

$clientScript protected property

ClientScript component reference.
protected ClientScript $clientScript
return ClientScript

$css protected property

Pre-registered css files.
protected array $css
return array

$cssPriority protected property

Default starting css priority.
protected int $cssPriority
return integer

$isAjaxRequest public property

Is the current request an AJAX request.
public bool $isAjaxRequest
return boolean

$isPrintRequest public property

Is the current request a print request.
public bool $isPrintRequest
return boolean

$js protected property

Pre-registered script files.
protected array $js
return array

$jsPriority protected property

Default starting script priority.
protected int $jsPriority
return integer

$scriptMapping public static property

public static $scriptMapping