bentools/rewindable-generator

Now your generators become rewindable.

Maintainers

Details

github.com/bpolaszek/rewindable-generator

Source

Issues

Installs: 201

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 3

Forks: 1

Open Issues: 0

1.2 2023-12-23 15:48 UTC

Requires

  • php: >=8.1

Requires (Dev)

MIT 3844b60c26d1273b4a97af483ccd6bfd4f2a1865

generatoriteratorgeneratorsrewindable

This package is auto-updated.

Last update: 2024-11-23 17:37:21 UTC

README

Latest Stable Version License CI Workflow Coverage Total Downloads

Rewindable generator

$generator = (function () {
    yield 'foo';
    yield 'bar';
})();

var_dump(iterator_to_array($generator)); // ['foo', 'bar']
var_dump(iterator_to_array($generator)); // Boom

PHP Fatal error: Uncaught Exception: Cannot traverse an already closed generator

Yes, I know. That's annoying. But here's a tiny class which will leverage a CachingIterator to make your generator rewindable.

Simple as:

use BenTools\RewindableGenerator;

$generator = (function () {
    yield 'foo';
    yield 'bar';
})();

$iterator = new RewindableGenerator($generator);

var_dump(iterator_to_array($iterator)); // ['foo', 'bar']
var_dump(iterator_to_array($iterator)); // ['foo', 'bar']

Warning: An exception will be thrown if you intend to rewind a generator which has not reached the end (i.e you breakthe loop), since the CachingIterator won't have all items in cache.

Installation

composer require bentools/rewindable-generator

Tests

./vendor/bin/phpunit