Settings

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

Settings model.

View source

# Public Properties

Property Description
activeCartDuration integer – The default length of time a cart is considered active since its last update See craft\helpers\ConfigHelper::durationInSeconds() for a list of supported value types.
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
allowEmptyCartOnCheckout boolean – Allow the cart to be empty on checkout
attributes array – Attribute values (name => value).
autoSetNewCartAddresses boolean
behaviors yii\base\Behavior – List of behaviors attached to this component
cartVariable string
defaultView string – Default view for Commerce in the CP
defaultViewOptions array
dimensionUnits string – Dimension Units
emailSenderAddress string – Sender's email address
emailSenderAddressPlaceholder string
emailSenderName string – Sender's name
emailSenderNamePlaceholder string
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
gatewayPostRedirectTemplate string
gatewaySettings array
iterator ArrayIterator – An iterator for traversing the items in the list.
loadCartRedirectUrl string, null – The uri to redirect to after using the load cart url
minimumTotalPriceStrategy string
minimumTotalPriceStrategyOptions array
orderPdfFilenameFormat string – Order PDF file name format
orderPdfPath string – Order PDF Path
orderReferenceFormat string – The order reference format
paymentCurrency array
paymentMethodSettings array
pdfAllowRemoteImages boolean
pdfPaperOrientation string – Order PDF Orientation
pdfPaperSize string – Order PDF Size
purgeInactiveCarts boolean
purgeInactiveCartsDuration integer – The default length of time before inactive carts are purged.
requireBillingAddressAtCheckout boolean
requireShippingAddressAtCheckout boolean
requireShippingMethodSelectionAtCheckout boolean
scenario string – The scenario that this model is in.
showCustomerInfoTab boolean
updateBillingDetailsUrl string
updateCartSearchIndexes boolean – Should the search index for a cart be updated when saving the cart on the front-end.
useBillingAddressForTax boolean
validateBusinessTaxIdAsVatId boolean
validateCartCustomFieldsOnSubmission boolean
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
weightUnits string – Weight Units
weightUnitsOptions array

# activeCartDuration

Type
integer
Since
2.2

The default length of time a cart is considered active since its last update

See craft\helpers\ConfigHelper::durationInSeconds() for a list of supported value types.

View source

# allowEmptyCartOnCheckout

Type
boolean
Since
2.2

Allow the cart to be empty on checkout

View source

# autoSetNewCartAddresses

Type
boolean

View source

# cartVariable

Type
string

View source

# defaultView

Type
string
Since
2.2

Default view for Commerce in the CP

View source

# defaultViewOptions

Type
array
Access
Read-only
Since
2.2

View source

# dimensionUnits

Type
string

Dimension Units

View source

# emailSenderAddress

Type
string

Sender's email address

View source

# emailSenderAddressPlaceholder

Type
string

View source

# emailSenderName

Type
string

Sender's name

View source

# emailSenderNamePlaceholder

Type
string

View source

# gatewayPostRedirectTemplate

Type
string

View source

# gatewaySettings

Type
array

View source

# loadCartRedirectUrl

Type
string, null
Since
3.1

The uri to redirect to after using the load cart url

View source

# minimumTotalPriceStrategy

Type
string

View source

# minimumTotalPriceStrategyOptions

Type
array
Access
Read-only

View source

# orderPdfFilenameFormat

Type
string

Order PDF file name format

View source

# orderPdfPath

Type
string

Order PDF Path

View source

# orderReferenceFormat

Type
string

The order reference format

View source

# paymentCurrency

Type
array

View source

# paymentMethodSettings

Type
array

View source

# pdfAllowRemoteImages

Type
boolean

View source

# pdfPaperOrientation

Type
string

Order PDF Orientation

View source

# pdfPaperSize

Type
string

Order PDF Size

View source

# purgeInactiveCarts

Type
boolean

View source

# purgeInactiveCartsDuration

Type
integer

The default length of time before inactive carts are purged. Default: 90 days

See craft\helpers\ConfigHelper::durationInSeconds() for a list of supported value types.

View source

# requireBillingAddressAtCheckout

Type
boolean

View source

# requireShippingAddressAtCheckout

Type
boolean

View source

# requireShippingMethodSelectionAtCheckout

Type
boolean

View source

# showCustomerInfoTab

Type
boolean
Since
3.0

View source

# updateBillingDetailsUrl

Type
string

View source

# updateCartSearchIndexes

Type
boolean
Since
3.1.5

Should the search index for a cart be updated when saving the cart on the front-end.

View source

# useBillingAddressForTax

Type
boolean

View source

# validateBusinessTaxIdAsVatId

Type
boolean

View source

# validateCartCustomFieldsOnSubmission

Type
boolean
Since
3.0.12

View source

# weightUnits

Type
string

Weight Units

View source

# weightUnitsOptions

Type
array
Access
Read-only

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__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.
defineRules() Returns the validation rules for attributes.
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.
getDefaultViewOptions()
getDimensionUnits()
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.
getMinimumTotalPriceStrategyOptions()
getPaymentCurrency()
getScenario() Returns the scenario that this model is used in.
getValidators() Returns all the validators declared in rules().
getWeightUnitsOptions()
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.
setScenario() Sets the scenario for the model.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# 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

# getDefaultViewOptions()

Since
2.2

View source

Returns

array

# getDimensionUnits()

View source

Returns

array

# getMinimumTotalPriceStrategyOptions()

View source

Returns

array

# getPaymentCurrency()

View source

Arguments

Returns

string, null

Throws

# getWeightUnitsOptions()

View source

Returns

array

# Protected Methods

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

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_CUSTOMERS
VIEW_URI_ORDERS
VIEW_URI_PRODUCTS
VIEW_URI_PROMOTIONS
VIEW_URI_SHIPPING
VIEW_URI_SUBSCRIPTIONS
VIEW_URI_TAX