OrderStatuses

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

Order status service.

View source

# Public Properties

# allOrderStatuses

Type
craft\commerce\models\OrderStatus[]
Access
Read-only
Since
2.2

View source

# defaultOrderStatus

Type
craft\commerce\models\OrderStatus, null
Access
Read-only

View source

# defaultOrderStatusId

Type
integer, null
Access
Read-only

View source

# orderCountByStatus

Type
array
Access
Read-only
Since
3.0.11

View source

# 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.
deleteOrderStatusById() Delete an order status by it's 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.
getAllOrderStatuses() Returns all Order Statuses
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getDefaultOrderStatus() Get default order status from the DB
getDefaultOrderStatusForOrder() Get the default order status for a particular order. Defaults to the CP configured default order status.
getDefaultOrderStatusId() Get default order status ID from the DB
getOrderCountByStatus()
getOrderStatusByHandle() Get order status by its handle.
getOrderStatusById() Get an order status by ID
handleChangedOrderStatus() Handle order status change.
handleDeletedOrderStatus() Handle order status being deleted
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.
pruneDeletedEmail() Prune a deleted email from order statuses.
reorderOrderStatuses() Reorders the order statuses.
saveOrderStatus() Save the order status.
statusChangeHandler() Handler for order status change event
trigger() Triggers an event.

# deleteOrderStatusById()

Delete an order status by it's id.

View source

Arguments

Returns

boolean

Throws

# getAllOrderStatuses()

Since
2.2

Returns all Order Statuses

View source

Arguments

Returns

craft\commerce\models\OrderStatus[]

# getDefaultOrderStatus()

Get default order status from the DB

View source

Returns

craft\commerce\models\OrderStatus, null

# getDefaultOrderStatusForOrder()

Get the default order status for a particular order. Defaults to the CP configured default order status.

View source

Arguments

Returns

craft\commerce\models\OrderStatus, null

# getDefaultOrderStatusId()

Get default order status ID from the DB

View source

Returns

integer, null

# getOrderCountByStatus()

Since
3.0.11

View source

Returns

array

# getOrderStatusByHandle()

Get order status by its handle.

View source

Arguments

Returns

craft\commerce\models\OrderStatus, null

# getOrderStatusById()

Get an order status by ID

View source

Arguments

Returns

craft\commerce\models\OrderStatus, null

# handleChangedOrderStatus()

Handle order status change.

View source

Arguments

Returns

void

Throws

# handleDeletedOrderStatus()

Handle order status being deleted

View source

Arguments

Returns

void

Throws

# pruneDeletedEmail()

Prune a deleted email from order statuses.

View source

Arguments

# reorderOrderStatuses()

Reorders the order statuses.

View source

Arguments

Returns

boolean

Throws

# saveOrderStatus()

Save the order status.

View source

Arguments

Returns

boolean

Throws

# statusChangeHandler()

Handler for order status change event

View source

Arguments

# Constants

Constant Description
CONFIG_STATUSES_KEY

# Events

# EVENT_DEFAULT_ORDER_STATUS

Type
craft\commerce\events\DefaultOrderStatusEvent

The event that is triggered when a default order status is being fetched.

Set the event object’s orderStatus property to override the default status set in the control panel.

use craft\commerce\events\DefaultOrderStatusEvent;
use craft\commerce\services\OrderStatuses;
use craft\commerce\models\OrderStatus;
use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(
    OrderStatuses::class,
    OrderStatuses::EVENT_DEFAULT_ORDER_STATUS,
    function(DefaultOrderStatusEvent $event) {
        // @var OrderStatus $status
        $status = $event->orderStatus;
        // @var Order $order
        $order = $event->order;

        // Choose a more appropriate order status than the control panel default
        // ...
    }
);