CommerceCpAsset
- Type
- Class
- Namespace
- craft\commerce\web\assets\commercecp
- Inherits
- craft\commerce\web\assets\commercecp\CommerceCpAsset » craft\web\AssetBundle (opens new window) » yii\web\AssetBundle (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Asset bundle for the Control Panel
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| basePath (opens new window) | string (opens new window) – The Web-accessible directory that contains the asset files in this bundle. |
| baseUrl (opens new window) | string (opens new window) – The base URL for the relative asset files listed in js (opens new window) and css (opens new window). |
| css (opens new window) | array (opens new window) – List of CSS files that this bundle contains. |
| cssOptions (opens new window) | array (opens new window) – The options that will be passed to yii\web\View::registerCssFile() (opens new window) when registering the CSS files in this bundle. |
| depends (opens new window) | array (opens new window) – List of bundle class names that this bundle depends on. |
| js (opens new window) | array (opens new window) – List of JavaScript files that this bundle contains. |
| jsOptions (opens new window) | array (opens new window) – The options that will be passed to yii\web\View::registerJsFile() (opens new window) when registering the JS files in this bundle. |
| publishOptions (opens new window) | array (opens new window) – The options to be passed to yii\web\AssetManager::publish() (opens new window) when the asset bundle is being published. |
| sourcePath (opens new window) | string (opens new window) – The directory that contains the source asset files for this asset bundle. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() | Initializes the bundle. |
| publish() (opens new window) | Publishes the asset bundle if its source code is not under Web-accessible directory. |
| register() (opens new window) | Registers this asset bundle with a view. |
| registerAssetFiles() | Registers the CSS and JS files with the given view. |
# init()
Initializes the bundle.
If you override this method, make sure you call the parent implementation in the last.
View source (opens new window)
# registerAssetFiles()
Registers the CSS and JS files with the given view.
View source (opens new window)
Arguments
$view(yii\web\View (opens new window)) – The view that the asset files are to be registered with.
# Protected Methods
| Method | Description |
|---|---|
| dotJs() (opens new window) | Returns '.min.js' if Craft is configured to serve compressed JavaScript files, otherwise '.js'. |
| useCompressedJs() (opens new window) | Returns whether Craft is configured to serve compressed JavaScript files |