Asset

Type
Class
Namespace
craft\elements
Inherits
craft\elements\Asset » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

Asset represents an asset element.

View source

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
ancestors craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archived boolean – Whether the element is archived
attributes array – Attribute values (name => value).
avoidFilenameConflicts boolean – Whether Asset should avoid filename conflicts when saved.
awaitingFieldValues boolean – Whether the element is still awaiting its custom field values
behaviors yii\base\Behavior – List of behaviors attached to this component
cacheTags string[]
children craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
conflictingFilename string, null – The filename that was used that caused a conflict.
contentId integer, null – The element’s content row ID
contentTable string
contents string
copyOfFile string
cpEditUrl string, null
currentRevision craft\base\ElementInterface, null
dateCreated DateTime, null – The date that the element was created
dateDeleted DateTime, null – The date that the element was trashed
dateModified DateTime, null – Date modified
dateUpdated DateTime, null – The date that the element was last updated
deletedWithVolume boolean – Whether the asset was deleted along with its volume
descendants craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
dimensions string, null
dirtyAttributes string[]
dirtyFields string[]
draftId integer, null – The ID of the draft’s row in the drafts table
duplicateOf craft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtml string – The HTML for the editor HUD
enabled boolean – Whether the element is enabled
enabledForSite boolean, null – Whether the element is enabled for the given site.
errors array – Errors for all attributes or the specified attribute.
extension string
fieldColumnPrefix string
fieldContext string
fieldLayout craft\models\FieldLayout, null
fieldLayoutId integer, null – The element’s field layout ID
fieldParamNamespace string, null – The field param namespace
fieldValues array – The field values (handle => value)
filename string, null – Filename
firstErrors array – The first errors.
focalPoint array, string, null
folder craft\models\VolumeFolder
folderId integer, null – Folder ID
folderPath string, null – Folder path
formattedSize string, null
formattedSizeInBytes string, null
gqlTypeName string
hardDelete boolean – Whether the element is being hard-deleted.
hasCheckeredThumb boolean
hasDescendants boolean
hasFocalPoint boolean
hasFreshContent boolean – Whether the element’s content is fresh
hasRoundedThumb boolean
hasUrls boolean
height integer, float, null
id integer, null – The element’s ID
imageTransformSourcePath string
img \Twig\Markup, null
isDraft boolean
isEditable boolean
isHomepage boolean
isRevision boolean
isTitleTranslatable boolean
isUnsavedDraft boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
keepFileOnDelete boolean – Whether the associated file should be preserved if the asset record is deleted.
keptFile boolean, null – Whether the file was kept around when the asset was deleted
kind string, null – Kind
language string
level integer, null – The element’s level within its structure
lft integer, null – The element’s left position within its structure
link \Twig\Markup, null
localized craft\elements\db\ElementQueryInterface[], craft\base\ElementInterface[]
locationError string, null – Location error code
mimeType string, null
newFilename string, null – New filename
newFolderId integer, null – New folder id
newLocation string, null – New file location
newSiteIds integer[] – The site IDs that the element was just propagated to for the first time.
next craft\base\ElementInterface, null
nextSibling craft\base\ElementInterface, null
parent craft\base\ElementInterface, null
path string
prev craft\base\ElementInterface, null
prevSibling craft\base\ElementInterface, null
previewTargets array
previewing boolean – Whether the element is currently being previewed.
propagateAll boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating boolean – Whether the element is being saved in the context of propagating another site's version of the element.
ref string, null
resaving boolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer – The ID of the revision’s row in the revisions table
rgt integer, null – The element’s right position within its structure
root integer, null – The element’s structure’s root ID
route mixed – The route that the request should use, or null if no special action should be taken
scenario string – The scenario that this model is in.
searchScore integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValues array
siblings craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
site craft\models\Site
siteId integer, null – The site ID the element is associated with
siteSettingsId integer, null – The ID of the element’s record in the elements_sites table
size integer, null – Size
slug string, null – The element’s slug
sourceId integer, null
sourceUid string
status string, null
stream resource
structureId integer, null – The element’s structure ID
suggestedFilename string, null – The suggested filename in case of a conflict.
supportedSites integer[], array
supportsImageEditor boolean
supportsPreview boolean
tempFilePath string, null – The temp file path
tempId string, null – The element’s temporary ID (only used if the element's URI format contains {id})
title string, null – The element’s title
titleTranslationDescription string, null
titleTranslationKey string – The translation key
totalDescendants integer
transform craft\models\AssetTransform, string, array, null – The transform that should be applied, if any.
transformSource string
trashed boolean – Whether the element has been soft-deleted.
uiLabel string
uid string, null – The element’s UID
uploader craft\elements\User, null
uploaderId integer, null – The ID of the user who first added this asset (if known)
uri string, null – The element’s URI
uriFormat string, null
url string, null
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
volume craft\base\VolumeInterface
volumeId integer, null
width integer, float, null

# avoidFilenameConflicts

Type
boolean

Whether Asset should avoid filename conflicts when saved.

View source

# cacheTags

Type
string[]
Access
Read-only
Since
3.5.0

View source

# conflictingFilename

Type
string, null

The filename that was used that caused a conflict.

View source

# contents

Type
string
Access
Read-only
Since
3.0.6

View source

# copyOfFile

Type
string
Access
Read-only

View source

# cpEditUrl

Type
string, null
Access
Read-only
Since
3.4.0

View source

# dateModified

Type
DateTime, null

Date modified

View source

# deletedWithVolume

Type
boolean

Whether the asset was deleted along with its volume

See also beforeDelete()

View source

# dimensions

Type
string, null
Access
Read-only
Since
3.4.0

View source

# editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

# extension

Type
string
Access
Read-only

View source

# fieldLayout

Type
craft\models\FieldLayout, null
Access
Read-only

View source

# filename

Type
string, null

Filename

View source

# focalPoint

Type
array, string, null

View source

# folder

Type
craft\models\VolumeFolder
Access
Read-only

View source

# folderId

Type
integer, null

Folder ID

View source

# folderPath

Type
string, null

Folder path

View source

# formattedSize

Type
string, null
Access
Read-only
Since
3.4.0

View source

# formattedSizeInBytes

Type
string, null
Access
Read-only
Since
3.4.0

View source

# gqlTypeName

Type
string
Access
Read-only
Since
3.3.0

View source

# hasCheckeredThumb

Type
boolean
Access
Read-only
Since
3.5.5

View source

# hasFocalPoint

Type
boolean
Access
Read-only

View source

# hasUrls

Type
boolean
Access
Read-only

View source

# height

Type
integer, float, null

View source

# imageTransformSourcePath

Type
string
Access
Read-only

View source

# img

Type
\Twig\Markup, null
Access
Read-only

View source

# isEditable

Type
boolean
Access
Read-only

View source

# keepFileOnDelete

Type
boolean

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

See also:

View source

# keptFile

Type
boolean, null

Whether the file was kept around when the asset was deleted

View source

# kind

Type
string, null

Kind

View source

# locationError

Type
string, null

Location error code

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

View source

# mimeType

Type
string, null
Access
Read-only

View source

# newFilename

Type
string, null

New filename

View source

# newFolderId

Type
integer, null

New folder id

View source

# newLocation

Type
string, null

New file location

View source

# path

Type
string
Access
Read-only

View source

# previewTargets

Type
array
Access
Read-only
Since
3.2.0

View source

# size

Type
integer, null

Size

View source

# stream

Type
resource
Access
Read-only

View source

# suggestedFilename

Type
string, null

The suggested filename in case of a conflict.

View source

# supportsImageEditor

Type
boolean
Access
Read-only

View source

# supportsPreview

Type
boolean
Access
Read-only

View source

# tempFilePath

Type
string, null

The temp file path

View source

# transform

Type
craft\models\AssetTransform, string, array, null
Access
Write-only

The transform that should be applied, if any. Can either be the handle of a named transform, or an array that defines the transform settings.

View source

# transformSource

Type
string

View source

# uploader

Type
craft\elements\User, null
Access
Read-only
Since
3.4.0

View source

# uploaderId

Type
integer, null

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

View source

# url

Type
string, null
Access
Read-only

View source

# volume

Type
craft\base\VolumeInterface
Access
Read-only

View source

# volumeId

Type
integer, null
Access
Read-only

View source

# width

Type
integer, float, null

View source

# Protected Properties

Property Description
revisionCreatorId string, null – Revision creator ID to be saved
revisionNotes string, null – Revision notes to be saved

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__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() Sets an object property to null.
actions() Returns the available element actions for a given source.
activeAttributes() Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() 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() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
attributeHints() 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() This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() Returns a value indicating whether a property can be read.
canSetProperty() Returns a value indicating whether a property can be set.
className() Returns the fully qualified name of this class.
clearErrors() Removes errors for all attributes or a single attribute.
copyWithTransform() Returns a copy of the asset with the given transform applied to it.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineFieldLayouts() Defines the field layouts associated with elements for a given source.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() 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() Makes sure that the behaviors declared in behaviors() 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().
fieldLayouts() Returns all of the field layouts associated with elements from the given source.
fields() Returns the list of fields that should be returned by default by toArray() 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.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() Returns the validators applicable to the current scenario.
getAncestors() Returns the element’s ancestors.
getAttributeHint() 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() Returns attribute values.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getCacheTags() Returns the cache tags that should be cleared when this element is saved.
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.
getCurrentRevision() Returns the element’s current revision, if one exists.
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.
getEditorHtml() Returns the HTML for the element’s editor HUD.
getEnabledForSite() Returns whether the element is enabled for the current site.
getError() Returns the first error of the specified attribute.
getErrorSummary() Returns the errors for all attributes as a one-dimensional array.
getErrors() 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.
getFieldStatus() Returns the status of a given field.
getFieldValue() Returns the value for a given field.
getFieldValues() Returns the element’s normalized custom field values, indexed by their handles.
getFilename() Returns the file name, with or without the extension.
getFirstError() Returns the first error of the specified attribute.
getFirstErrors() 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.
getFormattedSize() Returns the formatted file size, if known.
getFormattedSizeInBytes() Returns the formatted file size in bytes, if known.
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.
getHasFreshContent() Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHasRoundedThumb() Returns whether the element’s thumbnail should be rounded.
getHasUrls() Return whether the Asset has a URL.
getHeight() Returns the image height.
getHtmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() Returns the element’s ID.
getImageTransformSourcePath() Return the path where the source for this Asset's transforms should be.
getImg() Returns an <img> tag based on this asset.
getIsDraft() Returns whether this is a draft.
getIsEditable() Returns whether the current user can edit the element.
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.
getIsUnsavedDraft() Returns whether the element is an unsaved draft.
getIterator() 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.
getMimeType() Returns the file’s MIME type, if it can be determined.
getNext() Returns the next element relative to this one, from a given set of criteria.
getNextSibling() Returns the element’s next sibling.
getParent() Returns the element’s parent.
getPath() Returns the asset's path in the volume.
getPrev() Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() Returns the element’s previous sibling.
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() 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.
getSite() Returns the site the element is associated with.
getSourceId() Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
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.
getSupportsPreview() Returns whether this asset can be previewed.
getTableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.
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.
getTransformSource()
getUiLabel() Returns what the element should be called within the control panel.
getUploader() Returns the user that uploaded the asset, if known.
getUri() Returns the asset's path in the volume.
getUriFormat() Returns the URI format used to generate this element’s URI.
getUrl() Returns the element’s full URL.
getValidators() Returns all the validators declared in rules().
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() Returns a value indicating whether there is any handler attached to the named event.
hasMethod() Returns a value indicating whether a method is defined.
hasProperty() Returns a value indicating whether a property is defined.
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.
indexHtml() Returns the element index HTML.
init() Initializes the object.
instance() Returns static class instance, which can be used to obtain meta information.
isAncestorOf() Returns whether this element is an ancestor of another one.
isAttributeActive() 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.
isAttributeRequired() Returns a value indicating whether the attribute is required.
isAttributeSafe() 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.
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() Populates the model with input data.
loadMultiple() 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.
off() Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() Returns the element at the specified offset.
offsetSet() Sets the element at the specified offset.
offsetUnset() Sets the element value at the specified offset to null.
on() Attaches an event handler to an event.
onUnsafeAttribute() 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().
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() 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.
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.
setFocalPoint() Sets the asset's focal point.
setHeight() Sets the image height.
setNext() Sets the default next element.
setParent() Sets the element’s parent.
setPrev() Sets the default previous element.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() Sets the scenario for the model.
setTransform() Sets the transform.
setTransformSource() Set a source to use for transforms for this Assets File.
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() 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() Triggers an event.
validate() Performs the data validation.
validateCustomFieldAttribute() Calls a custom validation function on a custom field.
validateCustomFieldContentSize() Validates that the content size is going to fit within the field’s database column.
validateMultiple() Validates multiple models.

# __get()

Returns a property value.

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

View source

Arguments

  • $name (string) – The property name

Returns

mixed – The property value

Throws

# __isset()

Checks if a property is set.

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

View source

Arguments

  • $name (string) – The property name

Returns

boolean – Whether the property is set

# __toString()

Returns the string representation of the element.

View source

Returns

string

# afterDelete()

Performs actions after an element is deleted.

View source

# afterSave()

Performs actions after an element is saved.

View source

Arguments

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

Throws

  • yii\base\Exception
    if the asset isn't new but doesn't have a row in the assets table for some reason

# 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

Returns

array – List of attribute names.

# beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

# beforeRestore()

Since
3.1.0

Performs actions before an element is restored.

View source

Returns

boolean – Whether the element should be restored

# beforeSave()

Performs actions before an element is saved.

View source

Arguments

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

Returns

boolean – Whether the element should be saved

# copyWithTransform()

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

View source

Arguments

Returns

craft\elements\Asset

Throws

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

# defineFieldLayouts()

Since
3.5.0

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

View source

Arguments

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

Returns

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

# displayName()

Returns the display name of this class.

View source

Returns

string – 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

Arguments

  • $sourceElements (craft\base\ElementInterface[]) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

array, false, null – 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().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), 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

Returns

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

# fields()

Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.

A field is a named element in the returned array by toArray().

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function () {
        return $this->first_name . ' ' . $this->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns the public object member variables indexed by themselves.

View source

Returns

array – The list of field names or field definitions.

# 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()
    {
        // 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()
    {
        return parent::find()->limit(50);
    }
}

View source

Returns

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

# getCacheTags()

Since
3.5.0

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

View source

Returns

string[]

# getContents()

Since
3.0.6

Returns the file’s contents.

View source

Returns

string

Throws

# getCopyOfFile()

Get a temporary copy of the actual file.

View source

Returns

string

# getCpEditUrl()

Since
3.4.0

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

View source

Returns

string, null

Example

$url = $asset->cpEditUrl;

# getDimensions()

Since
3.4.0

Returns the image dimensions.

View source

Returns

string, null

# getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

# getExtension()

Returns the file extension.

View source

Returns

string

# getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

# getFilename()

Returns the file name, with or without the extension.

View source

Arguments

Returns

string

# getFocalPoint()

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

View source

Arguments

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

Returns

array, string, null

# getFolder()

Returns the asset’s volume folder.

View source

Returns

craft\models\VolumeFolder

Throws

# getFormattedSize()

Since
3.4.0

Returns the formatted file size, if known.

View source

Arguments

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

Returns

string, null

# getFormattedSizeInBytes()

Since
3.4.0

Returns the formatted file size in bytes, if known.

View source

Arguments

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

Returns

string, null

# getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source

Returns

string

# getHasCheckeredThumb()

Since
3.5.5

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

View source

Returns

boolean

# getHasFocalPoint()

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

View source

Returns

boolean

# getHasUrls()

DEPRECATED

Deprecated in 3.0.0-RC12. Use getVolume()->hasUrls instead.

Return whether the Asset has a URL.

View source

Returns

boolean

# getHeight()

Returns the image height.

View source

Arguments

Returns

integer, float, null

# getImageTransformSourcePath()

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

View source

Returns

string

# getImg()

Returns an <img> tag based on this asset.

View source

Arguments

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

Returns

\Twig\Markup, null

Throws

# getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

# getMimeType()

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

View source

Returns

string, null

# getPath()

Returns the asset's path in the volume.

View source

Arguments

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

Returns

string

# 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

Returns

array

# getPreviewThumbImg()

Since
3.4.0

Returns preview thumb image HTML.

View source

Arguments

Returns

string

Throws

# 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 indented 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

Arguments

Returns

string, false – The srcset attribute value, or false if it can’t be determined

Throws

# getStream()

Returns a stream of the actual file.

View source

Returns

resource

Throws

# getSupportsImageEditor()

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

View source

Returns

boolean

# getSupportsPreview()

DEPRECATED

Deprecated in 3.4.0. Use craft\services\Assets::getAssetPreviewHandler() instead.

Returns whether this asset can be previewed.

View source

Returns

boolean

# getThumbUrl()

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

View source

Arguments

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

Returns

string, null

# getTransformSource()

View source

Returns

string

# getUploader()

Since
3.4.0

Returns the user that uploaded the asset, if known.

View source

Returns

craft\elements\User, null

# getUri()

DEPRECATED

Deprecated in 3.0.0-RC12

Returns the asset's path in the volume.

View source

Arguments

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

Returns

string

# getUrl()

Returns the element’s full URL.

View source

Arguments

  • $transform (string, array, null) – The transform that should be applied, if any. Can either be the handle of a named transform, or an array that defines the transform settings. 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.
  • $generateNow (boolean, null) – Whether the transformed image should be generated immediately if it doesn’t exist. If null, it will be left up to the generateTransformsBeforePageLoad config setting.

Returns

string, null

Throws

# getVolume()

Returns the asset’s volume.

View source

Returns

craft\base\VolumeInterface

Throws

# getVolumeId()

Returns the volume’s ID.

View source

Returns

integer, null

# getWidth()

Returns the image width.

View source

Arguments

Returns

integer, float, null

# gqlMutationNameByContext()

Since
3.5.0

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

View source

Arguments

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

Returns

string

# gqlScopesByContext()

Since
3.3.0

Returns the GraphQL scopes required by element's context.

View source

Arguments

  • $context (mixed) – The element's context, such as a Volume, Entry Type or Matrix Block Type.

Returns

array

# gqlTypeNameByContext()

Since
3.3.0

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

View source

Arguments

  • $context (mixed) – The element's context, such as a Volume, Entry Type or Matrix Block Type.

Returns

string

# hasContent()

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

View source

Returns

boolean – 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

Returns

boolean – Whether elements of this type have traditional titles.

# 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

# 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

Returns

boolean – 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

Returns

string

# pluralDisplayName()

Since
3.2.0

Returns the plural version of displayName().

View source

Returns

string

# pluralLowerDisplayName()

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source

Returns

string

# refHandle()

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

View source

Returns

string, null – 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 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

Returns

array – 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

Arguments

# setFocalPoint()

Sets the asset's focal point.

View source

Arguments

  • $value – String|array|null

Throws

# setHeight()

Sets the image height.

View source

Arguments

# setTransform()

Sets the transform.

View source

Arguments

Returns

craft\elements\Asset

Throws

# setTransformSource()

Set a source to use for transforms for this Assets File.

View source

Arguments

# setUploader()

Since
3.4.0

Sets the asset's uploader.

View source

Arguments

# setVolumeId()

Sets the volume’s ID.

View source

Arguments

# setWidth()

Sets the image width.

View source

Arguments

# Protected Methods

Method Description
defineActions() Defines the available element actions for a given source.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() Defines the available element exporters 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() 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() 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.
htmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() Normalizes a field’s value.
prepElementQueryForTableAttribute() Preps the element criteria for a given table attribute
previewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() Determines which fields can be returned by toArray().
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.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# defineActions()

Defines the available element actions for a given source.

View source

Arguments

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

Returns

array – The available element actions.

# defineDefaultTableAttributes()

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

View source

Arguments

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

Returns

string[] – The table attributes.

# 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

Returns

array

# defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

# defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

# defineSources()

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

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

# defineTableAttributes()

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

View source

Returns

array – The table attributes.

# htmlAttributes()

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

View source

Arguments

  • $context (string) – The context that the element is being rendered in ('index', 'field', etc.)

Returns

array

# prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source

Arguments

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

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Throws

# Constants

Constant Description
ATTR_STATUS_CONFLICTED
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
ERROR_DISALLOWED_EXTENSION
ERROR_FILENAME_CONFLICT
HOMEPAGE_URI
KIND_ACCESS
KIND_AUDIO
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_REPLACE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED

# Events

# EVENT_BEFORE_HANDLE_FILE

Type
craft\events\AssetEvent

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