-
Notifications
You must be signed in to change notification settings - Fork 183
/
TimeEntry.php
201 lines (177 loc) · 5.79 KB
/
TimeEntry.php
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?php
namespace Redmine\Api;
use Redmine\Exception;
use Redmine\Exception\MissingParameterException;
use Redmine\Exception\SerializerException;
use Redmine\Exception\UnexpectedResponseException;
use Redmine\Http\HttpFactory;
use Redmine\Serializer\JsonSerializer;
use Redmine\Serializer\XmlSerializer;
use SimpleXMLElement;
/**
* Listing time entries, creating, editing.
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @author Kevin Saliou <kevin at saliou dot name>
*/
class TimeEntry extends AbstractApi
{
private $timeEntries = [];
/**
* List time entries.
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
*
* @throws UnexpectedResponseException if response body could not be converted into array
*
* @return array list of time entries found
*/
final public function list(array $params = []): array
{
try {
return $this->retrieveData('/time_entries.json', $params);
} catch (SerializerException $th) {
throw UnexpectedResponseException::create($this->getLastResponse(), $th);
}
}
/**
* List time entries.
*
* @deprecated v2.4.0 Use list() instead.
* @see TimeEntry::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
*
* @return array|string|false list of time entries found or error message or false
*/
public function all(array $params = [])
{
@trigger_error('`' . __METHOD__ . '()` is deprecated since v2.4.0, use `' . __CLASS__ . '::list()` instead.', E_USER_DEPRECATED);
try {
$this->timeEntries = $this->list($params);
} catch (Exception $e) {
if ($this->getLastResponse()->getContent() === '') {
return false;
}
if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
$e = $e->getPrevious();
}
return $e->getMessage();
}
return $this->timeEntries;
}
/**
* Get extended information about a time entry (including memberships + groups).
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param int $id the time entry id
*
* @return array|false|string information about the time entry as array or false|string on error
*/
public function show($id)
{
$this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeJsonRequest(
'GET',
'/time_entries/' . urlencode(strval($id)) . '.json'
));
$body = $this->lastResponse->getContent();
if ('' === $body) {
return false;
}
try {
return JsonSerializer::createFromString($body)->getNormalized();
} catch (SerializerException $e) {
return 'Error decoding body as JSON: ' . $e->getPrevious()->getMessage();
}
}
/**
* Create a new time entry given an array of $params.
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param array $params the new time entry data
*
* @throws MissingParameterException Missing mandatory parameters
*
* @return SimpleXMLElement|string
*/
public function create(array $params = [])
{
$defaults = [
'issue_id' => null,
'project_id' => null,
'spent_on' => null,
'hours' => null,
'activity_id' => null,
'comments' => null,
];
$params = $this->sanitizeParams($defaults, $params);
if (
(!isset($params['issue_id']) && !isset($params['project_id']))
|| !isset($params['hours'])
) {
throw new MissingParameterException('Theses parameters are mandatory: `issue_id` or `project_id`, `hours`');
}
$this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeXmlRequest(
'POST',
'/time_entries.xml',
XmlSerializer::createFromArray(['time_entry' => $params])->getEncoded()
));
$body = $this->lastResponse->getContent();
if ('' !== $body) {
return new SimpleXMLElement($body);
}
return $body;
}
/**
* Update time entry's information.
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param int $id
*
* @return string|false
*/
public function update($id, array $params)
{
$defaults = [
'id' => $id,
'issue_id' => null,
'project_id' => null,
'spent_on' => null,
'hours' => null,
'activity_id' => null,
'comments' => null,
];
$params = $this->sanitizeParams($defaults, $params);
$this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeXmlRequest(
'PUT',
'/time_entries/' . $id . '.xml',
XmlSerializer::createFromArray(['time_entry' => $params])->getEncoded()
));
return $this->lastResponse->getContent();
}
/**
* Delete a time entry.
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
* @param int $id id of the time entry
*
* @return string empty string on success
*/
public function remove($id)
{
$this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeXmlRequest(
'DELETE',
'/time_entries/' . $id . '.xml'
));
return $this->lastResponse->getContent();
}
}