Orders ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Orders » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 2.0
Orders service.
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. |
| afterSaveAddressHandler() | |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| beforeDeleteUserHandler() | Prevent deleting a user if they have any orders. |
| 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. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| eagerLoadAddressesForOrders() | |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | 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() | 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. |
| trigger() | Triggers an event. |
afterSaveAddressHandler() ​
- Since
- 4.2.11
Arguments ​
$event(craft\events\ModelEvent)
Returns ​
void
Throws ​
- yii\base\Exception
- Throwable
- craft\errors\ElementNotFoundException
- craft\errors\InvalidElementException
- craft\errors\UnsupportedSiteException
beforeDeleteUserHandler() ​
Prevent deleting a user if they have any orders.
Arguments ​
$event(craft\events\ModelEvent) – The event.
eagerLoadAddressesForOrders() ​
- Since
- 4.0.0
Arguments ​
$orders(array, craft\commerce\elements\Order[])
Returns ​
craft\commerce\elements\Order[]
getOrderById() ​
Get an order by its ID.
Arguments ​
$id(integer)
Returns ​
?\craft\commerce\elements\Order
getOrderByNumber() ​
Get an order by its number.
Arguments ​
$number
getOrdersByCustomer() ​
Get all orders by their customer.
Arguments ​
$customer(integer, craft\elements\User)
Returns ​
craft\commerce\elements\Order[], null
getOrdersByEmail() ​
Get all orders by their email.
Arguments ​
$email
Returns ​
craft\commerce\elements\Order[], null
handleChangedFieldLayout() ​
Handle field layout change
Arguments ​
$event
Throws ​
handleDeletedFieldLayout() ​
Handle field layout being deleted
Constants ​
| Constant | Description |
|---|---|
CONFIG_FIELDLAYOUT_KEY |