Версия:
Прочие методы get
В базовом классе, помимо основного метода get, реализован ряд специализированных методов для получения данных, упрощающих решение типовых задач.
getById
Упрощенный метод для получения записи по её уникальному идентификатору (id).
- Особенности:
- В отличие от базового
get, он не принимает параметрыwhereиparam_where. Вместо них передается непосредственноid. - Принимает параметры
columnsи другие, применимые и осмысленные для точечного запроса. - Обработка ошибок: Если запись с указанным
idне найдена, метод выбрасывает ошибку «Запись не найдена». В отличии от методаget, где, если по переданным условиям записи не найдены, это НЕ является ошибкой.
- В отличие от базового
- Формат ответа:
- Найденная запись располагается в
res.data.rows[0]. - В последних версиях ядра запись также дублируется в свойство
res.data.rowдля более удобного доступа.
- Найденная запись располагается в
getCount
Метод для получения общего количества записей, удовлетворяющих заданным условиям.
- Механика: Внутри вызывает стандартный метод
getс установленным параметромcountOnly=true. - Результат: Количество записей возвращается в поле
res.data.count.
getForSelect
Специализированный метод, используемый для формирования данных для выпадающих списков (select).
- Подробное описание в текущей версии документации отсутствует.
getForFilterSelect
Метод, используемый для формирования списков выбора в фильтрах клиентских компонентов.
- Подробное описание в текущей версии документации отсутствует.
search
Метод для выполнения быстрого поиска по строковому значению.
- Механика: Получает строку поиска и автоматически подставляет её в условие
where(с предварительным экранированием) для каждого поля, которое отмечено в профайле класса какquick_search_field.
getMass
Deprecated (Устарело). Данный метод более не рекомендуется к использованию.
export_to_excel
Метод для экспорта данных в формат Excel.
- Особенности: Формирует Excel-файл с теми же настройками колонок и фильтрацией данных, что и в клиентской таблице, из которой был инициирован вызов.
export_to_json
Метод для экспорта данных в формат JSON.
- Особенности: Формирует JSON-файл на основе текущих настроек и данных клиентской таблицы.