1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file is part of Jitamin. |
5
|
|
|
* |
6
|
|
|
* Copyright (C) Jitamin Team |
7
|
|
|
* |
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
9
|
|
|
* file that was distributed with this source code. |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace Jitamin\Action; |
13
|
|
|
|
14
|
|
|
use Jitamin\Model\TaskModel; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* Move a task to another column when the task is closed. |
18
|
|
|
*/ |
19
|
|
|
class TaskMoveColumnClosed extends Base |
20
|
|
|
{ |
21
|
|
|
/** |
22
|
|
|
* Get automatic action description. |
23
|
|
|
* |
24
|
|
|
* @return string |
25
|
|
|
*/ |
26
|
|
|
public function getDescription() |
27
|
|
|
{ |
28
|
|
|
return t('Move the task to another column when closed'); |
29
|
|
|
} |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* Get the list of compatible events. |
33
|
|
|
* |
34
|
|
|
* @return array |
35
|
|
|
*/ |
36
|
|
|
public function getCompatibleEvents() |
37
|
|
|
{ |
38
|
|
|
return [ |
39
|
|
|
TaskModel::EVENT_CLOSE, |
40
|
|
|
]; |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* Get the required parameter for the action (defined by the user). |
45
|
|
|
* |
46
|
|
|
* @return array |
47
|
|
|
*/ |
48
|
|
|
public function getActionRequiredParameters() |
49
|
|
|
{ |
50
|
|
|
return [ |
51
|
|
|
'dest_column_id' => t('Destination column'), |
52
|
|
|
]; |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* Get the required parameter for the event. |
57
|
|
|
* |
58
|
|
|
* @return string[] |
59
|
|
|
*/ |
60
|
|
|
public function getEventRequiredParameters() |
61
|
|
|
{ |
62
|
|
|
return [ |
63
|
|
|
'task_id', |
64
|
|
|
'task' => [ |
65
|
|
|
'project_id', |
66
|
|
|
'column_id', |
67
|
|
|
'swimlane_id', |
68
|
|
|
'is_active', |
69
|
|
|
], |
70
|
|
|
]; |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* Execute the action (move the task to another column). |
75
|
|
|
* |
76
|
|
|
* @param array $data Event data dictionary |
77
|
|
|
* |
78
|
|
|
* @return bool True if the action was executed or false when not executed |
79
|
|
|
*/ |
80
|
|
|
public function doAction(array $data) |
81
|
|
|
{ |
82
|
|
|
return $this->taskPositionModel->movePosition( |
|
|
|
|
83
|
|
|
$data['task']['project_id'], |
84
|
|
|
$data['task']['id'], |
85
|
|
|
$this->getParam('dest_column_id'), |
86
|
|
|
1, |
87
|
|
|
$data['task']['swimlane_id'], |
88
|
|
|
false, |
89
|
|
|
false |
90
|
|
|
); |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* Check if the event data meet the action condition. |
95
|
|
|
* |
96
|
|
|
* @param array $data Event data dictionary |
97
|
|
|
* |
98
|
|
|
* @return bool |
99
|
|
|
*/ |
100
|
|
|
public function hasRequiredCondition(array $data) |
101
|
|
|
{ |
102
|
|
|
return $data['task']['column_id'] != $this->getParam('dest_column_id') && $data['task']['is_active'] == 0; |
103
|
|
|
} |
104
|
|
|
} |
105
|
|
|
|
Since your code implements the magic getter
_get
, this function will be called for any read access on an undefined variable. You can add the@property
annotation to your class or interface to document the existence of this variable.If the property has read access only, you can use the @property-read annotation instead.
Of course, you may also just have mistyped another name, in which case you should fix the error.
See also the PhpDoc documentation for @property.