# FileRenameAsset

> Delivers the FilePond File Rename plugin.

[API reference](/docs/api/index.md) › [FilePond](/docs/extensions/filepond/reference/index.md) › [asset](/docs/extensions/filepond/reference/asset/index.md) › [plugin](/docs/extensions/filepond/reference/asset/plugin/index.md) › FileRenameAsset

| final class | `yii2\extensions\filepond\asset\plugin\FileRenameAsset` |
| --- | --- |
| Extends | [`yii2\extensions\filepond\asset\AbstractPluginAsset`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md) » [`yii2\extensions\filepond\asset\AbstractNpmAsset`](/docs/extensions/filepond/reference/asset/abstractnpmasset/index.md) » [`yii\web\AssetBundle`](/docs/api/yii/web/assetbundle/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Source | [`src/asset/plugin/FileRenameAsset.php`](https://github.com/yii2-extensions/filepond/blob/main/src/asset/plugin/FileRenameAsset.php#L14) |

Delivers the FilePond File Rename plugin.

See also: <https://pqina.nl/filepond/docs/api/plugins/file-rename/>.

## Properties

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

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/baseobject/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/baseobject/index.md#method-__get) | Returns the value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/baseobject/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/baseobject/index.md#method-__set) | Sets value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/baseobject/index.md#method-__unset) | Sets an object property to null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-dependencies"></span>[`dependencies()`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md#method-dependencies) static |  | [`yii2\extensions\filepond\asset\AbstractPluginAsset`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/baseobject/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/baseobject/index.md#method-hasProperty) | Returns a value indicating whether a property is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-init"></span>[`init()`](/docs/extensions/filepond/reference/asset/abstractnpmasset/index.md#method-init) | Initializes the bundle file lists for the configured delivery mode. | [`yii2\extensions\filepond\asset\AbstractNpmAsset`](/docs/extensions/filepond/reference/asset/abstractnpmasset/index.md) |
| [`plugin()`](#method-plugin) |  | `FileRenameAsset` |
| <span id="method-publish"></span>[`publish()`](/docs/api/yii/web/assetbundle/index.md#method-publish) | Publishes the asset bundle if its source code is not under Web-accessible directory. | [`yii\web\AssetBundle`](/docs/api/yii/web/assetbundle/index.md) |
| <span id="method-register"></span>[`register()`](/docs/api/yii/web/assetbundle/index.md#method-register) static | Registers this asset bundle with a view. | [`yii\web\AssetBundle`](/docs/api/yii/web/assetbundle/index.md) |
| <span id="method-registerAssetFiles"></span>[`registerAssetFiles()`](/docs/api/yii/web/assetbundle/index.md#method-registerAssetFiles) | Registers the CSS and JS files with the given view. | [`yii\web\AssetBundle`](/docs/api/yii/web/assetbundle/index.md) |
| <span id="method-registerWith"></span>[`registerWith()`](/docs/extensions/filepond/reference/asset/abstractnpmasset/index.md#method-registerWith) static | Registers the bundle, and its npm-backed dependencies, with the given delivery mode. | [`yii2\extensions\filepond\asset\AbstractNpmAsset`](/docs/extensions/filepond/reference/asset/abstractnpmasset/index.md) |
| <span id="method-package"></span>[`package()`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md#method-package) protected |  | [`yii2\extensions\filepond\asset\AbstractPluginAsset`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md) |
| <span id="method-scripts"></span>[`scripts()`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md#method-scripts) protected |  | [`yii2\extensions\filepond\asset\AbstractPluginAsset`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md) |
| <span id="method-styles"></span>[`styles()`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md#method-styles) protected |  | [`yii2\extensions\filepond\asset\AbstractPluginAsset`](/docs/extensions/filepond/reference/asset/abstractpluginasset/index.md) |

## Method details

### plugin() <span id="method-plugin"></span>

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

**Returns**

[`yii2\extensions\filepond\asset\Plugin`](/docs/extensions/filepond/reference/asset/plugin-enum/index.md)