Variant ​
- Type
- Class
- Namespace
- craft\commerce\elements
- Inherits
- craft\commerce\elements\Variant » craft\commerce\base\Purchasable » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ModelInterface, craft\commerce\base\PurchasableInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 2.0
Variant model.
Public Properties ​
Property | Description |
---|---|
activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
additionalButtons | string |
ancestors | craft\elements\db\ElementQueryInterface – The element’s ancestors |
archived | boolean – Whether the element is archived |
attributes | array – Attribute values (name => value). |
awaitingFieldValues | boolean – Whether the element is still awaiting its custom field values |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
cacheTags | string[] |
canonical | craft\base\ElementInterface, null – The canonical element, if one exists for the current site |
canonicalId | integer, null – The element’s canonical ID |
canonicalUid | string – The element’s canonical UID |
children | craft\elements\db\ElementQueryInterface – The element’s children |
contentId | integer, null – The element’s content row ID |
contentTable | string – The name of the table this element’s content is stored in |
cpEditUrl | string, null – The element’s edit URL in the control panel |
cpRevisionsUrl | string, null |
currentRevision | self , null |
dateCreated | craft\gql\types\DateTime, null |
dateDeleted | DateTime, null – The date that the element was trashed |
dateLastMerged | DateTime, null – The date that the canonical element was last merged into this one |
dateUpdated | craft\gql\types\DateTime, null |
deletedWithProduct | boolean – Whether the variant was deleted along with its product |
descendants | craft\elements\db\ElementQueryInterface – The element’s descendants |
description | string – the element's title or any additional descriptive information |
dirtyAttributes | string[] |
dirtyFields | string[] |
draftId | integer, null – The ID of the draft’s row in the drafts table |
duplicateOf | craft\base\ElementInterface, null – The element that this element is duplicating. |
eagerLoadedElements | string – some eager-loaded elements on a given handle |
editorHtml | string – The HTML for the element’s editor HUD |
enabled | boolean – Whether the element is enabled |
enabledForSite | boolean – Whether the element is enabled for this site |
errors | array – Errors for all attributes or the specified attribute. |
fieldColumnPrefix | string – The field column prefix this element’s content uses |
fieldContext | string – The field context this element’s content uses |
fieldLayout | craft\models\FieldLayout, null – The field layout used by this element |
fieldLayoutId | integer, null – The element’s field layout ID |
fieldParamNamespace | array – The namespace used by custom field params on the request |
fieldValues | array – The element’s normalized custom field values, indexed by their handles |
firstErrors | array – The first errors. |
firstSave | boolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision). |
gqlTypeName | string |
hardDelete | boolean – Whether the element is being hard-deleted. |
hasCheckeredThumb | boolean |
hasDescendants | boolean – Whether the element has descendants |
hasRoundedThumb | boolean |
hasUnlimitedStock | boolean |
height | float, null |
htmlAttributes | array – Any attributes that should be included in the element’s DOM representation in the control panel |
id | integer, null – The element’s ID |
isAvailable | boolean – whether the purchasable is currently available for purchase |
isCanonical | boolean – Whether this is the canonical element |
isDefault | boolean |
isDerivative | boolean – Whether this is a derivative element, such as a draft or revision |
isDraft | boolean |
isFresh | boolean |
isHomepage | boolean |
isNewForSite | boolean – Whether the element is being saved to the current site for the first time. |
isNewSite | boolean – Whether this is for a newly-created site. |
isPromotable | boolean – whether this purchasable can be subject to discounts or sales |
isProvisionalDraft | boolean – Whether this is a provisional draft. |
isRevision | boolean |
isShippable | boolean |
isSlugTranslatable | boolean |
isTaxable | boolean |
isTitleTranslatable | boolean |
isUnpublishedDraft | boolean |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
language | string |
length | float, null |
level | integer, null – The element’s level within its structure |
lft | integer, null – The element’s left position within its structure |
link | \Twig\Markup , null – An anchor pre-filled with this element’s URL and title |
localized | craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection |
maxQty | integer, null |
mergingCanonicalChanges | boolean – Whether recent changes to the canonical element are being merged into this element. |
metadata | array – The data, with keys representing the labels. |
minQty | integer, null |
modifiedAttributes | string[] |
modifiedFields | string[] |
newSiteIds | integer[] – The site IDs that the element was just propagated to for the first time. |
next | craft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria |
nextSibling | craft\base\ElementInterface, null – The element’s next sibling |
onSale | boolean |
outdatedAttributes | string[] |
outdatedFields | string[] |
parent | craft\base\ElementInterface, null – The element’s parent |
parentId | integer, null – The element’s parent’s ID |
parentUri | string, null |
postEditUrl | string, null |
prev | craft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria |
prevSibling | craft\base\ElementInterface, null – The element’s previous sibling |
previewTargets | array |
previewing | boolean – Whether the element is currently being previewed. |
price | float – the base price the item will be added to the line item with |
priceAsCurrency | string |
product | craft\commerce\elements\Product – the product associated with this variant |
productId | integer, null |
promotionRelationSource | float – The source for any promotion category relation |
propagateAll | boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values. |
propagating | boolean – Whether the element is being saved in the context of propagating another site's version of the element. |
ref | string, null – The reference string to this element |
resaving | boolean – Whether the element is being resaved by a ResaveElement job or a resave console command. |
revisionId | integer, null – The ID of the revision’s row in the revisions table |
rgt | integer, null – The element’s right position within its structure |
root | integer, null – The element’s structure’s root ID |
rootOwner | self |
route | mixed – The route that should be used when the element’s URI is requested |
salePrice | float – the base price the item will be added to the line item with |
salePriceAsCurrency | string |
sales | craft\commerce\models\Sale[] – sales models which are currently affecting the salePrice of this purchasable |
scenario | string – The scenario that this model is in. |
searchScore | integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element |
serializedFieldValues | array – Array of the element’s serialized custom field values, indexed by their handles |
serializedFieldValuesForDb | array |
shippingCategoryId | integer – the purchasable's shipping category ID |
siblings | craft\elements\db\ElementQueryInterface – All of the element’s siblings |
site | craft\models\Site – Site the element is associated with |
siteId | integer, null – The site ID the element is associated with |
siteSettingsId | integer, null – The ID of the element’s record in the elements_sites table |
sku | string – a unique code as per the commerce_purchasables table |
skuAsText | string |
slug | string, null – The element’s slug |
slugTranslationDescription | string, null |
slugTranslationKey | string – The translation key |
snapshot | array |
sortOrder | integer, null |
sourceId | integer, null |
sourceUid | string |
status | string, null – The element’s status |
stock | integer, null |
structureId | integer, null – The element’s structure ID |
supportedSites | integer[], array – The sites this element is associated with |
taxCategoryId | integer – the purchasable's tax category ID |
tempId | string, null – The element’s temporary ID (only used if the element’s URI format contains {id}) |
thumbAlt | string, null |
title | string, null – The element’s title |
titleTranslationDescription | string, null |
titleTranslationKey | string – The translation key |
totalDescendants | integer – The total number of descendants that the element has |
trashed | boolean – Whether the element has been soft-deleted. |
uiLabel | string |
uiLabelPath | string[] |
uid | string, null – The element’s UID |
updatingFromDerivative | boolean – Whether the element is being updated from a derivative element, such as a draft or revision. |
uri | string, null – The element’s URI |
uriFormat | string, null – The URI format used to generate this element’s URL |
url | string, null – The element’s full URL |
validatingRelatedElement | boolean – Whether the element is currently being validated via BaseRelationField::validateRelatedElements() |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
weight | float, null |
width | float, null |
cacheTags
​
- Type
- string[]
- Default value
null
dateCreated
​
- Type
- craft\gql\types\DateTime, null
- Default value
null
dateUpdated
​
- Type
- craft\gql\types\DateTime, null
- Default value
null
deletedWithProduct
​
- Type
- boolean
- Default value
false
Whether the variant was deleted along with its product
See also beforeDelete()
eagerLoadedElements
​
- Type
- string
- Default value
null
some eager-loaded elements on a given handle
gqlTypeName
​
- Type
- string
- Default value
null
hasUnlimitedStock
​
- Type
- boolean
- Default value
false
height
​
isDefault
​
- Type
- boolean
- Default value
false
length
​
maxQty
​
minQty
​
onSale
​
- Type
- boolean
- Default value
null
price
​
- Type
- float
- Default value
null
the base price the item will be added to the line item with
priceAsCurrency
​
- Type
- string
- Default value
null
product
​
- Type
- craft\commerce\elements\Product
- Default value
null
the product associated with this variant
productId
​
salePriceAsCurrency
​
- Type
- string
- Default value
null
sales
​
- Type
- craft\commerce\models\Sale[]
- Default value
null
sales models which are currently affecting the salePrice of this purchasable
skuAsText
​
- Type
- string
- Default value
null
sortOrder
​
stock
​
weight
​
width
​
Protected Properties ​
Property | Description |
---|---|
revisionCreatorId | integer, null – Revision creator ID to be saved |
revisionNotes | string, null – Revision notes to be saved |
Public Methods ​
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__clone() | |
__construct() | |
__get() | Returns the value of a component property. |
__isset() | Checks if a property is set. |
__set() | Sets the value of a component property. |
__toString() | Returns the string representation of the element. |
__unset() | Sets a component property to be null. |
actions() | Returns the available element actions for a given source. |
activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. |
addError() | Adds a new error to the specified attribute. |
addErrors() | Adds a list of errors. |
addModelErrors() | Adds errors from another model, with a given attribute name prefix. |
afterDelete() | Clean up purchasable table |
afterDeleteForSite() | Performs actions after an element is deleted for a site. |
afterMoveInStructure() | Performs actions after an element is moved within a structure. |
afterOrderComplete() | Updates Stock count from completed order. |
afterPropagate() | Performs actions after an element is fully saved and propagated to other sites. |
afterRestore() | |
afterSave() | Update purchasable table |
afterValidate() | This method is invoked after validation ends. |
attachBehavior() | Attaches a behavior to this component. |
attachBehaviors() | Attaches a list of behaviors to the component. |
attributeHints() | Returns the attribute hints. |
attributeLabels() | Returns the attribute labels. |
attributes() | Returns the list of attribute names. |
beforeDelete() | Performs actions before an element is deleted. |
beforeDeleteForSite() | Performs actions before an element is deleted for a site. |
beforeMoveInStructure() | 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() | |
canCreateDrafts() | Returns whether the given user is authorized to create drafts for this element. |
canDelete() | Returns whether the given user is authorized to delete this element. |
canDeleteForSite() | Returns whether the given user is authorized to delete this element for its current site. |
canDuplicate() | Returns whether the given user is authorized to duplicate this element. |
canGetProperty() | Returns a value indicating whether a property can be read. |
canSave() | Returns whether the given user is authorized to save this element in its current form. |
canSetProperty() | Returns a value indicating whether a property can be set. |
canView() | Returns whether the given user is authorized to view this element’s edit page. |
className() | Returns the fully qualified name of this class. |
clearErrors() | Removes errors for all attributes or a single attribute. |
createAnother() | Creates a new element (without saving it) based on this one. |
createCondition() | Returns an element condition for the element type. |
createValidators() | Creates validator objects based on the validation rules specified in rules(). |
currencyAttributes() | |
datetimeAttributes() | Returns the names of any attributes that should hold DateTime values. |
defaultTableAttributes() | Returns the list of table attribute keys that should be shown by default. |
detachBehavior() | Detaches a behavior from the component. |
detachBehaviors() | 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() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
exporters() | Returns the available export options for a given source. |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
fieldLayouts() | Returns all of the field layouts associated with elements from the given source. |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
find() | Creates an \craft\commerce\elements\ElementQueryInterface instance for query purpose. |
findAll() | Returns a list of elements that match the specified ID(s) or a set of element criteria parameters. |
findOne() | Returns a single element instance by a primary key or a set of element criteria parameters. |
findSource() | Returns a source definition by a given source key/path and context. |
formName() | Returns the form name that this model class should use. |
generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. |
getActiveValidators() | Returns the validators applicable to the current scenario. |
getAdditionalButtons() | Returns additional buttons that should be shown at the top of the element’s edit page. |
getAncestors() | Returns the element’s ancestors. |
getAttributeHint() | Returns the text hint for the specified attribute. |
getAttributeLabel() | Returns the text label for the specified attribute. |
getAttributeStatus() | Returns the status of a given attribute. |
getAttributes() | Returns attribute values. |
getBehavior() | Returns the named behavior object. |
getBehaviors() | Returns all behaviors attached to this component. |
getCacheTags() | Returns the cache tags that should be cleared when this element is saved. |
getCanonical() | Returns the canonical version of the element. |
getCanonicalId() | Returns the element’s canonical ID. |
getCanonicalUid() | Returns the element’s canonical UUID. |
getChildren() | Returns the element’s children. |
getContentTable() | Returns the name of the table this element’s content is stored in. |
getCpEditUrl() | Returns the element’s edit URL in the control panel. |
getCpRevisionsUrl() | Returns the element’s revisions index URL in the control panel. |
getCurrentRevision() | Returns the element’s current revision, if one exists. |
getDescendants() | Returns the element’s descendants. |
getDescription() | Returns the product title and variants title together for variable products. |
getDirtyAttributes() | Returns a list of attribute names that have changed since the element was first loaded. |
getDirtyFields() | Returns a list of custom field handles that have changed since the element was first loaded. |
getEagerLoadedElementCount() | Returns the count of eager-loaded elements for a given handle. |
getEagerLoadedElements() | Returns the eager-loaded elements for a given handle. |
getEnabledForSite() | Returns whether the element is enabled for the current site. |
getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. |
getErrors() | Returns the errors for all attributes or a single attribute. |
getFieldColumnPrefix() | Returns the field column prefix this element’s content uses. |
getFieldContext() | Returns the field context this element’s content uses. |
getFieldLayout() | Returns the field layout used by this element. |
getFieldParamNamespace() | Returns the namespace used by custom field params on the request. |
getFieldValue() | Returns the value for a given field. |
getFieldValues() | Returns the element’s normalized custom field values, indexed by their handles. |
getFirstError() | Returns the first error of the specified attribute. |
getFirstErrors() | Returns the first error of every attribute in the model. |
getGqlTypeName() | |
getHasCheckeredThumb() | Returns whether the element’s thumbnail should have a checkered background. |
getHasDescendants() | Returns whether the element has descendants. |
getHasRoundedThumb() | Returns whether the element’s thumbnail should be rounded. |
getHtmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
getId() | |
getIsAvailable() | Returns whether the purchasable is currently available for purchase. |
getIsCanonical() | Returns whether this is the canonical element. |
getIsDerivative() | Returns whether this is a derivative element, such as a draft or revision. |
getIsDraft() | Returns whether this is a draft. |
getIsFresh() | Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
getIsHomepage() | Returns whether this element represents the site homepage. |
getIsPromotable() | Returns whether this purchasable can be subject to discounts or sales. |
getIsRevision() | Returns whether this is a revision. |
getIsShippable() | |
getIsSlugTranslatable() | Returns whether the Slug field should be shown as translatable in the UI. |
getIsTaxable() | Returns whether this purchasable is exempt from taxes. |
getIsTitleTranslatable() | Returns whether the Title field should be shown as translatable in the UI. |
getIsUnpublishedDraft() | Returns whether the element is an unpublished draft. |
getIterator() | Returns an iterator for traversing the attributes in the model. |
getLanguage() | Returns the language of the element. |
getLineItemRules() | Returns any validation rules this purchasable required the line item to have. |
getLink() | Returns an anchor pre-filled with this element’s URL and title. |
getLocalized() | Returns the same element in other locales. |
getMetadata() | Returns element metadata that should be shown within the editor sidebar. |
getModifiedAttributes() | Returns the attribute names that have changed for this element. |
getModifiedFields() | Returns the field handles that have changed for this element. |
getNext() | Returns the next element relative to this one, from a given set of criteria. |
getNextSibling() | Returns the element’s next sibling. |
getOnSale() | |
getOutdatedAttributes() | Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element. |
getOutdatedFields() | Returns the field handles that have been updated on the canonical element since the last time it was merged into this element. |
getParent() | Returns the element’s parent. |
getParentId() | Returns the parent ID. |
getParentUri() | Returns the parent element’s URI, if there is one. |
getPostEditUrl() | Returns the URL that users should be redirected to after editing the element. |
getPrev() | Returns the previous element relative to this one, from a given set of criteria. |
getPrevSibling() | Returns the element’s previous sibling. |
getPreviewTargets() | Returns the additional locations that should be available for previewing the element, besides its primary URL. |
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() | Returns the reference string to this element. |
getRootOwner() | Returns the root owner element. |
getRoute() | 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() | Returns the scenario that this model is used in. |
getSearchKeywords() | |
getSerializedFieldValues() | Returns an array of the element’s serialized custom field values, indexed by their handles. |
getSerializedFieldValuesForDb() | Returns an array of the element’s serialized custom field values, indexed by their handles, for database storage. |
getShippingCategoryId() | Returns the purchasable's shipping category ID. |
getSiblings() | Returns all of the element’s siblings. |
getSidebarHtml() | Returns the HTML for any fields/info that should be shown within the editor sidebar. |
getSite() | 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. |
getSlugTranslationDescription() | Returns the description of the Slug field’s translation support. |
getSlugTranslationKey() | Returns the Slug’s translation key. |
getSnapshot() | |
getSourceId() | Returns the element’s canonical ID. |
getSourceUid() | Returns the element’s canonical UID. |
getStatus() | Returns the element’s status. |
getSupportedSites() | Returns the sites this element is associated with. |
getTableAttributeHtml() | Returns the HTML that should be shown for a given attribute in Table View. |
getTaxCategoryId() | Returns the purchasable's tax category ID. |
getThumbAlt() | Returns alt text for the element’s thumbnail. |
getThumbHtml() | Returns the HTML for the element’s thumbnail, if it has one. |
getThumbUrl() | Returns the URL to the element’s thumbnail, if it has one. |
getTitleTranslationDescription() | Returns the description of the Title field’s translation support. |
getTitleTranslationKey() | Returns the Title’s translation key. |
getTotalDescendants() | Returns the total number of descendants that the element has. |
getUiLabel() | Returns what the element should be called within the control panel. |
getUiLabelPath() | Returns any path segment labels that should be prepended to the element’s UI label. |
getUriFormat() | Returns the URI format used to generate this element’s URI. |
getUrl() | Returns the element’s full URL. |
getValidators() | Returns all the validators declared in rules(). |
gqlMutationNameByContext() | 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() | Returns whether elements have been eager-loaded with a given handle. |
hasErrors() | Returns a value indicating whether there is any validation error. |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
hasFreeShipping() | Returns whether this purchasable has free shipping. |
hasMethod() | Returns a value indicating whether a method is defined. |
hasProperty() | Returns a value indicating whether a property is defined for this component. |
hasRevisions() | Returns whether revisions should be created when this element is saved. |
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() | Returns whether elements of this type can have their own slugs and URIs. |
indexElementCount() | Returns the total number of elements that will be shown on an element index, for the given element query. |
indexHtml() | Returns the element index HTML. |
init() | Initializes the object. |
instance() | Returns static class instance, which can be used to obtain meta information. |
isAncestorOf() | Returns whether this element is an ancestor of another one. |
isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. |
isAttributeDirty() | Returns whether an attribute has changed since the element was first loaded. |
isAttributeModified() | Returns whether an attribute value has changed for this element. |
isAttributeOutdated() | Returns whether an attribute value has fallen behind the canonical element’s value. |
isAttributeRequired() | Returns a value indicating whether the attribute is required. |
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. |
isChildOf() | Returns whether this element is a direct child of another one. |
isDescendantOf() | Returns whether this element is a descendant of another one. |
isFieldDirty() | Returns whether a custom field value has changed since the element was first loaded. |
isFieldEmpty() | Returns whether a field is empty. |
isFieldModified() | Returns whether a field value has changed for this element. |
isFieldOutdated() | Returns whether a field value has fallen behind the canonical element’s value. |
isLocalized() | Returns whether elements of this type store content on a per-site basis. |
isNextSiblingOf() | Returns whether this element is the direct next sibling of another one. |
isParentOf() | Returns whether this element is a direct parent of another one. |
isPrevSiblingOf() | 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() | Returns whether this element is a sibling of another one. |
load() | Populates the model with input data. |
loadMultiple() | Populates a set of models with the data from end user. |
lowerDisplayName() | Returns the lowercase version of displayName(). |
markAsClean() | Resets the record of dirty attributes and fields. |
markAsDirty() | Marks all fields and attributes as dirty. |
mergeCanonicalChanges() | Merges changes from the canonical element into this one. |
modifyCustomSource() | Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources() |
off() | Detaches an existing event handler from this component. |
offsetExists() | Returns whether there is an element at the specified offset. |
offsetGet() | Returns the element at the specified offset. |
offsetSet() | Sets the element at the specified offset. |
offsetUnset() | Sets the element value at the specified offset to null. |
on() | Attaches an event handler to an event. |
onUnsafeAttribute() | 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. |
prepareEditScreen() | Prepares the response for the element’s Edit screen. |
refHandle() | Returns the handle that should be used to refer to this element type from reference tags. |
relatedSales() | |
rules() | Returns the validation rules for attributes. |
safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. |
scenarios() | Returns a list of scenarios and the corresponding active attributes. |
searchableAttributes() | Defines which element attributes should be searchable. |
setAttributes() | Sets the attribute values in a massive way. |
setCanonical() | Sets the canonical version of the element. |
setCanonicalId() | Sets the element’s canonical ID. |
setDirtyAttributes() | Sets the list of dirty attribute names. |
setDirtyFields() | Sets the list of dirty field handles. |
setEagerLoadedElementCount() | Sets the count of eager-loaded elements for a given handle. |
setEagerLoadedElements() | Sets some eager-loaded elements on a given handle. |
setEnabledForSite() | Sets whether the element is enabled for the current site. |
setFieldParamNamespace() | Sets the namespace used by custom field params on the request. |
setFieldValue() | Sets the value for a given field. |
setFieldValueFromRequest() | Sets the value for a given field. The value should have originated from post data. |
setFieldValues() | Sets the element’s custom field values. |
setFieldValuesFromRequest() | Sets the element’s custom field values, when the values have come from post data. |
setIsFresh() | Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
setNext() | Sets the default next element. |
setParent() | Sets the element’s parent. |
setParentId() | Sets the parent ID. |
setPrev() | Sets the default previous element. |
setProduct() | Sets the product associated with this variant. |
setRevisionCreatorId() | Sets the revision creator ID to be saved. |
setRevisionNotes() | Sets the revision notes to be saved. |
setScenario() | Sets the scenario for the model. |
setSku() | |
setUiLabel() | Defines what the element should be called within the control panel. |
setUiLabelPath() | Defines any path segment labels that should be prepended to the element’s UI label. |
sortOptions() | Returns the sort options for the element type. |
sourcePath() | Returns the source path for a given source key, step key, and context. |
sources() | Returns the source definitions that elements of this type may belong to. |
statuses() | Returns all of the possible statuses that elements of this type may have. |
tableAttributes() | Defines all of the available columns that can be shown in table views. |
toArray() | Converts the model into an array. |
trackChanges() | 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() | Triggers an event. |
updateSku() | |
updateTitle() | Updates the title based on titleFormat, or sets it to the same title as the product. |
validate() | Performs the data validation. |
validateCustomFieldAttribute() | Calls a custom validation function on a custom field. |
validateMaxQtyRange() | |
validateMinQtyRange() | |
validateMultiple() | Validates multiple models. |
__toString()
​
Returns the string representation of the element.
Returns ​
afterOrderComplete()
​
Updates Stock count from completed order.
This is called for each line item the purchasable was contained within.
Arguments ​
$order
(craft\commerce\elements\Order)$lineItem
(craft\commerce\models\LineItem)
afterRestore()
​
Throws ​
afterSave()
​
Update purchasable table
Arguments ​
$isNew
Throws ​
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(). 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()
.
Returns ​
array – 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.
Returns ​
string[] – List of attribute names.
beforeDelete()
​
Performs actions before an element is deleted.
Returns ​
boolean – Whether the element should be deleted
beforeRestore()
​
Performs actions before an element is restored.
Returns ​
boolean – Whether the element should be restored
beforeSave()
​
Arguments ​
$isNew
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.
Returns ​
boolean – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.
behaviors()
​
Throws ​
createCondition()
​
Returns an element condition for the element type.
Returns ​
craft\commerce\elements\conditions\variants\VariantCondition
currencyAttributes()
​
Returns ​
displayName()
​
Returns the display name of this class.
Returns ​
string – 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-loadedmap
– an array of element ID mappings, where each element is a sub-array withsource
andtarget
keyscriteria
(optional) – any criteria parameters that should be applied to the element query when fetching the eager-loaded elementscreateElement
(optional) - an element factory function, which will be passed the element query, the current query result data, and the first source element that the result was eager-loaded for
use craft\base\ElementInterface;
use craft\db\Query;
public static function eagerLoadingMap(array $sourceElements, string $handle)
{
switch ($handle) {
case 'author':
$bookIds = array_map(fn(ElementInterface $element) => $element->id, $sourceElements);
$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 = array_map(fn(ElementInterface $element) => $element->id, $sourceElements);
$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);
}
}
Arguments ​
$sourceElements
(self[]
) – An array of the source elements$handle
(string) – The property handle used to identify which target elements should be included in the map
Returns ​
array, null, false – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored
find()
​
Creates an \craft\commerce\elements\ElementQueryInterface
instance for query purpose.
The returned \craft\commerce\elements\ElementQueryInterface
instance can be further customized by calling methods defined in \craft\commerce\elements\ElementQueryInterface
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(): ElementQueryInterface
{
// 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(): ElementQueryInterface
{
return parent::find()->limit(50);
}
}
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.
Returns ​
getDescription()
​
Returns the product title and variants title together for variable products.
Throws ​
getFieldLayout()
​
Returns the field layout used by this element.
Returns ​
craft\models\FieldLayout, null
getGqlTypeName()
​
- Since
- 3.1
Throws ​
getIsAvailable()
​
Returns whether the purchasable is currently available for purchase.
getIsPromotable()
​
Returns whether this purchasable can be subject to discounts or sales.
getLineItemRules()
​
Returns any validation rules this purchasable required the line item to have.
Arguments ​
$lineItem
(craft\commerce\models\LineItem)
Returns ​
getPrice()
​
Cache on the purchasable table.
Returns ​
float – Decimal(14,4)
getProduct()
​
Returns the product associated with this variant.
Returns ​
craft\commerce\elements\Product, null – The product associated with this variant, or null if it isn’t known
Throws ​
- yii\base\InvalidConfigException
if the product ID is missing from the variant
getPromotionRelationSource()
​
Returns a promotion category related to this element if the category is related to the product OR the variant.
getSearchKeywords()
​
- Since
- 2.2
Arguments ​
$attribute
Throws ​
getShippingCategoryId()
​
Returns the purchasable's shipping category ID.
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()
​
Throws ​
getTaxCategoryId()
​
Returns the purchasable's tax category ID.
getUrl()
​
Returns the element’s full URL.
Returns ​
gqlScopesByContext()
​
- Since
- 3.1
Arguments ​
$context
(mixed
)
Returns ​
gqlTypeNameByContext()
​
- Since
- 3.1
Arguments ​
$context
(mixed
)
Returns ​
hasContent()
​
Returns whether elements of this type will be storing any data in the content
table (titles or custom fields).
Returns ​
boolean – Whether elements of this type will be storing any data in the content
table.
hasFreeShipping()
​
Returns whether this purchasable has free shipping.
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() to customize which statuses the elements might have.
Returns ​
boolean – Whether elements of this type have statuses.
hasStock()
​
Returns whether this variant has stock.
hasTitles()
​
Returns whether elements of this type have traditional titles.
Returns ​
boolean – 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() method will be responsible for defining which sites its content should be stored in.
Returns ​
boolean – Whether elements of this type store data on a per-site basis.
isSelectable()
​
Returns whether the component should be selectable in component Type selects.
Returns ​
boolean – Whether the component should be selectable in component Type selects.
lowerDisplayName()
​
Returns the lowercase version of displayName().
Returns ​
pluralDisplayName()
​
Returns the plural version of displayName().
Returns ​
pluralLowerDisplayName()
​
Returns the plural, lowercase version of displayName().
Returns ​
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.
Arguments ​
$lineItem
refHandle()
​
Returns the handle that should be used to refer to this element type from reference tags.
Returns ​
string, null – The reference handle, or null if the element type doesn’t support reference tags
setEagerLoadedElements()
​
Sets some eager-loaded elements on a given handle.
Arguments ​
$handle
(string) – The handle that was used to eager-load the elements$elements
(self[]
) – The eager-loaded elements
setProduct()
​
Sets the product associated with this variant.
Arguments ​
$product
(craft\commerce\elements\Product) – The product associated with this variant
Throws ​
setSku()
​
Arguments ​
updateSku()
​
Arguments ​
$product
Throws ​
updateTitle()
​
Updates the title based on titleFormat, or sets it to the same title as the product.
See also craft\elements\Entry::updateTitle()View source
Arguments ​
$product
Throws ​
validateMaxQtyRange()
​
Returns ​
void
validateMinQtyRange()
​
Returns ​
void
Protected Methods ​
Method | Description |
---|---|
ancestors() | Returns an element query for fetching the element’s ancestors. |
cacheTags() | Returns the cache tags that should be cleared when this element is saved. |
cpEditUrl() | Returns the element’s edit URL in the control panel. |
cpRevisionsUrl() | Returns the element’s revisions index URL in the control panel. |
defineActions() | Defines the available element actions for a given source. |
defineBehaviors() | Returns the behaviors to attach to this class. |
defineDefaultTableAttributes() | Returns the list of table attribute keys that should be shown by default. |
defineExporters() | Defines the available element exporters for a given source. |
defineFieldLayouts() | Defines the field layouts associated with elements for a given source. |
defineRules() | Returns the validation rules for attributes. |
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. |
descendants() | Returns an element query for fetching the element’s descendants. |
extractFieldsFor() | 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() | Extracts the root field names from nested fields. |
fieldByHandle() | Returns the field with a given handle. |
fieldLayoutFields() | Returns each of this element’s fields. |
findByCondition() | Finds Element instance(s) by the given condition. |
hasFieldLayout() | Returns whether the element has a field layout with at least one tab. |
hasNewParent() | Returns whether the element has been assigned a new parent. |
htmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
includeSetStatusAction() | Returns whether the Set Status action should be included in actions() automatically. |
indexElements() | Returns the resulting elements for an element index. |
metaFieldsHtml() | Returns the HTML for any meta fields that should be shown within the editor sidebar. |
metadata() | Returns element metadata that should be shown within the editor sidebar. |
normalizeFieldValue() | Normalizes a field’s value. |
notesFieldHtml() | Returns the notes field HTML for the sidebar. |
prepElementQueryForTableAttribute() | Prepares an element query for an element index that includes a given table attribute. |
previewTargets() | Returns the additional locations that should be available for previewing the element, besides its primary URL. |
resolveFields() | Determines which fields can be returned by toArray(). |
route() | Returns the route that should be used when the element’s URI is requested. |
searchKeywords() | Returns the search keywords for a given search attribute. |
showStatusField() | Returns whether the Status field should be shown for this element. |
slugFieldHtml() | Returns the HTML for the element’s Slug field. |
statusFieldHtml() | Returns the status field HTML for the sidebar. |
tableAttributeHtml() | Returns the HTML that should be shown for a given attribute in Table View. |
thumbSvg() | Returns the element’s thumbnail SVG contents, which should be used as a fallback when getThumbUrl() returns null . |
uiLabel() | Returns what the element should be called within the control panel. |
cacheTags()
​
Returns the cache tags that should be cleared when this element is saved.
Returns ​
string[]
defineDefaultTableAttributes()
​
Returns the list of table attribute keys that should be shown by default.
Arguments ​
$source
(string) – The selected source’s key
Returns ​
string[] – The table attributes.
defineRules()
​
Returns the validation rules for attributes.
See rules() for details about what should be returned.
Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.
Returns ​
defineSearchableAttributes()
​
Defines which element attributes should be searchable.
Returns ​
string[] – The element attributes that should be searchable
defineSortOptions()
​
Returns the sort options for the element type.
Returns ​
array – The attributes that elements can be sorted by
defineSources()
​
Defines the sources that elements of this type may belong to.
Arguments ​
$context
(string) – The context ('index', 'modal', 'field', or 'settings').
Returns ​
array – The sources.
defineTableAttributes()
​
Defines all of the available columns that can be shown in table views.
Returns ​
array – 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 tableAttributeHtml()
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() to prevent XSS attacks.
By default the following will be returned:
- If the attribute name is
link
oruri
, 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\gql\types\DateTime object, the date will be formatted with a localized date format.
- For anything else, it will output the attribute value as a string.
Arguments ​
$attribute
(string) – The attribute name.
Returns ​
string – The HTML that should be shown for a given attribute in Table View.
Throws ​
Constants ​
Constant | Description |
---|---|
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 ​
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 ​
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 ​
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 ​
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;
}
);