method public static

FavoriteTable::getList()

Класс: \Bitrix\Tasks\Internals\Task\FavoriteTable

Сигнатура

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

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

FavoriteTable::getList() — метод класса \Bitrix\Tasks\Internals\Task\FavoriteTable модуля «Задачи». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_Favorite, наборы — как EO_Favorite_Collection. Метод достаётся FavoriteTable от DataManager::getList: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\Loader;
use Bitrix\Tasks\Internals\Task\FavoriteTable;

Loader::includeModule('tasks');

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

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

Поле	Тип	Свойства
`TASK_ID`	`int`	обязательное
`USER_ID`	`int`	обязательное

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

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

check() Проверяет, находится ли задача в избранном у конкретного (или текущего) пользователя. Эта функция НЕ…
deleteByTaskId() Удаляет задачу из избранного для всех пользователей. Эта функция НЕ проверяет права доступа.
deleteList()
getClass()
toggle() Переключает "избранность" определённой задачи для конкретного (или текущего) пользователя. Эта функция НЕ проверяет права…

getList() есть и у других классов модуля «Задачи»: AccessTable, CheckListTable, CheckListTable, CheckListTreeTable, CheckListTreeTable, CounterTable, DependenceTable, DependenceTable.

Исходный файл: source/tasks/lib/internals/task/favorite.php