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