RowCellIterator::seek() - Code Metrics - Inspection of "Reformat column width section" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f99eb8...c5339b )

by Adrien

created 2017-03-10 10:58 UTC

RowCellIterator::seek() B

↳ Parent: RowCellIterator

Complexity

Conditions	5
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	12
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	5.3906

Importance

Changes

Metric	Value
cc	5
eloc	8
nc	3
nop	1
dl	12
loc	12
rs	8.8571
c	0
b	0
f	0
ccs	6
cts	8
cp	0.75
crap	5.3906

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

/**
 * Copyright (c) 2006 - 2016 PhpSpreadsheet.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category   PhpSpreadsheet
 *
 * @copyright  Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 */
class RowCellIterator extends CellIterator implements \Iterator
{
    /**
     * Row index.
     *
     * @var int
     */
    protected $rowIndex;

    /**
     * Start position.
     *
     * @var int
     */
    protected $startColumn = 0;

    /**
     * End position.
     *
     * @var int
     */
    protected $endColumn = 0;

    /**
     * Create a new column iterator.
     *
     * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject 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(\PhpOffice\PhpSpreadsheet\Worksheet $subject = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)

    {
        // Set subject and row index
        $this->subject = $subject;
        $this->rowIndex = $rowIndex;
        $this->resetEnd($endColumn);
        $this->resetStart($startColumn);
    }

    /**
     * Destructor.
     */
    public function __destruct()
    {
        unset($this->subject);
    }

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

        return $this;
    }

    /**
     * (Re)Set the end column.
     *
     * @param string $endColumn The column address at which to stop iterating
     *
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     *
     * @return RowCellIterator
     */
    public function resetEnd($endColumn = null)

    {
        $endColumn = ($endColumn) ? $endColumn : $this->subject->getHighestColumn();
        $this->endColumn = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($endColumn) - 1;
        $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 \PhpOffice\PhpSpreadsheet\Exception
     *
     * @return RowCellIterator
     */
    public function seek($column = 'A')

    {
        $column = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($column) - 1;
        if (($column < $this->startColumn) || ($column > $this->endColumn)) {
            throw new \PhpOffice\PhpSpreadsheet\Exception("Column $column is out of range ({$this->startColumn} - {$this->endColumn})");
        } elseif ($this->onlyExistingCells && !($this->subject->cellExistsByColumnAndRow($column, $this->rowIndex))) {
            throw new \PhpOffice\PhpSpreadsheet\Exception('In "IterateOnlyExistingCells" mode and Cell does not exist');
        }
        $this->position = $column;

        return $this;
    }

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

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

    /**
     * Return the current iterator key.
     *
     * @return string
     */
    public function key()
    {
        return \PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->position);
    }

    /**
     * Set the iterator to its next value.
     */
    public function next()

    {
        do {
            ++$this->position;
        } while (($this->onlyExistingCells) &&
            (!$this->subject->cellExistsByColumnAndRow($this->position, $this->rowIndex)) &&
            ($this->position <= $this->endColumn));
    }

    /**
     * Set the iterator to its previous value.
     *
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     */
    public function prev()
    {
        if ($this->position <= $this->startColumn) {

            throw new \PhpOffice\PhpSpreadsheet\Exception(
                'Column is already at the beginning of range (' .
                \PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->endColumn) . ' - ' .
                \PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->endColumn) . ')'
            );
        }

        do {
            --$this->position;
        } while (($this->onlyExistingCells) &&
            (!$this->subject->cellExistsByColumnAndRow($this->position, $this->rowIndex)) &&
            ($this->position >= $this->startColumn));
    }

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

    /**
     * Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.
     *
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     */
    protected function adjustForExistingOnlyRange()

    {
        if ($this->onlyExistingCells) {
            while ((!$this->subject->cellExistsByColumnAndRow($this->startColumn, $this->rowIndex)) &&
                ($this->startColumn <= $this->endColumn)) {
                ++$this->startColumn;
            }
            if ($this->startColumn > $this->endColumn) {
                throw new \PhpOffice\PhpSpreadsheet\Exception('No cells exist within the specified range');
            }
            while ((!$this->subject->cellExistsByColumnAndRow($this->endColumn, $this->rowIndex)) &&
                ($this->endColumn >= $this->startColumn)) {
                --$this->endColumn;
            }
            if ($this->endColumn < $this->startColumn) {
                throw new \PhpOffice\PhpSpreadsheet\Exception('No cells exist within the specified range');
            }
        }
    }
}


1			<?php
2
3			namespace PhpOffice\PhpSpreadsheet\Worksheet;
4
5			/**
6			* Copyright (c) 2006 - 2016 PhpSpreadsheet.
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU Lesser General Public
10			* License as published by the Free Software Foundation; either
11			* version 2.1 of the License, or (at your option) any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16			* Lesser General Public License for more details.
17			*
18			* You should have received a copy of the GNU Lesser General Public
19			* License along with this library; if not, write to the Free Software
20			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21			*
22			* @category PhpSpreadsheet
23			*
24			* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
25			* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
26			*/
27			class RowCellIterator extends CellIterator implements \Iterator
28			{
29			/**
30			* Row index.
31			*
32			* @var int
33			*/
34			protected $rowIndex;
35
36			/**
37			* Start position.
38			*
39			* @var int
40			*/
41			protected $startColumn = 0;
42
43			/**
44			* End position.
45			*
46			* @var int
47			*/
48			protected $endColumn = 0;
49
50			/**
51			* Create a new column iterator.
52			*
53			* @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over
54			* @param int $rowIndex The row that we want to iterate
55			* @param string $startColumn The column address at which to start iterating
56			* @param string $endColumn Optionally, the column address at which to stop iterating
57			*/
58	9	View Code Duplication	public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $subject = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
59			{
60			// Set subject and row index
61	9		$this->subject = $subject;
62	9		$this->rowIndex = $rowIndex;
63	9		$this->resetEnd($endColumn);
64	9		$this->resetStart($startColumn);
65	9		}
66
67			/**
68			* Destructor.
69			*/
70	9		public function __destruct()
71			{
72	9		unset($this->subject);
73	9		}
74
75			/**
76			* (Re)Set the start column and the current column pointer.
77			*
78			* @param int $startColumn The column address at which to start iterating
79			*
80			* @throws \PhpOffice\PhpSpreadsheet\Exception
81			*
82			* @return RowCellIterator
83			*/
84	9		public function resetStart($startColumn = 'A')
85			{
86	9		$startColumnIndex = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($startColumn) - 1;
87	9		$this->startColumn = $startColumnIndex;
88	9		$this->adjustForExistingOnlyRange();
89	9		$this->seek(\PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->startColumn));
90
91	9		return $this;
92			}
93
94			/**
95			* (Re)Set the end column.
96			*
97			* @param string $endColumn The column address at which to stop iterating
98			*
99			* @throws \PhpOffice\PhpSpreadsheet\Exception
100			*
101			* @return RowCellIterator
102			*/
103	9	View Code Duplication	public function resetEnd($endColumn = null)
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104			{
105	9		$endColumn = ($endColumn) ? $endColumn : $this->subject->getHighestColumn();
106	9		$this->endColumn = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($endColumn) - 1;
107	9		$this->adjustForExistingOnlyRange();
108
109	9		return $this;
110			}
111
112			/**
113			* Set the column pointer to the selected column.
114			*
115			* @param string $column The column address to set the current pointer at
116			*
117			* @throws \PhpOffice\PhpSpreadsheet\Exception
118			*
119			* @return RowCellIterator
120			*/
121	9	View Code Duplication	public function seek($column = 'A')
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
122			{
123	9		$column = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($column) - 1;
124	9		if (($column < $this->startColumn) \|\| ($column > $this->endColumn)) {
125			throw new \PhpOffice\PhpSpreadsheet\Exception("Column $column is out of range ({$this->startColumn} - {$this->endColumn})");
126	9		} elseif ($this->onlyExistingCells && !($this->subject->cellExistsByColumnAndRow($column, $this->rowIndex))) {
127			throw new \PhpOffice\PhpSpreadsheet\Exception('In "IterateOnlyExistingCells" mode and Cell does not exist');
128			}
129	9		$this->position = $column;
130
131	9		return $this;
132			}
133
134			/**
135			* Rewind the iterator to the starting column.
136			*/
137	3		public function rewind()
138			{
139	3		$this->position = $this->startColumn;
140	3		}
141
142			/**
143			* Return the current cell in this worksheet row.
144			*
145			* @return \PhpOffice\PhpSpreadsheet\Cell
146			*/
147	5		public function current()
148			{
149	5		return $this->subject->getCellByColumnAndRow($this->position, $this->rowIndex);
150			}
151
152			/**
153			* Return the current iterator key.
154			*
155			* @return string
156			*/
157	3		public function key()
158			{
159	3		return \PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->position);
160			}
161
162			/**
163			* Set the iterator to its next value.
164			*/
165	5	View Code Duplication	public function next()
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
166			{
167			do {
168	5		++$this->position;
169	5		} while (($this->onlyExistingCells) &&
170			(!$this->subject->cellExistsByColumnAndRow($this->position, $this->rowIndex)) &&
171			($this->position <= $this->endColumn));
172	5		}
173
174			/**
175			* Set the iterator to its previous value.
176			*
177			* @throws \PhpOffice\PhpSpreadsheet\Exception
178			*/
179	2		public function prev()
180			{
181	2	View Code Duplication	if ($this->position <= $this->startColumn) {
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
182	1		throw new \PhpOffice\PhpSpreadsheet\Exception(
183			'Column is already at the beginning of range (' .
184	1		\PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->endColumn) . ' - ' .
185	1		\PhpOffice\PhpSpreadsheet\Cell::stringFromColumnIndex($this->endColumn) . ')'
186			);
187			}
188
189			do {
190	1		--$this->position;
191	1		} while (($this->onlyExistingCells) &&
192			(!$this->subject->cellExistsByColumnAndRow($this->position, $this->rowIndex)) &&
193			($this->position >= $this->startColumn));
194	1		}
195
196			/**
197			* Indicate if more columns exist in the worksheet range of columns that we're iterating.
198			*
199			* @return bool
200			*/
201	5		public function valid()
202			{
203	5		return $this->position <= $this->endColumn;
204			}
205
206			/**
207			* Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.
208			*
209			* @throws \PhpOffice\PhpSpreadsheet\Exception
210			*/
211	9	View Code Duplication	protected function adjustForExistingOnlyRange()
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
212			{
213	9		if ($this->onlyExistingCells) {
214			while ((!$this->subject->cellExistsByColumnAndRow($this->startColumn, $this->rowIndex)) &&
215			($this->startColumn <= $this->endColumn)) {
216			++$this->startColumn;
217			}
218			if ($this->startColumn > $this->endColumn) {
219			throw new \PhpOffice\PhpSpreadsheet\Exception('No cells exist within the specified range');
220			}
221			while ((!$this->subject->cellExistsByColumnAndRow($this->endColumn, $this->rowIndex)) &&
222			($this->endColumn >= $this->startColumn)) {
223			--$this->endColumn;
224			}
225			if ($this->endColumn < $this->startColumn) {
226			throw new \PhpOffice\PhpSpreadsheet\Exception('No cells exist within the specified range');
227			}
228			}
229	9		}
230			}
231

PHPOffice / PhpSpreadsheet

Push — develop ( f99eb8...c5339b )

RowCellIterator::seek() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like