SheetIterator::rewind() - Code Metrics - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

SheetIterator::rewind() A
last analyzed 2021-06-07 10:47 UTC

↳ Parent: SheetIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Box\Spout\Reader\CSV;

use Box\Spout\Reader\IteratorInterface;

/**
 * Class SheetIterator
 * Iterate over CSV unique "sheet".
 */
class SheetIterator implements IteratorInterface
{
    /** @var \Box\Spout\Reader\CSV\Sheet The CSV unique "sheet" */
    protected $sheet;

    /** @var bool Whether the unique "sheet" has already been read */
    protected $hasReadUniqueSheet = false;

    /**
     * @param Sheet $sheet Corresponding unique sheet
     */
    public function __construct($sheet)
    {
        $this->sheet = $sheet;
    }

    /**
     * Rewind the Iterator to the first element
     * @see http://php.net/manual/en/iterator.rewind.php
     *
     * @return void
     */
    public function rewind()
    {
        $this->hasReadUniqueSheet = false;
    }

    /**
     * Checks if current position is valid
     * @see http://php.net/manual/en/iterator.valid.php
     *
     * @return bool
     */
    public function valid()
    {
        return (!$this->hasReadUniqueSheet);
    }

    /**
     * Move forward to next element
     * @see http://php.net/manual/en/iterator.next.php
     *
     * @return void
     */
    public function next()
    {
        $this->hasReadUniqueSheet = true;
    }

    /**
     * Return the current element
     * @see http://php.net/manual/en/iterator.current.php
     *
     * @return \Box\Spout\Reader\CSV\Sheet
     */
    public function current()
    {
        return $this->sheet;
    }

    /**
     * Return the key of the current element
     * @see http://php.net/manual/en/iterator.key.php
     *
     * @return int
     */
    public function key()
    {
        return 1;
    }

    /**
     * Cleans up what was created to iterate over the object.
     *
     * @return void
     */
    public function end()
    {
        // do nothing
    }
}


1		<?php
2
3		namespace Box\Spout\Reader\CSV;
4
5		use Box\Spout\Reader\IteratorInterface;
6
7		/**
8		* Class SheetIterator
9		* Iterate over CSV unique "sheet".
10		*/
11		class SheetIterator implements IteratorInterface
12		{
13		/** @var \Box\Spout\Reader\CSV\Sheet The CSV unique "sheet" */
14		protected $sheet;
15
16		/** @var bool Whether the unique "sheet" has already been read */
17		protected $hasReadUniqueSheet = false;
18
19		/**
20		* @param Sheet $sheet Corresponding unique sheet
21		*/
22	27	public function __construct($sheet)
23		{
24	27	$this->sheet = $sheet;
25	27	}
26
27		/**
28		* Rewind the Iterator to the first element
29		* @see http://php.net/manual/en/iterator.rewind.php
30		*
31		* @return void
32		*/
33	26	public function rewind()
34		{
35	26	$this->hasReadUniqueSheet = false;
36	26	}
37
38		/**
39		* Checks if current position is valid
40		* @see http://php.net/manual/en/iterator.valid.php
41		*
42		* @return bool
43		*/
44	26	public function valid()
45		{
46	26	return (!$this->hasReadUniqueSheet);
47		}
48
49		/**
50		* Move forward to next element
51		* @see http://php.net/manual/en/iterator.next.php
52		*
53		* @return void
54		*/
55	26	public function next()
56		{
57	26	$this->hasReadUniqueSheet = true;
58	26	}
59
60		/**
61		* Return the current element
62		* @see http://php.net/manual/en/iterator.current.php
63		*
64		* @return \Box\Spout\Reader\CSV\Sheet
65		*/
66	27	public function current()
67		{
68	27	return $this->sheet;
69		}
70
71		/**
72		* Return the key of the current element
73		* @see http://php.net/manual/en/iterator.key.php
74		*
75		* @return int
76		*/
77	20	public function key()
78		{
79	20	return 1;
80		}
81
82		/**
83		* Cleans up what was created to iterate over the object.
84		*
85		* @return void
86		*/
87	27	public function end()
88		{
89		// do nothing
90	27	}
91		}
92

box / spout

SheetIterator::rewind() A last analyzed 2021-06-07 10:47 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SheetIterator::rewind() A
last analyzed 2021-06-07 10:47 UTC