method public static

CatalogIblockTable::getList()

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

Сигнатура

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

Описание

Выполняет запрос и возвращает выборку по параметрам запроса. Эта функция является псевдонимом для функций объекта Query

Параметры

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

Массив параметров запроса, доступные ключи: "select" => массив полей в части SELECT запроса, возможны псевдонимы в виде "alias"=>"field"; "filter" => массив фильтров в части WHERE/HAVING запроса в виде "(condition)field"=>"value"; также может быть экземпляром Filter; "group" => массив полей в части GROUP BY запроса; "order" => массив полей в части ORDER BY запроса в виде "field"=>"asc|desc"; "limit" => целое число, указывающее максимальное количество строк в выборке (как LIMIT n в MySql); "offset" => целое число, указывающее номер первой строки в выборке (как LIMIT n, 100 в MySql); "runtime" => массив полей сущности, создаваемых динамически; "cache => массив опций кеширования: "ttl" => целое число, указывающее время жизни кеша (TTL); "cache_joins" => булево значение, включающее кеширование объединений, по умолчанию false.

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

EO_CatalogIblock_Result

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

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

Основной способ читать записи CatalogIblockTable. Параметры select, filter, order, limit, runtime передаются одним массивом, а возвращается EO_CatalogIblock_Result — по нему идут fetch() (массивы) или fetchObject() (объекты EO_CatalogIblock).

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

Loader::includeModule('catalog');

$result = CatalogIblockTable::getList([
    'select' => ['IBLOCK_ID', 'YANDEX_EXPORT', 'SUBSCRIPTION'],
    'limit'  => 20,
]);
while ($row = $result->fetch()) {
    // $row — массив с выбранными полями
}

Поля сущности 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() Возвращает выборку по первичному ключу сущности
getByPrimary() Возвращает выборку по первичному ключу сущности и необязательным параметрам для getList()
getCollectionClass() Возвращает класс коллекции объектов для текущей сущности.

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

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