1. Documentation
  2. API
  3. Backend
  4. Classes
  5. Dashboard
  6. ReportFetchDataResult

Backend\Classes\Dashboard\ReportFetchDataResult

Overview

Represents the result of fetching report data.

Public Methods

public __construct()

public __construct(array $rows = []): void

Constructs a new ReportFetchDataResult instance.

public addRow()

public addRow(object $row): ReportFetchDataResult

Adds a row to the result dataset.

public getMetricTotals()

public getMetricTotals(): array

Retrieves metric totals.

public getRows()

public getRows(): array

Returns the dataset rows.

public getTotalRecords()

public getTotalRecords(): int

Returns the number of records on all pages of a paginated data set.

public setMetricTotals()

public setMetricTotals(array $metricTotals): void

Sets metric totals.

public setRows()

public setRows(array $rows): ReportFetchDataResult

Sets the result dataset rows. This method overrides rows set previously.

public setTotalRecords()

public setTotalRecords(int $totalRecords): ReportFetchDataResult

Sets the number of records on all pages of a paginated data set.