Assets

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\Assets
Since
3.0.0

Class Assets

View source

# Public Methods

Method Description
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() Generate a URL for a given Assets file in a Source Type.
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 Image Editor for an Asset by id and size.
getMaxUploadSize() Returns the maximum allowed upload size in bytes per all config settings combined.
mirrorFolderStructure() Mirror a folder structure on a Volume.
parseFileLocation() Parses a file location in the format of {folder:X}filename.ext returns the folder ID + filename.
periodList() Get a list of available periods for Cache duration settings.
prepareAssetName() Clean an Asset's filename.
scaledDimensions() Returns scaled width & height values for a maximum container size.
sortFolderTree() Sorts a folder tree by Volume sort order.
tempFilePath() Get a temporary file path.
urlAppendix() Get appendix for an URL based on it's Source caching settings.

# 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()

Generate a URL for a given Assets file in a Source Type.

View source

Arguments

Returns

string

# 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

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 Image Editor for an Asset by id and size.

View source

Arguments

Returns

false, string

Throws

# getMaxUploadSize()

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

View source

Returns

integer, float

# mirrorFolderStructure()

Mirror a folder structure on a Volume.

View source

Arguments

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

Returns

array

Throws

# 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

# scaledDimensions()

Since
3.4.21

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

View source

Arguments

Returns

array – The scaled width and height

# sortFolderTree()

Sorts a folder tree by Volume sort order.

View source

Arguments

  • $tree

# tempFilePath()

Get a temporary file path.

View source

Arguments

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

Returns

string – The temporary file path

Throws

# urlAppendix()

Get appendix for an URL based on it's Source caching settings.

View source

Arguments

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\helpers\SetElementTableAttributeHtmlEvent

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