method public static

DiscountTable::getList()

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

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\DiscountTable;

Loader::includeModule('catalog');

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

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

ПолеТипСвойства
IDintобязательное
XML_IDstring(255)необязательное
SITE_IDstring(2)обязательное
TYPEintобязательное
ACTIVEboolнеобязательное, по умолчанию 'Y'
ACTIVE_FROMdatetimeнеобязательное
ACTIVE_TOdatetimeнеобязательное
RENEWALboolнеобязательное, по умолчанию 'N'
NAMEstring(255)необязательное
SORTintнеобязательное, по умолчанию 100
MAX_DISCOUNTdoubleнеобязательное
VALUE_TYPEstring(1)обязательное, по умолчанию 'P'
VALUEdoubleобязательное, по умолчанию 0.0000
CURRENCYstring(3)обязательное
TIMESTAMP_Xdatetimeобязательное, по умолчанию 'CURRENT_TIMESTAMP'
COUNT_PERIODstring(1)обязательное, по умолчанию 'U'
COUNT_SIZEintобязательное
COUNT_TYPEboolнеобязательное, по умолчанию 'Y'
COUNT_FROMdatetimeнеобязательное
COUNT_TOdatetimeнеобязательное
ACTION_SIZEintобязательное
ACTION_TYPEboolнеобязательное, по умолчанию 'Y'
MODIFIED_BYintнеобязательное
DATE_CREATEdatetimeнеобязательное
CREATED_BYintнеобязательное
PRIORITYintнеобязательное, по умолчанию 1
LAST_DISCOUNTboolнеобязательное, по умолчанию 'Y'
VERSIONintнеобязательное, по умолчанию 1
NOTESstring(255)необязательное
CONDITIONSstringнеобязательное
UNPACKstringнеобязательное
USE_COUPONSboolнеобязательное, по умолчанию 'N'
CREATED_BY_USERreference
MODIFIED_BY_USERreference
RESTRICTIONreference

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

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

  • checkType() Проверить поле TYPE.
  • convertCurrency() Преобразовать данные скидки в другую валюту (валюту магазина).
  • setUseCoupons() Установить флаг наличия купонов для списка скидок.
  • validateCurrency() Возвращает валидаторы для поля CURRENCY.
  • validateName() Возвращает валидаторы для поля NAME.
  • validateNotes() Возвращает валидаторы для поля NOTES.
  • validateSiteId() Возвращает валидаторы для поля SITE_ID.
  • validateType() Возвращает валидаторы для поля TYPE.
  • validateXmlId() Возвращает валидаторы для поля XML_ID.

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

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

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