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 (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\EagerLoadingFieldInterface, craft\base\FieldInterface, craft\base\ModelInterface, craft\base\PreviewableFieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
3.0.0

Assets represents an Assets field.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
allowLimit boolean (opens new window) – Whether to show the Min Relations and Max Relations settings.
allowMultipleSources boolean (opens new window) – Whether to allow multiple source selection in the settings
allowSelfRelations boolean (opens new window) – Whether elements should be allowed to relate themselves.
allowSubfolders boolean (opens new window) – Whether assets can be selected from subfolders, if assets are restricted.
allowUploads boolean (opens new window) – Whether it should be possible to upload files directly to the field.
allowedKinds array (opens new window), null (opens new window) – The file kinds that the field should be restricted to (only used if restrictFiles is true)
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
columnPrefix string (opens new window), null (opens new window) – The field’s content column prefix
columnSuffix string (opens new window), null (opens new window) – The field’s content column suffix
contentColumnType string (opens new window), string (opens new window)[] – The column type(s).
contentGqlMutationArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlQueryArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlType \GraphQL\Type\Definition\Type, array (opens new window)
context string (opens new window), null (opens new window) – The field’s context
dateCreated DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated DateTime (opens new window), null (opens new window) – The date that the component was last updated
defaultUploadLocationSource string (opens new window), null (opens new window) – The source where assets should be uploaded by default, if assets aren’t restricted.
defaultUploadLocationSubpath string (opens new window), null (opens new window) – The subpath where assets should be uploaded by default, if assets aren’t restricted.
describedBy string (opens new window), null (opens new window) – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions array (opens new window), null (opens new window)
elementConditionRuleType string (opens new window), array (opens new window), null (opens new window)
elementValidationRules array (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
fileKindOptions array (opens new window)
firstErrors (opens new window) array (opens new window) – The first errors.
group craft\models\FieldGroup, null (opens new window)
groupId integer (opens new window), null (opens new window) – The field’s group’s ID
handle string (opens new window), null (opens new window) – The field’s handle
id integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
inputId string (opens new window)
inputSelectionCriteria array (opens new window)
inputSources array (opens new window), string (opens new window), null (opens new window)
instructions string (opens new window), null (opens new window) – The field’s instructions
isNew boolean (opens new window) – Whether the component is new (unsaved)
isTranslatable boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
layoutId integer (opens new window), null (opens new window) – The ID of the field layout that the field was fetched from
localizeRelations boolean (opens new window) – Whether each site should get its own unique set of relations
maxRelations integer (opens new window), null (opens new window) – The maximum number of relations this field can have (used if allowLimit is set to true).
minRelations integer (opens new window), null (opens new window) – The maximum number of relations this field can have (used if allowLimit is set to true).
name string (opens new window), null (opens new window) – The field’s name
oldHandle string (opens new window), null (opens new window) – The field’s previous handle
oldSettings array (opens new window), null (opens new window) – The field’s previous settings
previewMode string (opens new window) – How related assets should be presented within element index views.
required boolean (opens new window), null (opens new window) – Whether the field is required in the field layout it was fetched from
restrictFiles boolean (opens new window) – Whether the available assets should be restricted to allowedKinds
restrictLocation boolean (opens new window) – Whether assets should be restricted to a single location.
restrictedDefaultUploadSubpath string (opens new window), null (opens new window) – The subpath where assets should be uploaded to by default, if assets are restricted and subfolders are allowed.
restrictedLocationSource string (opens new window), null (opens new window) – The source key where assets can be selected from, if assets are restricted.
restrictedLocationSubpath string (opens new window), null (opens new window) – The subpath where assets can be selected from, if assets are restricted.
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchable boolean (opens new window) – Whether the field's values should be registered as search keywords on the elements.
selectionCondition craft\elements\conditions\ElementConditionInterface, null (opens new window)
selectionLabel string (opens new window), null (opens new window) – The label that should be used on the selection input
settings array (opens new window) – The component’s settings
settingsHtml string (opens new window), null (opens new window)
showSiteMenu boolean (opens new window) – Whether the site menu should be shown in element selector modals.
showUnpermittedFiles boolean (opens new window) – Whether to show files the user doesn’t have permission to view, per the “View files uploaded by other users” permission.
showUnpermittedVolumes boolean (opens new window) – Whether to show input sources for volumes the user doesn’t have permission to view.
sortOption array (opens new window)
sortOrder integer (opens new window), null (opens new window) – The field’s sort position in the field layout it was fetched from
source string (opens new window), null (opens new window) – The source key that this field can relate elements from (used if allowMultipleSources is set to false)
sourceOptions array (opens new window)
sources string (opens new window), string (opens new window)[], null (opens new window) – The source keys that this field can relate elements from (used if allowMultipleSources is set to true)
tabId integer (opens new window), null (opens new window) – The tab ID of the field layout that the field was fetched from
targetSiteFieldHtml string (opens new window), null (opens new window)
targetSiteId string (opens new window), null (opens new window) – The UID of the site that this field should relate elements from
translationDescription string (opens new window), null (opens new window)
translationKeyFormat string (opens new window), null (opens new window) – The field’s translation key format, if translationMethod is "custom"
translationMethod string (opens new window) – The field’s translation method
uid string (opens new window), null (opens new window) – The field's UID
validateRelatedElements boolean (opens new window) – Whether related elements should be validated when the source element is saved.
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
viewMode string (opens new window), null (opens new window) – The view mode
viewModeFieldHtml string (opens new window), null (opens new window)

# allowSubfolders

Type
boolean (opens new window)
Default value
false
Since
4.0.0

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

View source (opens new window)

# allowUploads

Type
boolean (opens new window)
Default value
true
Since
3.5.13

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

View source (opens new window)

# allowedKinds

Type
array (opens new window), null (opens new window)
Default value
null

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

View source (opens new window)

# contentGqlType

Type
\GraphQL\Type\Definition\Type, array (opens new window)
Default value
null
Access
Read-only
Since
3.3.0

View source (opens new window)

# defaultUploadLocationSource

Type
string (opens new window), null (opens new window)
Default value
null

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

View source (opens new window)

# defaultUploadLocationSubpath

Type
string (opens new window), null (opens new window)
Default value
null

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

View source (opens new window)

# eagerLoadingGqlConditions

Type
array (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.3.0

View source (opens new window)

# elementValidationRules

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# fileKindOptions

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# inputSelectionCriteria

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# inputSources

Type
array (opens new window), string (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# previewMode

Type
string (opens new window)
Default value
self::PREVIEW_MODE_FULL
Since
3.5.11

How related assets should be presented within element index views.

View source (opens new window)

# restrictFiles

Type
boolean (opens new window)
Default value
false

Whether the available assets should be restricted to allowedKinds

View source (opens new window)

# restrictLocation

Type
boolean (opens new window)
Default value
false
Since
4.0.0

Whether assets should be restricted to a single location.

View source (opens new window)

# restrictedDefaultUploadSubpath

Type
string (opens new window), null (opens new window)
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 (opens new window)

# restrictedLocationSource

Type
string (opens new window), null (opens new window)
Default value
null
Since
4.0.0

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

View source (opens new window)

# restrictedLocationSubpath

Type
string (opens new window), null (opens new window)
Default value
null
Since
4.0.0

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

View source (opens new window)

# showUnpermittedFiles

Type
boolean (opens new window)
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 (opens new window)

# showUnpermittedVolumes

Type
boolean (opens new window)
Default value
false
Since
3.4.0

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

View source (opens new window)

# sourceOptions

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# Protected Properties

Property Description
allowLargeThumbsView boolean (opens new window) – Whether to allow the “Large Thumbnails” view mode
inputJsClass string (opens new window), null (opens new window) – The JS class that should be initialized for the input
inputTemplate string (opens new window) – Template to use for field rendering
settingsTemplate string (opens new window) – Template to use for settings rendering
sortable boolean (opens new window) – Whether the elements have a custom sort order

# allowLargeThumbsView

Type
boolean (opens new window)
Default value
true

Whether to allow the “Large Thumbnails” view mode

View source (opens new window)

# inputJsClass

Type
string (opens new window), null (opens new window)
Default value
'Craft.AssetSelectInput'

The JS class that should be initialized for the input

View source (opens new window)

# inputTemplate

Type
string (opens new window)
Default value
'_components/fieldtypes/Assets/input'

Template to use for field rendering

View source (opens new window)

# settingsTemplate

Type
string (opens new window)
Default value
'_components/fieldtypes/Assets/settings'

Template to use for settings rendering

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__toString() Use the translated field name as the string representation.
__unset() (opens new window) Sets a component property to be null.
_volumeIdBySourceKey() Returns a volume ID from an upload source key.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterDelete() Performs actions after a component is deleted.
afterElementDelete() 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() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() (opens new window) 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.
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() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
copyValue() Copies the field’s value from one element to another.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultSelectionLabel() Returns the default selectionLabel value.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
displayName() Returns the display name of this class.
elementType() Returns the element class associated with this field type.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
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() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFileKindOptions() Returns the available file kind options for the settings
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
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() (opens new window) Returns an iterator for traversing the attributes in the model.
getOrientation() Returns the orientation the field should use (ltr or rtl).
getScenario() (opens new window) 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() (opens new window) Returns all the validators declared in rules() (opens new window).
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() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
includeInGqlSchema() Returns whether the field should be included in the given GraphQL schema.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
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() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) 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.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
resolveDynamicPathToFolderId() Resolve source path for uploading for this field.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) 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() (opens new window) 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() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
useFieldset() Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate() (opens new window) 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() (opens new window) Validates multiple models.
validateRelatedElements() Validates the related elements.
validateRelationCount() Validates that the number of related elements are within the min/max relation bounds.
valueType() Returns the PHPDoc type this field’s values will have.

# __construct()

View source (opens new window)

Arguments

  • $config

# _volumeIdBySourceKey()

Returns a volume ID from an upload source key.

View source (opens new window)

Arguments

Returns

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

# afterElementSave()

Performs actions after the element has been saved.

View source (opens new window)

Arguments

# defaultSelectionLabel()

Returns the default selectionLabel value.

View source (opens new window)

Returns

string (opens new window) – The default selection label

# displayName()

Returns the display name of this class.

View source (opens new window)

Returns

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

# elementType()

Returns the element class associated with this field type.

View source (opens new window)

Returns

string (opens new window) – The Element class name

# getContentGqlType()

Since
3.3.0

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

View source (opens new window)

Returns

\GraphQL\Type\Definition\Type, array (opens new window)

# 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 (opens new window)

Returns

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

# 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() (opens new window), with one difference: you can skip the first argument (the attribute list).

[
    // 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 (opens new window) to live:

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

View source (opens new window)

Returns

array (opens new window)

# getFileKindOptions()

Returns the available file kind options for the settings

View source (opens new window)

Returns

array (opens new window)

# getInputSelectionCriteria()

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

View source (opens new window)

Returns

array (opens new window)

# getInputSources()

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

View source (opens new window)

Arguments

Returns

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

# getSourceOptions()

Normalizes the available sources into select input options.

View source (opens new window)

Returns

array (opens new window)

# includeInGqlSchema()

Since
3.6.0

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isValueEmpty()

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

View source (opens new window)

Arguments

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

Returns

boolean (opens new window) – 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.)

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

View source (opens new window)

Arguments

Returns

mixed – The prepared field value

# resolveDynamicPathToFolderId()

Resolve source path for uploading for this field.

View source (opens new window)

Arguments

Returns

integer (opens new window)

# validateFileSize()

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

View source (opens new window)

Arguments

# validateFileType()

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

View source (opens new window)

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.

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

View source (opens new window)

Returns

string (opens new window)

# Protected Methods

Method Description
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() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
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() (opens new window) Determines which fields can be returned by toArray() (opens new window).
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 (opens new window)

Returns

craft\elements\conditions\ElementConditionInterface, null (opens new window)

# 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 (opens new window)

Returns

array (opens new window)

# inputHtml()

Since
3.5.0

Returns the field’s input HTML.

View source (opens new window)

Arguments

Returns

string (opens new window) – The input HTML.

# inputTemplateVariables()

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

View source (opens new window)

Arguments

Returns

array (opens new window)

# tableAttributeHtml()

Since
3.6.3

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

View source (opens new window)

Arguments

  • $elements (\Illuminate\Support\Collection)

Returns

string (opens new window)

# Constants

Constant Description
PREVIEW_MODE_FULL
PREVIEW_MODE_THUMBS
SCENARIO_DEFAULT The 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
3.7.72

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