701 lines
23 KiB
PHP
701 lines
23 KiB
PHP
<?php
|
||
|
||
namespace frontend\modules\api\controllers;
|
||
|
||
use common\classes\Debug;
|
||
use common\models\ProjectTask;
|
||
use common\models\ProjectTaskUser;
|
||
use common\models\User;
|
||
use frontend\modules\api\models\project\ProjectColumn;
|
||
use frontend\modules\api\services\TaskService;
|
||
use Yii;
|
||
use yii\base\InvalidConfigException;
|
||
use yii\data\ActiveDataProvider;
|
||
use yii\web\BadRequestHttpException;
|
||
use yii\web\NotFoundHttpException;
|
||
use yii\web\ServerErrorHttpException;
|
||
|
||
class TaskController extends ApiController
|
||
{
|
||
/**
|
||
* @var TaskService
|
||
*/
|
||
private TaskService $taskService;
|
||
|
||
/**
|
||
* @param $id
|
||
* @param $module
|
||
* @param TaskService $taskService
|
||
* @param array $config
|
||
*/
|
||
public function __construct($id, $module, TaskService $taskService, $config = [])
|
||
{
|
||
$this->taskService = $taskService;
|
||
parent::__construct($id, $module, $config);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Post(path="/task/create-task",
|
||
* summary="Добавить задачу",
|
||
* description="Метод для создания задачи, если не передан параметр <b>user_id</b>, то будет получен текущий пользователь",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
*
|
||
* @OA\RequestBody(
|
||
* @OA\MediaType(
|
||
* mediaType="multipart/form-data",
|
||
* @OA\Schema(
|
||
* required={"project_id", "status", "title", "description"},
|
||
* @OA\Property(
|
||
* property="project_id",
|
||
* type="string",
|
||
* description="Идентификатор проекта",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="title",
|
||
* type="string",
|
||
* description="Заголовок задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="description",
|
||
* type="string",
|
||
* description="Описание задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="status",
|
||
* type="integer",
|
||
* description="статус",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="dead_line",
|
||
* type="string",
|
||
* description="Срок выполнения задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="priority",
|
||
* type="integer",
|
||
* description="Приоритет задачи.",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="execution_priority",
|
||
* type="integer",
|
||
* description="Приоритет выполнения задачи (0 - low, 1 - medium, 2 - high)",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="column_id",
|
||
* type="integer",
|
||
* description="Колонка к которой относится задача",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="user_id",
|
||
* type="integer",
|
||
* description="Идентификатор создателя задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="executor_id",
|
||
* type="integer",
|
||
* description="Идентификатор исполнителя задачи",
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект задачи",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTask"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @throws InvalidConfigException
|
||
* @throws ServerErrorHttpException
|
||
*/
|
||
public function actionCreateTask(): ProjectTask
|
||
{
|
||
$request = Yii::$app->getRequest()->getBodyParams();
|
||
if (!isset($request['user_id']) or $request['user_id'] == null) {
|
||
$request['user_id'] = Yii::$app->user->id;
|
||
}
|
||
|
||
$taskModel = $this->taskService->createTask($request);
|
||
if ($taskModel->errors) {
|
||
throw new ServerErrorHttpException(json_encode($taskModel->errors));
|
||
}
|
||
return $taskModel;
|
||
}
|
||
|
||
|
||
/**
|
||
*
|
||
* @OA\Get(path="/task/get-task-list",
|
||
* summary="Получить список задач по проекту",
|
||
* description="Метод для получения задач по проекту",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
* @OA\Parameter(
|
||
* name="project_id",
|
||
* in="query",
|
||
* required=true,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="user_id",
|
||
* description="При передаче этого параметера вернёт все задачи на проекте для пользователя с заданным id",
|
||
* in="query",
|
||
* required=false,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="expand",
|
||
* in="query",
|
||
* example="column,timers,mark",
|
||
* description="В этом параметре по необходимости передаются поля, которые нужно добавить в ответ сервера, сейчас доступно только поля <b>column</b>, <b>timers</b> и <b>mark</b>",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает массив объектов Задач",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTaskExample"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionGetTaskList($project_id, $user_id = null): array
|
||
{
|
||
$tasks = $this->taskService->getTaskListByProject($project_id, $user_id);
|
||
|
||
if (empty($tasks)) {
|
||
throw new NotFoundHttpException('The project does not exist or there are no tasks for it');
|
||
}
|
||
return $tasks;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Get(path="/task/get-archive-task",
|
||
* summary="Получить список архивных задач по проекту",
|
||
* description="Метод для получения архивных задач по проекту",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
* @OA\Parameter(
|
||
* name="project_id",
|
||
* in="query",
|
||
* required=true,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="user_id",
|
||
* in="query",
|
||
* required=false,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="expand",
|
||
* in="query",
|
||
* example="column,timers,mark",
|
||
* description="В этом параметре по необходимости передаются поля, которые нужно добавить в ответ сервера, сейчас доступно только поля <b>column</b>, <b>timers</b> и <b>mark</b>",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает массив объектов Задач",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTaskExample"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @param $project_id
|
||
* @param null $user_id
|
||
* @return array
|
||
*/
|
||
public function actionGetArchiveTask($project_id, $user_id = null): array
|
||
{
|
||
return $this->taskService->getArchiveTask($project_id, $user_id);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Get(path="/task/get-user-tasks",
|
||
* summary="Получить список задач по пользователю",
|
||
* description="Метод для получения задач по пользователю",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
* @OA\Parameter(
|
||
* name="user_id",
|
||
* in="query",
|
||
* required=true,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="expand",
|
||
* in="query",
|
||
* example="column,timers,mark",
|
||
* description="В этом параметре по необходимости передаются поля, которые нужно добавить в ответ сервера, сейчас доступно только поля <b>column</b>, <b>timers</b> и <b>mark</b>",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает массив объектов Задач",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTaskExample"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @param $user_id
|
||
* @return array
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionGetUserTasks($user_id): array
|
||
{
|
||
$tasks = $this->taskService->getTaskListByUser($user_id);
|
||
|
||
if (empty($tasks)) {
|
||
throw new NotFoundHttpException('The project does not exist or there are no tasks for it');
|
||
}
|
||
return $tasks;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Get(path="/task/get-task",
|
||
* summary="Получить информацию по задаче",
|
||
* description="Метод для получения данных по задаче",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
* @OA\Parameter(
|
||
* name="task_id",
|
||
* in="query",
|
||
* required=true,
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="expand",
|
||
* in="query",
|
||
* example="column,timers,mark",
|
||
* description="В этом параметре по необходимости передаются поля, которые нужно добавить в ответ сервера, сейчас доступно только поля <b>column</b>, <b>timers</b> и <b>mark</b>",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект Задачи",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTask"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionGetTask($task_id): ProjectTask
|
||
{
|
||
if (empty($task_id) or !is_numeric($task_id)) {
|
||
throw new NotFoundHttpException('Incorrect task ID');
|
||
}
|
||
|
||
$task = $this->taskService->getTask($task_id);
|
||
if (empty($task)) {
|
||
throw new NotFoundHttpException('The task does not exist');
|
||
}
|
||
|
||
return $task;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Put(path="/task/update-task",
|
||
* summary="Редактировать задачу",
|
||
* description="Метод для редактирования задачи",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
*
|
||
* @OA\RequestBody(
|
||
* @OA\MediaType(
|
||
* mediaType="application/x-www-form-urlencoded",
|
||
* @OA\Schema(
|
||
* required={"task_id"},
|
||
* @OA\Property(
|
||
* property="user_id",
|
||
* type="integer",
|
||
* description="Идентификатор пользователя",
|
||
* nullable=false,
|
||
* ),
|
||
* @OA\Property(
|
||
* property="executor_id",
|
||
* type="integer",
|
||
* description="Идентификатор исполнителя задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="task_id",
|
||
* type="integer",
|
||
* description="Идентификатор задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="title",
|
||
* type="string",
|
||
* description="Заголовок задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="column_id",
|
||
* type="integer",
|
||
* description="Идентификатор колонки",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="priority",
|
||
* type="integer",
|
||
* description="Приоритет задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="status",
|
||
* type="integer",
|
||
* description="Статус задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="dead_line",
|
||
* type="string",
|
||
* description="Срок выполнения задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="description",
|
||
* type="string",
|
||
* description="Описание запроса",
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект Задачи",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTask"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @throws InvalidConfigException
|
||
* @throws ServerErrorHttpException
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionUpdateTask(): ?ProjectTask
|
||
{
|
||
$params = array_diff(\Yii::$app->request->getBodyParams(), [null, '']);
|
||
if (empty ($params['task_id']) or !$this->taskService->taskExists($params['task_id'])) {
|
||
throw new NotFoundHttpException('The task does not exist');
|
||
}
|
||
|
||
$modelTask = $this->taskService->updateTask($params);
|
||
if (!empty($modelTask->hasErrors())) {
|
||
throw new ServerErrorHttpException(json_encode($modelTask->errors));
|
||
}
|
||
|
||
return $modelTask;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Post(path="/task/add-user-to-task",
|
||
* summary="Добавить пользователя в задачу",
|
||
* description="Метод для добавления пользователя в задачу",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
*
|
||
* @OA\RequestBody(
|
||
* @OA\MediaType(
|
||
* mediaType="multipart/form-data",
|
||
* @OA\Schema(
|
||
* required={"user_id", "task_id"},
|
||
* @OA\Property(
|
||
* property="user_id",
|
||
* type="integer",
|
||
* description="Идентификатор пользователя",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="task_id",
|
||
* type="integer",
|
||
* description="Идентификатор задачи",
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект связи задачи и пользователя",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTaskUser"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @return ProjectTaskUser
|
||
* @throws NotFoundHttpException
|
||
* @throws ServerErrorHttpException
|
||
*/
|
||
public function actionAddUserToTask(): ProjectTaskUser
|
||
{
|
||
$request = \Yii::$app->request->post();
|
||
|
||
$user = User::findOne($request['user_id']);
|
||
if (!$user) {
|
||
throw new NotFoundHttpException('User not found');
|
||
}
|
||
|
||
if (empty ($request['task_id']) or !$this->taskService->taskExists($request['task_id'])) {
|
||
throw new NotFoundHttpException('The task does not exist');
|
||
}
|
||
|
||
if (ProjectTaskUser::find()->where(['user_id' => $request['user_id'], 'task_id' => $request['task_id']])->exists()) {
|
||
throw new ServerErrorHttpException('The user has already been added');
|
||
}
|
||
|
||
$model = new ProjectTaskUser();
|
||
$model->load($request, '');
|
||
|
||
if (!$model->validate()) {
|
||
throw new ServerErrorHttpException($model->errors);
|
||
}
|
||
|
||
$model->save();
|
||
|
||
return $model;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Delete(path="/task/del-user",
|
||
* summary="Удаление пользователя из задачи",
|
||
* description="Метод для Удаления пользователя из задачи",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
*
|
||
* @OA\RequestBody(
|
||
* @OA\MediaType(
|
||
* mediaType="application/x-www-form-urlencoded",
|
||
* @OA\Schema(
|
||
* required={"task_id", "user_id"},
|
||
* @OA\Property(
|
||
* property="task_id",
|
||
* type="integer",
|
||
* description="Идентификатор задачи",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="user_id",
|
||
* type="integer",
|
||
* description="Идентификатор пользователя",
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект задачи",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectTask"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @return ProjectTask|null
|
||
* @throws InvalidConfigException
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionDelUser(): ?ProjectTask
|
||
{
|
||
$request = Yii::$app->request->getBodyParams();
|
||
|
||
$user = User::findOne($request['user_id']);
|
||
if (!$user) {
|
||
throw new NotFoundHttpException('User not found');
|
||
}
|
||
|
||
if (empty ($request['task_id']) or !$this->taskService->taskExists($request['task_id'])) {
|
||
throw new NotFoundHttpException('The task does not exist');
|
||
}
|
||
|
||
ProjectTaskUser::deleteAll(['task_id' => $request['task_id'], 'user_id' => $request['user_id']]);
|
||
|
||
return $this->taskService->getTask($request['task_id']);
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Post(path="/task/set-priority",
|
||
* summary="Установить приоритет задач",
|
||
* description="Метод для установления приоритета задач в колонке",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
*
|
||
* @OA\RequestBody(
|
||
* @OA\MediaType(
|
||
* mediaType="multipart/form-data",
|
||
* @OA\Schema(
|
||
* required={"column_id", "data"},
|
||
* @OA\Property(
|
||
* property="column_id",
|
||
* type="integer",
|
||
* description="Идентификатор проекта",
|
||
* ),
|
||
* @OA\Property(
|
||
* property="data",
|
||
* type="string",
|
||
* description="Данные для обновления приоритета. Пример: [{"task_id":3,"priority":2},{"task_id":4,"priority":3}]",
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает объект колонки",
|
||
* @OA\MediaType(
|
||
* mediaType="application/json",
|
||
* @OA\Schema(ref="#/components/schemas/ProjectColumn"),
|
||
* ),
|
||
* ),
|
||
* )
|
||
*
|
||
* @return ProjectColumn
|
||
* @throws BadRequestHttpException
|
||
* @throws NotFoundHttpException
|
||
*/
|
||
public function actionSetPriority(): ProjectColumn
|
||
{
|
||
$request = \Yii::$app->request->post();
|
||
$data = $request['data'];
|
||
|
||
if (!$data = json_decode($data, true)) {
|
||
throw new BadRequestHttpException('No valid JSON');
|
||
}
|
||
|
||
$column = ProjectColumn::findOne($request['column_id']);
|
||
if (empty($column)) {
|
||
throw new NotFoundHttpException('The column not found');
|
||
}
|
||
|
||
foreach ($data as $datum) {
|
||
$model = ProjectTask::findOne($datum['task_id']);
|
||
$model->priority = $datum['priority'];
|
||
if (!$model->validate()){
|
||
throw new BadRequestHttpException($model->errors);
|
||
}
|
||
$model->save();
|
||
}
|
||
|
||
return $column;
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @OA\Get(path="/task/import",
|
||
* summary="Экспорт задач",
|
||
* description="Метод импорта задач в xlsx",
|
||
* security={
|
||
* {"bearerAuth": {}}
|
||
* },
|
||
* tags={"TaskManager"},
|
||
* @OA\Parameter(
|
||
* name="companyId",
|
||
* in="query",
|
||
* description="ID компании",
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="userId",
|
||
* in="query",
|
||
* description="ID исполнителя задачи",
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="projectId",
|
||
* in="query",
|
||
* description="ID проекта",
|
||
* @OA\Schema(
|
||
* type="integer",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="fromDate",
|
||
* in="query",
|
||
* example="2023-11-09",
|
||
* description="Поиск задач с указанной даты",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Parameter(
|
||
* name="toDate",
|
||
* in="query",
|
||
* example="2023-11-09",
|
||
* description="Поиск задач до указанной даты",
|
||
* @OA\Schema(
|
||
* type="string",
|
||
* )
|
||
* ),
|
||
* @OA\Response(
|
||
* response=200,
|
||
* description="Возвращает задачи в xlsx файле",
|
||
* ),
|
||
* )
|
||
*
|
||
* @return string|void
|
||
* @throws BadRequestHttpException
|
||
*/
|
||
public function actionImport()
|
||
{
|
||
return $this->taskService->importTasks(Yii::$app->request->get());
|
||
}
|
||
} |