Purchasable

Type
Abstract Class
Namespace
craft\commerce\base
Inherits
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
Extended by
craft\commerce\elements\Donation, craft\commerce\elements\Variant
Since
2.0

Base Purchasable

View source

# 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
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
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.
hasDescendants boolean
hasFreshContent boolean – Whether the element’s content is fresh
id integer, null – The element’s ID
isAvailable boolean
isDraft boolean
isEditable boolean
isHomepage boolean
isPromotable boolean
isRevision boolean
isShippable boolean
isTaxable boolean
isUnsavedDraft boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
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
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 float – Decimal(14,4)
promotionRelationSource mixed
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.
purchasableId
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
sku string
slug string, null – The element’s slug
snapshot array
sourceId integer, null
sourceUid string
status string, null
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
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.

# description

Type
string
Access
Read-only

View source

# isAvailable

Type
boolean
Access
Read-only

View source

# isPromotable

Type
boolean
Access
Read-only

View source

# isShippable

Type
boolean
Access
Read-only

View source

# isTaxable

Type
boolean
Access
Read-only

View source

# onSale

Type
boolean
Access
Read-only

View source

# promotionRelationSource

Type
mixed
Access
Read-only

View source

# purchasableId

Access
Read-only

View source

# salePrice

Type
float
Access
Read-only

Decimal(14,4)

View source

# sales

Type
craft\commerce\models\Sale[], null
Access
Read-only

View source

# shippingCategoryId

Type
integer
Access
Read-only

View source

# snapshot

Type
array
Access
Read-only

View source

# taxCategoryId

Type
integer
Access
Read-only

View source

# 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 an object property to 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() 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.
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() 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.
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().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
displayName() Returns the display name of this class.
eagerLoadingMap() Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
exporters() Returns the available export options for a given source.
extraFields() Returns the list of fields that can be expanded further and returned by toArray().
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.
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.
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 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.
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() Returns the GraphQL type name for this element type.
getHasDescendants() Returns whether the element has descendants.
getHasFreshContent() Returns whether the element’s content is "fresh" (unsaved and without validation errors).
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.
getIsDraft() Returns whether this is a draft.
getIsEditable() Returns whether the current user can edit the element.
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.
getIsUnsavedDraft() Returns whether the element is an unsaved draft.
getIterator() Returns an iterator for traversing the attributes in the model.
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.
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() 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.
getPurchasableId()
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() 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.
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.
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 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.
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().
gqlScopesByContext() Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext() Returns the GraphQL type name by an element's context.
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.
hasStatuses() Returns whether elements of this type have statuses.
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.
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.
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.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() Sets the scenario for the model.
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.
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.

# afterDelete()

Clean up purchasable table

View source

# 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

Arguments

Returns

void

# afterSave()

Update purchasable table

View source

Arguments

# 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

Returns

array – List of attribute names.

# displayName()

Returns the display name of this class.

View source

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

View source

Returns

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

# getDescription()

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

View source

Returns

string

# getIsAvailable()

Returns whether the purchasable is currently available for purchase.

View source

Returns

boolean

# getIsPromotable()

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

View source

Returns

boolean

# getIsShippable()

View source

Returns

boolean

# getIsTaxable()

Returns whether this purchasable is exempt from taxes.

View source

Returns

boolean

# getLineItemRules()

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

View source

Arguments

Returns

array

# getOnSale()

View source

Returns

boolean

# getPromotionRelationSource()

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

View source

Returns

mixed

# getPurchasableId()

DEPRECATED

Deprecated as of 2.0

View source

# getSalePrice()

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

It provides opportunity to populate the salePrice if sales have not already been applied.

View source

Returns

float – Decimal(14,4)

# getSales()

Returns an array of sales models which are currently affecting the salePrice of this purchasable.

View source

Returns

craft\commerce\models\Sale[], null

# getShippingCategoryId()

Returns the purchasable's shipping category ID.

View source

Returns

integer

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

View source

Returns

array

# getTaxCategoryId()

Returns the purchasable's tax category ID.

View source

Returns

integer

# hasFreeShipping()

Returns whether this purchasable has free shipping.

View source

Returns

boolean

# populateLineItem()

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

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

View source

Arguments

# relatedSales()

View source

Returns

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

# rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\base\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of built-in validators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

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

View source

Returns

array – Validation rules

# 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.
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.
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.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# 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