# Class yii\web\AssetBundle

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|null | 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

Hide inherited properties

$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, `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.

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.

See also $publishOptions.

public string|null $sourcePath = null

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

- Initializes the object with the given configuration `$config`.
- Call init().

If this method is overridden in a child class, it is recommended that

- the last parameter of the constructor is a configuration array, like `$config` here.
- call the parent implementation at the end of the constructor.

public void __construct ( $config = [] )
$config | array | Name-value pairs that will be used to initialize the object properties

Source code

                    public function __construct($config = [])
    {
        if (!empty($config)) {
            Yii::configure($this, $config);
        }
        $this->init();
    }

__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$value = $object->property;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter();
        } elseif (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `isset($object->property)`.

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set (not null).

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        return false;
    }

__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$object->property = $value;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter($value);
        } elseif (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        } else {
            throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
        }
    }

__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `unset($object->property)`.

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
        } elseif (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
        }
    }

canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true)
    {
        return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
    }

canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true)
    {
        return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function `method_exists()`. You may override this method when you implemented the php magic method `__call()`.

public boolean hasMethod ( $name )
$name | string | The method name
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name)
    {
        return method_exists($this, $name);
    }

hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true)
    {
        return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
    }

init() public method

Initializes the bundle.

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

public void init ( )

Source code

                    public function init()
    {
        if ($this->sourcePath !== null) {
            $this->sourcePath = rtrim(Yii::getAlias($this->sourcePath), '/\\');
        }
        if ($this->basePath !== null) {
            $this->basePath = rtrim(Yii::getAlias($this->basePath), '/\\');
        }
        if ($this->baseUrl !== null) {
            $this->baseUrl = rtrim(Yii::getAlias($this->baseUrl), '/');
        }
    }

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

Source code

                    public function publish($am)
    {
        if ($this->sourcePath !== null && !isset($this->basePath, $this->baseUrl)) {
            list($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
        }
        if (isset($this->basePath, $this->baseUrl) && ($converter = $am->getConverter()) !== null) {
            foreach ($this->js as $i => $js) {
                if (is_array($js)) {
                    $file = array_shift($js);
                    if (Url::isRelative($file)) {
                        $js = ArrayHelper::merge($this->jsOptions, $js);
                        array_unshift($js, $converter->convert($file, $this->basePath));
                        $this->js[$i] = $js;
                    }
                } elseif (Url::isRelative($js)) {
                    $this->js[$i] = $converter->convert($js, $this->basePath);
                }
            }
            foreach ($this->css as $i => $css) {
                if (is_array($css)) {
                    $file = array_shift($css);
                    if (Url::isRelative($file)) {
                        $css = ArrayHelper::merge($this->cssOptions, $css);
                        array_unshift($css, $converter->convert($file, $this->basePath));
                        $this->css[$i] = $css;
                    }
                } elseif (Url::isRelative($css)) {
                    $this->css[$i] = $converter->convert($css, $this->basePath);
                }
            }
        }
    }

register() public static method

Registers this asset bundle with a view.

public static static register ( $view )
$view | yii\web\View | The view to be registered with
return | yii\web\AssetBundle | The registered asset bundle instance

Source code

                    public static function register($view)
    {
        return $view->registerAssetBundle(get_called_class());
    }

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.

Source code

                    public function registerAssetFiles($view)
    {
        $manager = $view->getAssetManager();
        foreach ($this->js as $js) {
            if (is_array($js)) {
                $file = array_shift($js);
                $options = ArrayHelper::merge($this->jsOptions, $js);
                $view->registerJsFile($manager->getAssetUrl($this, $file, ArrayHelper::getValue($options, 'appendTimestamp')), $options);
            } elseif ($js !== null) {
                $view->registerJsFile($manager->getAssetUrl($this, $js), $this->jsOptions);
            }
        }
        foreach ($this->css as $css) {
            if (is_array($css)) {
                $file = array_shift($css);
                $options = ArrayHelper::merge($this->cssOptions, $css);
                $view->registerCssFile($manager->getAssetUrl($this, $file, ArrayHelper::getValue($options, 'appendTimestamp')), $options);
            } elseif ($css !== null) {
                $view->registerCssFile($manager->getAssetUrl($this, $css), $this->cssOptions);
            }
        }
    }