1 | <?php |
||
28 | class ReferenceList implements Comparable, Countable, IteratorAggregate, Serializable { |
||
29 | |||
30 | /** |
||
31 | * @var Reference[] Ordered list or references, indexed by SPL object hash. |
||
32 | */ |
||
33 | private $references = []; |
||
34 | 29 | ||
35 | 29 | /** |
|
36 | 8 | * @param Reference[]|Traversable $references |
|
37 | * |
||
38 | * @throws InvalidArgumentException |
||
39 | 21 | */ |
|
40 | 12 | public function __construct( $references = [] ) { |
|
53 | |||
54 | /** |
||
55 | * Adds the provided reference to the list. |
||
56 | * Empty references are ignored. |
||
57 | * |
||
58 | 14 | * @since 0.1 |
|
59 | 14 | * |
|
60 | * @param Reference $reference |
||
61 | * @param int|null $index New position of the added reference, or null to append. |
||
62 | * |
||
63 | 14 | * @throws InvalidArgumentException |
|
64 | */ |
||
65 | 14 | public function addReference( Reference $reference, $index = null ) { |
|
87 | |||
88 | /** |
||
89 | * @since 1.1 |
||
90 | * |
||
91 | 6 | * @param Snak[]|Snak $snaks |
|
92 | 6 | * @param Snak [$snak2,...] |
|
93 | 5 | * |
|
94 | 5 | * @throws InvalidArgumentException |
|
95 | */ |
||
96 | 6 | public function addNewReference( $snaks = [] /*...*/ ) { |
|
103 | 2 | ||
104 | 2 | /** |
|
105 | 2 | * @param Reference $reference |
|
106 | * @param int $index |
||
107 | */ |
||
108 | 2 | private function insertReferenceAtIndex( Reference $reference, $index ) { |
|
121 | 2 | ||
122 | 2 | /** |
|
123 | 2 | * Returns if the list contains a reference with the same hash as the provided reference. |
|
124 | 2 | * |
|
125 | * @since 0.1 |
||
126 | * |
||
127 | * @param Reference $reference |
||
128 | * |
||
129 | * @return bool |
||
130 | */ |
||
131 | public function hasReference( Reference $reference ) { |
||
134 | |||
135 | 6 | /** |
|
136 | 6 | * Returns the index of the Reference object or false if the Reference could not be found. |
|
137 | 6 | * |
|
138 | * @since 0.5 |
||
139 | * |
||
140 | * @param Reference $reference |
||
141 | * |
||
142 | * @return int|bool |
||
143 | */ |
||
144 | public function indexOf( Reference $reference ) { |
||
157 | 2 | ||
158 | /** |
||
159 | 2 | * Removes the reference with the same hash as the provided reference if such a reference exists in the list. |
|
160 | * |
||
161 | * @since 0.1 |
||
162 | * |
||
163 | * @param Reference $reference |
||
164 | */ |
||
165 | public function removeReference( Reference $reference ) { |
||
168 | |||
169 | 3 | /** |
|
170 | 3 | * Returns if the list contains a reference with the provided hash. |
|
171 | 3 | * |
|
172 | * @since 0.3 |
||
173 | * |
||
174 | * @param string $referenceHash |
||
175 | * |
||
176 | * @return bool |
||
177 | */ |
||
178 | public function hasReferenceHash( $referenceHash ) { |
||
181 | |||
182 | 8 | /** |
|
183 | 8 | * Looks for the first Reference object in this list with the provided hash. |
|
184 | * Removes all occurences of that object. |
||
185 | * |
||
186 | * @since 0.3 |
||
187 | * |
||
188 | * @param string $referenceHash ` |
||
189 | */ |
||
190 | public function removeReferenceHash( $referenceHash ) { |
||
203 | |||
204 | /** |
||
205 | * Returns the first Reference object with the provided hash, or |
||
206 | * null if there is no such reference in the list. |
||
207 | * |
||
208 | * @since 0.3 |
||
209 | * |
||
210 | 14 | * @param string $referenceHash |
|
211 | * |
||
212 | * @return Reference|null |
||
213 | */ |
||
214 | 14 | public function getReference( $referenceHash ) { |
|
223 | |||
224 | /** |
||
225 | * @see Serializable::serialize |
||
226 | * |
||
227 | * @since 2.1 |
||
228 | * |
||
229 | * @return string |
||
230 | 3 | */ |
|
231 | 3 | public function serialize() { |
|
234 | |||
235 | /** |
||
236 | * @see Serializable::unserialize |
||
237 | * |
||
238 | * @since 2.1 |
||
239 | * |
||
240 | * @param string $serialized |
||
241 | 3 | */ |
|
242 | 3 | public function unserialize( $serialized ) { |
|
245 | |||
246 | /** |
||
247 | * @since 4.4 |
||
248 | * |
||
249 | * @return bool |
||
250 | 3 | */ |
|
251 | 3 | public function isEmpty() { |
|
254 | |||
255 | /** |
||
256 | * The hash is purely valuer based. Order of the elements in the array is not held into account. |
||
257 | * |
||
258 | * @since 0.3 |
||
259 | * |
||
260 | * @return string |
||
261 | */ |
||
262 | public function getValueHash() { |
||
266 | |||
267 | /** |
||
268 | * @see Comparable::equals |
||
269 | * |
||
270 | * The comparison is done purely value based, ignoring the order of the elements in the array. |
||
271 | * |
||
272 | * @since 0.3 |
||
273 | * |
||
274 | * @param mixed $target |
||
275 | * |
||
276 | * @return bool |
||
277 | */ |
||
278 | public function equals( $target ) { |
||
286 | |||
287 | /** |
||
288 | * @see Countable::count |
||
289 | * |
||
290 | * @return int |
||
291 | */ |
||
292 | public function count() { |
||
295 | |||
296 | /** |
||
297 | * @see IteratorAggregate::getIterator |
||
298 | * |
||
299 | * @since 5.0 |
||
300 | * |
||
301 | * @return Traversable |
||
302 | */ |
||
303 | public function getIterator() { |
||
306 | |||
307 | } |
||
308 |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..