Discount

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\Discount » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\commerce\base\HasStoreInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\commerce\base\StoreTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

2.0

Discount model

View source

Public Properties

Property	Description
_billingAddressCondition	craft\elements\conditions\ElementConditionInterface, null
_customerCondition	craft\elements\conditions\ElementConditionInterface, null
_orderCondition	craft\elements\conditions\ElementConditionInterface, null
_shippingAddressCondition	craft\elements\conditions\ElementConditionInterface, null
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
allCategories	boolean – Match all product types TODO: Rename to $allEntries in 6.0
allPurchasables	boolean – Match all products
appliedTo	string – What the per item amount and per item percentage off amounts can apply to
attributes	array – Attribute values (name => value).
baseDiscount	float – Base amount of discount
behaviors	yii\base\Behavior – List of behaviors attached to this component.
billingAddressCondition	string, array, craft\elements\conditions\ElementConditionInterface
categoryIds	array
categoryRelationshipType	string – Type of relationship between Categories and Products TODO: Rename to $entryRelationshipType in 6.0
couponFormat	string – Format coupons should be generated with
coupons	array, craft\commerce\models\Coupon[]
cpEditUrl	string, false
customerCondition	string, array, craft\elements\conditions\ElementConditionInterface
dateCreated	DateTime, null
dateFrom	DateTime, null – Date the discount is valid from
dateTo	DateTime, null – Date the discount is valid to
dateUpdated	DateTime, null
description	string, null – The description of this discount
enabled	boolean – Discount enabled?
errors	array – Errors for all attributes or the specified attribute.
excludeOnPromotion	boolean – Exclude the “On Promotion” Purchasables
excludeOnSale	boolean
firstErrors	array – The first errors.
hasFreeShippingForMatchingItems	boolean – Matching products have free shipping.
hasFreeShippingForOrder	boolean – The whole order has free shipping.
id	integer, null – ID
ignorePromotions	boolean – Discount ignores sales
iterator	ArrayIterator – An iterator for traversing the items in the list.
maxPurchaseQty	integer – Total maximum spend on matching items
name	string – Name of the discount
orderCondition	string, array, craft\elements\conditions\ElementConditionInterface
orderConditionFormula	string, null – Condition that must match to match the order, null or empty string means match all
perEmailLimit	integer – Per email coupon use limit
perItemDiscount	float – Amount of discount per item
perUserLimit	integer – Per user coupon use limit
percentDiscount	float – Percentage of amount discount per item
percentDiscountAsPercent	string
percentageOffSubject	string – Whether the discount is off the original price, or the already discount price.
purchasableIds	array
purchaseQty	integer – Total minimum qty of matching items
purchaseTotal	float – Total minimum spend on matching items
requireCouponCode	boolean – Requires a coupon code to be applied
scenario	string – The scenario that this model is in.
shippingAddressCondition	string, array, craft\elements\conditions\ElementConditionInterface
sortOrder	integer, null – SortOrder
stopProcessing	boolean – StopProcessing
store	craft\commerce\models\Store
storeId	integer, null – Store ID
totalDiscountUseLimit	integer – Total use limit by users
totalDiscountUses	integer – Total use counter;
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

_billingAddressCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getBillingAddressCondition()
• setBillingAddressCondition()

View source

_customerCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getCustomerCondition()
• setCustomerCondition()

View source

_orderCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getOrderCondition()
• setOrderCondition()

View source

_shippingAddressCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getShippingAddressCondition()
• setShippingAddressCondition()

View source

allCategories

Type

boolean

Default value

false

Match all product types

TODO: Rename to $allEntries in 6.0

View source

allPurchasables

Type

boolean

Default value

false

Match all products

View source

appliedTo

Type

string

Default value

\craft\commerce\records\Discount::APPLIED_TO_MATCHING_LINE_ITEMS

What the per item amount and per item percentage off amounts can apply to

View source

baseDiscount

Type

float

Default value

0

Base amount of discount

View source

billingAddressCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

categoryIds

Type

array

Default value

null

View source

categoryRelationshipType

Type

string

Default value

\craft\commerce\records\Discount::CATEGORY_RELATIONSHIP_TYPE_BOTH

Type of relationship between Categories and Products

TODO: Rename to $entryRelationshipType in 6.0

View source

couponFormat

Type

string

Default value

\craft\commerce\services\Coupons::DEFAULT_COUPON_FORMAT

Since

4.0

Format coupons should be generated with

View source

coupons

Type

array, craft\commerce\models\Coupon[]

Default value

null

View source

cpEditUrl

Type

string, false

Default value

null

View source

customerCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

dateCreated

Type

DateTime, null

Default value

null

View source

dateFrom

Type

DateTime, null

Default value

null

Date the discount is valid from

View source

dateTo

Type

DateTime, null

Default value

null

Date the discount is valid to

View source

dateUpdated

Type

DateTime, null

Default value

null

View source

description

Type

string, null

Default value

null

The description of this discount

View source

enabled

Type

boolean

Default value

true

Discount enabled?

View source

excludeOnPromotion

Type

boolean

Default value

false

Exclude the “On Promotion” Purchasables

View source

excludeOnSale

Type

boolean

Default value

null

Since

5.0.0

View source

hasFreeShippingForMatchingItems

Type

boolean

Default value

false

Matching products have free shipping.

View source

hasFreeShippingForOrder

Type

boolean

Default value

false

The whole order has free shipping.

View source

id

Type

integer, null

Default value

null

ID

View source

ignorePromotions

Type

boolean

Default value

true

Discount ignores sales

View source

maxPurchaseQty

Type

integer

Default value

0

Total maximum spend on matching items

View source

name

Type

string

Default value

''

Name of the discount

View source

orderCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

orderConditionFormula

Type

string, null

Default value

null

Condition that must match to match the order, null or empty string means match all

View source

perEmailLimit

Type

integer

Default value

0

Per email coupon use limit

View source

perItemDiscount

Type

float

Default value

0.0

Amount of discount per item

View source

perUserLimit

Type

integer

Default value

0

Per user coupon use limit

View source

percentDiscount

Type

float

Default value

0.0

Percentage of amount discount per item

View source

percentDiscountAsPercent

Type

string

Default value

null

View source

percentageOffSubject

Type

string

Default value

\craft\commerce\records\Discount::TYPE_DISCOUNTED_SALEPRICE

Whether the discount is off the original price, or the already discount price.

View source

purchasableIds

Type

array

Default value

null

View source

purchaseQty

Type

integer

Default value

0

Total minimum qty of matching items

View source

purchaseTotal

Type

float

Default value

0

Total minimum spend on matching items

View source

requireCouponCode

Type

boolean

Default value

false

Since

5.2.0

Requires a coupon code to be applied

View source

shippingAddressCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

sortOrder

Type

integer, null

Default value

999999

SortOrder

View source

stopProcessing

Type

boolean

Default value

false

StopProcessing

View source

totalDiscountUseLimit

Type

integer

Default value

0

Since

3.0

Total use limit by users

View source

totalDiscountUses

Type

integer

Default value

0

Since

3.0

Total use counter;

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
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.
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.
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.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
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.
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.
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.
getBillingAddressCondition()
getCategoryIds()
getCoupons()
getCpEditUrl()
getCustomerCondition()
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getExcludeOnSale()
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getHasFreeShippingForMatchingItems()
getIterator()	Returns an iterator for traversing the attributes in the model.
getOrderCondition()
getPercentDiscountAsPercent()
getPurchasableIds()
getScenario()	Returns the scenario that this model is used in.
getShippingAddressCondition()
getStore()
getValidators()	Returns all the validators declared in rules().
hasBillingAddressCondition()
hasCustomerCondition()
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.
hasMethod()	Returns a value indicating whether a method is defined.
hasOrderCondition()
hasProperty()	Returns a value indicating whether a property is defined for this component.
hasShippingAddressCondition()
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
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.
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()	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.
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.
setAttributes()	Sets the attribute values in a massive way.
setBillingAddressCondition()
setCategoryIds()	Sets the related product type ids
setCoupons()
setCustomerCondition()
setExcludeOnSale()
setHasFreeShippingForMatchingItems()
setOrderCondition()
setPurchasableIds()	Sets the related product ids
setScenario()	Sets the scenario for the model.
setShippingAddressCondition()
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

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.

getBillingAddressCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getCategoryIds()

View source

Returns

integer[]

getCoupons()

View source

Returns

array

Throws

• yii\base\InvalidConfigException

getCpEditUrl()

View source

getCustomerCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getExcludeOnSale()

DEPRECATED

Deprecated in 5.0.0. Use $excludeOnPromotion instead.

Since

5.0.0

View source

Returns

boolean

getHasFreeShippingForMatchingItems()

View source

Returns

boolean

getOrderCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getPercentDiscountAsPercent()

View source

getPurchasableIds()

View source

Returns

integer[]

getShippingAddressCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

hasBillingAddressCondition()

Since

4.3.0

View source

Returns

boolean

hasCustomerCondition()

Since

4.3.0

View source

Returns

boolean

hasOrderCondition()

Since

4.3.0

View source

Returns

boolean

hasShippingAddressCondition()

Since

4.3.0

View source

Returns

boolean

setBillingAddressCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

setCategoryIds()

Sets the related product type ids

View source

Arguments

• $categoryIds (integer[])

setCoupons()

View source

Arguments

• $coupons (array)

setCustomerCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string)

Returns

void

Throws

• yii\base\InvalidConfigException

setExcludeOnSale()

DEPRECATED

Deprecated in 5.0.0. Use $excludeOnPromotion instead.

Since

5.0.0

View source

Arguments

• $exclude (boolean)

Returns

void

setHasFreeShippingForMatchingItems()

View source

Arguments

• $value (boolean)

Returns

void

setOrderCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

setPurchasableIds()

Sets the related product ids

View source

Arguments

• $purchasableIds (integer[])

setShippingAddressCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
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.
resolveFields()	Determines which fields can be returned by toArray().

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.

View source

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.