summaryrefslogtreecommitdiff
path: root/app/Action/TaskEmail.php
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-06-20 10:48:47 -0400
committerFrederic Guillot <fred@kanboard.net>2015-06-20 10:48:47 -0400
commitcb0916d10e4a42a62f0ac8c69ecb4b7a15f398b4 (patch)
treed5344b06ee0b87224ec157f44bf513ca7e353b5b /app/Action/TaskEmail.php
parent7056d14c95888eebe90d023524d4a63e562a9f64 (diff)
Add automatic action to send a task by email
Diffstat (limited to 'app/Action/TaskEmail.php')
-rw-r--r--app/Action/TaskEmail.php97
1 files changed, 97 insertions, 0 deletions
diff --git a/app/Action/TaskEmail.php b/app/Action/TaskEmail.php
new file mode 100644
index 00000000..363a01c6
--- /dev/null
+++ b/app/Action/TaskEmail.php
@@ -0,0 +1,97 @@
+<?php
+
+namespace Action;
+
+use Model\Task;
+
+/**
+ * Email a task to someone
+ *
+ * @package action
+ * @author Frederic Guillot
+ */
+class TaskEmail extends Base
+{
+ /**
+ * Get the list of compatible events
+ *
+ * @access public
+ * @return array
+ */
+ public function getCompatibleEvents()
+ {
+ return array(
+ Task::EVENT_MOVE_COLUMN,
+ Task::EVENT_CLOSE,
+ );
+ }
+
+ /**
+ * Get the required parameter for the action (defined by the user)
+ *
+ * @access public
+ * @return array
+ */
+ public function getActionRequiredParameters()
+ {
+ return array(
+ 'column_id' => t('Column'),
+ 'user_id' => t('User that will receive the email'),
+ 'subject' => t('Email subject'),
+ );
+ }
+
+ /**
+ * Get the required parameter for the event
+ *
+ * @access public
+ * @return string[]
+ */
+ public function getEventRequiredParameters()
+ {
+ return array(
+ 'task_id',
+ 'column_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)
+ {
+ $user = $this->user->getById($this->getParam('user_id'));
+
+ if (! empty($user['email'])) {
+
+ $task = $this->taskFinder->getDetails($data['task_id']);
+
+ $this->emailClient->send(
+ $user['email'],
+ $user['name'] ?: $user['username'],
+ $this->getParam('subject'),
+ $this->template->render('notification/task_create', array('task' => $task, 'application_url' => $this->config->get('application_url')))
+ );
+
+ return true;
+ }
+
+ return 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('column_id');
+ }
+}