AlterableResultIterator::getIterator() - Code Metrics - thecodingmachine/database.tdbm - Measure and Improve Code Quality continuously with Scrutinizer

AlterableResultIterator::getIterator() A
last analyzed 2017-03-17 15:59 UTC

↳ Parent: AlterableResultIterator

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	3
nop	0

<?php

namespace Mouf\Database\TDBM;

use Porpaginas\Arrays\ArrayPage;
use Porpaginas\Iterator;
use Porpaginas\Result;

/**
 * This class acts as a wrapper around a result iterator.
 * It can be used to add or remove results from a ResultIterator (or any kind a traversable collection).
 *
 * Note: in the case of TDBM, this is useful to manage many to one relationships
 */
class AlterableResultIterator implements Result, \ArrayAccess, \JsonSerializable
{
    /**
     * @var \Iterator|null
     */
    private $resultIterator;

    /**
     * Key: the object to alter in the result set.
     * Value: "add" => the object will be added to the resultset (if it is not found in it)
     *        "delete" => the object will be removed from the resultset (if found).
     *
     * @var \SplObjectStorage
     */
    private $alterations;

    /**
     * The result array from the result set.
     *
     * @var array|null
     */
    private $resultArray;

    /**
     * @param \Iterator|null $resultIterator
     */
    public function __construct(\Iterator $resultIterator = null)
    {
        $this->resultIterator = $resultIterator;
        $this->alterations = new \SplObjectStorage();
    }

    /**
     * Sets a new iterator as the base iterator to be altered.
     *
     * @param \Iterator $resultIterator
     */
    public function setResultIterator(\Iterator $resultIterator)
    {
        $this->resultIterator = $resultIterator;
        $this->resultArray = null;
    }

    /**
     * Returns the non altered result iterator (or null if none exist).
     *
     * @return \Iterator|null
     */
    public function getUnderlyingResultIterator()
    {
        return $this->resultIterator;
    }

    /**
     * Adds an additional object to the result set (if not already available).
     *
     * @param $object
     */
    public function add($object)

    {
        $this->alterations->attach($object, 'add');

        if ($this->resultArray !== null) {
            $foundKey = array_search($object, $this->resultArray, true);
            if ($foundKey === false) {
                $this->resultArray[] = $object;
            }
        }
    }

    /**
     * Removes an object from the result set.
     *
     * @param $object
     */
    public function remove($object)

    {
        $this->alterations->attach($object, 'delete');

        if ($this->resultArray !== null) {
            $foundKey = array_search($object, $this->resultArray, true);
            if ($foundKey !== false) {
                unset($this->resultArray[$foundKey]);
            }
        }
    }

    /**
     * Casts the result set to a PHP array.
     *
     * @return array
     */
    public function toArray()
    {
        if ($this->resultArray === null) {
            if ($this->resultIterator !== null) {
                $this->resultArray = iterator_to_array($this->resultIterator);
            } else {
                $this->resultArray = [];
            }

            foreach ($this->alterations as $obj) {
                $action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL

                $foundKey = array_search($obj, $this->resultArray, true);

                if ($action === 'add' && $foundKey === false) {
                    $this->resultArray[] = $obj;
                } elseif ($action === 'delete' && $foundKey !== false) {
                    unset($this->resultArray[$foundKey]);
                }
            }
        }

        return array_values($this->resultArray);
    }

    /**
     * Whether a offset exists.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param mixed $offset <p>
     *                      An offset to check for.
     *                      </p>
     *
     * @return bool true on success or false on failure.
     *              </p>
     *              <p>
     *              The return value will be casted to boolean if non-boolean was returned
     *
     * @since 5.0.0
     */
    public function offsetExists($offset)
    {
        return isset($this->toArray()[$offset]);
    }

    /**
     * Offset to retrieve.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param mixed $offset <p>
     *                      The offset to retrieve.
     *                      </p>
     *
     * @return mixed Can return all value types
     *
     * @since 5.0.0
     */
    public function offsetGet($offset)
    {
        return $this->toArray()[$offset];
    }

    /**
     * Offset to set.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param mixed $offset <p>
     *                      The offset to assign the value to.
     *                      </p>
     * @param mixed $value  <p>
     *                      The value to set.
     *                      </p>
     *
     * @since 5.0.0
     */
    public function offsetSet($offset, $value)
    {
        throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.');
    }

    /**
     * Offset to unset.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
     *
     * @param mixed $offset <p>
     *                      The offset to unset.
     *                      </p>
     *
     * @since 5.0.0
     */
    public function offsetUnset($offset)
    {
        throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.');
    }

    /**
     * @param int $offset
     *
     * @return \Porpaginas\Page
     */
    public function take($offset, $limit)
    {
        // TODO: replace this with a class implementing the map method.
        return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
    }

    /**
     * Return the number of all results in the paginatable.
     *
     * @return int
     */
    public function count()
    {
        return count($this->toArray());
    }

    /**
     * Return an iterator over all results of the paginatable.
     *
     * @return Iterator
     */
    public function getIterator()
    {
        if ($this->alterations->count() === 0) {
            if ($this->resultIterator !== null) {
                return $this->resultIterator;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            } else {
                return new \ArrayIterator([]);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            }
        } else {
            return new \ArrayIterator($this->toArray());
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * Specify data which should be serialized to JSON.
     *
     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
     *
     * @return mixed data which can be serialized by <b>json_encode</b>,
     *               which is a value of any type other than a resource
     *
     * @since 5.4.0
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Returns only one value (the first) of the result set.
     * Returns null if no value exists.
     *
     * @return mixed|null
     */
    public function first()
    {
        $page = $this->take(0, 1);
        foreach ($page as $bean) {
            return $bean;
        }

        return;
    }

    /**
     * Returns a new iterator mapping any call using the $callable function.
     *
     * @param callable $callable
     *
     * @return MapIterator
     */
    public function map(callable $callable)
    {
        return new MapIterator($this->getIterator(), $callable);
    }
}


1		<?php
2
3		namespace Mouf\Database\TDBM;
4
5		use Porpaginas\Arrays\ArrayPage;
6		use Porpaginas\Iterator;
7		use Porpaginas\Result;
8
9		/**
10		* This class acts as a wrapper around a result iterator.
11		* It can be used to add or remove results from a ResultIterator (or any kind a traversable collection).
12		*
13		* Note: in the case of TDBM, this is useful to manage many to one relationships
14		*/
15		class AlterableResultIterator implements Result, \ArrayAccess, \JsonSerializable
16		{
17		/**
18		* @var \Iterator\|null
19		*/
20		private $resultIterator;
21
22		/**
23		* Key: the object to alter in the result set.
24		* Value: "add" => the object will be added to the resultset (if it is not found in it)
25		* "delete" => the object will be removed from the resultset (if found).
26		*
27		* @var \SplObjectStorage
28		*/
29		private $alterations;
30
31		/**
32		* The result array from the result set.
33		*
34		* @var array\|null
35		*/
36		private $resultArray;
37
38		/**
39		* @param \Iterator\|null $resultIterator
40		*/
41		public function __construct(\Iterator $resultIterator = null)
42		{
43		$this->resultIterator = $resultIterator;
44		$this->alterations = new \SplObjectStorage();
45		}
46
47		/**
48		* Sets a new iterator as the base iterator to be altered.
49		*
50		* @param \Iterator $resultIterator
51		*/
52		public function setResultIterator(\Iterator $resultIterator)
53		{
54		$this->resultIterator = $resultIterator;
55		$this->resultArray = null;
56		}
57
58		/**
59		* Returns the non altered result iterator (or null if none exist).
60		*
61		* @return \Iterator\|null
62		*/
63		public function getUnderlyingResultIterator()
64		{
65		return $this->resultIterator;
66		}
67
68		/**
69		* Adds an additional object to the result set (if not already available).
70		*
71		* @param $object
72		*/
73	View Code Duplication	public function add($object)
		0 ignored issues – show Duplication introduced 2016-09-20 09:15 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...
74		{
75		$this->alterations->attach($object, 'add');
76
77		if ($this->resultArray !== null) {
78		$foundKey = array_search($object, $this->resultArray, true);
79		if ($foundKey === false) {
80		$this->resultArray[] = $object;
81		}
82		}
83		}
84
85		/**
86		* Removes an object from the result set.
87		*
88		* @param $object
89		*/
90	View Code Duplication	public function remove($object)
		0 ignored issues – show Duplication introduced 2016-09-20 09:15 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...
91		{
92		$this->alterations->attach($object, 'delete');
93
94		if ($this->resultArray !== null) {
95		$foundKey = array_search($object, $this->resultArray, true);
96		if ($foundKey !== false) {
97		unset($this->resultArray[$foundKey]);
98		}
99		}
100		}
101
102		/**
103		* Casts the result set to a PHP array.
104		*
105		* @return array
106		*/
107		public function toArray()
108		{
109		if ($this->resultArray === null) {
110		if ($this->resultIterator !== null) {
111		$this->resultArray = iterator_to_array($this->resultIterator);
112		} else {
113		$this->resultArray = [];
114		}
115
116		foreach ($this->alterations as $obj) {
117		$action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL
118
119		$foundKey = array_search($obj, $this->resultArray, true);
120
121		if ($action === 'add' && $foundKey === false) {
122		$this->resultArray[] = $obj;
123		} elseif ($action === 'delete' && $foundKey !== false) {
124		unset($this->resultArray[$foundKey]);
125		}
126		}
127		}
128
129		return array_values($this->resultArray);
130		}
131
132		/**
133		* Whether a offset exists.
134		*
135		* @link http://php.net/manual/en/arrayaccess.offsetexists.php
136		*
137		* @param mixed $offset <p>
138		* An offset to check for.
139		* </p>
140		*
141		* @return bool true on success or false on failure.
142		* </p>
143		* <p>
144		* The return value will be casted to boolean if non-boolean was returned
145		*
146		* @since 5.0.0
147		*/
148		public function offsetExists($offset)
149		{
150		return isset($this->toArray()[$offset]);
151		}
152
153		/**
154		* Offset to retrieve.
155		*
156		* @link http://php.net/manual/en/arrayaccess.offsetget.php
157		*
158		* @param mixed $offset <p>
159		* The offset to retrieve.
160		* </p>
161		*
162		* @return mixed Can return all value types
163		*
164		* @since 5.0.0
165		*/
166		public function offsetGet($offset)
167		{
168		return $this->toArray()[$offset];
169		}
170
171		/**
172		* Offset to set.
173		*
174		* @link http://php.net/manual/en/arrayaccess.offsetset.php
175		*
176		* @param mixed $offset <p>
177		* The offset to assign the value to.
178		* </p>
179		* @param mixed $value <p>
180		* The value to set.
181		* </p>
182		*
183		* @since 5.0.0
184		*/
185		public function offsetSet($offset, $value)
186		{
187		throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.');
188		}
189
190		/**
191		* Offset to unset.
192		*
193		* @link http://php.net/manual/en/arrayaccess.offsetunset.php
194		*
195		* @param mixed $offset <p>
196		* The offset to unset.
197		* </p>
198		*
199		* @since 5.0.0
200		*/
201		public function offsetUnset($offset)
202		{
203		throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.');
204		}
205
206		/**
207		* @param int $offset
208		*
209		* @return \Porpaginas\Page
210		*/
211		public function take($offset, $limit)
212		{
213		// TODO: replace this with a class implementing the map method.
214		return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
215		}
216
217		/**
218		* Return the number of all results in the paginatable.
219		*
220		* @return int
221		*/
222		public function count()
223		{
224		return count($this->toArray());
225		}
226
227		/**
228		* Return an iterator over all results of the paginatable.
229		*
230		* @return Iterator
231		*/
232		public function getIterator()
233		{
234		if ($this->alterations->count() === 0) {
235		if ($this->resultIterator !== null) {
236		return $this->resultIterator;
		0 ignored issues – show Bug Best Practice introduced 2016-09-20 09:15 UTC by Report Bug Copy Issue Report The return type of `return $this->resultIterator;` (`Iterator`) is incompatible with the return type declared by the interface `Porpaginas\Result::getIterator` of type `Porpaginas\Iterator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
237		} else {
238		return new \ArrayIterator([]);
		0 ignored issues – show Bug Best Practice introduced 2016-09-20 09:15 UTC by Report Bug Copy Issue Report The return type of `return new \ArrayIterator(array());` (`ArrayIterator`) is incompatible with the return type declared by the interface `Porpaginas\Result::getIterator` of type `Porpaginas\Iterator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
239		}
240		} else {
241		return new \ArrayIterator($this->toArray());
		0 ignored issues – show Bug Best Practice introduced 2016-09-20 09:15 UTC by Report Bug Copy Issue Report The return type of `return new \ArrayIterator($this->toArray());` (`ArrayIterator`) is incompatible with the return type declared by the interface `Porpaginas\Result::getIterator` of type `Porpaginas\Iterator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
242		}
243		}
244
245		/**
246		* Specify data which should be serialized to JSON.
247		*
248		* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
249		*
250		* @return mixed data which can be serialized by <b>json_encode</b>,
251		* which is a value of any type other than a resource
252		*
253		* @since 5.4.0
254		*/
255		public function jsonSerialize()
256		{
257		return $this->toArray();
258		}
259
260		/**
261		* Returns only one value (the first) of the result set.
262		* Returns null if no value exists.
263		*
264		* @return mixed\|null
265		*/
266		public function first()
267		{
268		$page = $this->take(0, 1);
269		foreach ($page as $bean) {
270		return $bean;
271		}
272
273		return;
274		}
275
276		/**
277		* Returns a new iterator mapping any call using the $callable function.
278		*
279		* @param callable $callable
280		*
281		* @return MapIterator
282		*/
283		public function map(callable $callable)
284		{
285		return new MapIterator($this->getIterator(), $callable);
286		}
287		}
288

thecodingmachine / database.tdbm

AlterableResultIterator::getIterator() A last analyzed 2017-03-17 15:59 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AlterableResultIterator::getIterator() A
last analyzed 2017-03-17 15:59 UTC