method public static

VatTable::getList()

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Catalog\VatTable;

Loader::includeModule('catalog');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`TIMESTAMP_X`	`datetime`	обязательное, по умолчанию 'CURRENT_TIMESTAMP'
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`SORT`	`int`	необязательное, по умолчанию 100
`NAME`	`string(50)`	обязательное
`RATE`	`double`	обязательное, по умолчанию 0.00

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

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

getActiveVatIdByRate() Возвращает ID активной ставки НДС для указанного значения. При необходимости создаёт новую ставку НДС.
getExcludeVatId() Возвращает id исключаемого НДС, если существует.
isExistsExcludeVat() Возвращает true, если существует системный НДС.

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

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