Add new automatic action to move a task to another column when closed

2016-07-23 18:33:31 -04:00
parent 2a42e0e1aa
commit 9b2a32af78
35 changed files with 236 additions and 39 deletions
--- a/app/Action/TaskMoveColumnClosed.php
+++ b/app/Action/TaskMoveColumnClosed.php
@@ -0,0 +1,102 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+
+/**
+ * Move a task to another column when the task is closed
+ *
+ * @package Kanboard\Action
+ * @author  Frederic Guillot
+ */
+class TaskMoveColumnClosed extends Base
+{
+    /**
+     * Get automatic action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Move the task to another column when closed');
+    }
+
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            TaskModel::EVENT_CLOSE,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'dest_column_id' => t('Destination column'),
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'task' => array(
+                'project_id',
+                'column_id',
+                'swimlane_id',
+                'is_active',
+            )
+        );
+    }
+
+    /**
+     * 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)
+    {
+        return $this->taskPositionModel->movePosition(
+            $data['task']['project_id'],
+            $data['task']['id'],
+            $this->getParam('dest_column_id'),
+            1,
+            $data['task']['swimlane_id'],
+            false,
+            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['task']['column_id'] != $this->getParam('dest_column_id') && $data['task']['is_active'] == 0;
+    }
+}