| 1: | <?php |
| 2: | |
| 3: | declare(strict_types=1); |
| 4: | |
| 5: | /** |
| 6: | * This file is part of the Nexus framework. |
| 7: | * |
| 8: | * (c) John Paul E. Balandan, CPA <paulbalandan@gmail.com> |
| 9: | * |
| 10: | * For the full copyright and license information, please view |
| 11: | * the LICENSE file that was distributed with this source code. |
| 12: | */ |
| 13: | |
| 14: | namespace Nexus\Collection\Operation; |
| 15: | |
| 16: | use Nexus\Collection\CollectionInterface; |
| 17: | |
| 18: | /** |
| 19: | * @template TKey |
| 20: | * @template T |
| 21: | */ |
| 22: | interface Cycle |
| 23: | { |
| 24: | /** |
| 25: | * Cycle indefinitely over a collection of items. |
| 26: | * |
| 27: | * **NOTE:** Be careful when using `all()` after calling `cycle()` as this |
| 28: | * will exhaust all available memory trying to convert an infinite |
| 29: | * collection. Make sure to call `limit()` after `cycle()` before |
| 30: | * outputting the items. |
| 31: | * |
| 32: | * @return CollectionInterface<TKey, T> |
| 33: | */ |
| 34: | public function cycle(): CollectionInterface; |
| 35: | } |
| 36: |