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

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$allCategoriesboolean – Match all product types
$allGroupsboolean – Match all user groups.
$allPurchasablesboolean – Match all products
$attributesarray – Attribute values (name => value).
$baseDiscountfloat – Base amount of discount
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$categoryIdsarray
$codestring – Coupon Code
$cpEditUrlstring, false
$dateCreatedDateTime, null
$dateFromDateTime, null – Date the discount is valid from
$dateToDateTime, null – Date the discount is valid to
$dateUpdatedDateTime, null
$descriptionstring – The description of this discount
$enabledboolean – Discount enabled?
$errorsarray – Errors for all attributes or the specified attribute.
$excludeOnSaleboolean – Exclude on sale purchasables
$firstErrorsarray – The first errors.
$freeShippingboolean – Order has free shipping.
$idinteger – ID
$iteratorArrayIterator – An iterator for traversing the items in the list.
$maxPurchaseQtyinteger – Total maximum spend on matching items
$namestring – Name of the discount
$perEmailLimitinteger – Per email coupon use limit
$perItemDiscountfloat – Amount of discount per item
$perUserLimitinteger – Per user coupon use limit
$percentDiscountfloat – Percentage of amount discount per item
$percentDiscountAsPercentstring
$percentageOffSubjectstring – Whether the discount is off the original price, or the already discount price.
$purchasableIdsarray
$purchaseQtyinteger – Total minimum qty of matching items
$purchaseTotalfloat – Total minimum spend on matching items
$scenariostring – The scenario that this model is in.
$sortOrderinteger – SortOrder
$stopProcessingboolean – StopProcessing
$totalUseLimitinteger – Total use limit by guests or users
$totalUsesinteger – Total use counter;
$userGroupIdsarray
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$allCategories

Type
boolean

Match all product types

View source

Signature

public boolean $allCategories = null

$allGroups

Type
boolean

Match all user groups.

View source

Signature

public boolean $allGroups = null

$allPurchasables

Type
boolean

Match all products

View source

Signature

public boolean $allPurchasables = null

$baseDiscount

Type
float

Base amount of discount

View source

Signature

public float $baseDiscount = 0

$categoryIds

Signature

public array getCategoryIds ( )
public void setCategoryIds ( array $categoryIds )

$code

Type
string

Coupon Code

View source

Signature

public string $code = null

$cpEditUrl

Type
string, false
Access
Read-only

View source

Signature

public string, false getCpEditUrl ( )

$dateCreated

Signature

public DateTime, null $dateCreated = null

$dateFrom

Type
DateTime, null

Date the discount is valid from

View source

Signature

public DateTime, null $dateFrom = null

$dateTo

Type
DateTime, null

Date the discount is valid to

View source

Signature

public DateTime, null $dateTo = null

$dateUpdated

Signature

public DateTime, null $dateUpdated = null

$description

Type
string

The description of this discount

View source

Signature

public string $description = null

$enabled

Type
boolean

Discount enabled?

View source

Signature

public boolean $enabled = true

$excludeOnSale

Type
boolean

Exclude on sale purchasables

View source

Signature

public boolean $excludeOnSale = null

$freeShipping

Type
boolean

Order has free shipping.

View source

Signature

public boolean $freeShipping = null

$id

Signature

public integer $id = null

$maxPurchaseQty

Type
integer

Total maximum spend on matching items

View source

Signature

public integer $maxPurchaseQty = 0

$name

Type
string

Name of the discount

View source

Signature

public string $name = null

$perEmailLimit

Type
integer

Per email coupon use limit

View source

Signature

public integer $perEmailLimit = 0

$perItemDiscount

Type
float

Amount of discount per item

View source

Signature

public float $perItemDiscount = null

$perUserLimit

Type
integer

Per user coupon use limit

View source

Signature

public integer $perUserLimit = 0

$percentDiscount

Type
float

Percentage of amount discount per item

View source

Signature

public float $percentDiscount = null

$percentDiscountAsPercent

Type
string
Access
Read-only

View source

Signature

public string getPercentDiscountAsPercent ( )

$percentageOffSubject

Type
string

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

View source

Signature

public string $percentageOffSubject = null

$purchasableIds

Signature

public array getPurchasableIds ( )
public void setPurchasableIds ( array $purchasableIds )

$purchaseQty

Type
integer

Total minimum qty of matching items

View source

Signature

public integer $purchaseQty = 0

$purchaseTotal

Type
float

Total minimum spend on matching items

View source

Signature

public float $purchaseTotal = 0

$sortOrder

Type
integer

SortOrder

View source

Signature

public integer $sortOrder = null

$stopProcessing

Type
boolean

StopProcessing

View source

Signature

public boolean $stopProcessing = null

$totalUseLimit

Type
integer

Total use limit by guests or users

View source

Signature

public integer $totalUseLimit = 0

$totalUses

Type
integer

Total use counter;

View source

Signature

public integer $totalUses = 0

$userGroupIds

Signature

public array getUserGroupIds ( )
public void setUserGroupIds ( array $userGroupIds )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
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.
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
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[]

Signature

public string[] datetimeAttributes ( )

getCategoryIds()

Signature

public array getCategoryIds ( )

getCpEditUrl()

Signature

public string, false getCpEditUrl ( )

getPercentDiscountAsPercent()

Signature

public string getPercentDiscountAsPercent ( )

getPurchasableIds()

Signature

public array getPurchasableIds ( )

getUserGroupIds()

Signature

public array getUserGroupIds ( )

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\models\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\models\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 ( )

setCategoryIds()

Sets the related product type ids

View source

Arguments

Signature

public void setCategoryIds ( array $categoryIds )

setPurchasableIds()

Sets the related product ids

View source

Arguments

Signature

public void setPurchasableIds ( array $purchasableIds )

setUserGroupIds()

Sets the related user group ids

View source

Arguments

Signature

public void setUserGroupIds ( array $userGroupIds )

Protected Methods

MethodDescription
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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.