RowIterator::__destruct() - Code Metrics - Inspection of "PHPStan Level 3" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 02f37d...f95322 )

by Adrien

created 2021-04-11 07:52 UTC

RowIterator::__destruct() A

↳ Parent: RowIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use Iterator;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;

class RowIterator implements Iterator
{
    /**
     * Worksheet to iterate.
     *
     * @var Worksheet
     */
    private $subject;

    /**
     * Current iterator position.
     *
     * @var int
     */
    private $position = 1;

    /**
     * Start position.
     *
     * @var int
     */
    private $startRow = 1;

    /**
     * End position.
     *
     * @var int
     */
    private $endRow = 1;

    /**
     * Create a new row iterator.
     *
     * @param Worksheet $subject The worksheet to iterate over
     * @param int $startRow The row number at which to start iterating
     * @param int $endRow Optionally, the row number at which to stop iterating
     */
    public function __construct(Worksheet $subject, $startRow = 1, $endRow = null)
    {
        // Set subject
        $this->subject = $subject;
        $this->resetEnd($endRow);
        $this->resetStart($startRow);
    }

    /**
     * (Re)Set the start row and the current row pointer.
     *
     * @param int $startRow The row number at which to start iterating
     *
     * @return $this
     */
    public function resetStart(int $startRow = 1)
    {
        if ($startRow > $this->subject->getHighestRow()) {
            throw new PhpSpreadsheetException(
                "Start row ({$startRow}) is beyond highest row ({$this->subject->getHighestRow()})"
            );
        }

        $this->startRow = $startRow;
        if ($this->endRow < $this->startRow) {
            $this->endRow = $this->startRow;
        }
        $this->seek($startRow);

        return $this;
    }

    /**
     * (Re)Set the end row.
     *
     * @param int $endRow The row number at which to stop iterating
     *
     * @return $this
     */
    public function resetEnd($endRow = null)
    {
        $this->endRow = $endRow ?: $this->subject->getHighestRow();

        return $this;
    }

    /**
     * Set the row pointer to the selected row.
     *
     * @param int $row The row number to set the current pointer at
     *
     * @return $this
     */
    public function seek(int $row = 1)
    {
        if (($row < $this->startRow) || ($row > $this->endRow)) {
            throw new PhpSpreadsheetException("Row $row is out of range ({$this->startRow} - {$this->endRow})");
        }
        $this->position = $row;

        return $this;
    }

    /**
     * Rewind the iterator to the starting row.
     */
    public function rewind(): void
    {
        $this->position = $this->startRow;
    }

    /**
     * Return the current row in this worksheet.
     *
     * @return Row
     */
    public function current()
    {
        return new Row($this->subject, $this->position);
    }

    /**
     * Return the current iterator key.
     */
    public function key(): int
    {
        return $this->position;
    }

    /**
     * Set the iterator to its next value.
     */
    public function next(): void
    {
        ++$this->position;
    }

    /**
     * Set the iterator to its previous value.
     */
    public function prev(): void
    {
        --$this->position;
    }

    /**
     * Indicate if more rows exist in the worksheet range of rows that we're iterating.
     */
    public function valid(): bool
    {
        return $this->position <= $this->endRow && $this->position >= $this->startRow;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Worksheet;
4
5		use Iterator;
		0 ignored issues – show Bug introduced 2020-05-18 05:01 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `PhpOffice\PhpSpreadsheet\Worksheet\Iterator`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6		use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
7
8		class RowIterator implements Iterator
9		{
10		/**
11		* Worksheet to iterate.
12		*
13		* @var Worksheet
14		*/
15		private $subject;
16
17		/**
18		* Current iterator position.
19		*
20		* @var int
21		*/
22		private $position = 1;
23
24		/**
25		* Start position.
26		*
27		* @var int
28		*/
29		private $startRow = 1;
30
31		/**
32		* End position.
33		*
34		* @var int
35		*/
36		private $endRow = 1;
37
38		/**
39		* Create a new row iterator.
40		*
41		* @param Worksheet $subject The worksheet to iterate over
42		* @param int $startRow The row number at which to start iterating
43		* @param int $endRow Optionally, the row number at which to stop iterating
44		*/
45	20	public function __construct(Worksheet $subject, $startRow = 1, $endRow = null)
46		{
47		// Set subject
48	20	$this->subject = $subject;
49	20	$this->resetEnd($endRow);
50	20	$this->resetStart($startRow);
51	20	}
52
53		/**
54		* (Re)Set the start row and the current row pointer.
55		*
56		* @param int $startRow The row number at which to start iterating
57		*
58		* @return $this
59		*/
60	20	public function resetStart(int $startRow = 1)
61		{
62	20	if ($startRow > $this->subject->getHighestRow()) {
63	1	throw new PhpSpreadsheetException(
64	1	"Start row ({$startRow}) is beyond highest row ({$this->subject->getHighestRow()})"
65		);
66		}
67
68	20	$this->startRow = $startRow;
69	20	if ($this->endRow < $this->startRow) {
70	1	$this->endRow = $this->startRow;
71		}
72	20	$this->seek($startRow);
73
74	20	return $this;
75		}
76
77		/**
78		* (Re)Set the end row.
79		*
80		* @param int $endRow The row number at which to stop iterating
81		*
82		* @return $this
83		*/
84	20	public function resetEnd($endRow = null)
85		{
86	20	$this->endRow = $endRow ?: $this->subject->getHighestRow();
87
88	20	return $this;
89		}
90
91		/**
92		* Set the row pointer to the selected row.
93		*
94		* @param int $row The row number to set the current pointer at
95		*
96		* @return $this
97		*/
98	20	public function seek(int $row = 1)
99		{
100	20	if (($row < $this->startRow) \|\| ($row > $this->endRow)) {
101	1	throw new PhpSpreadsheetException("Row $row is out of range ({$this->startRow} - {$this->endRow})");
102		}
103	20	$this->position = $row;
104
105	20	return $this;
106		}
107
108		/**
109		* Rewind the iterator to the starting row.
110		*/
111	6	public function rewind(): void
112		{
113	6	$this->position = $this->startRow;
114	6	}
115
116		/**
117		* Return the current row in this worksheet.
118		*
119		* @return Row
120		*/
121	15	public function current()
122		{
123	15	return new Row($this->subject, $this->position);
124		}
125
126		/**
127		* Return the current iterator key.
128		*/
129	4	public function key(): int
130		{
131	4	return $this->position;
132		}
133
134		/**
135		* Set the iterator to its next value.
136		*/
137	16	public function next(): void
138		{
139	16	++$this->position;
140	16	}
141
142		/**
143		* Set the iterator to its previous value.
144		*/
145	2	public function prev(): void
146		{
147	2	--$this->position;
148	2	}
149
150		/**
151		* Indicate if more rows exist in the worksheet range of rows that we're iterating.
152		*/
153	17	public function valid(): bool
154		{
155	17	return $this->position <= $this->endRow && $this->position >= $this->startRow;
156		}
157		}
158

PHPOffice / PhpSpreadsheet

Push — master ( 02f37d...f95322 )

RowIterator::__destruct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like