Entity — сущность ORM

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

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

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

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

Класс Entity описывает сущность ORM — таблицу базы данных, ее поля, первичный ключ, классы объекта и коллекции. Ядро строит сущность по классу таблицы — наследнику DataManager. Объект сущности один на класс таблицы, его возвращает метод DataManager::getEntity.

use Bitrix\Main\Localization\LanguageTable;

$entity = LanguageTable::getEntity();

echo $entity->getDBTableName();
echo $entity->getPrimary();

Сущность нужна, чтобы прочитать описание полей, построить запрос Query или создать сущность на лету методом compileEntity.

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

Подробнее — в статье Концепция ORM.

Методы getUField и hasUField устарели. Пользовательские поля входят в getFields. Методы camel2snake и snake2camel устарели, используйте Bitrix\Main\Text\StringHelper. Методы enableFullTextIndex и fullTextIndexEnabled устарели. Первый ничего не делает, второй всегда возвращает true.

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

Получение и создание сущности

Метод Описание С версии
get Возвращает сущность по имени
getInstance Возвращает сущность по имени, то же, что get
has Проверяет, есть ли класс таблицы сущности
isExists Проверяет, есть ли класс таблицы сущности, то же, что has
compileEntity Создает сущность на лету
getInstanceByQuery Создает сущность по запросу
destroy Удаляет сущность из памяти

Инициализация

Метод Описание С версии
initialize Читает настройки из класса таблицы
postInitialize Создает поля и первичный ключ
reinitialize Привязывает сущность к другому классу таблицы
initializeField Создает поле по описанию
addField Добавляет поле в сущность

Сведения о сущности

Метод Описание С версии
getName Возвращает короткое имя сущности
getFullName Возвращает полное имя сущности
getNamespace Возвращает пространство имен
getModule Возвращает модуль
getDataClass Возвращает класс таблицы
getCode Возвращает код сущности
getLangCode Возвращает код языковой фразы названия
getTitle Возвращает название сущности
getConnection Возвращает соединение с базой данных
getDBTableName Возвращает имя таблицы
getPrimary Возвращает первичный ключ
getPrimaryArray Возвращает поля первичного ключа массивом
getAutoIncrement Возвращает поле с автоинкрементом
isUts Проверяет, хранит ли таблица одиночные пользовательские поля
isUtm Проверяет, хранит ли таблица множественные пользовательские поля
getUfId Возвращает объект пользовательских полей
setDefaultScope Добавляет в запрос условия по умолчанию

Поля

Метод Описание С версии
getFields Возвращает все поля
getField Возвращает поле по имени
hasField Проверяет, есть ли поле
getScalarFields Возвращает скалярные поля
getReferencesCountTo Возвращает число связей с другой сущностью
getReferencesTo Возвращает связи с другой сущностью

Объекты и коллекции

Метод Описание С версии
getObjectClass Возвращает полное имя класса объекта
getObjectClassName Возвращает короткое имя класса объекта
getDefaultObjectClassName Возвращает имя класса объекта по умолчанию
getCollectionClass Возвращает полное имя класса коллекции
getCollectionClassName Возвращает короткое имя класса коллекции
getDefaultCollectionClassName Возвращает имя класса коллекции по умолчанию
createObject Создает объект
createCollection Создает коллекцию
wakeUpObject Создает объект из готовых данных
wakeUpCollection Создает коллекцию из готовых данных
compileObjectClass Создает класс объекта, если его нет
compileCollectionClass Создает класс коллекции, если его нет

Имена классов

Метод Описание С версии
normalizeEntityClass Приводит имя к классу таблицы
normalizeName Приводит имя к имени сущности
getEntityClassParts Делит имя на пространство имен и имя сущности

Таблица в базе данных

Метод Описание С версии
compileDbTableStructureDump Возвращает SQL создания таблицы
createDbTable Создает таблицу в базе данных 14.5.1

Кеш выборок

Метод Описание С версии
readFromCache Читает результат выборки из кеша 16.5.10
writeToCache Пишет результат выборки в кеш
getCacheTtl Возвращает время жизни кеша 16.5.10
cleanCache Очищает кеш выборок сущности 16.5.10

Константы

Константа Значение Описание
DEFAULT_OBJECT_PREFIX 'EO_' Префикс имен классов объекта и коллекции по умолчанию

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