ShippingRule

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\ShippingRule » 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, craft\commerce\base\ShippingRuleInterface, 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

2.0

Shipping rule model

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
baseRate	float – Base rate
behaviors	yii\base\Behavior – List of behaviors attached to this component.
dateCreated	DateTime, null
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
isEnabled	boolean – whether this shipping rule enabled for listing and selection
iterator	ArrayIterator – An iterator for traversing the items in the list.
maxRate	float – Maximum rate
methodId	integer, null – Shipping method ID
minRate	float – Minimum Rate
name	string, null – Name
options	array
orderCondition	craft\commerce\elements\conditions\orders\ShippingRuleOrderCondition
orderConditionFormula	string, null – Order Condition Formula
perItemRate	float – Per item rate
percentageRate	float – Percentage rate
priority	integer – Priority
scenario	string – The scenario that this model is in.
shippingRuleCategories	array, craft\commerce\models\ShippingRuleCategory[]
store	craft\commerce\models\Store
storeId	integer, null – Store ID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
weightRate	float – Weight rate

baseRate

Type

float

Default value

0

Base rate

View source

dateCreated

Type

DateTime, null

Default value

null

Since

3.4

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

isEnabled

Type

boolean

Default value

null

whether this shipping rule enabled for listing and selection

View source

maxRate

Type

float

Default value

0

Maximum rate

View source

methodId

Type

integer, null

Default value

null

Shipping method ID

View source

minRate

Type

float

Default value

0

Minimum Rate

View source

name

Type

string, null

Default value

null

Name

View source

options

Type

array

Default value

null

View source

orderCondition

Type

craft\commerce\elements\conditions\orders\ShippingRuleOrderCondition

Default value

null

Since

5.0.0

View source

orderConditionFormula

Type

string, null

Default value

''

Order Condition Formula

View source

perItemRate

Type

float

Default value

0

Per item rate

View source

percentageRate

Type

float

Default value

0

Percentage rate

View source

priority

Type

integer

Default value

0

Priority

View source

shippingRuleCategories

Type

array, craft\commerce\models\ShippingRuleCategory[]

Default value

null

View source

weightRate

Type

float

Default value

0

Weight rate

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()	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.
getBaseRate()	Returns a base shipping cost. This is added at the order level.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getDescription()	Returns a description of the rates applied by this rule; Zero will not make any changes.
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.
getIsEnabled()	Returns whether this shipping rule is enabled for listing and selection.
getIterator()	Returns an iterator for traversing the attributes in the model.
getMaxRate()
getMinRate()	Returns a min cost this rule should have applied.
getOptions()	Returns this data as json on the order's shipping adjustment.
getOrderCondition()
getPerItemRate()	Returns the flat rate that is multiplied per qty.
getPercentageRate()	Returns the percentage rate that is multiplied per line item subtotal.
getScenario()	Returns the scenario that this model is used in.
getShippingRuleCategories()
getStore()
getValidators()	Returns all the validators declared in rules().
getWeightRate()	Returns the rate that is multiplied by the line item's weight.
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.
matchOrder()	Returns whether this rule a match on the order. If false is returned, the shipping engine tries the next rule.
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.
setOrderCondition()
setScenario()	Sets the scenario for the model.
setShippingRuleCategories()
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.
validateShippingRuleCategories()

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

getBaseRate()

Returns a base shipping cost. This is added at the order level.

Zero will not make any changes.

View source

getDescription()

Returns a description of the rates applied by this rule; Zero will not make any changes.

View source

getIsEnabled()

Returns whether this shipping rule is enabled for listing and selection.

View source

getMaxRate()

View source

getMinRate()

Returns a min cost this rule should have applied.

If the total of your rates as applied to the order are less than this, the baseShippingCost on the order is modified to meet this min rate. Zero will not make any changes.

View source

getOptions()

Returns this data as json on the order's shipping adjustment.

View source

Returns

mixed

getOrderCondition()

Since

5.0.0

View source

Returns

craft\commerce\elements\conditions\orders\ShippingRuleOrderCondition

getPerItemRate()

Returns the flat rate that is multiplied per qty.

Zero will not make any changes.

View source

Arguments

• $shippingCategoryId (integer, null) – The shipping category ID for the rate requested. A null category ID should use the default shipping category set up in Craft Commerce.

getPercentageRate()

Returns the percentage rate that is multiplied per line item subtotal.

Zero will not make any changes.

View source

Arguments

• $shippingCategoryId (integer, null) – The shipping category ID for the rate requested. A null category ID should use the default shipping category set up in Craft Commerce.

getShippingRuleCategories()

View source

Returns

craft\commerce\models\ShippingRuleCategory[]

Throws

• yii\base\InvalidConfigException

getWeightRate()

Returns the rate that is multiplied by the line item's weight.

Zero will not make any changes.

View source

Arguments

• $shippingCategoryId (integer, null) – The shipping category ID for the rate requested. A null category ID should use the default shipping category set up in Craft Commerce.

matchOrder()

Returns whether this rule a match on the order. If false is returned, the shipping engine tries the next rule.

View source

Arguments

• $order

setOrderCondition()

Since

5.0.0

View source

Arguments

• $condition (craft\commerce\elements\conditions\orders\ShippingRuleOrderCondition, string, array, null)

Returns

void

Throws

• yii\base\InvalidConfigException

setShippingRuleCategories()

View source

Arguments

• $models (craft\commerce\models\ShippingRuleCategory[])

validateShippingRuleCategories()

Since

3.2.7

View source

Arguments

• $attribute

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.