method public static

DiscountGroupTable::getList()

Класс: \Bitrix\Sale\Internals\DiscountGroupTable

Сигнатура

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

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

DiscountGroupTable::getList() — метод класса \Bitrix\Sale\Internals\DiscountGroupTable модуля «Интернет-магазин». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_DiscountGroup, наборы — как EO_DiscountGroup_Collection. Метод достаётся DiscountGroupTable от DataManager::getList: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\Loader;
use Bitrix\Sale\Internals\DiscountGroupTable;

Loader::includeModule('sale');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`DISCOUNT_ID`	`int`	обязательное
`ACTIVE`	`string(1)`	необязательное
`GROUP_ID`	`int`	обязательное
`DISCOUNT`	`reference`

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

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

changeActiveByDiscount() Изменить флаг активности в таблице по скидке.
deleteByDiscount() Удаляет список групп пользователей по скидке.
getActiveDiscountByGroups() Возвращает активные скидки по списку групп пользователей.
getDiscountByGroups() Возвращает список скидок по группам пользователей.
updateByDiscount() Обновляет список групп пользователей по скидке.

getList() есть и у других классов модуля «Интернет-магазин»: Basket, BasketArchivePackedTable, BasketArchiveTable, BasketBase, BasketPropertiesCollection, BasketPropertiesCollectionBase, BasketPropertyItem, BasketPropertyItemBase.

Исходный файл: source/sale/lib/internals/discountgroup.php