ConsolidateGuestOrders
- Type
- Class
- Namespace
- craft\commerce\queue\jobs
- Inherits
- craft\commerce\queue\jobs\ConsolidateGuestOrders » craft\queue\BaseJob (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- craft\queue\JobInterface (opens new window), yii\base\Configurable (opens new window)
- Since
- 3.0
ConsolidateGuestOrders job
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| description (opens new window) | string (opens new window), null (opens new window) – The configured job description |
| emails | array (opens new window) |
# emails
- 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. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| 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. |
| consolidate() | |
| execute() | |
| getDescription() (opens new window) | Returns the description that should be used for the job. |
| 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. |
| init() (opens new window) | Initializes the object. |
# consolidate()
DEPRECATED
Deprecated in 3.1.4. Use craft\commerce\services\Customers::consolidateGuestOrdersByEmail() instead.
View source (opens new window)
Arguments
$email
# execute()
View source (opens new window)
Arguments
$queue(yii\queue\Queue (opens new window), craft\queue\QueueInterface (opens new window)) – The queue the job belongs to
# Protected Methods
| Method | Description |
|---|---|
| defaultDescription() | Returns a default description for getDescription() (opens new window). |
| setProgress() (opens new window) | Sets the job progress on the queue. |
# defaultDescription()
Returns a default description for getDescription() (opens new window).
View source (opens new window)