method public static

GroupTable::getList()

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\GroupTable;

Loader::includeModule('catalog');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`NAME`	`string(100)`	обязательное
`BASE`	`bool`	необязательное, по умолчанию 'N'
`SORT`	`int`	необязательное, по умолчанию 100
`XML_ID`	`string(255)`	необязательное
`TIMESTAMP_X`	`datetime`	необязательное
`MODIFIED_BY`	`int`	необязательное
`DATE_CREATE`	`datetime`	необязательное
`CREATED_BY`	`int`	необязательное
`LANG`	`reference`
`CURRENT_LANG`	`reference`

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

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

getBasePriceType() Возвращает кешированный базовый тип цены или null.
getBasePriceTypeId() Возвращает кешированный id базового типа цены или null.
getTypeList() Возвращает кешированный список типов цен.

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

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