DataManager — базовый класс таблицы ORM

Пространство имен: Bitrix\Main\ORM\Data

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

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

Когда использовать

Класс DataManager — родитель всех таблиц ORM, например UserTable или LanguageTable. Чтобы работать со своей таблицей через ORM, создайте наследник. Наследник задает имя таблицы методом getTableName и описывает поля методом getMap.

use Bitrix\Main\ORM\Data\DataManager;
use Bitrix\Main\ORM\Fields\IntegerField;
use Bitrix\Main\ORM\Fields\StringField;

class UnitTable extends DataManager
{
    public static function getTableName()
    {
        return 'b_units';
    }

    public static function getMap()
    {
        return [
            (new IntegerField('ID'))->configurePrimary()->configureAutocomplete(),
            (new StringField('CODE'))->configureRequired(),
            new StringField('NAME'),
        ];
    }
}

Все методы класса статические. Методы работают с таблицей наследника.

  • Методы getList, getRow, getById и getCount выбирают записи. Метод query возвращает построитель запроса.
  • Методы add, update и delete записывают данные. Перед записью методы отправляют события ORM. Методы add и update еще проверяют поля.
  • Методы createObject и wakeUpObject создают объекты ORM для работы с записью как с объектом.
  • Наследник переопределяет методы get*Class и setDefaultScope, чтобы изменить поведение ORM.

Старое имя класса Bitrix\Main\Entity\DataManager работает как псевдоним.

Подробнее — в статьях Концепция ORM, Выборка данных и Операции с сущностями и события.

Методы класса

Описание таблицы

Метод Описание С версии
getTableName Возвращает имя таблицы в базе данных 12.0.7
getMap Возвращает описание полей 12.0.7
getConnectionName Возвращает имя подключения к базе данных 12.0.9
getTitle Возвращает название таблицы
getUfId Возвращает идентификатор пользовательских полей
isUts Отмечает таблицу одиночных пользовательских полей
isUtm Отмечает таблицу множественных пользовательских полей
setDefaultScope Добавляет условия во все запросы к таблице
postInitialize Дополняет сущность после создания
isCacheable Разрешает или запрещает кеш выборок
getEntity Возвращает сущность ORM
unsetEntity Удаляет сущность из памяти класса

Выборка

Метод Описание С версии
getList Выбирает записи по параметрам
getRow Возвращает одну запись по параметрам
getByPrimary Выбирает запись по первичному ключу
getById Выбирает запись по первичному ключу без параметров
getRowById Возвращает одну запись по первичному ключу 14.0.0
getCount Возвращает число записей 12.0.10
query Создает построитель запроса

Запись

Метод Описание С версии
add Добавляет запись
addMulti Добавляет несколько записей
update Изменяет запись
updateMulti Изменяет несколько записей
delete Удаляет запись
checkFields Проверяет значения полей
cleanCache Очищает кеш выборок
setCurrentDeletingObject Передает объект, который удаляет себя

Объекты

Метод Описание С версии
createObject Создает объект новой записи
createCollection Создает пустую коллекцию
wakeUpObject Создает объект существующей записи
wakeUpCollection Создает коллекцию существующих записей
getObjectClass Возвращает класс объекта
getObjectClassName Возвращает короткое имя класса объекта
getCollectionClass Возвращает класс коллекции
getCollectionClassName Возвращает короткое имя класса коллекции
getObjectParentClass Возвращает родительский класс объекта
getCollectionParentClass Возвращает родительский класс коллекции
getQueryClass Возвращает класс построителя запроса
getEntityClass Возвращает класс сущности

Шифрование

Метод Описание С версии
enableCrypto Включает шифрование поля 17.5.14
cryptoEnabled Проверяет, включено ли шифрование поля 17.5.14

Константы

Константа Значение Описание
EVENT_ON_BEFORE_ADD, EVENT_ON_ADD, EVENT_ON_AFTER_ADD 'OnBeforeAdd', 'OnAdd', 'OnAfterAdd' События метода add
EVENT_ON_BEFORE_UPDATE, EVENT_ON_UPDATE, EVENT_ON_AFTER_UPDATE 'OnBeforeUpdate', 'OnUpdate', 'OnAfterUpdate' События метода update
EVENT_ON_BEFORE_DELETE, EVENT_ON_DELETE, EVENT_ON_AFTER_DELETE 'OnBeforeDelete', 'OnDelete', 'OnAfterDelete' События метода delete

Обработчики событий в наследнике

Наследник может объявить статические методы onBeforeAdd, onAdd, onAfterAdd, onBeforeUpdate, onUpdate, onAfterUpdate, onBeforeDelete, onDelete и onAfterDelete. ORM вызывает метод при событии таблицы и передает ему объект Event. Так таблица обрабатывает свои события без регистрации обработчика.

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