TimespanFactory
in package
Class representing a time span factory.
Table of Contents
- EARLIEST_TIME = "1970-01-01"
- Earliest date.
- VALID_TERMS = ["today", "week", "month", "year", "all"]
- Valid terms.
- createForAllTime() : Timespan
- Return timespan for all time.
- createForThisMonth() : Timespan
- Return timespan for current month.
- createForThisWeek() : Timespan
- Return timespan for current week.
- createForThisYear() : Timespan
- Return timespan for current year.
- createForToday() : Timespan
- Return timespan for current day.
- createFromTerm() : Timespan
- Return time span for provided term.
- createTimespan() : Timespan
- Return time span.
Constants
EARLIEST_TIME
Earliest date.
private
mixed
EARLIEST_TIME
= "1970-01-01"
VALID_TERMS
Valid terms.
private
mixed
VALID_TERMS
= ["today", "week", "month", "year", "all"]
Methods
createForAllTime()
Return timespan for all time.
public
createForAllTime() : Timespan
Return values
Timespan —Time span.
createForThisMonth()
Return timespan for current month.
public
createForThisMonth() : Timespan
Return values
Timespan —Time span.
createForThisWeek()
Return timespan for current week.
public
createForThisWeek() : Timespan
Return values
Timespan —Time span.
createForThisYear()
Return timespan for current year.
public
createForThisYear() : Timespan
Return values
Timespan —Time span.
createForToday()
Return timespan for current day.
public
createForToday() : Timespan
Return values
Timespan —Time span.
createFromTerm()
Return time span for provided term.
public
createFromTerm(string $term) : Timespan
Parameters
- $term : string
-
Term.
Return values
Timespan —Time span.
createTimespan()
Return time span.
public
createTimespan(DateTimeImmutable $start, DateTimeImmutable $end) : Timespan
Parameters
- $start : DateTimeImmutable
-
Start date.
- $end : DateTimeImmutable
-
End date.
Return values
Timespan —Time span.