Refactoring of internal task events

This commit is contained in:
Frederic Guillot
2016-07-19 22:38:30 -04:00
parent d9d3788222
commit 390082aa41
58 changed files with 1210 additions and 468 deletions

View File

@@ -4,7 +4,6 @@ namespace Kanboard\Model;
use PicoDb\Database;
use Kanboard\Core\Base;
use Kanboard\Event\SubtaskEvent;
/**
* Subtask Model

View File

@@ -3,7 +3,6 @@
namespace Kanboard\Model;
use Kanboard\Core\Base;
use Kanboard\Event\TaskEvent;
/**
* Task Creation
@@ -42,7 +41,10 @@ class TaskCreationModel extends Base
$this->taskTagModel->save($values['project_id'], $task_id, $tags);
}
$this->fireEvents($task_id, $values);
$this->queueManager->push($this->taskEventJob->withParams(
$task_id,
array(TaskModel::EVENT_CREATE_UPDATE, TaskModel::EVENT_CREATE)
));
}
return (int) $task_id;
@@ -51,10 +53,10 @@ class TaskCreationModel extends Base
/**
* Prepare data
*
* @access public
* @access protected
* @param array $values Form values
*/
public function prepare(array &$values)
protected function prepare(array &$values)
{
$values = $this->dateParser->convert($values, array('date_due'));
$values = $this->dateParser->convert($values, array('date_started'), true);
@@ -84,26 +86,4 @@ class TaskCreationModel extends Base
$values['date_moved'] = $values['date_creation'];
$values['position'] = $this->taskFinderModel->countByColumnAndSwimlaneId($values['project_id'], $values['column_id'], $values['swimlane_id']) + 1;
}
/**
* Fire events
*
* @access private
* @param integer $task_id Task id
* @param array $values Form values
*/
private function fireEvents($task_id, array $values)
{
$event = new TaskEvent(array('task_id' => $task_id) + $values);
$this->logger->debug('Event fired: '.TaskModel::EVENT_CREATE_UPDATE);
$this->logger->debug('Event fired: '.TaskModel::EVENT_CREATE);
$this->dispatcher->dispatch(TaskModel::EVENT_CREATE_UPDATE, $event);
$this->dispatcher->dispatch(TaskModel::EVENT_CREATE, $event);
if (! empty($values['description'])) {
$this->userMentionModel->fireEvents($values['description'], TaskModel::EVENT_USER_MENTION, $event);
}
}
}

View File

@@ -3,7 +3,6 @@
namespace Kanboard\Model;
use Kanboard\Core\Base;
use Kanboard\Event\TaskEvent;
/**
* Task Modification
@@ -23,14 +22,14 @@ class TaskModificationModel extends Base
*/
public function update(array $values, $fire_events = true)
{
$original_task = $this->taskFinderModel->getById($values['id']);
$task = $this->taskFinderModel->getById($values['id']);
$this->updateTags($values, $original_task);
$this->updateTags($values, $task);
$this->prepare($values);
$result = $this->db->table(TaskModel::TABLE)->eq('id', $original_task['id'])->update($values);
$result = $this->db->table(TaskModel::TABLE)->eq('id', $task['id'])->update($values);
if ($fire_events && $result) {
$this->fireEvents($original_task, $values);
$this->fireEvents($task, $values);
}
return $result;
@@ -39,43 +38,56 @@ class TaskModificationModel extends Base
/**
* Fire events
*
* @access public
* @param array $task
* @param array $new_values
* @access protected
* @param array $task
* @param array $changes
*/
public function fireEvents(array $task, array $new_values)
protected function fireEvents(array $task, array $changes)
{
$events = array();
$event_data = array_merge($task, $new_values, array('task_id' => $task['id']));
// Values changed
$event_data['changes'] = array_diff_assoc($new_values, $task);
unset($event_data['changes']['date_modification']);
if ($this->isFieldModified('owner_id', $event_data['changes'])) {
if ($this->isAssigneeChanged($task, $changes)) {
$events[] = TaskModel::EVENT_ASSIGNEE_CHANGE;
} elseif (! empty($event_data['changes'])) {
} elseif ($this->isModified($task, $changes)) {
$events[] = TaskModel::EVENT_CREATE_UPDATE;
$events[] = TaskModel::EVENT_UPDATE;
}
foreach ($events as $event) {
$this->logger->debug('Event fired: '.$event);
$this->dispatcher->dispatch($event, new TaskEvent($event_data));
if (! empty($events)) {
$this->queueManager->push($this->taskEventJob
->withParams($task['id'], $events, $changes, array(), $task)
);
}
}
/**
* Return true if the task have been modified
*
* @access protected
* @param array $task
* @param array $changes
* @return bool
*/
protected function isModified(array $task, array $changes)
{
$diff = array_diff_assoc($changes, $task);
unset($diff['date_modification']);
return count($diff) > 0;
}
/**
* Return true if the field is the only modified value
*
* @access public
* @param string $field
* @param array $changes
* @return boolean
* @access protected
* @param array $task
* @param array $changes
* @return bool
*/
public function isFieldModified($field, array $changes)
protected function isAssigneeChanged(array $task, array $changes)
{
return isset($changes[$field]) && count($changes) === 1;
$diff = array_diff_assoc($changes, $task);
unset($diff['date_modification']);
return isset($changes['owner_id']) && $task['owner_id'] != $changes['owner_id'] && count($diff) === 1;
}
/**

View File

@@ -3,7 +3,6 @@
namespace Kanboard\Model;
use Kanboard\Core\Base;
use Kanboard\Event\TaskEvent;
/**
* Task Position
@@ -212,8 +211,7 @@ class TaskPositionModel extends Base
*/
private function fireEvents(array $task, $new_column_id, $new_position, $new_swimlane_id)
{
$event_data = array(
'task_id' => $task['id'],
$changes = array(
'project_id' => $task['project_id'],
'position' => $new_position,
'column_id' => $new_column_id,
@@ -226,14 +224,26 @@ class TaskPositionModel extends Base
);
if ($task['swimlane_id'] != $new_swimlane_id) {
$this->logger->debug('Event fired: '.TaskModel::EVENT_MOVE_SWIMLANE);
$this->dispatcher->dispatch(TaskModel::EVENT_MOVE_SWIMLANE, new TaskEvent($event_data));
$this->queueManager->push($this->taskEventJob->withParams(
$task['id'],
array(TaskModel::EVENT_MOVE_SWIMLANE),
$changes,
$changes
));
} elseif ($task['column_id'] != $new_column_id) {
$this->logger->debug('Event fired: '.TaskModel::EVENT_MOVE_COLUMN);
$this->dispatcher->dispatch(TaskModel::EVENT_MOVE_COLUMN, new TaskEvent($event_data));
$this->queueManager->push($this->taskEventJob->withParams(
$task['id'],
array(TaskModel::EVENT_MOVE_COLUMN),
$changes,
$changes
));
} elseif ($task['position'] != $new_position) {
$this->logger->debug('Event fired: '.TaskModel::EVENT_MOVE_POSITION);
$this->dispatcher->dispatch(TaskModel::EVENT_MOVE_POSITION, new TaskEvent($event_data));
$this->queueManager->push($this->taskEventJob->withParams(
$task['id'],
array(TaskModel::EVENT_MOVE_POSITION),
$changes,
$changes
));
}
}
}

View File

@@ -2,8 +2,6 @@
namespace Kanboard\Model;
use Kanboard\Event\TaskEvent;
/**
* Task Project Move
*
@@ -32,9 +30,8 @@ class TaskProjectMoveModel extends TaskDuplicationModel
$this->checkDestinationProjectValues($values);
$this->tagDuplicationModel->syncTaskTagsToAnotherProject($task_id, $project_id);
if ($this->db->table(TaskModel::TABLE)->eq('id', $task['id'])->update($values)) {
$event = new TaskEvent(array_merge($task, $values, array('task_id' => $task['id'])));
$this->dispatcher->dispatch(TaskModel::EVENT_MOVE_PROJECT, $event);
if ($this->db->table(TaskModel::TABLE)->eq('id', $task_id)->update($values)) {
$this->queueManager->push($this->taskEventJob->withParams($task_id, array(TaskModel::EVENT_MOVE_PROJECT), $values));
}
return true;

View File

@@ -3,7 +3,6 @@
namespace Kanboard\Model;
use Kanboard\Core\Base;
use Kanboard\Event\TaskEvent;
/**
* Task Status
@@ -101,10 +100,10 @@ class TaskStatusModel extends Base
* @param integer $task_id Task id
* @param integer $status Task status
* @param integer $date_completed Timestamp
* @param string $event Event name
* @param string $event_name Event name
* @return boolean
*/
private function changeStatus($task_id, $status, $date_completed, $event)
private function changeStatus($task_id, $status, $date_completed, $event_name)
{
if (! $this->taskFinderModel->exists($task_id)) {
return false;
@@ -120,8 +119,7 @@ class TaskStatusModel extends Base
));
if ($result) {
$this->logger->debug('Event fired: '.$event);
$this->dispatcher->dispatch($event, new TaskEvent(array('task_id' => $task_id) + $this->taskFinderModel->getById($task_id)));
$this->queueManager->push($this->taskEventJob->withParams($task_id, array($event_name)));
}
return $result;