loophp\iterators\ResourceIteratorAggregate

Complexity

Total Complexity

6

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	3
A	getIterator()	0	12	3

<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace loophp\iterators;

use Generator;
use InvalidArgumentException;
use IteratorAggregate;

use function is_resource;

/**
 * @implements IteratorAggregate<int, string>
 */
final class ResourceIteratorAggregate implements IteratorAggregate
{
    /**
     * @var resource
     */
    private $resource;

    /**
     * @param false|resource $resource
     */
    public function __construct($resource, private bool $closeResource = false)
    {
        if (!is_resource($resource) || 'stream' !== get_resource_type($resource)) {
            throw new InvalidArgumentException('Invalid resource type.');
        }

        $this->resource = $resource;
    }

    /**
     * @return Generator<int, string>
     */
    public function getIterator(): Generator
    {
        $resource = $this->resource;
        $closeResource = $this->closeResource;

        try {
            while (false !== $chunk = fgetc($resource)) {
                yield $chunk;
            }
        } finally {
            if ($closeResource) {
                fclose($resource);
            }
        }
    }
}