NoChildrenIterator.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 3.0.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Collection\Iterator;
  16. use Cake\Collection\Collection;
  17. use RecursiveIterator;
  18. /**
  19. * An iterator that can be used as an argument for other iterators that require
  20. * a RecursiveIterator but do not want children. This iterator will
  21. * always behave as having no nested items.
  22. */
  23. class NoChildrenIterator extends Collection implements RecursiveIterator
  24. {
  25. /**
  26. * Returns false as there are no children iterators in this collection
  27. *
  28. * @return bool
  29. */
  30. public function hasChildren()
  31. {
  32. return false;
  33. }
  34. /**
  35. * Returns null as there are no children for this iteration level
  36. *
  37. * @return null
  38. */
  39. public function getChildren()
  40. {
  41. return null;
  42. }
  43. }