Class yii\web\AssetBundle

All Classes | Properties | Methods

Inheritance	yii\web\AssetBundle » yii\base\BaseObject
Implements	yii\base\Configurable
Subclasses	yii\apidoc\templates\bootstrap\assets\AssetBundle, yii\apidoc\templates\bootstrap\assets\HighlightBundle, yii\apidoc\templates\bootstrap\assets\JsSearchAsset, yii\authclient\widgets\AuthChoiceAsset, yii\authclient\widgets\AuthChoiceStyleAsset, yii\bootstrap\BootstrapAsset, yii\bootstrap\BootstrapPluginAsset, yii\bootstrap\BootstrapThemeAsset, yii\captcha\CaptchaAsset, yii\debug\DbAsset, yii\debug\DebugAsset, yii\debug\TimelineAsset, yii\debug\UserswitchAsset, yii\gii\GiiAsset, yii\grid\GridViewAsset, yii\jui\DatePickerLanguageAsset, yii\jui\JuiAsset, yii\validators\PunycodeAsset, yii\validators\ValidationAsset, yii\web\JqueryAsset, yii\web\YiiAsset, yii\widgets\ActiveFormAsset, yii\widgets\MaskedInputAsset, yii\widgets\PjaxAsset
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/web/AssetBundle.php

AssetBundle represents a collection of asset files, such as CSS, JS, images.

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.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$basePath	string	The Web-accessible directory that contains the asset files in this bundle.	yii\web\AssetBundle
$baseUrl	string	The base URL for the relative asset files listed in $js and $css.	yii\web\AssetBundle
$css	array	List of CSS files that this bundle contains.	yii\web\AssetBundle
$cssOptions	array	The options that will be passed to yii\web\View::registerCssFile() when registering the CSS files in this bundle.	yii\web\AssetBundle
$depends	array	List of bundle class names that this bundle depends on.	yii\web\AssetBundle
$js	array	List of JavaScript files that this bundle contains.	yii\web\AssetBundle
$jsOptions	array	The options that will be passed to yii\web\View::registerJsFile() when registering the JS files in this bundle.	yii\web\AssetBundle
$publishOptions	array	The options to be passed to yii\web\AssetManager::publish() when the asset bundle is being published.	yii\web\AssetBundle
$sourcePath	string	The directory that contains the source asset files for this asset bundle.	yii\web\AssetBundle

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the bundle.	yii\web\AssetBundle
publish()	Publishes the asset bundle if its source code is not under Web-accessible directory.	yii\web\AssetBundle
register()	Registers this asset bundle with a view.	yii\web\AssetBundle
registerAssetFiles()	Registers the CSS and JS files with the given view.	yii\web\AssetBundle

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 yii\web\AssetManager when it publishes the asset files from $sourcePath.

You can use either a directory or an alias of the directory.

public string $basePath = null

$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 yii\web\AssetManager when it publishes the asset files from $sourcePath.

You can use either a URL or an alias of the URL.

public string $baseUrl = null

$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 array $css = []

$cssOptions public property

The options that will be passed to yii\web\View::registerCssFile() when registering the CSS files in this bundle.

public array $cssOptions = []

$depends public property

List of bundle class names that this bundle depends on.

For example:

public $depends = [
   'yii\web\YiiAsset',
   'yii\bootstrap\BootstrapAsset',
];

public array $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 array $js = []

$jsOptions public property

The options that will be passed to yii\web\View::registerJsFile() when registering the JS files in this bundle.

public array $jsOptions = []

$publishOptions public property

The options to be passed to yii\web\AssetManager::publish() when the asset bundle is being published. This property is used only when $sourcePath is set.

public array $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, yii\web\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.

Method Details

init() public method

Initializes the bundle.

If you override this method, make sure you call the parent implementation in the last.

public void init ( )

publish() public method

Publishes the asset bundle if its source code is not under Web-accessible directory.

It will also try to convert non-CSS or JS files (e.g. LESS, Sass) into the corresponding CSS or JS files using asset converter.

public void publish ( $am )
$am	yii\web\AssetManager	The asset manager to perform the asset publishing

Registers this asset bundle with a view.

public static static register ( $view )
$view	yii\web\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 void registerAssetFiles ( $view )
$view	yii\web\View	The view that the asset files are to be registered with.