OrderAdjustments

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

Order adjustment service.

View source

Public Properties

PropertyDescription
$adjusterscraft\commerce\base\AdjusterInterface[]
$behaviorsyii\base\Behavior – List of behaviors attached to this component

$adjusters

Signature

public craft\commerce\base\AdjusterInterface[] getAdjusters ( )

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.
deleteAllOrderAdjustmentsByOrderId()Delete all adjustments belonging to an order by its ID.
deleteOrderAdjustmentByAdjustmentId()Delete an order adjustment 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.
getAdjusters()Get all order adjusters.
getAllOrderAdjustmentsByOrderId()Get all order adjustments by order's ID.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
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.
saveOrderAdjustment()Save an order adjustment.
trigger()Triggers an event.

deleteAllOrderAdjustmentsByOrderId()

Delete all adjustments belonging to an order by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteAllOrderAdjustmentsByOrderId ( $orderId )

deleteOrderAdjustmentByAdjustmentId()

Delete an order adjustment by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteOrderAdjustmentByAdjustmentId ( $adjustmentId )

getAdjusters()

Get all order adjusters.

View source

Returns

craft\commerce\base\AdjusterInterface[]

Signature

public craft\commerce\base\AdjusterInterface[] getAdjusters ( )

getAllOrderAdjustmentsByOrderId()

Get all order adjustments by order's ID.

View source

Arguments

Returns

craft\commerce\models\OrderAdjustment[]

Signature

public craft\commerce\models\OrderAdjustment[] getAllOrderAdjustmentsByOrderId ( $orderId )

saveOrderAdjustment()

Save an order adjustment.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveOrderAdjustment ( craft\commerce\models\OrderAdjustment $orderAdjustment, \craft\commerce\services\bool $runValidation = true )

Events

EVENT_REGISTER_ORDER_ADJUSTERS

Type
craft\events\RegisterComponentTypesEvent

This event is raised when compiling the list of adjusters for an order

Plugins can register their own adjusters.

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

Event::on(OrderAdjustments::class, OrderAdjustments::EVENT_REGISTER_ORDER_ADJUSTERS, function(RegisterComponentTypesEvent $e) {
    $e->types[] = MyAdjuster::class;
});