method public static

CatalogIblockTable::getByPrimary()

Класс: \Bitrix\Catalog\CatalogIblockTable

Сигнатура

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

Описание

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

Параметры

$primary mixed

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

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

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

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

EO_CatalogIblock_Result

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

CatalogIblockTable::getByPrimary() — метод класса \Bitrix\Catalog\CatalogIblockTable модуля «Торговый каталог». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_CatalogIblock, наборы — как EO_CatalogIblock_Collection. Метод достаётся CatalogIblockTable от DataManager::getByPrimary: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\CatalogIblockTable;

Loader::includeModule('catalog');

$primary = [/*    */];
$row = CatalogIblockTable::getByPrimary($primary, [
    'select' => ['IBLOCK_ID', 'YANDEX_EXPORT', 'SUBSCRIPTION'],
])->fetch();

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

Поле	Тип	Свойства
`IBLOCK_ID`	`int`	обязательное
`YANDEX_EXPORT`	`bool`	необязательное, по умолчанию 'N'
`SUBSCRIPTION`	`bool`	необязательное, по умолчанию 'N'
`VAT_ID`	`int`	необязательное
`PRODUCT_IBLOCK_ID`	`int`	обязательное
`SKU_PROPERTY_ID`	`int`	обязательное
`IBLOCK`	`reference`
`PRODUCT_IBLOCK`	`reference`

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

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

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

getByPrimary() есть и у других классов модуля «Торговый каталог»: CatalogViewedProductTable, DiscountCouponTable, DiscountModuleTable, DiscountRestrictionTable, DiscountTable, ExtraTable, GroupAccessTable, GroupLangTable.

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