method public static

HandlerTable::getList()

Класс: \Bitrix\Main\Service\GeoIp\HandlerTable

Сигнатура

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

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

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

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

use Bitrix\Main\Service\GeoIp\HandlerTable;

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`SORT`	`int`	необязательное, по умолчанию 100
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`CLASS_NAME`	`string(255)`	обязательное
`CONFIG`	`string`	необязательное

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

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

validateClassName() Возвращает валидаторы для поля CLASS_NAME.

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

Исходный файл: source/main/lib/service/geoip/handler.php