SummarizableTimespan
extends Timespan
in package
Table of Contents
- $comparisonEndDate : DateTimeImmutable
- $comparisonStartDate : DateTimeImmutable
- $comparisonTotalsEndDate : DateTimeImmutable
- $comparisonTotalsStartDate : DateTimeImmutable
- $endDate : DateTimeImmutable
- $startDate : DateTimeImmutable
- $totalsEndDate : DateTimeImmutable
- $totalsStartDate : DateTimeImmutable
- $name : string
- $summarizer : AbstractSummarizer
- __construct() : mixed
- Constructor.
- comparisonEndDate() : DateTimeImmutable
- Return comparison end date.
- comparisonStartDate() : DateTimeImmutable
- Return comparison start date.
- comparisonTotalsEndDate() : DateTimeImmutable
- Return comparison totals end date.
- comparisonTotalsStartDate() : DateTimeImmutable
- Return comparison totals start date.
- endDate() : DateTimeImmutable
- Return time span end.
- name() : string
- Return time span name.
- startDate() : DateTimeImmutable
- Return time span start.
- summarize() : SummarizedData
- Summarize values.
- totalsEndDate() : DateTimeImmutable
- Return totals end date.
- totalsStartDate() : DateTimeImmutable
- Return totals start date.
Properties
$comparisonEndDate
protected
DateTimeImmutable
$comparisonEndDate
$comparisonStartDate
protected
DateTimeImmutable
$comparisonStartDate
$comparisonTotalsEndDate
protected
DateTimeImmutable
$comparisonTotalsEndDate
$comparisonTotalsStartDate
protected
DateTimeImmutable
$comparisonTotalsStartDate
$endDate
protected
DateTimeImmutable
$endDate
$startDate
protected
DateTimeImmutable
$startDate
$totalsEndDate
protected
DateTimeImmutable
$totalsEndDate
$totalsStartDate
protected
DateTimeImmutable
$totalsStartDate
$name
private
string
$name
$summarizer
private
AbstractSummarizer
$summarizer
Methods
__construct()
Constructor.
public
__construct(DateTimeImmutable $startDate, DateTimeImmutable $endDate, AbstractSummarizer $summarizer, string $name[, DateTimeImmutable|null $totalsStartDate = null ][, DateTimeImmutable|null $totalsEndDate = null ]) : mixed
Parameters
- $startDate : DateTimeImmutable
- $endDate : DateTimeImmutable
- $summarizer : AbstractSummarizer
- $name : string
- $totalsStartDate : DateTimeImmutable|null = null
- $totalsEndDate : DateTimeImmutable|null = null
Tags
Return values
mixed —comparisonEndDate()
Return comparison end date.
public
comparisonEndDate() : DateTimeImmutable
Return values
DateTimeImmutable —comparisonStartDate()
Return comparison start date.
public
comparisonStartDate() : DateTimeImmutable
Return values
DateTimeImmutable —comparisonTotalsEndDate()
Return comparison totals end date.
public
comparisonTotalsEndDate() : DateTimeImmutable
Return values
DateTimeImmutable —comparisonTotalsStartDate()
Return comparison totals start date.
public
comparisonTotalsStartDate() : DateTimeImmutable
Return values
DateTimeImmutable —endDate()
Return time span end.
public
endDate() : DateTimeImmutable
Return values
DateTimeImmutable —name()
Return time span name.
public
name() : string
Return values
string —startDate()
Return time span start.
public
startDate() : DateTimeImmutable
Return values
DateTimeImmutable —summarize()
Summarize values.
public
summarize(DataProviderResult ...$values) : SummarizedData
Parameters
- $values : DataProviderResult
Return values
SummarizedData —totalsEndDate()
Return totals end date.
public
totalsEndDate() : DateTimeImmutable
Return values
DateTimeImmutable —totalsStartDate()
Return totals start date.
public
totalsStartDate() : DateTimeImmutable