OrderAdjustments
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\OrderAdjustments » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Order adjustment service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| adjusters | craft\commerce\base\AdjusterInterface[] |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| discountAdjusters | array (opens new window) |
# adjusters
- Type
- craft\commerce\base\AdjusterInterface[]
- Default value
null
View source (opens new window)
# discountAdjusters
- Type
- array (opens new window)
- Default value
null- Access
- Read-only
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. |
| deleteAllOrderAdjustmentsByOrderId() | Delete all adjustments belonging to an order by its ID. |
| deleteOrderAdjustmentByAdjustmentId() | Delete an order adjustment by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| eagerLoadOrderAdjustmentsForOrders() | |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getAdjusters() | Get all order adjusters. |
| getAllOrderAdjustmentsByOrderId() | Get all order adjustments by order's ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getDiscountAdjusters() | |
| getOrderAdjustmentById() | |
| 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. |
| saveOrderAdjustment() | Save an order adjustment. |
| trigger() (opens new window) | Triggers an event. |
# deleteAllOrderAdjustmentsByOrderId()
Delete all adjustments belonging to an order by its ID.
View source (opens new window)
Arguments
$orderId(integer (opens new window))
Returns
# deleteOrderAdjustmentByAdjustmentId()
Delete an order adjustment by its ID.
View source (opens new window)
Arguments
$adjustmentId(integer (opens new window))
Returns
# eagerLoadOrderAdjustmentsForOrders()
- Since
- 3.2.0
View source (opens new window)
Arguments
$orders(array (opens new window), craft\commerce\elements\Order[])
Returns
craft\commerce\elements\Order[]
# getAdjusters()
Get all order adjusters.
View source (opens new window)
Returns
# getAllOrderAdjustmentsByOrderId()
Get all order adjustments by order's ID.
View source (opens new window)
Arguments
$orderId(integer (opens new window))
Returns
craft\commerce\models\OrderAdjustment[]
# getDiscountAdjusters()
View source (opens new window)
Returns
# getOrderAdjustmentById()
View source (opens new window)
Arguments
Returns
craft\commerce\models\OrderAdjustment, null (opens new window)
# saveOrderAdjustment()
Save an order adjustment.
View source (opens new window)
Arguments
$orderAdjustment(craft\commerce\models\OrderAdjustment)$runValidation(boolean (opens new window)) – Whether the Order Adjustment should be validated
Returns
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.
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;
}
);