method public static

RouteTable::getList()

Класс: \Bitrix\Main\UrlPreview\RouteTable

Сигнатура

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

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

RouteTable::getList() — метод класса \Bitrix\Main\UrlPreview\RouteTable модуля «Главный модуль». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_Route, наборы — как EO_Route_Collection. Метод достаётся RouteTable от DataManager::getList: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\UrlPreview\RouteTable;

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

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

getByRoute() Возвращает первую запись, отфильтрованную по значению $route
merge() Добавляет маршрут в таблицу маршрутов. Если запись маршрута уже существует, обновляет её.

getList() есть и у других классов модуля «Главный модуль»: AccessiblePermissionDictionary, AccessPermissionTable, AccessRoleRelationTable, AccessRoleTable, Actions, Actions, Actions, AdditionalDateType.

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