CatalogPricingRule

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\CatalogPricingRule » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\commerce\base\HasStoreInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\commerce\base\StoreTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

5.0.0

Catalog Pricing Rule model.

View source

Public Properties

Property	Description
_customerCondition	craft\elements\conditions\ElementConditionInterface, null
_productCondition	craft\elements\conditions\ElementConditionInterface, null
_purchasableCondition	craft\elements\conditions\ElementConditionInterface, null
_variantCondition	craft\elements\conditions\ElementConditionInterface, null
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
apply	string – How the sale should be applied
applyAmount	float, null – The amount field used by the apply option
applyAmountAsFlat	string
applyAmountAsPercent	string
applyPriceType	string
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
cpEditUrl	string, false
customerCondition	string, array, craft\elements\conditions\ElementConditionInterface
dateCreated	DateTime, null
dateFrom	DateTime, null – Date From
dateTo	DateTime, null – Date To
dateUpdated	DateTime, null
description	string, null – Description
enabled	boolean – Enabled
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
id	integer, null – ID
isPromotionalPrice	boolean
iterator	ArrayIterator – An iterator for traversing the items in the list.
metadata	array
name	string, null – Name
productCondition	string, array, craft\elements\conditions\ElementConditionInterface
purchasableCondition	string, array, craft\elements\conditions\ElementConditionInterface
purchasableIds	array
scenario	string – The scenario that this model is in.
store	craft\commerce\models\Store
storeId	integer, null – Store ID
userIds	integer[], null
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
variantCondition	string, array, craft\elements\conditions\ElementConditionInterface

_customerCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getCustomerCondition()
• setCustomerCondition()

View source

_productCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getProductCondition()
• setProductCondition()

View source

_purchasableCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getPurchasableCondition()
• setPurchasableCondition()

View source

_variantCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

See also:

• getVariantCondition()
• setVariantCondition()

View source

apply

Type

string

Default value

\craft\commerce\records\CatalogPricingRule::APPLY_BY_PERCENT

How the sale should be applied

View source

applyAmount

Type

float, null

Default value

null

The amount field used by the apply option

View source

applyAmountAsFlat

Type

string

Default value

null

View source

applyAmountAsPercent

Type

string

Default value

null

View source

applyPriceType

Type

string

Default value

\craft\commerce\records\CatalogPricingRule::APPLY_PRICE_TYPE_PRICE

View source

cpEditUrl

Type

string, false

Default value

null

View source

customerCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

dateCreated

Type

DateTime, null

Default value

null

Since

3.4

View source

dateFrom

Type

DateTime, null

Default value

null

Date From

View source

dateTo

Type

DateTime, null

Default value

null

Date To

View source

dateUpdated

Type

DateTime, null

Default value

null

Since

3.4

View source

description

Type

string, null

Default value

null

Description

View source

enabled

Type

boolean

Default value

true

Enabled

View source

id

Type

integer, null

Default value

null

ID

View source

isPromotionalPrice

Type

boolean

Default value

false

View source

metadata

Type

array

Default value

null

View source

name

Type

string, null

Default value

null

Name

View source

productCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

purchasableCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

purchasableIds

Type

array

Default value

null

View source

userIds

Type

integer[], null

Default value

null

Access

Read-only

View source

variantCondition

Type

string, array, craft\elements\conditions\ElementConditionInterface

Default value

null

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()
__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.
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()
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.
getApplyAmountAsFlat()
getApplyAmountAsPercent()
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.
getCpEditUrl()
getCustomerCondition()
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.
getMetadata()
getProductCondition()
getPurchasableCondition()
getPurchasableIds()
getRulePriceFromPrice()
getScenario()	Returns the scenario that this model is used in.
getStore()
getUserIds()
getValidators()	Returns all the validators declared in rules().
getVariantCondition()
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.
setCustomerCondition()
setMetadata()
setProductCondition()
setPurchasableCondition()
setScenario()	Sets the scenario for the model.
setVariantCondition()
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

extraFields()

View source

Returns

array

getApplyAmountAsFlat()

View source

Returns

string

getApplyAmountAsPercent()

View source

Returns

string

getCpEditUrl()

View source

getCustomerCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getMetadata()

View source

Returns

array

getProductCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getPurchasableCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

getPurchasableIds()

View source

Returns

integer[], null

getRulePriceFromPrice()

View source

Arguments

• $price (float)

Returns

float

getUserIds()

View source

Returns

integer[], null

getVariantCondition()

View source

Returns

craft\elements\conditions\ElementConditionInterface

setCustomerCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

setMetadata()

View source

Arguments

• $metadata (string, array)

Returns

void

setProductCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

setPurchasableCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

setVariantCondition()

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array)

Returns

void

Throws

• yii\base\InvalidConfigException

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
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().

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

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.