StatInterface
- Type
- Interface
- Namespace
- craft\commerce\base
- Implemented by
- craft\commerce\base\Stat, craft\commerce\stats\AverageOrderTotal, craft\commerce\stats\NewCustomers, craft\commerce\stats\RepeatCustomers, craft\commerce\stats\TopCustomers, craft\commerce\stats\TopProductTypes, craft\commerce\stats\TopProducts, craft\commerce\stats\TopPurchasables, craft\commerce\stats\TotalOrders, craft\commerce\stats\TotalOrdersByCountry, craft\commerce\stats\TotalRevenue
- Since
- 3.0
Stat Interface
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| get() | |
| getData() | |
| getDateRangeWording() | |
| getEndDate() | |
| getHandle() | |
| getOrderStatuses() | |
| getStartDate() | |
| prepareData() | |
| setEndDate() | |
| setOrderStatuses() | Set order statuses to limit stat query. Accepts array of OrderStatus models, handle strings or uid strings. |
| setStartDate() |
# get()
View source (opens new window)
Returns
mixed
# getData()
View source (opens new window)
Returns
mixed
# getDateRangeWording()
View source (opens new window)
# getEndDate()
View source (opens new window)
Returns
mixed
# getHandle()
View source (opens new window)
# getOrderStatuses()
- Since
- 4.2.0
View source (opens new window)
Returns
array (opens new window), null (opens new window)
# getStartDate()
View source (opens new window)
Returns
mixed
# prepareData()
View source (opens new window)
Arguments
$data
Returns
mixed
# setEndDate()
View source (opens new window)
Arguments
$date
# setOrderStatuses()
- Since
- 4.2.0
Set order statuses to limit stat query. Accepts array of OrderStatus models, handle strings or uid strings.
View source (opens new window)
Arguments
$orderStatuses(craft\commerce\models\OrderStatus[], string (opens new window)[], null (opens new window))
Returns
void
# setStartDate()
View source (opens new window)
Arguments
$date