ShippingMethods

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

Shipping method service.

View source

Public Properties

PropertyDescription
$allShippingMethodscraft\commerce\models\ShippingMethod[]
$behaviorsyii\base\Behavior – List of behaviors attached to this component

$allShippingMethods

Signature

public craft\commerce\models\ShippingMethod[] getAllShippingMethods ( )

Public Methods

MethodDescription
__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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
deleteShippingMethodById()Delete a shipping method by its 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.
getAllShippingMethods()Returns the Commerce managed and 3rd party shipping methods
getAvailableShippingMethods()Get all available shipping methods.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getMatchingShippingRule()Get a matching shipping rule for Order and shipping method.
getOrderedAvailableShippingMethods()
getShippingMethodByHandle()Get a shipping method by its handle.
getShippingMethodById()Get a shipping method 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.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
saveShippingMethod()Save a shipping method.
trigger()Triggers an event.

deleteShippingMethodById()

Delete a shipping method by its ID.

View source

Arguments

  • $shippingMethodId – Int

Returns

boolean

Signature

public boolean deleteShippingMethodById ( $shippingMethodId )

getAllShippingMethods()

Returns the Commerce managed and 3rd party shipping methods

View source

Returns

craft\commerce\models\ShippingMethod[]

Signature

public craft\commerce\models\ShippingMethod[] getAllShippingMethods ( )

getAvailableShippingMethods()

Get all available shipping methods.

View source

Arguments

Returns

array

Signature

public array getAvailableShippingMethods ( craft\commerce\elements\Order $cart )

getMatchingShippingRule()

Get a matching shipping rule for Order and shipping method.

View source

Arguments

Returns

boolean, craft\commerce\base\ShippingRuleInterface

Signature

public boolean, craft\commerce\base\ShippingRuleInterface getMatchingShippingRule ( craft\commerce\elements\Order $order, $method )

getOrderedAvailableShippingMethods()

DEPRECATED

Deprecated as of 2.0

View source

Arguments

Returns

array

Signature

public array getOrderedAvailableShippingMethods ( craft\commerce\elements\Order $cart )

getShippingMethodByHandle()

Get a shipping method by its handle.

View source

Arguments

  • $shippingMethodHandle (string)

Returns

craft\commerce\models\ShippingMethod, null

Signature

public craft\commerce\models\ShippingMethod, null getShippingMethodByHandle ( \craft\commerce\services\string $shippingMethodHandle )

getShippingMethodById()

Get a shipping method by its ID.

View source

Arguments

Returns

craft\commerce\models\ShippingMethod, null

Signature

public craft\commerce\models\ShippingMethod, null getShippingMethodById ( \craft\commerce\services\int $shippingMethodId )

saveShippingMethod()

Save a shipping method.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveShippingMethod ( craft\commerce\models\ShippingMethod $model, \craft\commerce\services\bool $runValidation = true )

Events

EVENT_REGISTER_AVAILABLE_SHIPPING_METHODS

Type
\craft\commerce\services\RegisterShippingMethods

The event that is triggered when registering additional shipping methods for the cart.