RowCellIterator::adjustForExistingOnlyRange() - Code Metrics - Inspection of "Allow iterators to go out of bounds with prev()" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 125f46...5e090d )

by Adrien

created 2018-08-19 05:04 UTC

RowCellIterator::adjustForExistingOnlyRange() B

↳ Parent: RowCellIterator

Complexity

Conditions	8
Paths	11

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	40.768

Importance

Changes

Metric	Value
cc	8
eloc	9
nc	11
nop	0
dl	0
loc	14
ccs	2
cts	10
cp	0.2
crap	40.768
rs	8.4444
c	0
b	0
f	0

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;

class RowCellIterator extends CellIterator
{
    /**
     * Current iterator position.
     *
     * @var int
     */
    private $currentColumnIndex;

    /**
     * Row index.
     *
     * @var int
     */
    private $rowIndex = 1;

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

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

    /**
     * Create a new column iterator.
     *
     * @param Worksheet $worksheet The worksheet to iterate over
     * @param int $rowIndex The row that we want to iterate
     * @param string $startColumn The column address at which to start iterating
     * @param string $endColumn Optionally, the column address at which to stop iterating
     */
    public function __construct(Worksheet $worksheet = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
    {
        // Set subject and row index
        $this->worksheet = $worksheet;
        $this->rowIndex = $rowIndex;
        $this->resetEnd($endColumn);
        $this->resetStart($startColumn);
    }

    /**
     * (Re)Set the start column and the current column pointer.
     *
     * @param string $startColumn The column address at which to start iterating
     *
     * @throws PhpSpreadsheetException
     *
     * @return RowCellIterator
     */
    public function resetStart($startColumn = 'A')
    {
        $this->startColumnIndex = Coordinate::columnIndexFromString($startColumn);
        $this->adjustForExistingOnlyRange();
        $this->seek(Coordinate::stringFromColumnIndex($this->startColumnIndex));

        return $this;
    }

    /**
     * (Re)Set the end column.
     *
     * @param string $endColumn The column address at which to stop iterating
     *
     * @throws PhpSpreadsheetException
     *
     * @return RowCellIterator
     */
    public function resetEnd($endColumn = null)
    {
        $endColumn = $endColumn ? $endColumn : $this->worksheet->getHighestColumn();
        $this->endColumnIndex = Coordinate::columnIndexFromString($endColumn);
        $this->adjustForExistingOnlyRange();

        return $this;
    }

    /**
     * Set the column pointer to the selected column.
     *
     * @param string $column The column address to set the current pointer at
     *
     * @throws PhpSpreadsheetException
     *
     * @return RowCellIterator
     */
    public function seek($column = 'A')
    {
        $column = Coordinate::columnIndexFromString($column);
        if (($column < $this->startColumnIndex) || ($column > $this->endColumnIndex)) {
            throw new PhpSpreadsheetException("Column $column is out of range ({$this->startColumnIndex} - {$this->endColumnIndex})");
        } elseif ($this->onlyExistingCells && !($this->worksheet->cellExistsByColumnAndRow($column, $this->rowIndex))) {
            throw new PhpSpreadsheetException('In "IterateOnlyExistingCells" mode and Cell does not exist');
        }
        $this->currentColumnIndex = $column;

        return $this;
    }

    /**
     * Rewind the iterator to the starting column.
     */
    public function rewind()
    {
        $this->currentColumnIndex = $this->startColumnIndex;
    }

    /**
     * Return the current cell in this worksheet row.
     *
     * @return \PhpOffice\PhpSpreadsheet\Cell\Cell
     */
    public function current()
    {
        return $this->worksheet->getCellByColumnAndRow($this->currentColumnIndex, $this->rowIndex);
    }

    /**
     * Return the current iterator key.
     *
     * @return string
     */
    public function key()
    {
        return Coordinate::stringFromColumnIndex($this->currentColumnIndex);
    }

    /**
     * Set the iterator to its next value.
     */
    public function next()
    {
        do {
            ++$this->currentColumnIndex;
        } while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex <= $this->endColumnIndex));
    }

    /**
     * Set the iterator to its previous value.
     *
     * @throws PhpSpreadsheetException
     */
    public function prev()
    {
        do {
            --$this->currentColumnIndex;
        } while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex >= $this->startColumnIndex));
    }

    /**
     * Indicate if more columns exist in the worksheet range of columns that we're iterating.
     *
     * @return bool
     */
    public function valid()
    {
        return $this->currentColumnIndex <= $this->endColumnIndex && $this->currentColumnIndex >= $this->startColumnIndex;
    }

    /**
     * Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.
     *
     * @throws PhpSpreadsheetException
     */
    protected function adjustForExistingOnlyRange()
    {
        if ($this->onlyExistingCells) {
            while ((!$this->worksheet->cellExistsByColumnAndRow($this->startColumnIndex, $this->rowIndex)) && ($this->startColumnIndex <= $this->endColumnIndex)) {
                ++$this->startColumnIndex;
            }
            if ($this->startColumnIndex > $this->endColumnIndex) {
                throw new PhpSpreadsheetException('No cells exist within the specified range');
            }
            while ((!$this->worksheet->cellExistsByColumnAndRow($this->endColumnIndex, $this->rowIndex)) && ($this->endColumnIndex >= $this->startColumnIndex)) {
                --$this->endColumnIndex;
            }
            if ($this->endColumnIndex < $this->startColumnIndex) {
                throw new PhpSpreadsheetException('No cells exist within the specified range');
            }
        }
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Worksheet;
4
5		use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
6		use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
7
8		class RowCellIterator extends CellIterator
9		{
10		/**
11		* Current iterator position.
12		*
13		* @var int
14		*/
15		private $currentColumnIndex;
16
17		/**
18		* Row index.
19		*
20		* @var int
21		*/
22		private $rowIndex = 1;
23
24		/**
25		* Start position.
26		*
27		* @var int
28		*/
29		private $startColumnIndex = 1;
30
31		/**
32		* End position.
33		*
34		* @var int
35		*/
36		private $endColumnIndex = 1;
37
38		/**
39		* Create a new column iterator.
40		*
41		* @param Worksheet $worksheet The worksheet to iterate over
42		* @param int $rowIndex The row that we want to iterate
43		* @param string $startColumn The column address at which to start iterating
44		* @param string $endColumn Optionally, the column address at which to stop iterating
45		*/
46	14	public function __construct(Worksheet $worksheet = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
47		{
48		// Set subject and row index
49	14	$this->worksheet = $worksheet;
50	14	$this->rowIndex = $rowIndex;
51	14	$this->resetEnd($endColumn);
52	14	$this->resetStart($startColumn);
53	14	}
54
55		/**
56		* (Re)Set the start column and the current column pointer.
57		*
58		* @param string $startColumn The column address at which to start iterating
59		*
60		* @throws PhpSpreadsheetException
61		*
62		* @return RowCellIterator
63		*/
64	14	public function resetStart($startColumn = 'A')
65		{
66	14	$this->startColumnIndex = Coordinate::columnIndexFromString($startColumn);
67	14	$this->adjustForExistingOnlyRange();
68	14	$this->seek(Coordinate::stringFromColumnIndex($this->startColumnIndex));
69
70	14	return $this;
71		}
72
73		/**
74		* (Re)Set the end column.
75		*
76		* @param string $endColumn The column address at which to stop iterating
77		*
78		* @throws PhpSpreadsheetException
79		*
80		* @return RowCellIterator
81		*/
82	14	public function resetEnd($endColumn = null)
83		{
84	14	$endColumn = $endColumn ? $endColumn : $this->worksheet->getHighestColumn();
85	14	$this->endColumnIndex = Coordinate::columnIndexFromString($endColumn);
86	14	$this->adjustForExistingOnlyRange();
87
88	14	return $this;
89		}
90
91		/**
92		* Set the column pointer to the selected column.
93		*
94		* @param string $column The column address to set the current pointer at
95		*
96		* @throws PhpSpreadsheetException
97		*
98		* @return RowCellIterator
99		*/
100	14	public function seek($column = 'A')
101		{
102	14	$column = Coordinate::columnIndexFromString($column);
103	14	if (($column < $this->startColumnIndex) \|\| ($column > $this->endColumnIndex)) {
104		throw new PhpSpreadsheetException("Column $column is out of range ({$this->startColumnIndex} - {$this->endColumnIndex})");
105	14	} elseif ($this->onlyExistingCells && !($this->worksheet->cellExistsByColumnAndRow($column, $this->rowIndex))) {
106		throw new PhpSpreadsheetException('In "IterateOnlyExistingCells" mode and Cell does not exist');
107		}
108	14	$this->currentColumnIndex = $column;
109
110	14	return $this;
111		}
112
113		/**
114		* Rewind the iterator to the starting column.
115		*/
116	3	public function rewind()
117		{
118	3	$this->currentColumnIndex = $this->startColumnIndex;
119	3	}
120
121		/**
122		* Return the current cell in this worksheet row.
123		*
124		* @return \PhpOffice\PhpSpreadsheet\Cell\Cell
125		*/
126	10	public function current()
127		{
128	10	return $this->worksheet->getCellByColumnAndRow($this->currentColumnIndex, $this->rowIndex);
129		}
130
131		/**
132		* Return the current iterator key.
133		*
134		* @return string
135		*/
136	3	public function key()
137		{
138	3	return Coordinate::stringFromColumnIndex($this->currentColumnIndex);
139		}
140
141		/**
142		* Set the iterator to its next value.
143		*/
144	10	public function next()
145		{
146		do {
147	10	++$this->currentColumnIndex;
148	10	} while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex <= $this->endColumnIndex));
149	10	}
150
151		/**
152		* Set the iterator to its previous value.
153		*
154		* @throws PhpSpreadsheetException
155		*/
156	2	public function prev()
157		{
158		do {
159	2	--$this->currentColumnIndex;
160	2	} while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex >= $this->startColumnIndex));
161	2	}
162
163		/**
164		* Indicate if more columns exist in the worksheet range of columns that we're iterating.
165		*
166		* @return bool
167		*/
168	11	public function valid()
169		{
170	11	return $this->currentColumnIndex <= $this->endColumnIndex && $this->currentColumnIndex >= $this->startColumnIndex;
171		}
172
173		/**
174		* Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.
175		*
176		* @throws PhpSpreadsheetException
177		*/
178	14	protected function adjustForExistingOnlyRange()
179		{
180	14	if ($this->onlyExistingCells) {
181		while ((!$this->worksheet->cellExistsByColumnAndRow($this->startColumnIndex, $this->rowIndex)) && ($this->startColumnIndex <= $this->endColumnIndex)) {
182		++$this->startColumnIndex;
183		}
184		if ($this->startColumnIndex > $this->endColumnIndex) {
185		throw new PhpSpreadsheetException('No cells exist within the specified range');
186		}
187		while ((!$this->worksheet->cellExistsByColumnAndRow($this->endColumnIndex, $this->rowIndex)) && ($this->endColumnIndex >= $this->startColumnIndex)) {
188		--$this->endColumnIndex;
189		}
190		if ($this->endColumnIndex < $this->startColumnIndex) {
191		throw new PhpSpreadsheetException('No cells exist within the specified range');
192		}
193		}
194	14	}
195		}
196

PHPOffice / PhpSpreadsheet

Push — develop ( 125f46...5e090d )

RowCellIterator::adjustForExistingOnlyRange() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like