@@ -15,745 +15,745 @@ |
||
15 | 15 | */ |
16 | 16 | class Collection implements CollectionContract { |
17 | 17 | |
18 | - /** |
|
19 | - * Collection elements. |
|
20 | - * |
|
21 | - * @var array |
|
22 | - */ |
|
23 | - protected $elements = array(); |
|
24 | - |
|
25 | - /** |
|
26 | - * Collection type to enforce. |
|
27 | - * |
|
28 | - * @var Type |
|
29 | - */ |
|
30 | - private $type; |
|
31 | - |
|
32 | - /** |
|
33 | - * Where Collection is in loop. |
|
34 | - * |
|
35 | - * @var int |
|
36 | - */ |
|
37 | - protected $position = 0; |
|
38 | - |
|
39 | - /** |
|
40 | - * Collection constructor. |
|
41 | - * |
|
42 | - * @param string $type |
|
43 | - * @param array $elements |
|
44 | - */ |
|
45 | - public function __construct( $type, array $elements = array() ) { |
|
46 | - $this->type = new Type( $type ); |
|
47 | - |
|
48 | - if ( $this->type->is_model() ) { |
|
49 | - foreach ( $elements as $idx => $element ) { |
|
50 | - if ( is_array( $element ) ) { |
|
51 | - $elements[ $idx ] = $this->type->create_model( $element ); |
|
52 | - } |
|
53 | - } |
|
54 | - } |
|
55 | - |
|
56 | - if ( $elements ) { |
|
57 | - $this->type->validate_elements( $elements ); |
|
58 | - } |
|
59 | - |
|
60 | - $this->elements = $elements; |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * {@inheritdoc} |
|
65 | - * |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function get_type() { |
|
69 | - return $this->type->get_type(); |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * {@inheritdoc} |
|
74 | - * |
|
75 | - * @param mixed $element |
|
76 | - * |
|
77 | - * @return Collection |
|
78 | - * |
|
79 | - * @throws InvalidArgumentException |
|
80 | - */ |
|
81 | - public function add( $element ) { |
|
82 | - if ( $this->type->is_model() && is_array( $element ) ) { |
|
83 | - $element = $this->type->create_model( $element ); |
|
84 | - } |
|
85 | - |
|
86 | - $this->type->validate_element( $element ); |
|
87 | - |
|
88 | - $elements = $this->elements; |
|
89 | - $elements[] = $element; |
|
90 | - |
|
91 | - $collection = new static( $this->get_type() ); |
|
92 | - $collection->set_from_trusted( $elements ); |
|
93 | - |
|
94 | - return $collection; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * {@inheritdoc} |
|
99 | - * |
|
100 | - * @return Collection |
|
101 | - */ |
|
102 | - public function clear() { |
|
103 | - return new static( $this->get_type() ); |
|
104 | - } |
|
105 | - |
|
106 | - /** |
|
107 | - * {@inheritdoc} |
|
108 | - * |
|
109 | - * @param callable $condition Condition to satisfy. |
|
110 | - * |
|
111 | - * @return bool |
|
112 | - */ |
|
113 | - public function contains( $condition ) { |
|
114 | - return (bool) $this->find( $condition ); |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * {@inheritdoc} |
|
119 | - * |
|
120 | - * @param callable $condition Condition to satisfy. |
|
121 | - * |
|
122 | - * @return mixed |
|
123 | - */ |
|
124 | - public function find( $condition ) { |
|
125 | - $index = $this->find_index( $condition ); |
|
126 | - |
|
127 | - return -1 === $index ? null : $this->elements[ $index ]; |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * {@inheritdoc} |
|
132 | - * |
|
133 | - * @param callable $condition Condition to satisfy. |
|
134 | - * |
|
135 | - * @return int |
|
136 | - */ |
|
137 | - public function find_index( $condition ) { |
|
138 | - $index = -1; |
|
139 | - |
|
140 | - for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) { |
|
141 | - if ( call_user_func( $condition, ($this->at( $i ) ) ) ) { |
|
142 | - $index = $i; |
|
143 | - break; |
|
144 | - } |
|
145 | - } |
|
146 | - |
|
147 | - return $index; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Fetches the element at the provided index. |
|
152 | - * |
|
153 | - * @param int $index Index to get element from. |
|
154 | - * |
|
155 | - * @return mixed |
|
156 | - * |
|
157 | - * @throws OutOfRangeException |
|
158 | - */ |
|
159 | - public function at( $index ) { |
|
160 | - $this->validate_index( $index ); |
|
161 | - |
|
162 | - return $this->elements[ $index ]; |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * {@inheritdoc} |
|
167 | - * |
|
168 | - * @param int $index Index to check for existence. |
|
169 | - * |
|
170 | - * @return bool |
|
171 | - * |
|
172 | - * @throws InvalidArgumentException |
|
173 | - */ |
|
174 | - public function index_exists( $index ) { |
|
175 | - if ( ! is_int( $index ) ) { |
|
176 | - throw new InvalidArgumentException( 'Index must be an integer' ); |
|
177 | - } |
|
178 | - |
|
179 | - if ( $index < 0 ) { |
|
180 | - throw new InvalidArgumentException( 'Index must be a non-negative integer' ); |
|
181 | - } |
|
182 | - |
|
183 | - return $index < $this->count(); |
|
184 | - } |
|
185 | - |
|
186 | - /** |
|
187 | - * {@inheritdoc} |
|
188 | - * |
|
189 | - * @param callable $condition Condition to satisfy. |
|
190 | - * |
|
191 | - * @return Collection |
|
192 | - */ |
|
193 | - public function filter( $condition ) { |
|
194 | - $elements = array(); |
|
195 | - |
|
196 | - foreach ( $this->elements as $element ) { |
|
197 | - if ( call_user_func( $condition, $element ) ) { |
|
198 | - $elements[] = $element; |
|
199 | - } |
|
200 | - } |
|
201 | - |
|
202 | - return $this->new_from_trusted( $elements ); |
|
203 | - } |
|
204 | - /** |
|
205 | - * {@inheritdoc} |
|
206 | - * |
|
207 | - * @param callable $condition Condition to satisfy. |
|
208 | - * |
|
209 | - * @return mixed |
|
210 | - */ |
|
211 | - public function find_last( $condition ) { |
|
212 | - $index = $this->find_last_index( $condition ); |
|
213 | - |
|
214 | - return -1 === $index ? null : $this->elements[ $index ]; |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * {@inheritdoc} |
|
219 | - * |
|
220 | - * @param callable $condition |
|
221 | - * @return int |
|
222 | - */ |
|
223 | - public function find_last_index( $condition ) { |
|
224 | - $index = -1; |
|
225 | - |
|
226 | - for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) { |
|
227 | - if ( call_user_func( $condition, $this->elements[ $i ] ) ) { |
|
228 | - $index = $i; |
|
229 | - break; |
|
230 | - } |
|
231 | - } |
|
232 | - |
|
233 | - return $index; |
|
234 | - } |
|
235 | - |
|
236 | - /** |
|
237 | - * {@inheritdoc} |
|
238 | - * |
|
239 | - * @param int $start Begining index to slice from. |
|
240 | - * @param int $end End index to slice to. |
|
241 | - * |
|
242 | - * @return Collection |
|
243 | - * |
|
244 | - * @throws InvalidArgumentException |
|
245 | - */ |
|
246 | - public function slice( $start, $end ) { |
|
247 | - if ( $start < 0 || ! is_int( $start ) ) { |
|
248 | - throw new InvalidArgumentException( 'Start must be a non-negative integer' ); |
|
249 | - } |
|
250 | - |
|
251 | - if ( $end < 0 || ! is_int( $end ) ) { |
|
252 | - throw new InvalidArgumentException( 'End must be a positive integer' ); |
|
253 | - } |
|
254 | - |
|
255 | - if ( $start > $end ) { |
|
256 | - throw new InvalidArgumentException( 'End must be greater than start' ); |
|
257 | - } |
|
258 | - |
|
259 | - if ( $end > $this->count() + 1 ) { |
|
260 | - throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' ); |
|
261 | - } |
|
262 | - |
|
263 | - $length = $end - $start + 1; |
|
264 | - |
|
265 | - return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) ); |
|
266 | - } |
|
267 | - |
|
268 | - /** |
|
269 | - * {@inheritdoc} |
|
270 | - * |
|
271 | - * @param int $index Index to start at. |
|
272 | - * @param mixed $element Element to insert. |
|
273 | - * |
|
274 | - * @return Collection |
|
275 | - * |
|
276 | - * @throws InvalidArgumentException |
|
277 | - * @throws OutOfRangeException |
|
278 | - */ |
|
279 | - public function insert( $index, $element ) { |
|
280 | - $this->validate_index( $index ); |
|
281 | - $this->type->validate_element( $element ); |
|
282 | - |
|
283 | - $a = array_slice( $this->elements, 0, $index ); |
|
284 | - $b = array_slice( $this->elements, $index, count( $this->elements ) ); |
|
285 | - |
|
286 | - $a[] = $element; |
|
287 | - |
|
288 | - return $this->new_from_trusted( array_merge( $a, $b ) ); |
|
289 | - } |
|
290 | - |
|
291 | - /** |
|
292 | - * {@inheritdoc} |
|
293 | - * |
|
294 | - * @param int $index Index to start insertion at. |
|
295 | - * @param array $elements Elements in insert. |
|
296 | - * |
|
297 | - * @return Collection |
|
298 | - * |
|
299 | - * @throws OutOfRangeException |
|
300 | - */ |
|
301 | - public function insert_range( $index, array $elements ) { |
|
302 | - $this->validate_index( $index ); |
|
303 | - $this->type->validate_elements( $elements ); |
|
304 | - |
|
305 | - if ( $index < 0 ) { |
|
306 | - $index = $this->count() + $index + 1; |
|
307 | - } |
|
308 | - |
|
309 | - return $this->new_from_trusted( |
|
310 | - array_merge( |
|
311 | - array_slice( $this->elements, 0, $index ), |
|
312 | - $elements, |
|
313 | - array_slice( $this->elements, $index, count( $this->elements ) ) |
|
314 | - ) |
|
315 | - ); |
|
316 | - } |
|
317 | - |
|
318 | - /** |
|
319 | - * {@inheritdoc} |
|
320 | - * |
|
321 | - * @param callable $condition Condition to satisfy. |
|
322 | - * |
|
323 | - * @return Collection |
|
324 | - */ |
|
325 | - public function reject( $condition ) { |
|
326 | - $inverse = function ( $element ) use ( $condition ) { |
|
327 | - return ! call_user_func( $condition, $element ); |
|
328 | - }; |
|
329 | - |
|
330 | - return $this->filter( $inverse ); |
|
331 | - } |
|
332 | - |
|
333 | - /** |
|
334 | - * {@inheritdoc} |
|
335 | - * |
|
336 | - * @param int $index Index to remove. |
|
337 | - * |
|
338 | - * @return Collection |
|
339 | - * |
|
340 | - * @throws OutOfRangeException |
|
341 | - */ |
|
342 | - public function remove_at( $index ) { |
|
343 | - $this->validate_index( $index ); |
|
344 | - |
|
345 | - $elements = $this->elements; |
|
346 | - |
|
347 | - return $this->new_from_trusted( |
|
348 | - array_merge( |
|
349 | - array_slice( $elements, 0, $index ), |
|
350 | - array_slice( $elements, $index + 1, count( $elements ) ) |
|
351 | - ) |
|
352 | - ); |
|
353 | - } |
|
354 | - /** |
|
355 | - * {@inheritdoc} |
|
356 | - * |
|
357 | - * @return Collection |
|
358 | - */ |
|
359 | - public function reverse() { |
|
360 | - return $this->new_from_trusted( |
|
361 | - array_reverse( $this->elements ) |
|
362 | - ); |
|
363 | - } |
|
364 | - |
|
365 | - /** |
|
366 | - * {@inheritdoc} |
|
367 | - * |
|
368 | - * @param callable $callback Sort callback. |
|
369 | - * |
|
370 | - * @return Collection |
|
371 | - */ |
|
372 | - public function sort( $callback ) { |
|
373 | - $elements = $this->elements; |
|
374 | - usort( $elements, $callback ); |
|
375 | - return $this->new_from_trusted( $elements ); |
|
376 | - } |
|
377 | - |
|
378 | - /** |
|
379 | - * {@inheritdoc} |
|
380 | - * |
|
381 | - * @return array |
|
382 | - */ |
|
383 | - public function to_array() { |
|
384 | - return $this->elements; |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * {@inheritdoc} |
|
389 | - * |
|
390 | - * @param callable $callable Reducer function. |
|
391 | - * |
|
392 | - * @param null $initial Initial reducer value. |
|
393 | - * |
|
394 | - * @return mixed |
|
395 | - */ |
|
396 | - public function reduce( $callable, $initial = null ) { |
|
397 | - return array_reduce( $this->elements, $callable, $initial ); |
|
398 | - } |
|
399 | - |
|
400 | - /** |
|
401 | - * {@inheritdoc} |
|
402 | - * |
|
403 | - * @param callable $condition Condition callback. |
|
404 | - * |
|
405 | - * @return bool |
|
406 | - */ |
|
407 | - public function every( $condition ) { |
|
408 | - $response = true; |
|
409 | - |
|
410 | - foreach ( $this->elements as $element ) { |
|
411 | - $result = call_user_func( $condition, $element ); |
|
412 | - |
|
413 | - if ( false === $result ) { |
|
414 | - $response = false; |
|
415 | - break; |
|
416 | - } |
|
417 | - } |
|
418 | - |
|
419 | - return $response; |
|
420 | - } |
|
421 | - |
|
422 | - /** |
|
423 | - * {@inheritdoc} |
|
424 | - * |
|
425 | - * @param int $num Number of elements to drop. |
|
426 | - * |
|
427 | - * @return Collection |
|
428 | - * |
|
429 | - * @throws InvalidArgumentException |
|
430 | - */ |
|
431 | - public function drop( $num ) { |
|
432 | - if ( $num > $this->count() ) { |
|
433 | - $num = $this->count(); |
|
434 | - } |
|
435 | - |
|
436 | - return $this->slice( $num, $this->count() ); |
|
437 | - } |
|
438 | - |
|
439 | - /** |
|
440 | - * {@inheritdoc} |
|
441 | - * |
|
442 | - * @param int $num Number of elements to drop. |
|
443 | - * |
|
444 | - * @return Collection |
|
445 | - * |
|
446 | - * @throws InvalidArgumentException |
|
447 | - */ |
|
448 | - public function drop_right( $num ) { |
|
449 | - return $num !== $this->count() |
|
450 | - ? $this->slice( 0, $this->count() - $num - 1 ) |
|
451 | - : $this->clear(); |
|
452 | - } |
|
453 | - |
|
454 | - /** |
|
455 | - * {@inheritdoc} |
|
456 | - * |
|
457 | - * @param callable $condition Condition callback. |
|
458 | - * |
|
459 | - * @return Collection |
|
460 | - */ |
|
461 | - public function drop_while( $condition ) { |
|
462 | - $count = $this->count_while_true( $condition ); |
|
463 | - return $count ? $this->drop( $count ) : $this; |
|
464 | - } |
|
465 | - /** |
|
466 | - * {@inheritdoc} |
|
467 | - * |
|
468 | - * @return Collection |
|
469 | - * |
|
470 | - * @throws InvalidArgumentException |
|
471 | - */ |
|
472 | - public function tail() { |
|
473 | - return $this->slice( 1, $this->count() ); |
|
474 | - } |
|
475 | - |
|
476 | - /** |
|
477 | - * {@inheritdoc} |
|
478 | - * |
|
479 | - * @param int $num Number of elements to take. |
|
480 | - * |
|
481 | - * @return Collection |
|
482 | - * |
|
483 | - * @throws InvalidArgumentException |
|
484 | - */ |
|
485 | - public function take( $num ) { |
|
486 | - return $this->slice( 0, $num - 1 ); |
|
487 | - } |
|
488 | - |
|
489 | - /** |
|
490 | - * {@inheritdoc} |
|
491 | - * |
|
492 | - * @param int $num Number of elements to take. |
|
493 | - * |
|
494 | - * @return Collection |
|
495 | - * |
|
496 | - * @throws InvalidArgumentException |
|
497 | - */ |
|
498 | - public function take_right( $num ) { |
|
499 | - return $this->slice( $this->count() - $num, $this->count() ); |
|
500 | - } |
|
501 | - |
|
502 | - /** |
|
503 | - * {@inheritdoc} |
|
504 | - * |
|
505 | - * @param callable $condition Callback function. |
|
506 | - * |
|
507 | - * @return Collection |
|
508 | - */ |
|
509 | - public function take_while( $condition ) { |
|
510 | - $count = $this->count_while_true( $condition ); |
|
511 | - |
|
512 | - return $count ? $this->take( $count ) : $this->clear(); |
|
513 | - } |
|
514 | - |
|
515 | - /** |
|
516 | - * {@inheritdoc} |
|
517 | - * |
|
518 | - * @param callable $callable Callback function. |
|
519 | - */ |
|
520 | - public function each( $callable ) { |
|
521 | - foreach ( $this->elements as $element ) { |
|
522 | - call_user_func( $callable, $element ); |
|
523 | - } |
|
524 | - } |
|
525 | - |
|
526 | - /** |
|
527 | - * {@inheritdoc} |
|
528 | - * |
|
529 | - * @param callable $callable Callback function. |
|
530 | - * |
|
531 | - * @return Collection |
|
532 | - */ |
|
533 | - public function map( $callable ) { |
|
534 | - $elements = array(); |
|
535 | - $type = null; |
|
536 | - foreach ( $this->elements as $element ) { |
|
537 | - $result = call_user_func( $callable, $element ); |
|
538 | - |
|
539 | - if ( null === $type ) { |
|
540 | - $type = gettype( $result ); |
|
541 | - |
|
542 | - if ( 'object' === $type ) { |
|
543 | - $type = get_class( $result ); |
|
544 | - } |
|
545 | - } |
|
546 | - |
|
547 | - $elements[] = $result; |
|
548 | - } |
|
549 | - |
|
550 | - return $this->new_from_trusted( $elements, $type ? : $this->get_type() ); |
|
551 | - } |
|
552 | - |
|
553 | - /** |
|
554 | - * {@inheritdoc} |
|
555 | - * |
|
556 | - * @param callable $callable Reducer function. |
|
557 | - * @param null $initial Initial value. |
|
558 | - * |
|
559 | - * @return mixed |
|
560 | - */ |
|
561 | - public function reduce_right( $callable, $initial = null ) { |
|
562 | - return array_reduce( |
|
563 | - array_reverse( $this->elements ), |
|
564 | - $callable, |
|
565 | - $initial |
|
566 | - ); |
|
567 | - } |
|
568 | - |
|
569 | - /** |
|
570 | - * {@inheritdoc} |
|
571 | - * |
|
572 | - * @return Collection |
|
573 | - */ |
|
574 | - public function shuffle() { |
|
575 | - $elements = $this->elements; |
|
576 | - shuffle( $elements ); |
|
577 | - |
|
578 | - return $this->new_from_trusted( $elements ); |
|
579 | - } |
|
580 | - |
|
581 | - /** |
|
582 | - * {@inheritdoc} |
|
583 | - * |
|
584 | - * @param array|Collection $elements Array of elements to merge. |
|
585 | - * |
|
586 | - * @return Collection |
|
587 | - * |
|
588 | - * @throws InvalidArgumentException |
|
589 | - */ |
|
590 | - public function merge( $elements ) { |
|
591 | - if ( $elements instanceof static ) { |
|
592 | - $elements = $elements->to_array(); |
|
593 | - } |
|
594 | - |
|
595 | - if ( ! is_array( $elements ) ) { |
|
596 | - throw new InvalidArgumentException( 'Merge must be given array or Collection' ); |
|
597 | - } |
|
598 | - |
|
599 | - $this->type->validate_elements( $elements ); |
|
600 | - |
|
601 | - return $this->new_from_trusted( |
|
602 | - array_merge( $this->elements, $elements ) |
|
603 | - ); |
|
604 | - } |
|
605 | - |
|
606 | - /** |
|
607 | - * {@inheritdoc} |
|
608 | - * |
|
609 | - * @return mixed |
|
610 | - * |
|
611 | - * @throws OutOfBoundsException |
|
612 | - */ |
|
613 | - public function first() { |
|
614 | - if ( empty( $this->elements ) ) { |
|
615 | - throw new OutOfBoundsException( 'Cannot get first element of empty Collection' ); |
|
616 | - } |
|
617 | - |
|
618 | - return reset( $this->elements ); |
|
619 | - } |
|
620 | - |
|
621 | - /** |
|
622 | - * {@inheritdoc} |
|
623 | - * |
|
624 | - * @return mixed |
|
625 | - * |
|
626 | - * @throws OutOfBoundsException |
|
627 | - */ |
|
628 | - public function last() { |
|
629 | - if ( empty( $this->elements ) ) { |
|
630 | - throw new OutOfBoundsException( 'Cannot get last element of empty Collection' ); |
|
631 | - } |
|
632 | - |
|
633 | - return end( $this->elements ); |
|
634 | - } |
|
635 | - |
|
636 | - /** |
|
637 | - * {@inheritdoc} |
|
638 | - * |
|
639 | - * @return int |
|
640 | - */ |
|
641 | - public function count() { |
|
642 | - return count( $this->elements ); |
|
643 | - } |
|
644 | - |
|
645 | - /** |
|
646 | - * {@inheritDoc} |
|
647 | - * |
|
648 | - * @return array |
|
649 | - */ |
|
650 | - public function serialize() { |
|
651 | - return $this->map(function( $element ) { |
|
652 | - if ( $element instanceof Serializes ) { |
|
653 | - return $element->serialize(); |
|
654 | - } |
|
655 | - |
|
656 | - return $element; |
|
657 | - } )->to_array(); |
|
658 | - } |
|
659 | - |
|
660 | - /** |
|
661 | - * Return the current element. |
|
662 | - * |
|
663 | - * @return mixed |
|
664 | - */ |
|
665 | - public function current() { |
|
666 | - return $this->at( $this->position ); |
|
667 | - } |
|
668 | - |
|
669 | - /** |
|
670 | - * Move forward to next element. |
|
671 | - */ |
|
672 | - public function next() { |
|
673 | - $this->position ++; |
|
674 | - } |
|
675 | - |
|
676 | - /** |
|
677 | - * Return the key of the current element. |
|
678 | - * |
|
679 | - * @return mixed |
|
680 | - */ |
|
681 | - public function key() { |
|
682 | - return $this->position; |
|
683 | - } |
|
684 | - |
|
685 | - /** |
|
686 | - * Checks if current position is valid. |
|
687 | - * |
|
688 | - * @return bool |
|
689 | - */ |
|
690 | - public function valid() { |
|
691 | - return isset( $this->elements[ $this->position ] ); |
|
692 | - } |
|
693 | - |
|
694 | - /** |
|
695 | - * Rewind the Iterator to the first element. |
|
696 | - */ |
|
697 | - public function rewind() { |
|
698 | - $this->position = 0; |
|
699 | - } |
|
700 | - |
|
701 | - /** |
|
702 | - * Creates a new instance of the Collection |
|
703 | - * from a trusted set of elements. |
|
704 | - * |
|
705 | - * @param array $elements Array of elements to pass into new collection. |
|
706 | - * @param null|mixed $type |
|
707 | - * |
|
708 | - * @return static |
|
709 | - */ |
|
710 | - protected function new_from_trusted( array $elements, $type = null ) { |
|
711 | - $collection = new static( null !== $type ? $type : $this->get_type() ); |
|
712 | - $collection->set_from_trusted( $elements ); |
|
713 | - |
|
714 | - return $collection; |
|
715 | - } |
|
716 | - |
|
717 | - /** |
|
718 | - * Sets the elements without validating them. |
|
719 | - * |
|
720 | - * @param array $elements Pre-validated elements to set. |
|
721 | - */ |
|
722 | - protected function set_from_trusted( array $elements ) { |
|
723 | - $this->elements = $elements; |
|
724 | - } |
|
725 | - |
|
726 | - /** |
|
727 | - * Number of elements true for the condition. |
|
728 | - * |
|
729 | - * @param callable $condition Condition to check. |
|
730 | - * @return int |
|
731 | - */ |
|
732 | - protected function count_while_true( $condition ) { |
|
733 | - $count = 0; |
|
734 | - |
|
735 | - foreach ( $this->elements as $element ) { |
|
736 | - if ( ! $condition($element) ) { |
|
737 | - break; |
|
738 | - } |
|
739 | - $count++; |
|
740 | - } |
|
741 | - |
|
742 | - return $count; |
|
743 | - } |
|
744 | - |
|
745 | - /** |
|
746 | - * Validates a number to be used as an index. |
|
747 | - * |
|
748 | - * @param integer $index The number to be validated as an index. |
|
749 | - * |
|
750 | - * @throws OutOfRangeException |
|
751 | - */ |
|
752 | - protected function validate_index( $index ) { |
|
753 | - $exists = $this->index_exists( $index ); |
|
754 | - |
|
755 | - if ( ! $exists ) { |
|
756 | - throw new OutOfRangeException( 'Index out of bounds of collection' ); |
|
757 | - } |
|
758 | - } |
|
18 | + /** |
|
19 | + * Collection elements. |
|
20 | + * |
|
21 | + * @var array |
|
22 | + */ |
|
23 | + protected $elements = array(); |
|
24 | + |
|
25 | + /** |
|
26 | + * Collection type to enforce. |
|
27 | + * |
|
28 | + * @var Type |
|
29 | + */ |
|
30 | + private $type; |
|
31 | + |
|
32 | + /** |
|
33 | + * Where Collection is in loop. |
|
34 | + * |
|
35 | + * @var int |
|
36 | + */ |
|
37 | + protected $position = 0; |
|
38 | + |
|
39 | + /** |
|
40 | + * Collection constructor. |
|
41 | + * |
|
42 | + * @param string $type |
|
43 | + * @param array $elements |
|
44 | + */ |
|
45 | + public function __construct( $type, array $elements = array() ) { |
|
46 | + $this->type = new Type( $type ); |
|
47 | + |
|
48 | + if ( $this->type->is_model() ) { |
|
49 | + foreach ( $elements as $idx => $element ) { |
|
50 | + if ( is_array( $element ) ) { |
|
51 | + $elements[ $idx ] = $this->type->create_model( $element ); |
|
52 | + } |
|
53 | + } |
|
54 | + } |
|
55 | + |
|
56 | + if ( $elements ) { |
|
57 | + $this->type->validate_elements( $elements ); |
|
58 | + } |
|
59 | + |
|
60 | + $this->elements = $elements; |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * {@inheritdoc} |
|
65 | + * |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function get_type() { |
|
69 | + return $this->type->get_type(); |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * {@inheritdoc} |
|
74 | + * |
|
75 | + * @param mixed $element |
|
76 | + * |
|
77 | + * @return Collection |
|
78 | + * |
|
79 | + * @throws InvalidArgumentException |
|
80 | + */ |
|
81 | + public function add( $element ) { |
|
82 | + if ( $this->type->is_model() && is_array( $element ) ) { |
|
83 | + $element = $this->type->create_model( $element ); |
|
84 | + } |
|
85 | + |
|
86 | + $this->type->validate_element( $element ); |
|
87 | + |
|
88 | + $elements = $this->elements; |
|
89 | + $elements[] = $element; |
|
90 | + |
|
91 | + $collection = new static( $this->get_type() ); |
|
92 | + $collection->set_from_trusted( $elements ); |
|
93 | + |
|
94 | + return $collection; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * {@inheritdoc} |
|
99 | + * |
|
100 | + * @return Collection |
|
101 | + */ |
|
102 | + public function clear() { |
|
103 | + return new static( $this->get_type() ); |
|
104 | + } |
|
105 | + |
|
106 | + /** |
|
107 | + * {@inheritdoc} |
|
108 | + * |
|
109 | + * @param callable $condition Condition to satisfy. |
|
110 | + * |
|
111 | + * @return bool |
|
112 | + */ |
|
113 | + public function contains( $condition ) { |
|
114 | + return (bool) $this->find( $condition ); |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * {@inheritdoc} |
|
119 | + * |
|
120 | + * @param callable $condition Condition to satisfy. |
|
121 | + * |
|
122 | + * @return mixed |
|
123 | + */ |
|
124 | + public function find( $condition ) { |
|
125 | + $index = $this->find_index( $condition ); |
|
126 | + |
|
127 | + return -1 === $index ? null : $this->elements[ $index ]; |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * {@inheritdoc} |
|
132 | + * |
|
133 | + * @param callable $condition Condition to satisfy. |
|
134 | + * |
|
135 | + * @return int |
|
136 | + */ |
|
137 | + public function find_index( $condition ) { |
|
138 | + $index = -1; |
|
139 | + |
|
140 | + for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) { |
|
141 | + if ( call_user_func( $condition, ($this->at( $i ) ) ) ) { |
|
142 | + $index = $i; |
|
143 | + break; |
|
144 | + } |
|
145 | + } |
|
146 | + |
|
147 | + return $index; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Fetches the element at the provided index. |
|
152 | + * |
|
153 | + * @param int $index Index to get element from. |
|
154 | + * |
|
155 | + * @return mixed |
|
156 | + * |
|
157 | + * @throws OutOfRangeException |
|
158 | + */ |
|
159 | + public function at( $index ) { |
|
160 | + $this->validate_index( $index ); |
|
161 | + |
|
162 | + return $this->elements[ $index ]; |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * {@inheritdoc} |
|
167 | + * |
|
168 | + * @param int $index Index to check for existence. |
|
169 | + * |
|
170 | + * @return bool |
|
171 | + * |
|
172 | + * @throws InvalidArgumentException |
|
173 | + */ |
|
174 | + public function index_exists( $index ) { |
|
175 | + if ( ! is_int( $index ) ) { |
|
176 | + throw new InvalidArgumentException( 'Index must be an integer' ); |
|
177 | + } |
|
178 | + |
|
179 | + if ( $index < 0 ) { |
|
180 | + throw new InvalidArgumentException( 'Index must be a non-negative integer' ); |
|
181 | + } |
|
182 | + |
|
183 | + return $index < $this->count(); |
|
184 | + } |
|
185 | + |
|
186 | + /** |
|
187 | + * {@inheritdoc} |
|
188 | + * |
|
189 | + * @param callable $condition Condition to satisfy. |
|
190 | + * |
|
191 | + * @return Collection |
|
192 | + */ |
|
193 | + public function filter( $condition ) { |
|
194 | + $elements = array(); |
|
195 | + |
|
196 | + foreach ( $this->elements as $element ) { |
|
197 | + if ( call_user_func( $condition, $element ) ) { |
|
198 | + $elements[] = $element; |
|
199 | + } |
|
200 | + } |
|
201 | + |
|
202 | + return $this->new_from_trusted( $elements ); |
|
203 | + } |
|
204 | + /** |
|
205 | + * {@inheritdoc} |
|
206 | + * |
|
207 | + * @param callable $condition Condition to satisfy. |
|
208 | + * |
|
209 | + * @return mixed |
|
210 | + */ |
|
211 | + public function find_last( $condition ) { |
|
212 | + $index = $this->find_last_index( $condition ); |
|
213 | + |
|
214 | + return -1 === $index ? null : $this->elements[ $index ]; |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * {@inheritdoc} |
|
219 | + * |
|
220 | + * @param callable $condition |
|
221 | + * @return int |
|
222 | + */ |
|
223 | + public function find_last_index( $condition ) { |
|
224 | + $index = -1; |
|
225 | + |
|
226 | + for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) { |
|
227 | + if ( call_user_func( $condition, $this->elements[ $i ] ) ) { |
|
228 | + $index = $i; |
|
229 | + break; |
|
230 | + } |
|
231 | + } |
|
232 | + |
|
233 | + return $index; |
|
234 | + } |
|
235 | + |
|
236 | + /** |
|
237 | + * {@inheritdoc} |
|
238 | + * |
|
239 | + * @param int $start Begining index to slice from. |
|
240 | + * @param int $end End index to slice to. |
|
241 | + * |
|
242 | + * @return Collection |
|
243 | + * |
|
244 | + * @throws InvalidArgumentException |
|
245 | + */ |
|
246 | + public function slice( $start, $end ) { |
|
247 | + if ( $start < 0 || ! is_int( $start ) ) { |
|
248 | + throw new InvalidArgumentException( 'Start must be a non-negative integer' ); |
|
249 | + } |
|
250 | + |
|
251 | + if ( $end < 0 || ! is_int( $end ) ) { |
|
252 | + throw new InvalidArgumentException( 'End must be a positive integer' ); |
|
253 | + } |
|
254 | + |
|
255 | + if ( $start > $end ) { |
|
256 | + throw new InvalidArgumentException( 'End must be greater than start' ); |
|
257 | + } |
|
258 | + |
|
259 | + if ( $end > $this->count() + 1 ) { |
|
260 | + throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' ); |
|
261 | + } |
|
262 | + |
|
263 | + $length = $end - $start + 1; |
|
264 | + |
|
265 | + return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) ); |
|
266 | + } |
|
267 | + |
|
268 | + /** |
|
269 | + * {@inheritdoc} |
|
270 | + * |
|
271 | + * @param int $index Index to start at. |
|
272 | + * @param mixed $element Element to insert. |
|
273 | + * |
|
274 | + * @return Collection |
|
275 | + * |
|
276 | + * @throws InvalidArgumentException |
|
277 | + * @throws OutOfRangeException |
|
278 | + */ |
|
279 | + public function insert( $index, $element ) { |
|
280 | + $this->validate_index( $index ); |
|
281 | + $this->type->validate_element( $element ); |
|
282 | + |
|
283 | + $a = array_slice( $this->elements, 0, $index ); |
|
284 | + $b = array_slice( $this->elements, $index, count( $this->elements ) ); |
|
285 | + |
|
286 | + $a[] = $element; |
|
287 | + |
|
288 | + return $this->new_from_trusted( array_merge( $a, $b ) ); |
|
289 | + } |
|
290 | + |
|
291 | + /** |
|
292 | + * {@inheritdoc} |
|
293 | + * |
|
294 | + * @param int $index Index to start insertion at. |
|
295 | + * @param array $elements Elements in insert. |
|
296 | + * |
|
297 | + * @return Collection |
|
298 | + * |
|
299 | + * @throws OutOfRangeException |
|
300 | + */ |
|
301 | + public function insert_range( $index, array $elements ) { |
|
302 | + $this->validate_index( $index ); |
|
303 | + $this->type->validate_elements( $elements ); |
|
304 | + |
|
305 | + if ( $index < 0 ) { |
|
306 | + $index = $this->count() + $index + 1; |
|
307 | + } |
|
308 | + |
|
309 | + return $this->new_from_trusted( |
|
310 | + array_merge( |
|
311 | + array_slice( $this->elements, 0, $index ), |
|
312 | + $elements, |
|
313 | + array_slice( $this->elements, $index, count( $this->elements ) ) |
|
314 | + ) |
|
315 | + ); |
|
316 | + } |
|
317 | + |
|
318 | + /** |
|
319 | + * {@inheritdoc} |
|
320 | + * |
|
321 | + * @param callable $condition Condition to satisfy. |
|
322 | + * |
|
323 | + * @return Collection |
|
324 | + */ |
|
325 | + public function reject( $condition ) { |
|
326 | + $inverse = function ( $element ) use ( $condition ) { |
|
327 | + return ! call_user_func( $condition, $element ); |
|
328 | + }; |
|
329 | + |
|
330 | + return $this->filter( $inverse ); |
|
331 | + } |
|
332 | + |
|
333 | + /** |
|
334 | + * {@inheritdoc} |
|
335 | + * |
|
336 | + * @param int $index Index to remove. |
|
337 | + * |
|
338 | + * @return Collection |
|
339 | + * |
|
340 | + * @throws OutOfRangeException |
|
341 | + */ |
|
342 | + public function remove_at( $index ) { |
|
343 | + $this->validate_index( $index ); |
|
344 | + |
|
345 | + $elements = $this->elements; |
|
346 | + |
|
347 | + return $this->new_from_trusted( |
|
348 | + array_merge( |
|
349 | + array_slice( $elements, 0, $index ), |
|
350 | + array_slice( $elements, $index + 1, count( $elements ) ) |
|
351 | + ) |
|
352 | + ); |
|
353 | + } |
|
354 | + /** |
|
355 | + * {@inheritdoc} |
|
356 | + * |
|
357 | + * @return Collection |
|
358 | + */ |
|
359 | + public function reverse() { |
|
360 | + return $this->new_from_trusted( |
|
361 | + array_reverse( $this->elements ) |
|
362 | + ); |
|
363 | + } |
|
364 | + |
|
365 | + /** |
|
366 | + * {@inheritdoc} |
|
367 | + * |
|
368 | + * @param callable $callback Sort callback. |
|
369 | + * |
|
370 | + * @return Collection |
|
371 | + */ |
|
372 | + public function sort( $callback ) { |
|
373 | + $elements = $this->elements; |
|
374 | + usort( $elements, $callback ); |
|
375 | + return $this->new_from_trusted( $elements ); |
|
376 | + } |
|
377 | + |
|
378 | + /** |
|
379 | + * {@inheritdoc} |
|
380 | + * |
|
381 | + * @return array |
|
382 | + */ |
|
383 | + public function to_array() { |
|
384 | + return $this->elements; |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * {@inheritdoc} |
|
389 | + * |
|
390 | + * @param callable $callable Reducer function. |
|
391 | + * |
|
392 | + * @param null $initial Initial reducer value. |
|
393 | + * |
|
394 | + * @return mixed |
|
395 | + */ |
|
396 | + public function reduce( $callable, $initial = null ) { |
|
397 | + return array_reduce( $this->elements, $callable, $initial ); |
|
398 | + } |
|
399 | + |
|
400 | + /** |
|
401 | + * {@inheritdoc} |
|
402 | + * |
|
403 | + * @param callable $condition Condition callback. |
|
404 | + * |
|
405 | + * @return bool |
|
406 | + */ |
|
407 | + public function every( $condition ) { |
|
408 | + $response = true; |
|
409 | + |
|
410 | + foreach ( $this->elements as $element ) { |
|
411 | + $result = call_user_func( $condition, $element ); |
|
412 | + |
|
413 | + if ( false === $result ) { |
|
414 | + $response = false; |
|
415 | + break; |
|
416 | + } |
|
417 | + } |
|
418 | + |
|
419 | + return $response; |
|
420 | + } |
|
421 | + |
|
422 | + /** |
|
423 | + * {@inheritdoc} |
|
424 | + * |
|
425 | + * @param int $num Number of elements to drop. |
|
426 | + * |
|
427 | + * @return Collection |
|
428 | + * |
|
429 | + * @throws InvalidArgumentException |
|
430 | + */ |
|
431 | + public function drop( $num ) { |
|
432 | + if ( $num > $this->count() ) { |
|
433 | + $num = $this->count(); |
|
434 | + } |
|
435 | + |
|
436 | + return $this->slice( $num, $this->count() ); |
|
437 | + } |
|
438 | + |
|
439 | + /** |
|
440 | + * {@inheritdoc} |
|
441 | + * |
|
442 | + * @param int $num Number of elements to drop. |
|
443 | + * |
|
444 | + * @return Collection |
|
445 | + * |
|
446 | + * @throws InvalidArgumentException |
|
447 | + */ |
|
448 | + public function drop_right( $num ) { |
|
449 | + return $num !== $this->count() |
|
450 | + ? $this->slice( 0, $this->count() - $num - 1 ) |
|
451 | + : $this->clear(); |
|
452 | + } |
|
453 | + |
|
454 | + /** |
|
455 | + * {@inheritdoc} |
|
456 | + * |
|
457 | + * @param callable $condition Condition callback. |
|
458 | + * |
|
459 | + * @return Collection |
|
460 | + */ |
|
461 | + public function drop_while( $condition ) { |
|
462 | + $count = $this->count_while_true( $condition ); |
|
463 | + return $count ? $this->drop( $count ) : $this; |
|
464 | + } |
|
465 | + /** |
|
466 | + * {@inheritdoc} |
|
467 | + * |
|
468 | + * @return Collection |
|
469 | + * |
|
470 | + * @throws InvalidArgumentException |
|
471 | + */ |
|
472 | + public function tail() { |
|
473 | + return $this->slice( 1, $this->count() ); |
|
474 | + } |
|
475 | + |
|
476 | + /** |
|
477 | + * {@inheritdoc} |
|
478 | + * |
|
479 | + * @param int $num Number of elements to take. |
|
480 | + * |
|
481 | + * @return Collection |
|
482 | + * |
|
483 | + * @throws InvalidArgumentException |
|
484 | + */ |
|
485 | + public function take( $num ) { |
|
486 | + return $this->slice( 0, $num - 1 ); |
|
487 | + } |
|
488 | + |
|
489 | + /** |
|
490 | + * {@inheritdoc} |
|
491 | + * |
|
492 | + * @param int $num Number of elements to take. |
|
493 | + * |
|
494 | + * @return Collection |
|
495 | + * |
|
496 | + * @throws InvalidArgumentException |
|
497 | + */ |
|
498 | + public function take_right( $num ) { |
|
499 | + return $this->slice( $this->count() - $num, $this->count() ); |
|
500 | + } |
|
501 | + |
|
502 | + /** |
|
503 | + * {@inheritdoc} |
|
504 | + * |
|
505 | + * @param callable $condition Callback function. |
|
506 | + * |
|
507 | + * @return Collection |
|
508 | + */ |
|
509 | + public function take_while( $condition ) { |
|
510 | + $count = $this->count_while_true( $condition ); |
|
511 | + |
|
512 | + return $count ? $this->take( $count ) : $this->clear(); |
|
513 | + } |
|
514 | + |
|
515 | + /** |
|
516 | + * {@inheritdoc} |
|
517 | + * |
|
518 | + * @param callable $callable Callback function. |
|
519 | + */ |
|
520 | + public function each( $callable ) { |
|
521 | + foreach ( $this->elements as $element ) { |
|
522 | + call_user_func( $callable, $element ); |
|
523 | + } |
|
524 | + } |
|
525 | + |
|
526 | + /** |
|
527 | + * {@inheritdoc} |
|
528 | + * |
|
529 | + * @param callable $callable Callback function. |
|
530 | + * |
|
531 | + * @return Collection |
|
532 | + */ |
|
533 | + public function map( $callable ) { |
|
534 | + $elements = array(); |
|
535 | + $type = null; |
|
536 | + foreach ( $this->elements as $element ) { |
|
537 | + $result = call_user_func( $callable, $element ); |
|
538 | + |
|
539 | + if ( null === $type ) { |
|
540 | + $type = gettype( $result ); |
|
541 | + |
|
542 | + if ( 'object' === $type ) { |
|
543 | + $type = get_class( $result ); |
|
544 | + } |
|
545 | + } |
|
546 | + |
|
547 | + $elements[] = $result; |
|
548 | + } |
|
549 | + |
|
550 | + return $this->new_from_trusted( $elements, $type ? : $this->get_type() ); |
|
551 | + } |
|
552 | + |
|
553 | + /** |
|
554 | + * {@inheritdoc} |
|
555 | + * |
|
556 | + * @param callable $callable Reducer function. |
|
557 | + * @param null $initial Initial value. |
|
558 | + * |
|
559 | + * @return mixed |
|
560 | + */ |
|
561 | + public function reduce_right( $callable, $initial = null ) { |
|
562 | + return array_reduce( |
|
563 | + array_reverse( $this->elements ), |
|
564 | + $callable, |
|
565 | + $initial |
|
566 | + ); |
|
567 | + } |
|
568 | + |
|
569 | + /** |
|
570 | + * {@inheritdoc} |
|
571 | + * |
|
572 | + * @return Collection |
|
573 | + */ |
|
574 | + public function shuffle() { |
|
575 | + $elements = $this->elements; |
|
576 | + shuffle( $elements ); |
|
577 | + |
|
578 | + return $this->new_from_trusted( $elements ); |
|
579 | + } |
|
580 | + |
|
581 | + /** |
|
582 | + * {@inheritdoc} |
|
583 | + * |
|
584 | + * @param array|Collection $elements Array of elements to merge. |
|
585 | + * |
|
586 | + * @return Collection |
|
587 | + * |
|
588 | + * @throws InvalidArgumentException |
|
589 | + */ |
|
590 | + public function merge( $elements ) { |
|
591 | + if ( $elements instanceof static ) { |
|
592 | + $elements = $elements->to_array(); |
|
593 | + } |
|
594 | + |
|
595 | + if ( ! is_array( $elements ) ) { |
|
596 | + throw new InvalidArgumentException( 'Merge must be given array or Collection' ); |
|
597 | + } |
|
598 | + |
|
599 | + $this->type->validate_elements( $elements ); |
|
600 | + |
|
601 | + return $this->new_from_trusted( |
|
602 | + array_merge( $this->elements, $elements ) |
|
603 | + ); |
|
604 | + } |
|
605 | + |
|
606 | + /** |
|
607 | + * {@inheritdoc} |
|
608 | + * |
|
609 | + * @return mixed |
|
610 | + * |
|
611 | + * @throws OutOfBoundsException |
|
612 | + */ |
|
613 | + public function first() { |
|
614 | + if ( empty( $this->elements ) ) { |
|
615 | + throw new OutOfBoundsException( 'Cannot get first element of empty Collection' ); |
|
616 | + } |
|
617 | + |
|
618 | + return reset( $this->elements ); |
|
619 | + } |
|
620 | + |
|
621 | + /** |
|
622 | + * {@inheritdoc} |
|
623 | + * |
|
624 | + * @return mixed |
|
625 | + * |
|
626 | + * @throws OutOfBoundsException |
|
627 | + */ |
|
628 | + public function last() { |
|
629 | + if ( empty( $this->elements ) ) { |
|
630 | + throw new OutOfBoundsException( 'Cannot get last element of empty Collection' ); |
|
631 | + } |
|
632 | + |
|
633 | + return end( $this->elements ); |
|
634 | + } |
|
635 | + |
|
636 | + /** |
|
637 | + * {@inheritdoc} |
|
638 | + * |
|
639 | + * @return int |
|
640 | + */ |
|
641 | + public function count() { |
|
642 | + return count( $this->elements ); |
|
643 | + } |
|
644 | + |
|
645 | + /** |
|
646 | + * {@inheritDoc} |
|
647 | + * |
|
648 | + * @return array |
|
649 | + */ |
|
650 | + public function serialize() { |
|
651 | + return $this->map(function( $element ) { |
|
652 | + if ( $element instanceof Serializes ) { |
|
653 | + return $element->serialize(); |
|
654 | + } |
|
655 | + |
|
656 | + return $element; |
|
657 | + } )->to_array(); |
|
658 | + } |
|
659 | + |
|
660 | + /** |
|
661 | + * Return the current element. |
|
662 | + * |
|
663 | + * @return mixed |
|
664 | + */ |
|
665 | + public function current() { |
|
666 | + return $this->at( $this->position ); |
|
667 | + } |
|
668 | + |
|
669 | + /** |
|
670 | + * Move forward to next element. |
|
671 | + */ |
|
672 | + public function next() { |
|
673 | + $this->position ++; |
|
674 | + } |
|
675 | + |
|
676 | + /** |
|
677 | + * Return the key of the current element. |
|
678 | + * |
|
679 | + * @return mixed |
|
680 | + */ |
|
681 | + public function key() { |
|
682 | + return $this->position; |
|
683 | + } |
|
684 | + |
|
685 | + /** |
|
686 | + * Checks if current position is valid. |
|
687 | + * |
|
688 | + * @return bool |
|
689 | + */ |
|
690 | + public function valid() { |
|
691 | + return isset( $this->elements[ $this->position ] ); |
|
692 | + } |
|
693 | + |
|
694 | + /** |
|
695 | + * Rewind the Iterator to the first element. |
|
696 | + */ |
|
697 | + public function rewind() { |
|
698 | + $this->position = 0; |
|
699 | + } |
|
700 | + |
|
701 | + /** |
|
702 | + * Creates a new instance of the Collection |
|
703 | + * from a trusted set of elements. |
|
704 | + * |
|
705 | + * @param array $elements Array of elements to pass into new collection. |
|
706 | + * @param null|mixed $type |
|
707 | + * |
|
708 | + * @return static |
|
709 | + */ |
|
710 | + protected function new_from_trusted( array $elements, $type = null ) { |
|
711 | + $collection = new static( null !== $type ? $type : $this->get_type() ); |
|
712 | + $collection->set_from_trusted( $elements ); |
|
713 | + |
|
714 | + return $collection; |
|
715 | + } |
|
716 | + |
|
717 | + /** |
|
718 | + * Sets the elements without validating them. |
|
719 | + * |
|
720 | + * @param array $elements Pre-validated elements to set. |
|
721 | + */ |
|
722 | + protected function set_from_trusted( array $elements ) { |
|
723 | + $this->elements = $elements; |
|
724 | + } |
|
725 | + |
|
726 | + /** |
|
727 | + * Number of elements true for the condition. |
|
728 | + * |
|
729 | + * @param callable $condition Condition to check. |
|
730 | + * @return int |
|
731 | + */ |
|
732 | + protected function count_while_true( $condition ) { |
|
733 | + $count = 0; |
|
734 | + |
|
735 | + foreach ( $this->elements as $element ) { |
|
736 | + if ( ! $condition($element) ) { |
|
737 | + break; |
|
738 | + } |
|
739 | + $count++; |
|
740 | + } |
|
741 | + |
|
742 | + return $count; |
|
743 | + } |
|
744 | + |
|
745 | + /** |
|
746 | + * Validates a number to be used as an index. |
|
747 | + * |
|
748 | + * @param integer $index The number to be validated as an index. |
|
749 | + * |
|
750 | + * @throws OutOfRangeException |
|
751 | + */ |
|
752 | + protected function validate_index( $index ) { |
|
753 | + $exists = $this->index_exists( $index ); |
|
754 | + |
|
755 | + if ( ! $exists ) { |
|
756 | + throw new OutOfRangeException( 'Index out of bounds of collection' ); |
|
757 | + } |
|
758 | + } |
|
759 | 759 | } |
@@ -2,17 +2,17 @@ |
||
2 | 2 | namespace Intraxia\Jaxion\Contract\Axolotl; |
3 | 3 | |
4 | 4 | interface UsesCustomTable { |
5 | - /** |
|
6 | - * Returns the custom table name used by the model. |
|
7 | - * |
|
8 | - * @return string |
|
9 | - */ |
|
10 | - public static function get_table_name(); |
|
5 | + /** |
|
6 | + * Returns the custom table name used by the model. |
|
7 | + * |
|
8 | + * @return string |
|
9 | + */ |
|
10 | + public static function get_table_name(); |
|
11 | 11 | |
12 | - /** |
|
13 | - * Get the attribute used as the primary key. |
|
14 | - * |
|
15 | - * @return string |
|
16 | - */ |
|
17 | - public static function get_primary_key(); |
|
12 | + /** |
|
13 | + * Get the attribute used as the primary key. |
|
14 | + * |
|
15 | + * @return string |
|
16 | + */ |
|
17 | + public static function get_primary_key(); |
|
18 | 18 | } |
@@ -5,56 +5,56 @@ |
||
5 | 5 | use WP_Error; |
6 | 6 | |
7 | 7 | interface EntityManager { |
8 | - /** |
|
9 | - * Get a single model of the provided class with the given ID. |
|
10 | - * |
|
11 | - * @param string $class Fully qualified class name of model. |
|
12 | - * @param int $id ID of the model. |
|
13 | - * @param array $params Extra params/options. |
|
14 | - * |
|
15 | - * @return Model|WP_Error |
|
16 | - */ |
|
17 | - public function find( $class, $id, array $params = array() ); |
|
8 | + /** |
|
9 | + * Get a single model of the provided class with the given ID. |
|
10 | + * |
|
11 | + * @param string $class Fully qualified class name of model. |
|
12 | + * @param int $id ID of the model. |
|
13 | + * @param array $params Extra params/options. |
|
14 | + * |
|
15 | + * @return Model|WP_Error |
|
16 | + */ |
|
17 | + public function find( $class, $id, array $params = array() ); |
|
18 | 18 | |
19 | - /** |
|
20 | - * Finds all the models of the provided class for the given params. |
|
21 | - * |
|
22 | - * This method will return an empty Collection if the query returns no models. |
|
23 | - * |
|
24 | - * @param string $class Fully qualified class name of models to find. |
|
25 | - * @param array $params Params to constrain the find. |
|
26 | - * |
|
27 | - * @return Collection|WP_Error |
|
28 | - */ |
|
29 | - public function find_by( $class, array $params = array() ); |
|
19 | + /** |
|
20 | + * Finds all the models of the provided class for the given params. |
|
21 | + * |
|
22 | + * This method will return an empty Collection if the query returns no models. |
|
23 | + * |
|
24 | + * @param string $class Fully qualified class name of models to find. |
|
25 | + * @param array $params Params to constrain the find. |
|
26 | + * |
|
27 | + * @return Collection|WP_Error |
|
28 | + */ |
|
29 | + public function find_by( $class, array $params = array() ); |
|
30 | 30 | |
31 | - /** |
|
32 | - * Saves a new model of the provided class with the given data. |
|
33 | - * |
|
34 | - * @param string $class |
|
35 | - * @param array $data |
|
36 | - * @param array $options |
|
37 | - * |
|
38 | - * @return Model|WP_Error |
|
39 | - */ |
|
40 | - public function create( $class, array $data = array(), array $options = array() ); |
|
31 | + /** |
|
32 | + * Saves a new model of the provided class with the given data. |
|
33 | + * |
|
34 | + * @param string $class |
|
35 | + * @param array $data |
|
36 | + * @param array $options |
|
37 | + * |
|
38 | + * @return Model|WP_Error |
|
39 | + */ |
|
40 | + public function create( $class, array $data = array(), array $options = array() ); |
|
41 | 41 | |
42 | - /** |
|
43 | - * Updates a model with its latest data. |
|
44 | - * |
|
45 | - * @param Model $model |
|
46 | - * |
|
47 | - * @return Model|WP_Error |
|
48 | - */ |
|
49 | - public function persist( Model $model ); |
|
42 | + /** |
|
43 | + * Updates a model with its latest data. |
|
44 | + * |
|
45 | + * @param Model $model |
|
46 | + * |
|
47 | + * @return Model|WP_Error |
|
48 | + */ |
|
49 | + public function persist( Model $model ); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Delete the provided model from the database. |
|
53 | - * |
|
54 | - * @param Model $model |
|
55 | - * @param bool $force |
|
56 | - * |
|
57 | - * @return mixed |
|
58 | - */ |
|
59 | - public function delete( Model $model, $force = false ); |
|
51 | + /** |
|
52 | + * Delete the provided model from the database. |
|
53 | + * |
|
54 | + * @param Model $model |
|
55 | + * @param bool $force |
|
56 | + * |
|
57 | + * @return mixed |
|
58 | + */ |
|
59 | + public function delete( Model $model, $force = false ); |
|
60 | 60 | } |
@@ -22,734 +22,734 @@ |
||
22 | 22 | * @since 0.1.0 |
23 | 23 | */ |
24 | 24 | abstract class Model implements Serializes { |
25 | - /** |
|
26 | - * Table attribute key. |
|
27 | - */ |
|
28 | - const TABLE_KEY = '@@table'; |
|
29 | - |
|
30 | - /** |
|
31 | - * Object attribute key. |
|
32 | - */ |
|
33 | - const OBJECT_KEY = '@@object'; |
|
34 | - |
|
35 | - /** |
|
36 | - * Memoized values for class methods. |
|
37 | - * |
|
38 | - * @var array |
|
39 | - */ |
|
40 | - private static $memo = array(); |
|
41 | - |
|
42 | - /** |
|
43 | - * Model attributes. |
|
44 | - * |
|
45 | - * @var array |
|
46 | - */ |
|
47 | - private $attributes = array( |
|
48 | - self::TABLE_KEY => array(), |
|
49 | - self::OBJECT_KEY => null, |
|
50 | - ); |
|
51 | - |
|
52 | - /** |
|
53 | - * Model's original attributes. |
|
54 | - * |
|
55 | - * @var array |
|
56 | - */ |
|
57 | - private $original = array( |
|
58 | - self::TABLE_KEY => array(), |
|
59 | - self::OBJECT_KEY => null, |
|
60 | - ); |
|
61 | - |
|
62 | - /** |
|
63 | - * Default attribute values. |
|
64 | - * |
|
65 | - * @var array |
|
66 | - */ |
|
67 | - protected $defaults = array(); |
|
68 | - |
|
69 | - /** |
|
70 | - * Properties which are allowed to be set on the model. |
|
71 | - * |
|
72 | - * If this array is empty, any attributes can be set on the model. |
|
73 | - * |
|
74 | - * @var string[] |
|
75 | - */ |
|
76 | - protected $fillable = array(); |
|
77 | - |
|
78 | - /** |
|
79 | - * Properties which cannot be automatically filled on the model. |
|
80 | - * |
|
81 | - * If the model is unguarded, these properties can be filled. |
|
82 | - * |
|
83 | - * @var array |
|
84 | - */ |
|
85 | - protected $guarded = array(); |
|
86 | - |
|
87 | - /** |
|
88 | - * Properties which should not be serialized. |
|
89 | - * |
|
90 | - * @var array |
|
91 | - */ |
|
92 | - protected $hidden = array(); |
|
93 | - |
|
94 | - /** |
|
95 | - * Properties which should be serialized. |
|
96 | - * |
|
97 | - * @var array |
|
98 | - */ |
|
99 | - protected $visible = array(); |
|
100 | - |
|
101 | - /** |
|
102 | - * Whether the model's properties are guarded. |
|
103 | - * |
|
104 | - * When false, allows guarded properties to be filled. |
|
105 | - * |
|
106 | - * @var bool |
|
107 | - */ |
|
108 | - protected $is_guarded = true; |
|
109 | - |
|
110 | - /** |
|
111 | - * Constructs a new model with provided attributes. |
|
112 | - * |
|
113 | - * If self::OBJECT_KEY is passed as one of the attributes, the underlying post |
|
114 | - * will be overwritten. |
|
115 | - * |
|
116 | - * @param array <string, mixed> $attributes |
|
117 | - */ |
|
118 | - public function __construct( array $attributes = array() ) { |
|
119 | - $this->maybe_boot(); |
|
120 | - $this->sync_original(); |
|
121 | - |
|
122 | - if ( $this->uses_wp_object() ) { |
|
123 | - $this->create_wp_object(); |
|
124 | - } |
|
125 | - |
|
126 | - $this->unguard(); |
|
127 | - $this->refresh( $attributes ); |
|
128 | - $this->reguard(); |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * Refreshes the model's current attributes with the provided array. |
|
133 | - * |
|
134 | - * The model's attributes will match what was provided in the array, |
|
135 | - * and any attributes not passed |
|
136 | - * |
|
137 | - * @param array $attributes |
|
138 | - * |
|
139 | - * @return $this |
|
140 | - */ |
|
141 | - public function refresh( array $attributes ) { |
|
142 | - $this->clear(); |
|
143 | - |
|
144 | - return $this->merge( $attributes ); |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * Merges the provided attributes with the provided array. |
|
149 | - * |
|
150 | - * @param array $attributes |
|
151 | - * |
|
152 | - * @return $this |
|
153 | - */ |
|
154 | - public function merge( array $attributes ) { |
|
155 | - foreach ( $attributes as $name => $value ) { |
|
156 | - $this->set_attribute( $name, $value ); |
|
157 | - } |
|
158 | - |
|
159 | - return $this; |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Get the model's table attributes. |
|
164 | - * |
|
165 | - * Returns the array of for the model that will either need to be |
|
166 | - * saved in postmeta or a separate table. |
|
167 | - * |
|
168 | - * @return array |
|
169 | - */ |
|
170 | - public function get_table_attributes() { |
|
171 | - return $this->attributes[ self::TABLE_KEY ]; |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Get the model's original attributes. |
|
176 | - * |
|
177 | - * @return array |
|
178 | - */ |
|
179 | - public function get_original_table_attributes() { |
|
180 | - return $this->original[ self::TABLE_KEY ]; |
|
181 | - } |
|
182 | - |
|
183 | - /** |
|
184 | - * Retrieve an array of the attributes on the model |
|
185 | - * that have changed compared to the model's |
|
186 | - * original data. |
|
187 | - * |
|
188 | - * @return array |
|
189 | - */ |
|
190 | - public function get_changed_table_attributes() { |
|
191 | - $changed = array(); |
|
192 | - |
|
193 | - foreach ( $this->get_table_attributes() as $key => $value ) { |
|
194 | - if ( $value !== |
|
195 | - $this->get_original_attribute( $key ) |
|
196 | - ) { |
|
197 | - $changed[ $key ] = $value; |
|
198 | - } |
|
199 | - } |
|
200 | - |
|
201 | - return $changed; |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * Get the model's underlying post. |
|
206 | - * |
|
207 | - * Returns the underlying WP_Post object for the model, representing |
|
208 | - * the data that will be save in the wp_posts table. |
|
209 | - * |
|
210 | - * @return false|WP_Post|WP_Term |
|
211 | - */ |
|
212 | - public function get_underlying_wp_object() { |
|
213 | - if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) { |
|
214 | - return $this->attributes[ self::OBJECT_KEY ]; |
|
215 | - } |
|
216 | - |
|
217 | - return false; |
|
218 | - } |
|
219 | - |
|
220 | - /** |
|
221 | - * Get the model's original underlying post. |
|
222 | - * |
|
223 | - * @return WP_Post |
|
224 | - */ |
|
225 | - public function get_original_underlying_wp_object() { |
|
226 | - return $this->original[ self::OBJECT_KEY ]; |
|
227 | - } |
|
228 | - |
|
229 | - /** |
|
230 | - * Get the model attributes on the WordPress object |
|
231 | - * that have changed compared to the model's |
|
232 | - * original attributes. |
|
233 | - * |
|
234 | - * @return array |
|
235 | - */ |
|
236 | - public function get_changed_wp_object_attributes() { |
|
237 | - $changed = array(); |
|
238 | - |
|
239 | - foreach ( $this->get_wp_object_keys() as $key ) { |
|
240 | - if ( $this->get_attribute( $key ) !== |
|
241 | - $this->get_original_attribute( $key ) |
|
242 | - ) { |
|
243 | - $changed[ $key ] = $this->get_attribute( $key ); |
|
244 | - } |
|
245 | - } |
|
246 | - |
|
247 | - return $changed; |
|
248 | - } |
|
249 | - |
|
250 | - /** |
|
251 | - * Magic __set method. |
|
252 | - * |
|
253 | - * Passes the name and value to set_attribute, which is where the magic happens. |
|
254 | - * |
|
255 | - * @param string $name |
|
256 | - * @param mixed $value |
|
257 | - */ |
|
258 | - public function __set( $name, $value ) { |
|
259 | - $this->set_attribute( $name, $value ); |
|
260 | - } |
|
261 | - |
|
262 | - /** |
|
263 | - * Sets the model attributes. |
|
264 | - * |
|
265 | - * Checks whether the model attribute can be set, check if it |
|
266 | - * maps to the WP_Post property, otherwise, assigns it to the |
|
267 | - * table attribute array. |
|
268 | - * |
|
269 | - * @param string $name |
|
270 | - * @param mixed $value |
|
271 | - * |
|
272 | - * @return $this |
|
273 | - * |
|
274 | - * @throws GuardedPropertyException |
|
275 | - */ |
|
276 | - public function set_attribute( $name, $value ) { |
|
277 | - if ( self::OBJECT_KEY === $name ) { |
|
278 | - return $this->override_wp_object( $value ); |
|
279 | - } |
|
280 | - |
|
281 | - if ( self::TABLE_KEY === $name ) { |
|
282 | - return $this->override_table( $value ); |
|
283 | - } |
|
284 | - |
|
285 | - if ( ! $this->is_fillable( $name ) ) { |
|
286 | - throw new GuardedPropertyException; |
|
287 | - } |
|
288 | - |
|
289 | - if ( $method = $this->has_map_method( $name ) ) { |
|
290 | - $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value; |
|
291 | - } else { |
|
292 | - $this->attributes[ self::TABLE_KEY ][ $name ] = $value; |
|
293 | - } |
|
294 | - |
|
295 | - return $this; |
|
296 | - } |
|
297 | - |
|
298 | - /** |
|
299 | - * Retrieves all the attribute keys for the model. |
|
300 | - * |
|
301 | - * @return array |
|
302 | - */ |
|
303 | - public function get_attribute_keys() { |
|
304 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
305 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
306 | - } |
|
307 | - |
|
308 | - return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
309 | - = array_merge( |
|
310 | - $this->fillable, |
|
311 | - $this->guarded, |
|
312 | - $this->get_compute_methods() |
|
313 | - ); |
|
314 | - } |
|
315 | - |
|
316 | - /** |
|
317 | - * Retrieves the attribute keys that aren't mapped to a post. |
|
318 | - * |
|
319 | - * @return array |
|
320 | - */ |
|
321 | - public function get_table_keys() { |
|
322 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
323 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
324 | - } |
|
325 | - |
|
326 | - $keys = array(); |
|
327 | - |
|
328 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
329 | - if ( ! $this->has_map_method( $key ) && |
|
330 | - ! $this->has_compute_method( $key ) |
|
331 | - ) { |
|
332 | - $keys[] = $key; |
|
333 | - } |
|
334 | - } |
|
335 | - |
|
336 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
337 | - } |
|
338 | - |
|
339 | - /** |
|
340 | - * Retrieves the attribute keys that are mapped to a post. |
|
341 | - * |
|
342 | - * @return array |
|
343 | - */ |
|
344 | - public function get_wp_object_keys() { |
|
345 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
346 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
347 | - } |
|
348 | - |
|
349 | - $keys = array(); |
|
350 | - |
|
351 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
352 | - if ( $this->has_map_method( $key ) ) { |
|
353 | - $keys[] = $key; |
|
354 | - } |
|
355 | - } |
|
356 | - |
|
357 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
358 | - } |
|
359 | - |
|
360 | - /** |
|
361 | - * Returns the model's keys that are computed at call time. |
|
362 | - * |
|
363 | - * @return array |
|
364 | - */ |
|
365 | - public function get_computed_keys() { |
|
366 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
367 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
368 | - } |
|
369 | - |
|
370 | - $keys = array(); |
|
371 | - |
|
372 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
373 | - if ( $this->has_compute_method( $key ) ) { |
|
374 | - $keys[] = $key; |
|
375 | - } |
|
376 | - } |
|
377 | - |
|
378 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
379 | - } |
|
380 | - |
|
381 | - /** |
|
382 | - * Serializes the model's public data into an array. |
|
383 | - * |
|
384 | - * @return array |
|
385 | - */ |
|
386 | - public function serialize() { |
|
387 | - $attributes = array(); |
|
388 | - |
|
389 | - if ( $this->visible ) { |
|
390 | - // If visible attributes are set, we'll only reveal those. |
|
391 | - foreach ( $this->visible as $key ) { |
|
392 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
393 | - } |
|
394 | - } elseif ( $this->hidden ) { |
|
395 | - // If hidden attributes are set, we'll grab everything and hide those. |
|
396 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
397 | - if ( ! in_array( $key, $this->hidden ) ) { |
|
398 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
399 | - } |
|
400 | - } |
|
401 | - } else { |
|
402 | - // If nothing is hidden/visible, we'll grab and reveal everything. |
|
403 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
404 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
405 | - } |
|
406 | - } |
|
407 | - |
|
408 | - return array_map( function ( $attribute ) { |
|
409 | - if ( $attribute instanceof Serializes ) { |
|
410 | - return $attribute->serialize(); |
|
411 | - } |
|
412 | - |
|
413 | - return $attribute; |
|
414 | - }, $attributes ); |
|
415 | - } |
|
416 | - |
|
417 | - /** |
|
418 | - * Syncs the current attributes to the model's original. |
|
419 | - * |
|
420 | - * @return $this |
|
421 | - */ |
|
422 | - public function sync_original() { |
|
423 | - $this->original = $this->attributes; |
|
424 | - |
|
425 | - if ( $this->attributes[ self::OBJECT_KEY ] ) { |
|
426 | - $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ]; |
|
427 | - } |
|
428 | - |
|
429 | - foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) { |
|
430 | - if ( is_object( $item ) ) { |
|
431 | - $this->original[ $key ] = clone $item; |
|
432 | - } |
|
433 | - } |
|
434 | - |
|
435 | - return $this; |
|
436 | - } |
|
437 | - |
|
438 | - /** |
|
439 | - * Checks if a given attribute is mass-fillable. |
|
440 | - * |
|
441 | - * Returns true if the attribute can be filled, false if it can't. |
|
442 | - * |
|
443 | - * @param string $name |
|
444 | - * |
|
445 | - * @return bool |
|
446 | - */ |
|
447 | - private function is_fillable( $name ) { |
|
448 | - // If this model isn't guarded, everything is fillable. |
|
449 | - if ( ! $this->is_guarded ) { |
|
450 | - return true; |
|
451 | - } |
|
452 | - |
|
453 | - // If it's in the fillable array, then it's fillable. |
|
454 | - if ( in_array( $name, $this->fillable ) ) { |
|
455 | - return true; |
|
456 | - } |
|
457 | - |
|
458 | - // If it's explicitly guarded, then it's not fillable. |
|
459 | - if ( in_array( $name, $this->guarded ) ) { |
|
460 | - return false; |
|
461 | - } |
|
462 | - |
|
463 | - // If fillable hasn't been defined, then everything else fillable. |
|
464 | - return ! $this->fillable; |
|
465 | - } |
|
466 | - |
|
467 | - /** |
|
468 | - * Overrides the current WordPress object with a provided one. |
|
469 | - * |
|
470 | - * Resets the post's default values and stores it in the attributes. |
|
471 | - * |
|
472 | - * @param WP_Post|WP_Term|null $value |
|
473 | - * |
|
474 | - * @return $this |
|
475 | - */ |
|
476 | - private function override_wp_object( $value ) { |
|
477 | - if ( is_object( $value ) ) { |
|
478 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value ); |
|
479 | - } else { |
|
480 | - $this->attributes[ self::OBJECT_KEY ] = null; |
|
481 | - |
|
482 | - if ( $this->uses_wp_object() ) { |
|
483 | - $this->create_wp_object(); |
|
484 | - } |
|
485 | - } |
|
486 | - |
|
487 | - return $this; |
|
488 | - } |
|
489 | - |
|
490 | - /** |
|
491 | - * Overrides the current table attributes array with a provided one. |
|
492 | - * |
|
493 | - * @param array $value |
|
494 | - * |
|
495 | - * @return $this |
|
496 | - */ |
|
497 | - private function override_table( array $value ) { |
|
498 | - $this->attributes[ self::TABLE_KEY ] = $value; |
|
499 | - |
|
500 | - return $this; |
|
501 | - } |
|
502 | - |
|
503 | - /** |
|
504 | - * Create and set with a new blank post. |
|
505 | - * |
|
506 | - * Creates a new WP_Post object, assigns it the default attributes, |
|
507 | - * and stores it in the attributes. |
|
508 | - * |
|
509 | - * @throws LogicException |
|
510 | - */ |
|
511 | - private function create_wp_object() { |
|
512 | - switch ( true ) { |
|
513 | - case $this instanceof UsesWordPressPost: |
|
514 | - $object = new WP_Post( (object) array() ); |
|
515 | - break; |
|
516 | - case $this instanceof UsesWordPressTerm: |
|
517 | - $object = new WP_Term( (object) array() ); |
|
518 | - break; |
|
519 | - default: |
|
520 | - throw new LogicException; |
|
521 | - break; |
|
522 | - } |
|
523 | - |
|
524 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object ); |
|
525 | - } |
|
526 | - |
|
527 | - /** |
|
528 | - * Enforces values on the post that can't change. |
|
529 | - * |
|
530 | - * Primarily, this is used to make sure the post_type always maps |
|
531 | - * to the model's "$type" property, but this can all be overridden |
|
532 | - * by the developer to enforce other values in the model. |
|
533 | - * |
|
534 | - * @param object $object |
|
535 | - * |
|
536 | - * @return object |
|
537 | - */ |
|
538 | - protected function set_wp_object_constants( $object ) { |
|
539 | - if ( $this instanceof UsesWordPressPost ) { |
|
540 | - $object->post_type = static::get_post_type(); |
|
541 | - } |
|
542 | - |
|
543 | - if ( $this instanceof UsesWordPressTerm ) { |
|
544 | - $object->taxonomy = static::get_taxonomy(); |
|
545 | - } |
|
546 | - |
|
547 | - return $object; |
|
548 | - } |
|
549 | - |
|
550 | - /** |
|
551 | - * Magic __get method. |
|
552 | - * |
|
553 | - * Passes the name and value to get_attribute, which is where the magic happens. |
|
554 | - * |
|
555 | - * @param string $name |
|
556 | - * |
|
557 | - * @return mixed |
|
558 | - */ |
|
559 | - public function __get( $name ) { |
|
560 | - return $this->get_attribute( $name ); |
|
561 | - } |
|
562 | - |
|
563 | - /** |
|
564 | - * Retrieves the model attribute. |
|
565 | - * |
|
566 | - * @param string $name |
|
567 | - * |
|
568 | - * @return mixed |
|
569 | - * |
|
570 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
571 | - */ |
|
572 | - public function get_attribute( $name ) { |
|
573 | - if ( $method = $this->has_map_method( $name ) ) { |
|
574 | - return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()}; |
|
575 | - } |
|
576 | - |
|
577 | - if ( $method = $this->has_compute_method( $name ) ) { |
|
578 | - return $this->{$method}(); |
|
579 | - } |
|
580 | - |
|
581 | - if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) { |
|
582 | - return $this->attributes[ self::TABLE_KEY ][ $name ]; |
|
583 | - } |
|
584 | - |
|
585 | - if ( isset( $this->defaults[ $name ] ) ) { |
|
586 | - return $this->defaults[ $name ]; |
|
587 | - } |
|
588 | - |
|
589 | - return null; |
|
590 | - } |
|
591 | - |
|
592 | - /** |
|
593 | - * Retrieve the model's original attribute value. |
|
594 | - * |
|
595 | - * @param string $name |
|
596 | - * |
|
597 | - * @return mixed |
|
598 | - * |
|
599 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
600 | - */ |
|
601 | - public function get_original_attribute( $name ) { |
|
602 | - $original_attributes = $this->original; |
|
603 | - |
|
604 | - if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) { |
|
605 | - unset( $original_attributes[ static::OBJECT_KEY ] ); |
|
606 | - } |
|
607 | - |
|
608 | - $original = new static( $original_attributes ); |
|
609 | - |
|
610 | - return $original->get_attribute( $name ); |
|
611 | - } |
|
612 | - |
|
613 | - /** |
|
614 | - * Fetches the Model's primary ID, depending on the model |
|
615 | - * implementation. |
|
616 | - * |
|
617 | - * @return int |
|
618 | - * |
|
619 | - * @throws LogicException |
|
620 | - */ |
|
621 | - public function get_primary_id() { |
|
622 | - if ( $this instanceof UsesWordPressPost ) { |
|
623 | - return $this->get_underlying_wp_object()->ID; |
|
624 | - } |
|
625 | - |
|
626 | - if ( $this instanceof UsesWordPressTerm ) { |
|
627 | - return $this->get_underlying_wp_object()->term_id; |
|
628 | - } |
|
629 | - |
|
630 | - if ( $this instanceof UsesCustomTable ) { |
|
631 | - return $this->get_attribute( $this->get_primary_key() ); |
|
632 | - } |
|
633 | - |
|
634 | - // Model w/o wp_object not yet supported. |
|
635 | - throw new LogicException; |
|
636 | - } |
|
637 | - |
|
638 | - /** |
|
639 | - * Checks whether the attribute has a map method. |
|
640 | - * |
|
641 | - * This is used to determine whether the attribute maps to a |
|
642 | - * property on the underlying WP_Post object. Returns the |
|
643 | - * method if one exists, returns false if it doesn't. |
|
644 | - * |
|
645 | - * @param string $name |
|
646 | - * |
|
647 | - * @return false|string |
|
648 | - */ |
|
649 | - protected function has_map_method( $name ) { |
|
650 | - if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
651 | - return $method; |
|
652 | - } |
|
653 | - |
|
654 | - return false; |
|
655 | - } |
|
656 | - |
|
657 | - /** |
|
658 | - * Checks whether the attribute has a compute method. |
|
659 | - * |
|
660 | - * This is used to determine if the attribute should be computed |
|
661 | - * from other attributes. |
|
662 | - * |
|
663 | - * @param string $name |
|
664 | - * |
|
665 | - * @return false|string |
|
666 | - */ |
|
667 | - protected function has_compute_method( $name ) { |
|
668 | - if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
669 | - return $method; |
|
670 | - } |
|
671 | - |
|
672 | - return false; |
|
673 | - } |
|
674 | - |
|
675 | - /** |
|
676 | - * Clears all the current attributes from the model. |
|
677 | - * |
|
678 | - * This does not touch the model's original attributes, and will |
|
679 | - * only clear fillable attributes, unless the model is unguarded. |
|
680 | - * |
|
681 | - * @return $this |
|
682 | - */ |
|
683 | - public function clear() { |
|
684 | - $keys = array_merge( |
|
685 | - $this->get_table_keys(), |
|
686 | - $this->get_wp_object_keys() |
|
687 | - ); |
|
688 | - |
|
689 | - foreach ( $keys as $key ) { |
|
690 | - try { |
|
691 | - $this->set_attribute( $key, null ); |
|
692 | - } catch ( GuardedPropertyException $e ) { |
|
693 | - // We won't clear out guarded attributes. |
|
694 | - } |
|
695 | - } |
|
696 | - |
|
697 | - return $this; |
|
698 | - } |
|
699 | - |
|
700 | - /** |
|
701 | - * Unguards the model. |
|
702 | - * |
|
703 | - * Sets the model to be unguarded, allowing the filling of |
|
704 | - * guarded attributes. |
|
705 | - */ |
|
706 | - public function unguard() { |
|
707 | - $this->is_guarded = false; |
|
708 | - } |
|
709 | - |
|
710 | - /** |
|
711 | - * Reguards the model. |
|
712 | - * |
|
713 | - * Sets the model to be guarded, preventing filling of |
|
714 | - * guarded attributes. |
|
715 | - */ |
|
716 | - public function reguard() { |
|
717 | - $this->is_guarded = true; |
|
718 | - } |
|
719 | - |
|
720 | - /** |
|
721 | - * Retrieves all the compute methods on the model. |
|
722 | - * |
|
723 | - * @return array |
|
724 | - */ |
|
725 | - protected function get_compute_methods() { |
|
726 | - $methods = get_class_methods( get_called_class() ); |
|
727 | - $methods = array_filter( $methods, function ( $method ) { |
|
728 | - return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
729 | - } ); |
|
730 | - $methods = array_map( function ( $method ) { |
|
731 | - return substr( $method, strlen( 'compute_' ) ); |
|
732 | - }, $methods ); |
|
733 | - |
|
734 | - return $methods; |
|
735 | - } |
|
736 | - |
|
737 | - /** |
|
738 | - * Sets up the memo array for the creating model. |
|
739 | - */ |
|
740 | - private function maybe_boot() { |
|
741 | - if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
742 | - self::$memo[ get_called_class() ] = array(); |
|
743 | - } |
|
744 | - } |
|
745 | - |
|
746 | - /** |
|
747 | - * Whether this Model uses an underlying WordPress object. |
|
748 | - * |
|
749 | - * @return bool |
|
750 | - */ |
|
751 | - protected function uses_wp_object() { |
|
752 | - return $this instanceof UsesWordPressPost || |
|
753 | - $this instanceof UsesWordPressTerm; |
|
754 | - } |
|
25 | + /** |
|
26 | + * Table attribute key. |
|
27 | + */ |
|
28 | + const TABLE_KEY = '@@table'; |
|
29 | + |
|
30 | + /** |
|
31 | + * Object attribute key. |
|
32 | + */ |
|
33 | + const OBJECT_KEY = '@@object'; |
|
34 | + |
|
35 | + /** |
|
36 | + * Memoized values for class methods. |
|
37 | + * |
|
38 | + * @var array |
|
39 | + */ |
|
40 | + private static $memo = array(); |
|
41 | + |
|
42 | + /** |
|
43 | + * Model attributes. |
|
44 | + * |
|
45 | + * @var array |
|
46 | + */ |
|
47 | + private $attributes = array( |
|
48 | + self::TABLE_KEY => array(), |
|
49 | + self::OBJECT_KEY => null, |
|
50 | + ); |
|
51 | + |
|
52 | + /** |
|
53 | + * Model's original attributes. |
|
54 | + * |
|
55 | + * @var array |
|
56 | + */ |
|
57 | + private $original = array( |
|
58 | + self::TABLE_KEY => array(), |
|
59 | + self::OBJECT_KEY => null, |
|
60 | + ); |
|
61 | + |
|
62 | + /** |
|
63 | + * Default attribute values. |
|
64 | + * |
|
65 | + * @var array |
|
66 | + */ |
|
67 | + protected $defaults = array(); |
|
68 | + |
|
69 | + /** |
|
70 | + * Properties which are allowed to be set on the model. |
|
71 | + * |
|
72 | + * If this array is empty, any attributes can be set on the model. |
|
73 | + * |
|
74 | + * @var string[] |
|
75 | + */ |
|
76 | + protected $fillable = array(); |
|
77 | + |
|
78 | + /** |
|
79 | + * Properties which cannot be automatically filled on the model. |
|
80 | + * |
|
81 | + * If the model is unguarded, these properties can be filled. |
|
82 | + * |
|
83 | + * @var array |
|
84 | + */ |
|
85 | + protected $guarded = array(); |
|
86 | + |
|
87 | + /** |
|
88 | + * Properties which should not be serialized. |
|
89 | + * |
|
90 | + * @var array |
|
91 | + */ |
|
92 | + protected $hidden = array(); |
|
93 | + |
|
94 | + /** |
|
95 | + * Properties which should be serialized. |
|
96 | + * |
|
97 | + * @var array |
|
98 | + */ |
|
99 | + protected $visible = array(); |
|
100 | + |
|
101 | + /** |
|
102 | + * Whether the model's properties are guarded. |
|
103 | + * |
|
104 | + * When false, allows guarded properties to be filled. |
|
105 | + * |
|
106 | + * @var bool |
|
107 | + */ |
|
108 | + protected $is_guarded = true; |
|
109 | + |
|
110 | + /** |
|
111 | + * Constructs a new model with provided attributes. |
|
112 | + * |
|
113 | + * If self::OBJECT_KEY is passed as one of the attributes, the underlying post |
|
114 | + * will be overwritten. |
|
115 | + * |
|
116 | + * @param array <string, mixed> $attributes |
|
117 | + */ |
|
118 | + public function __construct( array $attributes = array() ) { |
|
119 | + $this->maybe_boot(); |
|
120 | + $this->sync_original(); |
|
121 | + |
|
122 | + if ( $this->uses_wp_object() ) { |
|
123 | + $this->create_wp_object(); |
|
124 | + } |
|
125 | + |
|
126 | + $this->unguard(); |
|
127 | + $this->refresh( $attributes ); |
|
128 | + $this->reguard(); |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * Refreshes the model's current attributes with the provided array. |
|
133 | + * |
|
134 | + * The model's attributes will match what was provided in the array, |
|
135 | + * and any attributes not passed |
|
136 | + * |
|
137 | + * @param array $attributes |
|
138 | + * |
|
139 | + * @return $this |
|
140 | + */ |
|
141 | + public function refresh( array $attributes ) { |
|
142 | + $this->clear(); |
|
143 | + |
|
144 | + return $this->merge( $attributes ); |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * Merges the provided attributes with the provided array. |
|
149 | + * |
|
150 | + * @param array $attributes |
|
151 | + * |
|
152 | + * @return $this |
|
153 | + */ |
|
154 | + public function merge( array $attributes ) { |
|
155 | + foreach ( $attributes as $name => $value ) { |
|
156 | + $this->set_attribute( $name, $value ); |
|
157 | + } |
|
158 | + |
|
159 | + return $this; |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Get the model's table attributes. |
|
164 | + * |
|
165 | + * Returns the array of for the model that will either need to be |
|
166 | + * saved in postmeta or a separate table. |
|
167 | + * |
|
168 | + * @return array |
|
169 | + */ |
|
170 | + public function get_table_attributes() { |
|
171 | + return $this->attributes[ self::TABLE_KEY ]; |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Get the model's original attributes. |
|
176 | + * |
|
177 | + * @return array |
|
178 | + */ |
|
179 | + public function get_original_table_attributes() { |
|
180 | + return $this->original[ self::TABLE_KEY ]; |
|
181 | + } |
|
182 | + |
|
183 | + /** |
|
184 | + * Retrieve an array of the attributes on the model |
|
185 | + * that have changed compared to the model's |
|
186 | + * original data. |
|
187 | + * |
|
188 | + * @return array |
|
189 | + */ |
|
190 | + public function get_changed_table_attributes() { |
|
191 | + $changed = array(); |
|
192 | + |
|
193 | + foreach ( $this->get_table_attributes() as $key => $value ) { |
|
194 | + if ( $value !== |
|
195 | + $this->get_original_attribute( $key ) |
|
196 | + ) { |
|
197 | + $changed[ $key ] = $value; |
|
198 | + } |
|
199 | + } |
|
200 | + |
|
201 | + return $changed; |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * Get the model's underlying post. |
|
206 | + * |
|
207 | + * Returns the underlying WP_Post object for the model, representing |
|
208 | + * the data that will be save in the wp_posts table. |
|
209 | + * |
|
210 | + * @return false|WP_Post|WP_Term |
|
211 | + */ |
|
212 | + public function get_underlying_wp_object() { |
|
213 | + if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) { |
|
214 | + return $this->attributes[ self::OBJECT_KEY ]; |
|
215 | + } |
|
216 | + |
|
217 | + return false; |
|
218 | + } |
|
219 | + |
|
220 | + /** |
|
221 | + * Get the model's original underlying post. |
|
222 | + * |
|
223 | + * @return WP_Post |
|
224 | + */ |
|
225 | + public function get_original_underlying_wp_object() { |
|
226 | + return $this->original[ self::OBJECT_KEY ]; |
|
227 | + } |
|
228 | + |
|
229 | + /** |
|
230 | + * Get the model attributes on the WordPress object |
|
231 | + * that have changed compared to the model's |
|
232 | + * original attributes. |
|
233 | + * |
|
234 | + * @return array |
|
235 | + */ |
|
236 | + public function get_changed_wp_object_attributes() { |
|
237 | + $changed = array(); |
|
238 | + |
|
239 | + foreach ( $this->get_wp_object_keys() as $key ) { |
|
240 | + if ( $this->get_attribute( $key ) !== |
|
241 | + $this->get_original_attribute( $key ) |
|
242 | + ) { |
|
243 | + $changed[ $key ] = $this->get_attribute( $key ); |
|
244 | + } |
|
245 | + } |
|
246 | + |
|
247 | + return $changed; |
|
248 | + } |
|
249 | + |
|
250 | + /** |
|
251 | + * Magic __set method. |
|
252 | + * |
|
253 | + * Passes the name and value to set_attribute, which is where the magic happens. |
|
254 | + * |
|
255 | + * @param string $name |
|
256 | + * @param mixed $value |
|
257 | + */ |
|
258 | + public function __set( $name, $value ) { |
|
259 | + $this->set_attribute( $name, $value ); |
|
260 | + } |
|
261 | + |
|
262 | + /** |
|
263 | + * Sets the model attributes. |
|
264 | + * |
|
265 | + * Checks whether the model attribute can be set, check if it |
|
266 | + * maps to the WP_Post property, otherwise, assigns it to the |
|
267 | + * table attribute array. |
|
268 | + * |
|
269 | + * @param string $name |
|
270 | + * @param mixed $value |
|
271 | + * |
|
272 | + * @return $this |
|
273 | + * |
|
274 | + * @throws GuardedPropertyException |
|
275 | + */ |
|
276 | + public function set_attribute( $name, $value ) { |
|
277 | + if ( self::OBJECT_KEY === $name ) { |
|
278 | + return $this->override_wp_object( $value ); |
|
279 | + } |
|
280 | + |
|
281 | + if ( self::TABLE_KEY === $name ) { |
|
282 | + return $this->override_table( $value ); |
|
283 | + } |
|
284 | + |
|
285 | + if ( ! $this->is_fillable( $name ) ) { |
|
286 | + throw new GuardedPropertyException; |
|
287 | + } |
|
288 | + |
|
289 | + if ( $method = $this->has_map_method( $name ) ) { |
|
290 | + $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value; |
|
291 | + } else { |
|
292 | + $this->attributes[ self::TABLE_KEY ][ $name ] = $value; |
|
293 | + } |
|
294 | + |
|
295 | + return $this; |
|
296 | + } |
|
297 | + |
|
298 | + /** |
|
299 | + * Retrieves all the attribute keys for the model. |
|
300 | + * |
|
301 | + * @return array |
|
302 | + */ |
|
303 | + public function get_attribute_keys() { |
|
304 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
305 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
306 | + } |
|
307 | + |
|
308 | + return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
309 | + = array_merge( |
|
310 | + $this->fillable, |
|
311 | + $this->guarded, |
|
312 | + $this->get_compute_methods() |
|
313 | + ); |
|
314 | + } |
|
315 | + |
|
316 | + /** |
|
317 | + * Retrieves the attribute keys that aren't mapped to a post. |
|
318 | + * |
|
319 | + * @return array |
|
320 | + */ |
|
321 | + public function get_table_keys() { |
|
322 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
323 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
324 | + } |
|
325 | + |
|
326 | + $keys = array(); |
|
327 | + |
|
328 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
329 | + if ( ! $this->has_map_method( $key ) && |
|
330 | + ! $this->has_compute_method( $key ) |
|
331 | + ) { |
|
332 | + $keys[] = $key; |
|
333 | + } |
|
334 | + } |
|
335 | + |
|
336 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
337 | + } |
|
338 | + |
|
339 | + /** |
|
340 | + * Retrieves the attribute keys that are mapped to a post. |
|
341 | + * |
|
342 | + * @return array |
|
343 | + */ |
|
344 | + public function get_wp_object_keys() { |
|
345 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
346 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
347 | + } |
|
348 | + |
|
349 | + $keys = array(); |
|
350 | + |
|
351 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
352 | + if ( $this->has_map_method( $key ) ) { |
|
353 | + $keys[] = $key; |
|
354 | + } |
|
355 | + } |
|
356 | + |
|
357 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
358 | + } |
|
359 | + |
|
360 | + /** |
|
361 | + * Returns the model's keys that are computed at call time. |
|
362 | + * |
|
363 | + * @return array |
|
364 | + */ |
|
365 | + public function get_computed_keys() { |
|
366 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
367 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
368 | + } |
|
369 | + |
|
370 | + $keys = array(); |
|
371 | + |
|
372 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
373 | + if ( $this->has_compute_method( $key ) ) { |
|
374 | + $keys[] = $key; |
|
375 | + } |
|
376 | + } |
|
377 | + |
|
378 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
379 | + } |
|
380 | + |
|
381 | + /** |
|
382 | + * Serializes the model's public data into an array. |
|
383 | + * |
|
384 | + * @return array |
|
385 | + */ |
|
386 | + public function serialize() { |
|
387 | + $attributes = array(); |
|
388 | + |
|
389 | + if ( $this->visible ) { |
|
390 | + // If visible attributes are set, we'll only reveal those. |
|
391 | + foreach ( $this->visible as $key ) { |
|
392 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
393 | + } |
|
394 | + } elseif ( $this->hidden ) { |
|
395 | + // If hidden attributes are set, we'll grab everything and hide those. |
|
396 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
397 | + if ( ! in_array( $key, $this->hidden ) ) { |
|
398 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
399 | + } |
|
400 | + } |
|
401 | + } else { |
|
402 | + // If nothing is hidden/visible, we'll grab and reveal everything. |
|
403 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
404 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
405 | + } |
|
406 | + } |
|
407 | + |
|
408 | + return array_map( function ( $attribute ) { |
|
409 | + if ( $attribute instanceof Serializes ) { |
|
410 | + return $attribute->serialize(); |
|
411 | + } |
|
412 | + |
|
413 | + return $attribute; |
|
414 | + }, $attributes ); |
|
415 | + } |
|
416 | + |
|
417 | + /** |
|
418 | + * Syncs the current attributes to the model's original. |
|
419 | + * |
|
420 | + * @return $this |
|
421 | + */ |
|
422 | + public function sync_original() { |
|
423 | + $this->original = $this->attributes; |
|
424 | + |
|
425 | + if ( $this->attributes[ self::OBJECT_KEY ] ) { |
|
426 | + $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ]; |
|
427 | + } |
|
428 | + |
|
429 | + foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) { |
|
430 | + if ( is_object( $item ) ) { |
|
431 | + $this->original[ $key ] = clone $item; |
|
432 | + } |
|
433 | + } |
|
434 | + |
|
435 | + return $this; |
|
436 | + } |
|
437 | + |
|
438 | + /** |
|
439 | + * Checks if a given attribute is mass-fillable. |
|
440 | + * |
|
441 | + * Returns true if the attribute can be filled, false if it can't. |
|
442 | + * |
|
443 | + * @param string $name |
|
444 | + * |
|
445 | + * @return bool |
|
446 | + */ |
|
447 | + private function is_fillable( $name ) { |
|
448 | + // If this model isn't guarded, everything is fillable. |
|
449 | + if ( ! $this->is_guarded ) { |
|
450 | + return true; |
|
451 | + } |
|
452 | + |
|
453 | + // If it's in the fillable array, then it's fillable. |
|
454 | + if ( in_array( $name, $this->fillable ) ) { |
|
455 | + return true; |
|
456 | + } |
|
457 | + |
|
458 | + // If it's explicitly guarded, then it's not fillable. |
|
459 | + if ( in_array( $name, $this->guarded ) ) { |
|
460 | + return false; |
|
461 | + } |
|
462 | + |
|
463 | + // If fillable hasn't been defined, then everything else fillable. |
|
464 | + return ! $this->fillable; |
|
465 | + } |
|
466 | + |
|
467 | + /** |
|
468 | + * Overrides the current WordPress object with a provided one. |
|
469 | + * |
|
470 | + * Resets the post's default values and stores it in the attributes. |
|
471 | + * |
|
472 | + * @param WP_Post|WP_Term|null $value |
|
473 | + * |
|
474 | + * @return $this |
|
475 | + */ |
|
476 | + private function override_wp_object( $value ) { |
|
477 | + if ( is_object( $value ) ) { |
|
478 | + $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value ); |
|
479 | + } else { |
|
480 | + $this->attributes[ self::OBJECT_KEY ] = null; |
|
481 | + |
|
482 | + if ( $this->uses_wp_object() ) { |
|
483 | + $this->create_wp_object(); |
|
484 | + } |
|
485 | + } |
|
486 | + |
|
487 | + return $this; |
|
488 | + } |
|
489 | + |
|
490 | + /** |
|
491 | + * Overrides the current table attributes array with a provided one. |
|
492 | + * |
|
493 | + * @param array $value |
|
494 | + * |
|
495 | + * @return $this |
|
496 | + */ |
|
497 | + private function override_table( array $value ) { |
|
498 | + $this->attributes[ self::TABLE_KEY ] = $value; |
|
499 | + |
|
500 | + return $this; |
|
501 | + } |
|
502 | + |
|
503 | + /** |
|
504 | + * Create and set with a new blank post. |
|
505 | + * |
|
506 | + * Creates a new WP_Post object, assigns it the default attributes, |
|
507 | + * and stores it in the attributes. |
|
508 | + * |
|
509 | + * @throws LogicException |
|
510 | + */ |
|
511 | + private function create_wp_object() { |
|
512 | + switch ( true ) { |
|
513 | + case $this instanceof UsesWordPressPost: |
|
514 | + $object = new WP_Post( (object) array() ); |
|
515 | + break; |
|
516 | + case $this instanceof UsesWordPressTerm: |
|
517 | + $object = new WP_Term( (object) array() ); |
|
518 | + break; |
|
519 | + default: |
|
520 | + throw new LogicException; |
|
521 | + break; |
|
522 | + } |
|
523 | + |
|
524 | + $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object ); |
|
525 | + } |
|
526 | + |
|
527 | + /** |
|
528 | + * Enforces values on the post that can't change. |
|
529 | + * |
|
530 | + * Primarily, this is used to make sure the post_type always maps |
|
531 | + * to the model's "$type" property, but this can all be overridden |
|
532 | + * by the developer to enforce other values in the model. |
|
533 | + * |
|
534 | + * @param object $object |
|
535 | + * |
|
536 | + * @return object |
|
537 | + */ |
|
538 | + protected function set_wp_object_constants( $object ) { |
|
539 | + if ( $this instanceof UsesWordPressPost ) { |
|
540 | + $object->post_type = static::get_post_type(); |
|
541 | + } |
|
542 | + |
|
543 | + if ( $this instanceof UsesWordPressTerm ) { |
|
544 | + $object->taxonomy = static::get_taxonomy(); |
|
545 | + } |
|
546 | + |
|
547 | + return $object; |
|
548 | + } |
|
549 | + |
|
550 | + /** |
|
551 | + * Magic __get method. |
|
552 | + * |
|
553 | + * Passes the name and value to get_attribute, which is where the magic happens. |
|
554 | + * |
|
555 | + * @param string $name |
|
556 | + * |
|
557 | + * @return mixed |
|
558 | + */ |
|
559 | + public function __get( $name ) { |
|
560 | + return $this->get_attribute( $name ); |
|
561 | + } |
|
562 | + |
|
563 | + /** |
|
564 | + * Retrieves the model attribute. |
|
565 | + * |
|
566 | + * @param string $name |
|
567 | + * |
|
568 | + * @return mixed |
|
569 | + * |
|
570 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
571 | + */ |
|
572 | + public function get_attribute( $name ) { |
|
573 | + if ( $method = $this->has_map_method( $name ) ) { |
|
574 | + return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()}; |
|
575 | + } |
|
576 | + |
|
577 | + if ( $method = $this->has_compute_method( $name ) ) { |
|
578 | + return $this->{$method}(); |
|
579 | + } |
|
580 | + |
|
581 | + if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) { |
|
582 | + return $this->attributes[ self::TABLE_KEY ][ $name ]; |
|
583 | + } |
|
584 | + |
|
585 | + if ( isset( $this->defaults[ $name ] ) ) { |
|
586 | + return $this->defaults[ $name ]; |
|
587 | + } |
|
588 | + |
|
589 | + return null; |
|
590 | + } |
|
591 | + |
|
592 | + /** |
|
593 | + * Retrieve the model's original attribute value. |
|
594 | + * |
|
595 | + * @param string $name |
|
596 | + * |
|
597 | + * @return mixed |
|
598 | + * |
|
599 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
600 | + */ |
|
601 | + public function get_original_attribute( $name ) { |
|
602 | + $original_attributes = $this->original; |
|
603 | + |
|
604 | + if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) { |
|
605 | + unset( $original_attributes[ static::OBJECT_KEY ] ); |
|
606 | + } |
|
607 | + |
|
608 | + $original = new static( $original_attributes ); |
|
609 | + |
|
610 | + return $original->get_attribute( $name ); |
|
611 | + } |
|
612 | + |
|
613 | + /** |
|
614 | + * Fetches the Model's primary ID, depending on the model |
|
615 | + * implementation. |
|
616 | + * |
|
617 | + * @return int |
|
618 | + * |
|
619 | + * @throws LogicException |
|
620 | + */ |
|
621 | + public function get_primary_id() { |
|
622 | + if ( $this instanceof UsesWordPressPost ) { |
|
623 | + return $this->get_underlying_wp_object()->ID; |
|
624 | + } |
|
625 | + |
|
626 | + if ( $this instanceof UsesWordPressTerm ) { |
|
627 | + return $this->get_underlying_wp_object()->term_id; |
|
628 | + } |
|
629 | + |
|
630 | + if ( $this instanceof UsesCustomTable ) { |
|
631 | + return $this->get_attribute( $this->get_primary_key() ); |
|
632 | + } |
|
633 | + |
|
634 | + // Model w/o wp_object not yet supported. |
|
635 | + throw new LogicException; |
|
636 | + } |
|
637 | + |
|
638 | + /** |
|
639 | + * Checks whether the attribute has a map method. |
|
640 | + * |
|
641 | + * This is used to determine whether the attribute maps to a |
|
642 | + * property on the underlying WP_Post object. Returns the |
|
643 | + * method if one exists, returns false if it doesn't. |
|
644 | + * |
|
645 | + * @param string $name |
|
646 | + * |
|
647 | + * @return false|string |
|
648 | + */ |
|
649 | + protected function has_map_method( $name ) { |
|
650 | + if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
651 | + return $method; |
|
652 | + } |
|
653 | + |
|
654 | + return false; |
|
655 | + } |
|
656 | + |
|
657 | + /** |
|
658 | + * Checks whether the attribute has a compute method. |
|
659 | + * |
|
660 | + * This is used to determine if the attribute should be computed |
|
661 | + * from other attributes. |
|
662 | + * |
|
663 | + * @param string $name |
|
664 | + * |
|
665 | + * @return false|string |
|
666 | + */ |
|
667 | + protected function has_compute_method( $name ) { |
|
668 | + if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
669 | + return $method; |
|
670 | + } |
|
671 | + |
|
672 | + return false; |
|
673 | + } |
|
674 | + |
|
675 | + /** |
|
676 | + * Clears all the current attributes from the model. |
|
677 | + * |
|
678 | + * This does not touch the model's original attributes, and will |
|
679 | + * only clear fillable attributes, unless the model is unguarded. |
|
680 | + * |
|
681 | + * @return $this |
|
682 | + */ |
|
683 | + public function clear() { |
|
684 | + $keys = array_merge( |
|
685 | + $this->get_table_keys(), |
|
686 | + $this->get_wp_object_keys() |
|
687 | + ); |
|
688 | + |
|
689 | + foreach ( $keys as $key ) { |
|
690 | + try { |
|
691 | + $this->set_attribute( $key, null ); |
|
692 | + } catch ( GuardedPropertyException $e ) { |
|
693 | + // We won't clear out guarded attributes. |
|
694 | + } |
|
695 | + } |
|
696 | + |
|
697 | + return $this; |
|
698 | + } |
|
699 | + |
|
700 | + /** |
|
701 | + * Unguards the model. |
|
702 | + * |
|
703 | + * Sets the model to be unguarded, allowing the filling of |
|
704 | + * guarded attributes. |
|
705 | + */ |
|
706 | + public function unguard() { |
|
707 | + $this->is_guarded = false; |
|
708 | + } |
|
709 | + |
|
710 | + /** |
|
711 | + * Reguards the model. |
|
712 | + * |
|
713 | + * Sets the model to be guarded, preventing filling of |
|
714 | + * guarded attributes. |
|
715 | + */ |
|
716 | + public function reguard() { |
|
717 | + $this->is_guarded = true; |
|
718 | + } |
|
719 | + |
|
720 | + /** |
|
721 | + * Retrieves all the compute methods on the model. |
|
722 | + * |
|
723 | + * @return array |
|
724 | + */ |
|
725 | + protected function get_compute_methods() { |
|
726 | + $methods = get_class_methods( get_called_class() ); |
|
727 | + $methods = array_filter( $methods, function ( $method ) { |
|
728 | + return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
729 | + } ); |
|
730 | + $methods = array_map( function ( $method ) { |
|
731 | + return substr( $method, strlen( 'compute_' ) ); |
|
732 | + }, $methods ); |
|
733 | + |
|
734 | + return $methods; |
|
735 | + } |
|
736 | + |
|
737 | + /** |
|
738 | + * Sets up the memo array for the creating model. |
|
739 | + */ |
|
740 | + private function maybe_boot() { |
|
741 | + if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
742 | + self::$memo[ get_called_class() ] = array(); |
|
743 | + } |
|
744 | + } |
|
745 | + |
|
746 | + /** |
|
747 | + * Whether this Model uses an underlying WordPress object. |
|
748 | + * |
|
749 | + * @return bool |
|
750 | + */ |
|
751 | + protected function uses_wp_object() { |
|
752 | + return $this instanceof UsesWordPressPost || |
|
753 | + $this instanceof UsesWordPressTerm; |
|
754 | + } |
|
755 | 755 | } |