Документация для разработчиков
Темная тема

GetList

Описание и параметры

CDBResult
CTaskTemplates::GetList(
 array arOrder = array(),
 array arFilter = array(),
 array arNavParams = array(),
 array arParams = array(),
 array arSelect = array()
);

Возвращает список шаблонов по фильтру arFilter, отсортированный в порядке arOrder.

Примечание: Метод принимает массив конфигурационных параметров и генерирует скрипты, необходимые для показа файлового диалога. Метод статический.

Параметры метода

Параметр Описание С версии
arOrder Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]).
Поле для сортировки может принимать значения:
  • TITLE - название задачи;
  • CREATED_BY - постановщик; 
  • RESPONSIBLE_ID - ответственный; 
  • GROUP_ID - рабочая группа. 
Направление сортировки может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
    Необязательный. По умолчанию фильтруется по убыванию идентификатора шаблона.
arFilter Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения:
  • ID - идентификатор шаблона;
  • TASK_ID - идентификатор задачи;
  • CREATED_BY - постановщик;
  • PRIORITY - приоритет;
  • RESPONSIBLE - ответственный;
  • TITLE - название задачи (можно искать по шаблону [%_]) ;
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно

"значения фильтра" - одиночное значение или массив.

Необязательный. По умолчанию записи не фильтруются.
arNavParams Массив параметров постраничной навигации. Необязательный. 12.5.4
arParams Массив дополнительных параметров. Принимает ключ USER_ID с указанием ID пользователя, от имени которого будут проверяться права при выборке шаблонов задач. Необязательный. 12.5.8
arSelect Массив выбираемых полей. Если указан пустой массив (по умолчанию) - то будут выбраны все поля. Необязательный. 14.0.0

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

Возвращается объект CDBResult

Примеры использования

<?

// Выбираем все шаблоны пользователя с ID = 2
if (CModule::IncludeModule("tasks"))
{
$res = CTaskTemplates::GetList(
Array("TITLE" => "ASC"),
Array("RESPONSIBLE" => "2")
);

while ($arTemplate = $res->GetNext())
{
echo "Template name: ".$arTemplate["TITLE"]."<br>";
}
}

?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх