method public static

IblockFieldTable::getByPrimary()

Сигнатура

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_IblockField_Result

Описание

Возвращает выборку по первичному ключу сущности и необязательным параметрам для getList()

Параметры

$primary mixed

Первичный ключ сущности

$parameters array<string|int, mixed> = = '[]'

Дополнительные параметры для getList()

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

EO_IblockField_Result

Как применяется в IblockFieldTable

IblockFieldTable::getByPrimary() — метод класса \Bitrix\Iblock\IblockFieldTable модуля «Информационные блоки». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_IblockField, наборы — как EO_IblockField_Collection. Метод достаётся IblockFieldTable от DataManager::getByPrimary: поведение общее для всех сущностей, а данные, поля и классы — свои.

То же, что getById(), но с параметрами getList() вторым аргументом. Для составного ключа IblockFieldTable передаётся массивом.

use Bitrix\Main\Loader;
use Bitrix\Iblock\IblockFieldTable;

Loader::includeModule('iblock');

$primary = [/*    */];
$row = IblockFieldTable::getByPrimary($primary, [
    'select' => ['IBLOCK_ID', 'FIELD_ID', 'IS_REQUIRED'],
])->fetch();

Поля сущности IblockFieldTable

Поле	Тип	Свойства
`IBLOCK_ID`	`int`	обязательное
`FIELD_ID`	`string(50)`	обязательное
`IS_REQUIRED`	`bool`	необязательное, по умолчанию 'N'
`DEFAULT_VALUE`	`string`	необязательное
`IBLOCK`	`reference`

Список — из описания класса в исходном коде; точный состав в вашей версии вернёт IblockFieldTable::getEntity()->getFields().

Другие методы IblockFieldTable

add() Добавляет строку в таблицу сущности
addMulti() Добавляет несколько строк в таблицу сущности.
checkFields() Проверяет поля данных перед сохранением в БД. Результат хранится в объекте $result
cleanCache() Очищает кеш таблета после модификаций данных.
createCollection()
createObject()
cryptoEnabled() Возвращает true, если для поля включено шифрование.
delete() Удаляет строку в таблице сущности по первичному ключу
enableCrypto() Устанавливает флаг, указывающий на поддержку шифрования для поля.
getById() Возвращает выборку по первичному ключу сущности
getCollectionClass() Возвращает класс коллекции объектов для текущей сущности.
getCollectionClassName() Возвращает имя класса (без пространства имён) коллекции объектов для текущей сущности.

getByPrimary() есть и у других классов модуля «Информационные блоки»: ElementTable, IblockGroupTable, IblockMessageTable, IblockRssTable, IblockSiteTable, IblockTable, InheritedPropertyTable, PropertyEnumerationTable.

Исходный файл: source/iblock/lib/iblockfieldtable.php