Discount

Type
Class
Namespace
craft\commerce\records
Inherits
craft\commerce\records\Discount » craft\db\ActiveRecord (opens new window) » yii\db\ActiveRecord (opens new window) » yii\db\BaseActiveRecord (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), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window), yii\db\ActiveRecordInterface (opens new window)
Uses traits
yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
2.0

Discount record.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
allCategories boolean (opens new window)
allPurchasables boolean (opens new window)
appliedTo string (opens new window)
attributes (opens new window) array (opens new window) – Attribute values (name => value).
baseDiscount float (opens new window)
baseDiscountType string (opens new window)
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
billingAddressCondition array (opens new window), null (opens new window)
categories
categoryRelationshipType string (opens new window)
couponFormat string (opens new window)
customerCondition array (opens new window), null (opens new window)
dateCreated (opens new window) DateTime (opens new window), string (opens new window), null (opens new window) – Date created
dateFrom DateTime (opens new window)
dateTo DateTime (opens new window)
dateUpdated (opens new window) DateTime (opens new window), string (opens new window), null (opens new window) – Date updated
description string (opens new window)
dirtyAttributes (opens new window) array (opens new window) – The changed attribute values (name-value pairs).
discountCategories
discountPurchasables
discountUserGroups yii\db\ActiveQueryInterface (opens new window)
enabled boolean (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
excludeOnSale boolean (opens new window)
firstErrors (opens new window) array (opens new window) – The first errors.
groups craft\records\UserGroup (opens new window)
hasFreeShippingForMatchingItems boolean (opens new window)
hasFreeShippingForOrder boolean (opens new window)
id integer (opens new window)
ignoreSales boolean (opens new window)
isNewRecord (opens new window) boolean (opens new window) – Whether the record is new and should be inserted when calling save() (opens new window).
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
maxPurchaseQty integer (opens new window)
name string (opens new window)
oldAttributes (opens new window) array (opens new window) – The old attribute values (name-value pairs).
oldPrimaryKey (opens new window) mixed – The old primary key value.
orderCondition array (opens new window), null (opens new window)
orderConditionFormula string (opens new window), null (opens new window)
perEmailLimit integer (opens new window)
perItemDiscount float (opens new window)
perUserLimit integer (opens new window)
percentDiscount float (opens new window)
percentageOffSubject string (opens new window)
primaryKey (opens new window) mixed – The primary key value.
purchasables
purchaseQty integer (opens new window)
purchaseTotal float (opens new window)
relatedRecords (opens new window) array (opens new window) – An array of related records indexed by relation names.
scenario (opens new window) string (opens new window) – The scenario that this model is in.
shippingAddressCondition array (opens new window), null (opens new window)
sortOrder integer (opens new window)
stopProcessing boolean (opens new window)
totalDiscountUseLimit integer (opens new window)
totalDiscountUses integer (opens new window)
uid (opens new window) string (opens new window) – UUID
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# allCategories

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# allPurchasables

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# appliedTo

Type
string (opens new window)
Default value
null

View source (opens new window)

# baseDiscount

Type
float (opens new window)
Default value
null

View source (opens new window)

# baseDiscountType

Type
string (opens new window)
Default value
null

View source (opens new window)

# billingAddressCondition

Type
array (opens new window), null (opens new window)
Default value
null

View source (opens new window)

# categories

Default value
null
Access
Read-only

View source (opens new window)

# categoryRelationshipType

Type
string (opens new window)
Default value
null

View source (opens new window)

# couponFormat

Type
string (opens new window)
Default value
null

View source (opens new window)

# customerCondition

Type
array (opens new window), null (opens new window)
Default value
null

View source (opens new window)

# dateFrom

Type
DateTime (opens new window)
Default value
null

View source (opens new window)

# dateTo

Type
DateTime (opens new window)
Default value
null

View source (opens new window)

# description

Type
string (opens new window)
Default value
null

View source (opens new window)

# discountCategories

Default value
null
Access
Read-only

View source (opens new window)

# discountPurchasables

Default value
null
Access
Read-only

View source (opens new window)

# discountUserGroups

Type
yii\db\ActiveQueryInterface (opens new window)
Default value
null

View source (opens new window)

# enabled

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# excludeOnSale

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# groups

Type
craft\records\UserGroup (opens new window)
Default value
null

View source (opens new window)

# hasFreeShippingForMatchingItems

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# hasFreeShippingForOrder

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

View source (opens new window)

# ignoreSales

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# maxPurchaseQty

Type
integer (opens new window)
Default value
null

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

View source (opens new window)

# orderCondition

Type
array (opens new window), null (opens new window)
Default value
null

View source (opens new window)

# orderConditionFormula

Type
string (opens new window), null (opens new window)
Default value
null

View source (opens new window)

# perEmailLimit

Type
integer (opens new window)
Default value
null

View source (opens new window)

# perItemDiscount

Type
float (opens new window)
Default value
null

View source (opens new window)

# perUserLimit

Type
integer (opens new window)
Default value
null

View source (opens new window)

# percentDiscount

Type
float (opens new window)
Default value
null

View source (opens new window)

# percentageOffSubject

Type
string (opens new window)
Default value
null

View source (opens new window)

# purchasables

Default value
null
Access
Read-only

View source (opens new window)

# purchaseQty

Type
integer (opens new window)
Default value
null

View source (opens new window)

# purchaseTotal

Type
float (opens new window)
Default value
null

View source (opens new window)

# shippingAddressCondition

Type
array (opens new window), null (opens new window)
Default value
null

View source (opens new window)

# sortOrder

Type
integer (opens new window)
Default value
null

View source (opens new window)

# stopProcessing

Type
boolean (opens new window)
Default value
null

View source (opens new window)

# totalDiscountUseLimit

Type
integer (opens new window)
Default value
null

View source (opens new window)

# totalDiscountUses

Type
integer (opens new window)
Default value
null

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) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) PHP getter magic method.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) PHP setter magic method.
__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.
afterDelete() (opens new window) This method is invoked after deleting a record.
afterFind() (opens new window) This method is called when the AR object is created and populated with the query result.
afterRefresh() (opens new window) This method is called when the AR object is refreshed.
afterSave() (opens new window) This method is called at the end of inserting or updating a record.
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 all attribute names of the model.
beforeDelete() (opens new window) This method is invoked before deleting a record.
beforeSave() (opens new window) This method is called at the beginning of inserting or updating a record.
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).
delete() (opens new window) Deletes the table row corresponding to this active record.
deleteAll() (opens new window) Deletes rows in the table using the provided conditions.
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.
equals() (opens new window) Returns a value indicating whether the given active record is the same as the current one.
extraFields() (opens new window) 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.
find() (opens new window) Creates an \craft\db\ActiveQueryInterface instance for query purpose.
findAll() (opens new window) Returns a list of active record models that match the specified primary key value(s) or a set of column values.
findBySql() (opens new window) See yii\db\ActiveRecord::findBySql() (opens new window) for more info.
findOne() (opens new window) Returns a single active record model instance by a primary key or an array of column values.
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).
getAttribute() (opens new window) Returns the named attribute value.
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.
getCategories()
getDb() (opens new window) Returns the database connection used by this AR class.
getDirtyAttributes() (opens new window) Returns the attribute values that have been modified since they are loaded or saved most recently.
getDiscountCategories()
getDiscountPurchasables()
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.
getGroups()
getIsNewRecord() (opens new window) Returns a value indicating whether the current record is new.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getOldAttribute() (opens new window) Returns the old value of the named attribute.
getOldAttributes() (opens new window) Returns the old attribute values.
getOldPrimaryKey() (opens new window) Returns the old primary key value(s).
getPrimaryKey() (opens new window) Returns the primary key value(s).
getPurchasables()
getRelatedRecords() (opens new window) Returns all populated related records.
getRelation() (opens new window) Returns the relation object with the specified name.
getScenario() (opens new window) Returns the scenario that this model is used in.
getTableSchema() (opens new window) Returns the schema information of the DB table associated with this AR class.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasAttribute() (opens new window) Returns a value indicating whether the model has an attribute with the specified name.
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.
hasMany() (opens new window) See yii\db\BaseActiveRecord::hasMany() (opens new window) for more info.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasOne() (opens new window) See yii\db\BaseActiveRecord::hasOne() (opens new window) for more info.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
init() (opens new window) Initializes the object.
insert() (opens new window) Inserts a row into the associated database table using the attribute values of this record.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
instantiate() (opens new window) Creates an active record instance.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeChanged() (opens new window) Returns a value indicating whether the named attribute has been changed.
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.
isPrimaryKey() (opens new window) Returns a value indicating whether the given set of attributes represents the primary key for this model.
isRelationPopulated() (opens new window) Check whether the named relation has been populated with records.
isTransactional() (opens new window) Returns a value indicating whether the specified operation is transactional in the current scenario (opens new window).
link() (opens new window) Establishes the relationship between two models.
load() (opens new window) Populates the model with input data.
loadDefaultValues() (opens new window) Loads default values from database table schema.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
markAttributeDirty() (opens new window) Marks an attribute dirty.
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.
optimisticLock() (opens new window) Returns the name of the column that stores the lock version for implementing optimistic locking.
populateRecord() (opens new window) Populates an active record object using a row of data from the database/storage.
populateRelation() (opens new window) Populates the named relation with the related records.
primaryKey() (opens new window) Returns the primary key name(s) for this AR class.
refresh() (opens new window) Repopulates this active record with the latest data.
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.
save() (opens new window) Saves the current record.
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
setAttribute() (opens new window) Sets the named attribute value.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setIsNewRecord() (opens new window) Sets the value indicating whether the record is new.
setOldAttribute() (opens new window) Sets the old value of the named attribute.
setOldAttributes() (opens new window) Sets the old attribute values.
setScenario() (opens new window) Sets the scenario for the model.
tableName() Declares the name of the database table associated with this AR class.
toArray() (opens new window) Converts the model into an array.
transactions() (opens new window) Declares which DB operations should be performed within a transaction in different scenarios.
trigger() (opens new window) Triggers an event.
unlink() (opens new window) Destroys the relationship between two models.
unlinkAll() (opens new window) Destroys the relationship in current model.
update() (opens new window) Saves the changes to this active record into the associated database table.
updateAll() (opens new window) Updates the whole table using the provided attribute values and conditions.
updateAllCounters() (opens new window) Updates the whole table using the provided counter changes and conditions.
updateAttributes() (opens new window) Updates the specified attributes.
updateCounters() (opens new window) Updates one or several counter columns for the current AR object.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# getCategories()

View source (opens new window)

# getDiscountCategories()

View source (opens new window)

# getDiscountPurchasables()

View source (opens new window)

# getGroups()

View source (opens new window)

# getPurchasables()

View source (opens new window)

# tableName()

Declares the name of the database table associated with this AR class.

By default this method returns the class name as the table name by calling yii\helpers\Inflector::camel2id() (opens new window) with prefix yii\db\Connection::$tablePrefix (opens new window). For example if yii\db\Connection::$tablePrefix (opens new window) is tbl_, Customer becomes tbl_customer, and OrderItem becomes tbl_order_item. You may override this method if the table is not named after this convention.

View source (opens new window)

Returns

string (opens new window) – The table name

# Protected Methods

Method Description
createRelationQuery() (opens new window) Creates a query instance for has-one or has-many relation.
deleteInternal() (opens new window) Deletes an ActiveRecord without considering transaction.
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.
insertInternal() (opens new window) Inserts an ActiveRecord into DB without considering transaction.
prepareForDb() (opens new window) Sets the dateCreated, dateUpdated, and uid attributes on the record.
refreshInternal() (opens new window) Repopulates this active record with the latest data from a newly fetched instance.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
updateInternal() (opens new window)

# Constants

Constant Description
APPLIED_TO_ALL_LINE_ITEMS
APPLIED_TO_MATCHING_LINE_ITEMS
BASE_DISCOUNT_TYPE_PERCENT_ITEMS
BASE_DISCOUNT_TYPE_PERCENT_ITEMS_DISCOUNTED
BASE_DISCOUNT_TYPE_PERCENT_TOTAL
BASE_DISCOUNT_TYPE_PERCENT_TOTAL_DISCOUNTED
BASE_DISCOUNT_TYPE_VALUE
CATEGORY_RELATIONSHIP_TYPE_BOTH
CATEGORY_RELATIONSHIP_TYPE_SOURCE
CATEGORY_RELATIONSHIP_TYPE_TARGET
OP_ALL All three operations: insert, update, delete.
OP_DELETE The delete operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional.
OP_INSERT The insert operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional.
OP_UPDATE The update operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional.
SCENARIO_DEFAULT The name of the default scenario.
TYPE_DISCOUNTED_SALEPRICE
TYPE_ORIGINAL_SALEPRICE