PHP Class yii\web\AssetBundle

Each asset bundle has a unique name that globally identifies it among all asset bundles used in an application. The name is the fully qualified class name of the class representing it. An asset bundle can depend on other asset bundles. When registering an asset bundle with a view, all its dependent asset bundles will be automatically registered. For more details and usage information on AssetBundle, see the guide article on assets.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends yii\base\Object
Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$basePath the Web-accessible directory that contains the asset files in this bundle. If [[sourcePath]] is set, this property will be *overwritten* by AssetManager when it publishes the asset files from [[sourcePath]]. You can use either a directory or an alias of the directory.
$baseUrl the base URL for the relative asset files listed in [[js]] and [[css]]. If [[sourcePath]] is set, this property will be *overwritten* by AssetManager when it publishes the asset files from [[sourcePath]]. You can use either a URL or an alias of the URL.
$css list of CSS files that this bundle contains. Each CSS file can be specified in one of the three formats as explained in [[js]]. Note that only a forward slash "/" should be used as directory separator.
$cssOptions the options that will be passed to [[View::registerCssFile()]] when registering the CSS files in this bundle.
$depends list of bundle class names that this bundle depends on. For example: php public $depends = [ 'yii\web\YiiAsset', 'yii\bootstrap\BootstrapAsset', ];
$js list of JavaScript files that this bundle contains. Each JavaScript file can be specified in one of the following formats: - an absolute URL representing an external asset. For example, http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js or //ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js. - a relative path representing a local asset (e.g. js/main.js). The actual file path of a local asset can be determined by prefixing [[basePath]] to the relative path, and the actual URL of the asset can be determined by prefixing [[baseUrl]] to the relative path. - an array, with the first entry being the URL or relative path as described before, and a list of key => value pairs that will be used to overwrite [[jsOptions]] settings for this entry. This functionality is available since version 2.0.7. Note that only a forward slash "/" should be used as directory separator.
$jsOptions the options that will be passed to [[View::registerJsFile()]] when registering the JS files in this bundle.
$publishOptions the options to be passed to [[AssetManager::publish()]] when the asset bundle is being published. This property is used only when [[sourcePath]] is set.
$sourcePath the directory that contains the source asset files for this asset bundle. A source asset file is a file that is part of your source code repository of your Web application. You must set this property if the directory containing the source asset files is not Web accessible. By setting this property, AssetManager will publish the source asset files to a Web-accessible directory automatically when the asset bundle is registered on a page. If you do not set this property, it means the source asset files are located under [[basePath]]. You can use either a directory or an alias of the directory.

Public Methods

Method Description
init ( ) Initializes the bundle.
publish ( AssetManager $am ) Publishes the asset bundle if its source code is not under Web-accessible directory.
register ( View $view ) : static Registers this asset bundle with a view.
registerAssetFiles ( View $view ) Registers the CSS and JS files with the given view.

Method Details

init() public method

If you override this method, make sure you call the parent implementation in the last.
public init ( )

publish() public method

It will also try to convert non-CSS or JS files (e.g. LESS, Sass) into the corresponding CSS or JS files using [[AssetManager::converter|asset converter]].
public publish ( AssetManager $am )
$am AssetManager the asset manager to perform the asset publishing

register() public static method

Registers this asset bundle with a view.
public static register ( View $view ) : static
$view View the view to be registered with
return static the registered asset bundle instance

registerAssetFiles() public method

Registers the CSS and JS files with the given view.
public registerAssetFiles ( View $view )
$view View the view that the asset files are to be registered with.

Property Details

$basePath public property

the Web-accessible directory that contains the asset files in this bundle. If [[sourcePath]] is set, this property will be *overwritten* by AssetManager when it publishes the asset files from [[sourcePath]]. You can use either a directory or an alias of the directory.
public $basePath

$baseUrl public property

the base URL for the relative asset files listed in [[js]] and [[css]]. If [[sourcePath]] is set, this property will be *overwritten* by AssetManager when it publishes the asset files from [[sourcePath]]. You can use either a URL or an alias of the URL.
public $baseUrl

$css public property

list of CSS files that this bundle contains. Each CSS file can be specified in one of the three formats as explained in [[js]]. Note that only a forward slash "/" should be used as directory separator.
public $css

$cssOptions public property

the options that will be passed to [[View::registerCssFile()]] when registering the CSS files in this bundle.
public $cssOptions

$depends public property

list of bundle class names that this bundle depends on. For example: php public $depends = [ 'yii\web\YiiAsset', 'yii\bootstrap\BootstrapAsset', ];
public $depends

$js public property

list of JavaScript files that this bundle contains. Each JavaScript file can be specified in one of the following formats: - an absolute URL representing an external asset. For example, http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js or //ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js. - a relative path representing a local asset (e.g. js/main.js). The actual file path of a local asset can be determined by prefixing [[basePath]] to the relative path, and the actual URL of the asset can be determined by prefixing [[baseUrl]] to the relative path. - an array, with the first entry being the URL or relative path as described before, and a list of key => value pairs that will be used to overwrite [[jsOptions]] settings for this entry. This functionality is available since version 2.0.7. Note that only a forward slash "/" should be used as directory separator.
public $js

$jsOptions public property

the options that will be passed to [[View::registerJsFile()]] when registering the JS files in this bundle.
public $jsOptions

$publishOptions public property

the options to be passed to [[AssetManager::publish()]] when the asset bundle is being published. This property is used only when [[sourcePath]] is set.
public $publishOptions

$sourcePath public property

the directory that contains the source asset files for this asset bundle. A source asset file is a file that is part of your source code repository of your Web application. You must set this property if the directory containing the source asset files is not Web accessible. By setting this property, AssetManager will publish the source asset files to a Web-accessible directory automatically when the asset bundle is registered on a page. If you do not set this property, it means the source asset files are located under [[basePath]]. You can use either a directory or an alias of the directory.
public $sourcePath