ArrayManager::__sleep() - Code Metrics - Inspection of "Revert "Back to old .scrutinizer.yml"" - julien-boudry/Condorcet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — TEST/ScrutinizerPHPAnalysisEng... (bc3f13)

by Boudry

created 2018-01-12 16:00 UTC

ArrayManager::__sleep() A

↳ Parent: ArrayManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
crap	1
eloc	4
nc	1
nop	0

<?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 __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 __sleep () : array
47		{
48	1	$this->regularize();
49	1	$this->clearCache();
50	1	$this->rewind();
51
52	1	return ['_Container','_DataHandler','_link'];
53		}
54
55		public function __wakeup ()
56		{
57		$this->resetMaxKey();
58		$this->resetCounter();
59		}
60
61
62		/////////// Implement ArrayAccess ///////////
63
64	81	public function offsetSet($offset, $value) : void
65		{
66	81	if ($offset === null) :
67	81	$this->_Container[++$this->_maxKey] = $value;
68	81	++$this->_counter;
69		else :
70		$state = !$this->keyExist($offset);
71		$this->_Container[$offset] = $value;
72
73		if ($state) :
74		++$this->_counter;
75
76		if ($offset > $this->_maxKey) :
77		$this->_maxKey = $offset;
78		endif;
79
80		ksort($this->_Container,SORT_NUMERIC);
81		elseif ($this->_DataHandler !== null) :
82		$this->_DataHandler->deleteOneEntity($offset, true);
83		endif;
84
85		$this->clearCache();
86		endif;
87
88	81	$this->checkRegularize();
89	81	}
90
91		// Use by isset() function, must return false if offset value is null.
92		public function offsetExists($offset) : bool
93		{
94		return ( isset($this->_Container[$offset]) \|\| ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) ? true : false ;
95		}
96
97	7	public function offsetUnset($offset) : bool
98		{
99	7	if ($this->keyExist($offset)) :
100	7	if (array_key_exists($offset, $this->_Container)) :
101	7	unset($this->_Container[$offset]);
102		else :
103	1	unset($this->_Cache[$offset]);
104
105	1	$this->_DataHandler->deleteOneEntity($offset, false);
106		endif;
107
108	7	--$this->_counter;
109	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...
110		else :
111	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...
112		endif;
113		}
114
115	69	public function offsetGet($offset)
116		{
117	69	if (isset($this->_Container[$offset])) :
118	69	return $this->_Container[$offset];
119	2	elseif ($this->_DataHandler !== null) :
120	2	if (array_key_exists($offset, $this->_Cache)) :
121	2	return $this->_Cache[$offset];
122		else :
123	2	$query = $this->_DataHandler->selectOneEntity($offset);
124	2	return ($query === false) ? null : $query;
125		endif;
126		else :
127		return null;
128		endif;
129		}
130
131
132		/////////// Implement Iterator ///////////
133
134		protected $valid = true;
135
136	68	public function rewind() : void {
137	68	$this->_cursor = null;
138	68	$this->valid = true;
139
140	68	reset($this->_Cache);
141	68	reset($this->_Container);
142	68	}
143
144	68	public function current() {
145	68	return $this->offsetGet($this->key());
146		}
147
148	68	public function key() : ?int
149		{
150	68	if ($this->_counter === 0) :
151		return null;
152		else :
153	68	return ($this->_cursor === null) ? $this->getFirstKey() : $this->_cursor;
154		endif;
155		}
156
157	68	public function next() : void
158		{
159	68	$oldCursor = $this->_cursor;
160
161	68	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...
162		// Do nothing
163	66	elseif (!$this->isUsingHandler()) :
164	65	$this->setCursorOnNextKeyInArray($this->_Container);
165		else :
166	2	$this->populateCache();
167	2	$this->setCursorOnNextKeyInArray($this->_Cache);
168		endif;
169
170	68	if ($this->_cursor === $oldCursor) :
171	68	$this->valid = false;
172		endif;
173	68	}
174
175	66	protected function setCursorOnNextKeyInArray (array &$array)
176		{
177	66	next($array);
178	66	$arrayKey = key($array);
179
180	66	if ($arrayKey > $this->key()) :
181	66	return $this->_cursor = $arrayKey;
182		endif;
183	2	}
184
185	68	public function valid() : bool {
186	68	return $this->valid;
187		}
188
189
190		/////////// Implement Countable ///////////
191
192	15	public function count () : int {
193	15	return $this->_counter;
194		}
195
196		/////////// Array Methods ///////////
197
198	12	public function getFullDataSet () : array
199		{
200	12	$this->regularize();
201
202	12	return (!$this->isUsingHandler()) ? $this->_Container : $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);
203		}
204
205	7	public function keyExist ($offset) : bool
206		{
207	7	if ( array_key_exists($offset, $this->_Container) \|\| ($this->_DataHandler !== null && $this->_DataHandler->selectOneEntity($offset) !== false) ) :
208	7	return true;
209		else :
210	1	return false;
211		endif;
212		}
213
214	68	public function getFirstKey () : int
215		{
216	68	$r = array_keys($this->_Container);
217
218	68	if ($this->_DataHandler !== null) :
219	2	$r[] = $this->_DataHandler->selectMinKey();
220		endif;
221
222	68	return (int) min($r);
223		}
224
225	3	public function getContainerSize () : int
226		{
227	3	return count($this->_Container);
228		}
229
230	1	public function getCacheSize () : int
231		{
232	1	return count($this->_Cache);
233		}
234
235	1	public function debugGetCache () : array
236		{
237	1	return $this->_Cache;
238		}
239
240
241		/////////// HANDLER API ///////////
242
243	14	public function regularize () : bool
244		{
245	14	if (!$this->isUsingHandler() \|\| empty($this->_Container)) :
246	14	return false;
247		else :
248	3	$this->_DataHandler->insertEntitys($this->_Container);
249	3	$this->_Container = [];
250	3	return true;
251		endif;
252		}
253
254	81	public function checkRegularize () : bool
255		{
256	81	if ( $this->_DataHandler !== null && self::$MaxContainerLength <= $this->getContainerSize() ) :
257	1	$this->regularize();
258	1	return true;
259		else :
260	81	return false;
261		endif;
262		}
263
264	2	protected function populateCache () : void
265		{
266	2	$this->regularize();
267
268	2	$currentKey = $this->key();
269
270	2	if ( empty($this->_Cache) \|\| $currentKey >= $this->_CacheMaxKey \|\| $currentKey < $this->_CacheMinKey ) :
271	2	$this->_Cache = $this->_DataHandler->selectRangeEntitys($currentKey, self::$CacheSize);
272
273	2	$keys = array_keys($this->_Cache);
274	2	$this->_CacheMaxKey = max($keys);
275	2	$this->_CacheMinKey = min($keys);
276		endif;
277	2	}
278
279	2	public function clearCache () : void
280		{
281	2	$this->_Cache = [];
282	2	$this->_CacheMaxKey = 0;
283	2	$this->_CacheMinKey = 0;
284	2	}
285
286	72	public function isUsingHandler ()
287		{
288	72	return $this->_DataHandler !== null;
289		}
290
291		/////////// HANDLER INTERRACTION ///////////
292
293	3	public function resetCounter () : int
294		{
295	3	return $this->_counter = $this->getContainerSize() + ( ($this->isUsingHandler()) ? $this->_DataHandler->countEntitys() : 0 );
296		}
297
298	3	public function resetMaxKey () : ?int
299		{
300	3	$this->resetCounter();
301
302	3	if ($this->count() < 1) :
303	3	$this->_maxKey = -1;
304	3	return null;
305		else :
306	1	$maxContainerKey = (empty($this->_Container)) ? null : max(array_keys($this->_Container));
307	1	$maxHandlerKey = ($this->_DataHandler !== null) ? $this->_DataHandler->selectMaxKey() : null;
308
309	1	return $this->_maxKey = max( $maxContainerKey,$maxHandlerKey );
310		endif;
311		}
312
313	3	public function importHandler (DataHandlerDriverInterface $handler) : bool
314		{
315	3	if ($handler->countEntitys() === 0) :
316	3	$this->_DataHandler = $handler;
317	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...
318
319		try {
320	3	$this->regularize();
321		} catch (\Exception $e) {
322		$this->_DataHandler = null;
323		$this->resetCounter();
324		$this->resetMaxKey();
325		throw $e;
326		}
327
328	3	$this->resetCounter();
329	3	$this->resetMaxKey();
330
331	3	return true;
332		else :
333		throw new CondorcetException;
334		endif;
335		}
336
337	1	public function closeHandler () : void
338		{
339	1	if ($this->_DataHandler !== null) :
340	1	$this->regularize();
341	1	$this->clearCache();
342
343	1	$this->_Container = $this->_DataHandler->selectRangeEntitys(0,$this->_maxKey + 1);
344
345	1	$this->_DataHandler = null;
346
347	1	$this->resetCounter();
348	1	$this->resetMaxKey();
349		endif;
350	1	}
351
352		public function getDataContextObject () : DataContextInterface
353		{
354		return new Class implements DataContextInterface {
355		public function dataCallBack ($data)
356		{
357		return $data;
358		}
359
360		public function dataPrepareStoringAndFormat ($data)
361		{
362		return $data;
363		}
364		};
365		}
366		}
367

julien-boudry / Condorcet

Branch — TEST/ScrutinizerPHPAnalysisEng... (bc3f13)

ArrayManager::__sleep() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like