Преобразовать дату для SQL SqlHelper::convertToDbDate

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

Метод SqlHelper::convertToDbDate превращает объект даты в литерал даты SQL без времени.

Сигнатура метода в классе Bitrix\Main\DB\SqlHelper:

public function convertToDbDate($value)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
value* Bitrix\Main\Type\Date, null Задает дату. Объект DateTime тоже подходит, время метод отбрасывает

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод возвращает строку string. Для пустого значения — NULL. Для объекта — результат getCharToDateFunction с датой в формате Y-m-d, например '2024-01-01' в MySQL и timestamp '2024-01-01' в PostgreSQL.

Исключения

Исключение Когда возникает
Bitrix\Main\ArgumentTypeException Код передал непустое значение, но не объект Bitrix\Main\Type\Date

Примеры

Пример. Код готовит дату для условия запроса:

<?php
use Bitrix\Main\Application;
use Bitrix\Main\Type\Date;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$helper = Application::getConnection()->getSqlHelper();

echo 'DATE_REGISTER >= ' . $helper->convertToDbDate(new Date('2024-01-01', 'Y-m-d'));

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