Please wait while we load your page...

Tools

PHP Manual [The DatePeriod class]

Protect Your Website Today


PHP Manual || Date/Time

(PHP 5 >= 5.3.0, PHP 7)

Represents a date period.

A date period allows iteration over a set of dates and times, recurring at regular intervals, over a given period.

DatePeriod implements Traversable {
/* Constants */
const integer EXCLUDE_START_DATE = 1 ;
/* Properties */
public integer recurrences ;
public boolean include_start_date ;
public DateTimeInterface start ;
public DateTimeInterface current ;
public DateTimeInterface end ;
public DateInterval interval ;
/* Methods */
public __construct ( DateTimeInterface $start , DateInterval $interval , int $recurrences [, int $options ] )
public __construct ( DateTimeInterface $start , DateInterval $interval , DateTimeInterface $end [, int $options ] )
public __construct ( string $isostr [, int $options ] )
public getDateInterval ( void ) : DateInterval
public getEndDate ( void ) : DateTimeInterface
public getRecurrences ( void ) : int
public getStartDate ( void ) : DateTimeInterface
}
DatePeriod::EXCLUDE_START_DATE

Exclude start date, used in DatePeriod::__construct().

recurrences

The number of recurrences, if the DatePeriod instance had been created by explicitly passing $recurrences. See also DatePeriod::getRecurrences().

include_start_date

Whether to include the start date in the set of recurring dates or not.

start

The start date of the period.

current

During iteration this will contain the current date within the period.

end

The end date of the period.

interval

An ISO 8601 repeating interval specification.

Version Description
5.3.27, 5.4.17 The public properties recurrences, include_start_date, start, current, end and interval have been exposed.



PHP Manual || Date/Time