Assets

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Assets

Since

3.0.0

Class Assets

View source

Public Methods

Method	Description
downloadFile()	Save a file from a filesystem locally.
fileTransferList()	Create an asset transfer list based on a list of assets and an array of changing folder IDs.
filename2Title()	Generates a default asset title based on its filename.
generateUrl()	Generates the URL for an asset.
getAllowedFileKinds()	Returns a list of file kinds that are allowed to be uploaded.
getFileKindByExtension()	Return a file's kind by a file's extension.
getFileKindLabel()	Returns the label of a given file kind.
getFileKinds()	Returns a list of the supported file kinds.
getImageEditorSource()	Return an image path to use in the Image Editor for an asset by its ID and size.
getMaxUploadSize()	Returns the maximum allowed upload size in bytes per all config settings combined.
iconPath()	Returns the file path to an asset icon for a given extension.
iconSvg()	Returns the SVG contents for an asset icon with a given extension.
iconUrl()	Returns the URL to an asset icon for a given extension.
mirrorFolderStructure()	Mirrors a folder structure within a volume.
parseFileLocation()	Parses a file location in the format of {folder:X}filename.ext returns the folder ID + filename.
parseSrcsetSize()	Parses a srcset size (e.g. 100w or 2x).
periodList()	Get a list of available periods for Cache duration settings.
prepareAssetName()	Clean an Asset's filename.
revParams()	Returns revision query parameters that should be appended to as asset URL.
revUrl()	Appends revision parameters to a URL.
scaledDimensions()	Returns scaled width & height values for a maximum container size.
sortFolderTree()	Sorts a folder tree by the volume sort order.
tempFilePath()	Get a temporary file path.
urlAppendix()	Get appendix for a URL based on its Source caching settings.

downloadFile()

Since

4.0.0

Save a file from a filesystem locally.

View source

Arguments

• $fs (craft\base\BaseFsInterface)
• $uriPath (string)
• $localPath (string)

Returns

integer

Throws

• craft\errors\FsException

fileTransferList()

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

View source

Arguments

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

Returns

array

filename2Title()

Generates a default asset title based on its filename.

View source

Arguments

• $filename (string) – The asset's filename

Returns

string

generateUrl()

Generates the URL for an asset.

View source

Arguments

• $fs (craft\base\BaseFsInterface)
• $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

string

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.

View source

Returns

array – The allowed file kinds

getFileKindByExtension()

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

View source

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.

View source

Arguments

• $kind (string)

Returns

string

getFileKinds()

Returns a list of the supported file kinds.

View source

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.

View source

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.

View source

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.

View source

Arguments

• $extension (string)

Returns

string

iconSvg()

Since

4.5.0

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

View source

Arguments

• $extension (string)

Returns

string

iconUrl()

DEPRECATED

Deprecated in 4.5.0

Since

4.0.0

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

View source

Arguments

• $extension (string)

Returns

string

mirrorFolderStructure()

Mirrors a folder structure within a volume.

View source

Arguments

• $sourceParentFolder (craft\models\VolumeFolder) – Folder whose nested 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.

View source

Arguments

• $location (string)

Returns

array

Throws

• yii\base\InvalidArgumentException
  if the file location is invalid

parseSrcsetSize()

Since

3.5.0

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

View source

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.

View source

Returns

array

prepareAssetName()

Clean an Asset's filename.

View source

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

string

revParams()

Since

4.0.0

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

View source

Arguments

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

Returns

array

revUrl()

Since

4.3.7

Appends revision parameters to a URL.

View source

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

string

scaledDimensions()

Since

3.4.21

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

View source

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.

View source

Arguments

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

tempFilePath()

Get a temporary file path.

View source

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.

View source

Arguments

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

Returns

string

Constants

Constant	Description
INDEX_SKIP_ITEMS_PATTERN

Events

EVENT_REGISTER_FILE_KINDS

Type

craft\events\RegisterAssetFileKindsEvent

The event that is triggered when registering asset file kinds.

---

EVENT_SET_FILENAME

Type

craft\events\SetAssetFilenameEvent

The event that is triggered when defining an asset’s filename.

---