Namespaces

Classes

Traits

1: <?php declare(strict_types=1);
2:
3: namespace Salient\Iterator;
4:
5: use IteratorIterator;
6: use RecursiveCallbackFilterIterator;
7: use RecursiveIterator;
8:
9: /**
10: * Iterates over a recursive iterator, using a callback to determine which
11: * elements to descend into
12: *
13: * Similar to {@see RecursiveCallbackFilterIterator}, but the callback is only
14: * used to filter the return value of {@see RecursiveIterator::hasChildren()}.
15: * This allows elements to be treated as leaf nodes even if they have children.
16: *
17: * @api
18: *
19: * @template TKey
20: * @template TValue
21: * @template TIterator of RecursiveIterator<TKey,TValue>
22: *
23: * @extends IteratorIterator<TKey,TValue,TIterator>
24: * @implements RecursiveIterator<TKey,TValue>
25: */
26: class RecursiveCallbackIterator extends IteratorIterator implements RecursiveIterator
27: {
28: /** @var TIterator */
29: private RecursiveIterator $Iterator;
30: /** @var callable(TValue, TKey, TIterator): bool */
31: private $Callback;
32:
33: /**
34: * @api
35: *
36: * @param TIterator $iterator
37: * @param callable(TValue, TKey, TIterator): bool $callback
38: */
39: final public function __construct(RecursiveIterator $iterator, callable $callback)
40: {
41: $this->Iterator = $iterator;
42: $this->Callback = $callback;
43: parent::__construct($iterator);
44: }
45:
46: /**
47: * @inheritDoc
48: */
49: public function hasChildren(): bool
50: {
51: return $this->Iterator->hasChildren()
52: && ($this->Callback)(
53: $this->Iterator->current(),
54: $this->Iterator->key(),
55: $this->Iterator,
56: );
57: }
58:
59: /**
60: * @return static<TKey,TValue,TIterator>|null
61: */
62: public function getChildren(): ?self
63: {
64: /** @var TIterator|null */
65: $children = $this->Iterator->getChildren();
66: return $children === null
67: ? null
68: : new static($children, $this->Callback);
69: }
70: }
71:
salient/toolkit API documentation generated by ApiGen v7.0.0-alpha.6