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.
Public Properties ​
| Property | Description |
|---|---|
| adjusters | craft\commerce\base\AdjusterInterface[] |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| discountAdjusters | array |
adjusters ​
- Type
- craft\commerce\base\AdjusterInterface[]
- Default value
null
discountAdjusters ​
- Type
- array
- Default value
null
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. |
| 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. |
| eagerLoadOrderAdjustmentsForOrders() | |
| 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. |
| getDiscountAdjusters() | |
| getOrderAdjustmentById() | |
| 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. |
| saveOrderAdjustment() | Save an order adjustment. |
| trigger() | Triggers an event. |
deleteAllOrderAdjustmentsByOrderId() ​
Delete all adjustments belonging to an order by its ID.
Arguments ​
$orderId
deleteOrderAdjustmentByAdjustmentId() ​
Delete an order adjustment by its ID.
Arguments ​
$adjustmentId
Throws ​
eagerLoadOrderAdjustmentsForOrders() ​
- Since
- 3.2.0
Arguments ​
$orders(array, craft\commerce\elements\Order[])
Returns ​
craft\commerce\elements\Order[]
getAdjusters() ​
Get all order adjusters.
Returns ​
class-string<\craft\commerce\base\AdjusterInterface>[]
Throws ​
getAllOrderAdjustmentsByOrderId() ​
Get all order adjustments by order's ID.
Arguments ​
$orderId
Returns ​
craft\commerce\models\OrderAdjustment[]
getDiscountAdjusters() ​
Returns ​
class-string<\craft\commerce\base\AdjusterInterface>[]
getOrderAdjustmentById() ​
Arguments ​
$id
saveOrderAdjustment() ​
Save an order adjustment.
Arguments ​
$orderAdjustment$runValidation(boolean) – Whether the Order Adjustment should be validated
Throws ​
Events ​
EVENT_REGISTER_DISCOUNT_ADJUSTERS ​
The event that is triggered for registration of additional adjusters.
EVENT_REGISTER_ORDER_ADJUSTERS ​
The event that is triggered for registration of additional adjusters.
php
use craft\events\RegisterComponentTypesEvent;
use craft\commerce\services\OrderAdjustments;
use yii\base\Event;
Event::on(
OrderAdjustments::class,
OrderAdjustments::EVENT_REGISTER_ORDER_ADJUSTERS,
function(RegisterComponentTypesEvent $event) {
$event->types[] = MyAdjuster::class;
}
);