Orders

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

Orders 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 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.
beforeDeleteUserHandler() Prevent deleting a user if they have any orders.
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.
eagerLoadAddressesForOrders()
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getOrderById() Get an order by its ID.
getOrderByNumber() Get an order by its number.
getOrdersByCustomer() Get all orders by their customer.
getOrdersByEmail() Get all orders by their email.
handleChangedFieldLayout() Handle field layout change
handleDeletedFieldLayout() Handle field layout 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.
pruneDeletedField()
trigger() (opens new window) Triggers an event.

# beforeDeleteUserHandler()

Prevent deleting a user if they have any orders.

View source (opens new window)

Arguments

# eagerLoadAddressesForOrders()

Since
4.0.0

View source (opens new window)

Arguments

Returns

craft\commerce\elements\Order[]

# getOrderById()

Get an order by its ID.

View source (opens new window)

Arguments

Returns

craft\commerce\elements\Order, null (opens new window)

# getOrderByNumber()

Get an order by its number.

View source (opens new window)

Arguments

  • $number

# getOrdersByCustomer()

Get all orders by their customer.

View source (opens new window)

Arguments

Returns

craft\commerce\elements\Order[], null (opens new window)

# getOrdersByEmail()

Get all orders by their email.

View source (opens new window)

Arguments

  • $email

Returns

craft\commerce\elements\Order[], null (opens new window)

# handleChangedFieldLayout()

Handle field layout change

View source (opens new window)

Arguments

  • $event

Throws

# handleDeletedFieldLayout()

Handle field layout being deleted

View source (opens new window)

# pruneDeletedField()

DEPRECATED

Deprecated in 4.0.3. Unused fields will be pruned automatically as field layouts are resaved.

View source (opens new window)

# Constants

Constant Description
CONFIG_FIELDLAYOUT_KEY