ShippingRules

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\ShippingRules » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Shipping rule service.

View source

# Public Properties

# allShippingRules

Type
craft\commerce\models\ShippingRule[]
Access
Read-only

View source

# liteShippingRule

Type
craft\commerce\models\ShippingRule
Access
Read-only

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() 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.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
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.
deleteShippingRuleById() Deletes a shipping rule by an ID.
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.
getAllShippingRules() Get all shipping rules.
getAllShippingRulesByShippingMethodId() Get all shipping rules by a shipping method ID.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getLiteShippingRule() Gets the the lite shipping rule or returns a new one.
getShippingRuleById() Get a shipping rule by its ID.
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.
off() Detaches an existing event handler from this component.
on() Attaches an event handler to an event.
reorderShippingRules() Reorders shipping rules by the given array of IDs.
saveLiteShippingRule() Save a shipping rule.
saveShippingRule() Save a shipping rule.
trigger() Triggers an event.

# deleteShippingRuleById()

Deletes a shipping rule by an ID.

View source

Arguments

Returns

boolean

# getAllShippingRules()

Get all shipping rules.

View source

Returns

craft\commerce\models\ShippingRule[]

# getAllShippingRulesByShippingMethodId()

Get all shipping rules by a shipping method ID.

View source

Arguments

Returns

craft\commerce\models\ShippingRule[]

# getLiteShippingRule()

Gets the the lite shipping rule or returns a new one.

View source

Returns

craft\commerce\models\ShippingRule

# getShippingRuleById()

Get a shipping rule by its ID.

View source

Arguments

Returns

craft\commerce\models\ShippingRule, null

# reorderShippingRules()

Reorders shipping rules by the given array of IDs.

View source

Arguments

Returns

boolean

# saveLiteShippingRule()

Save a shipping rule.

View source

Arguments

Returns

boolean

Throws

# saveShippingRule()

Save a shipping rule.

View source

Arguments

Returns

boolean

Throws