PHP 8.0.24 Released!

La classe DatePeriod

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

Introduction

Représente une période de dates.

Une période de dates permet des itérations à travers un jeu de dates et d'heures, survenant à intervalle régulier, sur une période donnée.

Synopsis de la classe

class DatePeriod implements IteratorAggregate {
/* Constantes */
const int EXCLUDE_START_DATE = 1;
const int INCLUDE_END_DATE = 2;
/* Propriétés */
public int $recurrences;
public bool $include_end_date;
public bool $include_start_date;
/* Méthodes */
public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    int $recurrences,
    int $options = 0
)
public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    DateTimeInterface $end,
    int $options = 0
)
public __construct(string $isostr, int $options = 0)
public getRecurrences(): ?int
}

Constantes pré-définies

DatePeriod::EXCLUDE_START_DATE

Exclut la date de début, utilisée par DatePeriod::__construct().

DatePeriod::INCLUDE_END_DATE

Inclut la date de fin, utilisée par DatePeriod::__construct().

Propriétés

recurrences

Le nombre d'ocurrences, si l'instance de DatePeriod a été crée explicitement en passant $recurrences. Voir aussi DatePeriod::getRecurrences().

include_end_date

Inclut ou non la date de fin dans le jeu de dates récurrentes.

include_start_date

S'il faut inclure la date de début dans l'ensemble des dates récurrentes ou non.

start

La date de début de la période.

current

Pendant l'itération, cela contiendra la date du jour dans la période.

end

La date de fin de la période.

interval

Une spécification d'intervalle répétitif ISO 8601.

Historique

Version Description
8.2.0 La constante DatePeriod::INCLUDE_END_DATE et la propriété include_end_date ont été ajoutées.
8.0.0 La classe DatePeriod implémente désormais IteratorAggregate. Auparavant, seule Traversable était implémentée.

Sommaire

add a note

User Contributed Notes 1 note

up
18
mail at pascalhofmann dot de
5 years ago
When looping over a DatePeriod object, the returned objects always implement DateTimeInterface. The exact type returned depends on how the DatePeriod was created. If $start was a DateTimeImmutable, the objects returned will be of type DateTimeImmutable. If a DateTime object was used, the objects returned will be of type DateTime.
To Top