method public static

SortingTable::getList()

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

Сигнатура

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

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

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

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

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

Loader::includeModule('tasks');

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

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

deleteByTaskId() Удаляет задачу из дерева сортировки
deleteList()
fixSiblingsEx() То же, что deleteByTaskId, но без самого удаления
getClass()
insertBatch() Добавляет строки в таблицу.
insertIgnore()
setSorting() Устанавливает сортировку для задачи.

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

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