method public static

UserTable::getList()

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Intranet\UserTable;

Loader::includeModule('intranet');

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

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

createInvitedQuery()
deleteIndexRecord()
getActiveUsersCount()
getExternalUserTypes()
getIndexedFields() Возвращает массив с полями, используемыми в полнотекстовом индексе.
getSecondsForLimitOnline()
getUserGroupIds()
indexRecord()
shouldReindex() Возвращает true, если в наборе есть поля для индексации.

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