DatePeriod::getEndDate

Gets the end date

&reftitle.description;

&style.oop;

public ``DateTimeInterface``null```DatePeriod::getEndDate`

Gets the end date of the period.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

Returns &null; if the `DatePeriod` does not have an end date. For example, when initialized with the `recurrences` parameter, or the `isostr` parameter without an end date.

Returns a `DateTimeImmutable` `object` when the `DatePeriod` is initialized with a `DateTimeImmutable` `object` as the `end` parameter.

Returns a cloned `DateTime` `object` representing the end date otherwise.

&reftitle.examples;

### `DatePeriod::getEndDate` example

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

&examples.outputs;

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

### `DatePeriod::getEndDate` without an end date

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

&example.outputs;

    NULL

&reftitle.seealso;

- `DatePeriod::getStartDate`
- `DatePeriod::getDateInterval`