Клас DatePeriod
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
Вступ
Представляє тимчасовий період.
Дозволяє переміщатися в заданому часовому інтервалі на рівні проміжки часу.
Огляд класів
class DatePeriod
implements
IteratorAggregate {
/* Константы */
public
const
int
EXCLUDE_START_DATE;
public
const
int
INCLUDE_END_DATE;
/* Свойства */
public
readonly
?DateTimeInterface
$start;
public
readonly
?DateTimeInterface
$current;
public
readonly
?DateTimeInterface
$end;
public
readonly
?DateInterval
$interval;
public
readonly
int
$recurrences;
public
readonly
bool
$include_start_date;
public
readonly
bool
$include_end_date;
/* Методы */
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 static createFromISO8601String(string $specification, int $options = 0): static
public getDateInterval(): DateInterval
public getEndDate(): ?DateTimeInterface
public getRecurrences(): ?int
public getStartDate(): DateTimeInterface
}
Обумовлені константи
DatePeriod::EXCLUDE_START_DATE
Виключає початкову дату, використовується в DatePeriod::__construct()
DatePeriod::INCLUDE_END_DATE
Включає дату закінчення, використовується в DatePeriod::__construct()
Властивості
recurrences
Мінімальна кількість екземплярів, що повертається ітератором.
Якщо кількість повторень була явно передана за допомогою параметра recurrences конструктор екземпляра DatePeriod, то ця властивість містить це значення, плюс один, якщо дата початку не була відключена за допомогою константи DatePeriod::EXCLUDE_START_DATE
плюс один, якщо дата закінчення була включена за допомогою константи DatePeriod::INCLUDE_END_DATE
Якщо кількість повторень не було передано явно, то ця властивість містить мінімальну кількість повернутих екземплярів. Це буде плюс один, якщо дата початку не вимкнена за допомогою константи DatePeriod::EXCLUDE_START_DATE
плюс один, якщо дата закінчення була включена за допомогою константи DatePeriod::INCLUDE_END_DATE
Loading...
Результат виконання наведеного прикладу:
5
6
7
Смотрите также описание методаDatePeriod::getRecurrences()
include_end_date
Включати дату закінчення в набір дат, що повторюються, чи ні.
include_start_date
Включати початкову дату в набір дат чи ні.
start
Дата початку періоду.
current
У процесі ітерації міститиме поточну дату періоду.
end
Кінцева дата періоду.
interval
Специфікація інтервалу, що повторюється згідно ISO 8601.
список змін
Версия | Опис |
---|---|
8.2.0 | Були додані константа DatePeriod::INCLUDE_END_DATE та властивість include_end_date. |
8.0.0 | КлассDatePeriod тепер реалізує інтерфейс IteratorAggregate. . Раніше натомість було реалізовано інтерфейс Traversable |
Зміст
- DatePeriod::__construct— Створює новий об'єкт DatePeriod
- DatePeriod::createFromISO8601String— Створює новий об'єкт DatePeriod із рядка у форматі стандарту ISO8601
- DatePeriod::getDateInterval - Повертає інтервал
- DatePeriod::getEndDate— Повертає кінцеву дату періоду
- DatePeriod::getRecurrences— Отримує кількість повторів
- DatePeriod::getStartDate— Повертає початкову дату періоду