Права доступа к задачам
Права сотрудника на задачу проверяет контроллер доступа Bitrix\Tasks\Access\TaskAccessController. Он отвечает, может ли сотрудник выполнить конкретное действие с конкретной задачей, например прочитать, изменить или завершить ее. Команды модуля права не проверяют. Поэтому код, который меняет задачу по запросу сотрудника, сначала вызывает контроллер, а затем запускает команду. Команды описаны в статьях Создание, изменение и удаление задач и Чат, результаты, файлы и учет времени.
Общие принципы прав в Bitrix Framework описаны в статье Права доступа.
Перед запуском примеров подключите пролог Bitrix Framework и модуль tasks. Полный код подключения приведен только в примере из раздела Проверить одно действие, остальные примеры, в том числе короткие фрагменты выше этого раздела, его не содержат.
Переменная $userId в примерах содержит ID сотрудника, чьи права проверяет код, $taskId — ID задачи. Берите ID сотрудника из авторизованного контекста, например (int)CurrentUser::get()->getId(), а не из параметров запроса. Иначе запрос может подставить ID другого сотрудника, и код проверит чужие права.
Кто видит задачу
Право на чтение ACTION_TASK_READ модуль дает, если выполнено хотя бы одно условие.
-
Сотрудник — администратор, то есть состоит в группе администраторов с ID 1.
-
Сотрудник — участник задачи, то есть постановщик, ответственный, соисполнитель или наблюдатель.
-
Задача относится к проекту, где у сотрудника есть право проекта на просмотр всех задач.
-
Сотрудник — руководитель любого участника задачи, включая наблюдателей. Модуль учитывает подчиненных из вложенных отделов.
-
В роли сотрудника есть право «Просмотр всех задач в своем отделе», и постановщик, ответственный или соисполнитель задачи состоит в одном из отделов сотрудника.
-
В роли сотрудника есть право «Просмотр всех задач в других отделах», и ни постановщик, ни ответственный, ни соисполнители не состоят в отделах сотрудника.
Права по отделам учитывают только постановщика, ответственного и соисполнителей. Если в отделе сотрудника состоит только наблюдатель задачи, право «Просмотр всех задач в своем отделе» не откроет ее. Руководителю, наоборот, достаточно, чтобы его подчиненный был наблюдателем.
Роли и их права администратор настраивает в интерфейсе модуля Задачи. Права проекта хранит модуль Социальная сеть socialnetwork. Код не читает эти настройки напрямую, а получает их результат через контроллер доступа.
Кто может выполнить другие действия
Права на остальные действия модуль решает по тем же признакам — роль в задаче, права в проекте, подчиненность и права роли. Таблица показывает, кто может выполнить основные действия.
| Действие | Участники задачи | Другие сотрудники |
|---|---|---|
Изменить задачу ACTION_TASK_EDIT |
Постановщик, пока задача не завершена. После завершения — если в роли есть право «Постановщик: редактирование задачи после завершения». Ответственный — если в роли есть право «Исполнитель: редактирование задачи» и задача не завершена | Администратор. Сотрудник с правом проекта на изменение задач. Руководитель постановщика. Сотрудник с правами роли на редактирование задач своего или других отделов |
Начать выполнение ACTION_TASK_START |
Постановщик, ответственный, соисполнитель | Администратор. Сотрудник с правом проекта на изменение задач. Руководитель постановщика, ответственного или соисполнителя |
Завершить задачу ACTION_TASK_COMPLETE |
Постановщик, ответственный, соисполнитель | Администратор. Сотрудник с правом проекта на изменение задач. Руководитель постановщика, ответственного или соисполнителя |
Перенести срок ACTION_TASK_DEADLINE |
Ответственный, если задача разрешает ему перенос и срок укладывается в ограничения. Другие участники — если могут изменить задачу. Условия — в разделе Перенести крайний срок | Администратор. Руководитель постановщика. Руководитель ответственного на тех же условиях, что и ответственный. Сотрудник, который может изменить задачу |
Делегировать задачу ACTION_TASK_DELEGATE |
Постановщик. Ответственный, если в роли есть право «Исполнитель: делегирование задачи» | Администратор. Сотрудник с правом проекта на изменение задач. Руководитель постановщика, ответственного или соисполнителя |
Удалить задачу ACTION_TASK_REMOVE |
Постановщик, если он же ответственный. Постановщик, если в роли есть право «Постановщик: удаление задач» | Администратор. Руководитель постановщика. Сотрудник с правами роли на удаление задач своего или других отделов. Сотрудник с правом проекта на удаление задач |
Таблица перечисляет основные условия. Для задач в потоках модуль учитывает также настройки потока.
-
Создать задачу в потоке через
ACTION_TASK_SAVEможет сотрудник, если поток открыт для всех, сотрудник состоит в участниках потока или в одном из отделов потока. Проект задачи должен совпадать с проектом потока. -
Сменить ответственного через
ACTION_TASK_CHANGE_RESPONSIBLEможет также сотрудник, назначенный в потоке распределителем задач, и владелец потока, если задача относится к проекту. -
Делегировать задачу через
ACTION_TASK_DELEGATEможет также владелец потока, если задача относится к проекту.
Если задача ждет контроля постановщика, завершить ее могут только администратор, постановщик и руководитель постановщика, ответственного или соисполнителя. Ответственный в этом статусе получит false.
При создании задачи, смене ответственного и соисполнителей модуль дополнительно проверяет, может ли сотрудник ставить задачи выбранным людям. Сотрудник всегда может назначить себя и оставить прежних участников. Другого сотрудника он может назначить в одном из случаев.
-
Назначаемый — его подчиненный.
-
Задача относится к проекту, и оба сотрудника — участники этого проекта.
-
В роли сотрудника есть право на постановку задач, которое подходит назначаемому. Это права «Постановка задач сотрудникам своего отдела», «Постановка задач начальнику своего отдела», «Постановка задач сотрудникам других отделов» и «Постановка задач начальникам других отделов».
Экстранет-пользователя сотрудник назначит, только если у них есть общий проект.
Проверить право
Контроллер проверяет право тремя способами. Все они дают одинаковый результат, различаются только аргументы и доступ к причине отказа. Для методов объекта сначала получите объект контроллера методом TaskAccessController::getInstance($userId). Модуль создает один объект на сотрудника и возвращает его при каждом вызове, в том числе внутри can().
-
TaskAccessController::can($userId, string $action, $itemId = null, $params = null): bool— статический метод. Проверяет действие по ID сотрудника и ID задачи. -
checkByItemId(string $action, ?int $itemId = null, $params = null): bool— метод объекта контроллера. Проверяет действие по ID задачи. -
check(string $action, ?AccessibleItem $item = null, $params = null): bool— метод объекта контроллера. Проверяет действие для модели задачиBitrix\Tasks\Access\Model\TaskModel. Если вместо модели передатьnull, метод проверяет новую задачу.
Пример. Код получает объект контроллера и проверяет право изменить задачу по ее модели.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\Model\TaskModel;
use Bitrix\Tasks\Access\TaskAccessController;
$controller = TaskAccessController::getInstance($userId);
$canEdit = $controller->check(ActionDictionary::ACTION_TASK_EDIT, TaskModel::createFromId($taskId));
Методы объявлены в базовом классе Bitrix\Main\Access\BaseAccessController. Во всех трех методах последний аргумент $params — данные для проверки.
-
Тип аргумента не задан, по умолчанию он равен
null. -
В зависимости от действия в него передают модель
TaskModel, массив или модель пункта чек-листа. Что передавать для каждого действия, указано в таблице из раздела Основные действия. -
Для
ACTION_TASK_SAVEв него передают модельTaskModelс новыми данными, напримерcan($userId, ActionDictionary::ACTION_TASK_SAVE, $taskId, $model)илиcheckByItemId(ActionDictionary::ACTION_TASK_SAVE, $taskId, $model). -
Для новой задачи вместо ID задачи передают
null.
Действие передают строковой константой класса Bitrix\Tasks\Access\ActionDictionary. Если для строки у контроллера нет правила, метод выбрасывает исключение Bitrix\Main\Access\Exception\UnknownActionException. Такое случается при опечатке и при передаче действия, которое проверяет другой контроллер, как описано в разделе Изменить или удалить запись учета времени.
Классические методы CTaskItem::checkAccess() и CTaskItem::isActionAllowed() заменяет метод can(). Другие замены приведены в статье Как выбрать API задач.
Проверить одно действие
Метод can() принимает ID сотрудника, действие, ID задачи и необязательные данные для проверки $params. Для новой задачи третьим аргументом передают null. Какие данные нужны в $params, указано в таблице из раздела Основные действия.
Пример. Код проверяет, может ли текущий сотрудник прочитать и изменить задачу. Такая проверка подходит, чтобы показать или скрыть кнопки в интерфейсе.
use Bitrix\Main\Engine\CurrentUser;
use Bitrix\Main\Loader;
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
if (!Loader::includeModule('tasks'))
{
throw new \RuntimeException('Не удалось подключить модуль Задачи');
}
$userId = (int)CurrentUser::get()->getId();
$canRead = TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_READ, $taskId);
$canEdit = TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_EDIT, $taskId);
Метод не проверяет, существует ли задача. Для администратора проверка чтения вернет true и для несуществующего ID, для остальных сотрудников — false. Существование задачи проверяйте при чтении — провайдер Bitrix\Tasks\V2\Public\Provider\TaskProvider вернет null, как описано в разделе Прочитать одну задачу.
Проверка не закрепляет право. Между проверкой и командой задачу может изменить другой сотрудник. Проверяйте право непосредственно перед командой и все равно проверяйте результат команды.
Узнать причину отказа
Метод can() возвращает только true или false. Чтобы показать сотруднику причину отказа, проверьте право через объект контроллера и прочитайте сообщения.
-
clearUserErrors()— удаляет сообщения прошлых проверок. Объект копит сообщения всех проверок сотрудника за время выполнения кода, включая вызовыcan(). Вызывайте метод перед каждой проверкой, иначе к причине отказа добавятся чужие сообщения. -
getUserErrors()— возвращает массив объектовBitrix\Main\Errorс текстом для сотрудника.
Сообщение для сотрудника задают не все правила. Его задают, например, проверки чтения, изменения и сохранения задачи, переноса срока, добавления наблюдателей, файлов, изменения результата и обязательного результата. Проверки статуса и удаления сообщений не задают. Если массив пуст, покажите свой текст.
Метод getErrors() возвращает технические сообщения строками с именем класса правила. Они тоже копятся, метода очистки у них нет. Используйте их для отладки, а сотруднику показывайте сообщения из getUserErrors().
Пример. Код проверяет право сменить ответственного и выводит причину отказа. Переменная $newResponsibleId содержит ID нового ответственного.
use Bitrix\Main\Error;
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\Model\TaskModel;
use Bitrix\Tasks\Access\TaskAccessController;
use Bitrix\Tasks\Internals\TaskTable;
$current = TaskTable::getRow([
'select' => ['ID', 'CREATED_BY', 'RESPONSIBLE_ID', 'GROUP_ID'],
'filter' => ['=ID' => $taskId],
]);
if ($current === null)
{
throw new \RuntimeException('Задача не найдена');
}
$model = TaskModel::createFromArray(['RESPONSIBLE_ID' => $newResponsibleId], $current);
$controller = TaskAccessController::getInstance($userId);
$controller->clearUserErrors();
if (!$controller->checkByItemId(ActionDictionary::ACTION_TASK_SAVE, $taskId, $model))
{
$messages = array_map(
static fn(Error $error): string => $error->getMessage(),
$controller->getUserErrors()
);
throw new \RuntimeException($messages ? implode(' ', $messages) : 'Нет прав на изменение задачи');
}
Если сотрудник может редактировать задачу, но не может ставить задачи новому ответственному, исключение получит текст «Недостаточно прав для создания задачи на этого исполнителя». Если сотрудник не может редактировать задачу, текст будет «Недостаточно прав для редактирования задачи».
Понять, почему проверка вернула false
Значение false не всегда означает, что у сотрудника нет прав. Прежде чем сообщать об отказе в доступе, проверьте другие причины.
-
Статус задачи не подходит для действия. Проверки статуса возвращают
falseдаже для администратора. Статусы заданы константами классаBitrix\Tasks\Internals\Task\Status, все значения приведены в разделе Статусы.-
Действия
ACTION_TASK_STARTиACTION_TASK_DEFERпроходят только для задачи в статусеStatus::NEWилиStatus::PENDING— «Новая» или «Ждет выполнения». -
Действие
ACTION_TASK_PAUSEпроходит только для задачи в статусеStatus::IN_PROGRESS— «Выполняется». -
Действия
ACTION_TASK_APPROVEиACTION_TASK_DISAPPROVEпроходят только для задачи в статусеStatus::SUPPOSEDLY_COMPLETED— «Ждет контроля постановщика».
-
-
Задача завершена. Действия
ACTION_TASK_COMPLETE,ACTION_TASK_COMPLETE_RESULTиACTION_TASK_DELEGATEдля завершенной задачи возвращаютfalseдаже для администратора. -
Учет времени в задаче выключен, задача завершена или ждет контроля. В этих случаях действие
ACTION_TASK_TIME_TRACKINGвозвращаетfalseдля всех. -
Действие
ACTION_TASK_SAVEпроверяют без модели новых данных. Без модели проверка всегда возвращаетfalse. -
В проекте выключены задачи. Проверка
ACTION_TASK_SAVEдля такого проекта возвращаетfalseдаже для администратора. -
ID задачи указывает на служебную строку удаленной задачи с полем
ZOMBIE, равнымY. Для такой строки проверка любого действия возвращаетfalse. -
ID сотрудника равен
0. Подробнее — в разделе Проверить права другого сотрудника или в агенте.
Проверить права другого сотрудника или в агенте
Контроллер проверяет права сотрудника с переданным ID, а не текущего пользователя. Поэтому код может проверить права любого сотрудника. Администратором модуль считает сотрудника из группы администраторов с ID 1, группы другого сотрудника он читает из базы данных.
Пример. Код проверяет, увидит ли сотрудник задачу, прежде чем отправить ему ссылку на нее. Переменная $recipientId содержит ID получателя ссылки.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
if (!TaskAccessController::can($recipientId, ActionDictionary::ACTION_TASK_READ, $taskId))
{
throw new \RuntimeException('Получатель не может открыть задачу');
}
В агенте и фоновом задании авторизованного пользователя нет. Метод CurrentUser::get()->getId() возвращает null, после приведения к числу — 0. У пользователя с ID 0 нет ролей, подчиненных и прав администратора, поэтому проверки, которые зависят от них, вернут false. Проверка от ID 0 не означает проверку от имени системы.
Если агент выполняет действие по запросу сотрудника, например обрабатывает сохраненную заявку, сохраните ID этого сотрудника вместе с заявкой и проверяйте его права. Если агент выполняет служебное действие, права не проверяйте, а команде передайте ID пользователя, от имени которого выполняется действие. Подробнее — в разделе Проверить права сотрудника.
Передать новые данные в проверку
Некоторые действия зависят не только от текущей задачи, но и от новых значений. Например, сотрудник может редактировать задачу, но не может передать ее сотруднику из другого отдела. Новые значения передают в аргументе $params — моделью TaskModel или массивом, как указано в таблице из раздела Основные действия.
Модель задачи собирают двумя методами.
-
TaskModel::createFromId($taskId)— возвращает модель существующей задачи. Данные задачи модель загружает при первом обращении. Модуль хранит модели в памяти, поэтому повторный вызов с тем же ID возвращает тот же объект. -
TaskModel::createFromArray($data, $default)— собирает модель из массива с ключами в верхнем регистре. Значение модель берет из$data, а если ключа нет — из$default.
Для новой задачи передайте в createFromArray() один массив с новыми значениями, а третьим аргументом can() — null, как в разделе Проверить создание новой задачи. Для изменения во втором аргументе передайте текущие данные задачи из класса ORM Bitrix\Tasks\Internals\TaskTable с полями ID, CREATED_BY, RESPONSIBLE_ID и GROUP_ID. Без текущих данных модель не узнает проект задачи, и проверка может запретить назначить ответственным участника проекта.
Таблица показывает ключи, которые учитывают проверки.
| Ключ | Что учитывает проверка | Если ключа нет в $data |
|---|---|---|
ID |
ID задачи | Значение берется из $default |
CREATED_BY |
Постановщика. Если он отличается от текущего, проверка ACTION_TASK_SAVE дополнительно проверяет право ACTION_TASK_CHANGE_DIRECTOR. Исключение — сотрудник, который сам становится ответственным |
Значение берется из $default |
RESPONSIBLE_ID |
Ответственного. Проверка учитывает, может ли сотрудник ставить ему задачи | Значение берется из $default |
ACCOMPLICES |
Массив ID соисполнителей. Модель принимает и одно число | Значение берется из $default |
AUDITORS |
Массив ID наблюдателей. Число вместо массива модель пропускает. При изменении задачи проверка учитывает только новых наблюдателей | Значение берется из $default |
GROUP_ID |
Проект. Проверка учитывает, включены ли в проекте задачи и может ли сотрудник создавать или изменять в нем задачи. Значение 0 модель пропускает |
Значение берется из $default |
FLOW_ID |
Поток. Проверка учитывает права сотрудника в потоке | Поток не учитывается |
PARENT_ID |
Родительскую задачу. Проверка учитывает, может ли сотрудник ее прочитать | Родительская задача не учитывается |
Ключи FLOW_ID и PARENT_ID модель берет только из $data. Если новая задача создается в потоке или как подзадача, передайте их в первом аргументе, иначе проверка их не учтет.
Проверить создание новой задачи
У новой задачи еще нет ID. Поэтому модель Bitrix\Tasks\Access\Model\TaskModel собирают из одного массива, а третьим аргументом метода TaskAccessController::can() передают null.
Пример. Код проверяет, может ли сотрудник создать подзадачу в потоке и назначить ответственного. Переменная $responsibleId содержит ID ответственного, $flowId — ID потока, $parentTaskId — ID родительской задачи.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\Model\TaskModel;
use Bitrix\Tasks\Access\TaskAccessController;
$model = TaskModel::createFromArray([
'CREATED_BY' => $userId,
'RESPONSIBLE_ID' => $responsibleId,
'FLOW_ID' => $flowId,
'PARENT_ID' => $parentTaskId,
]);
if (!TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_SAVE, null, $model))
{
throw new \RuntimeException('Нет прав на создание задачи');
}
Полный пример с командой создания приведен в разделе Создать задачу.
Проверить изменение задачи
Пример. Код проверяет, может ли сотрудник перенести задачу в другой проект. Переменная $newGroupId содержит ID нового проекта.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\Model\TaskModel;
use Bitrix\Tasks\Access\TaskAccessController;
use Bitrix\Tasks\Internals\TaskTable;
$current = TaskTable::getRow([
'select' => ['ID', 'CREATED_BY', 'RESPONSIBLE_ID', 'GROUP_ID'],
'filter' => ['=ID' => $taskId],
]);
if ($current === null)
{
throw new \RuntimeException('Задача не найдена');
}
$model = TaskModel::createFromArray(['GROUP_ID' => $newGroupId], $current);
if (!TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_SAVE, $taskId, $model))
{
throw new \RuntimeException('Нет прав на перенос задачи в проект');
}
Проверка пройдет, если сотрудник может редактировать задачу, в новом проекте включены задачи и у сотрудника есть право проекта на создание или изменение задач. Как запустить команду изменения после проверки, описано в разделе Изменить задачу.
Значение GROUP_ID, равное 0, модель не принимает и берет проект из второго аргумента. Чтобы проверить задачу без проекта, удалите ключ GROUP_ID из текущих данных перед сборкой модели.
Основные действия
Действия задаются константами класса ActionDictionary. Таблица перечисляет действия для основных сценариев, данные для аргумента $params и команды, перед которыми проверяют действие.
| Действие | Что разрешает | Данные $params |
Перед какой командой проверять |
|---|---|---|---|
ACTION_TASK_READ |
Чтение задачи | — | Провайдер TaskProvider проверяет право сам. Перед AddResultCommand проверьте его в коде, подробнее — в разделе Добавить результат |
ACTION_TASK_SAVE |
Создание или изменение задачи с новыми значениями полей и участников | Модель TaskModel с новыми данными. Без нее проверка всегда возвращает false |
AddTaskCommand, UpdateTaskCommand, SetAuditorsCommand, подробнее — в разделах Создать задачу и Изменить задачу |
ACTION_TASK_CREATE |
Создание задачи в проекте. Через can() проверяет задачу без проекта и возвращает true для любого сотрудника |
— | Отдельно не проверяйте. Перед созданием проверяйте ACTION_TASK_SAVE, оно включает эту проверку |
ACTION_TASK_EDIT |
Редактирование задачи без учета новых значений | — | Перед DetachFilesCommand, подробнее — в разделе Открепить файлы. Подходит, чтобы показать или скрыть кнопку изменения |
ACTION_TASK_REMOVE |
Удаление задачи | — | DeleteTaskCommand, подробнее — в разделе Удалить задачу |
ACTION_TASK_START, ACTION_TASK_PAUSE |
Начало и приостановка выполнения | — | StartTaskCommand, PauseTaskCommand, подробнее — в разделе Сменить статус |
ACTION_TASK_COMPLETE |
Завершение задачи | — | CompleteTaskCommand вместе с ACTION_TASK_COMPLETE_RESULT, подробнее — в разделе Завершить задачу с результатом |
ACTION_TASK_APPROVE, ACTION_TASK_DISAPPROVE |
Приемка работы или возврат на доработку задачи, которая ждет контроля постановщика | — | ApproveTaskCommand, DisapproveTaskCommand. Действие ACTION_TASK_APPROVE также заменяет ACTION_TASK_COMPLETE перед CompleteTaskCommand |
ACTION_TASK_COMPLETE_RESULT |
Выполнено ли требование обязательного результата. Само право на завершение не проверяет | — | CompleteTaskCommand, подробнее — в разделе Завершить задачу с обязательным результатом |
ACTION_TASK_DEFER, ACTION_TASK_RENEW |
Откладывание и возобновление задачи | — | DeferTaskCommand, RenewTaskCommand, подробнее — в разделе Сменить статус |
ACTION_TASK_DEADLINE |
Перенос крайнего срока | Массив с ключами DEADLINE — новый срок объектом Bitrix\Main\Type\DateTime и DEADLINE_REASON — причина переноса. Ключ DEADLINE_REASON обязателен, только если в задаче включено требование указывать причину переноса. Без ключа DEADLINE проверка не учитывает ограничения переноса |
UpdateDeadlineCommand, подробнее — в разделе Перенести крайний срок |
ACTION_TASK_DELEGATE |
Передача задачи новому ответственному | Модель TaskModel с новым ответственным, как в разделе Передать новые данные в проверку. Без нее проверка не учитывает нового ответственного |
DelegateCommand, подробнее — в разделе Сменить участников |
ACTION_TASK_CHANGE_RESPONSIBLE |
Смена ответственного | Модель TaskModel с новым ответственным, как в разделе Передать новые данные в проверку. Без нее проверка не учитывает нового ответственного |
DelegateCommand. Достаточно, чтобы прошла эта проверка или проверка ACTION_TASK_DELEGATE |
ACTION_TASK_CHANGE_ACCOMPLICES |
Смена соисполнителей | Модель TaskModel с полным новым списком соисполнителей. Без нее проверка не учитывает новых соисполнителей |
SetAccomplicesCommand, подробнее — в разделе Добавить соисполнителя к текущим |
ACTION_TASK_ADD_AUDITORS |
Добавление наблюдателей. Разрешено сотруднику, который может прочитать задачу. Для экстранет-пользователей нужен общий проект | Массив ID новых наблюдателей | AddAuditorsCommand, подробнее — в разделе Сменить участников |
ACTION_TASK_ELAPSED_TIME |
Добавление записи учета времени | — | AddElapsedTimeCommand, подробнее — в разделе Учесть затраченное время |
ACTION_TASK_TIME_TRACKING |
Запуск и остановка таймера | — | StartTimerCommand, StopTimerCommand |
ACTION_TASK_ATTACH_FILE |
Прикрепление файлов. Разрешено участникам задачи и сотрудникам, которые могут ее изменить | — | AttachFilesCommand, подробнее — в разделе Прикрепить и открепить файлы |
ACTION_TASK_DETACH_FILE |
Открепление файлов | Данные вложений из модуля Диск, формат в статье не описывается | Вместо этого действия проверяйте ACTION_TASK_EDIT, подробнее — в разделе Открепить файлы |
ACTION_CHECKLIST_TOGGLE |
Отметка пункта чек-листа и снятие отметки | Модель пункта чек-листа из массива, который возвращает Bitrix\Tasks\CheckList\Task\TaskCheckListFacade::getAccessModelsByItemIds(). Третьим аргументом can() передают ID задачи |
CompleteCheckListItemsCommand, RenewCheckListItemsCommand, подробнее — в разделе Отметить пункты чек-листа |
ACTION_CHECKLIST_SAVE |
Сохранение чек-листов целиком | Массив пунктов чек-листа, формат в статье не описывается | SaveCheckListCommand |
ACTION_ELAPSED_TIME_UPDATE, ACTION_ELAPSED_TIME_DELETE |
Изменение и удаление записи учета времени. Проверяет отдельный контроллер Bitrix\Tasks\V2\Internal\Access\Tracking\Elapsed\ElapsedTimeAccessController, третьим аргументом его метода can() передают ID записи учета времени, а не ID задачи |
— | UpdateElapsedTimeCommand, DeleteElapsedTimeCommand, подробнее — в разделе Изменить или удалить запись учета времени |
Для шести действий есть особые условия. Они описаны в разделах ниже.
Перенести крайний срок
Действие ActionDictionary::ACTION_TASK_DEADLINE проверяет новый срок из аргумента $params. Проверка проходит в одном из случаев.
-
Сотрудник — администратор или руководитель постановщика.
-
Сотрудник — ответственный или руководитель ответственного, и выполнены все условия.
-
В задаче ответственному разрешено менять срок.
-
Новый срок не позже предельной даты переноса.
-
Сотрудник не исчерпал лимит переносов в задаче.
-
Указана причина в ключе
DEADLINE_REASON, если задача ее требует.
-
-
Сотрудник может изменить задачу, то есть проходит проверку
ACTION_TASK_EDIT.
Если ответственный не прошел условия и не может изменить задачу, а новый срок позже предельной даты, getUserErrors() вернет сообщение с этой датой.
Пример. Код проверяет, может ли сотрудник перенести срок задачи на неделю. Переменная $reason содержит причину переноса.
use Bitrix\Main\Type\DateTime;
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
$canMove = TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_DEADLINE, $taskId, [
'DEADLINE' => (new DateTime())->add('+7 days'),
'DEADLINE_REASON' => $reason,
]);
Метод add() объекта Bitrix\Main\Type\DateTime сдвигает дату на интервал и возвращает тот же объект. Интервал задают строкой в формате PHP DateInterval, например 7D или T2H, префикс P можно не писать. Другой вариант — относительная строка, например +7 days или -2 weeks.
Добавить наблюдателей
Действие ActionDictionary::ACTION_TASK_ADD_AUDITORS принимает в $params массив ID новых наблюдателей. Проверка учитывает, может ли сотрудник прочитать задачу и добавить каждого из них.
Пример. Код проверяет, может ли сотрудник добавить двух наблюдателей. Переменные $auditorId1 и $auditorId2 содержат их ID.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
$canAdd = TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_ADD_AUDITORS, $taskId, [$auditorId1, $auditorId2]);
Завершить задачу с обязательным результатом
Действие ACTION_TASK_COMPLETE_RESULT не проверяет право завершить задачу. Оно отвечает только на вопрос, выполнено ли требование результата. Проверка работает так.
-
Для завершенной задачи возвращает
falseдля всех. -
Для администратора и постановщика возвращает
true. -
Если результат не обязателен, возвращает
true. -
Если результат обязателен, возвращает
true, только когда последний результат задачи открыт. Новый результат открыт.
Команда CompleteTaskCommand требование результата не проверяет и завершит задачу без результата. Поэтому перед завершением проверяйте два условия — право ACTION_TASK_COMPLETE или ACTION_TASK_APPROVE и проверку ACTION_TASK_COMPLETE_RESULT. Полный пример с добавлением результата и завершением приведен в разделе Завершить задачу с результатом.
Пример. Код определяет, показывать ли сотруднику кнопку завершения задачи.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
$canClose =
TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_COMPLETE, $taskId)
|| TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_APPROVE, $taskId)
;
$showCompleteButton =
$canClose
&& TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_COMPLETE_RESULT, $taskId)
;
Если $canClose равно true, а кнопка скрыта, сотруднику нужно сначала добавить результат.
Открепить файлы
Действие ACTION_TASK_DETACH_FILE сначала проверяет право ACTION_TASK_EDIT. Если оно есть, проверка проходит. Иначе проверка требует в $params данные вложений из модуля Диск и разрешает открепить только файлы, которые сотрудник сам прикрепил или которыми владеет. Формат этих данных в статье не описывается.
Перед командой DetachFilesCommand проверяйте ACTION_TASK_EDIT. Такая проверка строже. Участник, который не может редактировать задачу, не сможет открепить и свой файл. Пример с файлами приведен в разделе Прикрепить и открепить файлы.
Отметить пункты чек-листа
Действие ACTION_CHECKLIST_TOGGLE проверяет пункт чек-листа в конкретной задаче. Третьим аргументом can() передают ID задачи, четвертым — модель пункта. Модели пунктов возвращает метод Bitrix\Tasks\CheckList\Task\TaskCheckListFacade::getAccessModelsByItemIds(). Он принимает массив ID пунктов и возвращает массив моделей с ключами — ID пунктов. Если пункта нет, ключа в массиве нет.
Проверка проходит в одном из случаев.
-
Сотрудник — администратор.
-
Сотрудник может прочитать задачу, пункт относится к этой задаче, и сотрудник — постановщик, ответственный или соисполнитель.
-
Сотрудник может прочитать задачу, пункт относится к этой задаче, и у сотрудника есть право изменять чек-лист
ACTION_CHECKLIST_EDIT.
Наблюдатель без права изменять чек-лист пункты не отметит. Без модели пункта или с пунктом другой задачи проверка вернет false всем, кроме администратора.
Пример. Код отбирает из списка пункты, которые сотрудник может отметить. Переменная $itemIds содержит массив ID пунктов.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
use Bitrix\Tasks\CheckList\Task\TaskCheckListFacade;
$models = TaskCheckListFacade::getAccessModelsByItemIds($itemIds);
$allowedIds = [];
foreach ($itemIds as $itemId)
{
if (
isset($models[$itemId])
&& TaskAccessController::can($userId, ActionDictionary::ACTION_CHECKLIST_TOGGLE, $taskId, $models[$itemId])
)
{
$allowedIds[] = $itemId;
}
}
Метод загружает модели всех пунктов одним запросом. Массив $allowedIds передайте в команду CompleteCheckListItemsCommand или RenewCheckListItemsCommand из раздела Чек-листы.
Изменить или удалить запись учета времени
Права на изменение и удаление записи учета времени проверяет отдельный контроллер Bitrix\Tasks\V2\Internal\Access\Tracking\Elapsed\ElapsedTimeAccessController. Третьим аргументом его метода can() передают ID записи учета времени, а не ID задачи.
Публичного аналога у контроллера нет, поэтому его использование — такое же исключение из правила о внутренних классах модуля, как конфигурации и объекты данных команд из пространства имен V2\Internal. Подробнее — в разделе Проверить права и запустить команду.
Если передать действия ACTION_ELAPSED_TIME_UPDATE и ACTION_ELAPSED_TIME_DELETE в TaskAccessController, метод выбросит исключение Bitrix\Main\Access\Exception\UnknownActionException. У основного контроллера нет правил для этих действий.
Изменить и удалить запись может только ее автор — сотрудник, чье время записано, и администратор. Постановщик и руководитель чужую запись не изменят. Право удаления модуль проверяет по тем же условиям, что и право изменения.
Пример. Код проверяет право удалить запись учета времени. Переменная $elapsedTimeId содержит ID записи.
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\V2\Internal\Access\Tracking\Elapsed\ElapsedTimeAccessController;
if (!ElapsedTimeAccessController::can($userId, ActionDictionary::ACTION_ELAPSED_TIME_DELETE, $elapsedTimeId))
{
throw new \RuntimeException('Нет прав на удаление записи учета времени');
}
Команды учета времени описаны в разделе Учесть затраченное время.
Проверить права для списка задач
Чтобы показать сотруднику список задач, выбирайте их методом getList() провайдера Bitrix\Tasks\V2\Public\Provider\TaskProvider. ID сотрудника передайте в аргументе userId объекта TaskListParams. Метод сам отбирает задачи, которые сотрудник может прочитать, и возвращает коллекцию объектов задач. Подробнее — в разделе Учесть права в выборке.
Другое действие для многих задач, например право изменения для кнопок в списке, проверяют методом can() для каждой задачи. Без подготовки каждая проверка загружает свою задачу отдельным запросом. Чтобы загрузить данные одним вызовом, используйте объект new AccessCacheLoader() класса Bitrix\Tasks\Access\AccessCacheLoader.
-
preload($userId, $taskIds)— загружает задачи с участниками и права сотрудника в их проектах на изменение, создание, удаление и просмотр всех задач. -
preloadForReadAccess($userId, $taskIds)— загружает те же данные и отделы участников задач, которые нужны проверке чтения. Используйте перед проверкойACTION_TASK_READдля многих задач.
После загрузки контроллер берет данные из памяти. Результат проверок от загрузки не меняется.
Пример. Код выбирает задачи проекта и определяет для каждой, может ли сотрудник ее изменить и удалить. Переменная $groupId содержит ID проекта. Формат фильтра описан в разделе Составить фильтр.
use Bitrix\Main\Provider\Params\Pager;
use Bitrix\Tasks\Access\AccessCacheLoader;
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
use Bitrix\Tasks\V2\Public\Provider\Params\TaskList\TaskListArrayFilter;
use Bitrix\Tasks\V2\Public\Provider\Params\TaskList\TaskListParams;
use Bitrix\Tasks\V2\Public\Provider\Params\TaskList\TaskListSelect;
use Bitrix\Tasks\V2\Public\Provider\Params\TaskList\TaskListSort;
use Bitrix\Tasks\V2\Public\Provider\TaskProvider;
$tasks = (new TaskProvider())->getList(new TaskListParams(
userId: $userId,
pagination: new Pager(limit: 50),
filter: new TaskListArrayFilter([
['groupId', $groupId],
]),
sort: new TaskListSort(['id' => 'desc']),
select: new TaskListSelect(['id', 'title']),
));
$taskIds = [];
foreach ($tasks as $task)
{
$taskIds[] = $task->id;
}
(new AccessCacheLoader())->preload($userId, $taskIds);
$actions = [];
foreach ($taskIds as $taskId)
{
$actions[$taskId] = [
'edit' => TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_EDIT, $taskId),
'remove' => TaskAccessController::can($userId, ActionDictionary::ACTION_TASK_REMOVE, $taskId),
];
}
Метод getList() уже учел право чтения, поэтому пример проверяет только изменение и удаление.
Отобрать задачи, которые сотрудник может прочитать
Если ID задач пришли не из выборки с учетом прав, например из другой системы или из своей таблицы, отберите задачи, которые сотрудник может прочитать. Для администратора проверка вернет true и для ID несуществующих задач.
Пример. Код оставляет в массиве $taskIds только задачи, которые может прочитать сотрудник.
use Bitrix\Tasks\Access\AccessCacheLoader;
use Bitrix\Tasks\Access\ActionDictionary;
use Bitrix\Tasks\Access\TaskAccessController;
(new AccessCacheLoader())->preloadForReadAccess($userId, $taskIds);
$readableIds = array_values(array_filter(
$taskIds,
static fn(int $taskId): bool => TaskAccessController::can(
$userId,
ActionDictionary::ACTION_TASK_READ,
$taskId
)
));
Проверить результат
Перед публикацией кода выполните в тестовом Битрикс24 несколько проверок.
-
Проверьте
ACTION_TASK_READот имени сотрудника, который не участвует в задаче и не руководит ее участниками. Проверка должна вернутьfalse. -
Добавьте подчиненного сотрудника наблюдателем задачи и проверьте
ACTION_TASK_READот имени его руководителя. Проверка должна вернутьtrue. -
Проверьте
ACTION_TASK_SAVEбез модели и убедитесь, что проверка вернулаfalse. Затем передайте модель с ответственным, которому сотрудник не может ставить задачи, и убедитесь, чтоgetUserErrors()вернул причину отказа. -
Проверьте
ACTION_TASK_STARTдля задачи в статусе «Выполняется» от имени администратора. Проверка вернетfalse, и код не должен показывать это как отказ в доступе. -
Включите в задаче требование результата. Проверьте
ACTION_TASK_COMPLETE_RESULTот имени ответственного до и после добавления результата. Проверка должна вернутьfalse, а затемtrue. -
Проверьте
ACTION_ELAPSED_TIME_UPDATEчерезElapsedTimeAccessControllerдля записи другого сотрудника. Проверка должна вернутьfalse. -
Запустите агент и убедитесь, что код не проверяет права от ID
0. -
Сравните результаты проверок для списка задач с вызовом
preload()и без него. Результаты должны совпасть.