Class craft\elements\Asset

Inheritance: 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\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/elements/Asset.php

Asset represents an asset element.

Public Properties
Property	Type	Description	Defined By
`$archived`	boolean	Whether the element is archived	craft\base\ElementTrait
`$avoidFilenameConflicts`	boolean	Whether Asset should avoid filename conflicts when saved.	craft\elements\Asset
`$awaitingFieldValues`	boolean	Whether the element is still awaiting its custom field values	craft\base\ElementTrait
`$conflictingFilename`	string, null	The filename that was used that caused a conflict.	craft\elements\Asset
`$contentId`	integer, null	The element’s content row ID	craft\base\ElementTrait
`$dateCreated`	DateTime, null	The date that the element was created	craft\base\ElementTrait
`$dateModified`	DateTime, null	Date modified	craft\elements\Asset
`$dateUpdated`	DateTime, null	The date that the element was last updated	craft\base\ElementTrait
`$enabled`	boolean	Whether the element is enabled	craft\base\ElementTrait
`$enabledForSite`	boolean	Whether the element is enabled for this site.	craft\base\ElementTrait
`$fieldLayoutId`	integer, null	The element’s field layout ID	craft\base\ElementTrait
`$filename`	string, null	Filename	craft\elements\Asset
`$folderId`	integer, null	Folder ID	craft\elements\Asset
`$folderPath`	string, null	Folder path	craft\elements\Asset
`$id`	integer, null	The element’s ID	craft\base\ElementTrait
`$keepFileOnDelete`	boolean	Whether the associated file should be preserved if the asset record is deleted.	craft\elements\Asset
`$kind`	string, null	Kind	craft\elements\Asset
`$level`	integer, null	The element’s level within its structure	craft\base\ElementTrait
`$lft`	integer, null	The element’s left position within its structure	craft\base\ElementTrait
`$locationError`	string, null	Location error code	craft\elements\Asset
`$newFilename`	string, null	New filename	craft\elements\Asset
`$newFolderId`	integer, null	New folder id	craft\elements\Asset
`$newLocation`	string, null	New file location	craft\elements\Asset
`$propagating`	boolean	Whether the element is being saved in the context of propagating another site's version of the element.	craft\base\ElementTrait
`$rgt`	integer, null	The element’s right position within its structure	craft\base\ElementTrait
`$root`	integer, null	The element’s structure’s root ID	craft\base\ElementTrait
`$searchScore`	integer, null	The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element	craft\base\ElementTrait
`$siteId`	integer, null	The site ID the element is associated with	craft\base\ElementTrait
`$size`	integer, null	Size	craft\elements\Asset
`$slug`	string, null	The element’s slug	craft\base\ElementTrait
`$structureId`	integer, null	The element’s structure ID	craft\base\ElementTrait
`$suggestedFilename`	string, null	The suggested filename in case of a conflict.	craft\elements\Asset
`$tempFilePath`	string, null	The temp file path	craft\elements\Asset
`$tempId`	string, null	The element’s temporary ID (only used if the element's URI format contains {id})	craft\base\ElementTrait
`$title`	string, null	The element’s title	craft\base\ElementTrait
`$uid`	string, null	The element’s UID	craft\base\ElementTrait
`$uri`	string, null	The element’s URI	craft\base\ElementTrait
`$volumeId`	integer, null	Source ID	craft\elements\Asset

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	craft\base\Element
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns a property value.	craft\elements\Asset
`__isset()`	Checks if a property is set.	craft\elements\Asset
`__set()`	Sets the value of a component property.	craft\base\Element
`__toString()`		craft\elements\Asset
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`actions()`	Returns the available element actions for a given source (if one is provided).	craft\base\Element
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	yii\base\Model
`addError()`	Adds a new error to the specified attribute.	craft\base\Element
`addErrors()`	Adds a list of errors.	yii\base\Model
`addModelErrors()`	Adds errors from another model, with a given attribute name prefix.	craft\base\Model
`afterDelete()`	Performs actions after an element is deleted.	craft\elements\Asset
`afterMoveInStructure()`	Performs actions after an element is moved within a structure.	craft\base\Element
`afterSave()`	Performs actions after an element is saved.	craft\elements\Asset
`afterValidate()`	This method is invoked after validation ends.	yii\base\Model
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`attributeHints()`	Returns the attribute hints.	yii\base\Model
`attributeLabels()`	Returns the attribute labels.	craft\base\Element
`attributes()`	Returns the list of attribute names.	craft\elements\Asset
`beforeDelete()`	Performs actions before an element is deleted.	craft\base\Element
`beforeMoveInStructure()`	Performs actions before an element is moved within a structure.	craft\base\Element
`beforeSave()`	Performs actions before an element is saved.	craft\elements\Asset
`beforeValidate()`	This method is invoked before validation starts.	yii\base\Model
`behaviors()`	Returns a list of behaviors that this component should behave as.	craft\base\Element
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`clearErrors()`	Removes errors for all attributes or a single attribute.	yii\base\Model
`copyWithTransform()`	Returns a copy of the asset with the given transform applied to it.	craft\elements\Asset
`createValidators()`	Creates validator objects based on the validation rules specified in rules().	yii\base\Model
`datetimeAttributes()`	Returns the names of any attributes that should hold DateTime values.	craft\elements\Asset
`defaultTableAttributes()`	Returns the list of table attribute keys that should be shown by default.	craft\base\Element
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`displayName()`	Returns the display name of this class.	craft\elements\Asset
`eagerLoadingMap()`	Returns an array that maps source-to-target element IDs based on the given sub-property handle.	craft\base\Element
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`extraFields()`	Returns the list of fields that can be expanded further and returned by toArray().	craft\elements\Asset
`fields()`	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	yii\base\ArrayableTrait
`find()`	Creates an craft\elements\db\ElementQueryInterface instance for query purpose.	craft\elements\Asset
`findAll()`	Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.	craft\base\Element
`findOne()`	Returns a single element instance by a primary key or a set of element criteria parameters.	craft\base\Element
`formName()`	Returns the form name that this model class should use.	yii\base\Model
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	yii\base\Model
`getActiveValidators()`	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
`getAncestors()`	Returns the element’s ancestors.	craft\base\Element
`getAttributeHint()`	Returns the text hint for the specified attribute.	yii\base\Model
`getAttributeLabel()`	Returns the text label for the specified attribute.	craft\base\Element
`getAttributes()`	Returns attribute values.	yii\base\Model
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getChildren()`	Returns the element’s children.	craft\base\Element
`getContentTable()`	Returns the name of the table this element’s content is stored in.	craft\base\Element
`getCopyOfFile()`	Get a temporary copy of the actual file.	craft\elements\Asset
`getCpEditUrl()`	Returns the element’s CP edit URL.	craft\base\Element
`getDescendants()`	Returns the element’s descendants.	craft\base\Element
`getEagerLoadedElements()`	Returns the eager-loaded elements for a given handle.	craft\base\Element
`getEditorHtml()`	Returns the HTML for the element’s editor HUD.	craft\elements\Asset
`getError()`	Returns the first error of the specified attribute.	craft\base\Model
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
`getErrors()`	Returns the errors for all attributes or a single attribute.	yii\base\Model
`getExtension()`	Returns the file extension.	craft\elements\Asset
`getFieldColumnPrefix()`	Returns the field column prefix this element’s content uses.	craft\base\Element
`getFieldContext()`	Returns the field context this element’s content uses.	craft\base\Element
`getFieldLayout()`	Returns the field layout used by this element.	craft\elements\Asset
`getFieldParamNamespace()`	Returns the namespace used by custom field params on the request.	craft\base\Element
`getFieldValue()`	Returns the value for a given field.	craft\base\Element
`getFieldValues()`	Returns the element’s normalized custom field values, indexed by their handles.	craft\base\Element
`getFilename()`	Returns the file name, with or without the extension.	craft\elements\Asset
`getFirstError()`	Returns the first error of the specified attribute.	yii\base\Model
`getFirstErrors()`	Returns the first error of every attribute in the model.	yii\base\Model
`getFocalPoint()`	Returns the focal point represented as an array with `x` and `y` keys, or null if it's not an image.	craft\elements\Asset
`getFolder()`	Returns the asset’s volume folder.	craft\elements\Asset
`getHasDescendants()`	Returns whether the element has descendants.	craft\base\Element
`getHasFocalPoint()`	Returns whether a user-defined focal point is set on the asset.	craft\elements\Asset
`getHasFreshContent()`	Returns whether the element’s content is "fresh" (unsaved and without validation errors).	craft\base\Element
`getHasUrls()`	Return whether the Asset has a URL.	craft\elements\Asset
`getHeight()`	Returns the image height.	craft\elements\Asset
`getHtmlAttributes()`	Returns any attributes that should be included in the element’s DOM representation in the Control Panel.	craft\base\Element
`getId()`	Returns the element’s ID.	craft\base\Element
`getImageTransformSourcePath()`	Return the path where the source for this Asset's transforms should be.	craft\elements\Asset
`getImg()`	Returns an `<img>` tag based on this asset.	craft\elements\Asset
`getIsEditable()`	Returns whether the current user can edit the element.	craft\elements\Asset
`getIterator()`	Returns an iterator for traversing the attributes in the model.	yii\base\Model
`getLink()`	Returns an anchor pre-filled with this element’s URL and title.	craft\base\Element
`getMimeType()`	Returns the file’s MIME type, if it can be determined.	craft\elements\Asset
`getNext()`	Returns the next element relative to this one, from a given set of criteria.	craft\base\Element
`getNextSibling()`	Returns the element’s next sibling.	craft\base\Element
`getParent()`	Returns the element’s parent.	craft\base\Element
`getPath()`	Returns the asset's path in the volume.	craft\elements\Asset
`getPrev()`	Returns the previous element relative to this one, from a given set of criteria.	craft\base\Element
`getPrevSibling()`	Returns the element’s previous sibling.	craft\base\Element
`getRef()`	Returns the reference string to this element.	craft\base\Element
`getRoute()`	Returns the route that should be used when the element’s URI is requested.	craft\base\Element
`getScenario()`	Returns the scenario that this model is used in.	yii\base\Model
`getSearchKeywords()`	Returns the search keywords for a given search attribute.	craft\base\Element
`getSerializedFieldValues()`	Returns an array of the element’s serialized custom field values, indexed by their handles.	craft\base\Element
`getSiblings()`	Returns all of the element’s siblings.	craft\base\Element
`getSite()`	Returns the site the element is associated with.	craft\base\Element
`getStatus()`	Returns the element’s status.	craft\base\Element
`getStream()`	Get a stream of the actual file.	craft\elements\Asset
`getSupportedSites()`	Returns the sites this element is associated with.	craft\base\Element
`getSupportsImageEditor()`	Returns whether this asset can be edited by the image editor.	craft\elements\Asset
`getSupportsPreview()`	Returns whether this asset can be previewed.	craft\elements\Asset
`getTableAttributeHtml()`	Returns the HTML that should be shown for a given attribute in Table View.	craft\base\Element
`getThumbUrl()`	Returns the URL to the element’s thumbnail, if there is one.	craft\elements\Asset
`getTotalDescendants()`	Returns the total number of descendants that the element has.	craft\base\Element
`getTransformSource()`		craft\elements\Asset
`getUri()`	Returns the asset's path in the volume.	craft\elements\Asset
`getUriFormat()`	Returns the URI format used to generate this element’s URI.	craft\base\Element
`getUrl()`	Returns the element’s full URL.	craft\elements\Asset
`getValidators()`	Returns all the validators declared in rules().	yii\base\Model
`getVolume()`	Returns the asset’s volume.	craft\elements\Asset
`getWidth()`	Returns the image width.	craft\elements\Asset
`hasContent()`	Returns whether elements of this type will be storing any data in the `content` table (tiles or custom fields).	craft\elements\Asset
`hasEagerLoadedElements()`	Returns whether elements have been eager-loaded with a given handle.	craft\base\Element
`hasErrors()`	Returns a value indicating whether there is any validation error.	yii\base\Model
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`hasStatuses()`	Returns whether elements of this type have statuses.	craft\base\Element
`hasTitles()`	Returns whether elements of this type have traditional titles.	craft\elements\Asset
`hasUris()`	Returns whether elements of this type can have their own slugs and URIs.	craft\base\Element
`indexHtml()`	Returns the element index HTML.	craft\base\Element
`init()`	Initializes the object.	craft\base\Element
`instance()`	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
`isAncestorOf()`	Returns whether this element is an ancestor of another one.	craft\base\Element
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	yii\base\Model
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	yii\base\Model
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	yii\base\Model
`isChildOf()`	Returns whether this element is a direct child of another one.	craft\base\Element
`isDescendantOf()`	Returns whether this element is a descendant of another one.	craft\base\Element
`isFieldEmpty()`	Returns whether a field is empty.	craft\base\Element
`isLocalized()`	Returns whether elements of this type store content on a per-site basis.	craft\elements\Asset
`isNextSiblingOf()`	Returns whether this element is the direct next sibling of another one.	craft\base\Element
`isParentOf()`	Returns whether this element is a direct parent of another one.	craft\base\Element
`isPrevSiblingOf()`	Returns whether this element is the direct previous sibling of another one.	craft\base\Element
`isSiblingOf()`	Returns whether this element is a sibling of another one.	craft\base\Element
`load()`	Populates the model with input data.	yii\base\Model
`loadMultiple()`	Populates a set of models with the data from end user.	yii\base\Model
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`offsetExists()`	Returns whether there is an element at the specified offset.	craft\base\Element
`offsetGet()`	Returns the element at the specified offset.	yii\base\Model
`offsetSet()`	Sets the element at the specified offset.	yii\base\Model
`offsetUnset()`	Sets the element value at the specified offset to null.	yii\base\Model
`on()`	Attaches an event handler to an event.	yii\base\Component
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	yii\base\Model
`refHandle()`	Returns the handle that should be used to refer to this element type from reference tags.	craft\elements\Asset
`rules()`	Returns the validation rules for attributes.	craft\elements\Asset
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	yii\base\Model
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	craft\elements\Asset
`searchableAttributes()`	Defines which element attributes should be searchable.	craft\base\Element
`setAttributes()`	Sets the attribute values in a massive way.	yii\base\Model
`setEagerLoadedElements()`	Sets some eager-loaded elements on a given handle.	craft\base\Element
`setFieldParamNamespace()`	Sets the namespace used by custom field params on the request.	craft\base\Element
`setFieldValue()`	Sets the value for a given field.	craft\base\Element
`setFieldValues()`	Sets the element’s custom field values.	craft\base\Element
`setFieldValuesFromRequest()`	Sets the element’s custom field values, when the values have come from post data.	craft\base\Element
`setFocalPoint()`	Sets the asset's focal point.	craft\elements\Asset
`setHeight()`	Sets the image height.	craft\elements\Asset
`setNext()`	Sets the default next element.	craft\base\Element
`setParent()`	Sets the element’s parent.	craft\base\Element
`setPrev()`	Sets the default previous element.	craft\base\Element
`setScenario()`	Sets the scenario for the model.	yii\base\Model
`setTransform()`	Sets the transform.	craft\elements\Asset
`setTransformSource()`	Set a source to use for transforms for this Assets File.	craft\elements\Asset
`setWidth()`	Sets the image width.	craft\elements\Asset
`sortOptions()`	Returns the sort options for the element type.	craft\base\Element
`sources()`	Returns the source definitions that elements of this type may belong to.	craft\base\Element
`statuses()`	Returns all of the possible statuses that elements of this type may have.	craft\base\Element
`tableAttributes()`	Defines all of the available columns that can be shown in table views.	craft\base\Element
`toArray()`	Converts the model into an array.	yii\base\ArrayableTrait
`trigger()`	Triggers an event.	yii\base\Component
`validate()`	Performs the data validation.	yii\base\Model
`validateCustomFieldAttribute()`	Calls a custom validation function on a custom field.	craft\base\Element
`validateCustomFieldContentSize()`	Validates that the content size is going to fit within the field’s database column.	craft\base\Element
`validateMultiple()`	Validates multiple models.	yii\base\Model

Protected Methods
Method	Description	Defined By
`defineActions()`	Defines the available element actions for a given source (if one is provided).	craft\elements\Asset
`defineDefaultTableAttributes()`	Returns the list of table attribute keys that should be shown by default.	craft\elements\Asset
`defineSearchableAttributes()`	Defines which element attributes should be searchable.	craft\elements\Asset
`defineSortOptions()`	Returns the sort options for the element type.	craft\elements\Asset
`defineSources()`	Defines the sources that elements of this type may belong to.	craft\elements\Asset
`defineTableAttributes()`	Defines all of the available columns that can be shown in table views.	craft\elements\Asset
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`fieldByHandle()`	Returns the field with a given handle.	craft\base\Element
`fieldLayoutFields()`	Returns each of this element’s fields.	craft\base\Element
`findByCondition()`	Finds Element instance(s) by the given condition.	craft\base\Element
`htmlAttributes()`	Returns any attributes that should be included in the element’s DOM representation in the Control Panel.	craft\elements\Asset
`normalizeFieldValue()`	Normalizes a field’s value.	craft\base\Element
`prepElementQueryForTableAttribute()`	Preps the element criteria for a given table attribute	craft\base\Element
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait
`route()`	Returns the route that should be used when the element’s URI is requested.	craft\base\Element
`tableAttributeHtml()`	Returns the HTML that should be shown for a given attribute in Table View.	craft\elements\Asset

Events
Event	Type	Description	Defined By
`EVENT_AFTER_DELETE`	yii\base\Event	The event that is triggered after the element is deleted	craft\base\Element
`EVENT_AFTER_MOVE_IN_STRUCTURE`	craft\events\ElementStructureEvent	The event that is triggered after the element is moved in a structure.	craft\base\Element
`EVENT_AFTER_SAVE`	craft\events\ModelEvent	The event that is triggered after the element is saved	craft\base\Element
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_DELETE`	craft\events\ModelEvent	The event that is triggered before the element is deleted You may set craft\events\ModelEvent::$isValid to `false` to prevent the element from getting deleted.	craft\base\Element
`EVENT_BEFORE_HANDLE_FILE`	craft\events\AssetEvent	The event that is triggered before an asset is uploaded to volume.	craft\elements\Asset
`EVENT_BEFORE_MOVE_IN_STRUCTURE`	craft\events\ElementStructureEvent	The event that is triggered before the element is moved in a structure.	craft\base\Element
`EVENT_BEFORE_SAVE`	craft\events\ModelEvent	The event that is triggered before the element is saved You may set craft\events\ModelEvent::$isValid to `false` to prevent the element from getting saved.	craft\base\Element
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model
`EVENT_DEFINE_BEHAVIORS`	craft\events\DefineBehaviorsEvent	The event that is triggered when defining the class behaviors	craft\base\Component
`EVENT_INIT`	yii\base\Event	The event that is triggered after the component's init cycle	craft\base\Component
`EVENT_REGISTER_ACTIONS`	craft\events\RegisterElementActionsEvent	The event that is triggered when registering the available actions for the element type.	craft\base\Element
`EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES`	craft\events\RegisterElementTableAttributesEvent	The event that is triggered when registering the table attributes for the element type.	craft\base\Element
`EVENT_REGISTER_HTML_ATTRIBUTES`	craft\events\RegisterElementHtmlAttributesEvent	The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the Control Panel.	craft\base\Element
`EVENT_REGISTER_SEARCHABLE_ATTRIBUTES`	craft\events\RegisterElementSearchableAttributesEvent	The event that is triggered when registering the searchable attributes for the element type.	craft\base\Element
`EVENT_REGISTER_SORT_OPTIONS`	craft\events\RegisterElementSortOptionsEvent	The event that is triggered when registering the sort options for the element type.	craft\base\Element
`EVENT_REGISTER_SOURCES`	craft\events\RegisterElementSourcesEvent	The event that is triggered when registering the available sources for the element type.	craft\base\Element
`EVENT_REGISTER_TABLE_ATTRIBUTES`	craft\events\RegisterElementTableAttributesEvent	The event that is triggered when registering the table attributes for the element type.	craft\base\Element
`EVENT_SET_ROUTE`	craft\events\SetElementRouteEvent	The event that is triggered when defining the route that should be used when this element’s URL is requested `php Event::on(craft\elements\Entry::class, craft\base\Element::EVENT_SET_ROUTE, function(craft\events\SetElementRouteEvent $e) { // @var craft\elements\Entry $entry $entry = $e->sender; if ($entry->uri === 'pricing') { $e->route = 'module/pricing/index'; } } `	craft\base\Element
`EVENT_SET_TABLE_ATTRIBUTE_HTML`	craft\events\SetElementTableAttributeHtmlEvent	The event that is triggered when defining the HTML to represent a table attribute.	craft\base\Element

Constants
Constant	Value	Description	Defined By
`ERROR_DISALLOWED_EXTENSION`	'disallowed_extension'		craft\elements\Asset
`ERROR_FILENAME_CONFLICT`	'filename_conflict'		craft\elements\Asset
`KIND_ACCESS`	'access'		craft\elements\Asset
`KIND_AUDIO`	'audio'		craft\elements\Asset
`KIND_COMPRESSED`	'compressed'		craft\elements\Asset
`KIND_EXCEL`	'excel'		craft\elements\Asset
`KIND_FLASH`	'flash'		craft\elements\Asset
`KIND_HTML`	'html'		craft\elements\Asset
`KIND_ILLUSTRATOR`	'illustrator'		craft\elements\Asset
`KIND_IMAGE`	'image'		craft\elements\Asset
`KIND_JAVASCRIPT`	'javascript'		craft\elements\Asset
`KIND_JSON`	'json'		craft\elements\Asset
`KIND_PDF`	'pdf'		craft\elements\Asset
`KIND_PHOTOSHOP`	'photoshop'		craft\elements\Asset
`KIND_PHP`	'php'		craft\elements\Asset
`KIND_POWERPOINT`	'powerpoint'		craft\elements\Asset
`KIND_TEXT`	'text'		craft\elements\Asset
`KIND_UNKNOWN`	'unknown'		craft\elements\Asset
`KIND_VIDEO`	'video'		craft\elements\Asset
`KIND_WORD`	'word'		craft\elements\Asset
`KIND_XML`	'xml'		craft\elements\Asset
`SCENARIO_CREATE`	'create'		craft\elements\Asset
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model
`SCENARIO_ESSENTIALS`	'essentials'		craft\base\Element
`SCENARIO_FILEOPS`	'fileOperations'		craft\elements\Asset
`SCENARIO_INDEX`	'index'		craft\elements\Asset
`SCENARIO_LIVE`	'live'		craft\base\Element
`SCENARIO_REPLACE`	'replace'		craft\elements\Asset
`STATUS_ARCHIVED`	'archived'		craft\base\Element
`STATUS_DISABLED`	'disabled'		craft\base\Element
`STATUS_ENABLED`	'enabled'		craft\base\Element

Property Details

`$avoidFilenameConflicts` public property #

Whether Asset should avoid filename conflicts when saved.

public boolean $avoidFilenameConflicts = false

`$conflictingFilename` public property #

The filename that was used that caused a conflict.

public string, null $conflictingFilename = null

`$dateModified` public property #

Date modified

public DateTime, null $dateModified = null

`$filename` public property #

Filename

public string, null $filename = null

`$folderId` public property #

Folder ID

public integer, null $folderId = null

`$folderPath` public property #

Folder path

public string, null $folderPath = null

`$keepFileOnDelete` public property #

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

public boolean $keepFileOnDelete = false

`$kind` public property #

Kind

public string, null $kind = null

`$locationError` public property #

Location error code

public string, null $locationError = null

`$newFilename` public property #

New filename

public string, null $newFilename = null

`$newFolderId` public property #

New folder id

public integer, null $newFolderId = null

`$newLocation` public property #

New file location

public string, null $newLocation = null

`$size` public property #

Size

public integer, null $size = null

`$suggestedFilename` public property #

The suggested filename in case of a conflict.

public string, null $suggestedFilename = null

`$tempFilePath` public property #

The temp file path

public string, null $tempFilePath = null

`$volumeId` public property #

Source ID

public integer, null $volumeId = null

Method Details

`__get()` public method #

Returns a property value.

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

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

public mixed __get ( $name )

`$name`	string	The property name
return	mixed	The property value
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is write-only.

`__isset()` public method #

Checks if a property is set.

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

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

public boolean __isset ( $name )

`$name`	string	The property name
return	boolean	Whether the property is set

`__toString()` public method #

public void __toString ( )

`afterDelete()` public method #

Performs actions after an element is deleted.

public void afterDelete ( )

`afterSave()` public method #

Performs actions after an element is saved.

public void afterSave ( \craft\elements\bool $isNew )

`$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()` public method #

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.

public array attributes ( )

return	array	List of attribute names.

`beforeSave()` public method #

Performs actions before an element is saved.

public boolean beforeSave ( \craft\elements\bool $isNew )

`$isNew`	boolean	Whether the element is brand new
return	boolean	Whether the element should be saved

`copyWithTransform()` public method #

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

public craft\elements\Asset copyWithTransform ( $transform )

`$transform`	craft\models\AssetTransform, string, array, null
throws	craft\errors\AssetTransformException	if $transform is an invalid transform handle

`datetimeAttributes()` public method #

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

public string[] datetimeAttributes ( )

`defineActions()` protected static method #

Defines the available element actions for a given source (if one is provided).

protected static array defineActions ( \craft\elements\string $source = null )

`$source`	string, null	The selected source’s key, if any.
return	array	The available element actions.

`defineDefaultTableAttributes()` protected static method #

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

protected static string[] defineDefaultTableAttributes ( \craft\elements\string $source )

`$source`	string	The selected source’s key
return	string[]	The table attributes.

`defineSearchableAttributes()` protected static method #

Defines which element attributes should be searchable.

protected static string[] defineSearchableAttributes ( )

return	string[]	The element attributes that should be searchable

`defineSortOptions()` protected static method #

Returns the sort options for the element type.

protected static array defineSortOptions ( )

return	array	The attributes that elements can be sorted by

`defineSources()` protected static method #

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

protected static array defineSources ( \craft\elements\string $context = null )

`$context`	string, null	The context ('index' or 'modal').
return	array	The sources.

`defineTableAttributes()` protected static method #

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

protected static array defineTableAttributes ( )

return	array	The table attributes.

`displayName()` public static method #

Returns the display name of this class.

public static string displayName ( )

return	string	The display name of this class.

`extraFields()` public method #

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

public array extraFields ( )

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

`find()` public static method #

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);
    }
}

public static craft\elements\db\AssetQuery find ( )

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

`getCopyOfFile()` public method #

Get a temporary copy of the actual file.

public string getCopyOfFile ( )

`getEditorHtml()` public method #

Returns the HTML for the element’s editor HUD.

public string getEditorHtml ( )

return	string	The HTML for the editor HUD

`getExtension()` public method #

Returns the file extension.

public string getExtension ( )

`getFieldLayout()` public method #

Returns the field layout used by this element.

public craft\models\FieldLayout, null getFieldLayout ( )

`getFilename()` public method #

Returns the file name, with or without the extension.

public string getFilename ( \craft\elements\bool $withExtension = true )

$withExtension boolean

`getFocalPoint()` public method #

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

public array, string, null getFocalPoint ( \craft\elements\bool $asCss = false )

$asCss

`getFolder()` public method #

Returns the asset’s volume folder.

public craft\models\VolumeFolder getFolder ( )

throws	yii\base\InvalidConfigException	if $folderId is missing or invalid

`getHasFocalPoint()` public method #

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

public boolean getHasFocalPoint ( )

`getHasUrls()` public method #

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

Return whether the Asset has a URL.

public boolean getHasUrls ( )

`getHeight()` public method #

Returns the image height.

public integer, float, null getHeight ( $transform = null )

$transform craft\models\AssetTransform, 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.

`getImageTransformSourcePath()` public method #

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

public string getImageTransformSourcePath ( )

`getImg()` public method #

Returns an <img> tag based on this asset.

public Twig_Markup, null getImg ( )

`getIsEditable()` public method #

Returns whether the current user can edit the element.

public boolean getIsEditable ( )

`getMimeType()` public method #

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

public string, null getMimeType ( )

`getPath()` public method #

Returns the asset's path in the volume.

public string getPath ( \craft\elements\string $filename = null )

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

`getStream()` public method #

Get a stream of the actual file.

public resource getStream ( )

`getSupportsImageEditor()` public method #

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

public boolean getSupportsImageEditor ( )

`getSupportsPreview()` public method #

Returns whether this asset can be previewed.

public boolean getSupportsPreview ( )

`getThumbUrl()` public method #

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

public string, null getThumbUrl ( \craft\elements\int $size )

$size integer

`getTransformSource()` public method #

public string getTransformSource ( )

`getUri()` public method #

Deprecated in 3.0.0-RC12

Returns the asset's path in the volume.

public string getUri ( \craft\elements\string $filename = null )

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

`getUrl()` public method #

Returns the element’s full URL.

public string, null getUrl ( $transform = null )

$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.

`getVolume()` public method #

Returns the asset’s volume.

public craft\base\VolumeInterface getVolume ( )

throws	yii\base\InvalidConfigException	if $volumeId is missing or invalid

`getWidth()` public method #

Returns the image width.

public integer, float, null getWidth ( $transform = null )

$transform craft\models\AssetTransform, string, array, null The optional transform handle for which to get thumbnail.

`hasContent()` public static method #

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

public static boolean hasContent ( )

return	boolean	Whether elements of this type will be storing any data in the `content` table.

`hasTitles()` public static method #

Returns whether elements of this type have traditional titles.

public static boolean hasTitles ( )

return	boolean	Whether elements of this type have traditional titles.

`htmlAttributes()` protected method #

Returns any attributes that should be included in the element’s DOM representation in the Control Panel.

protected array htmlAttributes ( \craft\elements\string $context )

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

`isLocalized()` public static method #

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.

public static boolean isLocalized ( )

return	boolean	Whether elements of this type store data on a per-site basis.

`refHandle()` public static method #

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

public static string, null refHandle ( )

return	string, null	The reference handle, or null if the elemnet type doesn’t support reference tags

`rules()` public method #

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 \craft\elements\scenario 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().

public array rules ( )

return	array	Validation rules

`scenarios()` public method #

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.

public array scenarios ( )

return	array	A list of scenarios and the corresponding active attributes.

`setFocalPoint()` public method #

Sets the asset's focal point.

public void setFocalPoint ( $value )

`$value`		String\|array\|null
throws	InvalidArgumentException	if $value is invalid

`setHeight()` public method #

Sets the image height.

public void setHeight ( $height )

$height integer, float, null The image height

`setTransform()` public method #

Sets the transform.

public craft\elements\Asset setTransform ( $transform )

`$transform`	craft\models\AssetTransform, 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.
throws	craft\errors\AssetTransformException	if $transform is an invalid transform handle

`setTransformSource()` public method #

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

public void setTransformSource ( \craft\elements\string $uri )

$uri string

`setWidth()` public method #

Sets the image width.

public void setWidth ( $width )

$width integer, float, null The image width

`tableAttributeHtml()` protected method #

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

protected string tableAttributeHtml ( \craft\elements\string $attribute )

`$attribute`	string	The attribute name.
return	string	The HTML that should be shown for a given attribute in Table View.

Event Details

`EVENT_BEFORE_HANDLE_FILE` event of type craft\events\AssetEvent #

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

Property Details

$avoidFilenameConflicts public property #

$conflictingFilename public property #

$dateModified public property #

$filename public property #

$folderId public property #

$folderPath public property #

$keepFileOnDelete public property #

$kind public property #

$locationError public property #

$newFilename public property #

$newFolderId public property #

$newLocation public property #

$size public property #

$suggestedFilename public property #

$tempFilePath public property #

$volumeId public property #

Method Details

__get() public method #

__isset() public method #

__toString() public method #

afterDelete() public method #

afterSave() public method #

attributes() public method #

beforeSave() public method #

copyWithTransform() public method #

datetimeAttributes() public method #

defineActions() protected static method #

defineDefaultTableAttributes() protected static method #

defineSearchableAttributes() protected static method #

defineSortOptions() protected static method #

defineSources() protected static method #

defineTableAttributes() protected static method #

displayName() public static method #

extraFields() public method #

find() public static method #

getCopyOfFile() public method #

getEditorHtml() public method #

getExtension() public method #

getFieldLayout() public method #

getFilename() public method #

getFocalPoint() public method #

getFolder() public method #

getHasFocalPoint() public method #

getHasUrls() public method #

getHeight() public method #

getImageTransformSourcePath() public method #

getImg() public method #

getIsEditable() public method #

getMimeType() public method #

getPath() public method #

getStream() public method #

getSupportsImageEditor() public method #

getSupportsPreview() public method #

getThumbUrl() public method #

getTransformSource() public method #

getUri() public method #

getUrl() public method #

getVolume() public method #

getWidth() public method #

hasContent() public static method #

hasTitles() public static method #

htmlAttributes() protected method #

isLocalized() public static method #

refHandle() public static method #

rules() public method #

scenarios() public method #

setFocalPoint() public method #

setHeight() public method #

setTransform() public method #

setTransformSource() public method #

setWidth() public method #

tableAttributeHtml() protected method #