NodeCollection::rewind() - Code Metrics - scotteh/php-dom-wrapper - Measure and Improve Code Quality continuously with Scrutinizer

NodeCollection::rewind() A
last analyzed 2023-09-05 13:23 UTC

↳ Parent: NodeCollection

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?php declare(strict_types=1);

namespace DOMWrap\Collections;

/**
 * Node List
 *
 * @package DOMWrap\Collections
 * @license http://opensource.org/licenses/BSD-3-Clause BSD 3 Clause
 */
class NodeCollection implements \Countable, \ArrayAccess, \RecursiveIterator
{
    /** @var array */
    protected $nodes = [];

    /**
     * @param iterable $nodes
     */
    public function __construct(iterable $nodes = null) {
        if (!is_iterable($nodes)) {
            $nodes = [];
        }

        foreach ($nodes as $node) {
            $this->nodes[] = $node;
        }
    }

    /**
     * @see \Countable::count()
     *
     * @return int
     */
    public function count(): int {
        return count($this->nodes);
    }

    /**
     * @see \ArrayAccess::offsetExists()
     *
     * @param mixed $offset
     *
     * @return bool
     */
    public function offsetExists($offset): bool {
        return isset($this->nodes[$offset]);
    }

    /**
     * @see \ArrayAccess::offsetGet()
     *
     * @param mixed $offset
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]

    public function offsetGet($offset) {
        return isset($this->nodes[$offset]) ? $this->nodes[$offset] : null;
    }

    /**
     * @see \ArrayAccess::offsetSet()
     *
     * @param mixed $offset
     * @param mixed $value
     */
    public function offsetSet($offset, $value): void {
        if (is_null($offset)) {
            $this->nodes[] = $value;
        } else {
            $this->nodes[$offset] = $value;
        }
    }

    /**
     * @see \ArrayAccess::offsetUnset()
     *
     * @param mixed $offset
     */
    public function offsetUnset($offset): void {
        unset($this->nodes[$offset]);
    }

    /**
     * @see \RecursiveIterator::RecursiveIteratorIterator()
     *
     * @return \RecursiveIteratorIterator
     */
    public function getRecursiveIterator(): \RecursiveIteratorIterator {
        return new \RecursiveIteratorIterator($this, \RecursiveIteratorIterator::SELF_FIRST);
    }

    /**
     * @see \RecursiveIterator::getChildren()
     *
     * @return \RecursiveIterator
     */
    public function getChildren(): \RecursiveIterator {
        $nodes = [];

        if ($this->valid()) {
            $nodes = $this->current()->childNodes;
        }

        return new static($nodes);
    }

    /**
     * @see \RecursiveIterator::hasChildren()
     *
     * @return bool
     */
    public function hasChildren(): bool {
        if ($this->valid()) {
            return $this->current()->hasChildNodes();
        }

        return false;
    }

    /**
     * @see \RecursiveIterator::current()
     * @see \Iterator::current()
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]

    public function current() {
        return current($this->nodes);
    }

    /**
     * @see \RecursiveIterator::key()
     * @see \Iterator::key()
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]

    public function key() {
        return key($this->nodes);
    }

    /**
     * @see \RecursiveIterator::next()
     * @see \Iterator::next()
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]

    public function next() {
        return next($this->nodes);
    }

    /**
     * @see \RecursiveIterator::rewind()
     * @see \Iterator::rewind()
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]

    public function rewind() {
        return reset($this->nodes);
    }

    /**
     * @see \RecursiveIterator::valid()
     * @see \Iterator::valid()
     *
     * @return bool
     */
    public function valid(): bool {
        return key($this->nodes) !== null;
    }
}

1		<?php declare(strict_types=1);
2
3		namespace DOMWrap\Collections;
4
5		/**
6		* Node List
7		*
8		* @package DOMWrap\Collections
9		* @license http://opensource.org/licenses/BSD-3-Clause BSD 3 Clause
10		*/
11		class NodeCollection implements \Countable, \ArrayAccess, \RecursiveIterator
12		{
13		/** @var array */
14		protected $nodes = [];
15
16		/**
17		* @param iterable $nodes
18		*/
19	138	public function __construct(iterable $nodes = null) {
20	138	if (!is_iterable($nodes)) {
21	1	$nodes = [];
22		}
23
24	138	foreach ($nodes as $node) {
25	134	$this->nodes[] = $node;
26		}
27	138	}
28
29		/**
30		* @see \Countable::count()
31		*
32		* @return int
33		*/
34	76	public function count(): int {
35	76	return count($this->nodes);
36		}
37
38		/**
39		* @see \ArrayAccess::offsetExists()
40		*
41		* @param mixed $offset
42		*
43		* @return bool
44		*/
45		public function offsetExists($offset): bool {
46		return isset($this->nodes[$offset]);
47		}
48
49		/**
50		* @see \ArrayAccess::offsetGet()
51		*
52		* @param mixed $offset
53		*
54		* @return mixed
55		*/
56	20	#[\ReturnTypeWillChange]
		0 ignored issues – show Unused Code Comprehensibility introduced 2022-08-16 16:54 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
57	20	public function offsetGet($offset) {
58		return isset($this->nodes[$offset]) ? $this->nodes[$offset] : null;
59		}
60
61		/**
62		* @see \ArrayAccess::offsetSet()
63		*
64		* @param mixed $offset
65		* @param mixed $value
66	81	*/
67	81	public function offsetSet($offset, $value): void {
68	81	if (is_null($offset)) {
69		$this->nodes[] = $value;
70		} else {
71		$this->nodes[$offset] = $value;
72	81	}
73		}
74
75		/**
76		* @see \ArrayAccess::offsetUnset()
77		*
78		* @param mixed $offset
79		*/
80		public function offsetUnset($offset): void {
81		unset($this->nodes[$offset]);
82		}
83
84		/**
85		* @see \RecursiveIterator::RecursiveIteratorIterator()
86		*
87		* @return \RecursiveIteratorIterator
88		*/
89		public function getRecursiveIterator(): \RecursiveIteratorIterator {
90		return new \RecursiveIteratorIterator($this, \RecursiveIteratorIterator::SELF_FIRST);
91		}
92
93		/**
94		* @see \RecursiveIterator::getChildren()
95		*
96		* @return \RecursiveIterator
97		*/
98		public function getChildren(): \RecursiveIterator {
99		$nodes = [];
100
101		if ($this->valid()) {
102		$nodes = $this->current()->childNodes;
103		}
104
105		return new static($nodes);
106		}
107
108		/**
109		* @see \RecursiveIterator::hasChildren()
110		*
111		* @return bool
112		*/
113		public function hasChildren(): bool {
114		if ($this->valid()) {
115		return $this->current()->hasChildNodes();
116		}
117
118		return false;
119		}
120
121		/**
122		* @see \RecursiveIterator::current()
123		* @see \Iterator::current()
124		*
125		* @return mixed
126	130	*/
127	130	#[\ReturnTypeWillChange]
		0 ignored issues – show Unused Code Comprehensibility introduced 2022-08-16 16:54 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128		public function current() {
129		return current($this->nodes);
130		}
131
132		/**
133		* @see \RecursiveIterator::key()
134		* @see \Iterator::key()
135		*
136	1	* @return mixed
137	1	*/
138		#[\ReturnTypeWillChange]
		0 ignored issues – show Unused Code Comprehensibility introduced 2022-08-16 16:54 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
139		public function key() {
140		return key($this->nodes);
141		}
142
143		/**
144		* @see \RecursiveIterator::next()
145		* @see \Iterator::next()
146	130	*
147	130	* @return mixed
148		*/
149		#[\ReturnTypeWillChange]
		0 ignored issues – show Unused Code Comprehensibility introduced 2022-08-16 16:54 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
150		public function next() {
151		return next($this->nodes);
152		}
153
154		/**
155		* @see \RecursiveIterator::rewind()
156	133	* @see \Iterator::rewind()
157	133	*
158		* @return mixed
159		*/
160		#[\ReturnTypeWillChange]
		0 ignored issues – show Unused Code Comprehensibility introduced 2022-08-16 16:54 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
161		public function rewind() {
162		return reset($this->nodes);
163		}
164
165		/**
166	131	* @see \RecursiveIterator::valid()
167	131	* @see \Iterator::valid()
168		*
169		* @return bool
170		*/
171		public function valid(): bool {
172		return key($this->nodes) !== null;
173		}
174		}

scotteh / php-dom-wrapper

NodeCollection::rewind() A last analyzed 2023-09-05 13:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

NodeCollection::rewind() A
last analyzed 2023-09-05 13:23 UTC