From a296ba5b18487d312acca2513d461a210a460fae Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sun, 3 Jan 2016 16:43:13 -0500
Subject: Improve Automatic Actions plugin api

---
 app/Action/CommentCreationMoveTaskColumn.php | 94 ++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 app/Action/CommentCreationMoveTaskColumn.php

(limited to 'app/Action/CommentCreationMoveTaskColumn.php')

diff --git a/app/Action/CommentCreationMoveTaskColumn.php b/app/Action/CommentCreationMoveTaskColumn.php
new file mode 100644
index 00000000..4473cf91
--- /dev/null
+++ b/app/Action/CommentCreationMoveTaskColumn.php
@@ -0,0 +1,94 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\Task;
+
+/**
+ * Add a comment of the triggering event to the task description.
+ *
+ * @package action
+ * @author  Oren Ben-Kiki
+ */
+class CommentCreationMoveTaskColumn extends Base
+{
+    /**
+     * Get automatic action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Add a comment log when moving the task between columns');
+    }
+
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            Task::EVENT_MOVE_COLUMN,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array('column_id' => t('Column'));
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array('task_id', 'column_id');
+    }
+
+    /**
+     * Execute the action (append to the task description).
+     *
+     * @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)
+    {
+        if (! $this->userSession->isLogged()) {
+            return false;
+        }
+
+        $column = $this->board->getColumn($data['column_id']);
+
+        return (bool) $this->comment->create(array(
+            'comment' => t('Moved to column %s', $column['title']),
+            'task_id' => $data['task_id'],
+            'user_id' => $this->userSession->getId(),
+        ));
+    }
+
+    /**
+     * 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('column_id');
+    }
+}
-- 
cgit v1.2.3