AbstractLocalAsset
API reference › FilePond › asset › AbstractLocalAsset
2 subclasses
Provides readable or minified delivery for the scripts and stylesheets shipped inside this package.
Subclasses list the readable file names; the minified copies are generated next to them by npm run build with a
.min infix and are served when $minified is enabled. Both variants are published so changing the delivery
mode can reuse an existing asset directory.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$basePath | string| | The Web-accessible directory that contains the asset files in this bundle. Default: null. | yii\ |
$baseUrl | string| | The base URL for the relative asset files listed in $js and $css. Default: null. | yii\ |
$css | array<string| | List of CSS files that this bundle contains. Default: []. | yii\ |
$cssOptions | yii\ | The options that will be passed to View::registerCssFile() when registering the CSS files in this bundle. Default: []. | yii\ |
$depends | array<class-string> | List of bundle class names that this bundle depends on. Default: []. | yii\ |
$js | array<string| | List of JavaScript files that this bundle contains. Default: []. | yii\ |
$jsOptions | yii\ | The options that will be passed to View::registerJsFile() when registering the JS files in this bundle. Default: []. | yii\ |
$minified | bool| | Whether to serve the minified files, or null to serve them outside debug mode. Default: null. | AbstractLocalAsset |
$publishOptions | yii\ | The options to be passed to AssetManager::publish() when the asset bundle is being published. Default: []. | yii\ |
$sourcePath | string| | The directory that contains the source asset files for this asset bundle. Default: null. | yii\ |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Constructor. | yii\ |
__call() | Calls the named method which is not a class method. | yii\ |
__get() | Returns the value of an object property. | yii\ |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
__set() | Sets value of an object property. | yii\ |
__unset() | Sets an object property to null. | yii\ |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
className() static | Returns the fully qualified name of this class. | yii\ |
hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
hasProperty() | Returns a value indicating whether a property is defined. | yii\ |
init() | Initializes the bundle file lists for the configured build. | AbstractLocalAsset |
publish() | Publishes the asset bundle if its source code is not under Web-accessible directory. | yii\ |
register() static | Registers this asset bundle with a view. | yii\ |
registerAssetFiles() | Registers the CSS and JS files with the given view. | yii\ |
scripts() protected abstract | Returns the script file names inside $sourcePath, without the .min infix. | AbstractLocalAsset |
styles() protected abstract | Returns the stylesheet file names inside $sourcePath, without the .min infix. | AbstractLocalAsset |
Method details
Section titled “Method details”init()
Section titled “init() ”public function init(): voidInitializes the bundle file lists for the configured build.
scripts()
Section titled “scripts() ”abstract protected function scripts(): list<string>Returns the script file names inside $sourcePath, without the .min infix.
Returns
list<string>: Script file names.
styles()
Section titled “styles() ”abstract protected function styles(): list<string>Returns the stylesheet file names inside $sourcePath, without the .min infix.
Returns
list<string>: Stylesheet file names.