Assets

`fileTransferList()`

Create an asset transfer list based on a list of assets and an array of changing folder IDs.

Arguments

$assets (array) – List of assets
$folderIdChanges (array) – A map of folder ID changes

Returns

`filename2Title()`

Generates a default asset title based on its filename.

Arguments

$filename (string) – The asset's filename

Returns

`generateUrl()`

Generates the URL for an asset.

Arguments

$asset (craft\elements\Asset)
$uri (string, null) – Asset URI to use. Defaults to the filename.
$dateUpdated (DateTime, null) – Last datetime the target of the url was updated, if known

Returns

Throws

yii\base\InvalidConfigException
if the asset doesn’t have a filename.

`getAllowedFileKinds()`

Since: 3.1.16

Returns a list of file kinds that are allowed to be uploaded.

Returns

array – The allowed file kinds

`getFileKindByExtension()`

Return a file's kind by a file's extension.

Arguments

$file (string) – The file name/path

Returns

string – The file kind, or "unknown" if unknown.

`getFileKindLabel()`

Returns the label of a given file kind.

Arguments

$kind (string)

Returns

`getFileKinds()`

Returns a list of the supported file kinds.

Returns

array – The supported file kinds

`getImageEditorSource()`

Return an image path to use in the Image Editor for an asset by its ID and size.

Arguments

$assetId (integer)
$size (integer)

Returns

string, false

Throws

yii\base\Exception
in case of failure

`getMaxUploadSize()`

Returns the maximum allowed upload size in bytes per all config settings combined.

Returns

integer, float

`iconPath()`

DEPRECATED

Deprecated in 4.5.0. iconSvg() or Asset::getThumbSvg() should be used instead.

Since: 4.0.0

Returns the file path to an asset icon for a given extension.

Arguments

$extension (string)

Returns

`iconSvg()`

Since: 4.5.0

Returns the SVG contents for an asset icon with a given extension.

Arguments

$extension (string)

Returns

`iconUrl()`

DEPRECATED

Deprecated in 4.5.0

Since: 4.0.0

Returns the URL to an asset icon for a given extension.

Arguments

$extension (string)

Returns

`isTempUploadFs()`

Returns whether the given filesystem is used to store temporary asset uploads.

Arguments

$fs (craft\base\FsInterface)

Returns

boolean

`mirrorFolderStructure()`

Mirrors a folder structure on a volume.

Arguments

$sourceParentFolder (craft\models\VolumeFolder) – Folder who's children folder structure should be mirrored.
$destinationFolder (craft\models\VolumeFolder) – The destination folder
$targetTreeMap (array) – Map of relative path => existing folder ID

Returns

array – Map of original folder ID => new folder ID

`parseFileLocation()`

Parses a file location in the format of {folder:X}filename.ext returns the folder ID + filename.

Arguments

$location (string)

Returns

Throws

yii\base\InvalidArgumentException
if the file location is invalid

`parseSrcsetSize()`

Since: 3.5.0

Parses a srcset size (e.g. 100w or 2x).

Arguments

$size (mixed)

Returns

array – An array of the size value and unit (w or x)

Throws

yii\base\InvalidArgumentException
if the size can’t be parsed

`periodList()`

Get a list of available periods for Cache duration settings.

Returns

`prepareAssetName()`

Clean an Asset's filename.

Arguments

$name (string)
$isFilename (boolean) – If set to true (default), will separate extension and clean the filename separately.
$preventPluginModifications (boolean) – If set to true, will prevent plugins from modify

Returns

`revParams()`

Since: 4.0.0

Returns revision query parameters that should be appended to as asset URL.

Arguments

$asset (craft\elements\Asset)
$dateUpdated (DateTime, null)

Returns

`revUrl()`

Since: 4.3.7

Appends revision parameters to a URL.

Arguments

$url (string)
$asset (craft\elements\Asset)
$dateUpdated (DateTime, null)
$fsOnly (boolean) – Only append a revision param if the URL begins with the asset’s filesystem URL

Returns

`scaledDimensions()`

Since: 3.4.21

Returns scaled width & height values for a maximum container size.

Arguments

$realWidth (integer)
$realHeight (integer)
$maxWidth (integer)
$maxHeight (integer)

Returns

array – The scaled width and height

`sortFolderTree()`

DEPRECATED

Deprecated in 4.4.0

Sorts a folder tree by the volume sort order.

Arguments

$tree (craft\models\VolumeFolder[]) – Array passed by reference of the sortable folders.

`tempFilePath()`

Get a temporary file path.

Arguments

$extension (string) – Extension to use. "tmp" by default.

Returns

string – The temporary file path

Throws

yii\base\Exception
in case of failure

`urlAppendix()`

DEPRECATED

Deprecated in 4.0.0. generateUrl() should be used instead.

Get appendix for a URL based on its Source caching settings.

Arguments

$asset (craft\elements\Asset)
$dateUpdated (DateTime, null) – Last datetime the target of the url was updated, if known

Returns