Sale

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\Sale » 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), 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

Sale model.

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) – Match all categories
allGroups boolean (opens new window) – Match all groups
allPurchasables boolean (opens new window) – Match all purchasables
apply string (opens new window) – How the sale should be applied
applyAmount float (opens new window) – The amount field used by the apply option
applyAmountAsFlat string (opens new window)
applyAmountAsPercent string (opens new window)
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
categoryIds array (opens new window)
categoryRelationshipType string (opens new window) – Type of relationship between Categories and Products
cpEditUrl string (opens new window), false (opens new window)
dateFrom DateTime (opens new window), null (opens new window) – Date From
dateTo DateTime (opens new window), null (opens new window) – Date To
description string (opens new window) – Description
enabled boolean (opens new window) – Enabled
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
id integer (opens new window) – ID
ignorePrevious boolean (opens new window) – Ignore the previous sales that affect the purchasable
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name string (opens new window) – Name
purchasableIds array (opens new window)
scenario (opens new window) string (opens new window) – The scenario that this model is in.
sortOrder integer (opens new window) – The order index of the application of the sale
stopProcessing boolean (opens new window) – Should the sales system stop processing other sales after this one
userGroupIds array (opens new window)
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
false

Match all categories

View source (opens new window)

# allGroups

Type
boolean (opens new window)
Default value
false

Match all groups

View source (opens new window)

# allPurchasables

Type
boolean (opens new window)
Default value
false

Match all purchasables

View source (opens new window)

# apply

Type
string (opens new window)
Default value
null

How the sale should be applied

View source (opens new window)

# applyAmount

Type
float (opens new window)
Default value
null

The amount field used by the apply option

View source (opens new window)

# applyAmountAsFlat

Type
string (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# applyAmountAsPercent

Type
string (opens new window)
Default value
null
Access
Read-only

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
null

Type of relationship between Categories and Products

View source (opens new window)

# cpEditUrl

Type
string (opens new window), false (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# dateFrom

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

Date From

View source (opens new window)

# dateTo

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

Date To

View source (opens new window)

# description

Type
string (opens new window)
Default value
null

Description

View source (opens new window)

# enabled

Type
boolean (opens new window)
Default value
true

Enabled

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

ID

View source (opens new window)

# ignorePrevious

Type
boolean (opens new window)
Default value
null

Ignore the previous sales that affect the purchasable

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

Name

View source (opens new window)

# purchasableIds

Type
array (opens new window)
Default value
null

View source (opens new window)

# sortOrder

Type
integer (opens new window)
Default value
null

The order index of the application of the sale

View source (opens new window)

# stopProcessing

Type
boolean (opens new window)
Default value
null

Should the sales system stop processing other sales after this one

View source (opens new window)

# userGroupIds

Type
array (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)
__construct() (opens new window) Constructor.
__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() Returns the names of any attributes that should hold DateTime (opens new window) values.
defineRules() Returns the validation rules for attributes.
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() (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.
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).
getApplyAmountAsFlat()
getApplyAmountAsPercent()
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.
getCategoryIds()
getCpEditUrl()
getError() (opens new window) Returns the first error of the specified attribute.
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.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getPurchasableIds()
getScenario() (opens new window) Returns the scenario that this model is used in.
getUserGroupIds()
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
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.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
init() 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.
setCategoryIds() Sets the related category ids
setPurchasableIds() Sets the related purchasable ids
setScenario() (opens new window) Sets the scenario for the model.
setUserGroupIds() Sets the related user group ids
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.

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime (opens new window) values.

View source (opens new window)

Returns

string (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

array (opens new window)

# getApplyAmountAsFlat()

View source (opens new window)

Returns

string (opens new window)

# getApplyAmountAsPercent()

View source (opens new window)

Returns

string (opens new window)

# getCategoryIds()

View source (opens new window)

Returns

array (opens new window)

# getCpEditUrl()

View source (opens new window)

Returns

string (opens new window), false (opens new window)

# getPurchasableIds()

View source (opens new window)

Returns

array (opens new window)

# getUserGroupIds()

View source (opens new window)

Returns

array (opens new window)

# init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

# setCategoryIds()

Sets the related category ids

View source (opens new window)

Arguments

# setPurchasableIds()

Sets the related purchasable ids

View source (opens new window)

Arguments

# setUserGroupIds()

Sets the related user group ids

View source (opens new window)

Arguments

# Protected Methods

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

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.