From 546e0ec8098293758d7764509b4fe1cf2bab2d70 Mon Sep 17 00:00:00 2001
From: Francois Ferrand <thetypz@gmail.com>
Date: Tue, 24 Feb 2015 18:41:38 +0100
Subject: Add new actions to move issue when the assignee is changed.

This will *not* fire the task_moved events, to avoid triggering other auto-assign actions.
This does not seem ideal, but I see no easy way to implement this properly (e.g. checking the event
stack).
---
 app/Action/TaskMoveColumnAssigned.php   | 91 +++++++++++++++++++++++++++++++++
 app/Action/TaskMoveColumnUnAssigned.php | 91 +++++++++++++++++++++++++++++++++
 app/Model/Action.php                    |  2 +
 app/Model/TaskPosition.php              |  5 +-
 4 files changed, 187 insertions(+), 2 deletions(-)
 create mode 100644 app/Action/TaskMoveColumnAssigned.php
 create mode 100644 app/Action/TaskMoveColumnUnAssigned.php

(limited to 'app')

diff --git a/app/Action/TaskMoveColumnAssigned.php b/app/Action/TaskMoveColumnAssigned.php
new file mode 100644
index 00000000..0f47ee19
--- /dev/null
+++ b/app/Action/TaskMoveColumnAssigned.php
@@ -0,0 +1,91 @@
+<?php
+
+namespace Action;
+
+use Model\Task;
+
+/**
+ * Move a task to another column when an assignee is set
+ *
+ * @package action
+ * @author  Francois Ferrand
+ */
+class TaskMoveColumnAssigned extends Base
+{
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            Task::EVENT_ASSIGNEE_CHANGE,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'src_column_id' => t('From column'),
+            'dest_column_id' => t('To column')
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'column_id',
+            'project_id',
+            'owner_id'
+        );
+    }
+
+    /**
+     * Execute the action (move the task to another column)
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool            True if the action was executed or false when not executed
+     */
+    public function doAction(array $data)
+    {
+        $original_task = $this->taskFinder->getById($data['task_id']);
+
+        return $this->taskPosition->movePosition(
+            $data['project_id'],
+            $data['task_id'],
+            $this->getParam('dest_column_id'),
+            $original_task['position'],
+            $original_task['swimlane_id'],
+            false
+        );
+    }
+
+    /**
+     * Check if the event data meet the action condition
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool
+     */
+    public function hasRequiredCondition(array $data)
+    {
+        return $data['column_id'] == $this->getParam('src_column_id') &&
+               $data['owner_id'];
+    }
+}
diff --git a/app/Action/TaskMoveColumnUnAssigned.php b/app/Action/TaskMoveColumnUnAssigned.php
new file mode 100644
index 00000000..66159b0c
--- /dev/null
+++ b/app/Action/TaskMoveColumnUnAssigned.php
@@ -0,0 +1,91 @@
+<?php
+
+namespace Action;
+
+use Model\Task;
+
+/**
+ * Move a task to another column when an assignee is cleared
+ *
+ * @package action
+ * @author  Francois Ferrand
+ */
+class TaskMoveColumnUnAssigned extends Base
+{
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            Task::EVENT_ASSIGNEE_CHANGE
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'src_column_id' => t('From column'),
+            'dest_column_id' => t('To column')
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'column_id',
+            'project_id',
+            'owner_id'
+        );
+    }
+
+    /**
+     * Execute the action (move the task to another column)
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool            True if the action was executed or false when not executed
+     */
+    public function doAction(array $data)
+    {
+        $original_task = $this->taskFinder->getById($data['task_id']);
+
+        return $this->taskPosition->movePosition(
+            $data['project_id'],
+            $data['task_id'],
+            $this->getParam('dest_column_id'),
+            $original_task['position'],
+            $original_task['swimlane_id'],
+            false
+        );
+    }
+
+    /**
+     * Check if the event data meet the action condition
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool
+     */
+    public function hasRequiredCondition(array $data)
+    {
+        return $data['column_id'] == $this->getParam('src_column_id') &&
+               !$data['owner_id'];
+    }
+}
diff --git a/app/Model/Action.php b/app/Model/Action.php
index 6fb2a2f1..c1662fad 100644
--- a/app/Model/Action.php
+++ b/app/Model/Action.php
@@ -45,6 +45,8 @@ class Action extends Base
             'TaskAssignCurrentUser' => t('Assign the task to the person who does the action'),
             'TaskDuplicateAnotherProject' => t('Duplicate the task to another project'),
             'TaskMoveAnotherProject' => t('Move the task to another project'),
+            'TaskMoveColumnAssigned' => t('Move the task to another column when assigned to a user'),
+            'TaskMoveColumnUnAssigned' => t('Move the task to another column when assignee is cleared'),
             'TaskAssignColorUser' => t('Assign a color to a specific user'),
             'TaskAssignColorCategory' => t('Assign automatically a color based on a category'),
             'TaskAssignCategoryColor' => t('Assign automatically a category based on a color'),
diff --git a/app/Model/TaskPosition.php b/app/Model/TaskPosition.php
index 1e49543a..c2b5cb86 100644
--- a/app/Model/TaskPosition.php
+++ b/app/Model/TaskPosition.php
@@ -23,7 +23,7 @@ class TaskPosition extends Base
      * @param  integer    $swimlane_id       Swimlane id
      * @return boolean
      */
-    public function movePosition($project_id, $task_id, $column_id, $position, $swimlane_id = 0)
+    public function movePosition($project_id, $task_id, $column_id, $position, $swimlane_id = 0, $fire_events = true)
     {
         $original_task = $this->taskFinder->getById($task_id);
 
@@ -35,7 +35,8 @@ class TaskPosition extends Base
                 $this->calculateAndSave($project_id, 0, $column_id, 1, $original_task['swimlane_id']);
             }
 
-            $this->fireEvents($original_task, $column_id, $position, $swimlane_id);
+            if ($fire_events)
+                $this->fireEvents($original_task, $column_id, $position, $swimlane_id);
         }
 
         return $result;
-- 
cgit v1.2.3