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

Класс CTaskItem

Описание

CTaskItem — высокоуровневое API для работы с отдельными задачами (включает в себя бизнес-логику).

Следует использовать вместо вызовов CTasks::Update(), CTasks::Delete() и т.д.;

  • позволяет вести работу с задачей от имени заданного (не обязательно текущего авторизованного) пользователя;
  • обладает внутренним механизмом прозрачного кэширования (не нужно следить за актуализацией кэша при работе с задачей через этот класс — при условии инстанцирования через getInstance());
  • применяется блочная «ленивая» подгрузка данных, что благоприятно сказывается на производительности;

Для работы с классом нужно его инстанцировать для конкретной задачи в контексте прав определенного пользователя.

Не является мультитоном, однако рекомендуется инстанцировать экземпляр класс с помощью статического метода getInstance(), т. к. в таком случае будет автоматически поддерживаться актуальность кэша.

Например,

<?
$taskId = 7;
$userId = $USER->getId();
$oTask = CTaskItem::getInstance($taskId, $userId);
?>

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

ПараметрОписание
$taskIdидентификатор задачи.
$userIdидентификатор пользователя, от имени которого ведется работа (для возможности имперсонализации).

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

Объект класса CTaskItem. При повторном вызове метода с параметрами, которые уже были переданы ранее, будет возвращен один и тот же объект.

array
public function getManifest();

Возвращает массив с описанием класса.

Внимание! Формат массива может произвольно меняться в будущем, он не предназначен для автоматической обработки, однако может быть очень удобен в процессе разработки, т. к. содержит, к примеру, список методов доступных в REST, принимаемые ими значения и т.д.

Список методов

Метод Описание С версии
addМетод возвращает экземпляр класса CTaskItem. 12.5.3
getDataМетод возвращает массив, содержащий данные о задаче. 12.5.4
getDescriptionМетод возвращает описание задачи.
getFilesМетод возвращает массив, содержащий идентификаторы файлов, прикрепленных к задаче. 12.5.4
getTagsМетод возвращает массив, содержащий теги заданного пользователя в задаче. 12.5.4
getDependsOnМетод возвращает массив, содержащий идентификаторы задач, от которых зависит задача. 12.5.4
getAllowedActionsМетод возвращает массив, описывающий допустимые действия над задачей. 12.5.8
isActionAllowedМетод проверяет разрешено ли действие.
deleteМетод удаляет задачу. 12.5.3
delegateМетод делегируюет задачу пользователю.
startExecutionМетод переводит задачу в статус «выполняется».
deferМетод переводит задачу в статус «отложена».
renewМетод переводит задачу в статус «не выполняется».
completeМетод переводит задачу в статус «завершена» или «условно завершена (ждет контроля исполнителя)».
approveМетод переводит задачу, ожидающую контроля, в статус «завершена».
disapproveМетод переводит задачу, ожидающую контроля, в статус «не выполняется».
updateМетод изменяет параметры задачи. 12.5.3
addByTemplateМетод добавляет задачу по шаблону. 14.5.11
addChildTaskByTemplateМетод добавляет подзадачи из шаблона. 14.5.11
duplicateМетод копирует задачу или задачи. 14.5.11
duplicateChildTasksМетод копирует подзадачи выбранной задачи. 14.5.11
addToFavoriteДанный метод добавляет задачу в Избранное. 15.6.0
deleteFromFavoriteДанный метод удаляет задачу из Избранного. 15.6.0
toggleFavoriteДанный метод меняет для указанной задачи состояние избранности. 15.6.0


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

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

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

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

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