VariantsField
- Type
- Class
- Namespace
- craft\commerce\fieldlayoutelements
- Inherits
- craft\commerce\fieldlayoutelements\VariantsField » craft\fieldlayoutelements\BaseField (opens new window) » craft\base\FieldLayoutElement (opens new window) » craft\base\FieldLayoutComponent (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\ModelInterface (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), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Since
- 3.2.0
VariantsField represents a Variants field that can be included within a product type’s product field layout designer.
View source (opens new window)
# Public Properties
# 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) | |
| __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. |
| __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. |
| 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. |
| attribute() | Returns the element attribute this field is for. |
| 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. |
| 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. |
| 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. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| 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. |
| formHtml() (opens new window) | Returns the element’s form HTMl. |
| 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. |
| getElementCondition() (opens new window) | Returns the element condition for this layout element. |
| 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. |
| getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
| getLayout() (opens new window) | Returns the layout this element belongs to. |
| getScenario() (opens new window) | Returns the scenario that this model is used in. |
| getSettingsHtml() (opens new window) | Returns the settings HTML for the layout element. |
| getUserCondition() (opens new window) | Returns the user condition for this layout element. |
| getValidators() (opens new window) | Returns all the validators declared in rules() (opens new window). |
| hasConditions() (opens new window) | Returns whether this element has any conditions. |
| hasCustomWidth() | Returns whether the element can have a custom width. |
| 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. |
| 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. |
| keywords() (opens new window) | Returns the search keywords for this layout element. |
| label() (opens new window) | Returns the field’s label. |
| 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. |
| mandatory() | Returns whether the field must be present within the layout. |
| 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. |
| requirable() (opens new window) | Returns whether the field can optionally be marked as required. |
| 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. |
| selectorHtml() (opens new window) | Returns the selector HTML that should be displayed within field layout designers. |
| setAttributes() (opens new window) | Sets the attribute values in a massive way. |
| setElementCondition() (opens new window) | Sets the element condition for this layout element. |
| setLayout() (opens new window) | Sets the layout this element belongs to. |
| setScenario() (opens new window) | Sets the scenario for the model. |
| setUserCondition() (opens new window) | Sets the user condition for this layout element. |
| showAttribute() (opens new window) | Returns whether the attribute should be shown for admin users with “Show field handles in edit forms” enabled. |
| showInForm() (opens new window) | Returns whether the layout element should be shown in an edit form for the given element. |
| toArray() (opens new window) | Converts the model into an array. |
| trigger() (opens new window) | Triggers an event. |
| validate() (opens new window) | Performs the data validation. |
| validateMultiple() (opens new window) | Validates multiple models. |
# attribute()
Returns the element attribute this field is for.
View source (opens new window)
Returns
# hasCustomWidth()
Returns whether the element can have a custom width.
View source (opens new window)
Returns
# mandatory()
Returns whether the field must be present within the layout.
View source (opens new window)
Returns
# Protected Methods
| Method | Description |
|---|---|
| conditional() (opens new window) | Returns whether this element can be conditional. |
| containerAttributes() (opens new window) | Returns the element container HTML attributes. |
| defaultInstructions() (opens new window) | Returns the field’s default instructions, which will be used if instructions() (opens new window) is null. |
| defaultLabel() | Returns the field’s default label, which will be used if label() (opens new window) is null. |
| defineBehaviors() (opens new window) | Returns the behaviors to attach to this class. |
| defineRules() (opens new window) | Returns the validation rules for attributes. |
| describedBy() (opens new window) | Returns the aria-describedby attribute value that should be set on the focusable input(s). |
| errors() (opens new window) | Returns the field’s validation errors. |
| errorsId() (opens new window) | Returns the id of the field errors. |
| 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. |
| id() (opens new window) | Returns the id of the input. |
| inputContainerAttributes() (opens new window) | Returns input container HTML attributes. |
| inputHtml() | Returns the field’s input HTML. |
| instructions() (opens new window) | Returns the field’s instructions. |
| instructionsId() (opens new window) | Returns the id of the field instructions. |
| labelAttributes() (opens new window) | Returns label HTML attributes. |
| labelId() (opens new window) | Returns the id of the field label. |
| orientation() (opens new window) | Returns the field’s orientation (ltr or rtl). |
| resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
| selectorAttributes() (opens new window) | Returns HTML attributes that should be added to the selector container. |
| selectorInnerHtml() | Returns the selector’s inner HTML. |
| selectorLabel() (opens new window) | Returns the selector label. |
| settingsHtml() (opens new window) | Returns the settings HTML for the layout element. |
| showLabel() (opens new window) | Returns whether the label should be shown in form inputs. |
| statusClass() (opens new window) | Returns the field’s status class. |
| statusId() (opens new window) | Returns the id if the field status message. |
| statusLabel() (opens new window) | Returns the field’s status label. |
| tip() (opens new window) | Returns the field’s tip text. |
| tipId() (opens new window) | Returns the id of the field tip. |
| translatable() (opens new window) | Returns whether the field is translatable. |
| translationDescription() (opens new window) | Returns the descriptive text for how this field is translatable. |
| useFieldset() (opens new window) | Returns whether the element’s form HTML should use a <fieldset> + <legend> instead of a <div> + <label>. |
| value() (opens new window) | Returns the field’s value. |
| warning() (opens new window) | Returns the field’s warning text. |
| warningId() (opens new window) | Returns the id of the field warning. |
# defaultLabel()
Returns the field’s default label, which will be used if label() (opens new window) is null.
View source (opens new window)
Arguments
$element(craft\base\ElementInterface (opens new window), null (opens new window)) – The element the form is being rendered for$static(boolean (opens new window)) – Whether the form should be static (non-interactive)
Returns
string (opens new window), null (opens new window)
# inputHtml()
Returns the field’s input HTML.
View source (opens new window)
Arguments
$element(craft\base\ElementInterface (opens new window), null (opens new window)) – The element the form is being rendered for$static(boolean (opens new window)) – Whether the form should be static (non-interactive)
Returns
string (opens new window), null (opens new window)
# selectorInnerHtml()
Returns the selector’s inner HTML.
View source (opens new window)
Returns
# Constants
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |