summaryrefslogtreecommitdiff
path: root/app/Action/StopSubtaskTimerMoveTaskColumn.php
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2017-12-06 18:31:43 -0800
committerFrédéric Guillot <fred@kanboard.net>2017-12-06 18:31:43 -0800
commit230eddcc69f7f31cdc489ad3de21a46de958f605 (patch)
tree5cb6de16f60646b3b8210214687975a645d5352e /app/Action/StopSubtaskTimerMoveTaskColumn.php
parent0060fb9d5c2d75203aa7662e646d1f6db2c977a8 (diff)
Add two automatic actions for subtasks
- Action to create a subtask assigned to the creator and start the timer - Action to stop the timer of subtasks
Diffstat (limited to 'app/Action/StopSubtaskTimerMoveTaskColumn.php')
-rw-r--r--app/Action/StopSubtaskTimerMoveTaskColumn.php102
1 files changed, 102 insertions, 0 deletions
diff --git a/app/Action/StopSubtaskTimerMoveTaskColumn.php b/app/Action/StopSubtaskTimerMoveTaskColumn.php
new file mode 100644
index 00000000..e6f9e436
--- /dev/null
+++ b/app/Action/StopSubtaskTimerMoveTaskColumn.php
@@ -0,0 +1,102 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+use Kanboard\Model\SubtaskModel;
+
+/**
+ * Stop the timer of all subtasks when moving a task to another column.
+ *
+ * @package Kanboard\Action
+ * @author Frederic Guillot
+ */
+class StopSubtaskTimerMoveTaskColumn extends Base
+{
+ /**
+ * Get automatic action description
+ *
+ * @access public
+ * @return string
+ */
+ public function getDescription()
+ {
+ return t('Stop the timer of all subtasks when moving a task to another column');
+ }
+
+ /**
+ * Get the list of compatible events
+ *
+ * @access public
+ * @return array
+ */
+ public function getCompatibleEvents()
+ {
+ return array(
+ TaskModel::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',
+ 'task' => array(
+ 'id',
+ 'column_id',
+ 'project_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)
+ {
+ $subtasks = $this->subtaskModel->getAll($data['task']['id']);
+ $results = array();
+
+ foreach ($subtasks as $subtask) {
+ $results[] = $this->subtaskModel->update(array('id' => $subtask['id'], 'status' => SubtaskModel::STATUS_DONE));
+ $results[] = $this->subtaskTimeTrackingModel->logEndTime($subtask['id'], $subtask['user_id']);
+ }
+
+ return !in_array(false, $results, true);
+ }
+
+ /**
+ * 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('column_id');
+ }
+}