PHP Класс AssetManager

You can access this class instance via: Yii::app()->getAssetManager() or Yii::app()->assetManager.
Наследование: extends CAssetManager
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$isAjaxRequest boolean Is the current request an AJAX request.
$isPrintRequest boolean Is the current request a print request.
$scriptMapping

Защищенные свойства (Protected)

Свойство Тип Описание
$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.

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
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.

Описание методов

addOrderedCssFile() защищенный Метод

(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() защищенный Метод

(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() публичный Метод

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() защищенный Метод

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.
Результат boolean Whether the asset should be output.

createUrl() публичный Метод

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'
Результат string The absolute path to the published asset.

getClientScript() публичный Метод

public getClientScript ( ) : ClientScript
Результат ClientScript

getPublishedPath() публичный Метод

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.
Результат string The absolute path.

getPublishedPathOfAlias() публичный Метод

Returns the published asset path for a given asset directory alias.
public getPublishedPathOfAlias ( string $alias = null ) : string
$alias string The alias to the assets.
Результат string The publish assets path.

init() публичный Метод

Initializes the component.
public init ( )

registerCoreCssFile() публичный Метод

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() публичный Метод

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

registerCssFile() публичный Метод

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() публичный Метод

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

registerOrderedCssFiles() защищенный Метод

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

registerOrderedScriptFiles() защищенный Метод

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

registerScriptFile() публичный Метод

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 reset ( )

setCacheBuster() публичный Метод

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

setClientScript() публичный Метод

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

sort() защищенный Метод

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

Описание свойств

$cacheBuster защищенное свойство

CacheBuster component reference.
protected CacheBuster $cacheBuster
Результат CacheBuster

$clientScript защищенное свойство

ClientScript component reference.
protected ClientScript $clientScript
Результат ClientScript

$css защищенное свойство

Pre-registered css files.
protected array $css
Результат array

$cssPriority защищенное свойство

Default starting css priority.
protected int $cssPriority
Результат integer

$isAjaxRequest публичное свойство

Is the current request an AJAX request.
public bool $isAjaxRequest
Результат boolean

$isPrintRequest публичное свойство

Is the current request a print request.
public bool $isPrintRequest
Результат boolean

$js защищенное свойство

Pre-registered script files.
protected array $js
Результат array

$jsPriority защищенное свойство

Default starting script priority.
protected int $jsPriority
Результат integer

$scriptMapping публичное статическое свойство

public static $scriptMapping