DatePeriod::getEndDate

(PHP 5 >= 5.6.5, PHP 7)

DatePeriod::getEndDate — 終了日を取得する

説明

オブジェクト指向型

public DatePeriod::getEndDate ( void ) : DateTimeInterface

期間の終了日を取得する。

パラメータ

この関数にはパラメータはありません。

返り値

DatePeriod が終了日を持たない場合は NULL を返す。 たとえば、recurrences パラメータや、終了日のない isostr パラメータを用いて初期化されている場合である。

DatePeriod が DateTimeImmutable object を end パラメータに用いて初期化されている場合は DateTimeImmutable object を返す。

それ以外の場合は DateTime object を返す。

例

例1 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);
?>

上の例の出力は以下となります。

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

例2 終了日のない DatePeriod::getEndDate()

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

上の例の出力は以下となります。

NULL

参考