ReportFetchData

Dashboard\Classes\ReportFetchData

Overview

ReportFetchData represents the report data for fetching.

Public Properties

public DashReport $dashReport

dashReport element

public array $widgetConfig

public array $extraData

public ReportDimension $dimension

dimension specifies the dimension to group the data by.

public string $dimensionCode

dimensionCode specifies the dimension to group the data by.

public ReportMetric[] $metrics

metrics specifies the metrics to return.

public array $metricCodes

metricCodes specifies the metrics to return.

public ReportMetricConfiguration[] $metricsConfiguration

metricsConfiguration specifies the report metrics configuration.

public Carbon $dateStart

dateStart specifies the start date.

public Carbon $dateEnd

dateEnd specifies the end date.

public Carbon $compareDateStart

dateStart specifies the start date.

public Carbon $compareDateEnd

dateEnd Specifies the end date.

public int $startTimestamp

startTimestamp Optional. Specifies the starting timestamp for relative intervals. Either $startTimestamp must be set, or both $dateStart and $dateEnd.

public ReportDimensionFilter[] $dimensionFilters

dimensionFilters specifies the filters to apply to the dimension values.

public string $groupInterval

groupInterval specifies the group interval. One of the GROUPINTERVAL* constants. Only applies if the dimension is a date dimension. If not specified, the default group interval GROUP_INTERVAL_DAY will be used.

public ReportDataOrderRule $orderRule

orderRule specifies the data ordering rule.

public int $limit

limit specifies the maximum number of records to return.

public ReportDataPaginationParams $paginationParams

paginationParams specifies the pagination parameters. Either $limit or $paginationParams or none can be set.

public bool $hideEmptyDimensionValues

hideEmptyDimensionValues indicates whether empty dimension values must be removed from the dataset.

public ReportDataCache $reportDataCache

reportDataCache specifies the cache to use.

public bool $totalsOnly

totalsOnly indicates that the method should only return total values for metrics, and not rows.

public bool $resetCache

resetCache indicates that the cache should be reset.

Public Methods

public fillFromPost()

public fillFromPost(): void

public makeCompareData()

public makeCompareData(): void

Protected Methods

protected findMetricInWidgetConfig()

protected findMetricInWidgetConfig(
    $code
): Dashboard\Classes\ReportMetricConfiguration|null

protected getBackendTimezone()

protected getBackendTimezone(): string

getBackendTimezone returns the timezone dashboard dates are interpreted in.

protected getRequestedCompareInterval()

protected getRequestedCompareInterval($compare): array

protected getRequestedDateInterval()

protected getRequestedDateInterval(
    $dashboardDateStart,
    $dashboardDateEnd
): array

protected getRequestedMetricsConfiguration()

protected getRequestedMetricsConfiguration(): array

protected getRequestedPaginationParams()

protected getRequestedPaginationParams(

): Dashboard\Classes\ReportDataPaginationParams|null

protected getRequestedWidgetFilters()

protected getRequestedWidgetFilters(): array

protected makeRequestedOrderRule()

protected makeRequestedOrderRule(): Dashboard\Classes\ReportDataOrderRule

protected parseDashboardDate()

protected parseDashboardDate($value): Carbon\Carbon|null

parseDashboardDate safely parses a dashboard date from the browser.

Contents