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, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Discount model

View source

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
allCategories boolean – Match all product types
allGroups boolean – Match all user groups.
allPurchasables boolean – Match all products
appliedTo boolean – 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
baseDiscountType string – Type of discount for the base discount e.g. currency value or percentage
behaviors yii\base\Behavior – List of behaviors attached to this component
categoryIds array
categoryRelationshipType string – Type of relationship between Categories and Products
code string – Coupon Code
cpEditUrl string, false
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 – The description of this discount
enabled boolean – Discount enabled?
errors array – Errors for all attributes or the specified attribute.
excludeOnSale boolean – Exclude on sale purchasables
firstErrors array – The first errors.
hasFreeShippingForMatchingItems boolean – Matching products have free shipping.
hasFreeShippingForOrder boolean – The whole order has free shipping.
id integer – ID
ignoreSales 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
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
scenario string – The scenario that this model is in.
sortOrder integer – SortOrder
stopProcessing boolean – StopProcessing
totalDiscountUseLimit integer – Total use limit by guests or users
totalDiscountUses integer – Total use counter;
userGroupIds array
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# allCategories

Type
boolean

Match all product types

View source

# allGroups

Type
boolean

Match all user groups.

View source

# allPurchasables

Type
boolean

Match all products

View source

# appliedTo

Type
boolean

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

View source

# baseDiscount

Type
float

Base amount of discount

View source

# baseDiscountType

Type
string

Type of discount for the base discount e.g. currency value or percentage

View source

# categoryIds

Type
array

View source

# categoryRelationshipType

Type
string

Type of relationship between Categories and Products

View source

# code

Type
string

Coupon Code

View source

# cpEditUrl

Type
string, false
Access
Read-only

View source

# dateCreated

Type
DateTime, null

View source

# dateFrom

Type
DateTime, null

Date the discount is valid from

View source

# dateTo

Type
DateTime, null

Date the discount is valid to

View source

# dateUpdated

Type
DateTime, null

View source

# description

Type
string

The description of this discount

View source

# enabled

Type
boolean

Discount enabled?

View source

# excludeOnSale

Type
boolean

Exclude on sale purchasables

View source

# hasFreeShippingForMatchingItems

Type
boolean

Matching products have free shipping.

View source

# hasFreeShippingForOrder

Type
boolean

The whole order has free shipping.

View source

# id

Type
integer

ID

View source

# ignoreSales

Type
boolean

Discount ignores sales

View source

# maxPurchaseQty

Type
integer

Total maximum spend on matching items

View source

# name

Type
string

Name of the discount

View source

# orderConditionFormula

Type
string, null

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

View source

# perEmailLimit

Type
integer

Per email coupon use limit

View source

# perItemDiscount

Type
float

Amount of discount per item

View source

# perUserLimit

Type
integer

Per user coupon use limit

View source

# percentDiscount

Type
float

Percentage of amount discount per item

View source

# percentDiscountAsPercent

Type
string
Access
Read-only

View source

# percentageOffSubject

Type
string

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

View source

# purchasableIds

Type
array

View source

# purchaseQty

Type
integer

Total minimum qty of matching items

View source

# purchaseTotal

Type
float

Total minimum spend on matching items

View source

# sortOrder

Type
integer

SortOrder

View source

# stopProcessing

Type
boolean

StopProcessing

View source

# totalDiscountUseLimit

Type
integer
Since
3.0

Total use limit by guests or users

View source

# totalDiscountUses

Type
integer
Since
3.0

Total use counter;

View source

# userGroupIds

Type
array

View source

# 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, 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.
defineRules() Returns the validation rules for attributes.
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.
getCategoryIds()
getCpEditUrl()
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.
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.
getPercentDiscountAsPercent()
getPurchasableIds()
getScenario() Returns the scenario that this model is used in.
getUserGroupIds()
getValidators() Returns all the validators declared in rules().
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.
hasProperty() Returns a value indicating whether a property is defined for this component.
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.
setCategoryIds() Sets the related product type ids
setHasFreeShippingForMatchingItems()
setPurchasableIds() Sets the related product ids
setScenario() Sets the scenario for the model.
setUserGroupIds() Sets the related user group ids
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

# 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

# getCategoryIds()

View source

Returns

array

# getCpEditUrl()

View source

Returns

string, false

# getHasFreeShippingForMatchingItems()

View source

Returns

boolean

# getPercentDiscountAsPercent()

View source

Returns

string

# getPurchasableIds()

View source

Returns

array

# getUserGroupIds()

View source

Returns

array

# setCategoryIds()

Sets the related product type ids

View source

Arguments

# setHasFreeShippingForMatchingItems()

View source

Arguments

# setPurchasableIds()

Sets the related product ids

View source

Arguments

# setUserGroupIds()

Sets the related user group ids

View source

Arguments

# Protected Methods

Method Description
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().

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.