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\Variant
Since
2.0

Base Purchasable

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$ancestorscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$archivedboolean – Whether the element is archived
$attributesarray – Attribute values (name => value).
$awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$childrencraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$contentIdinteger, null – The element’s content row ID
$contentTablestring
$cpEditUrlstring, null
$dateCreatedDateTime, null – The date that the element was created
$dateUpdatedDateTime, null – The date that the element was last updated
$descendantscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$descriptionstring
$editorHtmlstring – The HTML for the editor HUD
$enabledboolean – Whether the element is enabled
$enabledForSiteboolean – Whether the element is enabled for this site.
$errorsarray – Errors for all attributes or the specified attribute.
$fieldColumnPrefixstring
$fieldContextstring
$fieldLayoutcraft\models\FieldLayout, null
$fieldLayoutIdinteger, null – The element’s field layout ID
$fieldParamNamespacestring, null – The field param namespace
$fieldValuesarray – The field values (handle => value)
$fieldValuesFromRequeststring – The field param namespace
$firstErrorsarray – The first errors.
$hasDescendantsboolean
$hasFreshContentboolean – Whether the element’s content is fresh
$idinteger, null – The element’s ID
$isAvailableboolean
$isEditableboolean
$isPromotableboolean
$iteratorArrayIterator – An iterator for traversing the items in the list.
$levelinteger, null – The element’s level within its structure
$lftinteger, null – The element’s left position within its structure
$linkTwig_Markup, null
$nextcraft\base\ElementInterface, null
$nextSiblingcraft\base\ElementInterface, null
$parentcraft\base\ElementInterface, null
$prevcraft\base\ElementInterface, null
$prevSiblingcraft\base\ElementInterface, null
$pricefloat – Decimal(14,4)
$promotionRelationSourcemixed
$propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
$purchasableId
$refstring, null
$rgtinteger, null – The element’s right position within its structure
$rootinteger, null – The element’s structure’s root ID
$routemixed – The route that the request should use, or null if no special action should be taken
$salePricefloat – Decimal(14,4)
$salescraft\commerce\models\Sale[], null
$scenariostring – The scenario that this model is in.
$searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
$serializedFieldValuesarray
$shippingCategoryIdinteger
$siblingscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$sitecraft\models\Site
$siteIdinteger, null – The site ID the element is associated with
$skustring
$slugstring, null – The element’s slug
$snapshotarray
$statusstring, null
$structureIdinteger, null – The element’s structure ID
$supportedSitesinteger[], array
$taxCategoryIdinteger
$tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
$titlestring, null – The element’s title
$totalDescendantsinteger
$uidstring, null – The element’s UID
$uristring, null – The element’s URI
$uriFormatstring, null
$urlstring, null
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$description

Type
string
Access
Read-only

View source

Signature

public string getDescription ( )

$isPromotable

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsPromotable ( )

$promotionRelationSource

Type
mixed
Access
Read-only

View source

Signature

public mixed getPromotionRelationSource ( )

$purchasableId

Type

:

Access
Read-only

View source

Signature

public void getPurchasableId ( )

$salePrice

Type
float
Access
Read-only

Decimal(14,4)

View source

Signature

public float getSalePrice ( )

$sales

Signature

public craft\commerce\models\Sale[], null getSales ( )

$shippingCategoryId

Type
integer
Access
Read-only

View source

Signature

public integer getShippingCategoryId ( )

$snapshot

Type
array
Access
Read-only

View source

Signature

public array getSnapshot ( )

$taxCategoryId

Type
integer
Access
Read-only

View source

Signature

public integer getTaxCategoryId ( )

Public Methods

MethodDescription
__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 (if one is provided).
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).
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.
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.
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\commerce\base\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.
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 CP edit URL.
getDescendants()Returns the element’s descendants.
getDescription()Returns your element's title or any additional descriptive information.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor HUD.
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.
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.
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.
getIsEditable()Returns whether the current user can edit the element.
getIsPromotable()Returns whether this purchasable can be subject to discounts or sales.
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.
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.
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.
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.
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().
hasContent()Returns whether elements of this type will be storing any data in the content table (tiles 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.
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.
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.
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.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
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.
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.
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

Signature

public void afterDelete ( )

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

Signature

public void afterOrderComplete ( craft\commerce\elements\Order $order, craft\commerce\models\LineItem $lineItem )

afterSave()

Update purchasable table

View source

Arguments

Signature

public void afterSave ( \craft\commerce\base\bool $isNew )

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.

Signature

public array attributes ( )

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

Signature

public static string displayName ( )

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.

Signature

public array extraFields ( )

getDescription()

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

View source

Returns

string

Signature

public string getDescription ( )

getIsPromotable()

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

View source

Returns

boolean

Signature

public boolean getIsPromotable ( )

getLineItemRules()

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

View source

Arguments

Returns

array

Signature

public array getLineItemRules ( craft\commerce\models\LineItem $lineItem )

getPromotionRelationSource()

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

View source

Returns

mixed

Signature

public mixed getPromotionRelationSource ( )

getPurchasableId()

DEPRECATED

Deprecated as of 2.0

View source

Signature

public void getPurchasableId ( )

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)

Signature

public float getSalePrice ( )

getSales()

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

View source

Returns

craft\commerce\models\Sale[], null

Signature

public craft\commerce\models\Sale[], null getSales ( )

getShippingCategoryId()

Returns the purchasable's shipping category ID.

View source

Returns

integer

Signature

public integer getShippingCategoryId ( )

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

Signature

public array getSnapshot ( )

getTaxCategoryId()

Returns the purchasable's tax category ID.

View source

Returns

integer

Signature

public integer getTaxCategoryId ( )

hasFreeShipping()

Returns whether this purchasable has free shipping.

View source

Returns

boolean

Signature

public boolean hasFreeShipping ( )

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

Signature

public void populateLineItem ( craft\commerce\models\LineItem $lineItem )

relatedSales()

Signature

public craft\commerce\models\Sale[] relatedSales ( )

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 \craft\commerce\base\Validator::builtInValidators. 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

Signature

public array rules ( )

Protected Methods

MethodDescription
defineActions()Defines the available element actions for a given source (if one is provided).
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
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
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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED