Подготовить текстовую колонку для сортировки SqlHelper::softCastTextToChar

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

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

Метод SqlHelper::softCastTextToChar возвращает выражение текстовой колонки для группировки и сортировки. ORM вызывает метод, когда строит GROUP BY и ORDER BY по текстовому полю, но только для соединений с Oracle и MS SQL. Для MySQL и PostgreSQL ORM метод не вызывает.

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

abstract public function softCastTextToChar($fieldName);

Параметры

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

Параметр Тип Описание
fieldName* string Задает колонку или SQL-выражение. Метод подставляет значение в SQL без экранирования

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

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

Метод возвращает строку string. Реализации MysqliSqlHelper и PgsqlSqlHelper возвращают fieldName без изменений.

Примеры

Пример. Код выводит выражение для колонки:

<?php
use Bitrix\Main\Application;

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

echo Application::getConnection()->getSqlHelper()->softCastTextToChar('NOTE');

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