Date — дата без времени
Пространство имен: Bitrix\Main\Type
Модуль: main — подключать отдельно не нужно
Доступно с версии: 12.0.10
Когда использовать
Класс Date хранит дату без времени. ORM возвращает объект Date для полей с датой и принимает его при записи. Объект хранит значение в объекте стандартного класса PHP \DateTime. Конструктор устанавливает время 00:00:00 в часовом поясе сервера.
Конструктор и метод toString работают с форматом даты из региональных настроек, если формат не передан. Метод format выводит дату по маске PHP, метод add сдвигает дату на интервал.
Для даты со временем и часовыми поясами используйте наследника DateTime. В классическом API с датами работают функции MakeTimeStamp, ConvertTimeStamp, AddToTimeStamp и CheckDateTime. Эти функции принимают и возвращают дату строкой или меткой времени Unix.
Подробнее — в статье Дата и время.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Создает дату из строки или текущую дату | |
| format | Возвращает дату строкой по маске PHP | 14.0.18 |
| add | Сдвигает дату на интервал | 14.0.18 |
| setDate | Устанавливает год, месяц и день | |
| getTimestamp | Возвращает метку времени Unix | 14.0.18 |
| getDiff | Возвращает интервал до другой даты | |
| toString | Возвращает дату строкой в формате региональных настроек | 14.0.18 |
| getFormat | Возвращает формат даты из региональных настроек в виде маски PHP | 14.0.18 |
| convertFormatToPhp | Переводит формат региональных настроек в маску PHP | 14.0.18 |
| isCorrect | Проверяет, получится ли создать дату из строки | 14.0.18 |
| createFromPhp | Создает дату из объекта PHP \DateTime |
14.5.0 |
| createFromTimestamp | Создает дату из метки времени Unix | 14.5.0 |
| createFromText | Распознает дату в тексте на языке сайта |
При приведении к строке, например echo $date, объект выводит то же, что метод toString без аргументов.
Наследование
Реализации
| Класс | Собственные методы |
|---|---|
| DateTime | Методы времени, часового пояса объекта и перевода во время пользователя — setTime, setTimeZone, toUserTime, createFromUserTime, tryParse и другие |