API серверной части конфигурации

Это описание относится к версии 3!!! Актуальное API — на отдельной странице: API для Iris CRM 4.0.19+.

Содержание

Функции для работы с базой данных

Операции с правами доступа

Функции для смены ответственного

Отправка email сообщений

Внутрисистемные сообщения

Деньги

Функции для работы с проектами

Работа с отчетами

API для работы с базой данных (lib.php)

Функции файла config/common/Lib/lib.php
ФункцияНазначение
IsEmptyValue()Проверка, пустое ли значение переменной.
IsEmptyRecordValue()Пустое ли значение у поля.
GetConnection()Возвращает соединение с базой данных.
GetDomainValue()Получить значение домена по его коду.
FiledValuesToAssoc()Преобразование массива объектов, содержащих значения полей, в массив ассоциативных массивов. Используется для приема и дальнейшей обработки значений полей из Javascript.
GetLinkedValues()Получить значения связанных полей по ID базового поля.
GetLinkedValuesDetailed()Получить значения связанных полей по ID базового поля и названию таблиц.
GetArrayValueByName()Получить значение элемента массива полей по названию элемента.
GetArrayValueByParameter()Получить значение элемента массива полей по значению одного из параметров.
SetArrayValueByParameter()Задать значение параметра массива (навигация по значению одного из параметров).
GetDictionaryValue()Получить значение справочника по его коду.
GetDictionaryValues()Получить значения по коду сразу из нескольких справочников.
GetDefaultDictionaryValue()Получить значение справочника, у которого значение колонки isdefault='1'.
GetDefaultDictionaryValues()Получить значения сразу из нескольких справочников. Берутся значения, у которых значение колонки isdefault='1'.
GetValuesFromTable()Получить значения полей из строки таблицы.
GetFieldValueByID()Получить значение одной колонки записи таблицы по ID.
GetFieldValuesByID()Получить значения нескольких колонок записи таблицы по ID.
GetFieldValueByFieldValue()Получить значение колонки записи таблицы по значению одной из колонок таблицы. Результат представляется в виде строки, не оформляется в виде стандартной структуры записи.
GetFieldValuesByFieldValue()Получить значения колонок записи таблицы по значению одной из колонок таблицы. Результат представляется в виде массива строк, не оформляется в виде стандартной структуры записи.
GetFormatedFieldValuesByID()Получить значения полей записи таблицы по ID записи. Результат оформляется в виде стандартной структуры записи.
GetFormatedFieldValuesByFieldValue()Получить значения полей записи таблицы по значению одной из колонок. Результат оформляется в виде стандартной структуры записи.
GetSystemVariableValue()Получить значение системной переменной по ее коду.
SetSystemVariableValue()Установить значение системной переменной по ее коду.
FieldValueFormat()Преобразование значения колонки в формат поля конфигурации.
GetShortUserInfo()Возвращает ID и ФИО пользователя по его логину.
GetDefaultOwner()Получить ответственного пользователя по умолчанию (для заполнения значениями по умолчанию полей Ответственный).
GetCurrentUserOwner()Получить ответственного пользователя по ID пользователя.
GetCurrentDBDateTime()Получить текущее дата-время из СУБД.
GetCurrentDBDate()Получить текущую дату из СУБД.
GenerateNewNumber()Сгенерировать новый номер (для документов, заказов, инцидентов и других сущностей).
UpdateNumber()Обновить номер сущности в системной переменной, присвоить последний на данный момент сгенерированный номер (для документов, заказов, инцидентов и других сущностей).
UpdateRecord()Обновить значения записи таблицы (UPDATE).
InsertRecord()Вставка записи в таблицу (INSERT).
LoadTemplate()Загрузка HTML шаблона отчета.
json_encode_str()Преобразование кодировки cp1251utf-8.
json_decode_str()Преобразование кодировки utf-8cp1251.
monthName()Получение названия месяца по его номеру.
Date_DocumentFormat()Преобразование даты в формат "31" мая 2009 г.

API для работы с правами доступа (access.php)

Функции файла config/common/Lib/access.php
ФункцияНазначение
ChangeRecordPermissions()Применяет права доступа для указанной записи в таблице.
GetRecordPermissions()Возвращает текущие права для записи.
GetDefaultRecordPermissions()Возвращает права по умолчанию, которые должны быть проставлены при добавлении записи.
SetDefaultPermissions()Применяет права по умолчнию для записи.
DeleteAllRecordPermissions()Удаляет все права доступа к указанной записи.

Функции для смены ответственного (chown.php)

Функции файла config/common/Lib/chown.php
ФункцияНазначение
ChangeOwner()Функция смены ответсвенного для сущности (компания, контакт, проект, ...).
ChangeChildOwner()Функция смены ответсвенного для сущности (компания, контакт, проект, ...)

API для работы с электронной почтой (mailfunc.php)

Функции файла config/common/Lib/mailfunc.php
ФункцияНазначение
get_mail_settings()Возвращает параметры по умолчанию для отправки писем.
conv_rus_str()
SendEmail()Отправка письма.

API для работы с сообщениями (message.php)

Функции файла config/common/Lib/message.php
ФункцияНазначение
SendEmailToUser()Отправка уведомления по email.

API для работы с деньгами (money.php)

Функции файла config/common/Lib/money.php
ФункцияНазначение
num2str()Преобразование денежной суммы в сумму прописью.

API для работы с заказами (project.php)

Функции файла config/common/Lib/project.php
ФункцияНазначение
GetRecentProject()Получение последнего активного заказа клиента.
GenerateNewOwner()Автоматическое определение ответственного в новом заказе.
SendProjectStageNotify()Отправка уведомления при изменении стадии заказа.

API для работы с отчетами (report.php)

Функции файла config/common/Lib/report.php
ФункцияНазначение
BuildReportSQL()Построение SQL кода для получения выборки данных для отчета.
BuildReportFilters()Подготавливает список фильтров для заполнения перед построением отчета.
BuildReportData()Выполнение SQL запроса и получение данных в массив.
BuildReportTable()Построение таблицы отчета по данным, которые предварительно получены из SQL запроса.
BuildReportGraph()Построение графика отчета по данным, которые предварительно получены из SQL запроса.
GetReportInfo()Возвращает название и описание отчета.
BuildReport()Построение отчета из шаблона. Фактически функция отвечает за оформление таблицы и графика отчета согласно стандартному шаблону.

Навигация