OrderHistories
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\OrderHistories » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Order history service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
# 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 an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to 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. |
| createOrderHistoryFromOrder() | Create an order history from an order. |
| deleteOrderHistoryById() | Delete an order history 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. |
| getAllOrderHistoriesByOrderId() | Get all order histories by an order ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getOrderHistoryById() | Get order history 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. |
| 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. |
| saveOrderHistory() | Save an order history. |
| trigger() (opens new window) | Triggers an event. |
# createOrderHistoryFromOrder()
Create an order history from an order.
View source (opens new window)
Arguments
$order(craft\commerce\elements\Order)$oldStatusId(integer (opens new window))
Returns
# deleteOrderHistoryById()
Delete an order history by its ID.
View source (opens new window)
Arguments
$id
Returns
# getAllOrderHistoriesByOrderId()
Get all order histories by an order ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – OrderId
Returns
craft\commerce\models\OrderHistory[]
# getOrderHistoryById()
Get order history by its ID.
View source (opens new window)
Arguments
Returns
craft\commerce\models\OrderHistory, null (opens new window)
# saveOrderHistory()
Save an order history.
View source (opens new window)
Arguments
$model(craft\commerce\models\OrderHistory)$runValidation(boolean (opens new window)) – Whether the Order Adjustment should be validated
Returns
Throws
# Events
# EVENT_ORDER_STATUS_CHANGE
The event that is triggered when order status is changed
Plugins can get notified when an order status is changed
use craft\commerce\events\OrderStatusEvent;
use craft\commerce\services\OrderHistories;
use yii\base\Event;
Event::on(OrderHistories::class, OrderHistories::EVENT_ORDER_STATUS_CHANGE, function(OrderStatusEvent $e) {
// Perhaps, let the delivery department know that the order is ready to be delivered.
});