DatePeriod::getEndDate

(PHP 5 >= 5.6.5, PHP 7, PHP 8)

DatePeriod::getEndDate — Obtém a data final

Descrição

Estilo orientado a objetos

public DatePeriod::getEndDate(): ?DateTimeInterface

Obtém a data final do período.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Retorna null se o DatePeriod não tiver uma data final. Por exemplo, quando inicializado com o parâmetro recurrences ou isostr sem uma data final.

Retorna um object DateTimeImmutable quando o DatePeriod é inicializado com um object DateTimeImmutable no parâmetro end.

Caso contrário, retorna um clone do object DateTime representando a data final.

Exemplos

Example #1 Exemplo de DatePeriod::getEndDate()

<?php
$period = new DatePeriod(
    new DateTime('2016-05-16T00:00:00Z'),
    new DateInterval('P1D'),
    new DateTime('2016-05-20T00:00:00Z')
);
$start = $period->getEndDate();
echo $start->format(DateTime::ISO8601);
?>

Os exemplos acima produzirão:

2016-05-20T00:00:00+0000

Example #2 Exemplo de DatePeriod::getEndDate() sem uma data final

<?php
$period = new DatePeriod(
    new DateTime('2016-05-16T00:00:00Z'),
    new DateInterval('P1D'),
    7
);
var_dump($period->getEndDate());
?>

O exemplo acima produzirá:

NULL

Veja Também