UpgradeAsset ​
- Type
- Class
- Namespace
- craft\web\assets\upgrade
- Inherits
- craft\web\assets\upgrade\UpgradeAsset » craft\web\AssetBundle » yii\web\AssetBundle » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.7.40
Asset bundle for the Upgrade utility
Public Properties ​
| Property | Description |
|---|---|
| basePath | string – The Web-accessible directory that contains the asset files in this bundle. |
| baseUrl | string – The base URL for the relative asset files listed in js and css. |
| css | array – List of CSS files that this bundle contains. |
| cssOptions | array – The options that will be passed to yii\web\View::registerCssFile() when registering the CSS files in this bundle. |
| depends | array – List of bundle class names that this bundle depends on. |
| js | array – List of JavaScript files that this bundle contains. |
| jsOptions | array – The options that will be passed to yii\web\View::registerJsFile() when registering the JS files in this bundle. |
| publishOptions | array – The options to be passed to yii\web\AssetManager::publish() when the asset bundle is being published. |
| sourcePath | string, null – The directory that contains the source asset files for this asset bundle. |
css ​
- Type
- array
- Default value
[ 'css/UpgradeUtility.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.
depends ​
- Type
- array
- Default value
[ \craft\web\assets\cp\CpAsset::class, ]
List of bundle class names that this bundle depends on.
js ​
- Type
- array
- Default value
[ 'UpgradeUtility.js', ]
List of JavaScript files that this bundle contains. Each JavaScript file can be specified in one of the following formats:
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.
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the bundle. |
| publish() | Publishes the asset bundle if its source code is not under Web-accessible directory. |
| register() | Registers this asset bundle with a view. |
| registerAssetFiles() | Registers the CSS and JS files with the given view. |
registerAssetFiles() ​
Registers the CSS and JS files with the given view.
Arguments ​
$view(yii\web\View) – The view that the asset files are to be registered with.
Protected Methods ​
| Method | Description |
|---|---|
| dotJs() | Returns '.min.js' if Craft is configured to serve compressed JavaScript files, otherwise '.js'. |
| useCompressedJs() | Returns whether Craft is configured to serve compressed JavaScript files |