ConcatStream::rewind() - Code Metrics - b2pweb/bdf-collections - Measure and Improve Code Quality continuously with Scrutinizer

ConcatStream::rewind() A
last analyzed 2023-01-04 13:50 UTC

↳ Parent: ConcatStream

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Bdf\Collection\Stream;

use AppendIterator;

/**
 * Concatenate two or more Streams into one stream
 *
 * The streams will be iterated consecutively (The first iterator is the first iterated)
 *
 * @template T
 * @implements StreamInterface<T, mixed>
 *
 * @see StreamInterface::concat()
 */
final class ConcatStream extends AppendIterator implements StreamInterface
{
    use StreamTrait;

    /**
     * @var bool
     */
    private $preserveKeys;

    /**
     * @var int
     */
    private $key = 0;


    /**
     * ConcatStream constructor.
     *
     * @param array<StreamInterface<T, mixed>> $streams

     * @param bool $preserveKeys Preserve the base stream keys
     */
    public function __construct(array $streams, bool $preserveKeys = true)
    {
        parent::__construct();

        $this->preserveKeys = $preserveKeys;

        foreach ($streams as $stream) {
            $this->append($stream);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function concat(StreamInterface $stream, bool $preserveKeys = true): StreamInterface
    {
        // Do not preserve key for previous streams, but keep for new stream
        // => Create a new ContactStream for keeping new stream keys
        if (!$this->preserveKeys && $preserveKeys) {
            return new ConcatStream([$this, $stream], true);
        }

        // If keys are not preserved for the last stream
        // All the previous streams wil also loose their keys
        if (!$preserveKeys) {
            $this->preserveKeys = false;
        }

        $this->append($stream);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    #[\ReturnTypeWillChange]
    public function key()
    {
        if ($this->preserveKeys) {
            return parent::key();
        }

        return $this->key;
    }

    /**
     * {@inheritdoc}
     */
    public function next(): void
    {
        parent::next();

        ++$this->key;
    }

    /**
     * {@inheritdoc}
     */
    public function rewind(): void
    {
        parent::rewind();

        $this->key = 0;
    }
}


1		<?php
2
3		namespace Bdf\Collection\Stream;
4
5		use AppendIterator;
6
7		/**
8		* Concatenate two or more Streams into one stream
9		*
10		* The streams will be iterated consecutively (The first iterator is the first iterated)
11		*
12		* @template T
13		* @implements StreamInterface<T, mixed>
14		*
15		* @see StreamInterface::concat()
16		*/
17		final class ConcatStream extends AppendIterator implements StreamInterface
18		{
19		use StreamTrait;
20
21		/**
22		* @var bool
23		*/
24		private $preserveKeys;
25
26		/**
27		* @var int
28		*/
29		private $key = 0;
30
31
32		/**
33		* ConcatStream constructor.
34		*
35		* @param array<StreamInterface<T, mixed>> $streams
		0 ignored issues – show Documentation Bug introduced 2021-12-15 11:08 UTC by Report Bug Copy Issue Report The doc comment `array<StreamInterface<T, mixed>>` at position `2` could not be parsed: Expected '>' at position 2, but found 'StreamInterface'. Loading history...
36		* @param bool $preserveKeys Preserve the base stream keys
37		*/
38	32	public function __construct(array $streams, bool $preserveKeys = true)
39		{
40	32	parent::__construct();
41
42	32	$this->preserveKeys = $preserveKeys;
43
44	32	foreach ($streams as $stream) {
45	32	$this->append($stream);
46		}
47	32	}
48
49		/**
50		* {@inheritdoc}
51		*/
52	3	public function concat(StreamInterface $stream, bool $preserveKeys = true): StreamInterface
53		{
54		// Do not preserve key for previous streams, but keep for new stream
55		// => Create a new ContactStream for keeping new stream keys
56	3	if (!$this->preserveKeys && $preserveKeys) {
57	1	return new ConcatStream([$this, $stream], true);
58		}
59
60		// If keys are not preserved for the last stream
61		// All the previous streams wil also loose their keys
62	2	if (!$preserveKeys) {
63	1	$this->preserveKeys = false;
64		}
65
66	2	$this->append($stream);
67
68	2	return $this;
69		}
70
71		/**
72		* {@inheritdoc}
73		*/
74		#[\ReturnTypeWillChange]
75	27	public function key()
76		{
77	27	if ($this->preserveKeys) {
78	17	return parent::key();
79		}
80
81	12	return $this->key;
82		}
83
84		/**
85		* {@inheritdoc}
86		*/
87	30	public function next(): void
88		{
89	30	parent::next();
90
91	30	++$this->key;
92	30	}
93
94		/**
95		* {@inheritdoc}
96		*/
97	31	public function rewind(): void
98		{
99	31	parent::rewind();
100
101	31	$this->key = 0;
102	31	}
103		}
104

b2pweb / bdf-collections

ConcatStream::rewind() A last analyzed 2023-01-04 13:50 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ConcatStream::rewind() A
last analyzed 2023-01-04 13:50 UTC