Skip to content

Assets

Type
Class
Namespace
craft\fields
Inherits
craft\fields\Assets » craft\fields\BaseRelationField » craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\EagerLoadingFieldInterface, craft\base\FieldInterface, craft\base\ModelInterface, craft\base\PreviewableFieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

Assets represents an Assets field.

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
allowLimitboolean – Whether to show the Min Relations and Max Relations settings.
allowMultipleSourcesboolean – Whether to allow multiple source selection in the settings
allowSelfRelationsboolean – Whether elements should be allowed to relate themselves.
allowSubfoldersboolean – Whether assets can be selected from subfolders, if assets are restricted.
allowUploadsboolean – Whether it should be possible to upload files directly to the field.
allowedKindsarray, null – The file kinds that the field should be restricted to (only used if restrictFiles is true)
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
branchLimitinteger, null – Branch limit
columnPrefixstring, null – The field’s content column prefix
columnSuffixstring, null – The field’s content column suffix
contentColumnTypestring, string[] – The column type(s).
contentGqlMutationArgumentType\GraphQL\Type\Definition\Type, array
contentGqlQueryArgumentType\GraphQL\Type\Definition\Type, array
contentGqlType\GraphQL\Type\Definition\Type, array
contextstring, null – The field’s context
dateCreatedDateTime, null – The date that the component was created
dateUpdatedDateTime, null – The date that the component was last updated
defaultUploadLocationSourcestring, null – The source where assets should be uploaded by default, if assets aren’t restricted.
defaultUploadLocationSubpathstring, null – The subpath where assets should be uploaded by default, if assets aren’t restricted.
describedBystring, null – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditionsarray, null
elementConditionRuleTypestring, array, null
elementValidationRulesarray
errorsarray – Errors for all attributes or the specified attribute.
fileKindOptionsarray
firstErrorsarray – The first errors.
groupcraft\models\FieldGroup, null
groupIdinteger, null – The field’s group’s ID
handlestring, null – The field’s handle
idinteger, string, null – The component’s ID (could be a temporary one: "new:X")
inputIdstring
inputSelectionCriteriaarray
inputSourcesarray, string, null
instructionsstring, null – The field’s instructions
isNewboolean – Whether the component is new (unsaved)
isTranslatableboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
labelIdstring
layoutIdinteger, null – The ID of the field layout that the field was fetched from
localizeRelationsboolean – Whether each site should get its own unique set of relations
maintainHierarchyboolean – Whether to automatically relate structural ancestors.
maxRelationsinteger, null – The maximum number of relations this field can have (used if allowLimit is set to true).
minRelationsinteger, null – The maximum number of relations this field can have (used if allowLimit is set to true).
namestring, null – The field’s name
oldHandlestring, null – The field’s previous handle
oldSettingsarray, null – The field’s previous settings
previewModestring – How related assets should be presented within element index views.
requiredboolean, null – Whether the field is required in the field layout it was fetched from
restrictFilesboolean – Whether the available assets should be restricted to allowedKinds
restrictLocationboolean – Whether assets should be restricted to a single location.
restrictedDefaultUploadSubpathstring, null – The subpath where assets should be uploaded to by default, if assets are restricted and subfolders are allowed.
restrictedLocationSourcestring, null – The source key where assets can be selected from, if assets are restricted.
restrictedLocationSubpathstring, null – The subpath where assets can be selected from, if assets are restricted.
scenariostring – The scenario that this model is in.
searchableboolean – Whether the field's values should be registered as search keywords on the elements.
selectionConditioncraft\elements\conditions\ElementConditionInterface, null
selectionLabelstring, null – The label that should be used on the selection input
settingsarray – The component’s settings
settingsHtmlstring, null
showSiteMenuboolean – Whether the site menu should be shown in element selector modals.
showUnpermittedFilesboolean – Whether to show files the user doesn’t have permission to view, per the “View files uploaded by other users” permission.
showUnpermittedVolumesboolean – Whether to show input sources for volumes the user doesn’t have permission to view.
sortOptionarray
sortOrderinteger, null – The field’s sort position in the field layout it was fetched from
sourcestring, null – The source key that this field can relate elements from (used if allowMultipleSources is set to false)
sourceOptionsarray
sourcesstring, string[], null – The source keys that this field can relate elements from (used if allowMultipleSources is set to true)
tabIdinteger, null – The tab ID of the field layout that the field was fetched from
targetSiteFieldHtmlstring, null
targetSiteIdstring, null – The UID of the site that this field should relate elements from
translationDescriptionstring, null
translationKeyFormatstring, null – The field’s translation key format, if translationMethod is "custom"
translationMethodstring – The field’s translation method
uidstring, null – The field's UID
validateRelatedElementsboolean – Whether related elements should be validated when the source element is saved.
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
viewModestring, null – The view mode
viewModeFieldHtmlstring, null

allowSubfolders

Type
boolean
Default value
false
Since
4.0.0

Whether assets can be selected from subfolders, if assets are restricted.

View source

allowUploads

Type
boolean
Default value
true
Since
3.5.13

Whether it should be possible to upload files directly to the field.

View source

allowedKinds

Type
array, null
Default value
null

The file kinds that the field should be restricted to (only used if restrictFiles is true)

View source

contentGqlType

Type
\GraphQL\Type\Definition\Type, array
Default value
null
Access
Read-only
Since
3.3.0

View source

defaultUploadLocationSource

Type
string, null
Default value
null

The source where assets should be uploaded by default, if assets aren’t restricted.

View source

defaultUploadLocationSubpath

Type
string, null
Default value
null

The subpath where assets should be uploaded by default, if assets aren’t restricted.

View source

eagerLoadingGqlConditions

Type
array, null
Default value
null
Access
Read-only
Since
3.3.0

View source

elementValidationRules

Type
array
Default value
null
Access
Read-only

View source

fileKindOptions

Type
array
Default value
null
Access
Read-only

View source

inputSelectionCriteria

Type
array
Default value
null
Access
Read-only

View source

inputSources

Type
array, string, null
Default value
null
Access
Read-only

View source

previewMode

Type
string
Default value
self::PREVIEW_MODE_FULL
Since
3.5.11

How related assets should be presented within element index views.

View source

restrictFiles

Type
boolean
Default value
false

Whether the available assets should be restricted to allowedKinds

View source

restrictLocation

Type
boolean
Default value
false
Since
4.0.0

Whether assets should be restricted to a single location.

View source

restrictedDefaultUploadSubpath

Type
string, null
Default value
null
Since
4.0.0

The subpath where assets should be uploaded to by default, if assets are restricted and subfolders are allowed.

View source

restrictedLocationSource

Type
string, null
Default value
null
Since
4.0.0

The source key where assets can be selected from, if assets are restricted.

View source

restrictedLocationSubpath

Type
string, null
Default value
null
Since
4.0.0

The subpath where assets can be selected from, if assets are restricted.

View source

showUnpermittedFiles

Type
boolean
Default value
false
Since
3.4.0

Whether to show files the user doesn’t have permission to view, per the “View files uploaded by other users” permission.

View source

showUnpermittedVolumes

Type
boolean
Default value
false
Since
3.4.0

Whether to show input sources for volumes the user doesn’t have permission to view.

View source

sourceOptions

Type
array
Default value
null
Access
Read-only

View source

Protected Properties

PropertyDescription
allowLargeThumbsViewboolean – Whether to allow the “Large Thumbnails” view mode
inputJsClassstring, null – The JS class that should be initialized for the input
inputTemplatestring – Template to use for field rendering
settingsTemplatestring – Template to use for settings rendering
sortableboolean – Whether the elements have a custom sort order

allowLargeThumbsView

Type
boolean
Default value
true

Whether to allow the “Large Thumbnails” view mode

View source

inputJsClass

Type
string, null
Default value
'Craft.AssetSelectInput'

The JS class that should be initialized for the input

View source

inputTemplate

Type
string
Default value
'_components/fieldtypes/Assets/input.twig'

Template to use for field rendering

View source

settingsTemplate

Type
string
Default value
'_components/fieldtypes/Assets/settings.twig'

Template to use for settings rendering

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__toString()Use the translated field name as the string representation.
__unset()Sets a component property to be null.
_volumeBySourceKey()Returns a volume via its source key.
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 a component is deleted.
afterElementDelete()Performs actions after the element has been deleted.
afterElementDeleteForSite()Performs actions after the element has been deleted.
afterElementPropagate()Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore()Performs actions after the element has been restored.
afterElementSave()Performs actions after the element has been saved.
afterSave()Performs actions after a component 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.
beforeApplyDelete()Performs actions before a component delete is applied to the database.
beforeDelete()Performs actions before a component is deleted.
beforeElementDelete()Performs actions before an element is deleted.
beforeElementDeleteForSite()Performs actions before an element is deleted for a site.
beforeElementRestore()Performs actions before an element is restored.
beforeElementSave()Performs actions before an element is saved.
beforeSave()Performs actions before a component 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.
copyValue()Copies the field’s value from one element to another.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
defaultSelectionLabel()Returns the default selectionLabel value.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
elementType()Returns the element class associated with this field type.
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.
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.
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.
getContentColumnType()Returns the column type(s) that this field should get within the content table.
getContentGqlMutationArgumentType()Returns the GraphQL type to be used as an argument in mutations for this field type.
getContentGqlQueryArgumentType()Returns the GraphQL type to be used as an argument in queries for this field type.
getContentGqlType()Returns the GraphQL type to be used for this field type.
getEagerLoadingGqlConditions()Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.
getEagerLoadingMap()Returns an array that maps source-to-target element IDs based on this custom field.
getElementConditionRuleType()Returns the element condition rule class that should be used for this field.
getElementValidationRules()Returns the validation rules for an element with this field.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFileKindOptions()Returns the available file kind options for the settings
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGroup()Returns the field’s group.
getInputHtml()Returns the field’s input HTML.
getInputId()Returns the input’s ID, which the <label>’s for attribute should reference.
getInputSelectionCriteria()Returns any additional criteria parameters limiting which elements the field should be able to select.
getInputSources()Returns an array of the source keys the field should be able to select elements from.
getIsNew()Returns whether the component is new (unsaved).
getIsTranslatable()Returns whether the field should be shown as translatable in the UI.
getIterator()Returns an iterator for traversing the attributes in the model.
getLabelId()Returns the input’s label ID.
getOrientation()Returns the orientation the field should use (ltr or rtl).
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords that should be associated with this field.
getSelectionCondition()Returns the element condition that should be used to determine which elements are selectable by the field.
getSettings()Returns an array of the component’s settings.
getSettingsHtml()Returns the component’s settings HTML.
getSortOption()Returns the sort option array that should be included in the element’s sortOptions() response.
getSourceOptions()Normalizes the available sources into select input options.
getStaticHtml()Returns a static (non-editable) version of the field’s input HTML.
getStatus()Returns the status of the field for a given element.
getTableAttributeHtml()Returns the HTML that should be shown for this field in Table View.
getTargetSiteFieldHtml()Returns the HTML for the Target Site setting.
getTranslationDescription()Returns the description of this field’s translation support.
getTranslationKey()Returns the field’s translation key, based on a given element.
getValidators()Returns all the validators declared in rules().
getViewModeFieldHtml()Returns the HTML for the View Mode setting.
hasContentColumn()Returns whether this field has a column in the content table.
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 for this component.
includeInGqlSchema()Returns whether the field should be included in the given GraphQL schema.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
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.
isRequirable()Returns whether the field can be marked as required.
isSelectable()Returns whether the component should be selectable in component Type selects.
isValueEmpty()Returns whether the given value should be considered “empty” to a validator.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
modifyElementIndexQuery()Modifies an element index query.
modifyElementsQuery()Modifies an element query.
normalizeValue()Normalizes the field’s value for use.
normalizeValueFromRequest()Normalizes a posted field value for use.
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.
resolveDynamicPathToFolderId()Resolve source path for uploading for this field.
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.
serializeValue()Prepares the field’s value to be stored somewhere, like the content table.
setAttributes()Sets the attribute values in a massive way.
setIsFresh()Sets whether the field is fresh.
setScenario()Sets the scenario for the model.
setSelectionCondition()Sets the element condition that should be used to determine which elements are selectable by the field.
settingsAttributes()Returns the list of settings attribute names.
supportedTranslationMethods()Returns which translation methods the field supports.
toArray()Converts the model into an array.
trigger()Triggers an event.
useFieldset()Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate()Performs the data validation.
validateFileSize()Validates the files to make sure they are under the allowed max file size.
validateFileType()Validates the files to make sure they are one of the allowed file kinds.
validateMultiple()Validates multiple models.
validateNotTempVolume()Ensure that you can't select tempUploadsLocation volume as a source or default uploads location or restricted location for an Assets field.
validateRelatedElements()Validates the related elements.
validateRelationCount()Validates that the number of related elements are within the min/max relation bounds.
validateSources()Ensure only one structured source is selected when maintainHierarchy is true.
valueType()Returns the PHPDoc type this field’s values will have.

__construct()

View source

Arguments

  • $config

_volumeBySourceKey()

Returns a volume via its source key.

View source

Arguments

  • $sourceKey

afterElementSave()

Performs actions after the element has been saved.

View source

Arguments

defaultSelectionLabel()

Returns the default selectionLabel value.

View source

Returns

string – The default selection label

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

elementType()

Returns the element class associated with this field type.

View source

Returns

string – The Element class name

getContentGqlType()

Since
3.3.0

Returns the GraphQL type to be used for this field type.

View source

Returns

\GraphQL\Type\Definition\Type, array

getEagerLoadingGqlConditions()

Since
3.3.0

Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.

View source

Returns

array, null

getElementValidationRules()

Returns the validation rules for an element with this field.

Rules should be defined in the array syntax required by yii\base\Model::rules(), with one difference: you can skip the first argument (the attribute list).

php
[
    // explicitly specify the field attribute
    [$this->handle, 'string', 'min' => 3, 'max' => 12],
    // skip the field attribute
    ['string', 'min' => 3, 'max' => 12],
    // you can only pass the validator class name/handle if not setting any params
    'bool',
]

To register validation rules that should only be enforced for live elements, set the rule scenario to live:

php
[
    ['string', 'min' => 3, 'max' => 12, 'on' => \craft\base\Element::SCENARIO_LIVE],
]

View source

Returns

array

getFileKindOptions()

Returns the available file kind options for the settings

View source

Returns

array

getInputSelectionCriteria()

Returns any additional criteria parameters limiting which elements the field should be able to select.

View source

Returns

array

getInputSources()

Returns an array of the source keys the field should be able to select elements from.

View source

Arguments

Returns

array, string, null

getSourceOptions()

Normalizes the available sources into select input options.

View source

Returns

array

includeInGqlSchema()

Since
3.6.0

Returns whether the field should be included in the given GraphQL schema.

View source

Arguments

Returns

boolean

isValueEmpty()

Returns whether the given value should be considered “empty” to a validator.

View source

Arguments

  • $value (mixed) – The field’s value
  • $element (craft\base\ElementInterface) – The element the field is associated with, if there is one

Returns

boolean – Whether the value should be considered “empty”

normalizeValue()

Normalizes the field’s value for use.

This method is called when the field’s value is first accessed from the element. For example, the first time element.myFieldHandle is called from a template, or right before getInputHtml() is called. Whatever this method returns is what element.myFieldHandle will likewise return, and what getInputHtml()’s and serializeValue()’s $value arguments will be set to.

The value passed into this method will vary depending on the context.

  • If a new, unsaved element is being edited for the first time (such as an entry within a Quick Post widget on the Dashboard), the value will be null.
  • If an element is currently being saved, the value will be the field’s POST data.
  • If an existing element was retrieved from the database, the value will be whatever is stored in the field’s content table column. (Or if the field doesn’t have a content table column per hasContentColumn(), the value will be null.)
  • If the field is being cleared out (e.g. via the resave/entries command with --to :empty:), the value will be an empty string ('').

There are cases where a pre-normalized value could be passed in as well, so be sure to account for that.

View source

Arguments

Returns

mixed – The prepared field value

resolveDynamicPathToFolderId()

Resolve source path for uploading for this field.

View source

Arguments

Returns

integer

validateFileSize()

Validates the files to make sure they are under the allowed max file size.

View source

Arguments

validateFileType()

Validates the files to make sure they are one of the allowed file kinds.

View source

Arguments

validateNotTempVolume()

Since
4.7.0

Ensure that you can't select tempUploadsLocation volume as a source or default uploads location or restricted location for an Assets field.

View source

Arguments

valueType()

Since
3.2.0

Returns the PHPDoc type this field’s values will have.

It will be used by the generated CustomFieldBehavior class.

If the values can be of more than one type, return multiple types separated by |s.

php
public static function valueType(): string
{
     return 'int|string';
}

View source

Returns

string

Protected Methods

MethodDescription
availableSources()Returns the sources that should be available to choose from within the field's settings
createSelectionCondition()Creates an element condition that should be used to determine which elements are selectable by the field.
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
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.
inputHtml()Returns the field’s input HTML.
inputTemplateVariables()Returns an array of variables that should be passed to the input template.
isFresh()Returns whether this is the first time the element’s content has been edited.
requestParamName()Returns the field’s param name on the request.
resolveFields()Determines which fields can be returned by toArray().
searchKeywords()Returns the search keywords that should be associated with this field.
settingsTemplateVariables()Returns an array of variables that should be passed to the settings template.
supportedViewModes()Returns the field’s supported view modes.
tableAttributeHtml()Returns the HTML that should be shown for this field in Table View.
targetSiteId()Returns the site ID that target elements should have.
viewMode()Returns the field’s current view mode.

createSelectionCondition()

Since
4.0.0

Creates an element condition that should be used to determine which elements are selectable by the field.

The condition’s queryParams property should be set to any element query params that are already covered by other field settings.

View source

Returns

craft\elements\conditions\ElementConditionInterface, null

defineRules()

Since
3.4.9

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

inputHtml()

Since
3.5.0

Returns the field’s input HTML.

View source

Arguments

  • $value (mixed) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null
  • $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

string – The input HTML.

inputTemplateVariables()

Returns an array of variables that should be passed to the input template.

View source

Arguments

Returns

array

tableAttributeHtml()

Since
3.6.3

Returns the HTML that should be shown for this field in Table View.

View source

Arguments

  • $elements (\Illuminate\Support\Collection)

Returns

string

Constants

ConstantDescription
PREVIEW_MODE_FULL
PREVIEW_MODE_THUMBS
SCENARIO_DEFAULTThe name of the default scenario.
TRANSLATION_METHOD_CUSTOM
TRANSLATION_METHOD_LANGUAGE
TRANSLATION_METHOD_NONE
TRANSLATION_METHOD_SITE
TRANSLATION_METHOD_SITE_GROUP

Events

EVENT_LOCATE_UPLOADED_FILES

Type
craft\events\LocateUploadedFilesEvent
Since
4.0.2

The event that is triggered when identifying any uploaded files that should be stored as assets and related by the field.