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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<?php
declare(strict_types=1);
/**
* Nextcloud - Social Support
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Social\Model\Client\Options;
use JsonSerializable;
use OCA\Social\Exceptions\UnknownTimelineException;
use OCA\Social\Tools\Traits\TArrayTools;
use OCP\IRequest;
/**
* Class TimelineOptions
*
* @package OCA\Social\Model\Client\Options
*/
class TimelineOptions extends CoreOptions implements JsonSerializable {
use TArrayTools;
private string $timeline = '';
private bool $local = false;
private bool $remote = false;
private bool $onlyMedia = false;
private int $minId = 0;
private int $maxId = 0;
private int $sinceId = 0;
private int $limit = 20;
private bool $inverted = false;
public static array $availableTimelines = [
'home',
'public'
];
/**
* TimelineOptions constructor.
*
* @param IRequest|null $request
*/
public function __construct(IRequest $request = null) {
if ($request !== null) {
$this->fromArray($request->getParams());
}
}
/**
* @return string
*/
public function getTimeline(): string {
return $this->timeline;
}
/**
* @param string $timeline
*
* @return TimelineOptions
* @throws UnknownTimelineException
*/
public function setTimeline(string $timeline): self {
$timeline = strtolower($timeline);
if (!in_array($timeline, self::$availableTimelines)) {
throw new UnknownTimelineException(
'unknown timeline: ' . implode(', ', self::$availableTimelines)
);
}
$this->timeline = $timeline;
return $this;
}
/**
* @return bool
*/
public function isLocal(): bool {
return $this->local;
}
/**
* @param bool $local
*
* @return TimelineOptions
*/
public function setLocal(bool $local): self {
$this->local = $local;
return $this;
}
/**
* @return bool
*/
public function isRemote(): bool {
return $this->remote;
}
/**
* @param bool $remote
*
* @return TimelineOptions
*/
public function setRemote(bool $remote): self {
$this->remote = $remote;
return $this;
}
/**
* @return bool
*/
public function isOnlyMedia(): bool {
return $this->onlyMedia;
}
/**
* @param bool $onlyMedia
*
* @return TimelineOptions
*/
public function setOnlyMedia(bool $onlyMedia): self {
$this->onlyMedia = $onlyMedia;
return $this;
}
/**
* @return int
*/
public function getMinId(): int {
return $this->minId;
}
/**
* @param int $minId
*
* @return TimelineOptions
*/
public function setMinId(int $minId): self {
$this->minId = $minId;
return $this;
}
/**
* @return int
*/
public function getMaxId(): int {
return $this->maxId;
}
/**
* @param int $maxId
*
* @return TimelineOptions
*/
public function setMaxId(int $maxId): self {
$this->maxId = $maxId;
return $this;
}
/**
* @return int
*/
public function getSinceId(): int {
return $this->sinceId;
}
/**
* @param int $sinceId
*
* @return TimelineOptions
*/
public function setSinceId(int $sinceId): self {
$this->sinceId = $sinceId;
return $this;
}
/**
* @return int
*/
public function getLimit(): int {
return $this->limit;
}
/**
* @param int $limit
*
* @return TimelineOptions
*/
public function setLimit(int $limit): self {
$this->limit = $limit;
return $this;
}
/**
* @return bool
*/
public function isInverted(): bool {
return $this->inverted;
}
/**
* @param bool $inverted
*
* @return TimelineOptions
*/
public function setInverted(bool $inverted): self {
$this->inverted = $inverted;
return $this;
}
/**
* @param array $arr
*
* @return TimelineOptions
*/
public function fromArray(array $arr): self {
$this->setLocal($this->getBool('local', $arr, $this->isLocal()));
$this->setRemote($this->getBool('remote', $arr, $this->isRemote()));
$this->setRemote($this->getBool('only_media', $arr, $this->isOnlyMedia()));
$this->setMinId($this->getInt('min_id', $arr, $this->getMinId()));
$this->setMaxId($this->getInt('max_id', $arr, $this->getMaxId()));
$this->setSinceId($this->getInt('since_id', $arr, $this->getSinceId()));
$this->setLimit($this->getInt('limit', $arr, $this->getLimit()));
return $this;
}
/**
* @return array
*/
public function jsonSerialize(): array {
return
[
'timeline' => $this->getTimeline(),
'local' => $this->isLocal(),
'remote' => $this->isRemote(),
'only_media' => $this->isOnlyMedia(),
'min_id' => $this->getMinId(),
'max_id' => $this->getMaxId(),
'since_id' => $this->getSinceId(),
'limit' => $this->getLimit()
];
}
}
|