Commerce 3 Class Reference Commerce 3 Class Reference
  • Craft 2 Documentation (opens new window)
  • Craft 2 Class Reference (opens new window)
  • Craft 3 Documentation (opens new window)
  • Craft 3 Class Reference (opens new window)
  • Craft 4 Documentation (opens new window)
  • Craft 4 Class Reference (opens new window)
  • Commerce 1 Documentation (opens new window)
  • Commerce 2 Documentation (opens new window)
  • Commerce 2 Class Reference (opens new window)
  • Commerce 3 Documentation (opens new window)
  • Commerce 3 Class Reference
  • Commerce 4 Documentation (opens new window)
  • Commerce 4 Class Reference (opens new window)
Craftnet API (opens new window)
  • Craft 2 Documentation (opens new window)
  • Craft 2 Class Reference (opens new window)
  • Craft 3 Documentation (opens new window)
  • Craft 3 Class Reference (opens new window)
  • Craft 4 Documentation (opens new window)
  • Craft 4 Class Reference (opens new window)
  • Commerce 1 Documentation (opens new window)
  • Commerce 2 Documentation (opens new window)
  • Commerce 2 Class Reference (opens new window)
  • Commerce 3 Documentation (opens new window)
  • Commerce 3 Class Reference
  • Commerce 4 Documentation (opens new window)
  • Commerce 4 Class Reference (opens new window)
Craftnet API (opens new window)
  • craft\commerce

  • craft\commerce\adjusters

  • craft\commerce\base

    • AddressZoneInterface
    • AdjusterInterface
    • Gateway
    • GatewayInterface
    • GatewayTrait
    • Model
    • OrderDeprecatedTrait
    • Plan
    • PlanInterface
    • PlanTrait
    • Purchasable
    • PurchasableInterface
    • RequestResponseInterface
    • ShippingMethod
    • ShippingMethodInterface
    • ShippingRuleInterface
    • Stat
    • StatInterface
      • Public Methods
    • StatTrait
    • SubscriptionGateway
    • SubscriptionGatewayInterface
    • SubscriptionResponseInterface
    • TaxEngineInterface
  • craft\commerce\behaviors

  • craft\commerce\console

  • craft\commerce\console\controllers

  • craft\commerce\controllers

  • craft\commerce\db

  • craft\commerce\elements

  • craft\commerce\elements\actions

  • craft\commerce\elements\db

  • craft\commerce\elements\traits

  • craft\commerce\engines

  • craft\commerce\errors

  • craft\commerce\events

  • craft\commerce\exports

  • craft\commerce\fieldlayoutelements

  • craft\commerce\fields

  • craft\commerce\gateways

  • craft\commerce\gql\arguments\elements

  • craft\commerce\gql\interfaces\elements

  • craft\commerce\gql\queries

  • craft\commerce\gql\resolvers\elements

  • craft\commerce\gql\types

  • craft\commerce\gql\types\elements

  • craft\commerce\gql\types\generators

  • craft\commerce\gql\types\input

  • craft\commerce\helpers

  • craft\commerce\migrations

  • craft\commerce\models

  • craft\commerce\models\payments

  • craft\commerce\models\responses

  • craft\commerce\models\subscriptions

  • craft\commerce\plugin

  • craft\commerce\queue\jobs

  • craft\commerce\records

  • craft\commerce\services

  • craft\commerce\stats

  • craft\commerce\test\fixtures\elements

  • craft\commerce\test\mockclasses

  • craft\commerce\web\assets\chartjs

  • craft\commerce\web\assets\commercecp

  • craft\commerce\web\assets\commerceui

  • craft\commerce\web\assets\deepmerge

  • craft\commerce\web\assets\editproduct

  • craft\commerce\web\assets\orderswidget

  • craft\commerce\web\assets\productindex

  • craft\commerce\web\assets\statwidgets

  • craft\commerce\web\assets\variantmatrix

  • craft\commerce\web\panel

  • craft\commerce\web\twig

  • craft\commerce\widgets

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()
getStartDate()
prepareData()
setEndDate()
setStartDate()

# get()

View source (opens new window)

Returns

mixed

# getData()

View source (opens new window)

Returns

array (opens new window), null (opens new window), false (opens new window)

# getDateRangeWording()

View source (opens new window)

Returns

string (opens new window)

# getEndDate()

View source (opens new window)

Returns

mixed

# getHandle()

View source (opens new window)

Returns

string (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 (null (opens new window), DateTime (opens new window))

Returns

mixed

# setStartDate()

View source (opens new window)

Arguments

  • $date (null (opens new window), DateTime (opens new window))

Returns

mixed

← Stat StatTrait →