diff options
Diffstat (limited to 'app/Model/ProjectActivity.php')
| -rw-r--r-- | app/Model/ProjectActivity.php | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/app/Model/ProjectActivity.php b/app/Model/ProjectActivity.php new file mode 100644 index 00000000..d2457609 --- /dev/null +++ b/app/Model/ProjectActivity.php @@ -0,0 +1,189 @@ +<?php + +namespace Model; + +use Core\Template; +use Event\ProjectActivityListener; + +/** + * Project activity model + * + * @package model + * @author Frederic Guillot + */ +class ProjectActivity extends Base +{ + /** + * SQL table name + * + * @var string + */ + const TABLE = 'project_activities'; + + /** + * Maximum number of events + * + * @var integer + */ + const MAX_EVENTS = 5000; + + /** + * Add a new event for the project + * + * @access public + * @param integer $project_id Project id + * @param integer $task_id Task id + * @param integer $creator_id User id + * @param string $event_name Event name + * @param array $data Event data (will be serialized) + * @return boolean + */ + public function createEvent($project_id, $task_id, $creator_id, $event_name, array $data) + { + $values = array( + 'project_id' => $project_id, + 'task_id' => $task_id, + 'creator_id' => $creator_id, + 'event_name' => $event_name, + 'date_creation' => time(), + 'data' => serialize($data), + ); + + $this->cleanup(self::MAX_EVENTS - 1); + return $this->db->table(self::TABLE)->insert($values); + } + + /** + * Get all events for the given project + * + * @access public + * @param integer $project_id Project id + * @param integer $limit Maximum events number + * @return array + */ + public function getAll($project_id, $limit = 50) + { + $events = $this->db->table(self::TABLE) + ->columns( + self::TABLE.'.*', + User::TABLE.'.username AS author_username', + User::TABLE.'.name AS author_name' + ) + ->eq('project_id', $project_id) + ->join(User::TABLE, 'id', 'creator_id') + ->desc('id') + ->limit($limit) + ->findAll(); + + foreach ($events as &$event) { + + $event += unserialize($event['data']); + unset($event['data']); + + $event['author'] = $event['author_name'] ?: $event['author_username']; + $event['event_title'] = $this->getTitle($event); + $event['event_content'] = $this->getContent($event); + } + + return $events; + } + + /** + * Remove old event entries to avoid large table + * + * @access public + * @param integer $max Maximum number of items to keep in the table + */ + public function cleanup($max) + { + if ($this->db->table(self::TABLE)->count() > $max) { + + $this->db->execute(' + DELETE FROM '.self::TABLE.' + WHERE id <= ( + SELECT id FROM ( + SELECT id FROM '.self::TABLE.' ORDER BY id DESC LIMIT 1 OFFSET '.$max.' + ) foo + )' + ); + } + } + + /** + * Attach events to be able to record the history + * + * @access public + */ + public function attachEvents() + { + $events = array( + Task::EVENT_ASSIGNEE_CHANGE, + Task::EVENT_UPDATE, + Task::EVENT_CREATE, + Task::EVENT_CLOSE, + Task::EVENT_OPEN, + Task::EVENT_MOVE_COLUMN, + Task::EVENT_MOVE_POSITION, + Comment::EVENT_UPDATE, + Comment::EVENT_CREATE, + SubTask::EVENT_UPDATE, + SubTask::EVENT_CREATE, + ); + + $listener = new ProjectActivityListener($this->registry); + + foreach ($events as $event_name) { + $this->event->attach($event_name, $listener); + } + } + + /** + * Get the event html content + * + * @access public + * @param array $params Event properties + * @return string + */ + public function getContent(array $params) + { + $tpl = new Template; + return $tpl->load('event_'.str_replace('.', '_', $params['event_name']), $params); + } + + /** + * Get the event title (translated) + * + * @access public + * @param array $event Event properties + * @return string + */ + public function getTitle(array $event) + { + switch ($event['event_name']) { + case Task::EVENT_ASSIGNEE_CHANGE: + return t('%s change the assignee of the task #%d to %s', $event['author'], $event['task']['id'], $event['task']['assignee_name'] ?: $event['task']['assignee_username']); + case Task::EVENT_UPDATE: + return t('%s updated the task #%d', $event['author'], $event['task']['id']); + case Task::EVENT_CREATE: + return t('%s created the task #%d', $event['author'], $event['task']['id']); + case Task::EVENT_CLOSE: + return t('%s closed the task #%d', $event['author'], $event['task']['id']); + case Task::EVENT_OPEN: + return t('%s open the task #%d', $event['author'], $event['task']['id']); + case Task::EVENT_MOVE_COLUMN: + 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: + return t('%s updated a subtask for the task #%d', $event['author'], $event['task']['id']); + 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']); + case Comment::EVENT_CREATE: + return t('%s commented on the task #%d', $event['author'], $event['task']['id']); + default: + return ''; + } + } +} |