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\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. |
ancestors | craft\elements\db\ElementQueryInterface, craft\base\ElementInterface |
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[] |
children | craft\elements\db\ElementQueryInterface, craft\base\ElementInterface |
contentId | integer, null – The element’s content row ID |
contentTable | string |
cpEditUrl | string, null |
currentRevision | craft\base\ElementInterface, null |
dateCreated | DateTime, null – The date that the element was created |
dateDeleted | DateTime, null – The date that the element was trashed |
dateUpdated | DateTime, null – The date that the element was last updated |
deletedWithProduct | boolean – Whether the variant was deleted along with its product |
descendants | craft\elements\db\ElementQueryInterface, craft\base\ElementInterface |
description | string |
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 being duplicated by. |
editorHtml | string – The HTML for the editor HUD |
enabled | boolean – Whether the element is enabled |
enabledForSite | boolean, null – Whether the element is enabled for the given site. |
errors | array – Errors for all attributes or the specified attribute. |
fieldColumnPrefix | string |
fieldContext | string |
fieldLayout | craft\models\FieldLayout, null |
fieldLayoutId | integer, null – The element’s field layout ID |
fieldParamNamespace | string, null – The field param namespace |
fieldValues | array – The field values (handle => value) |
fieldValuesFromRequest | string – The field param namespace |
firstErrors | array – The first errors. |
gqlTypeName | string |
hardDelete | boolean – Whether the element is being hard-deleted. |
hasCheckeredThumb | boolean |
hasDescendants | boolean |
hasFreshContent | boolean – Whether the element’s content is fresh |
hasRoundedThumb | boolean |
hasUnlimitedStock | boolean |
height | integer |
id | integer, null – The element’s ID |
isAvailable | boolean |
isDefault | boolean |
isDeletable | boolean |
isDraft | boolean |
isEditable | boolean |
isHomepage | boolean |
isPromotable | boolean |
isRevision | boolean |
isShippable | boolean |
isTaxable | boolean |
isTitleTranslatable | boolean |
isUnsavedDraft | boolean |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
language | string |
length | integer |
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 |
localized | craft\elements\db\ElementQueryInterface, craft\base\ElementInterface |
maxQty | integer |
minQty | integer |
newSiteIds | integer[] – The site IDs that the element was just propagated to for the first time. |
next | craft\base\ElementInterface, null |
nextSibling | craft\base\ElementInterface, null |
onSale | boolean |
parent | craft\base\ElementInterface, null |
prev | craft\base\ElementInterface, null |
prevSibling | craft\base\ElementInterface, null |
previewTargets | array |
previewing | boolean – Whether the element is currently being previewed. |
price | |
product | craft\commerce\elements\Product, null – The product associated with this variant, or null if it isn’t known |
productId | integer |
promotionRelationSource | array |
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 |
resaving | boolean – Whether the element is being resaved by a ResaveElement job or a resave console command. |
revisionId | integer – 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 |
route | mixed – The route that the request should use, or null if no special action should be taken |
salePrice | float – Decimal(14,4) |
sales | craft\commerce\models\Sale[], null |
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 |
shippingCategoryId | integer |
siblings | craft\elements\db\ElementQueryInterface, craft\base\ElementInterface |
site | craft\models\Site |
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 |
skuAsText | string |
slug | string, null – The element’s slug |
snapshot | array |
sortOrder | integer |
sourceId | integer, null |
sourceUid | string |
status | string, null |
stock | integer |
structureId | integer, null – The element’s structure ID |
supportedSites | integer[], array |
taxCategoryId | integer |
tempId | string, null – The element’s temporary ID (only used if the element's URI format contains {id}) |
title | string, null – The element’s title |
titleTranslationDescription | string, null |
titleTranslationKey | string – The translation key |
totalDescendants | integer |
trashed | boolean – Whether the element has been soft-deleted. |
uiLabel | string |
uid | string, null – The element’s UID |
uri | string, null – The element’s URI |
uriFormat | string, null |
url | string, null |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
weight | integer |
width | integer |
# cpEditUrl
# deletedWithProduct
- Type
- boolean
- Default value
false
Whether the variant was deleted along with its product
See also beforeDelete()
# description
- Type
- string
- Default value
null
- Access
- Read-only
# fieldLayout
- Type
- craft\models\FieldLayout, null
- Default value
null
- Access
- Read-only
# gqlTypeName
- Type
- string
- Default value
null
- Access
- Read-only
- Since
- 3.1
# hasUnlimitedStock
- Type
- boolean
- Default value
null
# height
- Type
- integer
- Default value
null
# isAvailable
- Type
- boolean
- Default value
null
- Access
- Read-only
# isDefault
- Type
- boolean
- Default value
null
# isEditable
- Type
- boolean
- Default value
null
- Access
- Read-only
# isPromotable
- Type
- boolean
- Default value
null
- Access
- Read-only
# length
- Type
- integer
- Default value
null
# maxQty
- Type
- integer
- Default value
null
# minQty
- Type
- integer
- Default value
null
# price
- Default value
null
# product
- Type
- craft\commerce\elements\Product, null
- Default value
null
The product associated with this variant, or null if it isn’t known
# productId
- Type
- integer
- Default value
null
# promotionRelationSource
- Type
- array
- Default value
null
- Access
- Read-only
# shippingCategoryId
- Type
- integer
- Default value
null
- Access
- Read-only
# sku
- Type
- string
- Default value
null
- Access
- Read-only
# skuAsText
- Type
- string
- Default value
null
- Access
- Read-only
# snapshot
- Type
- array
- Default value
null
- Access
- Read-only
# sortOrder
- Type
- integer
- Default value
null
# stock
- Type
- integer
- Default value
null
# taxCategoryId
- Type
- integer
- Default value
null
- Access
- Read-only
# url
# weight
- Type
- integer
- Default value
null
# width
- Type
- integer
- Default value
null
# Protected Properties
Property | Description |
---|---|
revisionCreatorId | string, 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() | Constructor. |
__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 |
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. |
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() | |
canGetProperty() | Returns a value indicating whether a property can be read. |
canSetProperty() | Returns a value indicating whether a property can be set. |
className() | Returns the fully qualified name of this class. |
clearErrors() | Removes errors for all attributes or a single attribute. |
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. |
defineRules() | Returns the validation rules for attributes. |
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() | |
find() | Creates an craft\elements\db\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. |
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. |
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. |
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. |
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. |
getEditorHtml() | Returns the HTML for the element’s editor HUD. |
getEnabledForSite() | Returns whether the element is enabled for the current site. |
getError() | Returns the first error of the specified attribute. |
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. |
getFieldStatus() | Returns the status of a given field. |
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. |
getHasFreshContent() | Returns whether the element’s content is "fresh" (unsaved and without validation errors). |
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() | Returns the element’s ID. |
getIsAvailable() | Returns whether the purchasable is currently available for purchase. |
getIsDeletable() | Returns whether the current user can delete the element. |
getIsDraft() | Returns whether this is a draft. |
getIsEditable() | |
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() | |
getIsTaxable() | Returns whether this purchasable is exempt from taxes. |
getIsTitleTranslatable() | Returns whether the Title field should be shown as translatable in the UI. |
getIsUnsavedDraft() | Returns whether the element is an unsaved 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. |
getNext() | Returns the next element relative to this one, from a given set of criteria. |
getNextSibling() | Returns the element’s next sibling. |
getOnSale() | |
getParent() | Returns the element’s parent. |
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. |
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. |
getShippingCategoryId() | Returns the purchasable's shipping category ID. |
getSiblings() | Returns all of the element’s siblings. |
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. |
getSnapshot() | |
getSourceId() | Returns the element’s ID, or if it’s a draft/revision, its source element’s ID. |
getSourceUid() | Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID. |
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. |
getThumbUrl() | Returns the URL to the element’s thumbnail, if there is 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. |
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. |
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. |
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. |
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. |
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. |
off() | Detaches an existing event handler from this component. |
offsetExists() | Treats custom fields as array offsets. |
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. |
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. |
setDirtyAttributes() | Sets the list of dirty attribute names. |
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. |
setFieldValues() | Sets the element’s custom field values. |
setFieldValuesFromRequest() | Sets the element’s custom field values, when the values have come from post data. |
setNext() | Sets the default next element. |
setParent() | Sets the element’s parent. |
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() | |
sortOptions() | Returns the sort options for the element type. |
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. |
validateCustomFieldContentSize() | Validates that the content size is going to fit within the field’s database column. |
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)
Returns
void
# afterRestore()
Throws
# afterSave()
Update purchasable table
Arguments
$isNew
(boolean)
# 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
array – 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
(boolean)
Returns
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()
Returns
# currencyAttributes()
Returns
# 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
# 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
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);
}
}
Arguments
$sourceElements
(craft\base\ElementInterface) – 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, false, null – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored
# fields()
Returns
# find()
Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling
methods defined in craft\elements\db\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()
{
// 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);
}
}
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.
Returns
Throws
# getFieldLayout()
Returns the field layout used by this element.
Returns
craft\models\FieldLayout, null
# getGqlTypeName()
- Since
- 3.1
Returns
Throws
# getIsAvailable()
Returns whether the purchasable is currently available for purchase.
Returns
# getIsEditable()
Returns
Throws
# getIsPromotable()
Returns whether this purchasable can be subject to discounts or sales.
Returns
# 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.
Returns
# getSearchKeywords()
- Since
- 2.2
Arguments
$attribute
(string)
Returns
Throws
# getShippingCategoryId()
Returns the purchasable's shipping category ID.
Returns
# getSku()
Returns a unique code. Unique as per the commerce_purchasables table.
Returns
# getSkuAsText()
Returns the SKU as text but returns a blank string if it’s a temp SKU.
Returns
# getSnapshot()
Returns
Throws
# getTaxCategoryId()
Returns the purchasable's tax category ID.
Returns
# 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.
Returns
# 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.
Returns
# 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
(craft\commerce\models\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
(craft\base\ElementInterface) – The eager-loaded elements
# setProduct()
Sets the product associated with this variant.
Arguments
$product
(craft\commerce\elements\Product) – The product associated with this variant
# setSku()
Arguments
Returns
void
# updateSku()
Arguments
$product
(craft\commerce\elements\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
(craft\commerce\elements\Product)
Throws
# Protected Methods
Method | Description |
---|---|
defineActions() | Defines the available element actions for a given source. |
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. |
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() | 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. |
htmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
normalizeFieldValue() | Normalizes a field’s value. |
prepElementQueryForTableAttribute() | Preps the element criteria for 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. |
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.
Arguments
$source
(string) – The selected source’s key
Returns
string[] – The table attributes.
# 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
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
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() 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\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.
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_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;
}
);