VariantsField

Type
Class
Namespace
craft\commerce\fieldlayoutelements
Inherits
craft\commerce\fieldlayoutelements\VariantsField » craft\fieldlayoutelements\BaseField (opens new window) » craft\base\FieldLayoutElement (opens new window) » yii\base\BaseObject (opens new window)
Implements
craft\base\FieldLayoutElementInterface (opens new window), yii\base\Configurable (opens new window)
Uses traits
yii\base\ArrayableTrait (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.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attribute() Returns the element attribute this field is for.
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.
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.
hasCustomWidth() Returns whether the element can have a custom width.
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.
init() (opens new window) Initializes the object.
keywords() (opens new window) Returns the search keywords for this layout element.
label() (opens new window) Returns the field’s label.
mandatory() Returns whether the field must be present within the layout.
requirable() (opens new window) Returns whether the field can optionally be marked as required.
selectorHtml() (opens new window) Returns the selector HTML that should be displayed within field layout designers.
settingsHtml() (opens new window) Returns the settings HTML for the layout element.
toArray() (opens new window) Converts the model into an array.

# attribute()

Returns the element attribute this field is for.

View source (opens new window)

Returns

string (opens new window)

# hasCustomWidth()

Returns whether the element can have a custom width.

View source (opens new window)

Returns

boolean (opens new window)

# mandatory()

Returns whether the field must be present within the layout.

View source (opens new window)

Returns

boolean (opens new window)

# Protected Methods

Method Description
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.
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.
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.
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

Returns

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

# inputHtml()

Returns the field’s input HTML.

View source (opens new window)

Arguments

Returns

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

# selectorInnerHtml()

Returns the selector’s inner HTML.

View source (opens new window)

Returns

string (opens new window)