DatePeriod::getEndDate

(PHP 5 >= 5.6.5, PHP 7)

DatePeriod::getEndDate — Retourne la date de fin

Description

Style orienté objet

public DatePeriod::getEndDate ( void ) : DateTimeInterface

Retourne la date de fin de la période.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne NULL si la DatePeriod n'a pas de date de fin. Par exemple, lorsqu'elle est initialisée avec le paramètre recurrences, ou avec le paramètre isostr sans date de fin.

Renvoie un object DateTimeImmutable lorsque la DatePeriod est initialisée avec un object DateTimeImmutable comme paramètre end.

Retourne un object DateTime sinon.

Exemples

Exemple #1 Exemples avec 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);
?>

Les exemples ci-dessus vont afficher :

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

Exemple #2 DatePeriod::getEndDate() sans date de fin

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

L'exemple ci-dessus va afficher :

NULL

Voir aussi