From fa6d19928abcfa03861e264222dbe46ad2fdc15a Mon Sep 17 00:00:00 2001 From: Frederic Guillot Date: Sat, 7 Feb 2015 18:36:16 -0500 Subject: Rename subtask model --- app/Model/Base.php | 2 +- app/Model/ProjectActivity.php | 4 +- app/Model/SubTask.php | 388 -------------------------------------- app/Model/Subtask.php | 388 ++++++++++++++++++++++++++++++++++++++ app/Model/SubtaskExport.php | 8 +- app/Model/SubtaskTimeTracking.php | 8 +- app/Model/TaskDuplication.php | 2 +- 7 files changed, 400 insertions(+), 400 deletions(-) delete mode 100644 app/Model/SubTask.php create mode 100644 app/Model/Subtask.php (limited to 'app/Model') diff --git a/app/Model/Base.php b/app/Model/Base.php index e29588a2..cf5f2e9f 100644 --- a/app/Model/Base.php +++ b/app/Model/Base.php @@ -29,7 +29,7 @@ use Pimple\Container; * @property \Model\Project $project * @property \Model\ProjectDuplication $projectDuplication * @property \Model\ProjectPermission $projectPermission - * @property \Model\SubTask $subTask + * @property \Model\Subtask $subtask * @property \Model\SubtaskHistory $subtaskHistory * @property \Model\Swimlane $swimlane * @property \Model\Task $task diff --git a/app/Model/ProjectActivity.php b/app/Model/ProjectActivity.php index a046dffb..8ef35a97 100644 --- a/app/Model/ProjectActivity.php +++ b/app/Model/ProjectActivity.php @@ -162,9 +162,9 @@ class ProjectActivity extends Base return t('%s moved the task #%d to the column "%s"', $event['author'], $event['task']['id'], $event['task']['column_title']); case Task::EVENT_MOVE_POSITION: return t('%s moved the task #%d to the position %d in the column "%s"', $event['author'], $event['task']['id'], $event['task']['position'], $event['task']['column_title']); - case SubTask::EVENT_UPDATE: + case Subtask::EVENT_UPDATE: return t('%s updated a subtask for the task #%d', $event['author'], $event['task']['id']); - case SubTask::EVENT_CREATE: + case Subtask::EVENT_CREATE: return t('%s created a subtask for the task #%d', $event['author'], $event['task']['id']); case Comment::EVENT_UPDATE: return t('%s updated a comment on the task #%d', $event['author'], $event['task']['id']); diff --git a/app/Model/SubTask.php b/app/Model/SubTask.php deleted file mode 100644 index dd243b1f..00000000 --- a/app/Model/SubTask.php +++ /dev/null @@ -1,388 +0,0 @@ - t('Todo'), - self::STATUS_INPROGRESS => t('In progress'), - self::STATUS_DONE => t('Done'), - ); - } - - /** - * Add subtask status status to the resultset - * - * @access public - * @param array $subtasks Subtasks - * @return array - */ - public function addStatusName(array $subtasks) - { - $status = $this->getStatusList(); - - foreach ($subtasks as &$subtask) { - $subtask['status_name'] = $status[$subtask['status']]; - } - - return $subtasks; - } - - /** - * Get the query to fetch subtasks assigned to a user - * - * @access public - * @param integer $user_id User id - * @param array $status List of status - * @return \PicoDb\Table - */ - public function getUserQuery($user_id, array $status) - { - return $this->db->table(SubTask::TABLE) - ->columns( - SubTask::TABLE.'.*', - Task::TABLE.'.project_id', - Task::TABLE.'.color_id', - Project::TABLE.'.name AS project_name' - ) - ->eq('user_id', $user_id) - ->eq(Project::TABLE.'.is_active', Project::ACTIVE) - ->in(SubTask::TABLE.'.status', $status) - ->join(Task::TABLE, 'id', 'task_id') - ->join(Project::TABLE, 'id', 'project_id', Task::TABLE) - ->filter(array($this, 'addStatusName')); - } - - /** - * Get all subtasks for a given task - * - * @access public - * @param integer $task_id Task id - * @return array - */ - public function getAll($task_id) - { - return $this->db - ->table(self::TABLE) - ->eq('task_id', $task_id) - ->columns(self::TABLE.'.*', User::TABLE.'.username', User::TABLE.'.name') - ->join(User::TABLE, 'id', 'user_id') - ->asc(self::TABLE.'.id') - ->filter(array($this, 'addStatusName')) - ->findAll(); - } - - /** - * Get a subtask by the id - * - * @access public - * @param integer $subtask_id Subtask id - * @param bool $more Fetch more data - * @return array - */ - public function getById($subtask_id, $more = false) - { - if ($more) { - - return $this->db - ->table(self::TABLE) - ->eq(self::TABLE.'.id', $subtask_id) - ->columns(self::TABLE.'.*', User::TABLE.'.username', User::TABLE.'.name') - ->join(User::TABLE, 'id', 'user_id') - ->filter(array($this, 'addStatusName')) - ->findOne(); - } - - return $this->db->table(self::TABLE)->eq('id', $subtask_id)->findOne(); - } - - /** - * Prepare data before insert/update - * - * @access public - * @param array $values Form values - */ - public function prepare(array &$values) - { - $this->removeFields($values, array('another_subtask')); - $this->resetFields($values, array('time_estimated', 'time_spent')); - } - - /** - * Create a new subtask - * - * @access public - * @param array $values Form values - * @return bool|integer - */ - public function create(array $values) - { - $this->prepare($values); - $subtask_id = $this->persist(self::TABLE, $values); - - if ($subtask_id) { - $this->container['dispatcher']->dispatch( - self::EVENT_CREATE, - new SubtaskEvent(array('id' => $subtask_id) + $values) - ); - } - - return $subtask_id; - } - - /** - * Update - * - * @access public - * @param array $values Form values - * @return bool - */ - public function update(array $values) - { - $this->prepare($values); - $result = $this->db->table(self::TABLE)->eq('id', $values['id'])->save($values); - - if ($result) { - $this->container['dispatcher']->dispatch( - self::EVENT_UPDATE, - new SubtaskEvent($values) - ); - } - - return $result; - } - - /** - * Change the status of subtask - * - * Todo -> In progress -> Done -> Todo -> etc... - * - * @access public - * @param integer $subtask_id - * @return bool - */ - public function toggleStatus($subtask_id) - { - $subtask = $this->getById($subtask_id); - - $values = array( - 'id' => $subtask['id'], - 'status' => ($subtask['status'] + 1) % 3, - ); - - return $this->update($values); - } - - /** - * Get the subtask in progress for this user - * - * @access public - * @param integer $user_id - * @return array - */ - public function getSubtaskInProgress($user_id) - { - return $this->db->table(self::TABLE) - ->eq('status', self::STATUS_INPROGRESS) - ->eq('user_id', $user_id) - ->findOne(); - } - - /** - * Return true if the user have a subtask in progress - * - * @access public - * @param integer $user_id - * @return boolean - */ - public function hasSubtaskInProgress($user_id) - { - return $this->config->get('subtask_restriction') == 1 && - $this->db->table(self::TABLE) - ->eq('status', self::STATUS_INPROGRESS) - ->eq('user_id', $user_id) - ->count() === 1; - } - - /** - * Remove - * - * @access public - * @param integer $subtask_id Subtask id - * @return bool - */ - public function remove($subtask_id) - { - return $this->db->table(self::TABLE)->eq('id', $subtask_id)->remove(); - } - - /** - * Duplicate all subtasks to another task - * - * @access public - * @param integer $src_task_id Source task id - * @param integer $dst_task_id Destination task id - * @return bool - */ - public function duplicate($src_task_id, $dst_task_id) - { - return $this->db->transaction(function ($db) use ($src_task_id, $dst_task_id) { - - $subtasks = $db->table(SubTask::TABLE) - ->columns('title', 'time_estimated') - ->eq('task_id', $src_task_id) - ->asc('id') // Explicit sorting for postgresql - ->findAll(); - - foreach ($subtasks as &$subtask) { - - $subtask['task_id'] = $dst_task_id; - - if (! $db->table(SubTask::TABLE)->save($subtask)) { - return false; - } - } - }); - } - - /** - * Validate creation - * - * @access public - * @param array $values Form values - * @return array $valid, $errors [0] = Success or not, [1] = List of errors - */ - public function validateCreation(array $values) - { - $rules = array( - new Validators\Required('task_id', t('The task id is required')), - new Validators\Required('title', t('The title is required')), - ); - - $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); - - return array( - $v->execute(), - $v->getErrors() - ); - } - - /** - * Validate modification - * - * @access public - * @param array $values Form values - * @return array $valid, $errors [0] = Success or not, [1] = List of errors - */ - public function validateModification(array $values) - { - $rules = array( - new Validators\Required('id', t('The subtask id is required')), - new Validators\Required('task_id', t('The task id is required')), - new Validators\Required('title', t('The title is required')), - ); - - $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); - - return array( - $v->execute(), - $v->getErrors() - ); - } - - /** - * Validate API modification - * - * @access public - * @param array $values Form values - * @return array $valid, $errors [0] = Success or not, [1] = List of errors - */ - public function validateApiModification(array $values) - { - $rules = array( - new Validators\Required('id', t('The subtask id is required')), - new Validators\Required('task_id', t('The task id is required')), - ); - - $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); - - return array( - $v->execute(), - $v->getErrors() - ); - } - - /** - * Common validation rules - * - * @access private - * @return array - */ - private function commonValidationRules() - { - return array( - new Validators\Integer('id', t('The subtask id must be an integer')), - new Validators\Integer('task_id', t('The task id must be an integer')), - new Validators\MaxLength('title', t('The maximum length is %d characters', 100), 100), - new Validators\Integer('user_id', t('The user id must be an integer')), - new Validators\Integer('status', t('The status must be an integer')), - new Validators\Numeric('time_estimated', t('The time must be a numeric value')), - new Validators\Numeric('time_spent', t('The time must be a numeric value')), - ); - } -} diff --git a/app/Model/Subtask.php b/app/Model/Subtask.php new file mode 100644 index 00000000..9ecd2c6a --- /dev/null +++ b/app/Model/Subtask.php @@ -0,0 +1,388 @@ + t('Todo'), + self::STATUS_INPROGRESS => t('In progress'), + self::STATUS_DONE => t('Done'), + ); + } + + /** + * Add subtask status status to the resultset + * + * @access public + * @param array $subtasks Subtasks + * @return array + */ + public function addStatusName(array $subtasks) + { + $status = $this->getStatusList(); + + foreach ($subtasks as &$subtask) { + $subtask['status_name'] = $status[$subtask['status']]; + } + + return $subtasks; + } + + /** + * Get the query to fetch subtasks assigned to a user + * + * @access public + * @param integer $user_id User id + * @param array $status List of status + * @return \PicoDb\Table + */ + public function getUserQuery($user_id, array $status) + { + return $this->db->table(Subtask::TABLE) + ->columns( + Subtask::TABLE.'.*', + Task::TABLE.'.project_id', + Task::TABLE.'.color_id', + Project::TABLE.'.name AS project_name' + ) + ->eq('user_id', $user_id) + ->eq(Project::TABLE.'.is_active', Project::ACTIVE) + ->in(Subtask::TABLE.'.status', $status) + ->join(Task::TABLE, 'id', 'task_id') + ->join(Project::TABLE, 'id', 'project_id', Task::TABLE) + ->filter(array($this, 'addStatusName')); + } + + /** + * Get all subtasks for a given task + * + * @access public + * @param integer $task_id Task id + * @return array + */ + public function getAll($task_id) + { + return $this->db + ->table(self::TABLE) + ->eq('task_id', $task_id) + ->columns(self::TABLE.'.*', User::TABLE.'.username', User::TABLE.'.name') + ->join(User::TABLE, 'id', 'user_id') + ->asc(self::TABLE.'.id') + ->filter(array($this, 'addStatusName')) + ->findAll(); + } + + /** + * Get a subtask by the id + * + * @access public + * @param integer $subtask_id Subtask id + * @param bool $more Fetch more data + * @return array + */ + public function getById($subtask_id, $more = false) + { + if ($more) { + + return $this->db + ->table(self::TABLE) + ->eq(self::TABLE.'.id', $subtask_id) + ->columns(self::TABLE.'.*', User::TABLE.'.username', User::TABLE.'.name') + ->join(User::TABLE, 'id', 'user_id') + ->filter(array($this, 'addStatusName')) + ->findOne(); + } + + return $this->db->table(self::TABLE)->eq('id', $subtask_id)->findOne(); + } + + /** + * Prepare data before insert/update + * + * @access public + * @param array $values Form values + */ + public function prepare(array &$values) + { + $this->removeFields($values, array('another_subtask')); + $this->resetFields($values, array('time_estimated', 'time_spent')); + } + + /** + * Create a new subtask + * + * @access public + * @param array $values Form values + * @return bool|integer + */ + public function create(array $values) + { + $this->prepare($values); + $subtask_id = $this->persist(self::TABLE, $values); + + if ($subtask_id) { + $this->container['dispatcher']->dispatch( + self::EVENT_CREATE, + new SubtaskEvent(array('id' => $subtask_id) + $values) + ); + } + + return $subtask_id; + } + + /** + * Update + * + * @access public + * @param array $values Form values + * @return bool + */ + public function update(array $values) + { + $this->prepare($values); + $result = $this->db->table(self::TABLE)->eq('id', $values['id'])->save($values); + + if ($result) { + $this->container['dispatcher']->dispatch( + self::EVENT_UPDATE, + new SubtaskEvent($values) + ); + } + + return $result; + } + + /** + * Change the status of subtask + * + * Todo -> In progress -> Done -> Todo -> etc... + * + * @access public + * @param integer $subtask_id + * @return bool + */ + public function toggleStatus($subtask_id) + { + $subtask = $this->getById($subtask_id); + + $values = array( + 'id' => $subtask['id'], + 'status' => ($subtask['status'] + 1) % 3, + ); + + return $this->update($values); + } + + /** + * Get the subtask in progress for this user + * + * @access public + * @param integer $user_id + * @return array + */ + public function getSubtaskInProgress($user_id) + { + return $this->db->table(self::TABLE) + ->eq('status', self::STATUS_INPROGRESS) + ->eq('user_id', $user_id) + ->findOne(); + } + + /** + * Return true if the user have a subtask in progress + * + * @access public + * @param integer $user_id + * @return boolean + */ + public function hasSubtaskInProgress($user_id) + { + return $this->config->get('subtask_restriction') == 1 && + $this->db->table(self::TABLE) + ->eq('status', self::STATUS_INPROGRESS) + ->eq('user_id', $user_id) + ->count() === 1; + } + + /** + * Remove + * + * @access public + * @param integer $subtask_id Subtask id + * @return bool + */ + public function remove($subtask_id) + { + return $this->db->table(self::TABLE)->eq('id', $subtask_id)->remove(); + } + + /** + * Duplicate all subtasks to another task + * + * @access public + * @param integer $src_task_id Source task id + * @param integer $dst_task_id Destination task id + * @return bool + */ + public function duplicate($src_task_id, $dst_task_id) + { + return $this->db->transaction(function ($db) use ($src_task_id, $dst_task_id) { + + $subtasks = $db->table(Subtask::TABLE) + ->columns('title', 'time_estimated') + ->eq('task_id', $src_task_id) + ->asc('id') // Explicit sorting for postgresql + ->findAll(); + + foreach ($subtasks as &$subtask) { + + $subtask['task_id'] = $dst_task_id; + + if (! $db->table(Subtask::TABLE)->save($subtask)) { + return false; + } + } + }); + } + + /** + * Validate creation + * + * @access public + * @param array $values Form values + * @return array $valid, $errors [0] = Success or not, [1] = List of errors + */ + public function validateCreation(array $values) + { + $rules = array( + new Validators\Required('task_id', t('The task id is required')), + new Validators\Required('title', t('The title is required')), + ); + + $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); + + return array( + $v->execute(), + $v->getErrors() + ); + } + + /** + * Validate modification + * + * @access public + * @param array $values Form values + * @return array $valid, $errors [0] = Success or not, [1] = List of errors + */ + public function validateModification(array $values) + { + $rules = array( + new Validators\Required('id', t('The subtask id is required')), + new Validators\Required('task_id', t('The task id is required')), + new Validators\Required('title', t('The title is required')), + ); + + $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); + + return array( + $v->execute(), + $v->getErrors() + ); + } + + /** + * Validate API modification + * + * @access public + * @param array $values Form values + * @return array $valid, $errors [0] = Success or not, [1] = List of errors + */ + public function validateApiModification(array $values) + { + $rules = array( + new Validators\Required('id', t('The subtask id is required')), + new Validators\Required('task_id', t('The task id is required')), + ); + + $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); + + return array( + $v->execute(), + $v->getErrors() + ); + } + + /** + * Common validation rules + * + * @access private + * @return array + */ + private function commonValidationRules() + { + return array( + new Validators\Integer('id', t('The subtask id must be an integer')), + new Validators\Integer('task_id', t('The task id must be an integer')), + new Validators\MaxLength('title', t('The maximum length is %d characters', 100), 100), + new Validators\Integer('user_id', t('The user id must be an integer')), + new Validators\Integer('status', t('The status must be an integer')), + new Validators\Numeric('time_estimated', t('The time must be a numeric value')), + new Validators\Numeric('time_spent', t('The time must be a numeric value')), + ); + } +} diff --git a/app/Model/SubtaskExport.php b/app/Model/SubtaskExport.php index 1e728c05..23dcc019 100644 --- a/app/Model/SubtaskExport.php +++ b/app/Model/SubtaskExport.php @@ -29,7 +29,7 @@ class SubtaskExport extends Base */ public function export($project_id, $from, $to) { - $this->subtask_status = $this->subTask->getStatusList(); + $this->subtask_status = $this->subtask->getStatusList(); $subtasks = $this->getSubtasks($project_id, $from, $to); $results = array($this->getColumns()); @@ -101,10 +101,10 @@ class SubtaskExport extends Base $to = $this->dateParser->removeTimeFromTimestamp(strtotime('+1 day', $this->dateParser->getTimestamp($to))); } - return $this->db->table(SubTask::TABLE) + return $this->db->table(Subtask::TABLE) ->eq('project_id', $project_id) ->columns( - SubTask::TABLE.'.*', + Subtask::TABLE.'.*', User::TABLE.'.username AS assignee_username', User::TABLE.'.name AS assignee_name', Task::TABLE.'.title AS task_title' @@ -113,7 +113,7 @@ class SubtaskExport extends Base ->lte('date_creation', $to) ->join(Task::TABLE, 'id', 'task_id') ->join(User::TABLE, 'id', 'user_id') - ->asc(SubTask::TABLE.'.id') + ->asc(Subtask::TABLE.'.id') ->findAll(); } } diff --git a/app/Model/SubtaskTimeTracking.php b/app/Model/SubtaskTimeTracking.php index 5c8a7c81..cc839ddb 100644 --- a/app/Model/SubtaskTimeTracking.php +++ b/app/Model/SubtaskTimeTracking.php @@ -33,13 +33,13 @@ class SubtaskTimeTracking extends Base self::TABLE.'.subtask_id', self::TABLE.'.end', self::TABLE.'.start', - SubTask::TABLE.'.task_id', - SubTask::TABLE.'.title AS subtask_title', + Subtask::TABLE.'.task_id', + Subtask::TABLE.'.title AS subtask_title', Task::TABLE.'.title AS task_title', Task::TABLE.'.project_id' ) - ->join(SubTask::TABLE, 'id', 'subtask_id') - ->join(Task::TABLE, 'id', 'task_id', SubTask::TABLE) + ->join(Subtask::TABLE, 'id', 'subtask_id') + ->join(Task::TABLE, 'id', 'task_id', Subtask::TABLE) ->eq(self::TABLE.'.user_id', $user_id); } diff --git a/app/Model/TaskDuplication.php b/app/Model/TaskDuplication.php index 172edb9f..bd593dc1 100644 --- a/app/Model/TaskDuplication.php +++ b/app/Model/TaskDuplication.php @@ -158,7 +158,7 @@ class TaskDuplication extends Base $new_task_id = $this->taskCreation->create($values); if ($new_task_id) { - $this->subTask->duplicate($task_id, $new_task_id); + $this->subtask->duplicate($task_id, $new_task_id); } return $new_task_id; -- cgit v1.2.3