TotalRevenue ​
- Type
- Class
- Namespace
- craft\commerce\stats
- Inherits
- craft\commerce\stats\TotalRevenue » craft\commerce\base\Stat
- Implements
- craft\commerce\base\HasStoreInterface, craft\commerce\base\StatInterface
- Uses traits
- craft\commerce\base\StatTrait, craft\commerce\base\StoreTrait
- Since
- 3.0
Total Revenue Stat
Public Properties ​
| Property | Description |
|---|---|
| cache | boolean |
| cacheDuration | integer – How long to cache the data, in seconds. |
| dateRange | string, null |
| storeId | integer, null – Store ID |
| type | string |
| weekStartDay | integer |
type ​
- Type
- string
- Default value
self::TYPE_TOTAL- Since
- 4.1.0
Protected Properties ​
| Property | Description |
|---|---|
| _handle | string |
_handle ​
- Type
- string
- Default value
'totalRevenue'
Public Methods ​
| Method | Description |
|---|---|
| __construct() | Stat constructor. |
| get() | |
| getChartQueryOptionsByInterval() | |
| getData() | |
| getDateRangeInterval() | |
| getDateRangeWording() | |
| getEndDate() | |
| getHandle() | |
| getOrderStatuses() | |
| getStartDate() | |
| getStore() | |
| prepareData() | |
| setEndDate() | |
| setOrderStatuses() | Set order statuses to limit stat query. Accepts array of OrderStatus models, handle strings or uid strings. |
| setStartDate() |
getData() ​
Returns ​
mixed
Protected Methods ​
| Method | Description |
|---|---|
| _createChartQuery() | |
| _createStatQuery() | Generate base stat query |
Constants ​
| Constant | Description |
|---|---|
TYPE_TOTAL | |
TYPE_TOTAL_PAID |