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

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
ancestorscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
avoidFilenameConflictsboolean – Whether Asset should avoid filename conflicts when saved.
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component
childrencraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
conflictingFilenamestring, null – The filename that was used that caused a conflict.
contentIdinteger, null – The element’s content row ID
contentTablestring
contentsstring
copyOfFilestring
cpEditUrlstring, null
currentRevisioncraft\base\ElementInterface, null
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateModifiedDateTime, null – Date modified
dateUpdatedDateTime, null – The date that the element was last updated
deletedWithVolumeboolean – Whether the asset was deleted along with its volume
descendantscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
draftIdinteger, null – The ID of the draft’s row in the drafts table
duplicateOfcraft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtmlstring – The HTML for the editor HUD
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site.
errorsarray – Errors for all attributes or the specified attribute.
extensionstring
fieldColumnPrefixstring
fieldContextstring
fieldLayoutcraft\models\FieldLayout, null
fieldLayoutIdinteger, null – The element’s field layout ID
fieldParamNamespacestring, null – The field param namespace
fieldValuesarray – The field values (handle => value)
filenamestring, null – Filename
firstErrorsarray – The first errors.
focalPointarray, string, null
foldercraft\models\VolumeFolder
folderIdinteger, null – Folder ID
folderPathstring, null – Folder path
gqlTypeNamestring
hardDeleteboolean – Whether the element is being hard-deleted.
hasDescendantsboolean
hasFocalPointboolean
hasFreshContentboolean – Whether the element’s content is fresh
hasUrlsboolean
heightinteger, float, null
idinteger, null – The element’s ID
imageTransformSourcePathstring
img\Twig\Markup, null
isDraftboolean
isEditableboolean
isHomepage
isRevisionboolean
isUnsavedDraftboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
keepFileOnDeleteboolean – Whether the associated file should be preserved if the asset record is deleted.
keptFileboolean, null – Whether the file was kept around when the asset was deleted
kindstring, null – Kind
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
link\Twig\Markup, null
locationErrorstring, null – Location error code
mimeTypestring, null
newFilenamestring, null – New filename
newFolderIdinteger, null – New folder id
newLocationstring, null – New file location
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
nextcraft\base\ElementInterface, null
nextSiblingcraft\base\ElementInterface, null
parentcraft\base\ElementInterface, null
pathstring
prevcraft\base\ElementInterface, null
prevSiblingcraft\base\ElementInterface, null
previewTargetsarray
previewingboolean – Whether the element is currently being previewed.
propagateAllboolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
refstring, null
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger – The ID of the revision’s row in the revisions table
rgtinteger, null – The element’s right position within its structure
rootinteger, null – The element’s structure’s root ID
routemixed – The route that the request should use, or null if no special action should be taken
scenariostring – The scenario that this model is in.
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValuesarray
siblingscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
sitecraft\models\Site
siteIdinteger, null – The site ID the element is associated with
sizeinteger, null – Size
slugstring, null – The element’s slug
sourceIdinteger, null
sourceUidstring
statusstring, null
streamresource
structureIdinteger, null – The element’s structure ID
suggestedFilenamestring, null – The suggested filename in case of a conflict.
supportedSitesinteger[], array
supportsImageEditorboolean
supportsPreviewboolean
tempFilePathstring, null – The temp file path
tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
titlestring, null – The element’s title
totalDescendantsinteger
transformcraft\models\AssetTransform, string, array, null – The transform that should be applied, if any.
transformSourcestring
trashedboolean – Whether the element has been soft-deleted.
uiLabelstring
uidstring, null – The element’s UID
uristring, null – The element’s URI
uriFormatstring, null
urlstring, null
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
volumecraft\base\VolumeInterface
volumeIdinteger, null – Volume ID
widthinteger, float, null

avoidFilenameConflicts

Type
boolean

Whether Asset should avoid filename conflicts when saved.

View source

conflictingFilename

Type
string, null

The filename that was used that caused a conflict.

View source

contents

Type
string
Access
Read-only

View source

copyOfFile

Type
string
Access
Read-only

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

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
Access
Read-only

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

gqlTypeName

Type
string
Access
Read-only

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

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

url

Type
string, null
Access
Read-only

View source

volume

Type
craft\base\VolumeInterface
Access
Read-only

View source

volumeId

Type
integer, null

Volume ID

View source

width

Type
integer, float, null

View source

Protected Properties

PropertyDescription
revisionCreatorIdstring, null – Revision creator ID to be saved
revisionNotesstring, null – Revision notes to be saved

Public Methods

MethodDescription
__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 (if one is provided).
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.
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.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
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.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
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 CP edit URL.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDescendants()Returns the element’s descendants.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor HUD.
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.
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.
getGqlTypeName()Returns the GraphQL type name for this element type.
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).
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.
getIsUnsavedDraft()Returns whether the element is an unsaved draft.
getIterator()Returns an iterator for traversing the attributes in the model.
getLink()Returns an anchor pre-filled with this element’s URL and title.
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.
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.
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.
getTotalDescendants()Returns the total number of descendants that the element has.
getTransformSource()
getUiLabel()Returns what the element should be called within the Control Panel.
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.
getWidth()Returns the image width.
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.
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.
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.
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.
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().
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.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
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.
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.
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()

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[]

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

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.

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.

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

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

getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source

Returns

string

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

Returns

\Twig\Markup, null

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

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

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

Returns

string, null

getTransformSource()

View source

Returns

string

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.

Returns

string, null

getVolume()

Returns the asset’s volume.

View source

Returns

craft\base\VolumeInterface

Throws

getWidth()

Returns the image width.

View source

Arguments

Returns

integer, float, null

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.

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.

pluralDisplayName()

Returns the plural 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

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\elements\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\elements\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

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.

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

setWidth()

Sets the image width.

View source

Arguments

Protected Methods

MethodDescription
defineActions()Defines the available element actions for a given source (if one is provided).
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
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.
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 (if one is provided).

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.

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

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

ConstantDescription
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_DEFAULTThe 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.