method public static

DiscountCouponTable::getList()

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

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\DiscountCouponTable;

Loader::includeModule('catalog');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`DISCOUNT_ID`	`int`	обязательное
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`COUPON`	`string(32)`	обязательное
`DATE_APPLY`	`datetime`	необязательное
`TYPE`	`enum`	необязательное, по умолчанию 'O'
`TIMESTAMP_X`	`datetime`	необязательное
`MODIFIED_BY`	`int`	необязательное
`DATE_CREATE`	`datetime`	необязательное
`CREATED_BY`	`int`	необязательное
`DESCRIPTION`	`string`	необязательное
`CREATED_BY_USER`	`reference`
`MODIFIED_BY_USER`	`reference`
`DISCOUNT`	`reference`

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

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

checkCoupon() Проверить купон.
checkDiscountId() Проверить id скидки.
couponManager() Вернуть методы для менеджера купонов.
deleteByDiscount() Удалить все купоны для скидки.
getCouponTypes() Возвращает список типов купонов.
getData() Вернуть описание купона.
isExist() Проверить существующий купон.
saveApplied() Сохранить применённые купоны.
validateCoupon() Возвращает валидаторы для поля COUPON.
validateDiscountId() Возвращает валидаторы для поля DISCOUNT_ID.

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

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