Commerce 3 Class Reference

Variant

Type
Class
Namespace
craft\commerce\elements
Inherits
craft\commerce\elements\Variant » craft\commerce\base\Purchasable » craft\base\Element (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\ElementInterface (opens new window), craft\commerce\base\PurchasableInterface, 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\ElementTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
2.0

Variant model.

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).
ancestors (opens new window) craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
archived (opens new window) boolean (opens new window) – Whether the element is archived
attributes (opens new window) array (opens new window) – Attribute values (name => value).
awaitingFieldValues (opens new window) boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
cacheTags (opens new window) string (opens new window)[]
children (opens new window) craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
contentId (opens new window) integer (opens new window), null (opens new window) – The element’s content row ID
contentTable (opens new window) string (opens new window)
cpEditUrl string (opens new window), null (opens new window)
currentRevision (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
dateCreated (opens new window) DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted (opens new window) DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateUpdated (opens new window) DateTime (opens new window), null (opens new window) – The date that the element was last updated
deletedWithProduct boolean (opens new window) – Whether the variant was deleted along with its product
descendants (opens new window) craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
description string (opens new window)
dirtyAttributes (opens new window) string (opens new window)[]
dirtyFields (opens new window) string (opens new window)[]
draftId (opens new window) integer (opens new window), null (opens new window) – The ID of the draft’s row in the drafts table
duplicateOf (opens new window) craft\base\ElementInterface (opens new window), null (opens new window) – The element that this element is being duplicated by.
editorHtml (opens new window) string (opens new window) – The HTML for the editor HUD
enabled (opens new window) boolean (opens new window) – Whether the element is enabled
enabledForSite (opens new window) boolean (opens new window), null (opens new window) – Whether the element is enabled for the given site.
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
fieldColumnPrefix (opens new window) string (opens new window)
fieldContext (opens new window) string (opens new window)
fieldLayout craft\models\FieldLayout (opens new window), null (opens new window)
fieldLayoutId (opens new window) integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace (opens new window) string (opens new window), null (opens new window) – The field param namespace
fieldValues (opens new window) array (opens new window) – The field values (handle => value)
fieldValuesFromRequest (opens new window) string (opens new window) – The field param namespace
firstErrors (opens new window) array (opens new window) – The first errors.
gqlTypeName string (opens new window)
hardDelete (opens new window) boolean (opens new window) – Whether the element is being hard-deleted.
hasCheckeredThumb (opens new window) boolean (opens new window)
hasDescendants (opens new window) boolean (opens new window)
hasFreshContent (opens new window) boolean (opens new window) – Whether the element’s content is fresh
hasRoundedThumb (opens new window) boolean (opens new window)
hasUnlimitedStock boolean (opens new window)
height integer (opens new window)
id (opens new window) integer (opens new window), null (opens new window) – The element’s ID
isAvailable boolean (opens new window)
isDefault boolean (opens new window)
isDeletable (opens new window) boolean (opens new window)
isDraft (opens new window) boolean (opens new window)
isEditable boolean (opens new window)
isHomepage (opens new window) boolean (opens new window)
isPromotable boolean (opens new window)
isRevision (opens new window) boolean (opens new window)
isShippable boolean (opens new window)
isTaxable boolean (opens new window)
isTitleTranslatable (opens new window) boolean (opens new window)
isUnsavedDraft (opens new window) boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
language (opens new window) string (opens new window)
length integer (opens new window)
level (opens new window) integer (opens new window), null (opens new window) – The element’s level within its structure
lft (opens new window) integer (opens new window), null (opens new window) – The element’s left position within its structure
link (opens new window) \Twig\Markup, null (opens new window)
localized (opens new window) craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
maxQty integer (opens new window)
minQty integer (opens new window)
newSiteIds (opens new window) integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
nextSibling (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
onSale boolean (opens new window)
parent (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
prev (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
prevSibling (opens new window) craft\base\ElementInterface (opens new window), null (opens new window)
previewTargets (opens new window) array (opens new window)
previewing (opens new window) boolean (opens new window) – Whether the element is currently being previewed.
price
product craft\commerce\elements\Product, null (opens new window) – The product associated with this variant, or null if it isn’t known
productId integer (opens new window)
promotionRelationSource array (opens new window)
propagateAll (opens new window) boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating (opens new window) boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref (opens new window) string (opens new window), null (opens new window)
resaving (opens new window) boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId (opens new window) integer (opens new window) – The ID of the revision’s row in the revisions table
rgt (opens new window) integer (opens new window), null (opens new window) – The element’s right position within its structure
root (opens new window) integer (opens new window), null (opens new window) – The element’s structure’s root ID
route (opens new window) mixed – The route that the request should use, or null if no special action should be taken
salePrice float (opens new window) – Decimal(14,4)
sales craft\commerce\models\Sale[], null (opens new window)
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchScore (opens new window) integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() (opens new window) parameter was used when querying for the element
serializedFieldValues (opens new window) array (opens new window)
shippingCategoryId integer (opens new window)
siblings (opens new window) craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
site (opens new window) craft\models\Site (opens new window)
siteId (opens new window) integer (opens new window), null (opens new window) – The site ID the element is associated with
siteSettingsId (opens new window) integer (opens new window), null (opens new window) – The ID of the element’s record in the elements_sites table
sku string (opens new window)
skuAsText string (opens new window)
slug (opens new window) string (opens new window), null (opens new window) – The element’s slug
snapshot array (opens new window)
sortOrder integer (opens new window)
sourceId (opens new window) integer (opens new window), null (opens new window)
sourceUid (opens new window) string (opens new window)
status (opens new window) string (opens new window), null (opens new window)
stock integer (opens new window)
structureId (opens new window) integer (opens new window), null (opens new window) – The element’s structure ID
supportedSites (opens new window) integer (opens new window)[], array (opens new window)
taxCategoryId integer (opens new window)
tempId (opens new window) string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element's URI format contains {id})
title (opens new window) string (opens new window), null (opens new window) – The element’s title
titleTranslationDescription (opens new window) string (opens new window), null (opens new window)
titleTranslationKey (opens new window) string (opens new window) – The translation key
totalDescendants (opens new window) integer (opens new window)
trashed (opens new window) boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel (opens new window) string (opens new window)
uid (opens new window) string (opens new window), null (opens new window) – The element’s UID
uri (opens new window) string (opens new window), null (opens new window) – The element’s URI
uriFormat (opens new window) string (opens new window), null (opens new window)
url string (opens new window), null (opens new window)
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
weight integer (opens new window)
width integer (opens new window)

# cpEditUrl

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

View source (opens new window)

# deletedWithProduct

Type
boolean (opens new window)
Default value
false

Whether the variant was deleted along with its product

See also beforeDelete()

View source (opens new window)

# description

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

View source (opens new window)

# fieldLayout

Type
craft\models\FieldLayout (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# gqlTypeName

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.1

View source (opens new window)

# hasUnlimitedStock

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# height

Type
integer (opens new window)
Default value
null

View source (opens new window)

# isAvailable

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

View source (opens new window)

# isDefault

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# isEditable

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

View source (opens new window)

# isPromotable

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

View source (opens new window)

# length

Type
integer (opens new window)
Default value
null

View source (opens new window)

# maxQty

Type
integer (opens new window)
Default value
null

View source (opens new window)

# minQty

Type
integer (opens new window)
Default value
null

View source (opens new window)

# price

Default value
null

View source (opens new window)

# product

Type
craft\commerce\elements\Product, null (opens new window)
Default value
null

The product associated with this variant, or null if it isn’t known

View source (opens new window)

# productId

Type
integer (opens new window)
Default value
null

View source (opens new window)

# promotionRelationSource

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

View source (opens new window)

# shippingCategoryId

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

View source (opens new window)

# sku

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

View source (opens new window)

# skuAsText

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

View source (opens new window)

# snapshot

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

View source (opens new window)

# sortOrder

Type
integer (opens new window)
Default value
null

View source (opens new window)

# stock

Type
integer (opens new window)
Default value
null

View source (opens new window)

# taxCategoryId

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

View source (opens new window)

# url

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

View source (opens new window)

# weight

Type
integer (opens new window)
Default value
null

View source (opens new window)

# width

Type
integer (opens new window)
Default value
null

View source (opens new window)

# Protected Properties

Property Description
revisionCreatorId (opens new window) string (opens new window), null (opens new window) – Revision creator ID to be saved
revisionNotes (opens new window) string (opens new window), null (opens new window) – Revision notes to be saved

# 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.
__set() (opens new window) Sets the value of a component property.
__toString() Returns the string representation of the element.
__unset() (opens new window) Sets a component property to be null.
actions() (opens new window) Returns the available element actions (opens new window) for a given source.
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() Clean up purchasable table
afterMoveInStructure() (opens new window) Performs actions after an element is moved within a structure.
afterOrderComplete() Updates Stock count from completed order.
afterPropagate() (opens new window) Performs actions after an element is fully saved and propagated to other sites.
afterRestore()
afterSave() Update purchasable table
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() Returns the list of attribute names.
beforeDelete() Performs actions before an element is deleted.
beforeMoveInStructure() (opens new window) Performs actions before an element is moved within a structure.
beforeRestore() Performs actions before an element is restored.
beforeSave()
beforeValidate() This method is invoked before validation starts.
behaviors()
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).
currencyAttributes()
datetimeAttributes() (opens new window) Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes() (opens new window) Returns the list of table attribute keys that should be shown by default.
defineRules() Returns the validation rules for attributes.
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.
eagerLoadingMap() Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exporters() (opens new window) Returns the available export options for a given source.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fieldLayouts() (opens new window) Returns all of the field layouts associated with elements from the given source.
fields()
find() Creates an craft\elements\db\ElementQueryInterface (opens new window) instance for query purpose.
findAll() (opens new window) Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne() (opens new window) Returns a single element instance by a primary key or a set of element criteria parameters.
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).
getAncestors() (opens new window) Returns the element’s ancestors.
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributeStatus() (opens new window) Returns the status of a given 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.
getCacheTags() (opens new window) Returns the cache tags that should be cleared when this element is saved.
getChildren() (opens new window) Returns the element’s children.
getContentTable() (opens new window) Returns the name of the table this element’s content is stored in.
getCpEditUrl() Returns the element’s edit URL in the control panel.
getCurrentRevision() (opens new window) Returns the element’s current revision, if one exists.
getDescendants() (opens new window) Returns the element’s descendants.
getDescription() Returns the product title and variants title together for variable products.
getDirtyAttributes() (opens new window) Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() (opens new window) Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() (opens new window) Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() (opens new window) Returns the eager-loaded elements for a given handle.
getEditorHtml() (opens new window) Returns the HTML for the element’s editor HUD.
getEnabledForSite() (opens new window) Returns whether the element is enabled for the current site.
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.
getFieldColumnPrefix() (opens new window) Returns the field column prefix this element’s content uses.
getFieldContext() (opens new window) Returns the field context this element’s content uses.
getFieldLayout() Returns the field layout used by this element.
getFieldParamNamespace() (opens new window) Returns the namespace used by custom field params on the request.
getFieldStatus() (opens new window) Returns the status of a given field.
getFieldValue() (opens new window) Returns the value for a given field.
getFieldValues() (opens new window) Returns the element’s normalized custom field values, indexed by their handles.
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.
getGqlTypeName()
getHasCheckeredThumb() (opens new window) Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants() (opens new window) Returns whether the element has descendants.
getHasFreshContent() (opens new window) Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHasRoundedThumb() (opens new window) Returns whether the element’s thumbnail should be rounded.
getHtmlAttributes() (opens new window) Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() Returns the element’s ID.
getIsAvailable() Returns whether the purchasable is currently available for purchase.
getIsDeletable() (opens new window) Returns whether the current user can delete the element.
getIsDraft() (opens new window) Returns whether this is a draft.
getIsEditable()
getIsHomepage() (opens new window) Returns whether this element represents the site homepage.
getIsPromotable() Returns whether this purchasable can be subject to discounts or sales.
getIsRevision() (opens new window) Returns whether this is a revision.
getIsShippable()
getIsTaxable() Returns whether this purchasable is exempt from taxes.
getIsTitleTranslatable() (opens new window) Returns whether the Title field should be shown as translatable in the UI.
getIsUnsavedDraft() (opens new window) Returns whether the element is an unsaved draft.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getLanguage() (opens new window) Returns the language of the element.
getLineItemRules() Returns any validation rules this purchasable required the line item to have.
getLink() (opens new window) Returns an anchor pre-filled with this element’s URL and title.
getLocalized() (opens new window) Returns the same element in other locales.
getNext() (opens new window) Returns the next element relative to this one, from a given set of criteria.
getNextSibling() (opens new window) Returns the element’s next sibling.
getOnSale()
getParent() (opens new window) Returns the element’s parent.
getPrev() (opens new window) Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() (opens new window) Returns the element’s previous sibling.
getPreviewTargets() (opens new window) Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
getPrice() Cache on the purchasable table.
getProduct() Returns the product associated with this variant.
getPromotionRelationSource() Returns a promotion category related to this element if the category is related to the product OR the variant.
getRef() (opens new window) Returns the reference string to this element.
getRoute() (opens new window) Returns the route that should be used when the element’s URI is requested.
getSalePrice() Returns the base price the item will be added to the line item with.
getSales() Returns an array of sales models which are currently affecting the salePrice of this purchasable.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSearchKeywords()
getSerializedFieldValues() (opens new window) Returns an array of the element’s serialized custom field values, indexed by their handles.
getShippingCategoryId() Returns the purchasable's shipping category ID.
getSiblings() (opens new window) Returns all of the element’s siblings.
getSite() (opens new window) Returns the site the element is associated with.
getSku() Returns a unique code. Unique as per the commerce_purchasables table.
getSkuAsText() Returns the SKU as text but returns a blank string if it’s a temp SKU.
getSnapshot()
getSourceId() (opens new window) Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() (opens new window) Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus() (opens new window) Returns the element’s status.
getSupportedSites() (opens new window) Returns the sites this element is associated with.
getTableAttributeHtml() (opens new window) Returns the HTML that should be shown for a given attribute in Table View.
getTaxCategoryId() Returns the purchasable's tax category ID.
getThumbUrl() (opens new window) Returns the URL to the element’s thumbnail, if there is one.
getTitleTranslationDescription() (opens new window) Returns the description of the Title field’s translation support.
getTitleTranslationKey() (opens new window) Returns the Title’s translation key.
getTotalDescendants() (opens new window) Returns the total number of descendants that the element has.
getUiLabel() (opens new window) Returns what the element should be called within the control panel.
getUriFormat() (opens new window) Returns the URI format used to generate this element’s URI.
getUrl() Returns the element’s full URL.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
gqlMutationNameByContext() (opens new window) Returns the GraphQL mutation name by an element's context.
gqlScopesByContext()
gqlTypeNameByContext()
hasContent() Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
hasEagerLoadedElements() (opens new window) Returns whether elements have been eager-loaded with a given handle.
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.
hasFreeShipping() Returns whether this purchasable has free shipping.
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.
hasStatuses() Returns whether elements of this type have statuses.
hasStock() Returns whether this variant has stock.
hasTitles() Returns whether elements of this type have traditional titles.
hasUris() (opens new window) Returns whether elements of this type can have their own slugs and URIs.
indexHtml() (opens new window) Returns the element index HTML.
init() (opens new window) Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAncestorOf() (opens new window) Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty() (opens new window) Returns whether an attribute has changed since the element was first loaded.
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.
isChildOf() (opens new window) Returns whether this element is a direct child of another one.
isDescendantOf() (opens new window) Returns whether this element is a descendant of another one.
isFieldDirty() (opens new window) Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty() (opens new window) Returns whether a field is empty.
isLocalized() Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf() (opens new window) Returns whether this element is the direct next sibling of another one.
isParentOf() (opens new window) Returns whether this element is a direct parent of another one.
isPrevSiblingOf() (opens new window) Returns whether this element is the direct previous sibling of another one.
isSelectable() Returns whether the component should be selectable in component Type selects.
isSiblingOf() (opens new window) Returns whether this element is a sibling of another one.
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.
lowerDisplayName() Returns the lowercase version of displayName().
markAsClean() (opens new window) Resets the record of dirty attributes and fields.
markAsDirty() (opens new window) Marks all fields and attributes as dirty.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Treats custom fields as array offsets.
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.
pluralDisplayName() Returns the plural version of displayName().
pluralLowerDisplayName() Returns the plural, lowercase version of displayName().
populateLineItem() Populates the line item when this purchasable is found on it. Called when Purchasable is added to the cart and when the cart recalculates.
refHandle() Returns the handle that should be used to refer to this element type from reference tags.
relatedSales()
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.
searchableAttributes() (opens new window) Defines which element attributes should be searchable.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setDirtyAttributes() (opens new window) Sets the list of dirty attribute names.
setEagerLoadedElementCount() (opens new window) Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() Sets some eager-loaded elements on a given handle.
setEnabledForSite() (opens new window) Sets whether the element is enabled for the current site.
setFieldParamNamespace() (opens new window) Sets the namespace used by custom field params on the request.
setFieldValue() (opens new window) Sets the value for a given field.
setFieldValues() (opens new window) Sets the element’s custom field values.
setFieldValuesFromRequest() (opens new window) Sets the element’s custom field values, when the values have come from post data.
setNext() (opens new window) Sets the default next element.
setParent() (opens new window) Sets the element’s parent.
setPrev() (opens new window) Sets the default previous element.
setProduct() Sets the product associated with this variant.
setRevisionCreatorId() (opens new window) Sets the revision creator ID to be saved.
setRevisionNotes() (opens new window) Sets the revision notes to be saved.
setScenario() (opens new window) Sets the scenario for the model.
setSku()
sortOptions() (opens new window) Returns the sort options for the element type.
sources() (opens new window) Returns the source definitions that elements of this type may belong to.
statuses() (opens new window) Returns all of the possible statuses that elements of this type may have.
tableAttributes() (opens new window) Defines all of the available columns that can be shown in table views.
toArray() (opens new window) Converts the model into an array.
trackChanges() (opens new window) Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() (opens new window) Triggers an event.
updateSku()
updateTitle() Updates the title based on titleFormat, or sets it to the same title as the product.
validate() (opens new window) Performs the data validation.
validateCustomFieldAttribute() (opens new window) Calls a custom validation function on a custom field.
validateCustomFieldContentSize() (opens new window) Validates that the content size is going to fit within the field’s database column.
validateMultiple() (opens new window) Validates multiple models.

# __toString()

Returns the string representation of the element.

View source (opens new window)

Returns

string (opens new window)

# afterOrderComplete()

Updates Stock count from completed order.

This is called for each line item the purchasable was contained within.

View source (opens new window)

Arguments

Returns

void

# afterRestore()

View source (opens new window)

Throws

# afterSave()

Update purchasable table

View source (opens new window)

Arguments

# attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel() (opens new window). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

# attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source (opens new window)

Returns

array (opens new window) – List of attribute names.

# beforeDelete()

Performs actions before an element is deleted.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be deleted

# beforeRestore()

Performs actions before an element is restored.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be restored

# beforeSave()

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# beforeValidate()

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

View source (opens new window)

Returns

boolean (opens new window) – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

# behaviors()

View source (opens new window)

Returns

array (opens new window)

# currencyAttributes()

View source (opens new window)

Returns

array (opens new window), string (opens new window)[]

# defineRules()

Returns the validation rules for attributes.

See rules() (opens new window) for details about what should be returned.

Models should override this method instead of rules() (opens new window) so EVENT_DEFINE_RULES (opens new window) handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# displayName()

Returns the display name of this class.

View source (opens new window)

Returns

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

# eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria (optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.
use craft\db\Query;
use craft\helpers\ArrayHelper;

public static function eagerLoadingMap(array $sourceElements, string $handle) {
    switch ($handle) {
        case 'author':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'id', 'target' => 'authorId'])
                ->from('{{%books}}')
                ->where(['id' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\Author::class,
                'map' => $map,
            ];
        case 'bookClubs':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'bookId', 'target' => 'clubId'])
                ->from('{{%bookclub_books}}')
                ->where(['bookId' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\BookClub::class,
                'map' => $map,
            ];
        default:
            return parent::eagerLoadMap($sourceElements, $handle);
    }
}

View source (opens new window)

Arguments

Returns

array (opens new window), false (opens new window), null (opens new window) – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored

# fields()

View source (opens new window)

Returns

array (opens new window)

# find()

Creates an craft\elements\db\ElementQueryInterface (opens new window) instance for query purpose.

The returned craft\elements\db\ElementQueryInterface (opens new window) instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface (opens new window) before one() or all() is called to return populated \craft\commerce\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source (opens new window)

Returns

craft\commerce\elements\db\VariantQuery – The newly created craft\commerce\elements\db\VariantQuery instance.

# getCpEditUrl()

Returns the element’s edit URL in the control panel.

View source (opens new window)

Returns

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

# getDescription()

Returns the product title and variants title together for variable products.

View source (opens new window)

Returns

string (opens new window)

Throws

# getFieldLayout()

Returns the field layout used by this element.

View source (opens new window)

Returns

craft\models\FieldLayout (opens new window), null (opens new window)

# getGqlTypeName()

Since
3.1

View source (opens new window)

Returns

string (opens new window)

Throws

# getIsAvailable()

Returns whether the purchasable is currently available for purchase.

View source (opens new window)

Returns

boolean (opens new window)

# getIsEditable()

View source (opens new window)

Returns

boolean (opens new window)

Throws

# getIsPromotable()

Returns whether this purchasable can be subject to discounts or sales.

View source (opens new window)

Returns

boolean (opens new window)

# getLineItemRules()

Returns any validation rules this purchasable required the line item to have.

View source (opens new window)

Arguments

Returns

array (opens new window)

# getPrice()

Cache on the purchasable table.

View source (opens new window)

Returns

float (opens new window) – Decimal(14,4)

# getProduct()

Returns the product associated with this variant.

View source (opens new window)

Returns

craft\commerce\elements\Product, null (opens new window) – The product associated with this variant, or null if it isn’t known

Throws

# getPromotionRelationSource()

Returns a promotion category related to this element if the category is related to the product OR the variant.

View source (opens new window)

Returns

array (opens new window)

# getSearchKeywords()

Since
2.2

View source (opens new window)

Arguments

Returns

string (opens new window)

Throws

# getShippingCategoryId()

Returns the purchasable's shipping category ID.

View source (opens new window)

Returns

integer (opens new window)

# getSku()

Returns a unique code. Unique as per the commerce_purchasables table.

View source (opens new window)

Returns

string (opens new window)

# getSkuAsText()

Returns the SKU as text but returns a blank string if it’s a temp SKU.

View source (opens new window)

Returns

string (opens new window)

# getSnapshot()

View source (opens new window)

Returns

array (opens new window)

Throws

# getTaxCategoryId()

Returns the purchasable's tax category ID.

View source (opens new window)

Returns

integer (opens new window)

# getUrl()

Returns the element’s full URL.

View source (opens new window)

Returns

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

# gqlScopesByContext()

Since
3.1

View source (opens new window)

Arguments

  • $context (mixed)

Returns

array (opens new window)

# gqlTypeNameByContext()

Since
3.1

View source (opens new window)

Arguments

  • $context (mixed)

Returns

string (opens new window)

# hasContent()

Returns whether elements of this type will be storing any data in the content table (titles or custom fields).

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type will be storing any data in the content table.

# hasFreeShipping()

Returns whether this purchasable has free shipping.

View source (opens new window)

Returns

boolean (opens new window)

# hasStatuses()

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() (opens new window) to customize which statuses the elements might have.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type have statuses.

# hasStock()

Returns whether this variant has stock.

View source (opens new window)

Returns

boolean (opens new window)

# hasTitles()

Returns whether elements of this type have traditional titles.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type have traditional titles.

# isLocalized()

Returns whether elements of this type store content on a per-site basis.

If this returns true, the element’s getSupportedSites() (opens new window) method will be responsible for defining which sites its content should be stored in.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type store data on a per-site basis.

# isSelectable()

Returns whether the component should be selectable in component Type selects.

View source (opens new window)

Returns

boolean (opens new window) – Whether the component should be selectable in component Type selects.

# lowerDisplayName()

Returns the lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# pluralDisplayName()

Returns the plural version of displayName().

View source (opens new window)

Returns

string (opens new window)

# pluralLowerDisplayName()

Returns the plural, lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# populateLineItem()

Populates the line item when this purchasable is found on it. Called when Purchasable is added to the cart and when the cart recalculates.

This is your chance to modify the weight, height, width, length, price and saleAmount. This is called before any LineItems::EVENT_POPULATE_LINE_ITEM event listeners.

View source (opens new window)

Arguments

# refHandle()

Returns the handle that should be used to refer to this element type from reference tags.

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The reference handle, or null if the element type doesn’t support reference tags

# setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source (opens new window)

Arguments

# setProduct()

Sets the product associated with this variant.

View source (opens new window)

Arguments

# setSku()

View source (opens new window)

Arguments

Returns

void

# updateSku()

View source (opens new window)

Arguments

Throws

# updateTitle()

Updates the title based on titleFormat, or sets it to the same title as the product.

See also craft\elements\Entry::updateTitle() (opens new window) View source (opens new window)

Arguments

Throws

# Protected Methods

Method Description
defineActions() (opens new window) Defines the available element actions for a given source.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() (opens new window) Defines the available element exporters for a given source.
defineFieldLayouts() (opens new window) Defines the field layouts associated with elements for a given source.
defineSearchableAttributes() Defines which element attributes should be searchable.
defineSortOptions() Returns the sort options for the element type.
defineSources() Defines the sources that elements of this type may belong to.
defineTableAttributes() Defines all of the available columns that can be shown in table views.
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.
fieldByHandle() (opens new window) Returns the field with a given handle.
fieldLayoutFields() (opens new window) Returns each of this element’s fields.
findByCondition() (opens new window) Finds Element instance(s) by the given condition.
htmlAttributes() (opens new window) Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() (opens new window) Normalizes a field’s value.
prepElementQueryForTableAttribute() (opens new window) Preps the element criteria for a given table attribute
previewTargets() (opens new window) Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
route() (opens new window) Returns the route that should be used when the element’s URI is requested.
searchKeywords() (opens new window) Returns the search keywords for a given search attribute.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source (opens new window)

Arguments

Returns

string (opens new window)[] – The table attributes.

# defineSearchableAttributes()

Defines which element attributes should be searchable.

View source (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

# defineSortOptions()

Returns the sort options for the element type.

View source (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

# defineSources()

Defines the sources that elements of this type may belong to.

View source (opens new window)

Arguments

Returns

array (opens new window) – The sources.

# defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source (opens new window)

Returns

array (opens new window) – The table attributes.

# tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value.

For example, if your elements have an email attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? Html::mailto(Html::encode($this->email)) : '';
    // ...
}
return parent::tableAttributeHtml($attribute);

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() (opens new window) to prevent XSS attacks.

By default the following will be returned:

  • If the attribute name is link or uri, it will be linked to the front-end URL.
  • If the attribute is a custom field handle, it will pass the responsibility off to the field type.
  • If the attribute value is a \craft\commerce\elements\DateTime object, the date will be formatted with a localized date format.
  • For anything else, it will output the attribute value as a string.

View source (opens new window)

Arguments

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

Throws

# Constants

Constant Description
ATTR_STATUS_CONFLICTED
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
HOMEPAGE_URI
SCENARIO_DEFAULT The name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED

# Events

# EVENT_AFTER_CAPTURE_PRODUCT_SNAPSHOT

Type
\craft\commerce\elements\craft\commerce\events\CustomizeProductSnapshotDataEvent

The event that is triggered after a product’s field data is captured, which can be used to customize, extend, or redact the data to be persisted on the product instance.

use craft\commerce\elements\Variant;
use craft\commerce\elements\Product;
use craft\commerce\events\CustomizeProductSnapshotDataEvent;
use yii\base\Event;

Event::on(
    Variant::class,
    Variant::EVENT_AFTER_CAPTURE_PRODUCT_SNAPSHOT,
    function(CustomizeProductSnapshotDataEvent $event) {
        // @var Product $product
        $product = $event->product;
        // @var array $data
        $data = $event->fieldData;

        // Modify or redact captured `$data`
        // ...
    }
);

# EVENT_AFTER_CAPTURE_VARIANT_SNAPSHOT

Type
\craft\commerce\elements\craft\commerce\events\CustomizeVariantSnapshotDataEvent

The event that is triggered after a variant’s field data is captured. This makes it possible to customize, extend, or redact the data to be persisted on the variant instance.

use craft\commerce\elements\Variant;
use craft\commerce\events\CustomizeVariantSnapshotDataEvent;
use yii\base\Event;

Event::on(
    Variant::class,
    Variant::EVENT_AFTER_CAPTURE_VARIANT_SNAPSHOT,
    function(CustomizeVariantSnapshotDataEvent $event) {
        // @var Variant $variant
        $variant = $event->variant;
        // @var array|null $fields
        $fields = $event->fields;

        // Modify or redact captured `$data`
        // ...
    }
);

# EVENT_BEFORE_CAPTURE_PRODUCT_SNAPSHOT

Type
\craft\commerce\elements\craft\commerce\events\CustomizeProductSnapshotFieldsEvent

The event that is triggered before a product’s field data is captured. This makes it possible to customize which fields are included in the snapshot. Custom fields are not included by default.

This example adds every custom field to the product snapshot:

use craft\commerce\elements\Variant;
use craft\commerce\elements\Product;
use craft\commerce\events\CustomizeProductSnapshotFieldsEvent;
use yii\base\Event;

Event::on(
    Variant::class,
    Variant::EVENT_BEFORE_CAPTURE_PRODUCT_SNAPSHOT,
    function(CustomizeProductSnapshotFieldsEvent $event) {
        // @var Product $product
        $product = $event->product;
        // @var array|null $fields
        $fields = $event->fields;

        // Add every custom field to the snapshot
        if (($fieldLayout = $product->getFieldLayout()) !== null) {
            foreach ($fieldLayout->getFields() as $field) {
                $fields[] = $field->handle;
            }
        }

        $event->fields = $fields;
    }
);

WARNING

Add with care! A huge amount of custom fields/data will increase your database size.

# EVENT_BEFORE_CAPTURE_VARIANT_SNAPSHOT

Type
\craft\commerce\elements\craft\commerce\events\CustomizeVariantSnapshotFieldsEvent

The event that is triggered before a variant’s field data is captured, which makes it possible to customize which fields are included in the snapshot. Custom fields are not included by default.

This example adds every custom field to the variant snapshot:

use craft\commerce\elements\Variant;
use craft\commerce\events\CustomizeVariantSnapshotFieldsEvent;
use yii\base\Event;

Event::on(
    Variant::class,
    Variant::EVENT_BEFORE_CAPTURE_VARIANT_SNAPSHOT,
    function(CustomizeVariantSnapshotFieldsEvent $event) {
        // @var Variant $variant
        $variant = $event->variant;
        // @var array|null $fields
        $fields = $event->fields;

        // Add every custom field to the snapshot
        if (($fieldLayout = $variant->getFieldLayout()) !== null) {
            foreach ($fieldLayout->getFields() as $field) {
                $fields[] = $field->handle;
            }
        }

        $event->fields = $fields;
    }
);

← CreateDiscount →