Join — условие и типы соединения для связей ORM

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

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

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

Класс Join строит условия связей в методе getMap и хранит типы SQL-соединения. Метод on строит условие связи для поля Reference, а константы TYPE_* задают тип SQL-соединения в методе configureJoinType. Все методы класса статические.

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

Подробнее о связях — в статье Связи между сущностями.

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

Метод Описание С версии
on Создает условие связи, которое сравнивает два поля
getTypes Возвращает допустимые типы соединения

Константы

Константа Значение Описание
TYPE_INNER INNER Соединение INNER JOIN
TYPE_LEFT LEFT Соединение LEFT JOIN. Тип по умолчанию у поля Reference
TYPE_LEFT_OUTER LEFT OUTER Соединение LEFT OUTER JOIN
TYPE_RIGHT RIGHT Соединение RIGHT JOIN
TYPE_RIGHT_OUTER RIGHT OUTER Соединение RIGHT OUTER JOIN

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