OrderStatuses

Type: Class
Namespace: craft\commerce\services
Inherits: craft\commerce\services\OrderStatuses » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 2.0

Order status service.

# Public Properties

Property	Description
allOrderStatuses	craft\commerce\models\OrderStatus[], array (opens new window) – all Order Statuses
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
defaultOrderStatus	craft\commerce\models\OrderStatus, null (opens new window) – default order status from the DB
defaultOrderStatusId	null (opens new window), integer (opens new window) – default order status ID from the DB
orderCountByStatus	array (opens new window)

# `allOrderStatuses`

Type: craft\commerce\models\OrderStatus[], array (opens new window)
Default value: null

all Order Statuses

View source (opens new window)

# `defaultOrderStatus`

Type: craft\commerce\models\OrderStatus, null (opens new window)
Default value: null

default order status from the DB

View source (opens new window)

# `defaultOrderStatusId`

Type: null (opens new window), integer (opens new window)
Default value: null

default order status ID from the DB

View source (opens new window)

# `orderCountByStatus`

Type: array (opens new window)
Default value: null

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.
deleteOrderStatusById()	Delete an order status by it's 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.
getAllOrderStatuses()	Returns all Order Statuses
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	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 control-panel-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() (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.
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() (opens new window)	Triggers an event.

# `deleteOrderStatusById()`

Delete an order status by it's id.

View source (opens new window)

Arguments

$id

Throws

Throwable (opens new window)

# `getAllOrderStatuses()`

Since: 2.2

Returns all Order Statuses

View source (opens new window)

Arguments

$withTrashed

Returns

craft\commerce\models\OrderStatus[]

# `getDefaultOrderStatus()`

Get default order status from the DB

View source (opens new window)

# `getDefaultOrderStatusForOrder()`

Get the default order status for a particular order. Defaults to the control-panel-configured default order status.

View source (opens new window)

Arguments

$order

# `getDefaultOrderStatusId()`

Get default order status ID from the DB

View source (opens new window)

# `getOrderCountByStatus()`

Since: 3.0.11

View source (opens new window)

# `getOrderStatusByHandle()`

Get order status by its handle.

View source (opens new window)

Arguments

$handle

# `getOrderStatusById()`

Get an order status by ID

View source (opens new window)

Arguments

$id

# `handleChangedOrderStatus()`

Handle order status change.

View source (opens new window)

Arguments

$event

Returns

void

Throws

Throwable (opens new window)
if reasons

# `handleDeletedOrderStatus()`

Handle order status being deleted

View source (opens new window)

Arguments

$event

Returns

void

Throws

Throwable (opens new window)
if reasons

# `pruneDeletedEmail()`

Prune a deleted email from order statuses.

View source (opens new window)

Arguments

$event

# `reorderOrderStatuses()`

Reorders the order statuses.

View source (opens new window)

Arguments

$ids

Throws

# `saveOrderStatus()`

Save the order status.

View source (opens new window)

Arguments

$orderStatus
$emailIds
$runValidation (boolean (opens new window)) – Should we validate this order status before saving.
$force

Throws

yii\base\Exception (opens new window)

# `statusChangeHandler()`

Handler for order status change event

View source (opens new window)

Arguments

$order (craft\commerce\elements\Order)
$orderHistory (craft\commerce\models\OrderHistory)

Throws

yii\base\InvalidConfigException (opens new window)

# 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
        // ...
    }
);

# EVENT_ORDER_STATUS_CHANGE_EMAILS

Type: craft\commerce\events\OrderStatusEmailsEvent

The email event that is triggered when an order status is changed.

Plugins can get notified when an order status is changed

use craft\commerce\events\OrderStatusEmailsEvent;
use craft\commerce\services\OrderStatuses;
use craft\commerce\models\OrderHistory;
use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(
    OrderStatuses::class,
    OrderStatuses::EVENT_ORDER_STATUS_CHANGE_EMAILS,
    function(OrderStatusEmailsEvent $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
        // ...
    }
);

← OrderNotices Orders →

OrderStatuses

# Public Properties

# allOrderStatuses

# defaultOrderStatus

# defaultOrderStatusId

# orderCountByStatus

# Public Methods

# deleteOrderStatusById()

Arguments

Throws

# getAllOrderStatuses()

Arguments

Returns

# getDefaultOrderStatus()

# getDefaultOrderStatusForOrder()

Arguments

# getDefaultOrderStatusId()

# getOrderCountByStatus()

# getOrderStatusByHandle()

Arguments

# getOrderStatusById()

Arguments

# handleChangedOrderStatus()

Arguments

Returns

Throws

# handleDeletedOrderStatus()

Arguments

Returns

Throws

# pruneDeletedEmail()

Arguments

# reorderOrderStatuses()

Arguments

Throws

# saveOrderStatus()

Arguments

Throws

# statusChangeHandler()

Arguments

Throws

# Constants

# Events

# EVENT_DEFAULT_ORDER_STATUS

# EVENT_ORDER_STATUS_CHANGE_EMAILS

# `allOrderStatuses`

# `defaultOrderStatus`

# `defaultOrderStatusId`

# `orderCountByStatus`

# `deleteOrderStatusById()`

# `getAllOrderStatuses()`

# `getDefaultOrderStatus()`

# `getDefaultOrderStatusForOrder()`

# `getDefaultOrderStatusId()`

# `getOrderCountByStatus()`

# `getOrderStatusByHandle()`

# `getOrderStatusById()`

# `handleChangedOrderStatus()`

# `handleDeletedOrderStatus()`

# `pruneDeletedEmail()`

# `reorderOrderStatuses()`

# `saveOrderStatus()`

# `statusChangeHandler()`