AssetBundle

API reference › yii › web › AssetBundle

class	`yii\web\AssetBundle`
Extends	`yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/web/AssetBundle.php`

14 subclasses

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.

Properties

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

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`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()` static	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.	`AssetBundle`
`publish()`	Publishes the asset bundle if its source code is not under Web-accessible directory.	`AssetBundle`
`register()` static	Registers this asset bundle with a view.	`AssetBundle`
`registerAssetFiles()`	Registers the CSS and JS files with the given view.	`AssetBundle`

Property details

$basePath

public string|null $basePath = null

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

public string|null $baseUrl = null

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

public array<string|array<array-key, mixed>> $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.

$depends

public array<class-string> $depends = []

List of bundle class names that this bundle depends on.

For example:

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

$js

public array<string|array<array-key, mixed>> $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, https://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.

$publishOptions

public yii\web\PublishOptions $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

public string|null $sourcePath = null

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.

Method details

init()

public function init(): mixed

Initializes the bundle.

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

Returns

mixed

publish()

public function publish(yii\web\AssetManager $am): mixed

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.

Parameters

Parameter	Type	Description
`$am`	`AssetManager`	The asset manager to perform the asset publishing

Returns

mixed

register()

public static function register(yii\web\View $view): static

Registers this asset bundle with a view.

Parameters

Parameter	Type	Description
`$view`	`View`	The view to be registered with

Returns

static: The registered asset bundle instance

registerAssetFiles()

public function registerAssetFiles(yii\web\View $view): mixed

Registers the CSS and JS files with the given view.

Parameters

Parameter	Type	Description
`$view`	`View`	The view that the asset files are to be registered with.

Returns

mixed