CachingIterator::__construct() - Code Metrics - Inspection of "Add caching iterator." - gielfeldt/iterators - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dba213...74f8ff )

by Thomas

created 2017-04-26 05:12 UTC

CachingIterator::__construct() A

↳ Parent: CachingIterator

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	2

<?php

namespace Gielfeldt\Iterators;

class CachingIterator extends \ArrayIterator
{
    const CLONE_KEY = 1;
    const CLONE_CURRENT = 2;

    private $uncachedIterator;
    private $uncachedIteratorCount;
    private $modified = false;
    private $finished = false;
    private $flags;

    public function __construct(\Traversable $iterator, int $flags = self::CLONE_KEY | self::CLONE_CURRENT)
    {
        $this->flags = $flags;
        $this->uncachedIteratorCount = $iterator instanceof \Countable ? count($iterator) : null;
        $this->uncachedIterator = new IteratorIterator($iterator);
        parent::__construct();
    }

    public function count()
    {
        if (!$this->finished && !$this->modified && $this->uncachedIteratorCount !== null) {
            return $this->uncachedIteratorCount;
        }
        $this->collectRest();
        return parent::count();
    }

    private function setupInnerIterator()
    {
        if ($this->uncachedIterator->getIndex() === null) {
            $this->uncachedIterator->rewind();
            parent::rewind();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            $this->collect();            
        }
    }

    public function rewind()
    {
        $this->setupInnerIterator();
        parent::rewind();
    }

    public function next()
    {
        parent::next();
        if (!parent::valid()) {
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            $this->collect();
        }
    }

    public function offsetSet($offset, $value)
    {
        $this->collectRest();
        $this->modified = true;
        return parent::offsetSet($offset, $value);
    }

    public function collectRest($until = null)
    {
        if ($this->finished) {
            return;
        }

        $this->setupInnerIterator();

        while (!$this->finished && ($until == null || $until >= $this->uncachedIterator->getIndex())) {
            $this->collect();
        }
    }

    public function collect()
    {
        if ($this->uncachedIterator->valid()) {
            $key = $this->uncachedIterator->key();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $key = ($this->flags & self::CLONE_KEY) && is_object($key) ? clone $key : $key;
            $current = $this->uncachedIterator->current();
            $current = ($this->flags & self::CLONE_CURRENT) && is_object($current) ? clone $current : $current;
            parent::offsetSet($key, $current);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            $this->uncachedIterator->next();
        }
        else {
            $this->finished = true;
        }
    }

    // Ensure entire inner iterator is collected before applying the follwing.
    public function seek($pos) {
        $this->collectRest($pos);
        return parent::seek($pos);
    }

    public function offsetGet($offset)
    {
        $this->collectRest();
        return parent::offsetGet($offset);
    }

    public function offsetExists($offset)
    {
        $this->collectRest();
        return parent::offsetExists($offset);
    }

    public function offsetUnset($offset)
    {
        $this->collectRest();
        $this->modified = true;
        return parent::offsetUnset($offset);
    }

    public function getArrayCopy()
    {
        $this->collectRest();
        return iterator_to_array($this);
    }

    public function ksort()
    {
        $this->collectRest();
        return parent::ksort();
    }
    public function natcasesort()
    {
        $this->collectRest();
        return parent::natcasesort();
    }
    public function natsort()
    {
        $this->collectRest();
        return parent::natsort();
    }
    public function uasort($cmp)
    {
        $this->collectRest();
        return parent::uasort($cmp);
    }
    public function uksort($cmp)
    {
        $this->collectRest();
        return parent::uksort($cmp);
    }
    public function serialize()
    {
        $this->collectRest();
        $serialized = "x:i:0;";
        $serialized .= serialize($this->getArrayCopy()) . ";";
        $serialized .= "m:a:0:{}";
        return $serialized;
    }
    public function unserialize($serialized)
    {
        $this->finished = true;
        $this->modified = false;
        $this->innerIterator = null;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->innerIteratorCount = null;

        return parent::unserialize($serialized);
    }

}


1			<?php
2
3			namespace Gielfeldt\Iterators;
4
5			class CachingIterator extends \ArrayIterator
6			{
7			const CLONE_KEY = 1;
8			const CLONE_CURRENT = 2;
9
10			private $uncachedIterator;
11			private $uncachedIteratorCount;
12			private $modified = false;
13			private $finished = false;
14			private $flags;
15
16			public function __construct(\Traversable $iterator, int $flags = self::CLONE_KEY \| self::CLONE_CURRENT)
17			{
18			$this->flags = $flags;
19			$this->uncachedIteratorCount = $iterator instanceof \Countable ? count($iterator) : null;
20			$this->uncachedIterator = new IteratorIterator($iterator);
21			parent::__construct();
22			}
23
24			public function count()
25			{
26			if (!$this->finished && !$this->modified && $this->uncachedIteratorCount !== null) {
27			return $this->uncachedIteratorCount;
28			}
29			$this->collectRest();
30			return parent::count();
31			}
32
33			private function setupInnerIterator()
34			{
35			if ($this->uncachedIterator->getIndex() === null) {
36			$this->uncachedIterator->rewind();
37			parent::rewind();
			0 ignored issues – show Comprehensibility Bug introduced 2017-04-26 05:14 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`rewind()` instead of `setupInnerIterator()`). Are you sure this is correct? If so, you might want to change this to `$this->rewind()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
38			$this->collect();
39			}
40			}
41
42			public function rewind()
43			{
44			$this->setupInnerIterator();
45			parent::rewind();
46			}
47
48			public function next()
49			{
50			parent::next();
51			if (!parent::valid()) {
			0 ignored issues – show Comprehensibility Bug introduced 2017-04-23 08:41 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`valid()` instead of `next()`). Are you sure this is correct? If so, you might want to change this to `$this->valid()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
52			$this->collect();
53			}
54			}
55
56			public function offsetSet($offset, $value)
57			{
58			$this->collectRest();
59			$this->modified = true;
60			return parent::offsetSet($offset, $value);
61			}
62
63			public function collectRest($until = null)
64			{
65			if ($this->finished) {
66			return;
67			}
68
69			$this->setupInnerIterator();
70
71			while (!$this->finished && ($until == null \|\| $until >= $this->uncachedIterator->getIndex())) {
72			$this->collect();
73			}
74			}
75
76			public function collect()
77			{
78			if ($this->uncachedIterator->valid()) {
79			$key = $this->uncachedIterator->key();
			0 ignored issues – show Bug introduced 2017-04-26 05:14 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$key` is correct as `$this->uncachedIterator->key()` (which targets `IteratorIterator::key()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
80			$key = ($this->flags & self::CLONE_KEY) && is_object($key) ? clone $key : $key;
81			$current = $this->uncachedIterator->current();
82			$current = ($this->flags & self::CLONE_CURRENT) && is_object($current) ? clone $current : $current;
83			parent::offsetSet($key, $current);
			0 ignored issues – show Comprehensibility Bug introduced 2017-04-26 05:14 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `collect()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
84			$this->uncachedIterator->next();
85			}
86			else {
87			$this->finished = true;
88			}
89			}
90
91			// Ensure entire inner iterator is collected before applying the follwing.
92			public function seek($pos) {
93			$this->collectRest($pos);
94			return parent::seek($pos);
95			}
96
97			public function offsetGet($offset)
98			{
99			$this->collectRest();
100			return parent::offsetGet($offset);
101			}
102
103			public function offsetExists($offset)
104			{
105			$this->collectRest();
106			return parent::offsetExists($offset);
107			}
108
109			public function offsetUnset($offset)
110			{
111			$this->collectRest();
112			$this->modified = true;
113			return parent::offsetUnset($offset);
114			}
115
116			public function getArrayCopy()
117			{
118			$this->collectRest();
119			return iterator_to_array($this);
120			}
121
122			public function ksort()
123			{
124			$this->collectRest();
125			return parent::ksort();
126			}
127			public function natcasesort()
128			{
129			$this->collectRest();
130			return parent::natcasesort();
131			}
132			public function natsort()
133			{
134			$this->collectRest();
135			return parent::natsort();
136			}
137			public function uasort($cmp)
138			{
139			$this->collectRest();
140			return parent::uasort($cmp);
141			}
142			public function uksort($cmp)
143			{
144			$this->collectRest();
145			return parent::uksort($cmp);
146			}
147			public function serialize()
148			{
149			$this->collectRest();
150			$serialized = "x:i:0;";
151			$serialized .= serialize($this->getArrayCopy()) . ";";
152			$serialized .= "m:a:0:{}";
153			return $serialized;
154			}
155			public function unserialize($serialized)
156			{
157			$this->finished = true;
158			$this->modified = false;
159			$this->innerIterator = null;
			0 ignored issues – show Bug introduced 2017-04-26 05:14 UTC by Report Bug Copy Issue Report The property `innerIterator` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
160			$this->innerIteratorCount = null;
			0 ignored issues – show Bug introduced 2017-04-26 05:14 UTC by Report Bug Copy Issue Report The property `innerIteratorCount` does not seem to exist. Did you mean `innerIterator`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
161			return parent::unserialize($serialized);
162			}
163
164			}
165

gielfeldt / iterators

GitHub Access Token became invalid

Push — master ( dba213...74f8ff )

CachingIterator::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like