TopProductTypes

Type
Class
Namespace
craft\commerce\stats
Inherits
craft\commerce\stats\TopProductTypes » craft\commerce\base\Stat
Implements
craft\commerce\base\StatInterface
Uses traits
craft\commerce\base\StatTrait
Since
3.0

Top Product Types Stat

View source (opens new window)

# Public Properties

# limit

Type
integer (opens new window)
Default value
5

Number of customers to show.

View source (opens new window)

# type

Type
string (opens new window)
Default value
'qty'

Type either 'qty' or 'revenue'.

View source (opens new window)

# Protected Properties

Property Description
_handle string (opens new window)

# _handle

Type
string (opens new window)
Default value
'topProductTypes'

View source (opens new window)

# Public Methods

Method Description
__construct() Stat constructor.
get()
getChartQueryOptionsByInterval()
getData()
getDateRangeInterval()
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()

# __construct()

Stat constructor.

View source (opens new window)

Arguments

Throws

# getData()

View source (opens new window)

Returns

mixed

# getHandle()

View source (opens new window)

# prepareData()

View source (opens new window)

Arguments

  • $data

Returns

mixed

# Protected Methods

Method Description
_createChartQuery()
_createStatQuery() Generate base stat query