Discount
- Type
- Class
- Namespace
- craft\commerce\models
- Inherits
- craft\commerce\models\Discount » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ModelInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
- Uses traits
- craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Since
- 2.0
Discount model
View source (opens new window)
# Public Properties
# _billingAddressCondition
- Type
- craft\elements\conditions\ElementConditionInterface (opens new window), null (opens new window)
- Default value
null
See also:
View source (opens new window)
# _customerCondition
- Type
- craft\elements\conditions\ElementConditionInterface (opens new window), null (opens new window)
- Default value
null
See also:
View source (opens new window)
# _orderCondition
- Type
- craft\elements\conditions\ElementConditionInterface (opens new window), null (opens new window)
- Default value
null
See also:
View source (opens new window)
# _shippingAddressCondition
- Type
- craft\elements\conditions\ElementConditionInterface (opens new window), null (opens new window)
- Default value
null
See also:
View source (opens new window)
# allCategories
- Type
- boolean (opens new window)
- Default value
false
Match all product types
TODO: Rename to $allEntries in Commerce 5
View source (opens new window)
# allPurchasables
- Type
- boolean (opens new window)
- Default value
false
Match all products
View source (opens new window)
# appliedTo
- Type
- string (opens new window)
- 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 (opens new window)
# baseDiscount
- Type
- float (opens new window)
- Default value
0
Base amount of discount
View source (opens new window)
# baseDiscountType
- Type
- string (opens new window)
- Default value
\craft\commerce\records\Discount::BASE_DISCOUNT_TYPE_VALUE
Type of discount for the base discount e.g. currency value or percentage
View source (opens new window)
# billingAddressCondition
- Type
- string (opens new window), array (opens new window), craft\elements\conditions\ElementConditionInterface (opens new window)
- Default value
null
View source (opens new window)
# categoryIds
- Type
- array (opens new window)
- Default value
null
View source (opens new window)
# categoryRelationshipType
- Type
- string (opens new window)
- Default value
\craft\commerce\records\Discount::CATEGORY_RELATIONSHIP_TYPE_BOTH
Type of relationship between Categories and Products
TODO: Rename to $entryRelationshipType in Commerce 5
View source (opens new window)
# couponFormat
- Type
- string (opens new window)
- Default value
\craft\commerce\services\Coupons::DEFAULT_COUPON_FORMAT- Since
- 4.0
Format coupons should be generated with
View source (opens new window)
# coupons
- Type
- array (opens new window), craft\commerce\models\Coupon[]
- Default value
null
View source (opens new window)
# cpEditUrl
- Type
- string (opens new window), false (opens new window)
- Default value
null
View source (opens new window)
# customerCondition
- Type
- string (opens new window), array (opens new window), craft\elements\conditions\ElementConditionInterface (opens new window)
- Default value
null
View source (opens new window)
# dateCreated
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
View source (opens new window)
# dateFrom
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Date the discount is valid from
View source (opens new window)
# dateTo
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Date the discount is valid to
View source (opens new window)
# dateUpdated
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
View source (opens new window)
# description
- Type
- string (opens new window), null (opens new window)
- Default value
null
The description of this discount
View source (opens new window)
# enabled
- Type
- boolean (opens new window)
- Default value
true
Discount enabled?
View source (opens new window)
# excludeOnSale
- Type
- boolean (opens new window)
- Default value
false
Exclude the “On Sale” Purchasables
View source (opens new window)
# hasFreeShippingForMatchingItems
- Type
- boolean (opens new window)
- Default value
false
Matching products have free shipping.
View source (opens new window)
# hasFreeShippingForOrder
- Type
- boolean (opens new window)
- Default value
false
The whole order has free shipping.
View source (opens new window)
# id
- Type
- integer (opens new window), null (opens new window)
- Default value
null
ID
View source (opens new window)
# ignoreSales
- Type
- boolean (opens new window)
- Default value
true
Discount ignores sales
View source (opens new window)
# maxPurchaseQty
- Type
- integer (opens new window)
- Default value
0
Total maximum spend on matching items
View source (opens new window)
# name
- Type
- string (opens new window)
- Default value
''
Name of the discount
View source (opens new window)
# orderCondition
- Type
- string (opens new window), array (opens new window), craft\elements\conditions\ElementConditionInterface (opens new window)
- Default value
null
View source (opens new window)
# orderConditionFormula
- Type
- string (opens new window), null (opens new window)
- Default value
null
Condition that must match to match the order, null or empty string means match all
View source (opens new window)
# perEmailLimit
- Type
- integer (opens new window)
- Default value
0
Per email coupon use limit
View source (opens new window)
# perItemDiscount
- Type
- float (opens new window)
- Default value
0.0
Amount of discount per item
View source (opens new window)
# perUserLimit
- Type
- integer (opens new window)
- Default value
0
Per user coupon use limit
View source (opens new window)
# percentDiscount
- Type
- float (opens new window)
- Default value
0.0
Percentage of amount discount per item
View source (opens new window)
# percentDiscountAsPercent
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# percentageOffSubject
- Type
- string (opens new window)
- Default value
\craft\commerce\records\Discount::TYPE_DISCOUNTED_SALEPRICE
Whether the discount is off the original price, or the already discount price.
View source (opens new window)
# purchasableIds
- Type
- array (opens new window)
- Default value
null
View source (opens new window)
# purchaseQty
- Type
- integer (opens new window)
- Default value
0
Total minimum qty of matching items
View source (opens new window)
# purchaseTotal
- Type
- float (opens new window)
- Default value
0
Total minimum spend on matching items
View source (opens new window)
# shippingAddressCondition
- Type
- string (opens new window), array (opens new window), craft\elements\conditions\ElementConditionInterface (opens new window)
- Default value
null
View source (opens new window)
# sortOrder
- Type
- integer (opens new window), null (opens new window)
- Default value
999999
SortOrder
View source (opens new window)
# stopProcessing
- Type
- boolean (opens new window)
- Default value
false
StopProcessing
View source (opens new window)
# totalDiscountUseLimit
- Type
- integer (opens new window)
- Default value
0- Since
- 3.0
Total use limit by users
View source (opens new window)
# totalDiscountUses
- Type
- integer (opens new window)
- Default value
0- Since
- 3.0
Total use counter;
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | |
| __construct() (opens new window) | |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| activeAttributes() (opens new window) | Returns the attribute names that are subject to validation in the current scenario. |
| addError() (opens new window) | Adds a new error to the specified attribute. |
| addErrors() (opens new window) | Adds a list of errors. |
| addModelErrors() (opens new window) | Adds errors from another model, with a given attribute name prefix. |
| afterValidate() (opens new window) | This method is invoked after validation ends. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attributeHints() (opens new window) | Returns the attribute hints. |
| attributeLabels() (opens new window) | Returns the attribute labels. |
| attributes() (opens new window) | Returns the list of attribute names. |
| beforeValidate() (opens new window) | This method is invoked before validation starts. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| clearErrors() (opens new window) | Removes errors for all attributes or a single attribute. |
| createValidators() (opens new window) | Creates validator objects based on the validation rules specified in rules() (opens new window). |
| datetimeAttributes() (opens new window) | Returns the names of any attributes that should hold DateTime (opens new window) values. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| extraFields() | Returns the list of fields that can be expanded further and returned by toArray() (opens new window). |
| fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified. |
| formName() (opens new window) | Returns the form name that this model class should use. |
| generateAttributeLabel() (opens new window) | Generates a user friendly attribute label based on the give attribute name. |
| getActiveValidators() (opens new window) | Returns the validators applicable to the current scenario (opens new window). |
| getAttributeHint() (opens new window) | Returns the text hint for the specified attribute. |
| getAttributeLabel() (opens new window) | Returns the text label for the specified attribute. |
| getAttributes() (opens new window) | Returns attribute values. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getBillingAddressCondition() | |
| getCategoryIds() | |
| getCoupons() | |
| getCpEditUrl() | |
| getCustomerCondition() | |
| getErrorSummary() (opens new window) | Returns the errors for all attributes as a one-dimensional array. |
| getErrors() (opens new window) | Returns the errors for all attributes or a single attribute. |
| getFirstError() (opens new window) | Returns the first error of the specified attribute. |
| getFirstErrors() (opens new window) | Returns the first error of every attribute in the model. |
| getHasFreeShippingForMatchingItems() | |
| getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
| getOrderCondition() | |
| getPercentDiscountAsPercent() | |
| getPurchasableIds() | |
| getScenario() (opens new window) | Returns the scenario that this model is used in. |
| getShippingAddressCondition() | |
| getValidators() (opens new window) | Returns all the validators declared in rules() (opens new window). |
| hasBillingAddressCondition() | |
| hasCustomerCondition() | |
| hasErrors() (opens new window) | Returns a value indicating whether there is any validation error. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasOrderCondition() | |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| hasShippingAddressCondition() | |
| init() (opens new window) | Initializes the object. |
| instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
| isAttributeActive() (opens new window) | Returns a value indicating whether the attribute is active in the current scenario. |
| isAttributeRequired() (opens new window) | Returns a value indicating whether the attribute is required. |
| isAttributeSafe() (opens new window) | Returns a value indicating whether the attribute is safe for massive assignments. |
| load() (opens new window) | Populates the model with input data. |
| loadMultiple() (opens new window) | Populates a set of models with the data from end user. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| offsetExists() (opens new window) | Returns whether there is an element at the specified offset. |
| offsetGet() (opens new window) | Returns the element at the specified offset. |
| offsetSet() (opens new window) | Sets the element at the specified offset. |
| offsetUnset() (opens new window) | Sets the element value at the specified offset to null. |
| on() (opens new window) | Attaches an event handler to an event. |
| onUnsafeAttribute() (opens new window) | This method is invoked when an unsafe attribute is being massively assigned. |
| rules() (opens new window) | Returns the validation rules for attributes. |
| safeAttributes() (opens new window) | Returns the attribute names that are safe to be massively assigned in the current scenario. |
| scenarios() (opens new window) | Returns a list of scenarios and the corresponding active attributes. |
| setAttributes() (opens new window) | Sets the attribute values in a massive way. |
| setBillingAddressCondition() | |
| setCategoryIds() | Sets the related product type ids |
| setCoupons() | |
| setCustomerCondition() | |
| setHasFreeShippingForMatchingItems() | |
| setOrderCondition() | |
| setPurchasableIds() | Sets the related product ids |
| setScenario() (opens new window) | Sets the scenario for the model. |
| setShippingAddressCondition() | |
| toArray() (opens new window) | Converts the model into an array. |
| trigger() (opens new window) | Triggers an event. |
| validate() (opens new window) | Performs the data validation. |
| validateMultiple() (opens new window) | Validates multiple models. |
# extraFields()
Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), 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 (opens new window)
Returns
array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() (opens new window) on the format of the return value.
# getBillingAddressCondition()
View source (opens new window)
Returns
craft\elements\conditions\ElementConditionInterface (opens new window)
# getCategoryIds()
View source (opens new window)
Returns
# getCoupons()
View source (opens new window)
Returns
Throws
# getCpEditUrl()
View source (opens new window)
# getCustomerCondition()
View source (opens new window)
Returns
craft\elements\conditions\ElementConditionInterface (opens new window)
# getHasFreeShippingForMatchingItems()
View source (opens new window)
Returns
# getOrderCondition()
View source (opens new window)
Returns
craft\elements\conditions\ElementConditionInterface (opens new window)
# getPercentDiscountAsPercent()
View source (opens new window)
# getPurchasableIds()
View source (opens new window)
Returns
# getShippingAddressCondition()
View source (opens new window)
Returns
craft\elements\conditions\ElementConditionInterface (opens new window)
# hasBillingAddressCondition()
- Since
- 4.3.0
View source (opens new window)
Returns
# hasCustomerCondition()
- Since
- 4.3.0
View source (opens new window)
Returns
# hasOrderCondition()
- Since
- 4.3.0
View source (opens new window)
Returns
# hasShippingAddressCondition()
- Since
- 4.3.0
View source (opens new window)
Returns
# setBillingAddressCondition()
View source (opens new window)
Arguments
$condition(craft\elements\conditions\ElementConditionInterface (opens new window), string (opens new window), array (opens new window))
Returns
void
Throws
# setCategoryIds()
Sets the related product type ids
View source (opens new window)
Arguments
$categoryIds(integer (opens new window)[])
# setCoupons()
View source (opens new window)
Arguments
$coupons(array (opens new window))
# setCustomerCondition()
View source (opens new window)
Arguments
$condition(craft\elements\conditions\ElementConditionInterface (opens new window), string (opens new window))
Returns
void
Throws
# setHasFreeShippingForMatchingItems()
View source (opens new window)
Arguments
$value(boolean (opens new window))
Returns
void
# setOrderCondition()
View source (opens new window)
Arguments
$condition(craft\elements\conditions\ElementConditionInterface (opens new window), string (opens new window), array (opens new window))
Returns
void
Throws
# setPurchasableIds()
Sets the related product ids
View source (opens new window)
Arguments
$purchasableIds(integer (opens new window)[])
# setShippingAddressCondition()
View source (opens new window)
Arguments
$condition(craft\elements\conditions\ElementConditionInterface (opens new window), string (opens new window), array (opens new window))
Returns
void
Throws
# Protected Methods
| Method | Description |
|---|---|
| defineBehaviors() (opens new window) | Returns the behaviors to attach to this class. |
| defineRules() | Returns the validation rules for attributes. |
| extractFieldsFor() (opens new window) | 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() (opens new window) | Extracts the root field names from nested fields. |
| resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
# defineRules()
Returns the validation rules for attributes.
See rules() (opens new window) for details about what should be returned.
Models should override this method instead of rules() (opens new window) so EVENT_DEFINE_RULES (opens new window) handlers can modify the class-defined rules.
View source (opens new window)
Returns
# Constants
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |