Класс 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 |
addProjectDependence | Добавляет зависимость одной задачи от другой в рамках Ганта. | |
updateProjectDependence | Обновляет зависимость одной задачи от другой в рамках Ганта. | 15.6.0 |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024