1 | <?php |
||
14 | class Field |
||
15 | { |
||
16 | /** |
||
17 | * @var string |
||
18 | */ |
||
19 | private $name; |
||
20 | /** |
||
21 | * @var array |
||
22 | */ |
||
23 | private $groups; |
||
24 | /** |
||
25 | * @var string |
||
26 | */ |
||
27 | private $type; |
||
28 | /** |
||
29 | * @var int |
||
30 | */ |
||
31 | private $length; |
||
32 | /** |
||
33 | * @var string |
||
34 | */ |
||
35 | private $title; |
||
36 | /** |
||
37 | * @var string |
||
38 | */ |
||
39 | private $description; |
||
40 | /** |
||
41 | * @var string |
||
42 | */ |
||
43 | private $exposeAs; |
||
44 | /** |
||
45 | * @var bool |
||
46 | */ |
||
47 | private $readOnly = false; |
||
48 | /** |
||
49 | * @var bool |
||
50 | */ |
||
51 | private $recordOriginException = false; |
||
52 | /** |
||
53 | * @var bool |
||
54 | */ |
||
55 | private $required = false; |
||
56 | /** |
||
57 | * @var integer |
||
58 | */ |
||
59 | private $searchable = 0; |
||
60 | /** |
||
61 | * @var bool |
||
62 | */ |
||
63 | private $translatable = false; |
||
64 | /** |
||
65 | * @var Constraint[] |
||
66 | */ |
||
67 | private $constraints = []; |
||
68 | |||
69 | /** |
||
70 | * @var array |
||
71 | */ |
||
72 | private $collection = []; |
||
73 | |||
74 | /** |
||
75 | * @var XDynamicKey |
||
76 | */ |
||
77 | private $xDynamicKey; |
||
78 | |||
79 | /** |
||
80 | * @return string |
||
81 | */ |
||
82 | 30 | public function getName() |
|
86 | |||
87 | /** |
||
88 | * @param string $name Field name |
||
89 | * @return $this |
||
90 | */ |
||
91 | 16 | public function setName($name) |
|
96 | |||
97 | /** |
||
98 | * get Groups |
||
99 | * |
||
100 | * @return array Groups |
||
101 | */ |
||
102 | 16 | public function getGroups() |
|
106 | |||
107 | /** |
||
108 | * set Groups |
||
109 | * |
||
110 | * @param array $groups groups |
||
111 | * |
||
112 | * @return void |
||
|
|||
113 | */ |
||
114 | 4 | public function setGroups($groups) |
|
119 | |||
120 | /** |
||
121 | * @return string |
||
122 | */ |
||
123 | 80 | public function getType() |
|
127 | |||
128 | /** |
||
129 | * @param string $type Field type |
||
130 | * @return $this |
||
131 | */ |
||
132 | 58 | public function setType($type) |
|
137 | |||
138 | /** |
||
139 | * @return int |
||
140 | */ |
||
141 | 16 | public function getLength() |
|
145 | |||
146 | /** |
||
147 | * @param int $length Field length |
||
148 | * @return $this |
||
149 | */ |
||
150 | 4 | public function setLength($length) |
|
155 | |||
156 | /** |
||
157 | * @return string |
||
158 | */ |
||
159 | 22 | public function getTitle() |
|
163 | |||
164 | /** |
||
165 | * @param string $title Field title |
||
166 | * @return $this |
||
167 | */ |
||
168 | 6 | public function setTitle($title) |
|
173 | |||
174 | /** |
||
175 | * @return string |
||
176 | */ |
||
177 | 22 | public function getDescription() |
|
181 | |||
182 | /** |
||
183 | * @param string $description Field description |
||
184 | * @return $this |
||
185 | */ |
||
186 | 12 | public function setDescription($description) |
|
191 | |||
192 | /** |
||
193 | * @return string |
||
194 | */ |
||
195 | 18 | public function getExposeAs() |
|
199 | |||
200 | /** |
||
201 | * @param string $exposeAs Expose field as ... |
||
202 | * @return $this |
||
203 | */ |
||
204 | 10 | public function setExposeAs($exposeAs) |
|
209 | |||
210 | /** |
||
211 | * @return bool |
||
212 | */ |
||
213 | 18 | public function getReadOnly() |
|
217 | |||
218 | /** |
||
219 | * @param bool $readOnly Is field readonly |
||
220 | * @return $this |
||
221 | */ |
||
222 | 6 | public function setReadOnly($readOnly) |
|
227 | |||
228 | /** |
||
229 | * get RecordOriginException |
||
230 | * |
||
231 | * @return boolean RecordOriginException |
||
232 | */ |
||
233 | 16 | public function isRecordOriginException() |
|
237 | |||
238 | /** |
||
239 | * set RecordOriginException |
||
240 | * |
||
241 | * @param boolean $recordOriginException recordOriginException |
||
242 | * |
||
243 | * @return void |
||
244 | */ |
||
245 | public function setRecordOriginException($recordOriginException) |
||
249 | |||
250 | /** |
||
251 | * @return bool |
||
252 | */ |
||
253 | 20 | public function getRequired() |
|
257 | |||
258 | /** |
||
259 | * @param bool $required Is field required |
||
260 | * @return $this |
||
261 | */ |
||
262 | 10 | public function setRequired($required) |
|
267 | |||
268 | /** |
||
269 | * @return bool |
||
270 | */ |
||
271 | 16 | public function getTranslatable() |
|
275 | |||
276 | /** |
||
277 | * @param bool $translatable Is field translatable |
||
278 | * @return $this |
||
279 | */ |
||
280 | 4 | public function setTranslatable($translatable) |
|
285 | |||
286 | /** |
||
287 | * @return Constraint[] |
||
288 | */ |
||
289 | 18 | public function getConstraints() |
|
293 | |||
294 | /** |
||
295 | * @param Constraint[] $constraints Field constraints |
||
296 | * @return $this |
||
297 | */ |
||
298 | 4 | public function setConstraints(array $constraints) |
|
303 | |||
304 | /** |
||
305 | * @return array |
||
306 | */ |
||
307 | 16 | public function getCollection() |
|
311 | |||
312 | /** |
||
313 | * @param array $collection Field |
||
314 | * @return $this |
||
315 | */ |
||
316 | 4 | public function setCollection(array $collection) |
|
321 | |||
322 | /** |
||
323 | * @return XDynamicKey |
||
324 | */ |
||
325 | 18 | public function getXDynamicKey() |
|
329 | |||
330 | /** |
||
331 | * @param XDynamicKey $xDynamicKey x-dynamic-key field value |
||
332 | * @return $this |
||
333 | */ |
||
334 | 2 | public function setXDynamicKey(XDynamicKey $xDynamicKey) |
|
339 | |||
340 | /** |
||
341 | * @return integer |
||
342 | */ |
||
343 | 18 | public function getSearchable() |
|
347 | |||
348 | /** |
||
349 | * @param integer $searchable searchable flag |
||
350 | * |
||
351 | * @return void |
||
352 | */ |
||
353 | public function setSearchable($searchable) |
||
357 | } |
||
358 |
This check compares the return type specified in the
@return
annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.