Взять имя в кавычки SqlHelper::quote
Модуль: main — подключать отдельно не нужно
Доступно с версии: 14.0.0
Метод SqlHelper::quote берет имя таблицы или колонки в кавычки идентификатора. Используйте метод для каждого имени, которое код подставляет в SQL. Аналог в классическом API — CDatabase::quote.
Сигнатура метода в классе Bitrix\Main\DB\SqlHelper:
public function quote($identifier)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| identifier* | string |
Задает имя таблицы или колонки. Может содержать имя таблицы и колонки через точку, например table.column |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод возвращает строку string — имя в кавычках. Способ зависит от реализации.
| Реализация | Как берет имя в кавычки |
|---|---|
SqlHelper |
Удаляет из имени символы кавычек идентификатора, берет в кавычки каждую часть имени между точками. Запоминает результат для каждого имени |
MysqliSqlHelper |
Удаляет из имени обратные кавычки и берет в обратные кавычки каждую часть имени между точками. Имя table.column превращается в `table`.`column` |
PgsqlSqlHelper |
Приводит имя к нижнему регистру и экранирует его целиком функцией pg_escape_identifier. Точку не считает разделителем. Подключается к базе данных, если подключения еще нет |
Исключения
| Исключение | Когда возникает |
|---|---|
Bitrix\Main\DB\ConnectionException |
В PostgreSQL подключиться к базе данных не удалось |
Примеры
Пример. Код берет в кавычки имя колонки с именем таблицы:
<?php
use Bitrix\Main\Application;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
echo Application::getConnection()->getSqlHelper()->quote('demo_api_units.CODE');
Для MySQL код выведет `demo_api_units`.`CODE`.
Смотрите также
Была ли статья полезна?
Предыдущая