Purchasable <a class="header-anchor" href="#purchasable" aria-label="Permalink to &quot;Purchasable&quot;">​

`availableForPurchase`

Type: boolean
Default value: true
Since: 5.0.0

`basePrice`

Type: float, null
Default value: null

`basePriceAsCurrency`

Type: string
Default value: null

the base price

`basePromotionalPrice`

Type: float, null
Default value: null

`basePromotionalPriceAsCurrency`

Type: string
Default value: null

the base promotional price

`description`

Type: string
Default value: null

the element's title or any additional descriptive information

`freeShipping`

Type: boolean
Default value: false
Since: 5.0.0

`hasUnlimitedStock`

Default value: null

`height`

Type: float, null
Default value: null
Since: 5.0.0

`inventoryItem`

Type: craft\commerce\models\InventoryItem
Default value: null
Access: Read-only

`inventoryItemId`

Type: integer
Default value: null
Since: 5.0.0

`inventoryLevels`

Type: \Illuminate\Support\Collection<\craft\commerce\models\InventoryLevel>
Default value: null
Access: Read-only
Since: 5.0.0

`inventoryTracked`

Type: boolean
Default value: false
Since: 5.0.0

`isAvailable`

Type: boolean
Default value: null

whether the purchasable is currently available for purchase

`isPromotable`

Type: boolean
Default value: null

whether this purchasable can be subject to discounts or sales

`isShippable`

Type: boolean
Default value: null

`isTaxable`

Type: boolean
Default value: null

`length`

Type: float, null
Default value: null
Since: 5.0.0

`maxQty`

Type: integer, null
Default value: null
Since: 5.0.0

`minQty`

Type: integer, null
Default value: null
Since: 5.0.0

`onPromotion`

Type: boolean
Default value: null

whether this purchasable is currently on sale at a promotional price

`onSale`

Type: boolean
Default value: null
Access: Read-only

`price`

Type: float
Default value: null

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

`priceAsCurrency`

Type: string
Default value: null

the price

`promotable`

Type: boolean
Default value: false
Since: 5.0.0

`promotionRelationSource`

Type: float
Default value: null

The source for any promotion category relation

`promotionalPrice`

Type: float, null
Default value: null
Since: 5.0.0

`salePrice`

Type: float
Default value: null

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

`salePriceAsCurrency`

Type: string
Default value: null

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

`sales`

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

sales models which are currently affecting the price of this purchasable

`shippingCategory`

Default value: null
Access: Read-only

`shippingCategoryId`

Type: integer
Default value: null

the purchasable's shipping category ID

`sku`

Type: string
Default value: null

a unique code as per the commerce_purchasables table

`skuAsText`

Default value: null
Access: Read-only

`snapshot`

Type: array
Default value: null

`stock`

Type: integer
Default value: null
Access: Read-only
Since: 5.0.0

`store`

Type: craft\commerce\models\Store
Default value: null

`storeId`

Type: integer
Default value: null

`taxCategory`

Default value: null
Access: Read-only

`taxCategoryId`

Type: integer
Default value: null

the purchasable's tax category ID

`weight`

Type: float, null
Default value: null
Since: 5.0.0

`width`

Type: float, null
Default value: null
Since: 5.0.0

Protected Properties

Property	Description
revisionCreatorId	integer, null – Revision creator ID to be saved
revisionNotes	string, null – Revision notes to be saved

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()
__construct()
__get()	Returns the value of a component property.
__isset()	Checks if a property is set.
__set()	Sets the value of a component property.
__toString()	Returns the string representation of the element.
__unset()	Sets a component property to be null.
actions()	Returns the available bulk 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.
addInvalidNestedElementIds()	Registers invalid nested element IDs with the element, so an `error` class can be added on their cards.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterDelete()	Clean up purchasable table
afterDeleteForSite()	Performs actions after an element is deleted for a site.
afterMoveInStructure()	Performs actions after an element is moved within a structure.
afterOrderComplete()	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()	Performs actions after an element is fully saved and propagated to other sites.
afterRestore()	Performs actions after an element is restored.
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.
attributePreviewHtml()	Return HTML for the attribute in the card preview.
attributes()	Returns the list of attribute names.
beforeDelete()	Performs actions before an element is deleted.
beforeDeleteForSite()	Performs actions before an element is deleted for a site.
beforeMoveInStructure()	Performs actions before an element is moved within a structure.
beforeRestore()	Performs actions before an element is restored.
beforeSave()	Performs actions before an element is saved.
beforeValidate()	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canCreateDrafts()	Returns whether the given user is authorized to create drafts for this element.
canDelete()	Returns whether the given user is authorized to delete this element.
canDeleteForSite()	Returns whether the given user is authorized to delete this element for its current site.
canDuplicate()	Returns whether the given user is authorized to duplicate this element.
canDuplicateAsDraft()	Returns whether the given user is authorized to duplicate this element as an unpublished draft.
canGetProperty()	Returns a value indicating whether a property can be read.
canSave()	Returns whether the given user is authorized to save this element in its current form.
canSetProperty()	Returns a value indicating whether a property can be set.
canView()	Returns whether the given user is authorized to view this element’s edit page.
cardAttributes()	Defines all the available attributes that can be shown in card views.
className()	Returns the fully qualified name of this class.
clearErrors()	Removes errors for all attributes or a single attribute.
createAnother()	Creates a new element (without saving it) based on this one.
createCondition()	Returns an element condition for the element type.
createValidators()	Creates validator objects based on the validation rules specified in rules().
currencyAttributes()
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
defaultCardAttributes()	Returns the list of card attribute keys that should be shown by default, if the field layout hasn't been customised.
defaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
eagerLoadingMap()	Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
exporters()	Returns the available export options for a given source.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fieldLayouts()	Returns all the field layouts associated with elements from the given source.
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()	Creates an craft\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.
findSource()	Returns a source definition by a given source key/path and context.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
get()
getActionMenuItems()
getActiveValidators()	Returns the validators applicable to the current scenario.
getAdditionalButtons()	Returns additional buttons that should be shown at the top of the element’s edit page.
getAncestors()	Returns the element’s ancestors.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeHtml()	Returns the HTML that should be shown for a given attribute in table and card views.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributeStatus()	Returns the status of a given attribute.
getAttributes()	Returns attribute values.
getBasePrice()
getBasePromotionalPrice()
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCacheTags()	Returns the cache tags that should be cleared when this element is saved.
getCanonical()	Returns the canonical version of the element.
getCanonicalId()	Returns the element’s canonical ID.
getCanonicalUid()	Returns the element’s canonical UUID.
getCardBodyHtml()	Returns the body HTML for element cards.
getChildren()	Returns the element’s children.
getChipLabelHtml()	Returns the label HTML for element chips.
getCpEditUrl()
getCpRevisionsUrl()	Returns the element’s revisions index URL in the control panel.
getCrumbs()	Returns the breadcrumbs that lead up to the element.
getCurrentRevision()	Returns the element’s current revision, if one exists.
getDescendants()	Returns the element’s descendants.
getDescription()	Returns your element's title or any additional descriptive information.
getDirtyAttributes()	Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields()	Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount()	Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements()	Returns the eager-loaded elements for a given handle.
getEnabledForSite()	Returns whether the element is enabled for the current site.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFieldContext()	Returns the field context this element’s content uses.
getFieldLayout()	Returns the field layout used by this element.
getFieldParamNamespace()	Returns the namespace used by custom field params on the request.
getFieldValue()	Returns the value for a given field.
getFieldValues()	Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getGqlTypeName()	Returns the GraphQL type name for this element type.
getHasDescendants()	Returns whether the element has descendants.
getHasUnlimitedStock()
getHtmlAttributes()	Returns any attributes that should be included in the element’s chips and cards.
getId()
getInlineAttributeInputHtml()	Returns the HTML that should be shown for a given attribute's inline editing input.
getInvalidNestedElementIds()	Returns the element’s invalid nested element IDs.
getInventoryItem()
getInventoryLevels()	Returns the total stock across all locations this purchasable is tracked in.
getIsAvailable()	Returns whether the purchasable is currently available for purchase.
getIsCanonical()	Returns whether this is the canonical element.
getIsDerivative()	Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()	Returns whether this is a draft.
getIsFresh()	Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()	Returns whether this element represents the site homepage.
getIsPromotable()	Returns whether this purchasable can be subject to discounts or sales.
getIsRevision()	Returns whether this is a revision.
getIsShippable()
getIsSlugTranslatable()	Returns whether the Slug field should be shown as translatable in the UI.
getIsTaxable()	Returns whether this purchasable is exempt from taxes.
getIsTitleTranslatable()	Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()	Returns whether the element is an unpublished draft.
getIterator()	Returns an iterator for traversing the attributes in the model.
getLanguage()	Returns the language of the element.
getLineItemRules()	Returns any validation rules this purchasable required the line item to have.
getLink()	Returns an anchor pre-filled with this element’s URL and title.
getLocalized()	Returns the same element in other locales.
getMetadata()	Returns element metadata that should be shown within the editor sidebar.
getModifiedAttributes()	Returns the attribute names that have changed for this element.
getModifiedFields()	Returns the field handles that have changed for this element.
getNext()	Returns the next element relative to this one, from a given set of criteria.
getNextSibling()	Returns the element’s next sibling.
getOnPromotion()
getOnSale()
getOutdatedAttributes()	Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields()	Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent()	Returns the element’s parent.
getParentId()	Returns the parent ID.
getParentUri()	Returns the parent element’s URI, if there is one.
getPostEditUrl()	Returns the URL that users should be redirected to after editing the element.
getPrev()	Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()	Returns the element’s previous sibling.
getPreviewTargets()	Returns the additional locations that should be available for previewing the element, besides its primary URL.
getPrice()
getPromotionRelationSource()	Returns the source param used for knowing if a promotion category is related to this purchasable.
getPromotionalPrice()
getRef()	Returns the reference string to this element.
getRootOwner()	Returns the root owner element.
getRoute()	Returns the route that should be used when the element’s URI is requested.
getSalePrice()	Returns the actual price the purchasable will be sold for.
getSales()
getScenario()	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords for a given search attribute.
getSerializedFieldValues()	Returns an array of the element’s serialized custom field values, indexed by their handles.
getShippingCategory()	Returns the purchasable's shipping category.
getShippingCategoryId()
getSiblings()	Returns all of the element’s siblings.
getSidebarHtml()	Returns the HTML for any fields/info that should be shown within the editor sidebar.
getSite()	Returns the site the element is associated with.
getSku()	Returns a unique code. Unique as per the commerce_purchasables table.
getSkuAsText()	Returns the SKU as text but returns a blank string if it’s a temp SKU.
getSlugTranslationDescription()	Returns the description of the Slug field’s translation support.
getSlugTranslationKey()	Returns the Slug’s translation key.
getSnapshot()	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()	Returns the element’s canonical ID.
getSourceUid()	Returns the element’s canonical UID.
getStatus()
getStock()	Returns the cached total available stock across all inventory locations for this store.
getStore()	Returns the store for the current instance of the purchasable.
getStoreId()
getSupportedSites()	Returns the sites this element is associated with.
getTaxCategory()	Returns the purchasable's tax category.
getTaxCategoryId()
getThumbHtml()
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()
getUiLabelPath()	Returns any path segment labels that should be prepended to the element’s UI label.
getUriFormat()	Returns the URI format used to generate this element’s URI.
getUrl()	Returns the element’s full URL.
getValidators()	Returns all the validators declared in rules().
gqlScopesByContext()	Returns the GraphQL scopes required by element’s context.
hasDrafts()	Returns whether element indexes should show the “Drafts” status option.
hasEagerLoadedElements()	Returns whether elements have been eager-loaded with a given handle.
hasErrors()	Returns a value indicating whether there is any validation error.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasFreeShipping()	Returns whether this purchasable has free shipping.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
hasRevisions()	Returns whether revisions should be created when this element is saved.
hasStatuses()	Returns whether elements of this type have statuses.
hasStock()	Returns whether this variant has stock.
hasThumbs()	Returns whether element indexes should include a thumbnail view by default.
hasTitles()	Returns whether elements of this type have traditional titles.
hasUris()	Returns whether elements of this type can have their own slugs and URIs.
indexElementCount()	Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()	Returns the element index HTML.
indexViewModes()	Returns the view modes available for the element type.
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
isAncestorOf()	Returns whether this element is an ancestor of another one.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty()	Returns whether an attribute has changed since the element was first loaded.
isAttributeModified()	Returns whether an attribute value has changed for this element.
isAttributeOutdated()	Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()	Returns whether this element is a direct child of another one.
isDescendantOf()	Returns whether this element is a descendant of another one.
isFieldDirty()	Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty()	Returns whether a field is empty.
isFieldModified()	Returns whether a field value has changed for this element.
isFieldOutdated()	Returns whether a field value has fallen behind the canonical element’s value.
isLocalized()	Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()	Returns whether this element is the direct next sibling of another one.
isParentOf()	Returns whether this element is a direct parent of another one.
isPrevSiblingOf()	Returns whether this element is the direct previous sibling of another one.
isSelectable()	Returns whether the component should be selectable in component Type selects.
isSiblingOf()	Returns whether this element is a sibling of another one.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
lowerDisplayName()	Returns the lowercase version of displayName().
markAsClean()	Resets the record of dirty attributes and fields.
markAsDirty()	Marks all fields and attributes as dirty.
mergeCanonicalChanges()	Merges changes from the canonical element into this one.
modifyCustomSource()	Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources()
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName()	Returns the plural version of displayName().
pluralLowerDisplayName()	Returns the plural, lowercase version of displayName().
populateLineItem()	Populates the line item when this purchasable is found on it. Called when Purchasable is added to the cart and when the cart recalculates.
prepareEditScreen()	Prepares the response for the element’s Edit screen.
refHandle()	Returns the handle that should be used to refer to this element type from reference tags.
relatedSales()
render()	Renders the element using its partial template.
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.
setAttributesFromRequest()	Sets the element’s attributes from an element editor submission.
setBasePrice()
setBasePromotionalPrice()
setCanonical()	Sets the canonical version of the element.
setCanonicalId()	Sets the element’s canonical ID.
setDirtyAttributes()	Sets the list of dirty attribute names.
setDirtyFields()	Sets the list of dirty field handles.
setEagerLoadedElementCount()	Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements()	Sets some eager-loaded elements on a given handle.
setEnabledForSite()	Sets whether the element is enabled for the current site.
setFieldParamNamespace()	Sets the namespace used by custom field params on the request.
setFieldValue()	Sets the value for a given field.
setFieldValueFromRequest()	Sets the value for a given field. The value should have originated from post data.
setFieldValues()	Sets the element’s custom field values.
setFieldValuesFromRequest()	Sets the element’s custom field values, when the values have come from post data.
setHasUnlimitedStock()
setIsFresh()	Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setLazyEagerLoadedElements()	Sets whether the given eager-loaded element handles were eager-loaded lazily.
setNext()	Sets the default next element.
setParent()	Sets the element’s parent.
setParentId()	Sets the parent ID.
setPrev()	Sets the default previous element.
setPrice()
setPromotionalPrice()
setRevisionCreatorId()	Sets the revision creator ID to be saved.
setRevisionNotes()	Sets the revision notes to be saved.
setScenario()	Sets the scenario for the model.
setShippingCategoryId()
setSku()
setTaxCategoryId()
setUiLabel()	Defines what the element should be called within the control panel.
setUiLabelPath()	Defines any path segment labels that should be prepended to the element’s UI label.
showStatusIndicator()	Returns whether chips and cards for this element should include a status indicator.
sortOptions()	Returns the sort options for the element type.
sourcePath()	Returns the source path for a given source key, step key, and context.
sources()	Returns the source definitions that elements of this type may belong to.
statuses()
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.
validate()	Performs the data validation.
validateCustomFieldAttribute()	Calls a custom validation function on a custom field.
validateMultiple()	Validates multiple models.

`afterDelete()`

Clean up purchasable table

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

Arguments

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

`afterPropagate()`

Performs actions after an element is fully saved and propagated to other sites.

TIP

This will get called regardless of whether $propagate is true or false for craft\services\Elements::saveElement().

Arguments

$isNew (boolean) – Whether the element is brand new

`afterSave()`

Update purchasable table

Arguments

$isNew

Throws

`attributeLabels()`

Returns the attribute labels.

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

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

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

Returns

array – Attribute labels (name => label)

`attributes()`

Returns the list of attribute names.

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

Returns

string[] – List of attribute names.

`currencyAttributes()`

Returns

array

`displayName()`

Returns the display name of this class.

Returns

string – The display name of this class.

`extraFields()`

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

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), 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).

Returns

array – 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() when no specific fields are specified.

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

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:

php

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.

php

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.

The default implementation of this method returns the public object member variables indexed by themselves.

Returns

array – The list of field names or field definitions.

`getBasePrice()`

Since: 5.0.0

Returns

`getBasePromotionalPrice()`

Since: 5.0.0

Returns

`getDescription()`

Returns your element's title or any additional descriptive information.

`getHasUnlimitedStock()`

DEPRECATED

Deprecated in 5.0.0 use craft\commerce\base\Purchasable::$inventoryTracked instead.

`getInventoryLevels()`

Since: 5.0.0

Returns the total stock across all locations this purchasable is tracked in.

Returns

\Illuminate\Support\Collection<\craft\commerce\models\InventoryLevel>

`getIsAvailable()`

Since: 5.0.0

Returns whether the purchasable is currently available for purchase.

Throws

yii\base\InvalidConfigException

`getIsPromotable()`

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

`getIsShippable()`

`getIsTaxable()`

Returns whether this purchasable is exempt from taxes.

`getLineItemRules()`

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

Arguments

$lineItem (craft\commerce\models\LineItem)

Returns

array

`getOnPromotion()`

`getOnSale()`

Returns

boolean

Throws

craft\errors\DeprecationException

`getPrice()`

Since: 5.0.0

Returns

Throws

`getPromotionRelationSource()`

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

Returns

mixed

`getPromotionalPrice()`

Since: 5.0.0

Returns

Throws

`getSalePrice()`

Returns the actual price the purchasable will be sold for.

Returns

float, null – Decimal(14,4)

`getSales()`

Returns

array, craft\commerce\models\Sale[]

Throws

yii\base\InvalidConfigException

`getShippingCategory()`

Returns the purchasable's shipping category.

`getShippingCategoryId()`

Since: 5.0.0

Returns

Throws

yii\base\InvalidConfigException

`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()`

Returns an array of data that is serializable to json for storing a line item at time of adding to the cart or order.

`getStock()`

Since: 5.0.0

Returns the cached total available stock across all inventory locations for this store.

Returns

`getStore()`

Returns the store for the current instance of the purchasable.

craft\commerce\models\Store

Returns

`getStoreId()`

Since: 5.0.0

Returns

Throws

yii\base\InvalidConfigException

`getTaxCategory()`

Returns the purchasable's tax category.

`getTaxCategoryId()`

Since: 5.0.0

Returns

Throws

yii\base\InvalidConfigException

`hasFreeShipping()`

Returns whether this purchasable has free shipping.

`hasStock()`

Returns whether this variant has stock.

`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

`relatedSales()`

Returns

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

Throws

yii\base\InvalidConfigException

`setAttributesFromRequest()`

Sets the element’s attributes from an element editor submission.

Arguments

$values (array) – The attribute values

`setBasePrice()`

Since: 5.0.0

Arguments

$basePrice (\Money\Money, array, float, integer, null)

Returns

void

Throws

yii\base\InvalidConfigException

`setBasePromotionalPrice()`

Since: 5.0.0

Arguments

$basePromotionalPrice (\Money\Money, array, float, integer, null)

Returns

void

Throws

yii\base\InvalidConfigException

`setHasUnlimitedStock()`

DEPRECATED

Deprecated in 5.0.0 use craft\commerce\base\Purchasable::$inventoryTracked instead.

Arguments

$value

`setPrice()`

Since: 5.0.0

Arguments

$price (float, null)

Returns

void

`setPromotionalPrice()`

Since: 5.0.0

Arguments

$price (float, null)

Returns

void

`setShippingCategoryId()`

Since: 5.0.0

Arguments

$shippingCategoryId (integer, null)

Returns

void

`setSku()`

Arguments

$sku (string, null)

`setTaxCategoryId()`

Since: 5.0.0

Arguments

$taxCategoryId (integer, null)

Returns

void

Protected Methods

Method	Description
attributeHtml()	Returns the HTML that should be shown for a given attribute in table and card views.
availableShippingCategories()
availableTaxCategories()
cacheTags()	Returns the cache tags that should be cleared when this element is saved.
cpEditUrl()	Returns the element’s edit URL in the control panel.
cpRevisionsUrl()	Returns the element’s revisions index URL in the control panel.
crumbs()	Returns the breadcrumbs that lead up to the element.
defineActions()	Defines the available bulk element actions for a given source.
defineBehaviors()	Returns the behaviors to attach to this class.
defineCardAttributes()	Defines all the available attributes that can be shown in card views along with their default placeholder values.
defineDefaultCardAttributes()	Returns the list of card attribute keys that should be shown by default.
defineDefaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
defineExporters()	Defines the available element exporters for a given source.
defineFieldLayouts()	Defines the field layouts associated with elements for a given source.
defineRules()	Returns the validation rules for attributes.
defineSearchableAttributes()	Defines which element attributes should be searchable.
defineSortOptions()	Returns the sort options for the element type.
defineSources()	Defines the sources that elements of this type may belong to.
defineTableAttributes()	Defines all of the available columns that can be shown in table views.
destructiveActionMenuItems()	Returns destructive action menu items for the element’s edit screens.
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.
hasCheckeredThumb()	Returns whether the element’s thumbnail should have a checkered background.
hasFieldLayout()	Returns whether the element has a field layout with at least one tab.
hasNewParent()	Returns whether the element has been assigned a new parent.
hasRoundedThumb()	Returns whether the element’s thumbnail should be rounded.
htmlAttributes()	Returns any attributes that should be included in the element’s chips and cards.
includeSetStatusAction()	Returns whether the Set Status action should be included in actions() automatically.
indexElements()	Returns the resulting elements for an element index.
inlineAttributeInputHtml()	Returns the HTML that should be shown for a given attribute’s inline input.
metaFieldsHtml()	Returns the HTML for any meta fields that should be shown within the editor sidebar.
metadata()	Returns element metadata that should be shown within the editor sidebar.
normalizeFieldValue()	Normalizes a field’s value.
notesFieldHtml()	Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute()	Prepares an element query for an element index that includes a given table attribute.
previewTargets()	Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()	Determines which fields can be returned by toArray().
route()	Returns the route that should be used when the element’s URI is requested.
safeActionMenuItems()	Returns action menu items for the element’s edit screens.
searchKeywords()	Returns the search keywords for a given search attribute.
shippingCategoryFieldHtml()
shouldValidateTitle()	Returns whether the element’s `title` attribute should be validated
showStatusField()	Returns whether the Status field should be shown for this element.
slugFieldHtml()	Returns the HTML for the element’s Slug field.
statusFieldHtml()	Returns the status field HTML for the sidebar.
taxCategoryFieldHtml()
thumbAlt()	Returns alt text for the element’s thumbnail.
thumbSvg()	Returns the element’s thumbnail SVG contents, which should be used as a fallback when `\craft\base\getThumbUrl()` returns `null`.
thumbUrl()	Returns the URL to the element’s thumbnail, if it has one.
uiLabel()	Returns what the element should be called within the control panel.

`attributeHtml()`

Returns the HTML that should be shown for a given attribute in table and card views.

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

php

return match ($attribute) {
    'email' => $this->email ? Html::mailto(Html::encode($this->email)) : '',
    default => parent::attributeHtml($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 or uri, it will be linked to the front-end URL.
If the attribute is a custom field handle, it will pass the responsibility off to the field type.
If the attribute value is a \craft\commerce\base\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 and card views.

Throws

yii\base\InvalidConfigException

`availableShippingCategories()`

Since: 5.0.12

craft\commerce\models\ShippingCategory[]

Returns

Throws

`availableTaxCategories()`

Since: 5.0.12

craft\commerce\models\TaxCategory[]

Returns

Throws

yii\base\InvalidConfigException

`defineDefaultTableAttributes()`

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

Arguments

$source (string) – The selected source’s key

Returns

string[] – The table attributes.

`defineRules()`

Returns the validation rules for attributes.

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

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

Returns

array

`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

`defineTableAttributes()`

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

Returns

array – The table attributes.

`inlineAttributeInputHtml()`

Returns the HTML that should be shown for a given attribute’s inline input.

Arguments

$attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute’s inline input.

`metaFieldsHtml()`

Returns the HTML for any meta fields that should be shown within the editor sidebar.

Arguments

$static (boolean) – Whether the fields should be static (non-interactive)

Returns

string

`shippingCategoryFieldHtml()`

Since: 5.0.12

Arguments

$static (boolean)

Returns

string

Throws

yii\base\InvalidConfigException

`taxCategoryFieldHtml()`

Since: 5.0.12