method public static

ProductTable::getList()

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

Сигнатура

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Product_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_Product_Result

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\ProductTable;

Loader::includeModule('catalog');

$result = ProductTable::getList([
    'select' => ['ID', 'QUANTITY', 'QUANTITY_TRACE'],
    'filter' => ['>ID' => 0],
    'limit'  => 20,
]);
while ($row = $result->fetch()) {
    // $row — массив с выбранными полями
}

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

ПолеТипСвойства
IDintобязательное
QUANTITYdoubleобязательное
QUANTITY_TRACEboolнеобязательное, по умолчанию 'N'
WEIGHTdoubleобязательное
TIMESTAMP_Xdatetimeобязательное, по умолчанию 'CURRENT_TIMESTAMP'
PRICE_TYPEstring(1)обязательное, по умолчанию 'S'
RECUR_SCHEME_LENGTHintнеобязательное
RECUR_SCHEME_TYPEstring(1)обязательное, по умолчанию 'D'
TRIAL_PRICE_IDintнеобязательное
WITHOUT_ORDERboolнеобязательное, по умолчанию 'N'
SELECT_BEST_PRICEboolнеобязательное, по умолчанию 'Y'
VAT_IDintнеобязательное
VAT_INCLUDEDboolнеобязательное, по умолчанию 'Y'
CAN_BUY_ZEROboolнеобязательное, по умолчанию 'N'
NEGATIVE_AMOUNT_TRACEstring(1)обязательное, по умолчанию 'D'
TMP_IDstring(40)необязательное
PURCHASING_PRICEdoubleнеобязательное
PURCHASING_CURRENCYstring(3)необязательное
BARCODE_MULTIboolнеобязательное, по умолчанию 'N'
QUANTITY_RESERVEDdoubleнеобязательное
SUBSCRIBEstring(1)необязательное
WIDTHdoubleнеобязательное
LENGTHdoubleнеобязательное
HEIGHTdoubleнеобязательное
MEASUREintнеобязательное
TYPEintнеобязательное
AVAILABLEstring(1)необязательное
BUNDLEstring(1)необязательное
IBLOCK_ELEMENTreference
TRIAL_IBLOCK_ELEMENTreference
TRIAL_PRODUCTreference

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

Собственные методы ProductTable

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

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

Что будем искать? Например,Продвижение