Функция RecVirtualFormat($dbn, $format, $rec_array)

НАЧАЛО >> API ИРБИС 64/128 >> JSON-RPC API модуля API >> Функция RecVirtualFormat($dbn, $format, $rec_array)📄 Скачать в DOCX

1. Описание функции

Функция форматирует виртуальную запись: принимает массив полей записи, создает из него временный объект записи и выполняет для него заданный формат.

В текущей реализации метод доступен через JSON-RPC сервер модуля Bitrix24: /JSONRPC.php?i128Module=Bitrix24. Он делегирует вызов функции Database::API_RecVirtualFormat($dbn, $format, $rec_array).

2. Параметры

Таблица 1. Параметры функции RecVirtualFormat
Параметр Тип Описание
$dbn string Имя базы данных, в контексте которой выполняется форматирование.
$format string Имя формата или inline-формат, который нужно применить к виртуальной записи.
$rec_array array Содержимое виртуальной записи в виде массива полей и подполей. Если клиент передал JSON-объект, сервер преобразует его в массив.

3. Возвращаемые значения

Возвращается текстовая строка с результатом форматирования. Если база данных не указана или не открывается, сервер возвращает ошибку JSON-RPC с текстом исключения.

4. Пример параметра rec_array

array(
    1 => array(
        0 => array('*' => '"A=Пушкин$"'),
    ),
)