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
|
|
|
* Assign a task to a specific user. |
18
|
|
|
*/ |
19
|
|
|
class TaskAssignSpecificUser extends Base |
20
|
|
|
{ |
21
|
|
|
/** |
22
|
|
|
* Get automatic action description. |
23
|
|
|
* |
24
|
|
|
* @return string |
25
|
|
|
*/ |
26
|
|
|
public function getDescription() |
27
|
|
|
{ |
28
|
|
|
return t('Assign the task to a specific user'); |
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_CREATE_UPDATE, |
40
|
|
|
TaskModel::EVENT_MOVE_COLUMN, |
41
|
|
|
]; |
42
|
|
|
} |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* Get the required parameter for the action (defined by the user). |
46
|
|
|
* |
47
|
|
|
* @return array |
48
|
|
|
*/ |
49
|
|
|
public function getActionRequiredParameters() |
50
|
|
|
{ |
51
|
|
|
return [ |
52
|
|
|
'column_id' => t('Column'), |
53
|
|
|
'user_id' => t('Assignee'), |
54
|
|
|
]; |
55
|
|
|
} |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* Get the required parameter for the event. |
59
|
|
|
* |
60
|
|
|
* @return string[] |
61
|
|
|
*/ |
62
|
|
|
public function getEventRequiredParameters() |
63
|
|
|
{ |
64
|
|
|
return [ |
65
|
|
|
'task_id', |
66
|
|
|
'task' => [ |
67
|
|
|
'project_id', |
68
|
|
|
'column_id', |
69
|
|
|
], |
70
|
|
|
]; |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* Execute the action (assign the given user). |
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
|
|
|
$values = [ |
83
|
|
|
'id' => $data['task_id'], |
84
|
|
|
'owner_id' => $this->getParam('user_id'), |
85
|
|
|
]; |
86
|
|
|
|
87
|
|
|
return $this->taskModel->update($values); |
|
|
|
|
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* Check if the event data meet the action condition. |
92
|
|
|
* |
93
|
|
|
* @param array $data Event data dictionary |
94
|
|
|
* |
95
|
|
|
* @return bool |
96
|
|
|
*/ |
97
|
|
|
public function hasRequiredCondition(array $data) |
98
|
|
|
{ |
99
|
|
|
return $data['task']['column_id'] == $this->getParam('column_id'); |
100
|
|
|
} |
101
|
|
|
} |
102
|
|
|
|
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.