Получить число связей Entity::getReferencesCountTo

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

Метод Entity::getReferencesCountTo возвращает число полей Reference, которые связывают сущность с другой сущностью.

Сигнатура метода в классе Bitrix\Main\ORM\Entity:

public function getReferencesCountTo($refEntityName)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
refEntityName* string Задает имя связанной сущности

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает число связей или 0.

Особенности

Метод переводит имя в нижний регистр, а сущность хранит имена связанных сущностей в исходном регистре с ведущим \, например \Bitrix\Main\Localization\Language. Поэтому для классов с заглавными буквами метод возвращает 0. Чтобы найти связи, переберите поля из getFields и проверьте Reference::getRefEntityName.

Примеры

Пример. Код ищет связь двумя способами:

<?php
use Bitrix\Main\Localization\LanguageTable;
use Bitrix\Main\ORM\Entity;
use Bitrix\Main\ORM\Fields\IntegerField;
use Bitrix\Main\ORM\Fields\Relations\Reference;
use Bitrix\Main\ORM\Fields\StringField;
use Bitrix\Main\ORM\Query\Join;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$entity = Entity::compileEntity('DemoUnit', [
    new IntegerField('ID', ['primary' => true]),
    new StringField('LANG_ID'),
    new Reference('LANG', LanguageTable::class, Join::on('this.LANG_ID', 'ref.LID')),
], ['namespace' => 'Vendor\Units']);

$found = array_filter($entity->getFields(), fn($field) => $field instanceof Reference
    && $field->getRefEntityName() === '\Bitrix\Main\Localization\Language');

echo $entity->getReferencesCountTo('\Bitrix\Main\Localization\Language') . ' ' . count($found);

Код выведет 0 1.

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