LineItemStatuses

Type

Class

Namespace

craft\commerce\services

Inherits

craft\commerce\services\LineItemStatuses » 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.

View source (opens new window)

Public Properties

Property	Description
allLineItemStatuses	craft\commerce\models\LineItemStatus[], array (opens new window) – all Order Statuses
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
defaultLineItemStatus	craft\commerce\models\LineItemStatus, null (opens new window) – default line item status from the DB
defaultLineItemStatusId	null (opens new window), integer (opens new window) – default line item status ID from the DB

allLineItemStatuses

Type

craft\commerce\models\LineItemStatus[], array (opens new window)

Default value

null

all Order Statuses

View source (opens new window)

defaultLineItemStatus

Type

craft\commerce\models\LineItemStatus, null (opens new window)

Default value

null

default line item status from the DB

View source (opens new window)

defaultLineItemStatusId

Type

null (opens new window), integer (opens new window)

Default value

null

default line item status ID from the DB

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.
_clearCaches()	Clear all memoization
archiveLineItemStatusById()	Archive an line item status by it's id.
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.
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.
getAllLineItemStatuses()	Returns all Order Statuses
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getDefaultLineItemStatus()	Get default lineItem status from the DB
getDefaultLineItemStatusForLineItem()	Get the default lineItem status for a particular lineItem. Defaults to the CP configured default lineItem status.
getDefaultLineItemStatusId()	Get default lineItem status ID from the DB
getLineItemStatusByHandle()	Get line item status by its handle.
getLineItemStatusById()	Get an line item status by ID
handleArchivedLineItemStatus()	Handle line item status being archived
handleChangedLineItemStatus()	Handle line item status change.
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.
reorderLineItemStatuses()	Reorders the line item statuses.
saveLineItemStatus()	Save the line item status.
trigger() (opens new window)	Triggers an event.

_clearCaches()

Since

3.2.5

Clear all memoization

View source (opens new window)

archiveLineItemStatusById()

Archive an line item status by it's id.

View source (opens new window)

Arguments

• $id (integer (opens new window))

Returns

boolean (opens new window)

Throws

• Throwable (opens new window)

getAllLineItemStatuses()

Returns all Order Statuses

View source (opens new window)

Returns

craft\commerce\models\LineItemStatus[]

getDefaultLineItemStatus()

Get default lineItem status from the DB

View source (opens new window)

Returns

craft\commerce\models\LineItemStatus, null (opens new window)

getDefaultLineItemStatusForLineItem()

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

View source (opens new window)

Arguments

• $lineItem (craft\commerce\models\LineItem)

Returns

craft\commerce\models\LineItemStatus, null (opens new window)

getDefaultLineItemStatusId()

Get default lineItem status ID from the DB

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

getLineItemStatusByHandle()

Get line item status by its handle.

View source (opens new window)

Arguments

• $handle (string (opens new window))

Returns

craft\commerce\models\LineItemStatus, null (opens new window)

getLineItemStatusById()

Get an line item status by ID

View source (opens new window)

Arguments

• $id (integer (opens new window))

Returns

craft\commerce\models\LineItemStatus, null (opens new window)

handleArchivedLineItemStatus()

Handle line item status being archived

View source (opens new window)

Arguments

• $event (craft\events\ConfigEvent (opens new window))

Returns

void

Throws

• Throwable (opens new window)
  if reasons

handleChangedLineItemStatus()

Handle line item status change.

View source (opens new window)

Arguments

• $event (craft\events\ConfigEvent (opens new window))

Returns

void

Throws

• Throwable (opens new window)
  if reasons

reorderLineItemStatuses()

Reorders the line item statuses.

View source (opens new window)

Arguments

• $ids (array (opens new window))

Returns

boolean (opens new window)

Throws

• yii\base\Exception (opens new window)
• yii\base\ErrorException (opens new window)
• yii\base\NotSupportedException (opens new window)
• yii\web\ServerErrorHttpException (opens new window)

saveLineItemStatus()

Save the line item status.

View source (opens new window)

Arguments

• $lineItemStatus (craft\commerce\models\LineItemStatus)
• $runValidation (boolean (opens new window)) – Should we validate this line item status before saving.

Returns

boolean (opens new window)

Throws

• yii\base\Exception (opens new window)
• yii\base\ErrorException (opens new window)

Constants

Constant	Description
CONFIG_STATUSES_KEY

Events

EVENT_DEFAULT_LINE_ITEM_STATUS

Type

craft\commerce\events\DefaultLineItemStatusEvent

The event that is triggered when getting a default status for a line item. You may set craft\commerce\events\DefaultLineItemStatusEvent::$lineItemStatus to a desired LineItemStatus to override the default status set in CP

Plugins can get notified when a default line item status is being fetched

use craft\commerce\events\DefaultLineItemStatusEvent;
use craft\commerce\services\LineItemStatuses;
use yii\base\Event;

Event::on(LineItemStatuses::class, LineItemStatuses::EVENT_DEFAULT_LINE_ITEM_STATUS, function(DefaultLineItemStatusEvent $e) {
    // Do something - perhaps figure out a better default line item status than the one set in CP
});