summaryrefslogtreecommitdiff
path: root/actions/task_close.php
blob: 4d129d73953f456366d8a6f778a40143aa24d0da (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
<?php

namespace Action;

require_once __DIR__.'/base.php';

/**
 * Close automatically a task
 *
 * @package action
 * @author  Frederic Guillot
 */
class TaskClose extends Base
{
    /**
     * Constructor
     *
     * @access public
     * @param  integer  $project_id  Project id
     * @param  Task     $task        Task model instance
     */
    public function __construct($project_id, \Model\Task $task)
    {
        parent::__construct($project_id);
        $this->task = $task;
    }

    /**
     * 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 (check if for the event data)
     *
     * @abstract
     * @access public
     * @return array
     */
    public function getEventRequiredParameters()
    {
        return array(
            'task_id',
            'column_id',
        );
    }

    /**
     * Execute the action
     *
     * @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 ($data['column_id'] == $this->getParam('column_id')) {
            $this->task->close($data['task_id']);
            return true;
        }

        return false;
    }
}