AbstractPluginAsset

API reference › FilePond › asset › AbstractPluginAsset

abstract class	`yii2\extensions\filepond\asset\AbstractPluginAsset`
Extends	`AbstractNpmAsset` » `yii\web\AssetBundle` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Source	`src/asset/AbstractPluginAsset.php`

11 subclasses

Provides local or CDN delivery for a FilePond plugin distribution.

Concrete bundles only declare the Plugin case they deliver; file names and dependencies derive from it.

Properties

Property	Type	Description	Defined by
`$basePath`	`string\|null`	The Web-accessible directory that contains the asset files in this bundle. Default: `null`.	`yii\web\AssetBundle`
`$baseUrl`	`string\|null`	The base URL for the relative asset files listed in `$js` and `$css`. Default: `null`.	`yii\web\AssetBundle`
`$cdn`	`bool`	Whether to link the files from the CDN instead of publishing the local package. Default: `false`.	`AbstractNpmAsset`
`$cdnUrl`	`string`	Base URL of the CDN serving npm packages as `{cdnUrl}/{package}@{version}/dist/{file}`. Default: `'https://unpkg.com'`.	`AbstractNpmAsset`
`$css`	`array<string\|array<array-key, mixed>>`	List of CSS files that this bundle contains. Default: `[]`.	`yii\web\AssetBundle`
`$cssOptions`	`yii\web\RegisterCssFileOptions`	The options that will be passed to `View::registerCssFile()` when registering the CSS files in this bundle. Default: `[]`.	`yii\web\AssetBundle`
`$depends`	`array<class-string>`	List of bundle class names that this bundle depends on. Default: `[]`.	`yii\web\AssetBundle`
`$js`	`array<string\|array<array-key, mixed>>`	List of JavaScript files that this bundle contains. Default: `[]`.	`yii\web\AssetBundle`
`$jsOptions`	`yii\web\RegisterJsFileOptions`	The options that will be passed to `View::registerJsFile()` when registering the JS files in this bundle. Default: `[]`.	`yii\web\AssetBundle`
`$minified`	`bool\|null`	Whether to serve the minified `dist` files, or `null` to serve them outside debug mode. Default: `null`.	`AbstractNpmAsset`
`$publishOptions`	`yii\web\PublishOptions`	The options to be passed to `AssetManager::publish()` when the asset bundle is being published. Default: `[]`.	`yii\web\AssetBundle`
`$sourcePath`	`string\|null`	The directory that contains the source asset files for this asset bundle. Default: `null`.	`yii\web\AssetBundle`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`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()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`dependencies()` static		`AbstractPluginAsset`
`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 file lists for the configured delivery mode.	`AbstractNpmAsset`
`plugin()` abstract	Returns the plugin delivered by this bundle.	`AbstractPluginAsset`
`publish()`	Publishes the asset bundle if its source code is not under Web-accessible directory.	`yii\web\AssetBundle`
`register()` static	Registers this asset bundle with a view.	`yii\web\AssetBundle`
`registerAssetFiles()`	Registers the CSS and JS files with the given view.	`yii\web\AssetBundle`
`registerWith()` static	Registers the bundle, and its npm-backed dependencies, with the given delivery mode.	`AbstractNpmAsset`
`package()` protected		`AbstractPluginAsset`
`scripts()` protected		`AbstractPluginAsset`
`styles()` protected		`AbstractPluginAsset`

Method details

dependencies()

public static function dependencies(): array

Returns

array

plugin()

abstract public function plugin(): yii2\extensions\filepond\asset\Plugin

Returns the plugin delivered by this bundle.

Returns

Plugin: Delivered plugin.

package()

protected function package(): string

Returns

string

scripts()

protected function scripts(): array

Returns

array

styles()

protected function styles(): array

Returns

array