-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
NoChildrenIterator.php
50 lines (46 loc) · 1.43 KB
/
NoChildrenIterator.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Collection\Iterator;
use Cake\Collection\Collection;
use RecursiveIterator;
/**
* An iterator that can be used as an argument for other iterators that require
* a RecursiveIterator but do not want children. This iterator will
* always behave as having no nested items.
*
* @template-implements \RecursiveIterator<mixed, mixed>
*/
class NoChildrenIterator extends Collection implements RecursiveIterator
{
/**
* Returns false as there are no children iterators in this collection
*
* @return bool
*/
public function hasChildren(): bool
{
return false;
}
/**
* Returns a self instance without any elements.
*
* @return \RecursiveIterator<mixed, mixed>
*/
public function getChildren(): RecursiveIterator
{
return new static([]);
}
}