method public static

Tree::getList()

Класс: \Bitrix\Tasks\Internals\DataBase\Tree

Сигнатура

public static getList([array<string|int, mixed> $parameters = array() ]) : Result

Описание

Выполняет запрос и возвращает выборку по параметрам запроса. Эта функция является псевдонимом для функций объекта Query

Параметры

$parameters array<string|int, mixed> = array()

Массив параметров запроса, доступные ключи: "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.

Возвращаемое значение

Result

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Tasks\Internals\DataBase\Tree;

Loader::includeModule('tasks');

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

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

createLink() Связывает один элемент с другим. Низкоуровневый метод.
deleteLink() Разрывает связь между узлами. Низкоуровневый метод.
deleteSubtree()
dropLinkL()
getDIRECTColumnName()
getIDColumnName()
getLinkCount()
getParentId()
getPARENTIDColumnName()
getPathToNode()
getPathToNodeSql()
getSubTree()

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

Исходный файл: source/tasks/lib/internals/database/tree.php:431