OrderHistories

Type

Class

Namespace

craft\commerce\services

Inherits

craft\commerce\services\OrderHistories » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable

Since

2.0

Order history service.

View source

Public Properties

Property	Description
behaviors	yii\base\Behavior – List of behaviors attached to this component.

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.
createOrderHistoryFromOrder()	Create an order history from an order.
deleteOrderHistoryById()	Delete an order history 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.
getAllOrderHistoriesByOrderId()	Get all order histories by an order ID.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getOrderHistoryById()	Get order history 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 for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
saveOrderHistory()	Save an order history.
trigger()	Triggers an event.

createOrderHistoryFromOrder()

Create an order history from an order.

View source

Arguments

• $order
• $oldStatusId

Throws

• yii\base\Exception
• yii\base\InvalidConfigException
• craft\errors\MissingComponentException

deleteOrderHistoryById()

Delete an order history by its ID.

View source

Arguments

• $id

Throws

• Throwable
• yii\db\StaleObjectException

getAllOrderHistoriesByOrderId()

Get all order histories by an order ID.

View source

Arguments

• $id (integer) – OrderId

Returns

craft\commerce\models\OrderHistory[]

getOrderHistoryById()

Get order history by its ID.

View source

Arguments

• $id

saveOrderHistory()

Save an order history.

View source

Arguments

• $model
• $runValidation (boolean) – Whether the Order Adjustment should be validated

Throws

• yii\base\Exception

Events

EVENT_ORDER_STATUS_CHANGE

Type

craft\commerce\events\OrderStatusEvent

The event that is triggered when an 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 craft\commerce\models\OrderHistory;
use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(
    OrderHistories::class,
    OrderHistories::EVENT_ORDER_STATUS_CHANGE,
    function(OrderStatusEvent $event) {
        // @var OrderHistory $orderHistory
        $orderHistory = $event->orderHistory;
        // @var Order $order
        $order = $event->order;

        // Let the delivery department know the order’s ready to be delivered
        // ...
    }
);

---