DateInterval::createFromDateString

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

DateInterval::createFromDateString — Создаёт объект DateInterval из строки с обозначениями времени в относительном формате

Описание

Объектно-ориентированный стиль

public static function DateInterval::createFromDateString(string $datetime): DateInterval

Процедурный стиль

function date_interval_create_from_date_string(string $datetime): DateInterval|false

Метод создаёт объект DateInterval из строки, которая содержит обозначения времени в относительном формате. Метод разбирает строку с датой и временем аналогично конструктору класса DateTimeImmutable.

Список параметров

datetime

Строка с обозначениями даты и времени в относительном формате, который поддерживается методами классов DateTimeImmutable, DateTime и функцией strtotime().

Интервалы на основе строки в формате стандарта ISO-8601 — наподобие P7D — создают методом DateInterval::__construct().

Возвращаемые значения

Метод возвращает новый объект DateInterval, если выполнился успешно. Процедурный стиль возвращает false, если возникла ошибка.

Ошибки

Только для объектно-ориентированного API: при передаче недопустимой строки с датой и временем метод выбрасывает исключение DateMalformedIntervalStringException.

Список изменений

Версия Описание
8.4.0 Вместо объединения типов DateInterval|false метод теперь возвращает тип DateInterval.
8.3.0 Метод DateInterval::createFromDateString() теперь выбрасывает исключение DateMalformedIntervalStringException, если передали строку в недопустимом формате. Раньше метод возвращал значение false и выдавал предупреждение. Функция date_interval_create_from_date_string() не изменилась.
8.2.0 Метод создаёт объект DateInterval, в котором останутся видимыми только свойства from_string и date_string.

Примеры

Пример #1 Пример разбора допустимых интервалов времени

<?php

// Интервалы в каждом примере эквивалентны
$i = new DateInterval('P1D');
$i = DateInterval::createFromDateString('1 day');

$i = new DateInterval('P2W');
$i = DateInterval::createFromDateString('2 weeks');

$i = new DateInterval('P3M');
$i = DateInterval::createFromDateString('3 months');

$i = new DateInterval('P4Y');
$i = DateInterval::createFromDateString('4 years');

$i = new DateInterval('P1Y1D');
$i = DateInterval::createFromDateString('1 year + 1 day');

$i = new DateInterval('P1DT12H');
$i = DateInterval::createFromDateString('1 day + 12 hours');

$i = new DateInterval('PT3600S');
$i = DateInterval::createFromDateString('3600 seconds');

Пример #2 Пример разбора комбинации обозначений и отрицательных интервалов

<?php

$i = DateInterval::createFromDateString('62 weeks + 1 day + 2 weeks + 2 hours + 70 minutes');
echo $i->format('%d %h %i'), "\n";

$i = DateInterval::createFromDateString('1 year - 10 days');
echo $i->format('%y %d'), "\n";

Результат выполнения приведённого примера: 

449 2 70
1 -10

Пример #3 Пример разбора относительных интервалов времени

<?php

$i = DateInterval::createFromDateString('last day of next month');
var_dump($i);

$i = DateInterval::createFromDateString('last weekday');
var_dump($i);

Результат выполнения приведённого примера в PHP 8.2: 

object(DateInterval)#1 (2) {
  ["from_string"]=>
  bool(true)
  ["date_string"]=>
  string(22) "last day of next month"
}
object(DateInterval)#2 (2) {
  ["from_string"]=>
  bool(true)
  ["date_string"]=>
  string(12) "last weekday"
}

Результат выполнения приведённого примера в PHP 8 аналогичен: 

object(DateInterval)#1 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(1)
  ["d"]=>
  int(0)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(2)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(0)
  ["special_amount"]=>
  int(0)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(0)
}
object(DateInterval)#2 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(0)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(1)
  ["special_amount"]=>
  int(-1)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(1)
}