QuickPostAsset

Type
Class
Namespace
craft\web\assets\quickpost
Inherits
craft\web\assets\quickpost\QuickPostAsset » craft\web\AssetBundle » yii\web\AssetBundle (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)

Asset bundle for Quick Post widgets

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 array (opens new window) – List of bundle class names that this bundle depends on.
js 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 string (opens new window) – The directory that contains the source asset files for this asset bundle.

# depends

Type
array (opens new window)
Default value
[\craft\web\assets\cp\CpAsset::class]

List of bundle class names that this bundle depends on.

For example:

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

View source (opens new window)

# js

Type
array (opens new window)
Default value
['QuickPostWidget.min.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, 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 (opens new window) to the relative path, and the actual URL of the asset can be determined by prefixing baseUrl (opens new window) 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 (opens new window) 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.

View source (opens new window)

# sourcePath

Type
string (opens new window)
Default value
__DIR__ . '/dist'

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, \craft\web\assets\quickpost\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 (opens new window).

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

View source (opens new window)

# 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() (opens new window) Initializes the object.
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.

# registerAssetFiles()

Registers the CSS and JS files with the given view.

View source (opens new window)

Arguments

# 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