Variants

Type
Class
Namespace
craft\commerce\fields
Inherits
craft\commerce\fields\Variants » craft\fields\BaseRelationField (opens new window) » craft\base\Field (opens new window) » craft\base\SavableComponent (opens new window) » craft\base\ConfigurableComponent (opens new window) » craft\base\Component (opens new window) » craft\base\Model (opens new window) » 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 (opens new window), craft\base\ConfigurableComponentInterface (opens new window), craft\base\EagerLoadingFieldInterface (opens new window), craft\base\FieldInterface (opens new window), craft\base\PreviewableFieldInterface (opens new window), craft\base\SavableComponentInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait (opens new window), craft\base\FieldTrait (opens new window), craft\base\SavableComponentTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
2.0

Class Variant 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 (opens new window) boolean (opens new window) – Whether to allow the Limit setting
allowMultipleSources (opens new window) boolean (opens new window) – Whether to allow multiple source selection in the settings
allowSelfRelations (opens new window) boolean (opens new window) – Whether elements should be allowed to relate themselves.
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 (opens new window) string (opens new window), null (opens new window) – The field’s content column prefix
columnSuffix (opens new window) string (opens new window), null (opens new window) – The field’s content column suffix
contentColumnType (opens new window) string (opens new window), string (opens new window)[] – The column type(s).
contentGqlMutationArgumentType (opens new window) \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlQueryArgumentType (opens new window) \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlType \GraphQL\Type\Definition\Type, array (opens new window)
context (opens new window) string (opens new window), null (opens new window) – The field’s context
dateCreated (opens new window) DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated (opens new window) DateTime (opens new window), null (opens new window) – The date that the component was last updated
describedBy (opens new window) string (opens new window), null (opens new window) – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions (opens new window) array (opens new window), false (opens new window)
elementValidationRules (opens new window) array (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute. Empty array is returned if no error. See getErrors() (opens new window) for detailed description. Note that when returning errors for all attributes, the result is a two-dimensional array, like the following: php [ 'username' => [ 'Username is required.', 'Username must contain only word characters.', ], 'email' => [ 'Email address is invalid.', ] ] .
firstErrors (opens new window) array (opens new window) – The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error.
group (opens new window) craft\models\FieldGroup (opens new window), null (opens new window)
groupId (opens new window) integer (opens new window), null (opens new window) – The field’s group’s ID
handle (opens new window) string (opens new window), null (opens new window) – The field’s handle
id (opens new window) integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
instructions (opens new window) string (opens new window), null (opens new window) – The field’s instructions
isNew (opens new window) boolean (opens new window) – Whether the component is new (unsaved)
isTranslatable (opens new window) boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
layoutId (opens new window) integer (opens new window), null (opens new window) – The ID of the field layout that the field was fetched from
limit (opens new window) integer (opens new window), null (opens new window) – The maximum number of relations this field can have (used if allowLimit (opens new window) is set to true)
localizeRelations (opens new window) integer (opens new window) – Whether each site should get its own unique set of relations
name (opens new window) string (opens new window), null (opens new window) – The field’s name
oldHandle (opens new window) string (opens new window), null (opens new window) – The field’s previous handle
oldSettings (opens new window) array (opens new window), null (opens new window) – The field’s previous settings
required (opens new window) boolean (opens new window), null (opens new window) – Whether the field is required in the field layout it was fetched from
scenario (opens new window) string (opens new window) – The scenario that this model is in. Defaults to SCENARIO_DEFAULT (opens new window).
searchable (opens new window) boolean (opens new window) – Whether the field's values should be registered as search keywords on the elements.
selectionLabel (opens new window) string (opens new window), null (opens new window) – The label that should be used on the selection input
settings (opens new window) array (opens new window) – The component’s settings
settingsHtml (opens new window) string (opens new window), null (opens new window)
showSiteMenu (opens new window) boolean (opens new window) – Whether the site menu should be shown in element selector modals.
sortOption (opens new window) array (opens new window)
sortOrder (opens new window) integer (opens new window), null (opens new window) – The field’s sort position in the field layout it was fetched from
source (opens new window) string (opens new window), null (opens new window) – The source key that this field can relate elements from (used if allowMultipleSources (opens new window) is set to false)
sourceOptions (opens new window) array (opens new window)
sources (opens new window) 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 (opens new window) is set to true)
tabId (opens new window) integer (opens new window), null (opens new window) – The tab ID of the field layout that the field was fetched from
targetSiteFieldHtml (opens new window) string (opens new window), null (opens new window)
targetSiteId (opens new window) string (opens new window), null (opens new window) – The UID of the site that this field should relate elements from
translationDescription (opens new window) string (opens new window), null (opens new window)
translationKeyFormat (opens new window) string (opens new window), null (opens new window) – The field’s translation key format, if translationMethod (opens new window) is "custom"
translationMethod (opens new window) string (opens new window) – The field’s translation method
uid (opens new window) string (opens new window), null (opens new window) – The field's UID
validateRelatedElements (opens new window) 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 (opens new window) string (opens new window), null (opens new window) – The view mode
viewModeFieldHtml (opens new window) string (opens new window), null (opens new window)

# contentGqlType

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

View source (opens new window)

# Protected Properties

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

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window)
__construct() (opens new window) Constructor.
__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() (opens new window) Use the translated field name as the string representation.
__unset() (opens new window) Sets a component property to be null.
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() (opens new window) Adds errors from another model, with a given attribute name prefix.
afterDelete() (opens new window) Performs actions after a component is deleted.
afterElementDelete() (opens new window) Performs actions after the element has been deleted.
afterElementPropagate() (opens new window) Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore() (opens new window) Performs actions after the element has been restored.
afterElementSave() (opens new window) Performs actions after the element has been saved.
afterSave() (opens new window) 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() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeApplyDelete() (opens new window) Performs actions before a component delete is applied to the database.
beforeDelete() (opens new window) Performs actions before a component is deleted.
beforeElementDelete() (opens new window) Performs actions before an element is deleted.
beforeElementRestore() (opens new window) Performs actions before an element is restored.
beforeElementSave() (opens new window) Performs actions before an element is saved.
beforeSave() (opens new window) Performs actions before a component is saved.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() (opens new window) 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() (opens new window) 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() (opens new window) Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultSelectionLabel() Returns the default selectionLabel (opens new window) 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.
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() (opens new window) Returns the column type(s) that this field should get within the content table.
getContentGqlMutationArgumentType() (opens new window) Returns the GraphQL type to be used as an argument in mutations for this field type.
getContentGqlQueryArgumentType() (opens new window) 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() (opens new window) 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() (opens new window) Returns an array that maps source-to-target element IDs based on this custom field.
getElementValidationRules() (opens new window) Returns the validation rules for an element with this field.
getError() (opens new window) Returns the first error of the specified attribute.
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.
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() (opens new window) Returns the field’s group.
getInputHtml() (opens new window) Returns the field’s input HTML.
getIsNew() (opens new window) Returns whether the component is new (unsaved).
getIsTranslatable() (opens new window) 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() (opens new window) Returns the orientation the field should use (ltr or rtl).
getScenario() (opens new window) Returns the scenario that this model is used in.
getSearchKeywords() (opens new window) Returns the search keywords that should be associated with this field.
getSettings() (opens new window) Returns an array of the component’s settings.
getSettingsHtml() (opens new window) Returns the component’s settings HTML.
getSortOption() (opens new window) Returns the sort option array that should be included in the element’s sortOptions() (opens new window) response.
getSourceOptions() (opens new window) Normalizes the available sources into select input options.
getStaticHtml() (opens new window) Returns a static (non-editable) version of the field’s input HTML.
getStatus() (opens new window) Returns the status of the field for a given element.
getTableAttributeHtml() (opens new window) Returns the HTML that should be shown for this field in Table View.
getTargetSiteFieldHtml() (opens new window) Returns the HTML for the Target Site setting.
getTranslationDescription() (opens new window) Returns the description of this field’s translation support.
getTranslationKey() (opens new window) 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() (opens new window) Returns the HTML for the View Mode setting.
hasContentColumn() (opens new window) Returns whether this field has a column in the content table.
hasErrors() (opens new window) 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() (opens new window) Returns whether the field should be included in the given GraphQL schema.
init() (opens new window) 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.
isEmpty() (opens new window)
isSelectable() (opens new window) Returns whether the component should be selectable in component Type selects.
isValueEmpty() (opens new window) 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() (opens new window) Modifies an element index query.
modifyElementsQuery() (opens new window) Modifies an element query.
normalizeValue() (opens new window) 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.
rules() (opens new window) 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() (opens new window) Prepares the field’s value to be stored somewhere, like the content table.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setIsFresh() (opens new window) Sets whether the field is fresh.
setScenario() (opens new window) Sets the scenario for the model.
settingsAttributes() (opens new window) Returns the list of settings attribute names.
supportedTranslationMethods() (opens new window) 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() (opens new window) Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.
validateRelatedElements() (opens new window) Validates the related elements.
valueType() (opens new window) Returns the PHPDoc type this field’s values will have.

# defaultSelectionLabel()

Returns the default selectionLabel (opens new window) 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.

# getContentGqlType()

Since
3.1.4

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)

# Protected Methods

Method Description
availableSources() (opens new window) Returns the sources that should be available to choose from within the field's settings
defineRules() (opens new window) Returns the validation rules for attributes.
elementType() Returns the element class associated with this field type.
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() (opens new window) Returns the field’s input HTML.
inputSelectionCriteria() (opens new window) Returns any additional criteria parameters limiting which elements the field should be able to select.
inputSiteId() (opens new window) Returns the site ID that the input should select elements from.
inputSources() (opens new window) Returns an array of the source keys the field should be able to select elements from.
inputTemplateVariables() (opens new window) Returns an array of variables that should be passed to the input template.
isFresh() (opens new window) Returns whether this is the first time the element's content has been edited.
requestParamName() (opens new window) 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() (opens new window) Returns the search keywords that should be associated with this field.
settingsTemplateVariables() (opens new window) Returns an array of variables that should be passed to the settings template.
supportedViewModes() (opens new window) Returns the field’s supported view modes.
tableAttributeHtml() (opens new window) Returns the HTML that should be shown for this field in Table View.
targetSiteId() (opens new window) Returns the site ID that target elements should have.
viewMode() (opens new window) Returns the field’s current view mode.

# elementType()

Returns the element class associated with this field type.

View source (opens new window)

Returns

string (opens new window) – The Element class name

Throws

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.
TRANSLATION_METHOD_CUSTOM
TRANSLATION_METHOD_LANGUAGE
TRANSLATION_METHOD_NONE
TRANSLATION_METHOD_SITE
TRANSLATION_METHOD_SITE_GROUP