DatePeriod

class DatePeriod implements IteratorAggregate (View source)

Representation of date period.

Constants

EXCLUDE_START_DATE

INCLUDE_END_DATE Since: 8.2

Properties

DateTimeInterface $start

Start date
DateTimeInterface|null $current

Current iterator value.
DateTimeInterface|null $end

End date.
DateInterval $interval

The interval
int $recurrences

Number of recurrences.
bool $include_start_date

Start of period.
bool Since: 8.2
$include_end_date

Methods

__construct(string $isostr, int $options = 0)

Creates a new DatePeriod object

DateInterval
getDateInterval()

Gets the interval

DateTimeInterface|null
getEndDate()

Gets the end date

DateTimeInterface
getStartDate()

Gets the start date

static DatePeriod
__set_state(array $array)

No description

void
__wakeup()

No description

int|null
getRecurrences()

Get the number of recurrences

Traversable
getIterator()

No description

array
__serialize()

No description

void
__unserialize(array $data)

No description

static DatePeriod
createFromISO8601String(string $specification, int $options = 0)

Creates a new DatePeriod object from an ISO8601 string

Details

at line 1557
__construct(string $isostr, int $options = 0)

Creates a new DatePeriod object

Parameters

string $isostr

String containing the ISO interval.
int $options

Can be set to DatePeriod::EXCLUDE_START_DATE.

Exceptions

DateMalformedPeriodStringException

at line 1566
DateInterval getDateInterval()

Since: 5.6

Gets the interval

Return Value

DateInterval

Returns a DateInterval object

at line 1579
DateTimeInterface|null getEndDate()

Since: 5.6

Gets the end date

Return Value

DateTimeInterface|null

Returns null if the DatePeriod does not have an end date. For example, when initialized with the recurrences parameter, or the isostr parameter without an end date. Returns a DateTimeImmutable object when the DatePeriod is initialized with a DateTimeImmutable object as the end parameter. Returns a cloned DateTime object representing the end date otherwise.

at line 1590
DateTimeInterface getStartDate()

Since: 5.6

Gets the start date

Return Value

DateTimeInterface

Returns a DateTimeImmutable object when the DatePeriod is initialized with a DateTimeImmutable object as the start parameter. Returns a DateTime object otherwise.

at line 1593
static DatePeriod __set_state(array $array)

No description

Parameters

array $array

Return Value

DatePeriod

at line 1596
void __wakeup()

No description

Return Value

void

at line 1607
int|null getRecurrences()

Since: 7.2

Get the number of recurrences

Return Value

int|null

The number of recurrences as set by explicitly passing the $recurrences to the constructor of the DatePeriod class, or null otherwise.

at line 1614
Traversable getIterator()

Since: 8.0

No description

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 1616
array __serialize()

No description

Return Value

array

at line 1619
void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void

at line 1632
static DatePeriod createFromISO8601String(string $specification, int $options = 0)

Since: 8.3

Creates a new DatePeriod object from an ISO8601 string

Creates a new DatePeriod object from an ISO8601 string, as specified with specification.

Parameters

string $specification
int $options

Return Value

DatePeriod

Exceptions

DateMalformedPeriodStringException