summaryrefslogtreecommitdiff
path: root/app/Action/TaskClose.php
blob: d80bd02339334687db9c8670b8d1dca7e806b726 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?php

namespace Kanboard\Action;

use Kanboard\Integration\GitlabWebhook;
use Kanboard\Integration\GithubWebhook;
use Kanboard\Integration\BitbucketWebhook;
use Kanboard\Model\Task;

/**
 * Close automatically a task
 *
 * @package action
 * @author  Frederic Guillot
 */
class TaskClose extends Base
{
    /**
     * Get the list of compatible events
     *
     * @access public
     * @return array
     */
    public function getCompatibleEvents()
    {
        return array(
            Task::EVENT_MOVE_COLUMN,
            GithubWebhook::EVENT_COMMIT,
            GithubWebhook::EVENT_ISSUE_CLOSED,
            GitlabWebhook::EVENT_COMMIT,
            GitlabWebhook::EVENT_ISSUE_CLOSED,
            BitbucketWebhook::EVENT_COMMIT,
            BitbucketWebhook::EVENT_ISSUE_CLOSED,
        );
    }

    /**
     * Get the required parameter for the action (defined by the user)
     *
     * @access public
     * @return array
     */
    public function getActionRequiredParameters()
    {
        switch ($this->event_name) {
            case GithubWebhook::EVENT_COMMIT:
            case GithubWebhook::EVENT_ISSUE_CLOSED:
            case GitlabWebhook::EVENT_COMMIT:
            case GitlabWebhook::EVENT_ISSUE_CLOSED:
            case BitbucketWebhook::EVENT_COMMIT:
            case BitbucketWebhook::EVENT_ISSUE_CLOSED:
                return array();
            default:
                return array('column_id' => t('Column'));
        }
    }

    /**
     * Get the required parameter for the event
     *
     * @access public
     * @return string[]
     */
    public function getEventRequiredParameters()
    {
        switch ($this->event_name) {
            case GithubWebhook::EVENT_COMMIT:
            case GithubWebhook::EVENT_ISSUE_CLOSED:
            case GitlabWebhook::EVENT_COMMIT:
            case GitlabWebhook::EVENT_ISSUE_CLOSED:
            case BitbucketWebhook::EVENT_COMMIT:
            case BitbucketWebhook::EVENT_ISSUE_CLOSED:
                return array('task_id');
            default:
                return array('task_id', 'column_id');
        }
    }

    /**
     * Execute the action (close the task)
     *
     * @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->taskStatus->close($data['task_id']);
    }

    /**
     * Check if the event data meet the action condition
     *
     * @access public
     * @param  array   $data   Event data dictionary
     * @return bool
     */
    public function hasRequiredCondition(array $data)
    {
        switch ($this->event_name) {
            case GithubWebhook::EVENT_COMMIT:
            case GithubWebhook::EVENT_ISSUE_CLOSED:
            case GitlabWebhook::EVENT_COMMIT:
            case GitlabWebhook::EVENT_ISSUE_CLOSED:
            case BitbucketWebhook::EVENT_COMMIT:
            case BitbucketWebhook::EVENT_ISSUE_CLOSED:
                return true;
            default:
                return $data['column_id'] == $this->getParam('column_id');
        }
    }
}