ResourceIteratorAggregate::getIterator() - Code Metrics - loophp/iterators - Measure and Improve Code Quality continuously with Scrutinizer

ResourceIteratorAggregate::getIterator() A
last analyzed 2023-05-08 20:37 UTC

↳ Parent: ResourceIteratorAggregate

Complexity

Conditions	3
Paths	8

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	8
c	1
b	0
f	0
nc	8
nop	0
dl	0
loc	12
ccs	7
cts	7
cp	1
crap	3
rs	10

<?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);
            }
        }
    }
}


1		<?php
2
3		/**
4		* For the full copyright and license information, please view
5		* the LICENSE file that was distributed with this source code.
6		*/
7
8		declare(strict_types=1);
9
10		namespace loophp\iterators;
11
12		use Generator;
13		use InvalidArgumentException;
14		use IteratorAggregate;
15
16		use function is_resource;
17
18		/**
19		* @implements IteratorAggregate<int, string>
20		*/
21		final class ResourceIteratorAggregate implements IteratorAggregate
22		{
23		/**
24		* @var resource
25		*/
26		private $resource;
27
28		/**
29		* @param false\|resource $resource
30		*/
31	5	public function __construct($resource, private bool $closeResource = false)
32		{
33	5	if (!is_resource($resource) \|\| 'stream' !== get_resource_type($resource)) {
34	2	throw new InvalidArgumentException('Invalid resource type.');
35		}
36
37	3	$this->resource = $resource;
38		}
39
40		/**
41		* @return Generator<int, string>
42		*/
43	3	public function getIterator(): Generator
44		{
45	3	$resource = $this->resource;
46	3	$closeResource = $this->closeResource;
47
48		try {
49	3	while (false !== $chunk = fgetc($resource)) {
50	3	yield $chunk;
51		}
52		} finally {
53	3	if ($closeResource) {
54	1	fclose($resource);
55		}
56		}
57		}
58		}
59

loophp / iterators

ResourceIteratorAggregate::getIterator() A last analyzed 2023-05-08 20:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ResourceIteratorAggregate::getIterator() A
last analyzed 2023-05-08 20:37 UTC