A classe DatePeriod

(PHP 5 >= 5.3.0, PHP 7)

Introdução

Representa um período entre datas.

O período entre datas permite a iteração entre um conjunto de datas e horários recorrentes a intervalos regulares, durante um determinado período.

Sinopse da classe

DatePeriod implements Traversable {
/* Constantes */
const integer EXCLUDE_START_DATE = 1 ;
/* Propriedades */
public integer $recurrences ;
public boolean $include_start_date ;
/* Métodos */
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
getRecurrences ( void ) : int
public getStartDate ( void ) : DateTimeInterface
}

Constantes pré-definidas

DatePeriod::EXCLUDE_START_DATE

Exclui a data inicial, utilizada em DatePeriod::__construct().

Propriedades

recurrences

O número de recorrências, se a instância DatePeriod foi criada com o argumento $recurrences. Veja também DatePeriod::getRecurrences().

include_start_date

Se inclui a data inicial na recorrências.

start

A data inicial do período.

current

Contém a data atual dentro do período.

end

Data final do período.

interval

Uma especificação ISO 8601 do intervalo repetidor.

Changelog

Versão Descrição
5.3.27, 5.4.17 As propriedades recurrences, include_start_date, start, current, end e interval foram expostas.

Índice