1
|
|
|
<?php declare(strict_types = 1); |
2
|
|
|
|
3
|
|
|
namespace ikoene\Marvel\Entity; |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Class SeriesFilter |
7
|
|
|
* @package ikoene\Marvel\Entity |
8
|
|
|
*/ |
9
|
|
|
class SeriesFilter |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* Return only series matching the specified title. |
13
|
|
|
* |
14
|
|
|
* @var string |
15
|
|
|
*/ |
16
|
|
|
public $name; |
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* Return series with titles that begin with the specified string (e.g. Sp). |
20
|
|
|
* |
21
|
|
|
* @var string |
22
|
|
|
*/ |
23
|
|
|
public $titleStartsWith; |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* Return only series matching the specified start year. |
27
|
|
|
* |
28
|
|
|
* @var int |
29
|
|
|
*/ |
30
|
|
|
public $startYear; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* Return only series which have been modified since the specified date. |
34
|
|
|
* |
35
|
|
|
* @var string |
36
|
|
|
*/ |
37
|
|
|
public $modifiedSince; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* Return only series which contain the specified comics |
41
|
|
|
* (accepts a comma-separated list of ids). |
42
|
|
|
* |
43
|
|
|
* @var string |
44
|
|
|
*/ |
45
|
|
|
public $comics; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Return only series which contain the specified stories |
49
|
|
|
* (accepts a comma-separated list of ids). |
50
|
|
|
* |
51
|
|
|
* @var string |
52
|
|
|
*/ |
53
|
|
|
public $stories; |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* Return only series which have comics that take place during the specified events |
57
|
|
|
* (accepts a comma-separated list of ids). |
58
|
|
|
* |
59
|
|
|
* @var string |
60
|
|
|
*/ |
61
|
|
|
public $events; |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* Return only series which feature work by the specified creators |
65
|
|
|
* (accepts a comma-separated list of ids). |
66
|
|
|
* |
67
|
|
|
* @var string |
68
|
|
|
*/ |
69
|
|
|
public $creators; |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* Return only series which feature the specified characters |
73
|
|
|
* (accepts a comma-separated list of ids). |
74
|
|
|
* |
75
|
|
|
* @var string |
76
|
|
|
*/ |
77
|
|
|
public $characters; |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Filter the series by publication frequency type. |
81
|
|
|
* |
82
|
|
|
* @var string |
83
|
|
|
*/ |
84
|
|
|
public $seriesType; |
85
|
|
|
|
86
|
|
|
/** |
87
|
|
|
* Return only series containing one or more comics with the specified format. |
88
|
|
|
* |
89
|
|
|
* @var string |
90
|
|
|
*/ |
91
|
|
|
public $contains; |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* Order the result set by a field or fields. |
95
|
|
|
* Add a "-" to the value sort in descending order. |
96
|
|
|
* Multiple values are given priority in the order in which they are passed. |
97
|
|
|
* |
98
|
|
|
* @var string |
99
|
|
|
*/ |
100
|
|
|
public $orderBy; |
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* Limit the result set to the specified number of resources. |
104
|
|
|
* |
105
|
|
|
* @var int |
106
|
|
|
*/ |
107
|
|
|
public $limit; |
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* Skip the specified number of resources in the result set. |
111
|
|
|
* |
112
|
|
|
* @var int |
113
|
|
|
*/ |
114
|
|
|
public $offset; |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* @return string |
118
|
|
|
*/ |
119
|
|
|
public function getName() |
120
|
|
|
{ |
121
|
|
|
return $this->name; |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* @param string $name |
126
|
|
|
*/ |
127
|
|
|
public function setName(string $name) |
128
|
|
|
{ |
129
|
|
|
$this->name = $name; |
130
|
|
|
} |
131
|
|
|
|
132
|
|
|
/** |
133
|
|
|
* @return string |
134
|
|
|
*/ |
135
|
|
|
public function getTitleStartsWith() |
136
|
|
|
{ |
137
|
|
|
return $this->titleStartsWith; |
138
|
|
|
} |
139
|
|
|
|
140
|
|
|
/** |
141
|
|
|
* @param string $titleStartsWith |
142
|
|
|
*/ |
143
|
|
|
public function setTitleStartsWith(string $titleStartsWith) |
144
|
|
|
{ |
145
|
|
|
$this->titleStartsWith = $titleStartsWith; |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
/** |
149
|
|
|
* @return int |
150
|
|
|
*/ |
151
|
|
|
public function getStartYear() |
152
|
|
|
{ |
153
|
|
|
return $this->startYear; |
154
|
|
|
} |
155
|
|
|
|
156
|
|
|
/** |
157
|
|
|
* @param int $startYear |
158
|
|
|
*/ |
159
|
|
|
public function setStartYear(int $startYear) |
160
|
|
|
{ |
161
|
|
|
$this->startYear = $startYear; |
162
|
|
|
} |
163
|
|
|
|
164
|
|
|
/** |
165
|
|
|
* @return string |
166
|
|
|
*/ |
167
|
|
|
public function getModifiedSince() |
168
|
|
|
{ |
169
|
|
|
return $this->modifiedSince; |
170
|
|
|
} |
171
|
|
|
|
172
|
|
|
/** |
173
|
|
|
* @param string $modifiedSince |
174
|
|
|
*/ |
175
|
|
|
public function setModifiedSince(string $modifiedSince) |
176
|
|
|
{ |
177
|
|
|
$this->modifiedSince = $modifiedSince; |
178
|
|
|
} |
179
|
|
|
|
180
|
|
|
/** |
181
|
|
|
* @return string |
182
|
|
|
*/ |
183
|
|
|
public function getComics() |
184
|
|
|
{ |
185
|
|
|
return $this->comics; |
186
|
|
|
} |
187
|
|
|
|
188
|
|
|
/** |
189
|
|
|
* @param string $comics |
190
|
|
|
*/ |
191
|
|
|
public function setComics(string $comics) |
192
|
|
|
{ |
193
|
|
|
$this->comics = $comics; |
194
|
|
|
} |
195
|
|
|
|
196
|
|
|
/** |
197
|
|
|
* @return string |
198
|
|
|
*/ |
199
|
|
|
public function getStories() |
200
|
|
|
{ |
201
|
|
|
return $this->stories; |
202
|
|
|
} |
203
|
|
|
|
204
|
|
|
/** |
205
|
|
|
* @param string $stories |
206
|
|
|
*/ |
207
|
|
|
public function setStories(string $stories) |
208
|
|
|
{ |
209
|
|
|
$this->stories = $stories; |
210
|
|
|
} |
211
|
|
|
|
212
|
|
|
/** |
213
|
|
|
* @return string |
214
|
|
|
*/ |
215
|
|
|
public function getEvents() |
216
|
|
|
{ |
217
|
|
|
return $this->events; |
218
|
|
|
} |
219
|
|
|
|
220
|
|
|
/** |
221
|
|
|
* @param string $events |
222
|
|
|
*/ |
223
|
|
|
public function setEvents(string $events) |
224
|
|
|
{ |
225
|
|
|
$this->events = $events; |
226
|
|
|
} |
227
|
|
|
|
228
|
|
|
/** |
229
|
|
|
* @return string |
230
|
|
|
*/ |
231
|
|
|
public function getCreators() |
232
|
|
|
{ |
233
|
|
|
return $this->creators; |
234
|
|
|
} |
235
|
|
|
|
236
|
|
|
/** |
237
|
|
|
* @param string $creators |
238
|
|
|
*/ |
239
|
|
|
public function setCreators(string $creators) |
240
|
|
|
{ |
241
|
|
|
$this->creators = $creators; |
242
|
|
|
} |
243
|
|
|
|
244
|
|
|
/** |
245
|
|
|
* @return string |
246
|
|
|
*/ |
247
|
|
|
public function getCharacters() |
248
|
|
|
{ |
249
|
|
|
return $this->characters; |
250
|
|
|
} |
251
|
|
|
|
252
|
|
|
/** |
253
|
|
|
* @param string $characters |
254
|
|
|
*/ |
255
|
|
|
public function setCharacters(string $characters) |
256
|
|
|
{ |
257
|
|
|
$this->characters = $characters; |
258
|
|
|
} |
259
|
|
|
|
260
|
|
|
/** |
261
|
|
|
* @return string |
262
|
|
|
*/ |
263
|
|
|
public function getSeriesType() |
264
|
|
|
{ |
265
|
|
|
return $this->seriesType; |
266
|
|
|
} |
267
|
|
|
|
268
|
|
|
/** |
269
|
|
|
* @param string $seriesType |
270
|
|
|
*/ |
271
|
|
|
public function setSeriesType(string $seriesType) |
272
|
|
|
{ |
273
|
|
|
$this->seriesType = $seriesType; |
274
|
|
|
} |
275
|
|
|
|
276
|
|
|
/** |
277
|
|
|
* @return string |
278
|
|
|
*/ |
279
|
|
|
public function getContains() |
280
|
|
|
{ |
281
|
|
|
return $this->contains; |
282
|
|
|
} |
283
|
|
|
|
284
|
|
|
/** |
285
|
|
|
* @param string $contains |
286
|
|
|
*/ |
287
|
|
|
public function setContains(string $contains) |
288
|
|
|
{ |
289
|
|
|
$this->contains = $contains; |
290
|
|
|
} |
291
|
|
|
|
292
|
|
|
/** |
293
|
|
|
* @return string |
294
|
|
|
*/ |
295
|
|
|
public function getOrderBy() |
296
|
|
|
{ |
297
|
|
|
return $this->orderBy; |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
/** |
301
|
|
|
* @param string $orderBy |
302
|
|
|
*/ |
303
|
|
|
public function setOrderBy(string $orderBy) |
304
|
|
|
{ |
305
|
|
|
$this->orderBy = $orderBy; |
306
|
|
|
} |
307
|
|
|
|
308
|
|
|
/** |
309
|
|
|
* @return int |
310
|
|
|
*/ |
311
|
|
|
public function getLimit() |
312
|
|
|
{ |
313
|
|
|
return $this->limit; |
314
|
|
|
} |
315
|
|
|
|
316
|
|
|
/** |
317
|
|
|
* @param int $limit |
318
|
|
|
*/ |
319
|
|
|
public function setLimit(int $limit) |
320
|
|
|
{ |
321
|
|
|
$this->limit = $limit; |
322
|
|
|
} |
323
|
|
|
|
324
|
|
|
/** |
325
|
|
|
* @return int |
326
|
|
|
*/ |
327
|
|
|
public function getOffset() |
328
|
|
|
{ |
329
|
|
|
return $this->offset; |
330
|
|
|
} |
331
|
|
|
|
332
|
|
|
/** |
333
|
|
|
* @param int $offset |
334
|
|
|
*/ |
335
|
|
|
public function setOffset(int $offset) |
336
|
|
|
{ |
337
|
|
|
$this->offset = $offset; |
338
|
|
|
} |
339
|
|
|
} |
340
|
|
|
|