DBCIterator::seek() - Code Metrics - wowstack/php-dbc-parser - Measure and Improve Code Quality continuously with Scrutinizer

DBCIterator::seek() A
last analyzed 2019-08-16 07:28 UTC

↳ Parent: DBCIterator

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	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Wowstack\Dbc;

/**
 * Implements iteration over the records of a DBC file.
 */
class DBCIterator implements \Iterator
{
    /**
     * @var DBC
     */
    protected $dbcFile = null;

    /**
     * @var int
     */
    protected $position = 0;

    /**

     * Creates a new DBC iterator.
     *
     * @var DBC $dbcFile A valid DBC file to be used
     */
    public function __construct(DBC $dbcFile)
    {
        $this->dbcFile = $dbcFile;
    }

    /**
     * Reset iterator to the first record.
     */
    public function rewind()
    {
        $this->position = 0;
    }

    /**
     * Returns the current record.
     *
     * @return DBCRecord
     *
     * @throws DBCException
     */
    public function current()
    {
        return $this->dbcFile->getRecord($this->position);
    }

    /**
     * Returns the current record index.
     *
     * @return int
     */
    public function key(): int
    {
        return $this->position;
    }

    /**
     * Advances the record index by one.
     */
    public function next()
    {
        ++$this->position;
    }

    /**
     * Moves the record index back by one.
     */
    public function prev()
    {
        --$this->position;
    }

    /**
     * Moves record position to given position.
     *
     * @param int $position
     */
    public function seek(int $position)
    {
        $this->position = $position;
    }

    /**
     * Returns information if a given record index exists.
     *
     * @return bool
     */
    public function valid(): bool
    {
        return $this->dbcFile->hasRecord($this->position);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Wowstack\Dbc;
6
7		/**
8		* Implements iteration over the records of a DBC file.
9		*/
10		class DBCIterator implements \Iterator
11		{
12		/**
13		* @var DBC
14		*/
15		protected $dbcFile = null;
16
17		/**
18		* @var int
19		*/
20		protected $position = 0;
21
22		/**
		0 ignored issues – show introduced 2019-04-17 20:35 UTC by Report Bug Copy Issue Report Doc comment for parameter "$dbcFile" missing Loading history...
23		* Creates a new DBC iterator.
24		*
25		* @var DBC $dbcFile A valid DBC file to be used
26		*/
27	2	public function __construct(DBC $dbcFile)
28		{
29	2	$this->dbcFile = $dbcFile;
30	2	}
31
32		/**
33		* Reset iterator to the first record.
34		*/
35	1	public function rewind()
36		{
37	1	$this->position = 0;
38	1	}
39
40		/**
41		* Returns the current record.
42		*
43		* @return DBCRecord
44		*
45		* @throws DBCException
46		*/
47	1	public function current()
48		{
49	1	return $this->dbcFile->getRecord($this->position);
50		}
51
52		/**
53		* Returns the current record index.
54		*
55		* @return int
56		*/
57	1	public function key(): int
58		{
59	1	return $this->position;
60		}
61
62		/**
63		* Advances the record index by one.
64		*/
65	1	public function next()
66		{
67	1	++$this->position;
68	1	}
69
70		/**
71		* Moves the record index back by one.
72		*/
73	1	public function prev()
74		{
75	1	--$this->position;
76	1	}
77
78		/**
79		* Moves record position to given position.
80		*
81		* @param int $position
82		*/
83	1	public function seek(int $position)
84		{
85	1	$this->position = $position;
86	1	}
87
88		/**
89		* Returns information if a given record index exists.
90		*
91		* @return bool
92		*/
93	1	public function valid(): bool
94		{
95	1	return $this->dbcFile->hasRecord($this->position);
96		}
97		}
98

wowstack / php-dbc-parser

DBCIterator::seek() A last analyzed 2019-08-16 07:28 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DBCIterator::seek() A
last analyzed 2019-08-16 07:28 UTC