Commerce 3 Class Reference

ShippingMethods

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\ShippingMethods » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
2.0

Shipping method service.

View source (opens new window)

# Public Properties

Property Description
allShippingMethods craft\commerce\models\ShippingMethod[] – the Commerce managed and 3rd party shipping methods
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
liteShippingMethod craft\commerce\models\ShippingMethod

# allShippingMethods

Type
craft\commerce\models\ShippingMethod[]
Default value
null

the Commerce managed and 3rd party shipping methods

View source (opens new window)

# liteShippingMethod

Type
craft\commerce\models\ShippingMethod
Default value
null

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) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__unset() (opens new window) Sets a component property to be null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
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.
deleteShippingMethodById() Delete a shipping method by its ID.
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.
getAllShippingMethods() Returns the Commerce managed shipping methods stored in the database.
getAvailableShippingMethods() Get all available shipping methods to the order.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getLiteShippingMethod() Gets the the lite shipping method or returns a new one.
getMatchingShippingRule() Get a matching shipping rule for Order and shipping method.
getShippingMethodByHandle() Get a shipping method by its handle.
getShippingMethodById() Get a shipping method by its ID.
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 for this component.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
saveLiteShippingMethod() Save a lite shipping method.
saveShippingMethod() Save a shipping method.
trigger() (opens new window) Triggers an event.

# deleteShippingMethodById()

Delete a shipping method by its ID.

View source (opens new window)

Arguments

  • $shippingMethodId – Int

Returns

boolean (opens new window)

# getAllShippingMethods()

Returns the Commerce managed shipping methods stored in the database.

View source (opens new window)

Returns

craft\commerce\models\ShippingMethod[]

# getAvailableShippingMethods()

Get all available shipping methods to the order.

View source (opens new window)

Arguments

Returns

craft\commerce\models\ShippingMethod[]

# getLiteShippingMethod()

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

View source (opens new window)

Returns

craft\commerce\models\ShippingMethod

# getMatchingShippingRule()

Get a matching shipping rule for Order and shipping method.

View source (opens new window)

Arguments

Returns

boolean (opens new window), craft\commerce\base\ShippingRuleInterface

# getShippingMethodByHandle()

Get a shipping method by its handle.

View source (opens new window)

Arguments

Returns

craft\commerce\models\ShippingMethod, null (opens new window)

# getShippingMethodById()

Get a shipping method by its ID.

View source (opens new window)

Arguments

Returns

craft\commerce\models\ShippingMethod, null (opens new window)

# saveLiteShippingMethod()

Save a lite shipping method.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# saveShippingMethod()

Save a shipping method.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# Events

# EVENT_REGISTER_AVAILABLE_SHIPPING_METHODS

Type
craft\commerce\services\RegisterShippingMethods

The event that is triggered for registration of additional shipping methods.

This example adds an instance of MyShippingMethod to the event object’s shippingMethods array:

use craft\events\RegisterComponentTypesEvent;
use craft\commerce\services\ShippingMethods;
use yii\base\Event;

Event::on(
    ShippingMethods::class,
    ShippingMethods::EVENT_REGISTER_AVAILABLE_SHIPPING_METHODS,
    function(RegisterComponentTypesEvent $event) {
        $event->shippingMethods[] = MyShippingMethod::class;
    }
);

← ShippingRuleCategories →