method public static

CashboxRestHandlerTable::getList()

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

Сигнатура

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

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

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

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

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

Loader::includeModule('sale');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`NAME`	`string(255)`	обязательное
`CODE`	`string(50)`	обязательное
`SORT`	`int`	необязательное, по умолчанию 100
`SETTINGS`	`text`	обязательное

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

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

validateCode() Возвращает валидаторы для поля CODE.
validateName() Возвращает валидаторы для поля NAME.

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

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