MonthSummarizer
extends AbstractSummarizer
in package
Table of Contents
- LANGUAGE_SECTION = 'dashboard_statistics'
- $textManager : TextManager
- $values : array<string|int, DataProviderResult>
- __construct() : mixed
- Constructor.
- summarize() : SummarizedData
- Summarize dataset for time span.
- summarizeAsArray() : array<string|int, mixed>
- Return summarized data array.
- alignPartials() : void
- Align partials.
- buildPartials() : array<string|int, mixed>
- Build partials.
- buildTotals() : array<string|int, mixed>
- Build totals.
- calculateTotals() : array<string|int, mixed>
- Calculate totals.
- initializeEmptyStructure() : array<string|int, mixed>
- Initialize data.
- parseArray() : SummarizedData
- Parse data.
Constants
LANGUAGE_SECTION
private
mixed
LANGUAGE_SECTION
= 'dashboard_statistics'
Properties
$textManager
protected
TextManager
$textManager
$values
protected
array<string|int, DataProviderResult>
$values
Methods
__construct()
Constructor.
public
__construct(TextManager $textManager) : mixed
Parameters
- $textManager : TextManager
Return values
mixed —summarize()
Summarize dataset for time span.
public
summarize(Timespan $timespan, DataProviderResult ...$values) : SummarizedData
Parameters
- $timespan : Timespan
- $values : DataProviderResult
Tags
Return values
SummarizedData —summarizeAsArray()
Return summarized data array.
public
summarizeAsArray(string $format, Timespan $timespan) : array<string|int, mixed>
Parameters
- $format : string
- $timespan : Timespan
Return values
array<string|int, mixed> —alignPartials()
Align partials.
protected
alignPartials(array<string|int, mixed> &$partials, array<string|int, mixed> &$comparisonPartials) : void
Partials and comparison partials need to have the same number of datasets. Missing datasets are added to the smaller one.
Parameters
- $partials : array<string|int, mixed>
- $comparisonPartials : array<string|int, mixed>
Return values
void —buildPartials()
Build partials.
protected
buildPartials(string $format, DateTimeInterface $startDate, DateTimeInterface $endDate) : array<string|int, mixed>
Parameters
- $format : string
- $startDate : DateTimeInterface
- $endDate : DateTimeInterface
Return values
array<string|int, mixed> —buildTotals()
Build totals.
protected
buildTotals(string $format, Timespan $timespan) : array<string|int, mixed>
Parameters
- $format : string
- $timespan : Timespan
Return values
array<string|int, mixed> —calculateTotals()
Calculate totals.
protected
calculateTotals(string $format, DateTimeInterface $startDate, DateTimeInterface $endDate) : array<string|int, mixed>
Parameters
- $format : string
- $startDate : DateTimeInterface
- $endDate : DateTimeInterface
Return values
array<string|int, mixed> —initializeEmptyStructure()
Initialize data.
protected
initializeEmptyStructure(string $format, DateTimeInterface $startDate, DateTimeInterface $endDate) : array<string|int, mixed>
Parameters
- $format : string
- $startDate : DateTimeInterface
- $endDate : DateTimeInterface
Return values
array<string|int, mixed> —parseArray()
Parse data.
protected
parseArray(array<string|int, mixed> $struct, SummaryTitle $title, SummaryHint $hint, SummaryName $summaryName, array<string|int, mixed> $translationMap) : SummarizedData
Parameters
- $struct : array<string|int, mixed>
- $title : SummaryTitle
- $hint : SummaryHint
- $summaryName : SummaryName
- $translationMap : array<string|int, mixed>