method public static

CurrencyTable::getList()

Сигнатура

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

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

CurrencyTable::getList() — метод класса \Bitrix\Currency\CurrencyTable модуля «Валюты». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_Currency, наборы — как EO_Currency_Collection. Метод достаётся CurrencyTable от DataManager::getList: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\Loader;
use Bitrix\Currency\CurrencyTable;

Loader::includeModule('currency');

$result = CurrencyTable::getList([
    'select' => ['CURRENCY', 'AMOUNT_CNT', 'AMOUNT'],
    'limit'  => 20,
]);
while ($row = $result->fetch()) {
    // $row — массив с выбранными полями
}

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

Поле	Тип	Свойства
`CURRENCY`	`string(3)`	обязательное
`AMOUNT_CNT`	`int`	необязательное, по умолчанию 1
`AMOUNT`	`float`	необязательное
`SORT`	`int`	необязательное, по умолчанию 100
`DATE_UPDATE`	`datetime`	обязательное
`NUMCODE`	`string(3)`	необязательное
`BASE`	`string(1)`	обязательное
`CREATED_BY`	`int`	необязательное
`DATE_CREATE`	`datetime`	необязательное
`MODIFIED_BY`	`int`	необязательное
`CURRENT_BASE_RATE`	`float`	необязательное
`CREATED_BY_USER`	`reference`
`MODIFIED_BY_USER`	`reference`
`LANG_FORMAT`	`reference`
`CURRENT_LANG_FORMAT`	`reference`

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

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

currencyBaseRateAgent()

getList() есть и у других классов модуля «Валюты»: CurrencyLangTable, CurrencyRateTable.

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