PHP Class AssetManager

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

Méthodes publiques

Свойство Type Description
$isAjaxRequest boolean Is the current request an AJAX request.
$isPrintRequest boolean Is the current request a print request.
$scriptMapping

Protected Properties

Свойство 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.

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode 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 méthode

(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 méthode

(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 méthode

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 méthode

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.
Résultat boolean Whether the asset should be output.

createUrl() public méthode

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'
Résultat string The absolute path to the published asset.

getClientScript() public méthode

public getClientScript ( ) : ClientScript
Résultat ClientScript

getPublishedPath() public méthode

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.
Résultat string The absolute path.

getPublishedPathOfAlias() public méthode

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

init() public méthode

Initializes the component.
public init ( )

registerCoreCssFile() public méthode

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 méthode

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

registerCssFile() public méthode

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 méthode

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

registerOrderedCssFiles() protected méthode

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

registerOrderedScriptFiles() protected méthode

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

registerScriptFile() public méthode

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 méthode

public reset ( )

setCacheBuster() public méthode

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

setClientScript() public méthode

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

sort() protected méthode

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

Property Details

$cacheBuster protected_oe property

CacheBuster component reference.
protected CacheBuster $cacheBuster
Résultat CacheBuster

$clientScript protected_oe property

ClientScript component reference.
protected ClientScript $clientScript
Résultat ClientScript

$css protected_oe property

Pre-registered css files.
protected array $css
Résultat array

$cssPriority protected_oe property

Default starting css priority.
protected int $cssPriority
Résultat integer

$isAjaxRequest public_oe property

Is the current request an AJAX request.
public bool $isAjaxRequest
Résultat boolean

$isPrintRequest public_oe property

Is the current request a print request.
public bool $isPrintRequest
Résultat boolean

$js protected_oe property

Pre-registered script files.
protected array $js
Résultat array

$jsPriority protected_oe property

Default starting script priority.
protected int $jsPriority
Résultat integer

$scriptMapping public_oe static_oe property

public static $scriptMapping