Asset

Type

Class

Namespace

craft\elements

Inherits

craft\elements\Asset » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)

Uses traits

craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Since

3.0.0

Asset represents an asset element.

View source (opens new window)

Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
additionalButtons	string (opens new window)
alt	string (opens new window), null (opens new window) – Alternative text
ancestors	craft\elements\db\ElementQueryInterface – The element’s ancestors
archived	boolean (opens new window) – Whether the element is archived
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
avoidFilenameConflicts	boolean (opens new window) – Whether the asset should avoid filename conflicts when saved.
awaitingFieldValues	boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheTags	string (opens new window)[]
canonical	craft\base\ElementInterface, null (opens new window) – The canonical element, if one exists for the current site
canonicalId	integer (opens new window), null (opens new window) – The element’s canonical ID
canonicalUid	string (opens new window) – The element’s canonical UID
children	craft\elements\db\ElementQueryInterface – The element’s children
conflictingFilename	string (opens new window), null (opens new window) – The filename that was used that caused a conflict.
contentId	integer (opens new window), null (opens new window) – The element’s content row ID
contentTable	string (opens new window) – The name of the table this element’s content is stored in
contents	string (opens new window)
copyOfFile	string (opens new window)
cpEditUrl	string (opens new window), null (opens new window) – The element’s edit URL in the control panel
cpRevisionsUrl	string (opens new window), null (opens new window)
currentRevision	self, null (opens new window)
dataUrl	string (opens new window)
dateCreated	DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted	DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateLastMerged	DateTime (opens new window), null (opens new window) – The date that the canonical element was last merged into this one
dateModified	DateTime (opens new window), null (opens new window) – Date modified
dateUpdated	DateTime (opens new window), null (opens new window) – The date that the element was last updated
deletedWithVolume	boolean (opens new window) – Whether the asset was deleted along with its volume
descendants	craft\elements\db\ElementQueryInterface – The element’s descendants
dimensions	null (opens new window), string (opens new window)
dirtyAttributes	string (opens new window)[]
dirtyFields	string (opens new window)[]
draftId	integer (opens new window), null (opens new window) – The ID of the draft’s row in the drafts table
duplicateOf	craft\base\ElementInterface, null (opens new window) – The element that this element is being duplicated by.
editorHtml	string (opens new window) – The HTML for the element’s editor HUD
enabled	boolean (opens new window) – Whether the element is enabled
enabledForSite	boolean (opens new window) – Whether the element is enabled for this site
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
extension	string (opens new window) – the file extension
fieldColumnPrefix	string (opens new window) – The field column prefix this element’s content uses
fieldContext	string (opens new window) – The field context this element’s content uses
fieldLayout	craft\models\FieldLayout, null (opens new window) – The field layout used by this element
fieldLayoutId	integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace	array (opens new window) – The namespace used by custom field params on the request
fieldValues	array (opens new window) – The element’s normalized custom field values, indexed by their handles
filename	string (opens new window) – the filename (with extension)
firstErrors (opens new window)	array (opens new window) – The first errors.
firstSave	boolean (opens new window) – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
focalPoint	string (opens new window), array (opens new window), null (opens new window) – the focal point represented as an array with x and y keys, or null if it’s not an image
folder	craft\models\VolumeFolder – the asset’s volume folder
folderId	integer (opens new window), null (opens new window) – Folder ID
folderPath	string (opens new window), null (opens new window) – Folder path
format	string (opens new window) – The asset's format
formattedSize	string (opens new window), null (opens new window)
formattedSizeInBytes	string (opens new window), null (opens new window)
fs	craft\base\FsInterface
gqlTypeName	string (opens new window)
hardDelete	boolean (opens new window) – Whether the element is being hard-deleted.
hasCheckeredThumb	boolean (opens new window)
hasDescendants	boolean (opens new window) – Whether the element has descendants
hasFocalPoint	boolean (opens new window) – whether a user-defined focal point is set on the asset
hasRoundedThumb	boolean (opens new window)
height	integer (opens new window), null (opens new window) – the image height
htmlAttributes	array (opens new window) – Any attributes that should be included in the element’s DOM representation in the control panel
id	integer (opens new window), null (opens new window) – The element’s ID
imageTransformSourcePath	string (opens new window)
img	\Twig\Markup, null (opens new window) – an <img> tag based on this asset
isCanonical	boolean (opens new window) – Whether this is the canonical element
isDerivative	boolean (opens new window) – Whether this is a derivative element, such as a draft or revision
isDraft	boolean (opens new window)
isFresh	boolean (opens new window)
isHomepage	boolean (opens new window)
isNewForSite	boolean (opens new window) – Whether the element is being saved to the current site for the first time.
isProvisionalDraft	boolean (opens new window) – Whether this is a provisional draft.
isRevision	boolean (opens new window)
isTitleTranslatable	boolean (opens new window)
isUnpublishedDraft	boolean (opens new window)
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
keepFileOnDelete	boolean (opens new window) – Whether the associated file should be preserved if the asset record is deleted.
keptFile	boolean (opens new window), null (opens new window) – Whether the file was kept around when the asset was deleted
kind	string (opens new window), null (opens new window) – Kind
language	string (opens new window)
level	integer (opens new window), null (opens new window) – The element’s level within its structure
lft	integer (opens new window), null (opens new window) – The element’s left position within its structure
link	\Twig\Markup, null (opens new window) – An anchor pre-filled with this element’s URL and title
localized	craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection
locationError	string (opens new window), null (opens new window) – Location error code
mergingCanonicalChanges	boolean (opens new window) – Whether recent changes to the canonical element are being merged into this element.
metadata	array (opens new window) – The data, with keys representing the labels.
mimeType	string (opens new window), null (opens new window) – the file’s MIME type, if it can be determined
modifiedAttributes	string (opens new window)[]
modifiedFields	string (opens new window)[]
newFilename	string (opens new window), null (opens new window) – New filename
newFolderId	integer (opens new window), null (opens new window) – New folder ID
newLocation	string (opens new window), null (opens new window) – New file location
newSiteIds	integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next	craft\base\ElementInterface, null (opens new window) – The next element relative to this one, from a given set of criteria
nextSibling	craft\base\ElementInterface, null (opens new window) – The element’s next sibling
outdatedAttributes	string (opens new window)[]
outdatedFields	string (opens new window)[]
parent	craft\base\ElementInterface, null (opens new window) – The element’s parent
parentId	integer (opens new window), null (opens new window) – The element’s parent’s ID
parentUri	string (opens new window), null (opens new window)
path	string (opens new window) – the asset's path in the volume
postEditUrl	string (opens new window), null (opens new window)
prev	craft\base\ElementInterface, null (opens new window) – The previous element relative to this one, from a given set of criteria
prevSibling	craft\base\ElementInterface, null (opens new window) – The element’s previous sibling
previewHtml	string (opens new window)
previewTargets	array (opens new window)
previewing	boolean (opens new window) – Whether the element is currently being previewed.
propagateAll	boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating	boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref	string (opens new window), null (opens new window) – The reference string to this element
resaving	boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId	integer (opens new window), null (opens new window) – The ID of the revision’s row in the revisions table
rgt	integer (opens new window), null (opens new window) – The element’s right position within its structure
root	integer (opens new window), null (opens new window) – The element’s structure’s root ID
route	mixed – The route that should be used when the element’s URI is requested
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
searchScore	integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValues	array (opens new window) – Array of the element’s serialized custom field values, indexed by their handles
siblings	craft\elements\db\ElementQueryInterface – All of the element’s siblings
site	craft\models\Site – Site the element is associated with
siteId	integer (opens new window), null (opens new window) – The site ID the element is associated with
siteSettingsId	integer (opens new window), null (opens new window) – The ID of the element’s record in the elements_sites table
size	integer (opens new window), null (opens new window) – Size
slug	string (opens new window), null (opens new window) – The element’s slug
sourceId	integer (opens new window), null (opens new window)
sourceUid	string (opens new window)
status	string (opens new window), null (opens new window) – The element’s status
stream	resource (opens new window)
structureId	integer (opens new window), null (opens new window) – The element’s structure ID
suggestedFilename	string (opens new window), null (opens new window) – The suggested filename in case of a conflict.
supportedSites	integer (opens new window)[], array (opens new window) – The sites this element is associated with
supportsImageEditor	boolean (opens new window)
tempFilePath	string (opens new window), null (opens new window) – The temp file path
tempId	string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element’s URI format contains {id})
thumbAlt	string (opens new window), null (opens new window)
title	string (opens new window), null (opens new window) – The element’s title
titleTranslationDescription	null (opens new window), string (opens new window)
titleTranslationKey	string (opens new window)
totalDescendants	integer (opens new window) – The total number of descendants that the element has
transform	null (opens new window), string (opens new window), array (opens new window), craft\models\ImageTransform
transformSource	string (opens new window)
trashed	boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel	string (opens new window)
uiLabelPath	string (opens new window)[]
uid	string (opens new window), null (opens new window) – The element’s UID
updatingFromDerivative	boolean (opens new window) – Whether the element is being updated from a derivative element, such as a draft or revision.
uploader	craft\elements\User, null (opens new window)
uploaderId	integer (opens new window), null (opens new window) – The ID of the user who first added this asset (if known)
uri	string (opens new window), null (opens new window) – The element’s URI
uriFormat	string (opens new window), null (opens new window) – The URI format used to generate this element’s URL
url	string (opens new window), null (opens new window) – The element’s full URL
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
volume	craft\models\Volume – the asset’s volume
volumeId	integer (opens new window), null (opens new window) – the volume ID
width	integer (opens new window), null (opens new window) – the image width

additionalButtons

Type

string (opens new window)

Default value

null

Access

Read-only

Since

4.0.0

View source (opens new window)

alt

Type

string (opens new window), null (opens new window)

Default value

null

Since

4.0.0

Alternative text

View source (opens new window)

avoidFilenameConflicts

Type

boolean (opens new window)

Default value

false

Whether the asset should avoid filename conflicts when saved.

View source (opens new window)

cacheTags

Type

string (opens new window)[]

Default value

null

View source (opens new window)

conflictingFilename

Type

string (opens new window), null (opens new window)

Default value

null

The filename that was used that caused a conflict.

View source (opens new window)

contents

Type

string (opens new window)

Default value

null

View source (opens new window)

copyOfFile

Type

string (opens new window)

Default value

null

View source (opens new window)

dataUrl

Type

string (opens new window)

Default value

null

View source (opens new window)

dateModified

Type

DateTime (opens new window), null (opens new window)

Default value

null

Date modified

View source (opens new window)

deletedWithVolume

Type

boolean (opens new window)

Default value

false

Whether the asset was deleted along with its volume

See also beforeDelete()

View source (opens new window)

dimensions

Type

null (opens new window), string (opens new window)

Default value

null

View source (opens new window)

extension

Type

string (opens new window)

Default value

null

the file extension

View source (opens new window)

filename

Type

string (opens new window)

Default value

null

the filename (with extension)

View source (opens new window)

focalPoint

Type

string (opens new window), array (opens new window), null (opens new window)

Default value

null

the focal point represented as an array with x and y keys, or null if it’s not an image

View source (opens new window)

folder

Type

craft\models\VolumeFolder

Default value

null

the asset’s volume folder

View source (opens new window)

folderId

Type

integer (opens new window), null (opens new window)

Default value

null

Folder ID

View source (opens new window)

folderPath

Type

string (opens new window), null (opens new window)

Default value

null

Folder path

View source (opens new window)

format

Type

string (opens new window)

Default value

null

Access

Read-only

The asset's format

View source (opens new window)

formattedSize

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

Since

3.4.0

View source (opens new window)

formattedSizeInBytes

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

Since

3.4.0

View source (opens new window)

fs

Type

craft\base\FsInterface

Default value

null

View source (opens new window)

gqlTypeName

Type

string (opens new window)

Default value

null

View source (opens new window)

hasCheckeredThumb

Type

boolean (opens new window)

Default value

null

View source (opens new window)

hasFocalPoint

Type

boolean (opens new window)

Default value

null

whether a user-defined focal point is set on the asset

View source (opens new window)

height

Type

integer (opens new window), null (opens new window)

Default value

null

the image height

View source (opens new window)

imageTransformSourcePath

Type

string (opens new window)

Default value

null

View source (opens new window)

img

Type

\Twig\Markup, null (opens new window)

Default value

null

an <img> tag based on this asset

View source (opens new window)

isTitleTranslatable

Type

boolean (opens new window)

Default value

null

View source (opens new window)

keepFileOnDelete

Type

boolean (opens new window)

Default value

false

Whether the associated file should be preserved if the asset record is deleted.

See also:

• beforeDelete()
• afterDelete()

View source (opens new window)

keptFile

Type

boolean (opens new window), null (opens new window)

Default value

null

Whether the file was kept around when the asset was deleted

View source (opens new window)

kind

Type

string (opens new window), null (opens new window)

Default value

null

Kind

View source (opens new window)

locationError

Type

string (opens new window), null (opens new window)

Default value

null

Location error code

See also craft\validators\AssetLocationValidator::validateAttribute()

View source (opens new window)

mimeType

Type

string (opens new window), null (opens new window)

Default value

null

the file’s MIME type, if it can be determined

View source (opens new window)

newFilename

Type

string (opens new window), null (opens new window)

Default value

null

New filename

View source (opens new window)

newFolderId

Type

integer (opens new window), null (opens new window)

Default value

null

New folder ID

View source (opens new window)

newLocation

Type

string (opens new window), null (opens new window)

Default value

null

New file location

View source (opens new window)

path

Type

string (opens new window)

Default value

null

the asset's path in the volume

View source (opens new window)

postEditUrl

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

Since

4.0.0

View source (opens new window)

previewHtml

Type

string (opens new window)

Default value

null

View source (opens new window)

previewTargets

Type

array (opens new window)

Default value

null

View source (opens new window)

size

Type

integer (opens new window), null (opens new window)

Default value

null

Size

View source (opens new window)

stream

Type

resource (opens new window)

Default value

null

View source (opens new window)

suggestedFilename

Type

string (opens new window), null (opens new window)

Default value

null

The suggested filename in case of a conflict.

View source (opens new window)

supportsImageEditor

Type

boolean (opens new window)

Default value

null

View source (opens new window)

tempFilePath

Type

string (opens new window), null (opens new window)

Default value

null

The temp file path

View source (opens new window)

thumbAlt

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

Since

4.0.0

View source (opens new window)

titleTranslationDescription

Type

null (opens new window), string (opens new window)

Default value

null

View source (opens new window)

titleTranslationKey

Type

string (opens new window)

Default value

null

View source (opens new window)

transform

Type

null (opens new window), string (opens new window), array (opens new window), craft\models\ImageTransform

Default value

null

View source (opens new window)

transformSource

Type

string (opens new window)

Default value

null

View source (opens new window)

uploader

Type

craft\elements\User, null (opens new window)

Default value

null

View source (opens new window)

uploaderId

Type

integer (opens new window), null (opens new window)

Default value

null

The ID of the user who first added this asset (if known)

View source (opens new window)

volume

Type

craft\models\Volume

Default value

null

the asset’s volume

View source (opens new window)

volumeId

Type

integer (opens new window), null (opens new window)

Default value

null

the volume ID

View source (opens new window)

width

Type

integer (opens new window), null (opens new window)

Default value

null

the image width

View source (opens new window)

Protected Properties

Property	Description
revisionCreatorId	integer (opens new window), null (opens new window) – Revision creator ID to be saved
revisionNotes	string (opens new window), null (opens new window) – Revision notes to be saved

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()
__construct()
__get()	Returns a property value.
__isset()	Checks if a property is set.
__set()	Sets the value of a component property.
__toString()	Returns the string representation of the element.
__unset() (opens new window)	Sets a component property to be null.
actions()	Returns the available element actions (opens new window) for a given source.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterDelete()	Performs actions after an element is deleted.
afterMoveInStructure()	Performs actions after an element is moved within a structure.
afterPropagate()	Performs actions after an element is fully saved and propagated to other sites.
afterRestore()	Performs actions after an element is restored.
afterSave()	Performs actions after an element is saved.
afterValidate()	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeDelete()	Performs actions before an element is deleted.
beforeMoveInStructure()	Performs actions before an element is moved within a structure.
beforeRestore()	Performs actions before an element is restored.
beforeSave()	Performs actions before an element is saved.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canCreateDrafts()	Returns whether the given user is authorized to create drafts for this element.
canDelete()	Returns whether the given user is authorized to delete this element.
canDeleteForSite()	Returns whether the given user is authorized to delete this element for its current site.
canDuplicate()	Returns whether the given user is authorized to duplicate this element.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSave()	Returns whether the given user is authorized to save this element in its current form.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
canView()	Returns whether the given user is authorized to view this element’s edit page.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
copyWithTransform()	Returns a copy of the asset with the given transform applied to it.
createAnother()	Creates a new element (without saving it) based on this one.
createCondition()	Returns an element condition for the element type.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes()	Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
eagerLoadingMap()	Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exporters()	Returns the available export options for a given source.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fieldLayouts()	Returns all of the field layouts associated with elements from the given source.
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
find()	Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()	Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()	Returns a single element instance by a primary key or a set of element criteria parameters.
findSource()	Returns a source definition by a given source key/path and context.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAdditionalButtons()	Returns additional buttons that should be shown at the top of the element’s edit page.
getAncestors()	Returns the element’s ancestors.
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributeStatus()	Returns the status of a given attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getCacheTags()	Returns the cache tags that should be cleared when this element is saved.
getCanonical()	Returns the canonical version of the element.
getCanonicalId()	Returns the element’s canonical ID.
getCanonicalUid()	Returns the element’s canonical UUID.
getChildren()	Returns the element’s children.
getContentTable()	Returns the name of the table this element’s content is stored in.
getContents()	Returns the file’s contents.
getCopyOfFile()	Get a temporary copy of the actual file.
getCpEditUrl()	Returns the element’s edit URL in the control panel.
getCpRevisionsUrl()	Returns the element’s revisions index URL in the control panel.
getCurrentRevision()	Returns the element’s current revision, if one exists.
getDataUrl()	Generates a base64-encoded data URL (opens new window) for the asset.
getDescendants()	Returns the element’s descendants.
getDimensions()	Returns the image dimensions.
getDirtyAttributes()	Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields()	Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount()	Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements()	Returns the eager-loaded elements for a given handle.
getEnabledForSite()	Returns whether the element is enabled for the current site.
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getExtension()	Returns the file extension.
getFieldColumnPrefix()	Returns the field column prefix this element’s content uses.
getFieldContext()	Returns the field context this element’s content uses.
getFieldLayout()	Returns the field layout used by this element.
getFieldParamNamespace()	Returns the namespace used by custom field params on the request.
getFieldValue()	Returns the value for a given field.
getFieldValues()	Returns the element’s normalized custom field values, indexed by their handles.
getFilename()	Returns the filename, with or without the extension.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getFocalPoint()	Returns the focal point represented as an array with x and y keys, or null if it’s not an image.
getFolder()	Returns the asset’s volume folder.
getFormat()	Returns the file's format, if it can be determined.
getFormattedSize()	Returns the formatted file size, if known.
getFormattedSizeInBytes()	Returns the formatted file size in bytes, if known.
getFs()	Returns the filesystem the asset is stored in.
getGqlTypeName()	Returns the GraphQL type name for this element type.
getHasCheckeredThumb()	Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants()	Returns whether the element has descendants.
getHasFocalPoint()	Returns whether a user-defined focal point is set on the asset.
getHasRoundedThumb()	Returns whether the element’s thumbnail should be rounded.
getHeight()	Returns the image height.
getHtmlAttributes()	Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId()
getImageTransformSourcePath()	Return the path where the source for this Asset's transforms should be.
getImg()	Returns an <img> tag based on this asset.
getIsCanonical()	Returns whether this is the canonical element.
getIsDerivative()	Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()	Returns whether this is a draft.
getIsFresh()	Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()	Returns whether this element represents the site homepage.
getIsRevision()	Returns whether this is a revision.
getIsTitleTranslatable()	Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()	Returns whether the element is an unpublished draft.
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getLanguage()	Returns the language of the element.
getLink()	Returns an anchor pre-filled with this element’s URL and title.
getLocalized()	Returns the same element in other locales.
getMetadata()	Returns element metadata that should be shown within the editor sidebar.
getMimeType()	Returns the file’s MIME type, if it can be determined.
getModifiedAttributes()	Returns the attribute names that have changed for this element.
getModifiedFields()	Returns the field handles that have changed for this element.
getNext()	Returns the next element relative to this one, from a given set of criteria.
getNextSibling()	Returns the element’s next sibling.
getOutdatedAttributes()	Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields()	Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent()	Returns the element’s parent.
getParentId()	Returns the parent ID.
getParentUri()	Returns the parent element’s URI, if there is one.
getPath()	Returns the asset's path in the volume.
getPostEditUrl()	Returns the URL that users should be redirected to after editing the element.
getPrev()	Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()	Returns the element’s previous sibling.
getPreviewHtml()	Returns the HTML for asset previews.
getPreviewTargets()	Returns the additional locations that should be available for previewing the element, besides its primary URL.
getPreviewThumbImg()	Returns preview thumb image HTML.
getRef()	Returns the reference string to this element.
getRoute()	Returns the route that should be used when the element’s URI is requested.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords for a given search attribute.
getSerializedFieldValues()	Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings()	Returns all of the element’s siblings.
getSidebarHtml()	Returns the HTML for any fields/info that should be shown within the editor sidebar.
getSite()	Returns the site the element is associated with.
getSourceId()	Returns the element’s canonical ID.
getSourceUid()	Returns the element’s canonical UID.
getSrcset()	Returns a srcset attribute value based on the given widths or x-descriptors.
getStatus()	Returns the element’s status.
getStream()	Returns a stream of the actual file.
getSupportedSites()	Returns the sites this element is associated with.
getSupportsImageEditor()	Returns whether this asset can be edited by the image editor.
getTableAttributeHtml()	Returns the HTML that should be shown for a given attribute in Table View.
getThumbAlt()	Returns alt text for the element’s thumbnail.
getThumbUrl()	Returns the URL to the element’s thumbnail, if there is one.
getTitleTranslationDescription()	Returns the description of the Title field’s translation support.
getTitleTranslationKey()	Returns the Title’s translation key.
getTotalDescendants()	Returns the total number of descendants that the element has.
getUiLabel()	Returns what the element should be called within the control panel.
getUiLabelPath()	Returns any path segment labels that should be prepended to the element’s UI label.
getUploader()	Returns the user that uploaded the asset, if known.
getUriFormat()	Returns the URI format used to generate this element’s URI.
getUrl()	Returns the element’s full URL.
getUrlsBySize()	Returns an array of image transform URLs based on the given widths or x-descriptors.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
getVolume()	Returns the asset’s volume.
getVolumeId()	Returns the volume’s ID.
getWidth()	Returns the image width.
gqlMutationNameByContext()	Returns the GraphQL mutation name by an element’s context.
gqlScopesByContext()	Returns the GraphQL scopes required by element’s context.
gqlTypeNameByContext()	Returns the GraphQL type name by an element’s context.
hasContent()	Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
hasEagerLoadedElements()	Returns whether elements have been eager-loaded with a given handle.
hasErrors()	Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
hasRevisions()	Returns whether revisions should be created when this element is saved.
hasStatuses()	Returns whether elements of this type have statuses.
hasTitles()	Returns whether elements of this type have traditional titles.
hasUris()	Returns whether elements of this type can have their own slugs and URIs.
indexElementCount()	Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()	Returns the element index HTML.
init()	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAncestorOf()	Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty()	Returns whether an attribute has changed since the element was first loaded.
isAttributeModified()	Returns whether an attribute value has changed for this element.
isAttributeOutdated()	Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()	Returns whether this element is a direct child of another one.
isDescendantOf()	Returns whether this element is a descendant of another one.
isFieldDirty()	Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty()	Returns whether a field is empty.
isFieldModified()	Returns whether a field value has changed for this element.
isFieldOutdated()	Returns whether a field value has fallen behind the canonical element’s value.
isLocalized()	Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()	Returns whether this element is the direct next sibling of another one.
isParentOf()	Returns whether this element is a direct parent of another one.
isPrevSiblingOf()	Returns whether this element is the direct previous sibling of another one.
isSelectable()	Returns whether the component should be selectable in component Type selects.
isSiblingOf()	Returns whether this element is a sibling of another one.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
lowerDisplayName()	Returns the lowercase version of displayName().
markAsClean()	Resets the record of dirty attributes and fields.
markAsDirty()	Marks all fields and attributes as dirty.
mergeCanonicalChanges()	Merges changes from the canonical element into this one.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName()	Returns the plural version of displayName().
pluralLowerDisplayName()	Returns the plural, lowercase version of displayName().
prepareEditScreen()	Prepares the response for the element’s Edit screen.
refHandle()	Returns the handle that should be used to refer to this element type from reference tags.
rules()	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
searchableAttributes()	Defines which element attributes should be searchable.
setAttributes()	Sets the attribute values in a massive way.
setCanonical()	Sets the canonical version of the element.
setCanonicalId()	Sets the element’s canonical ID.
setDirtyAttributes()	Sets the list of dirty attribute names.
setEagerLoadedElementCount()	Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements()	Sets some eager-loaded elements on a given handle.
setEnabledForSite()	Sets whether the element is enabled for the current site.
setFieldParamNamespace()	Sets the namespace used by custom field params on the request.
setFieldValue()	Sets the value for a given field.
setFieldValues()	Sets the element’s custom field values.
setFieldValuesFromRequest()	Sets the element’s custom field values, when the values have come from post data.
setFilename()	Sets the filename (with extension).
setFocalPoint()	Sets the asset's focal point.
setHeight()	Sets the image height.
setIsFresh()	Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setNext()	Sets the default next element.
setParent()	Sets the element’s parent.
setParentId()	Sets the parent ID.
setPrev()	Sets the default previous element.
setRevisionCreatorId()	Sets the revision creator ID to be saved.
setRevisionNotes()	Sets the revision notes to be saved.
setScenario() (opens new window)	Sets the scenario for the model.
setTransform()	Sets the transform.
setUiLabel()	Defines what the element should be called within the control panel.
setUiLabelPath()	Defines any path segment labels that should be prepended to the element’s UI label.
setUploader()	Sets the asset's uploader.
setVolumeId()	Sets the volume’s ID.
setWidth()	Sets the image width.
sortOptions()	Returns the sort options for the element type.
sources()	Returns the source definitions that elements of this type may belong to.
statuses()	Returns all of the possible statuses that elements of this type may have.
tableAttributes()	Defines all of the available columns that can be shown in table views.
toArray() (opens new window)	Converts the model into an array.
trackChanges()	Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() (opens new window)	Triggers an event.
validate()	Performs the data validation.
validateCustomFieldAttribute()	Calls a custom validation function on a custom field.
validateMultiple() (opens new window)	Validates multiple models.

__get()

Returns a property value.

This method will check if $name is one of the following:

• a magic property supported by craft\base\Element::__get()
• an image transform handle

View source (opens new window)

Arguments

• $name (string (opens new window)) – The property name

Returns

mixed – The property value

Throws

• yii\base\UnknownPropertyException (opens new window)
  if the property is not defined
• yii\base\InvalidCallException (opens new window)
  if the property is write-only.

__isset()

Checks if a property is set.

This method will check if $name is one of the following:

• a magic property supported by craft\base\Element::__isset()
• an image transform handle

View source (opens new window)

Arguments

• $name (string (opens new window)) – The property name

Returns

boolean (opens new window) – Whether the property is set

__toString()

Returns the string representation of the element.

View source (opens new window)

Returns

string (opens new window)

afterDelete()

Performs actions after an element is deleted.

View source (opens new window)

afterSave()

Performs actions after an element is saved.

View source (opens new window)

Arguments

• $isNew (boolean (opens new window)) – Whether the element is brand new

Throws

• yii\base\InvalidConfigException (opens new window)

afterValidate()

This method is invoked after validation ends.

The default implementation raises an afterValidate event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

View source (opens new window)

attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source (opens new window)

Returns

string (opens new window)[] – List of attribute names.

beforeDelete()

Performs actions before an element is deleted.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be deleted

beforeRestore()

Since

3.1.0

Performs actions before an element is restored.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be restored

beforeSave()

Performs actions before an element is saved.

View source (opens new window)

Arguments

• $isNew (boolean (opens new window)) – Whether the element is brand new

Returns

boolean (opens new window) – Whether the element should be saved

canDelete()

Since

4.0.0

Returns whether the given user is authorized to delete this element.

This will only be called if the element can be viewed and/or saved.

View source (opens new window)

Arguments

• $user (craft\elements\User)

Returns

boolean (opens new window)

canSave()

Since

4.0.0

Returns whether the given user is authorized to save this element in its current form.

This will only be called if the element can be viewed.

View source (opens new window)

Arguments

• $user (craft\elements\User)

Returns

boolean (opens new window)

canView()

Since

4.0.0

Returns whether the given user is authorized to view this element’s edit page.

If they can view but not save, the edit form will either render statically, or be restricted to only saving changes as a draft, depending on canCreateDrafts().

View source (opens new window)

Arguments

• $user (craft\elements\User)

Returns

boolean (opens new window)

copyWithTransform()

Returns a copy of the asset with the given transform applied to it.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – The transform handle or configuration that should be applied to the image

Returns

craft\elements\Asset

Throws

• craft\errors\ImageTransformException
  if $transform is an invalid transform handle

createCondition()

Since

4.0.0

Returns an element condition for the element type.

View source (opens new window)

Returns

craft\elements\conditions\assets\AssetCondition

displayName()

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

eagerLoadingMap()

Since

3.4.0

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

• elementType – the fully qualified class name of the element type that should be eager-loaded
• map – an array of element ID mappings, where each element is a sub-array with source and target keys.
• criteria (optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

use craft\db\Query;
use craft\helpers\ArrayHelper;

public static function eagerLoadingMap(array $sourceElements, string $handle)
{
    switch ($handle) {
        case 'author':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'id', 'target' => 'authorId'])
                ->from('{{%books}}')
                ->where(['id' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\Author::class,
                'map' => $map,
            ];
        case 'bookClubs':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'bookId', 'target' => 'clubId'])
                ->from('{{%bookclub_books}}')
                ->where(['bookId' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\BookClub::class,
                'map' => $map,
            ];
        default:
            return parent::eagerLoadMap($sourceElements, $handle);
    }
}

View source (opens new window)

Arguments

• $sourceElements (self[]) – An array of the source elements
• $handle (string (opens new window)) – The property handle used to identify which target elements should be included in the map

Returns

array (opens new window), null (opens new window), false (opens new window) – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored

extraFields()

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() (opens new window) on the format of the return value.

find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find(): ElementQueryInterface
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find(): ElementQueryInterface
    {
        return parent::find()->limit(50);
    }
}

View source (opens new window)

Returns

craft\elements\db\AssetQuery – The newly created craft\elements\db\AssetQuery instance.

findSource()

Since

4.4.0

Returns a source definition by a given source key/path and context.

View source (opens new window)

Arguments

• $sourceKey (string (opens new window))
• $context (string (opens new window), null (opens new window))

Returns

array (opens new window), null (opens new window)

getAdditionalButtons()

Since

4.0.0

Returns additional buttons that should be shown at the top of the element’s edit page.

View source (opens new window)

Returns

string (opens new window)

getContents()

Since

3.0.6

Returns the file’s contents.

View source (opens new window)

Returns

string (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)
  if volumeId is missing or invalid
• craft\errors\AssetException
  if a stream could not be created

getCopyOfFile()

Get a temporary copy of the actual file.

View source (opens new window)

Returns

string (opens new window)

Throws

• craft\errors\VolumeException
  If unable to fetch file from volume.
• yii\base\InvalidConfigException (opens new window)
  If no volume can be found.

getDataUrl()

Since

3.5.13

Generates a base64-encoded data URL (opens new window) for the asset.

View source (opens new window)

Returns

string (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)
  if volumeId is missing or invalid
• craft\errors\AssetException
  if a stream could not be created

getDimensions()

Since

3.4.0

Returns the image dimensions.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

getExtension()

Returns the file extension.

View source (opens new window)

Returns

string (opens new window)

getFieldLayout()

Returns the field layout used by this element.

View source (opens new window)

Returns

craft\models\FieldLayout, null (opens new window)

getFilename()

Returns the filename, with or without the extension.

View source (opens new window)

Arguments

• $withExtension (boolean (opens new window))

Returns

string (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)
  if the filename isn’t set yet

getFocalPoint()

Returns the focal point represented as an array with x and y keys, or null if it’s not an image.

View source (opens new window)

Arguments

• $asCss (boolean (opens new window)) – Whether the value should be returned in CSS syntax ("50% 25%") instead

Returns

array (opens new window), string (opens new window), null (opens new window)

getFolder()

Returns the asset’s volume folder.

View source (opens new window)

Returns

craft\models\VolumeFolder

Throws

• yii\base\InvalidConfigException (opens new window)
  if folderId is missing or invalid

getFormat()

Returns the file's format, if it can be determined.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

string (opens new window) – The asset's format

Throws

• craft\errors\ImageTransformException
  If an invalid transform handle is supplied

getFormattedSize()

Since

3.4.0

Returns the formatted file size, if known.

View source (opens new window)

Arguments

• $decimals (integer (opens new window), null (opens new window)) – The number of digits after the decimal point
• $short (boolean (opens new window)) – Whether the size should be returned in short form (“kB” instead of “kilobytes”)

Returns

string (opens new window), null (opens new window)

getFormattedSizeInBytes()

Since

3.4.0

Returns the formatted file size in bytes, if known.

View source (opens new window)

Arguments

• $short (boolean (opens new window)) – Whether the size should be returned in short form (“B” instead of “bytes”)

Returns

string (opens new window), null (opens new window)

getFs()

DEPRECATED

Deprecated in 4.4.0

Since

4.0.0

Returns the filesystem the asset is stored in.

View source (opens new window)

Returns

craft\base\FsInterface

Throws

• yii\base\InvalidConfigException (opens new window)

getGqlTypeName()

Since

3.3.0

Returns the GraphQL type name for this element type.

View source (opens new window)

Returns

string (opens new window)

getHasCheckeredThumb()

Since

3.5.5

Returns whether the element’s thumbnail should have a checkered background.

View source (opens new window)

Returns

boolean (opens new window)

getHasFocalPoint()

Returns whether a user-defined focal point is set on the asset.

View source (opens new window)

Returns

boolean (opens new window)

getHeight()

Returns the image height.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

integer (opens new window), null (opens new window)

getHtmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the control panel.

The attribute HTML will be rendered with yii\helpers\BaseHtml::renderTagAttributes() (opens new window).

TIP

Element types that extend craft\base\Element should override craft\base\Element::htmlAttributes() instead of this method.

View source (opens new window)

Arguments

• $context (string (opens new window)) – The context that the element is being rendered in ('index', 'modal', 'field', or 'settings'.)

Returns

array (opens new window)

getImageTransformSourcePath()

Return the path where the source for this Asset's transforms should be.

View source (opens new window)

Returns

string (opens new window)

getImg()

Returns an <img> tag based on this asset.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – The transform to use when generating the html.
• $sizes (string (opens new window)[], null (opens new window)) – The widths/x-descriptors that should be used for the srcset attribute (see getSrcset() for example syntaxes)

Returns

\Twig\Markup, null (opens new window)

Throws

• yii\base\InvalidArgumentException (opens new window)

getIsTitleTranslatable()

Since

3.5.0

Returns whether the Title field should be shown as translatable in the UI.

Note this method has no effect on whether titles will get copied over to other sites when the element is actually getting saved. That is determined by getTitleTranslationKey().

View source (opens new window)

Returns

boolean (opens new window)

getMimeType()

Returns the file’s MIME type, if it can be determined.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the mime type

Returns

string (opens new window), null (opens new window)

Throws

• craft\errors\ImageTransformException
  if $transform is an invalid transform handle

getPath()

Returns the asset's path in the volume.

View source (opens new window)

Arguments

• $filename (string (opens new window), null (opens new window)) – Filename to use. If not specified, the asset's filename will be used.

Returns

string (opens new window)

getPostEditUrl()

Since

4.0.0

Returns the URL that users should be redirected to after editing the element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

getPreviewHtml()

Returns the HTML for asset previews.

View source (opens new window)

Returns

string (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)

getPreviewTargets()

Since

3.2.0

Returns the additional locations that should be available for previewing the element, besides its primary URL.

Each target should be represented by a sub-array with the following keys:

• label – What the preview target will be called in the control panel.
• url – The URL that the preview target should open.
• refresh – Whether preview frames should be automatically refreshed when content changes (true by default).

TIP

Element types that extend craft\base\Element should override craft\base\Element::previewTargets() instead of this method.

View source (opens new window)

Returns

array (opens new window)

getPreviewThumbImg()

Since

3.4.0

Returns preview thumb image HTML.

View source (opens new window)

Arguments

• $desiredWidth (integer (opens new window))
• $desiredHeight (integer (opens new window))

Returns

string (opens new window)

getSidebarHtml()

Since

3.7.0

Returns the HTML for any fields/info that should be shown within the editor sidebar.

View source (opens new window)

Arguments

• $static (boolean (opens new window)) – Whether any fields within the sidebar should be static (non-interactive)

Returns

string (opens new window)

getSrcset()

Since

3.5.0

Returns a srcset attribute value based on the given widths or x-descriptors.

For example, if you pass ['100w', '200w'], you will get:

image-url@100w.ext 100w,
image-url@200w.ext 200w

If you pass x-descriptors, it will be assumed that the image’s current width is the 1x width. So if you pass ['1x', '2x'] on an image with a 100px-wide transform applied, you will get:

image-url@100w.ext,
image-url@200w.ext 2x

View source (opens new window)

Arguments

• $sizes (string (opens new window)[])
• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

string (opens new window), false (opens new window) – The srcset attribute value, or false if it can’t be determined

Throws

• yii\base\InvalidArgumentException (opens new window)

getStream()

Returns a stream of the actual file.

View source (opens new window)

Returns

resource (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)
  if volumeId is missing or invalid
• craft\errors\FsException
  if a stream cannot be created

getSupportsImageEditor()

Returns whether this asset can be edited by the image editor.

View source (opens new window)

Returns

boolean (opens new window)

getTableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

TIP

Element types that extend craft\base\Element should override craft\base\Element::tableAttributeHtml() instead of this method.

View source (opens new window)

Arguments

• $attribute (string (opens new window)) – The attribute name.

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

getThumbAlt()

Since

4.0.0

Returns alt text for the element’s thumbnail.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

getThumbUrl()

Returns the URL to the element’s thumbnail, if there is one.

View source (opens new window)

Arguments

• $size (integer (opens new window)) – The maximum width and height the thumbnail should have.

Returns

string (opens new window), null (opens new window)

getTitleTranslationDescription()

Since

3.5.0

Returns the description of the Title field’s translation support.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

getTitleTranslationKey()

Returns the Title’s translation key.

When saving an element on a multi-site Craft install, if $propagate is true for craft\services\Elements::saveElement(), then getTitleTranslationKey() will be called for each site the element should be propagated to. If the method returns the same value as it did for the initial site, then the initial site’s title will be copied over to the target site.

View source (opens new window)

Returns

string (opens new window) – The translation key

getUploader()

Since

3.4.0

Returns the user that uploaded the asset, if known.

View source (opens new window)

Returns

craft\elements\User, null (opens new window)

getUrl()

Returns the element’s full URL.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image If an array is passed, it can optionally include a transform key that defines a base transform which the rest of the settings should be applied to.
• $immediately (boolean (opens new window), null (opens new window)) – Whether the image should be transformed immediately

Returns

string (opens new window), null (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)

getUrlsBySize()

Since

3.7.16

Returns an array of image transform URLs based on the given widths or x-descriptors.

For example, if you pass ['100w', '200w'], you will get:

[
    '100w' => 'image-url@100w.ext',
    '200w' => 'image-url@200w.ext'
]

If you pass x-descriptors, it will be assumed that the image’s current width is the indented 1x width. So if you pass ['1x', '2x'] on an image with a 100px-wide transform applied, you will get:

[
    '1x' => 'image-url@100w.ext',
    '2x' => 'image-url@200w.ext'
]

View source (opens new window)

Arguments

• $sizes (string (opens new window)[])
• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

array (opens new window)

getVolume()

Returns the asset’s volume.

View source (opens new window)

Returns

craft\models\Volume

Throws

• yii\base\InvalidConfigException (opens new window)
  if volumeId is missing or invalid

getVolumeId()

Returns the volume’s ID.

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

getWidth()

Returns the image width.

View source (opens new window)

Arguments

• $transform (array (opens new window), string (opens new window), craft\models\ImageTransform, null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

integer (opens new window), null (opens new window)

gqlMutationNameByContext()

Since

3.5.0

Returns the GraphQL mutation name by an element’s context.

View source (opens new window)

Arguments

• $context (mixed) – The element’s context, such as a volume, entry type, or Matrix block type.

Returns

string (opens new window)

gqlScopesByContext()

Since

3.3.0

Returns the GraphQL scopes required by element’s context.

View source (opens new window)

Arguments

• $context (mixed) – The element’s context, such as a volume, entry type or Matrix block type.

Returns

array (opens new window)

gqlTypeNameByContext()

Since

3.3.0

Returns the GraphQL type name by an element’s context.

View source (opens new window)

Arguments

• $context (mixed) – The element’s context, such as a volume, entry type or Matrix block type.

Returns

string (opens new window)

hasContent()

Returns whether elements of this type will be storing any data in the content table (titles or custom fields).

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type will be storing any data in the content table.

hasTitles()

Returns whether elements of this type have traditional titles.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type have traditional titles.

indexElementCount()

Since

4.4.0

Returns the total number of elements that will be shown on an element index, for the given element query.

View source (opens new window)

Arguments

• $elementQuery (craft\elements\db\ElementQueryInterface)
• $sourceKey (string (opens new window), null (opens new window))

Returns

integer (opens new window)

init()

Since

3.5.0

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

isLocalized()

Returns whether elements of this type store content on a per-site basis.

If this returns true, the element’s getSupportedSites() method will be responsible for defining which sites its content should be stored in.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type store data on a per-site basis.

lowerDisplayName()

Since

3.3.17

Returns the lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

pluralDisplayName()

Since

3.2.0

Returns the plural version of displayName().

View source (opens new window)

Returns

string (opens new window)

pluralLowerDisplayName()

Since

3.3.17

Returns the plural, lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

prepareEditScreen()

Since

4.0.0

Prepares the response for the element’s Edit screen.

View source (opens new window)

Arguments

• $response (yii\web\Response (opens new window)) – The response being prepared
• $containerId (string (opens new window)) – The ID of the element editor’s container element

refHandle()

Returns the handle that should be used to refer to this element type from reference tags.

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The reference handle, or null if the element type doesn’t support reference tags

scenarios()

Returns a list of scenarios and the corresponding active attributes.

An active attribute is one that is subject to validation in the current scenario. The returned array should be in the following format:

[
    'scenario1' => ['attribute11', 'attribute12', ...],
    'scenario2' => ['attribute21', 'attribute22', ...],
    ...
]

By default, an active attribute is considered safe and can be massively assigned. If an attribute should NOT be massively assigned (thus considered unsafe), please prefix the attribute with an exclamation character (e.g. '!rank').

The default implementation of this method will return all scenarios found in the rules() declaration. A special scenario named SCENARIO_DEFAULT (opens new window) will contain all attributes found in the rules(). Each scenario will be associated with the attributes that are being validated by the validation rules that apply to the scenario.

View source (opens new window)

Returns

array (opens new window) – A list of scenarios and the corresponding active attributes.

setEagerLoadedElements()

Since

3.4.0

Sets some eager-loaded elements on a given handle.

View source (opens new window)

Arguments

• $handle (string (opens new window)) – The handle that was used to eager-load the elements
• $elements (self[]) – The eager-loaded elements

setFilename()

Since

4.0.0

Sets the filename (with extension).

View source (opens new window)

Arguments

• $filename (string (opens new window))

setFocalPoint()

Sets the asset's focal point.

View source (opens new window)

Arguments

• $value (array (opens new window), string (opens new window), null (opens new window))

Throws

• InvalidArgumentException (opens new window)
  if $value is invalid

setHeight()

Sets the image height.

View source (opens new window)

Arguments

• $height (integer (opens new window), null (opens new window)) – The image height

setTransform()

Sets the transform.

View source (opens new window)

Arguments

• $transform (craft\models\ImageTransform, string (opens new window), array (opens new window), null (opens new window)) – A transform handle or configuration that should be applied to the image

Returns

craft\elements\Asset

Throws

• craft\errors\ImageTransformException
  if $transform is an invalid transform handle

setUploader()

Since

3.4.0

Sets the asset's uploader.

View source (opens new window)

Arguments

• $uploader (craft\elements\User, null (opens new window))

setVolumeId()

Sets the volume’s ID.

View source (opens new window)

Arguments

• $id (integer (opens new window), null (opens new window))

setWidth()

Sets the image width.

View source (opens new window)

Arguments

• $width (integer (opens new window), null (opens new window)) – The image width

sortOptions()

Returns the sort options for the element type.

This method should return an array, where each item is a sub-array with the following keys:

• label – The sort option label
• orderBy – An array, comma-delimited string, or a callback function that defines the columns to order the query by. If set to a callback function, the function will be passed two arguments: $dir (either SORT_ASC or SORT_DESC) and $db (a craft\db\Connection object), and it should return an array of column names or an yii\db\ExpressionInterface (opens new window) object.
• attribute (optional) – The table attribute name that this option is associated with (required if orderBy is an array or more than one column name)
• defaultDir (optional) – The default sort direction that should be used when sorting by this option (set to either asc or desc). Defaults to asc if not specified.

return [
    [
        'label' => Craft::t('app', 'Attribute Label'),
        'orderBy' => 'columnName',
        'attribute' => 'attributeName',
        'defaultDir' => 'asc',
    ],
];

A shorthand syntax is also supported, if there is no corresponding table attribute, or the table attribute has the exact same name as the column.

return [
    'columnName' => Craft::t('app', 'Attribute Label'),
];

Note that this method will only get called once for the entire index; not each time that a new source is selected.

View source (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

tableAttributes()

Defines all of the available columns that can be shown in table views.

This method should return an array whose keys represent element attribute names, and whose values make up the table’s column headers.

View source (opens new window)

Returns

array (opens new window) – The table attributes.

Protected Methods

Method	Description
cacheTags()	Returns the cache tags that should be cleared when this element is saved.
cpEditUrl()	Returns the element’s edit URL in the control panel.
cpRevisionsUrl()	Returns the element’s revisions index URL in the control panel.
defineActions()	Defines the available element actions for a given source.
defineBehaviors()	Returns the behaviors to attach to this class.
defineDefaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
defineExporters()	Defines the available element exporters for a given source.
defineFieldLayouts()	Defines the field layouts associated with elements for a given source.
defineRules()	Returns the validation rules for attributes.
defineSearchableAttributes()	Defines which element attributes should be searchable.
defineSortOptions()	Returns the sort options for the element type.
defineSources()	Defines the sources that elements of this type may belong to.
defineTableAttributes()	Defines all of the available columns that can be shown in table views.
extractFieldsFor() (opens new window)	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window)	Extracts the root field names from nested fields.
fieldByHandle()	Returns the field with a given handle.
fieldLayoutFields()	Returns each of this element’s fields.
findByCondition()	Finds Element instance(s) by the given condition.
hasFieldLayout()	Returns whether the element has a field layout with at least one tab.
hasNewParent()	Returns whether the element has been assigned a new parent.
htmlAttributes()	Returns any attributes that should be included in the element’s DOM representation in the control panel.
includeSetStatusAction()	Returns whether the Set Status action should be included in actions() automatically.
indexElements()	Returns the resulting elements for an element index.
metaFieldsHtml()	Returns the HTML for any meta fields that should be shown within the editor sidebar.
metadata()	Returns element metadata that should be shown within the editor sidebar.
normalizeFieldValue()	Normalizes a field’s value.
notesFieldHtml()	Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute()	Prepares an element query for an element index that includes a given table attribute.
previewTargets()	Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).
route()	Returns the route that should be used when the element’s URI is requested.
searchKeywords()	Returns the search keywords for a given search attribute.
slugFieldHtml()	Returns the HTML for the element’s Slug field.
statusFieldHtml()	Returns the status field HTML for the sidebar.
tableAttributeHtml()	Returns the HTML that should be shown for a given attribute in Table View.
uiLabel()	Returns what the element should be called within the control panel.

cacheTags()

Since

3.5.0

Returns the cache tags that should be cleared when this element is saved.

View source (opens new window)

Returns

string (opens new window)[]

cpEditUrl()

Since

3.4.0

Returns the element’s edit URL in the control panel.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Example

• PHP
• Twig

$url = $asset->cpEditUrl;

defineActions()

Defines the available element actions for a given source.

View source (opens new window)

Arguments

• $source (string (opens new window)) – The selected source’s key, if any.

Returns

array (opens new window) – The available element actions.

defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source (opens new window)

Arguments

• $source (string (opens new window)) – The selected source’s key

Returns

string (opens new window)[] – The table attributes.

defineFieldLayouts()

Since

3.5.0

Defines the field layouts associated with elements for a given source.

View source (opens new window)

Arguments

• $source (string (opens new window)) – The selected source’s key, if any

Returns

craft\models\FieldLayout[] – The associated field layouts

defineRules()

Since

3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

defineSearchableAttributes()

Defines which element attributes should be searchable.

View source (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

defineSortOptions()

Returns the sort options for the element type.

View source (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

defineSources()

Defines the sources that elements of this type may belong to.

View source (opens new window)

Arguments

• $context (string (opens new window)) – The context ('index', 'modal', 'field', or 'settings').

Returns

array (opens new window) – The sources.

defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source (opens new window)

Returns

array (opens new window) – The table attributes.

htmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the control panel.

View source (opens new window)

Arguments

• $context (string (opens new window)) – The context that the element is being rendered in ('index', 'modal', 'field', or 'settings'.)

Returns

array (opens new window)

indexElements()

Since

4.4.0

Returns the resulting elements for an element index.

View source (opens new window)

Arguments

• $elementQuery (craft\elements\db\ElementQueryInterface)
• $sourceKey (string (opens new window), null (opens new window))

Returns

craft\base\ElementInterface[]

metaFieldsHtml()

Since

3.7.0

Returns the HTML for any meta fields that should be shown within the editor sidebar.

View source (opens new window)

Arguments

• $static (boolean (opens new window)) – Whether the fields should be static (non-interactive)

Returns

string (opens new window)

metadata()

Since

3.7.0

Returns element metadata that should be shown within the editor sidebar.

View source (opens new window)

Returns

array (opens new window) – The data, with keys representing the labels. The values can either be strings or callables. If a value is false, it will be omitted.

prepElementQueryForTableAttribute()

Prepares an element query for an element index that includes a given table attribute.

View source (opens new window)

Arguments

• $elementQuery (craft\elements\db\ElementQueryInterface)
• $attribute (string (opens new window))

tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value.

For example, if your elements have an email attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? Html::mailto(Html::encode($this->email)) : '';
    // ...
}
return parent::tableAttributeHtml($attribute);

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() (opens new window) to prevent XSS attacks.

By default the following will be returned:

• If the attribute name is link or uri, it will be linked to the front-end URL.
• If the attribute is a custom field handle, it will pass the responsibility off to the field type.
• If the attribute value is a DateTime (opens new window) object, the date will be formatted with a localized date format.
• For anything else, it will output the attribute value as a string.

View source (opens new window)

Arguments

• $attribute (string (opens new window)) – The attribute name.

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

Throws

• yii\base\InvalidConfigException (opens new window)

Constants

Constant	Description
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
ERROR_DISALLOWED_EXTENSION
ERROR_FILENAME_CONFLICT
HOMEPAGE_URI
KIND_ACCESS
KIND_AUDIO
KIND_CAPTIONS_SUBTITLES
KIND_COMPRESSED
KIND_EXCEL
KIND_FLASH
KIND_HTML
KIND_ILLUSTRATOR
KIND_IMAGE
KIND_JAVASCRIPT
KIND_JSON
KIND_PDF
KIND_PHOTOSHOP
KIND_PHP
KIND_POWERPOINT
KIND_TEXT
KIND_UNKNOWN
KIND_VIDEO
KIND_WORD
KIND_XML
SCENARIO_CREATE
SCENARIO_DEFAULT	The name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_FILEOPS
SCENARIO_INDEX
SCENARIO_LIVE
SCENARIO_MOVE	Validation scenario that should be used when the asset is only getting moved; not renamed.
SCENARIO_REPLACE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED

Events

EVENT_AFTER_GENERATE_TRANSFORM

Type

craft\events\GenerateTransformEvent

Since

4.0.0

The event that is triggered after a transform is generated for an asset.

EVENT_BEFORE_GENERATE_TRANSFORM

Type

craft\events\GenerateTransformEvent

Since

4.0.0

The event that is triggered before a transform is generated for an asset.

EVENT_BEFORE_HANDLE_FILE

Type

craft\events\AssetEvent

The event that is triggered before an asset is uploaded to volume.

EVENT_DEFINE_URL

Type

craft\events\DefineAssetUrlEvent

Since

4.0.0

The event that is triggered when defining the asset’s URL.

See also getUrl()