|
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
|
|
|
* Email a task with no activity. |
|
18
|
|
|
*/ |
|
19
|
|
|
class TaskEmailNoActivity extends Base |
|
20
|
|
|
{ |
|
21
|
|
|
/** |
|
22
|
|
|
* Get automatic action description. |
|
23
|
|
|
* |
|
24
|
|
|
* @return string |
|
25
|
|
|
*/ |
|
26
|
|
|
public function getDescription() |
|
27
|
|
|
{ |
|
28
|
|
|
return t('Send email when there is no activity on a task'); |
|
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_DAILY_CRONJOB, |
|
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
|
|
|
'user_id' => t('User that will receive the email'), |
|
52
|
|
|
'subject' => t('Email subject'), |
|
53
|
|
|
'duration' => t('Duration in days'), |
|
54
|
|
|
]; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* Get the required parameter for the event. |
|
59
|
|
|
* |
|
60
|
|
|
* @return string[] |
|
61
|
|
|
*/ |
|
62
|
|
|
public function getEventRequiredParameters() |
|
63
|
|
|
{ |
|
64
|
|
|
return ['tasks']; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* Check if the event data meet the action condition. |
|
69
|
|
|
* |
|
70
|
|
|
* @param array $data Event data dictionary |
|
71
|
|
|
* |
|
72
|
|
|
* @return bool |
|
73
|
|
|
*/ |
|
74
|
|
|
public function hasRequiredCondition(array $data) |
|
75
|
|
|
{ |
|
76
|
|
|
return count($data['tasks']) > 0; |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* Execute the action (move the task to another column). |
|
81
|
|
|
* |
|
82
|
|
|
* @param array $data Event data dictionary |
|
83
|
|
|
* |
|
84
|
|
|
* @return bool True if the action was executed or false when not executed |
|
85
|
|
|
*/ |
|
86
|
|
|
public function doAction(array $data) |
|
87
|
|
|
{ |
|
88
|
|
|
$results = []; |
|
89
|
|
|
$max = $this->getParam('duration') * 86400; |
|
90
|
|
|
$user = $this->userModel->getById($this->getParam('user_id')); |
|
|
|
|
|
|
91
|
|
|
|
|
92
|
|
|
if (!empty($user['email'])) { |
|
93
|
|
View Code Duplication |
foreach ($data['tasks'] as $task) { |
|
|
|
|
|
|
94
|
|
|
$duration = time() - $task['date_modification']; |
|
95
|
|
|
|
|
96
|
|
|
if ($duration > $max) { |
|
97
|
|
|
$results[] = $this->sendEmail($task['id'], $user); |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
} |
|
101
|
|
|
|
|
102
|
|
|
return in_array(true, $results, true); |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* Send email. |
|
107
|
|
|
* |
|
108
|
|
|
* @param int $task_id |
|
109
|
|
|
* @param array $user |
|
110
|
|
|
* |
|
111
|
|
|
* @return bool |
|
112
|
|
|
*/ |
|
113
|
|
|
private function sendEmail($task_id, array $user) |
|
114
|
|
|
{ |
|
115
|
|
|
$task = $this->taskFinderModel->getDetails($task_id); |
|
|
|
|
|
|
116
|
|
|
|
|
117
|
|
|
$this->emailClient->send( |
|
|
|
|
|
|
118
|
|
|
$user['email'], |
|
119
|
|
|
$user['name'] ?: $user['username'], |
|
120
|
|
|
$this->getParam('subject'), |
|
121
|
|
|
$this->template->render('notification/task_create', ['task' => $task, 'application_url' => $this->settingModel->get('application_url')]) |
|
|
|
|
|
|
122
|
|
|
); |
|
123
|
|
|
|
|
124
|
|
|
return true; |
|
125
|
|
|
} |
|
126
|
|
|
} |
|
127
|
|
|
|
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@propertyannotation 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.