Commerce 2 Class Reference

Settings

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

Settings model.

View source (opens new window)

# Public Properties

Property Description
activeCartDuration string (opens new window)
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
allowEmptyCartOnCheckout boolean (opens new window) – Allow the cart to be empty on checkout
attributes (opens new window) array (opens new window) – Attribute values (name => value).
autoSetNewCartAddresses boolean (opens new window)
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
cartVariable string (opens new window)
defaultView string (opens new window) – Default view for Commerce in the CP
defaultViewOptions array (opens new window)
dimensionUnits string (opens new window) – Dimension Units
emailSenderAddress string (opens new window) – Sender's email address
emailSenderAddressPlaceholder string (opens new window)
emailSenderName string (opens new window) – Sender's name
emailSenderNamePlaceholder string (opens new window)
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.
gatewayPostRedirectTemplate string (opens new window)
gatewaySettings array (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
mergeLastCartOnLogin boolean (opens new window)
minimumTotalPriceStrategy string (opens new window)
minimumTotalPriceStrategyOptions array (opens new window)
orderPdfFilenameFormat string (opens new window) – Order PDF file name format
orderPdfPath string (opens new window) – Order PDF Path
orderReferenceFormat string (opens new window) – The order reference format
paymentCurrency array (opens new window)
paymentMethodSettings array (opens new window)
pdfAllowRemoteImages boolean (opens new window)
pdfPaperOrientation string (opens new window) – Order PDF Orientation
pdfPaperSize string (opens new window) – Order PDF Size
purgeInactiveCarts boolean (opens new window)
purgeInactiveCartsDuration string (opens new window)
requireBillingAddressAtCheckout boolean (opens new window)
requireShippingAddressAtCheckout boolean (opens new window)
requireShippingMethodSelectionAtCheckout boolean (opens new window)
scenario (opens new window) string (opens new window) – The scenario that this model is in.
updateBillingDetailsUrl string (opens new window)
useBillingAddressForTax boolean (opens new window)
validateBusinessTaxIdAsVatId boolean (opens new window)
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
weightUnits string (opens new window) – Weight Units
weightUnitsOptions array (opens new window)

# activeCartDuration

Type
string (opens new window)
Since
2.2

View source (opens new window)

# allowEmptyCartOnCheckout

Type
boolean (opens new window)
Since
2.2

Allow the cart to be empty on checkout

View source (opens new window)

# autoSetNewCartAddresses

Type
boolean (opens new window)

View source (opens new window)

# cartVariable

Type
string (opens new window)

View source (opens new window)

# defaultView

Type
string (opens new window)
Since
2.2

Default view for Commerce in the CP

View source (opens new window)

# defaultViewOptions

Type
array (opens new window)
Access
Read-only
Since
2.2

View source (opens new window)

# dimensionUnits

Type
string (opens new window)

Dimension Units

View source (opens new window)

# emailSenderAddress

Type
string (opens new window)

Sender's email address

View source (opens new window)

# emailSenderAddressPlaceholder

Type
string (opens new window)

View source (opens new window)

# emailSenderName

Type
string (opens new window)

Sender's name

View source (opens new window)

# emailSenderNamePlaceholder

Type
string (opens new window)

View source (opens new window)

# gatewayPostRedirectTemplate

Type
string (opens new window)

View source (opens new window)

# gatewaySettings

Type
array (opens new window)

View source (opens new window)

# mergeLastCartOnLogin

Type
boolean (opens new window)

View source (opens new window)

# minimumTotalPriceStrategy

Type
string (opens new window)

View source (opens new window)

# minimumTotalPriceStrategyOptions

Type
array (opens new window)
Access
Read-only

View source (opens new window)

# orderPdfFilenameFormat

Type
string (opens new window)

Order PDF file name format

View source (opens new window)

# orderPdfPath

Type
string (opens new window)

Order PDF Path

View source (opens new window)

# orderReferenceFormat

Type
string (opens new window)

The order reference format

View source (opens new window)

# paymentCurrency

Type
array (opens new window)

View source (opens new window)

# paymentMethodSettings

Type
array (opens new window)

View source (opens new window)

# pdfAllowRemoteImages

Type
boolean (opens new window)

View source (opens new window)

# pdfPaperOrientation

Type
string (opens new window)

Order PDF Orientation

View source (opens new window)

# pdfPaperSize

Type
string (opens new window)

Order PDF Size

View source (opens new window)

# purgeInactiveCarts

Type
boolean (opens new window)

View source (opens new window)

# purgeInactiveCartsDuration

Type
string (opens new window)

View source (opens new window)

# requireBillingAddressAtCheckout

Type
boolean (opens new window)

View source (opens new window)

# requireShippingAddressAtCheckout

Type
boolean (opens new window)

View source (opens new window)

# requireShippingMethodSelectionAtCheckout

Type
boolean (opens new window)

View source (opens new window)

# updateBillingDetailsUrl

Type
string (opens new window)

View source (opens new window)

# useBillingAddressForTax

Type
boolean (opens new window)

View source (opens new window)

# validateBusinessTaxIdAsVatId

Type
boolean (opens new window)

View source (opens new window)

# weightUnits

Type
string (opens new window)

Weight Units

View source (opens new window)

# weightUnitsOptions

Type
array (opens new window)
Access
Read-only

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 an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to 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() (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).
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.
getDefaultViewOptions()
getDimensionUnits()
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.
getMinimumTotalPriceStrategyOptions()
getPaymentCurrency()
getScenario() (opens new window) Returns the scenario that this model is used in.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
getWeightUnitsOptions()
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.
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() 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.
setScenario() (opens new window) Sets the scenario for the model.
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.

# getDefaultViewOptions()

Since
2.2

View source (opens new window)

Returns

array (opens new window)

# getDimensionUnits()

View source (opens new window)

Returns

array (opens new window)

# getMinimumTotalPriceStrategyOptions()

View source (opens new window)

Returns

array (opens new window)

# getPaymentCurrency()

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

Throws

# getWeightUnitsOptions()

View source (opens new window)

Returns

array (opens new window)

# rules()

Returns the validation rules for attributes.

Validation rules are used by validate() (opens new window) 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 (opens new window) 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 built-in validators (opens new window). 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 (opens new window)

Returns

array (opens new window) – Validation rules

# Protected Methods

Method Description
defineRules() (opens new window) 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).

# Constants

Constant Description
MINIMUM_TOTAL_PRICE_STRATEGY_DEFAULT
MINIMUM_TOTAL_PRICE_STRATEGY_SHIPPING
MINIMUM_TOTAL_PRICE_STRATEGY_ZERO
SCENARIO_DEFAULT The name of the default scenario.
VIEW_URI_ORDERS
VIEW_URI_PRODUCTS
VIEW_URI_PROMOTIONS
VIEW_URI_SHIPPING
VIEW_URI_SUBSCRIPTIONS
VIEW_URI_TAX

← ShippingAddressZone →