1
|
|
|
<?php declare(strict_types = 1); |
2
|
|
|
|
3
|
|
|
namespace ikoene\Marvel\Entity; |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Class StoryFilter |
7
|
|
|
* @package ikoene\Marvel\Entity |
8
|
|
|
*/ |
9
|
|
|
class StoryFilter |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* Return only stories which have been modified since the specified date. |
13
|
|
|
* |
14
|
|
|
* @var string |
15
|
|
|
*/ |
16
|
|
|
public $modifiedSince; |
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* Return only stories contained in the specified |
20
|
|
|
* (accepts a comma-separated list of ids). |
21
|
|
|
* |
22
|
|
|
* @var string |
23
|
|
|
*/ |
24
|
|
|
public $comics; |
25
|
|
|
|
26
|
|
|
/** |
27
|
|
|
* Return only stories contained the specified series |
28
|
|
|
* (accepts a comma-separated list of ids). |
29
|
|
|
* |
30
|
|
|
* @var string |
31
|
|
|
*/ |
32
|
|
|
public $series; |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Return only stories which take place during the specified events |
36
|
|
|
* (accepts a comma-separated list of ids). |
37
|
|
|
* |
38
|
|
|
* @var string |
39
|
|
|
*/ |
40
|
|
|
public $events; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Return only stories which feature work by the specified creators |
44
|
|
|
* (accepts a comma-separated list of ids). |
45
|
|
|
* |
46
|
|
|
* @var string |
47
|
|
|
*/ |
48
|
|
|
public $creators; |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Return only stories which feature the specified characters |
52
|
|
|
* (accepts a comma-separated list of ids). |
53
|
|
|
* |
54
|
|
|
* @var string |
55
|
|
|
*/ |
56
|
|
|
public $characters; |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* Order the result set by a field or fields. |
60
|
|
|
* Add a "-" to the value sort in descending order. |
61
|
|
|
* Multiple values are given priority in the order in which they are passed. |
62
|
|
|
* |
63
|
|
|
* @var string |
64
|
|
|
*/ |
65
|
|
|
public $orderBy; |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* Limit the result set to the specified number of resources. |
69
|
|
|
* |
70
|
|
|
* @var int |
71
|
|
|
*/ |
72
|
|
|
public $limit; |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Skip the specified number of resources in the result set. |
76
|
|
|
* |
77
|
|
|
* @var int |
78
|
|
|
*/ |
79
|
|
|
public $offset; |
80
|
|
|
|
81
|
|
|
/** |
82
|
|
|
* @return string |
83
|
|
|
*/ |
84
|
|
|
public function getModifiedSince() |
85
|
|
|
{ |
86
|
|
|
return $this->modifiedSince; |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* @param string $modifiedSince |
91
|
|
|
*/ |
92
|
|
|
public function setModifiedSince(string $modifiedSince) |
93
|
|
|
{ |
94
|
|
|
$this->modifiedSince = $modifiedSince; |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
/** |
98
|
|
|
* @return string |
99
|
|
|
*/ |
100
|
|
|
public function getComics() |
101
|
|
|
{ |
102
|
|
|
return $this->comics; |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
/** |
106
|
|
|
* @param string $comics |
107
|
|
|
*/ |
108
|
|
|
public function setComics(string $comics) |
109
|
|
|
{ |
110
|
|
|
$this->comics = $comics; |
111
|
|
|
} |
112
|
|
|
|
113
|
|
|
/** |
114
|
|
|
* @return string |
115
|
|
|
*/ |
116
|
|
|
public function getSeries() |
117
|
|
|
{ |
118
|
|
|
return $this->series; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
/** |
122
|
|
|
* @param string $series |
123
|
|
|
*/ |
124
|
|
|
public function setSeries(string $series) |
125
|
|
|
{ |
126
|
|
|
$this->series = $series; |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
/** |
130
|
|
|
* @return string |
131
|
|
|
*/ |
132
|
|
|
public function getEvents() |
133
|
|
|
{ |
134
|
|
|
return $this->events; |
135
|
|
|
} |
136
|
|
|
|
137
|
|
|
/** |
138
|
|
|
* @param string $events |
139
|
|
|
*/ |
140
|
|
|
public function setEvents(string $events) |
141
|
|
|
{ |
142
|
|
|
$this->events = $events; |
143
|
|
|
} |
144
|
|
|
|
145
|
|
|
/** |
146
|
|
|
* @return string |
147
|
|
|
*/ |
148
|
|
|
public function getCreators() |
149
|
|
|
{ |
150
|
|
|
return $this->creators; |
151
|
|
|
} |
152
|
|
|
|
153
|
|
|
/** |
154
|
|
|
* @param string $creators |
155
|
|
|
*/ |
156
|
|
|
public function setCreators(string $creators) |
157
|
|
|
{ |
158
|
|
|
$this->creators = $creators; |
159
|
|
|
} |
160
|
|
|
|
161
|
|
|
/** |
162
|
|
|
* @return string |
163
|
|
|
*/ |
164
|
|
|
public function getCharacters() |
165
|
|
|
{ |
166
|
|
|
return $this->characters; |
167
|
|
|
} |
168
|
|
|
|
169
|
|
|
/** |
170
|
|
|
* @param string $characters |
171
|
|
|
*/ |
172
|
|
|
public function setCharacters(string $characters) |
173
|
|
|
{ |
174
|
|
|
$this->characters = $characters; |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
/** |
178
|
|
|
* @return string |
179
|
|
|
*/ |
180
|
|
|
public function getOrderBy() |
181
|
|
|
{ |
182
|
|
|
return $this->orderBy; |
183
|
|
|
} |
184
|
|
|
|
185
|
|
|
/** |
186
|
|
|
* @param string $orderBy |
187
|
|
|
*/ |
188
|
|
|
public function setOrderBy(string $orderBy) |
189
|
|
|
{ |
190
|
|
|
$this->orderBy = $orderBy; |
191
|
|
|
} |
192
|
|
|
|
193
|
|
|
/** |
194
|
|
|
* @return int |
195
|
|
|
*/ |
196
|
|
|
public function getLimit() |
197
|
|
|
{ |
198
|
|
|
return $this->limit; |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
/** |
202
|
|
|
* @param int $limit |
203
|
|
|
*/ |
204
|
|
|
public function setLimit(int $limit) |
205
|
|
|
{ |
206
|
|
|
$this->limit = $limit; |
207
|
|
|
} |
208
|
|
|
|
209
|
|
|
/** |
210
|
|
|
* @return int |
211
|
|
|
*/ |
212
|
|
|
public function getOffset() |
213
|
|
|
{ |
214
|
|
|
return $this->offset; |
215
|
|
|
} |
216
|
|
|
|
217
|
|
|
/** |
218
|
|
|
* @param int $offset |
219
|
|
|
*/ |
220
|
|
|
public function setOffset(int $offset) |
221
|
|
|
{ |
222
|
|
|
$this->offset = $offset; |
223
|
|
|
} |
224
|
|
|
} |
225
|
|
|
|