ArrayManager - Code Metrics - Inspection of "Merge branch 'master' into TEST/ScrutinizerPHPAnal..." - julien-boudry/Condorcet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — TEST/ScrutinizerPHPAnalysisEng... ( bc3f13...c9e065 )

by Boudry

created 2018-01-14 14:26 UTC

ArrayManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	350
Duplicated Lines	0 %

Test Coverage

Coverage

85.45%

Importance

Changes

Metric	Value
wmc	3
dl	0
loc	350
ccs	141
cts	165
cp	0.8545
rs	10
c	0
b	0
f	0

35 Methods

Rating	Name	Size	Complexity
A	__construct()	1	1
A	__destruct()	3	1
A	debugGetCache()	3	1
A	setCursorOnNextKeyInArray()	7	2
A	getContainerSize()	3	1
A	checkRegularize()	7	3
A	regularize()	8	3
	getDataContextObject()	11	?
A	offsetExists()	3	4
A	next()	15	4
A	__clone()	3	1
A	getFullDataSet()	5	2
A	key()	6	3
A	__sleep()	7	1
A	current()	2	1
A	offsetUnset()	15	3
A	getFirstKey()	9	2
A	__wakeup()	4	1
A	hp$0 ➔ dataCallBack()	3	1
A	valid()	2	1
A	isUsingHandler()	3	1
A	resetCounter()	3	2
A	importHandler()	21	3
A	resetMaxKey()	12	4
A	clearCache()	5	1
A	rewind()	6	1
B	offsetSet()	25	5
A	count()	2	1
B	offsetGet()	13	5
A	getCacheSize()	3	1
A	hp$0 ➔ dataPrepareStoringAndFormat()	3	1
A	hp$0 ➔ getDataContextObject()	11	1
A	populateCache()	12	4
A	keyExist()	6	4
A	closeHandler()	12	2

<?php
/*
    Condorcet PHP Class, with Schulze Methods and others !

    By Julien Boudry - MIT LICENSE (Please read LICENSE.txt)
    https://github.com/julien-boudry/Condorcet
*/
declare(strict_types=1);


namespace Condorcet\DataManager;

use Condorcet\DataManager\DataContextInterface;
use Condorcet\DataManager\DataHandlerDrivers\DataHandlerDriverInterface;
use Condorcet\CondorcetException;
use Condorcet\CondorcetVersion;

abstract class ArrayManager implements \ArrayAccess, \Countable, \Iterator
{
    use CondorcetVersion;

        //////

    public static $CacheSize = 2000;
    public static $MaxContainerLength = 2000;

    protected $_Container = [];
    protected $_DataHandler = null;
    protected $_link = [];

    protected $_Cache = [];
    protected $_CacheMaxKey = 0;
    protected $_CacheMinKey = 0;

    protected $_cursor = null;
    protected $_counter = 0;
    protected $_maxKey = -1;

    public function __construct () {}

    public function __destruct ()
    {
        $this->regularize();
    }

    public function __clone ()
    {
        $this->_link = [];
    }

    public function __sleep () : array
    {
        $this->regularize();
        $this->clearCache();
        $this->rewind();

        return ['_Container','_DataHandler','_link'];
    }

    public function __wakeup ()
    {
        $this->resetMaxKey();
        $this->resetCounter();
    }


/////////// Implement ArrayAccess ///////////

    public function offsetSet($offset, $value) : void
    {
        if ($offset === null) :
            $this->_Container[++$this->_maxKey] = $value;
            ++$this->_counter;
        else :
            $state = !$this->keyExist($offset);
            $this->_Container[$offset] = $value;

            if ($state) :
                ++$this->_counter;

                if ($offset > $this->_maxKey) :
                    $this->_maxKey = $offset;
                endif;

                ksort($this->_Container,SORT_NUMERIC);
            elseif ($this->_DataHandler !== null) :
                $this->_DataHandler->deleteOneEntity($offset, true);
            endif;

            $this->clearCache();
        endif;

        $this->checkRegularize();
    }

    // Use by isset() function, must return false if offset value is null.
    public function offsetExists($offset) : bool
    {
        return ( isset($this->_Container[$offset]) || ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) ? true : false ;
    }

    public function offsetUnset($offset) : bool
    {
        if ($this->keyExist($offset)) :
            if (array_key_exists($offset, $this->_Container)) :
                unset($this->_Container[$offset]);
            else :
                unset($this->_Cache[$offset]);

                $this->_DataHandler->deleteOneEntity($offset, false);
            endif;

            --$this->_counter;
            return true;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        else :
            return false;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        endif;
    }

    public function offsetGet($offset)
    {
        if (isset($this->_Container[$offset])) :
            return $this->_Container[$offset];
        elseif ($this->_DataHandler !== null) :
            if (array_key_exists($offset, $this->_Cache)) :
                return $this->_Cache[$offset];
            else :
                $query = $this->_DataHandler->selectOneEntity($offset);
                return ($query === false) ? null : $query;
            endif;
        else :
            return null;
        endif;
    }


/////////// Implement Iterator ///////////

    protected $valid = true;

    public function rewind() : void {
        $this->_cursor = null;
        $this->valid = true;

        reset($this->_Cache);
        reset($this->_Container);
    }

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

    public function key() : ?int
    {
        if ($this->_counter === 0) :
            return null;
        else :
            return ($this->_cursor === null) ? $this->getFirstKey() : $this->_cursor;
        endif;
    }

    public function next() : void
    {
        $oldCursor = $this->_cursor;

        if ($this->_cursor >= $this->_maxKey) :
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            // Do nothing
        elseif (!$this->isUsingHandler()) :
            $this->setCursorOnNextKeyInArray($this->_Container);
        else :
            $this->populateCache();
            $this->setCursorOnNextKeyInArray($this->_Cache);
        endif;

        if ($this->_cursor === $oldCursor) :
            $this->valid = false;
        endif;
    }

        protected function setCursorOnNextKeyInArray (array &$array)
        {
            next($array);
            $arrayKey = key($array);

            if ($arrayKey > $this->key()) :
                return $this->_cursor = $arrayKey;
            endif;
        }

    public function valid() : bool {
        return $this->valid;
    }


/////////// Implement Countable ///////////

    public function count () : int {
        return $this->_counter;
    }

/////////// Array Methods ///////////

    public function getFullDataSet () : array
    {
        $this->regularize();

        return (!$this->isUsingHandler()) ? $this->_Container : $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);
    }

    public function keyExist ($offset) : bool
    {
        if ( array_key_exists($offset, $this->_Container) || ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) :
            return true;
        else  :
            return false;
        endif;
    }

    public function getFirstKey () : int
    {
        $r = array_keys($this->_Container);

        if ($this->_DataHandler !== null) :
            $r[] = $this->_DataHandler->selectMinKey();
        endif;

        return (int) min($r);
    }

    public function getContainerSize () : int
    {
        return count($this->_Container);
    }

    public function getCacheSize () : int
    {
        return count($this->_Cache);
    }

    public function debugGetCache () : array
    {
        return $this->_Cache;
    }


/////////// HANDLER API ///////////

    public function regularize () : bool
    {
        if (!$this->isUsingHandler() || empty($this->_Container)) :
            return false;
        else :
            $this->_DataHandler->insertEntitys($this->_Container);
            $this->_Container = [];
            return true;
        endif;
    }

    public function checkRegularize () : bool
    {
        if ( $this->_DataHandler !== null && self::$MaxContainerLength <= $this->getContainerSize() ) :
            $this->regularize();
            return true;
        else :
            return false;
        endif;
    }

    protected function populateCache () : void
    {
        $this->regularize();

        $currentKey = $this->key();

        if ( empty($this->_Cache) || $currentKey >= $this->_CacheMaxKey || $currentKey < $this->_CacheMinKey ) :
            $this->_Cache = $this->_DataHandler->selectRangeEntitys($currentKey, self::$CacheSize);

            $keys = array_keys($this->_Cache);
            $this->_CacheMaxKey = max($keys);
            $this->_CacheMinKey = min($keys);
        endif;
    }

    public function clearCache () : void
    {
        $this->_Cache = [];
        $this->_CacheMaxKey = 0;
        $this->_CacheMinKey = 0;
    }

    public function isUsingHandler ()
    {
        return $this->_DataHandler !== null;
    }

/////////// HANDLER INTERRACTION ///////////

    public function resetCounter () : int
    {
        return $this->_counter = $this->getContainerSize() + ( ($this->isUsingHandler()) ? $this->_DataHandler->countEntitys() : 0 );
    }

    public function resetMaxKey () : ?int
    {
        $this->resetCounter();

        if ($this->count() < 1) :
            $this->_maxKey = -1;
            return null;
        else :
            $maxContainerKey = (empty($this->_Container)) ? null : max(array_keys($this->_Container));
            $maxHandlerKey = ($this->_DataHandler !== null) ? $this->_DataHandler->selectMaxKey() : null;

            return $this->_maxKey = max( $maxContainerKey,$maxHandlerKey );
        endif;
    }

    public function importHandler (DataHandlerDriverInterface $handler) : bool
    {
        if ($handler->countEntitys() === 0) :
            $this->_DataHandler = $handler;
            $this->_DataHandler->_dataContextObject = $this->getDataContextObject();


            try {
                $this->regularize();
            } catch (\Exception $e) {
                $this->_DataHandler = null;
                $this->resetCounter();
                $this->resetMaxKey();
                throw $e;
            }

            $this->resetCounter();
            $this->resetMaxKey();

            return true;
        else :
            throw new CondorcetException;
        endif;
    }

    public function closeHandler () : void
    {
        if ($this->_DataHandler !== null) :
            $this->regularize();
            $this->clearCache();

            $this->_Container = $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);

            $this->_DataHandler = null;

            $this->resetCounter();
            $this->resetMaxKey();
        endif;
    }

    public function getDataContextObject () : DataContextInterface
    {
        return new Class implements DataContextInterface {
            public function dataCallBack ($data)
            {
                return $data;
            }

            public function dataPrepareStoringAndFormat ($data)
            {
                return $data;
            }
        };
    }
}


1		<?php
2		/*
3		Condorcet PHP Class, with Schulze Methods and others !
4
5		By Julien Boudry - MIT LICENSE (Please read LICENSE.txt)
6		https://github.com/julien-boudry/Condorcet
7		*/
8		declare(strict_types=1);
9
10
11		namespace Condorcet\DataManager;
12
13		use Condorcet\DataManager\DataContextInterface;
14		use Condorcet\DataManager\DataHandlerDrivers\DataHandlerDriverInterface;
15		use Condorcet\CondorcetException;
16		use Condorcet\CondorcetVersion;
17
18		abstract class ArrayManager implements \ArrayAccess, \Countable, \Iterator
19		{
20		use CondorcetVersion;
21
22		//////
23
24		public static $CacheSize = 2000;
25		public static $MaxContainerLength = 2000;
26
27		protected $_Container = [];
28		protected $_DataHandler = null;
29		protected $_link = [];
30
31		protected $_Cache = [];
32		protected $_CacheMaxKey = 0;
33		protected $_CacheMinKey = 0;
34
35		protected $_cursor = null;
36		protected $_counter = 0;
37		protected $_maxKey = -1;
38
39		public function __construct () {}
40
41	1	public function __destruct ()
42		{
43	1	$this->regularize();
44	1	}
45
46	1	public function __clone ()
47		{
48	1	$this->_link = [];
49	1	}
50
51	2	public function __sleep () : array
52		{
53	2	$this->regularize();
54	2	$this->clearCache();
55	2	$this->rewind();
56
57	2	return ['_Container','_DataHandler','_link'];
58		}
59
60	1	public function __wakeup ()
61		{
62	1	$this->resetMaxKey();
63	1	$this->resetCounter();
64	1	}
65
66
67		/////////// Implement ArrayAccess ///////////
68
69	100	public function offsetSet($offset, $value) : void
70		{
71	100	if ($offset === null) :
72	100	$this->_Container[++$this->_maxKey] = $value;
73	100	++$this->_counter;
74		else :
75		$state = !$this->keyExist($offset);
76		$this->_Container[$offset] = $value;
77
78		if ($state) :
79		++$this->_counter;
80
81		if ($offset > $this->_maxKey) :
82		$this->_maxKey = $offset;
83		endif;
84
85		ksort($this->_Container,SORT_NUMERIC);
86		elseif ($this->_DataHandler !== null) :
87		$this->_DataHandler->deleteOneEntity($offset, true);
88		endif;
89
90		$this->clearCache();
91		endif;
92
93	100	$this->checkRegularize();
94	100	}
95
96		// Use by isset() function, must return false if offset value is null.
97		public function offsetExists($offset) : bool
98		{
99		return ( isset($this->_Container[$offset]) \|\| ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) ? true : false ;
100		}
101
102	7	public function offsetUnset($offset) : bool
103		{
104	7	if ($this->keyExist($offset)) :
105	7	if (array_key_exists($offset, $this->_Container)) :
106	7	unset($this->_Container[$offset]);
107		else :
108	1	unset($this->_Cache[$offset]);
109
110	1	$this->_DataHandler->deleteOneEntity($offset, false);
111		endif;
112
113	7	--$this->_counter;
114	7	return true;
		0 ignored issues – show Bug Best Practice introduced 2018-01-08 17:22 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the return type mandated by `ArrayAccess::offsetUnset()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
115		else :
116	1	return false;
		0 ignored issues – show Bug Best Practice introduced 2018-01-08 17:22 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the return type mandated by `ArrayAccess::offsetUnset()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
117		endif;
118		}
119
120	83	public function offsetGet($offset)
121		{
122	83	if (isset($this->_Container[$offset])) :
123	83	return $this->_Container[$offset];
124	2	elseif ($this->_DataHandler !== null) :
125	2	if (array_key_exists($offset, $this->_Cache)) :
126	2	return $this->_Cache[$offset];
127		else :
128	2	$query = $this->_DataHandler->selectOneEntity($offset);
129	2	return ($query === false) ? null : $query;
130		endif;
131		else :
132		return null;
133		endif;
134		}
135
136
137		/////////// Implement Iterator ///////////
138
139		protected $valid = true;
140
141	82	public function rewind() : void {
142	82	$this->_cursor = null;
143	82	$this->valid = true;
144
145	82	reset($this->_Cache);
146	82	reset($this->_Container);
147	82	}
148
149	82	public function current() {
150	82	return $this->offsetGet($this->key());
151		}
152
153	82	public function key() : ?int
154		{
155	82	if ($this->_counter === 0) :
156		return null;
157		else :
158	82	return ($this->_cursor === null) ? $this->getFirstKey() : $this->_cursor;
159		endif;
160		}
161
162	82	public function next() : void
163		{
164	82	$oldCursor = $this->_cursor;
165
166	82	if ($this->_cursor >= $this->_maxKey) :
		1 ignored issue – show Unused Code introduced 2018-01-08 14:18 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
167		// Do nothing
168	70	elseif (!$this->isUsingHandler()) :
169	69	$this->setCursorOnNextKeyInArray($this->_Container);
170		else :
171	2	$this->populateCache();
172	2	$this->setCursorOnNextKeyInArray($this->_Cache);
173		endif;
174
175	82	if ($this->_cursor === $oldCursor) :
176	82	$this->valid = false;
177		endif;
178	82	}
179
180	70	protected function setCursorOnNextKeyInArray (array &$array)
181		{
182	70	next($array);
183	70	$arrayKey = key($array);
184
185	70	if ($arrayKey > $this->key()) :
186	70	return $this->_cursor = $arrayKey;
187		endif;
188	2	}
189
190	82	public function valid() : bool {
191	82	return $this->valid;
192		}
193
194
195		/////////// Implement Countable ///////////
196
197	10	public function count () : int {
198	10	return $this->_counter;
199		}
200
201		/////////// Array Methods ///////////
202
203	15	public function getFullDataSet () : array
204		{
205	15	$this->regularize();
206
207	15	return (!$this->isUsingHandler()) ? $this->_Container : $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);
208		}
209
210	7	public function keyExist ($offset) : bool
211		{
212	7	if ( array_key_exists($offset, $this->_Container) \|\| ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) :
213	7	return true;
214		else :
215	1	return false;
216		endif;
217		}
218
219	82	public function getFirstKey () : int
220		{
221	82	$r = array_keys($this->_Container);
222
223	82	if ($this->_DataHandler !== null) :
224	2	$r[] = $this->_DataHandler->selectMinKey();
225		endif;
226
227	82	return (int) min($r);
228		}
229
230	4	public function getContainerSize () : int
231		{
232	4	return count($this->_Container);
233		}
234
235	1	public function getCacheSize () : int
236		{
237	1	return count($this->_Cache);
238		}
239
240	1	public function debugGetCache () : array
241		{
242	1	return $this->_Cache;
243		}
244
245
246		/////////// HANDLER API ///////////
247
248	17	public function regularize () : bool
249		{
250	17	if (!$this->isUsingHandler() \|\| empty($this->_Container)) :
251	17	return false;
252		else :
253	3	$this->_DataHandler->insertEntitys($this->_Container);
254	3	$this->_Container = [];
255	3	return true;
256		endif;
257		}
258
259	100	public function checkRegularize () : bool
260		{
261	100	if ( $this->_DataHandler !== null && self::$MaxContainerLength <= $this->getContainerSize() ) :
262	1	$this->regularize();
263	1	return true;
264		else :
265	100	return false;
266		endif;
267		}
268
269	2	protected function populateCache () : void
270		{
271	2	$this->regularize();
272
273	2	$currentKey = $this->key();
274
275	2	if ( empty($this->_Cache) \|\| $currentKey >= $this->_CacheMaxKey \|\| $currentKey < $this->_CacheMinKey ) :
276	2	$this->_Cache = $this->_DataHandler->selectRangeEntitys($currentKey, self::$CacheSize);
277
278	2	$keys = array_keys($this->_Cache);
279	2	$this->_CacheMaxKey = max($keys);
280	2	$this->_CacheMinKey = min($keys);
281		endif;
282	2	}
283
284	3	public function clearCache () : void
285		{
286	3	$this->_Cache = [];
287	3	$this->_CacheMaxKey = 0;
288	3	$this->_CacheMinKey = 0;
289	3	}
290
291	77	public function isUsingHandler ()
292		{
293	77	return $this->_DataHandler !== null;
294		}
295
296		/////////// HANDLER INTERRACTION ///////////
297
298	4	public function resetCounter () : int
299		{
300	4	return $this->_counter = $this->getContainerSize() + ( ($this->isUsingHandler()) ? $this->_DataHandler->countEntitys() : 0 );
301		}
302
303	4	public function resetMaxKey () : ?int
304		{
305	4	$this->resetCounter();
306
307	4	if ($this->count() < 1) :
308	3	$this->_maxKey = -1;
309	3	return null;
310		else :
311	2	$maxContainerKey = (empty($this->_Container)) ? null : max(array_keys($this->_Container));
312	2	$maxHandlerKey = ($this->_DataHandler !== null) ? $this->_DataHandler->selectMaxKey() : null;
313
314	2	return $this->_maxKey = max( $maxContainerKey,$maxHandlerKey );
315		endif;
316		}
317
318	3	public function importHandler (DataHandlerDriverInterface $handler) : bool
319		{
320	3	if ($handler->countEntitys() === 0) :
321	3	$this->_DataHandler = $handler;
322	3	$this->_DataHandler->_dataContextObject = $this->getDataContextObject();
		1 ignored issue – show Bug introduced 2018-01-08 17:22 UTC by Report Bug Copy Issue Report Accessing `_dataContextObject` on the interface `Condorcet\DataManager\Da...aHandlerDriverInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
323
324		try {
325	3	$this->regularize();
326		} catch (\Exception $e) {
327		$this->_DataHandler = null;
328		$this->resetCounter();
329		$this->resetMaxKey();
330		throw $e;
331		}
332
333	3	$this->resetCounter();
334	3	$this->resetMaxKey();
335
336	3	return true;
337		else :
338		throw new CondorcetException;
339		endif;
340		}
341
342	1	public function closeHandler () : void
343		{
344	1	if ($this->_DataHandler !== null) :
345	1	$this->regularize();
346	1	$this->clearCache();
347
348	1	$this->_Container = $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);
349
350	1	$this->_DataHandler = null;
351
352	1	$this->resetCounter();
353	1	$this->resetMaxKey();
354		endif;
355	1	}
356
357		public function getDataContextObject () : DataContextInterface
358		{
359		return new Class implements DataContextInterface {
360		public function dataCallBack ($data)
361		{
362		return $data;
363		}
364
365		public function dataPrepareStoringAndFormat ($data)
366		{
367		return $data;
368		}
369		};
370		}
371		}
372

julien-boudry / Condorcet

Push — TEST/ScrutinizerPHPAnalysisEng... ( bc3f13...c9e065 )

ArrayManager A

Complexity

Size/Duplication

Test Coverage

Importance

35 Methods

Duplication Side-by-Side

Filter issues like