DateTime — дата и время

Пространство имен: Bitrix\Main\Type

Модуль: main — подключать отдельно не нужно

Доступно с версии: 12.0.7

Когда использовать

Класс DateTime хранит дату со временем и часовым поясом. ORM возвращает объект DateTime для полей DatetimeField и принимает его при записи.

Конструктор без параметра timezone создает объект в часовом поясе сервера. При выводе в формате региональных настроек метод toString переводит время в часовой пояс пользователя, если на сайте включены часовые пояса. Метод toUserTime переводит время объекта во время пользователя, метод createFromUserTime создает объект из времени, которое ввел пользователь.

Для даты без времени используйте родительский класс Date.

Подробнее — в статье Дата и время.

Методы класса

Метод Описание С версии
setTime Устанавливает время
getTimeZone Возвращает часовой пояс объекта
setTimeZone Переводит объект в другой часовой пояс 14.0.18
setDefaultTimeZone Переводит объект в часовой пояс сервера 14.0.18
getOffset Возвращает смещение часового пояса объекта от UTC в секундах
secondsToOffset Переводит смещение в секундах в строку вида +0300
toUserTime Переводит время объекта во время пользователя 14.0.18
createFromUserTime Создает объект из времени пользователя 14.0.18
tryParse Создает объект из строки или возвращает null
isUserTimeEnabled Проверяет, переводит ли toString время во время пользователя
disableUserTime Отключает перевод во время пользователя в toString
enableUserTime Включает перевод во время пользователя в toString

Наследование

Класс наследует Date.

Реализация методов базового класса

Метод Особенность реализации
__construct Сигнатура __construct($time = null, $format = null, ?\DateTimeZone $timezone = null). Без строки создает текущие дату и время, а не полночь. Без формата берет формат даты и времени из региональных настроек. Параметр timezone задает часовой пояс, в котором конструктор разбирает строку. Смещение в строке, например +05:30, задает часовой пояс объекта. Название пояса в строке, например Europe/Berlin, конструктор не учитывает. Сохраняет микросекунды из строки. Сообщение исключения — Incorrect date/time: и переданная строка
toString Выводит дату и время в формате региональных настроек. Если перевод во время пользователя включен у объекта, на сайте включены часовые пояса и код не отключил их методом CTimeZone::Disable, выводит время пользователя. Сам объект не меняет
createFromPhp Сохраняет время и часовой пояс исходного объекта
createFromTimestamp Сохраняет время. Создает объект в часовом поясе сервера. Доступен с версии 15.0.7

Унаследованные методы

  • Вывод, арифметика и установка даты — format, add, setDate, getTimestamp, getDiff работают как в классе Date. Метод add сдвигает и время.
  • Форматы и проверка строки — getFormat и isCorrect у DateTime по умолчанию используют формат даты и времени.
  • Разбор текста — метод createFromText возвращает объект DateTime при вызове из любого из двух классов.

Смотрите также