Purchasable

Type: Abstract Class
Namespace: craft\commerce\base
Inherits: craft\commerce\base\Purchasable » craft\base\Element (opens new window) » craft\base\Component (opens new window) » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface (opens new window), craft\base\ElementInterface (opens new window), craft\commerce\base\PurchasableInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), craft\base\ElementTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by: craft\commerce\elements\Donation, craft\commerce\elements\Variant, craft\commerce\test\mockclasses\Purchasable
Since: 2.0

Base Purchasable

# Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
ancestors (opens new window)	craft\elements\db\ElementQueryInterface (opens new window) – The element’s ancestors
archived (opens new window)	boolean (opens new window) – Whether the element is archived
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
awaitingFieldValues (opens new window)	boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheTags (opens new window)	string (opens new window)[]
canonical (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The canonical element, if one exists for the current site
canonicalId (opens new window)	integer (opens new window), null (opens new window) – The element’s canonical ID
canonicalUid (opens new window)	string (opens new window) – The element’s canonical UID
children (opens new window)	craft\elements\db\ElementQueryInterface (opens new window) – The element’s children
contentId (opens new window)	integer (opens new window), null (opens new window) – The element’s content row ID
contentTable (opens new window)	string (opens new window) – The name of the table this element’s content is stored in
cpEditUrl (opens new window)	string (opens new window), null (opens new window) – The element’s edit URL in the control panel
currentRevision (opens new window)	`static`, null (opens new window)
dateCreated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateLastMerged (opens new window)	DateTime (opens new window), null (opens new window) – The date that the canonical element was last merged into this one
dateUpdated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was last updated
descendants (opens new window)	craft\elements\db\ElementQueryInterface (opens new window) – The element’s descendants
description	string (opens new window) – the element's title or any additional descriptive information
dirtyAttributes (opens new window)	string (opens new window)[]
dirtyFields (opens new window)	string (opens new window)[]
draftId (opens new window)	integer (opens new window), null (opens new window) – The ID of the draft’s row in the `drafts` table
duplicateOf (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The element that this element is being duplicated by.
editorHtml (opens new window)	string (opens new window) – The HTML for the element’s editor HUD
enabled (opens new window)	boolean (opens new window) – Whether the element is enabled
enabledForSite (opens new window)	boolean (opens new window) – Whether the element is enabled for this site
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
fieldColumnPrefix (opens new window)	string (opens new window) – The field column prefix this element’s content uses
fieldContext (opens new window)	string (opens new window) – The field context this element’s content uses
fieldLayout (opens new window)	craft\models\FieldLayout (opens new window), null (opens new window) – The field layout used by this element
fieldLayoutId (opens new window)	integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace (opens new window)	array (opens new window) – The namespace used by custom field params on the request
fieldValues (opens new window)	array (opens new window) – The element’s normalized custom field values, indexed by their handles
firstErrors (opens new window)	array (opens new window) – The first errors.
firstSave (opens new window)	boolean (opens new window) – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
gqlTypeName (opens new window)	string (opens new window)
hardDelete (opens new window)	boolean (opens new window) – Whether the element is being hard-deleted.
hasCheckeredThumb (opens new window)	boolean (opens new window)
hasDescendants (opens new window)	boolean (opens new window) – Whether the element has descendants
hasFreshContent (opens new window)	boolean (opens new window) – Whether the element’s content is "fresh" (unsaved and without validation errors)
hasRoundedThumb (opens new window)	boolean (opens new window)
htmlAttributes (opens new window)	array (opens new window) – Any attributes that should be included in the element’s DOM representation in the control panel
id (opens new window)	integer (opens new window), null (opens new window) – The element’s ID
isAvailable	boolean (opens new window) – whether the purchasable is currently available for purchase
isCanonical (opens new window)	– Whether this is the canonical element
isDeletable (opens new window)	boolean (opens new window)
isDerivative (opens new window)	– Whether this is a derivative element, such as a draft or revision
isDraft (opens new window)	boolean (opens new window)
isEditable (opens new window)	boolean (opens new window) – Whether the current user can edit the element
isFresh (opens new window)	boolean (opens new window)
isHomepage (opens new window)	boolean (opens new window)
isNewForSite (opens new window)	boolean (opens new window) – Whether the element is being saved to the current site for the first time.
isPromotable	boolean (opens new window) – whether this purchasable can be subject to discounts or sales
isProvisionalDraft (opens new window)	boolean (opens new window) – Whether this is a provisional draft.
isRevision (opens new window)	boolean (opens new window)
isShippable	boolean (opens new window)
isTaxable	boolean (opens new window)
isTitleTranslatable (opens new window)	boolean (opens new window)
isUnpublishedDraft (opens new window)	boolean (opens new window)
isUnsavedDraft (opens new window)	boolean (opens new window)
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
language (opens new window)	string (opens new window)
level (opens new window)	integer (opens new window), null (opens new window) – The element’s level within its structure
lft (opens new window)	integer (opens new window), null (opens new window) – The element’s left position within its structure
link (opens new window)	`\Twig\Markup`, null (opens new window) – An anchor pre-filled with this element’s URL and title
localized (opens new window)	craft\elements\db\ElementQueryInterface (opens new window), `static[]`
mergingCanonicalChanges (opens new window)	boolean (opens new window) – Whether recent changes to the canonical element are being merged into this element.
metadata (opens new window)	array (opens new window) – The data, with keys representing the labels.
modifiedAttributes (opens new window)	string (opens new window)[]
modifiedFields (opens new window)	string (opens new window)[]
newSiteIds (opens new window)	integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The next element relative to this one, from a given set of criteria
nextSibling (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The element’s next sibling
onSale	boolean (opens new window)
outdatedAttributes (opens new window)	string (opens new window)[]
outdatedFields (opens new window)	string (opens new window)[]
parent (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The element’s parent
parentUri (opens new window)	string (opens new window), null (opens new window)
prev (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The previous element relative to this one, from a given set of criteria
prevSibling (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The element’s previous sibling
previewTargets (opens new window)	array (opens new window)
previewing (opens new window)	boolean (opens new window) – Whether the element is currently being previewed.
price	float (opens new window) – the base price the item will be added to the line item with
promotionRelationSource	float (opens new window) – The source for any promotion category relation
propagateAll (opens new window)	boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating (opens new window)	boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref (opens new window)	string (opens new window), null (opens new window) – The reference string to this element
resaving (opens new window)	boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a `resave` console command.
revisionId (opens new window)	integer (opens new window) – The ID of the revision’s row in the `revisions` table
rgt (opens new window)	integer (opens new window), null (opens new window) – The element’s right position within its structure
root (opens new window)	integer (opens new window), null (opens new window) – The element’s structure’s root ID
route (opens new window)	`mixed` – The route that should be used when the element’s URI is requested
salePrice	float (opens new window) – the base price the item will be added to the line item with
sales	craft\commerce\models\Sale[] – sales models which are currently affecting the salePrice of this purchasable
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
searchScore (opens new window)	integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() (opens new window) parameter was used when querying for the element
serializedFieldValues (opens new window)	array (opens new window) – Array of the element’s serialized custom field values, indexed by their handles
shippingCategoryId	integer (opens new window) – the purchasable's shipping category ID
siblings (opens new window)	craft\elements\db\ElementQueryInterface (opens new window) – All of the element’s siblings
sidebarHtml (opens new window)	string (opens new window)
site (opens new window)	craft\models\Site (opens new window) – Site the element is associated with
siteId (opens new window)	integer (opens new window), null (opens new window) – The site ID the element is associated with
siteSettingsId (opens new window)	integer (opens new window), null (opens new window) – The ID of the element’s record in the `elements_sites` table
sku	string (opens new window) – a unique code as per the commerce_purchasables table
slug (opens new window)	string (opens new window), null (opens new window) – The element’s slug
snapshot	array (opens new window)
sourceId (opens new window)	integer (opens new window), null (opens new window)
sourceUid (opens new window)	string (opens new window)
status (opens new window)	string (opens new window), null (opens new window) – The element’s status
structureId (opens new window)	integer (opens new window), null (opens new window) – The element’s structure ID
supportedSites (opens new window)	integer (opens new window)[], array (opens new window) – The sites this element is associated with
taxCategoryId	integer (opens new window) – the purchasable's tax category ID
tempId (opens new window)	string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element's URI format contains {id})
title (opens new window)	string (opens new window), null (opens new window) – The element’s title
titleTranslationDescription (opens new window)	string (opens new window), null (opens new window)
titleTranslationKey (opens new window)	string (opens new window) – The translation key
totalDescendants (opens new window)	integer (opens new window) – The total number of descendants that the element has
trashed (opens new window)	boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel (opens new window)	string (opens new window)
uid (opens new window)	string (opens new window), null (opens new window) – The element’s UID
updatingFromDerivative (opens new window)	boolean (opens new window) – Whether the element is being updated from a derivative element, such as a draft or revision.
uri (opens new window)	string (opens new window), null (opens new window) – The element’s URI
uriFormat (opens new window)	string (opens new window), null (opens new window) – The URI format used to generate this element’s URL
url (opens new window)	string (opens new window), null (opens new window) – The element’s full URL
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# `description`

Type: string (opens new window)
Default value: null

the element's title or any additional descriptive information

View source (opens new window)

# `isAvailable`

Type: boolean (opens new window)
Default value: null

whether the purchasable is currently available for purchase

View source (opens new window)

# `isPromotable`

Type: boolean (opens new window)
Default value: null

whether this purchasable can be subject to discounts or sales

View source (opens new window)

# `isShippable`

Type: boolean (opens new window)
Default value: null

View source (opens new window)

# `isTaxable`

Type: boolean (opens new window)
Default value: null

View source (opens new window)

# `onSale`

Type: boolean (opens new window)
Default value: null

View source (opens new window)

# `price`

Type: float (opens new window)
Default value: null

the base price the item will be added to the line item with

View source (opens new window)

# `promotionRelationSource`

Type: float (opens new window)
Default value: null

The source for any promotion category relation

View source (opens new window)

# `salePrice`

Type: float (opens new window)
Default value: null

the base price the item will be added to the line item with

View source (opens new window)

# `sales`

Type: craft\commerce\models\Sale[]
Default value: null

sales models which are currently affecting the salePrice of this purchasable

View source (opens new window)

# `shippingCategoryId`

Type: integer (opens new window)
Default value: null

the purchasable's shipping category ID

View source (opens new window)

# `sku`

Type: string (opens new window)
Default value: null

a unique code as per the commerce_purchasables table

View source (opens new window)

# `snapshot`

Type: array (opens new window)
Default value: null

View source (opens new window)

# `taxCategoryId`

Type: integer (opens new window)
Default value: null

the purchasable's tax category ID

View source (opens new window)

# Protected Properties

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

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set.
__set() (opens new window)	Sets the value of a component property.
__toString() (opens new window)	Returns the string representation of the element.
__unset() (opens new window)	Sets a component property to be null.
actions() (opens new window)	Returns the available element actions (opens new window) for a given source.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterDelete()	Clean up purchasable table
afterMoveInStructure() (opens new window)	Performs actions after an element is moved within a structure.
afterOrderComplete()	Runs any logic needed for this purchasable after it was on an order that was just completed (not when an order was paid, although paying an order will complete it).
afterPropagate() (opens new window)	Performs actions after an element is fully saved and propagated to other sites.
afterRestore() (opens new window)	Performs actions after an element is restored.
afterSave()	Update purchasable table
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeDelete() (opens new window)	Performs actions before an element is deleted.
beforeMoveInStructure() (opens new window)	Performs actions before an element is moved within a structure.
beforeRestore() (opens new window)	Performs actions before an element is restored.
beforeSave() (opens new window)	Performs actions before an element is saved.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() (opens new window)	Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes() (opens new window)	Returns the list of table attribute keys that should be shown by default.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
eagerLoadingMap() (opens new window)	Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exporters() (opens new window)	Returns the available export options for a given source.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fieldLayouts() (opens new window)	Returns all of the field layouts associated with elements from the given source.
fields()	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
find() (opens new window)	Creates an craft\elements\db\ElementQueryInterface (opens new window) instance for query purpose.
findAll() (opens new window)	Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne() (opens new window)	Returns a single element instance by a primary key or a set of element criteria parameters.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAncestors() (opens new window)	Returns the element’s ancestors.
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributeStatus() (opens new window)	Returns the status of a given attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getCacheTags() (opens new window)	Returns the cache tags that should be cleared when this element is saved.
getCanonical() (opens new window)	Returns the canonical version of the element.
getCanonicalId() (opens new window)	Returns the element’s canonical ID.
getCanonicalUid() (opens new window)	Returns the element’s canonical UUID.
getChildren() (opens new window)	Returns the element’s children.
getContentTable() (opens new window)	Returns the name of the table this element’s content is stored in.
getCpEditUrl() (opens new window)	Returns the element’s edit URL in the control panel.
getCurrentRevision() (opens new window)	Returns the element’s current revision, if one exists.
getDescendants() (opens new window)	Returns the element’s descendants.
getDescription()	Returns your element's title or any additional descriptive information.
getDirtyAttributes() (opens new window)	Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() (opens new window)	Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() (opens new window)	Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() (opens new window)	Returns the eager-loaded elements for a given handle.
getEditorHtml() (opens new window)	Returns the HTML for the element’s editor slideout.
getEnabledForSite() (opens new window)	Returns whether the element is enabled for the current site.
getError() (opens new window)	Returns the first error of the specified attribute.
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix() (opens new window)	Returns the field column prefix this element’s content uses.
getFieldContext() (opens new window)	Returns the field context this element’s content uses.
getFieldLayout() (opens new window)	Returns the field layout used by this element.
getFieldParamNamespace() (opens new window)	Returns the namespace used by custom field params on the request.
getFieldStatus() (opens new window)	Returns the status of a given field.
getFieldValue() (opens new window)	Returns the value for a given field.
getFieldValues() (opens new window)	Returns the element’s normalized custom field values, indexed by their handles.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getGqlTypeName() (opens new window)	Returns the GraphQL type name for this element type.
getHasCheckeredThumb() (opens new window)	Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants() (opens new window)	Returns whether the element has descendants.
getHasFreshContent() (opens new window)	Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getHasRoundedThumb() (opens new window)	Returns whether the element’s thumbnail should be rounded.
getHtmlAttributes() (opens new window)	Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() (opens new window)
getIsAvailable()	Returns whether the purchasable is currently available for purchase.
getIsCanonical() (opens new window)	Returns whether this is the canonical element.
getIsDeletable() (opens new window)	Returns whether the current user can delete the element.
getIsDerivative() (opens new window)	Returns whether this is a derivative element, such as a draft or revision.
getIsDraft() (opens new window)	Returns whether this is a draft.
getIsEditable() (opens new window)	Returns whether the current user can edit the element.
getIsFresh() (opens new window)	Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage() (opens new window)	Returns whether this element represents the site homepage.
getIsPromotable()	Returns whether this purchasable can be subject to discounts or sales.
getIsProvisionalDraft() (opens new window)	Returns whether this is a provisional draft.
getIsRevision() (opens new window)	Returns whether this is a revision.
getIsShippable()
getIsTaxable()	Returns whether this purchasable is exempt from taxes.
getIsTitleTranslatable() (opens new window)	Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft() (opens new window)	Returns whether the element is an unpublished draft.
getIsUnsavedDraft() (opens new window)	Returns whether the element is an unpublished draft.
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getLanguage() (opens new window)	Returns the language of the element.
getLineItemRules()	Returns any validation rules this purchasable required the line item to have.
getLink() (opens new window)	Returns an anchor pre-filled with this element’s URL and title.
getLocalized() (opens new window)	Returns the same element in other locales.
getMetadata() (opens new window)	Returns element metadata that can be shown on its edit page or within element editor slideouts.
getModifiedAttributes() (opens new window)	Returns the attribute names that have changed for this element.
getModifiedFields() (opens new window)	Returns the field handles that have changed for this element.
getNext() (opens new window)	Returns the next element relative to this one, from a given set of criteria.
getNextSibling() (opens new window)	Returns the element’s next sibling.
getOnSale()
getOutdatedAttributes() (opens new window)	Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields() (opens new window)	Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent() (opens new window)	Returns the element’s parent.
getParentUri() (opens new window)	Returns the parent element’s URI, if there is one.
getPrev() (opens new window)	Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() (opens new window)	Returns the element’s previous sibling.
getPreviewTargets() (opens new window)	Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
getPrice()	Returns the base price the item will be added to the line item with.
getPromotionRelationSource()	Returns the source param used for knowing if a promotion category is related to this purchasable.
getRef() (opens new window)	Returns the reference string to this element.
getRoute() (opens new window)	Returns the route that should be used when the element’s URI is requested.
getSalePrice()	Returns the base price the item will be added to the line item with.
getSales()	Returns an array of sales models which are currently affecting the salePrice of this purchasable.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSearchKeywords() (opens new window)	Returns the search keywords for a given search attribute.
getSerializedFieldValues() (opens new window)	Returns an array of the element’s serialized custom field values, indexed by their handles.
getShippingCategoryId()	Returns the purchasable's shipping category ID.
getSiblings() (opens new window)	Returns all of the element’s siblings.
getSidebarHtml() (opens new window)	Returns the HTML for any fields/info that should be shown within the sidebar of element editor slideouts.
getSite() (opens new window)	Returns the site the element is associated with.
getSku()	Returns a unique code. Unique as per the commerce_purchasables table.
getSnapshot()	Returns an array of data that is serializable to json for storing a line item at time of adding to the cart or order.
getSourceId() (opens new window)	Returns the element’s canonical ID.
getSourceUid() (opens new window)	Returns the element’s canonical UID.
getStatus() (opens new window)	Returns the element’s status.
getSupportedSites() (opens new window)	Returns the sites this element is associated with.
getTableAttributeHtml() (opens new window)	Returns the HTML that should be shown for a given attribute in Table View.
getTaxCategoryId()	Returns the purchasable's tax category ID.
getThumbUrl() (opens new window)	Returns the URL to the element’s thumbnail, if there is one.
getTitleTranslationDescription() (opens new window)	Returns the description of the Title field’s translation support.
getTitleTranslationKey() (opens new window)	Returns the Title’s translation key.
getTotalDescendants() (opens new window)	Returns the total number of descendants that the element has.
getUiLabel() (opens new window)	Returns what the element should be called within the control panel.
getUriFormat() (opens new window)	Returns the URI format used to generate this element’s URI.
getUrl() (opens new window)	Returns the element’s full URL.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
gqlMutationNameByContext() (opens new window)	Returns the GraphQL mutation name by an element's context.
gqlScopesByContext() (opens new window)	Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext() (opens new window)	Returns the GraphQL type name by an element's context.
hasContent() (opens new window)	Returns whether elements of this type will be storing any data in the `content` table (titles or custom fields).
hasEagerLoadedElements() (opens new window)	Returns whether elements have been eager-loaded with a given handle.
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasFreeShipping()	Returns whether this purchasable has free shipping.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
hasStatuses() (opens new window)	Returns whether elements of this type have statuses.
hasTitles() (opens new window)	Returns whether elements of this type have traditional titles.
hasUris() (opens new window)	Returns whether elements of this type can have their own slugs and URIs.
indexHtml() (opens new window)	Returns the element index HTML.
init() (opens new window)	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAncestorOf() (opens new window)	Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty() (opens new window)	Returns whether an attribute has changed since the element was first loaded.
isAttributeModified() (opens new window)	Returns whether an attribute value has changed for this element.
isAttributeOutdated() (opens new window)	Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf() (opens new window)	Returns whether this element is a direct child of another one.
isDescendantOf() (opens new window)	Returns whether this element is a descendant of another one.
isFieldDirty() (opens new window)	Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty() (opens new window)	Returns whether a field is empty.
isFieldModified() (opens new window)	Returns whether a field value has changed for this element.
isFieldOutdated() (opens new window)	Returns whether a field value has fallen behind the canonical element’s value.
isLocalized() (opens new window)	Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf() (opens new window)	Returns whether this element is the direct next sibling of another one.
isParentOf() (opens new window)	Returns whether this element is a direct parent of another one.
isPrevSiblingOf() (opens new window)	Returns whether this element is the direct previous sibling of another one.
isSelectable() (opens new window)	Returns whether the component should be selectable in component Type selects.
isSiblingOf() (opens new window)	Returns whether this element is a sibling of another one.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
lowerDisplayName() (opens new window)	Returns the lowercase version of displayName() (opens new window).
markAsClean() (opens new window)	Resets the record of dirty attributes and fields.
markAsDirty() (opens new window)	Marks all fields and attributes as dirty.
mergeCanonicalChanges() (opens new window)	Merges changes from the canonical element into this one.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName() (opens new window)	Returns the plural version of displayName() (opens new window).
pluralLowerDisplayName() (opens new window)	Returns the plural, lowercase version of displayName() (opens new window).
populateLineItem()	Populates the line item when this purchasable is found on it. Called when Purchasable is added to the cart and when the cart recalculates.
refHandle() (opens new window)	Returns the handle that should be used to refer to this element type from reference tags.
relatedSales()
rules() (opens new window)	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
searchableAttributes() (opens new window)	Defines which element attributes should be searchable.
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setCanonical() (opens new window)	Sets the canonical version of the element.
setCanonicalId() (opens new window)	Sets the element’s canonical ID.
setDirtyAttributes() (opens new window)	Sets the list of dirty attribute names.
setEagerLoadedElementCount() (opens new window)	Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() (opens new window)	Sets some eager-loaded elements on a given handle.
setEnabledForSite() (opens new window)	Sets whether the element is enabled for the current site.
setFieldParamNamespace() (opens new window)	Sets the namespace used by custom field params on the request.
setFieldValue() (opens new window)	Sets the value for a given field.
setFieldValues() (opens new window)	Sets the element’s custom field values.
setFieldValuesFromRequest() (opens new window)	Sets the element’s custom field values, when the values have come from post data.
setIsFresh() (opens new window)	Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setNext() (opens new window)	Sets the default next element.
setParent() (opens new window)	Sets the element’s parent.
setPrev() (opens new window)	Sets the default previous element.
setRevisionCreatorId() (opens new window)	Sets the revision creator ID to be saved.
setRevisionNotes() (opens new window)	Sets the revision notes to be saved.
setScenario() (opens new window)	Sets the scenario for the model.
setUiLabel() (opens new window)	Defines what the element should be called within the control panel.
sortOptions() (opens new window)	Returns the sort options for the element type.
sources() (opens new window)	Returns the source definitions that elements of this type may belong to.
statuses() (opens new window)	Returns all of the possible statuses that elements of this type may have.
tableAttributes() (opens new window)	Defines all of the available columns that can be shown in table views.
toArray() (opens new window)	Converts the model into an array.
trackChanges() (opens new window)	Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateCustomFieldAttribute() (opens new window)	Calls a custom validation function on a custom field.
validateCustomFieldContentSize() (opens new window)	Validates that the content size is going to fit within the field’s database column.
validateMultiple() (opens new window)	Validates multiple models.

# `afterDelete()`

Clean up purchasable table

View source (opens new window)

# `afterOrderComplete()`

Runs any logic needed for this purchasable after it was on an order that was just completed (not when an order was paid, although paying an order will complete it).

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

View source (opens new window)

Arguments

$order (craft\commerce\elements\Order)
$lineItem (craft\commerce\models\LineItem)

Returns

void

# `afterSave()`

Update purchasable table

View source (opens new window)

Arguments

$isNew (boolean (opens new window))

# `attributes()`

Returns the list of attribute names.

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

View source (opens new window)

Returns

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

# `displayName()`

Returns the display name of this class.

View source (opens new window)

Returns

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

# `extraFields()`

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

# `fields()`

Since: 3.2.9

Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.

A field is a named element in the returned array by toArray() (opens new window).

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

email: the field name is the same as the property name email;
firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.

return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function () {
        return $this->first_name . ' ' . $this->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

Returns

boolean (opens new window)

# `getLineItemRules()`

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

View source (opens new window)

Arguments

$lineItem (craft\commerce\models\LineItem)

Returns

array (opens new window)

# `getOnSale()`

View source (opens new window)

Returns

boolean (opens new window)

# `getPromotionRelationSource()`

Returns the source param used for knowing if a promotion category is related to this purchasable.

View source (opens new window)

Returns

mixed

# `getSalePrice()`

Returns the base price the item will be added to the line item with.

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

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

View source (opens new window)

Arguments

$lineItem (craft\commerce\models\LineItem)

# `relatedSales()`

View source (opens new window)

Returns

craft\commerce\models\Sale[] – The sales that relate directly to this purchasable

# Protected Methods

Method	Description
cpEditUrl() (opens new window)	Returns the element’s edit URL in the control panel.
defineActions() (opens new window)	Defines the available element actions for a given source.
defineDefaultTableAttributes() (opens new window)	Returns the list of table attribute keys that should be shown by default.
defineExporters() (opens new window)	Defines the available element exporters for a given source.
defineFieldLayouts() (opens new window)	Defines the field layouts associated with elements for a given source.
defineRules()	Returns the validation rules for attributes.
defineSearchableAttributes() (opens new window)	Defines which element attributes should be searchable.
defineSortOptions() (opens new window)	Returns the sort options for the element type.
defineSources() (opens new window)	Defines the sources that elements of this type may belong to.
defineTableAttributes() (opens new window)	Defines all of the available columns that can be shown in table views.
extractFieldsFor() (opens new window)	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window)	Extracts the root field names from nested fields.
fieldByHandle() (opens new window)	Returns the field with a given handle.
fieldLayoutFields() (opens new window)	Returns each of this element’s fields.
findByCondition() (opens new window)	Finds Element instance(s) by the given condition.
hasFieldLayout() (opens new window)	Returns whether the element has a field layout with at least one tab.
htmlAttributes() (opens new window)	Returns any attributes that should be included in the element’s DOM representation in the control panel.
isDeletable() (opens new window)	Returns whether the current user can delete the element.
isEditable() (opens new window)	Returns whether the current user can edit the element.
metaFieldsHtml() (opens new window)	Returns the HTML for any meta fields that should be shown within the sidebar of element editor slideouts. Or if the element doesn’t have a field layout, they’ll be shown in the main body of the slideout.
metadata() (opens new window)	Returns element metadata that can be shown on its edit page or within element editor slideouts.
normalizeFieldValue() (opens new window)	Normalizes a field’s value.
prepElementQueryForTableAttribute() (opens new window)	Preps the element criteria for a given table attribute
previewTargets() (opens new window)	Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).
route() (opens new window)	Returns the route that should be used when the element’s URI is requested.
searchKeywords() (opens new window)	Returns the search keywords for a given search attribute.
slugFieldHtml() (opens new window)	Returns the HTML for the element’s Slug field.
tableAttributeHtml() (opens new window)	Returns the HTML that should be shown for a given attribute in Table View.
uiLabel() (opens new window)	Returns what the element should be called within the control panel.

# `defineRules()`

Returns the validation rules for attributes.

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

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

View source (opens new window)

Returns

array (opens new window)

# 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`

← PlanTrait PurchasableInterface →

Purchasable

# Public Properties

# description

# isAvailable

# isPromotable

# isShippable

# isTaxable

# onSale

# price

# promotionRelationSource

# salePrice

# sales

# shippingCategoryId

# sku

# snapshot

# taxCategoryId

# Protected Properties

# Public Methods

# afterDelete()

# afterOrderComplete()

Arguments

Returns

# afterSave()

Arguments

# attributes()

Returns

# displayName()

Returns

# extraFields()

Returns

# fields()

Returns

# getDescription()

Returns

# getIsAvailable()

Returns

# getIsPromotable()

Returns

# getIsShippable()

Returns

# getIsTaxable()

Returns

# getLineItemRules()

Arguments

Returns

# getOnSale()

Returns

# getPromotionRelationSource()

Returns

# getSalePrice()

Returns

# getSales()

Returns

# getShippingCategoryId()

Returns

# getSnapshot()

Returns

# getTaxCategoryId()

Returns

# hasFreeShipping()

Returns

# populateLineItem()

Arguments

# relatedSales()

Returns

# Protected Methods

# defineRules()

Returns

# Constants

# `description`

# `isAvailable`

# `isPromotable`

# `isShippable`

# `isTaxable`

# `onSale`

# `price`

# `promotionRelationSource`

# `salePrice`

# `sales`

# `shippingCategoryId`

# `sku`

# `snapshot`

# `taxCategoryId`

# `afterDelete()`

# `afterOrderComplete()`

# `afterSave()`

# `attributes()`

# `displayName()`

# `extraFields()`

# `fields()`

# `getDescription()`

# `getIsAvailable()`

# `getIsPromotable()`

# `getIsShippable()`

# `getIsTaxable()`

# `getLineItemRules()`

# `getOnSale()`

# `getPromotionRelationSource()`

# `getSalePrice()`

# `getSales()`

# `getShippingCategoryId()`

# `getSnapshot()`

# `getTaxCategoryId()`

# `hasFreeShipping()`

# `populateLineItem()`

# `relatedSales()`

# `defineRules()`