EnumSet::rewind() - Code Metrics - Inspection of "optimized EnumSet::count()" - marc-mabe/php-enum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#67)

by Marc

created 2016-10-01 20:41 UTC

EnumSet::rewind() A

↳ Parent: EnumSet

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
ccs	7
cts	7
cp	1
rs	9.6666
cc	2
eloc	6
nc	2
nop	0
crap	2

<?php

namespace MabeEnum;

use Iterator;
use Countable;
use InvalidArgumentException;

/**
 * EnumSet implementation in base of an integer bit set
 *
 * @link http://github.com/marc-mabe/php-enum for the canonical source repository
 * @copyright Copyright (c) 2015 Marc Bennewitz
 * @license http://github.com/marc-mabe/php-enum/blob/master/LICENSE.txt New BSD License
 */
class EnumSet implements Iterator, Countable
{
    /**
     * The classname of the Enumeration
     * @var string
     */
    private $enumeration;

    /**
     * BitSet of all attached enumerations in little endian
     * @var string
     */
    private $bitset;

    /**
     * Ordinal number of current iterator position
     * @var int
     */
    private $ordinal = 0;

    /**
     * Highest possible ordinal number
     * @var int
     */
    private $ordinalMax;

    /**
     * Constructor
     *
     * @param string $enumeration The classname of the enumeration
     * @throws InvalidArgumentException
     */
    public function __construct($enumeration)
    {
        if (!is_subclass_of($enumeration, __NAMESPACE__ . '\Enum')) {
            throw new InvalidArgumentException(sprintf(
                "This EnumSet can handle subclasses of '%s' only",
                __NAMESPACE__ . '\Enum'
            ));
        }
        
        $this->enumeration = $enumeration;
        $this->ordinalMax  = count($enumeration::getConstants());
        
        // init the bitset with zeros
        $this->bitset = str_repeat("\0", ceil($this->ordinalMax / 8));
    }

    /**
     * Get the classname of enumeration this set is for
     * @return string
     * @deprecated Please use getEnumeration() instead
     */
    public function getEnumClass()
    {
        return $this->getEnumeration();
    }

    /**
     * Get the classname of the enumeration
     * @return string
     */
    public function getEnumeration()
    {
        return $this->enumeration;
    }

    /**
     * Attach a new enumerator or overwrite an existing one
     * @param Enum|null|boolean|int|float|string $enumerator
     * @return void
     * @throws InvalidArgumentException On an invalid given enumerator
     */
    public function attach($enumerator)
    {
        $enumeration = $this->enumeration;
        $this->setBit($enumeration::get($enumerator)->getOrdinal());
    }

    /**
     * Detach the given enumerator
     * @param Enum|null|boolean|int|float|string $enumerator
     * @return void
     * @throws InvalidArgumentException On an invalid given enumerator
     */
    public function detach($enumerator)
    {
        $enumeration = $this->enumeration;
        $this->unsetBit($enumeration::get($enumerator)->getOrdinal());
    }

    /**
     * Test if the given enumerator was attached
     * @param Enum|null|boolean|int|float|string $enumerator
     * @return boolean
     */
    public function contains($enumerator)
    {
        $enumeration = $this->enumeration;
        return $this->getBit($enumeration::get($enumerator)->getOrdinal());
    }

    /* Iterator */

    /**
     * Get the current enumerator
     * @return Enum|null Returns the current enumerator or NULL on an invalid iterator position
     */
    public function current()
    {
        if ($this->valid()) {
            $enumeration = $this->enumeration;
            return $enumeration::getByOrdinal($this->ordinal);
        }

        return null;
    }

    /**
     * Get the ordinal number of the current iterator position
     * @return int
     */
    public function key()
    {
        return $this->ordinal;
    }

    /**
     * Go to the next valid iterator position.
     * If no valid iterator position is found the iterator position will be the last possible + 1.
     * @return void
     */
    public function next()
    {
        do {
            if (++$this->ordinal >= $this->ordinalMax) {
                $this->ordinal = $this->ordinalMax;
                return;
            }
        } while (!$this->getBit($this->ordinal));
    }

    /**
     * Go to the first valid iterator position.
     * If no valid iterator position in found the iterator position will be 0.
     * @return void
     */
    public function rewind()
    {
        if (trim($this->bitset, "\0") !== '') {
            $this->ordinal = -1;
            $this->next();
        } else {
            $this->ordinal = 0;
        }
    }

    /**
     * Test if the iterator in a valid state
     * @return boolean
     */
    public function valid()
    {
        return $this->ordinal !== $this->ordinalMax && $this->getBit($this->ordinal);
    }

    /* Countable */

    /**
     * Count the number of elements
     * @return int
     */
    public function count()
    {
        $count   = 0;
        $byteLen = strlen($this->bitset);
        for ($bytePos = 0; $bytePos < $byteLen; ++$bytePos) {
            if ($this->bitset[$bytePos] === "\0") {
                continue; // fast skip null byte
            }

            for ($bitPos = 0; $bitPos < 8; ++$bitPos) {
                if ((ord($this->bitset[$bytePos]) & (1 << $bitPos)) !== 0) {
                    ++$count;
                }
            }
        }

        return $count;
    }

    /**
     * Check if this EnumSet is the same as other
     * @param EnumSet $other
     * @return bool
     */
    public function isEqual(EnumSet $other)
    {
        return $this->getEnumeration() === $other->getEnumeration()
            && $this->getBinaryBitsetLe() === $other->getBinaryBitsetLe();
    }

    /**
     * Check if this EnumSet is a subset of other
     * @param EnumSet $other
     * @return bool
     */
    public function isSubset(EnumSet $other)

    {
        if ($this->getEnumeration() !== $other->getEnumeration()) {
            return false;
        }

        $thisBitset = $this->getBinaryBitsetLe();
        return ($thisBitset & $other->getBinaryBitsetLe()) === $thisBitset;
    }

    /**
     * Check if this EnumSet is a superset of other
     * @param EnumSet $other
     * @return bool
     */
    public function isSuperset(EnumSet $other)

    {
        if ($this->getEnumeration() !== $other->getEnumeration()) {
            return false;
        }

        $thisBitset = $this->getBinaryBitsetLe();
        return ($thisBitset | $other->getBinaryBitsetLe()) === $thisBitset;
    }

    /**
     * Get ordinal numbers of the defined enumerators as array
     * @return int[]
     */
    public function getOrdinals()
    {
        $ordinals = array();
        $byteLen  = strlen($this->bitset);

        for ($bytePos = 0; $bytePos < $byteLen; ++$bytePos) {
            if ($this->bitset[$bytePos] === "\0") {
                continue; // fast skip null byte
            }

            for ($bitPos = 0; $bitPos < 8; ++$bitPos) {
                if ((ord($this->bitset[$bytePos]) & (1 << $bitPos)) !== 0) {
                    $ordinals[] = $bytePos * 8 + $bitPos;
                }
            }
        }

        return $ordinals;
    }

    /**
     * Get values of the defined enumerators as array
     * @return null[]|bool[]|int[]|float[]|string[]
     */
    public function getValues()
    {
        $values = array();
        foreach ($this->getEnumerators() as $enumerator) {
            $values[] = $enumerator->getValue();
        }
        return $values;
    }

    /**
     * Get names of the defined enumerators as array
     * @return string[]
     */
    public function getNames()
    {
        $names = array();
        foreach ($this->getEnumerators() as $enumerator) {
            $names[] = $enumerator->getName();
        }
        return $names;
    }

    /**
     * Get the defined enumerators as array
     * @return Enum[]
     */
    public function getEnumerators()
    {
        $enumeration = $this->enumeration;
        $enumerators = array();
        foreach ($this->getOrdinals() as $ord) {
            $enumerators[] = $enumeration::getByOrdinal($ord);
        }
        return $enumerators;
    }

    /**
     * Get binary bitset in little-endian order
     * 
     * @return string
     */
    public function getBinaryBitsetLe()
    {
        return $this->bitset;
    }

    /**
     * Set binary bitset in little-endian order
     *
     * NOTE: It resets the current position of the iterator
     * 
     * @param string $bitset
     * @return void
     * @throws InvalidArgumentException On a non string is given as Parameter
     */
    public function setBinaryBitsetLe($bitset)
    {
        if (!is_string($bitset)) {
            throw new InvalidArgumentException('Bitset must be a string');
        }
        
        $size   = ceil($this->ordinalMax / 8);
        $sizeIn = strlen($bitset);
        
        if ($sizeIn < $size) {
            // add "\0" if the given bitset is not long enough
            $bitset .= str_repeat("\0", $size - $sizeIn);
        } elseif ($sizeIn > $size) {
            $bitset = substr($bitset, 0, $size);
        }
        
        $this->bitset = $bitset;
        
        $this->rewind();
    }

    /**
     * Get binary bitset in big-endian order
     * 
     * @return string
     */
    public function getBinaryBitsetBe()
    {
        return strrev($this->bitset);
    }

    /**
     * Set binary bitset in big-endian order
     *
     * NOTE: It resets the current position of the iterator
     * 
     * @param string $bitset
     * @return void
     * @throws InvalidArgumentException On a non string is given as Parameter
     */
    public function setBinaryBitsetBe($bitset)
    {
        if (!is_string($bitset)) {
            throw new InvalidArgumentException('Bitset must be a string');
        }
        
	$this->setBinaryBitsetLe(strrev($bitset));
    }

    /**
     * Get the binary bitset
     * 
     * @return string Returns the binary bitset in big-endian order
     * @deprecated Please use getBinaryBitsetBe() instead
     */
    public function getBitset()
    {
        return $this->getBinaryBitsetBe();
    }

    /**
     * Set the bitset.
     * NOTE: It resets the current position of the iterator
     * 
     * @param string $bitset The binary bitset in big-endian order
     * @return void
     * @throws InvalidArgumentException On a non string is given as Parameter
     * @deprecated Please use setBinaryBitsetBe() instead
     */
    public function setBitset($bitset)
    {
        $this->setBinaryBitsetBE($bitset);
    }

    /**
     * Get a bit at the given ordinal number
     * 
     * @param $ordinal int Ordinal number of bit to get
     * @return boolean
     */
    private function getBit($ordinal)
    {
        return (ord($this->bitset[(int) ($ordinal / 8)]) & 1 << ($ordinal % 8)) !== 0;
    }

    /**
     * Set a bit at the given ordinal number
     * 
     * @param $ordinal int Ordnal number of bit to set
     * @return void
     */
    private function setBit($ordinal)
    {
        $byte = (int) ($ordinal / 8);
        $this->bitset[$byte] = $this->bitset[$byte] | chr(1 << ($ordinal % 8));
    }

    /**
     * Unset a bit at the given ordinal number
     * 
     * @param $ordinal int Ordinal number of bit to unset
     * @return void
     */
    private function unsetBit($ordinal)
    {
        $byte = (int) ($ordinal / 8);
        $this->bitset[$byte] = $this->bitset[$byte] & chr(~(1 << ($ordinal % 8)));
    }
}


1			<?php
2
3			namespace MabeEnum;
4
5			use Iterator;
6			use Countable;
7			use InvalidArgumentException;
8
9			/**
10			* EnumSet implementation in base of an integer bit set
11			*
12			* @link http://github.com/marc-mabe/php-enum for the canonical source repository
13			* @copyright Copyright (c) 2015 Marc Bennewitz
14			* @license http://github.com/marc-mabe/php-enum/blob/master/LICENSE.txt New BSD License
15			*/
16			class EnumSet implements Iterator, Countable
17			{
18			/**
19			* The classname of the Enumeration
20			* @var string
21			*/
22			private $enumeration;
23
24			/**
25			* BitSet of all attached enumerations in little endian
26			* @var string
27			*/
28			private $bitset;
29
30			/**
31			* Ordinal number of current iterator position
32			* @var int
33			*/
34			private $ordinal = 0;
35
36			/**
37			* Highest possible ordinal number
38			* @var int
39			*/
40			private $ordinalMax;
41
42			/**
43			* Constructor
44			*
45			* @param string $enumeration The classname of the enumeration
46			* @throws InvalidArgumentException
47			*/
48	42		public function __construct($enumeration)
49			{
50	42		if (!is_subclass_of($enumeration, __NAMESPACE__ . '\Enum')) {
51	1		throw new InvalidArgumentException(sprintf(
52	1		"This EnumSet can handle subclasses of '%s' only",
53			__NAMESPACE__ . '\Enum'
54	1		));
55			}
56
57	41		$this->enumeration = $enumeration;
58	41		$this->ordinalMax = count($enumeration::getConstants());
59
60			// init the bitset with zeros
61	41		$this->bitset = str_repeat("\0", ceil($this->ordinalMax / 8));
62	41		}
63
64			/**
65			* Get the classname of enumeration this set is for
66			* @return string
67			* @deprecated Please use getEnumeration() instead
68			*/
69			public function getEnumClass()
70			{
71			return $this->getEnumeration();
72			}
73
74			/**
75			* Get the classname of the enumeration
76			* @return string
77			*/
78	12		public function getEnumeration()
79			{
80	12		return $this->enumeration;
81			}
82
83			/**
84			* Attach a new enumerator or overwrite an existing one
85			* @param Enum\|null\|boolean\|int\|float\|string $enumerator
86			* @return void
87			* @throws InvalidArgumentException On an invalid given enumerator
88			*/
89	31		public function attach($enumerator)
90			{
91	31		$enumeration = $this->enumeration;
92	31		$this->setBit($enumeration::get($enumerator)->getOrdinal());
93	31		}
94
95			/**
96			* Detach the given enumerator
97			* @param Enum\|null\|boolean\|int\|float\|string $enumerator
98			* @return void
99			* @throws InvalidArgumentException On an invalid given enumerator
100			*/
101	7		public function detach($enumerator)
102			{
103	7		$enumeration = $this->enumeration;
104	7		$this->unsetBit($enumeration::get($enumerator)->getOrdinal());
105	7		}
106
107			/**
108			* Test if the given enumerator was attached
109			* @param Enum\|null\|boolean\|int\|float\|string $enumerator
110			* @return boolean
111			*/
112	11		public function contains($enumerator)
113			{
114	11		$enumeration = $this->enumeration;
115	11		return $this->getBit($enumeration::get($enumerator)->getOrdinal());
116			}
117
118			/* Iterator */
119
120			/**
121			* Get the current enumerator
122			* @return Enum\|null Returns the current enumerator or NULL on an invalid iterator position
123			*/
124	9		public function current()
125			{
126	9		if ($this->valid()) {
127	9		$enumeration = $this->enumeration;
128	9		return $enumeration::getByOrdinal($this->ordinal);
129			}
130
131	2		return null;
132			}
133
134			/**
135			* Get the ordinal number of the current iterator position
136			* @return int
137			*/
138	6		public function key()
139			{
140	6		return $this->ordinal;
141			}
142
143			/**
144			* Go to the next valid iterator position.
145			* If no valid iterator position is found the iterator position will be the last possible + 1.
146			* @return void
147			*/
148	16		public function next()
149			{
150			do {
151	16		if (++$this->ordinal >= $this->ordinalMax) {
152	4		$this->ordinal = $this->ordinalMax;
153	4		return;
154			}
155	16		} while (!$this->getBit($this->ordinal));
156	16		}
157
158			/**
159			* Go to the first valid iterator position.
160			* If no valid iterator position in found the iterator position will be 0.
161			* @return void
162			*/
163	10		public function rewind()
164			{
165	10		if (trim($this->bitset, "\0") !== '') {
166	10		$this->ordinal = -1;
167	10		$this->next();
168	10		} else {
169	1		$this->ordinal = 0;
170			}
171	10		}
172
173			/**
174			* Test if the iterator in a valid state
175			* @return boolean
176			*/
177	10		public function valid()
178			{
179	10		return $this->ordinal !== $this->ordinalMax && $this->getBit($this->ordinal);
180			}
181
182			/* Countable */
183
184			/**
185			* Count the number of elements
186			* @return int
187			*/
188	11		public function count()
189			{
190	11		$count = 0;
191	11		$byteLen = strlen($this->bitset);
192			for ($bytePos = 0; $bytePos < $byteLen; ++$bytePos) {
193	11		if ($this->bitset[$bytePos] === "\0") {
194	10		continue; // fast skip null byte
195	10		}
196	10
197	10		for ($bitPos = 0; $bitPos < 8; ++$bitPos) {
198			if ((ord($this->bitset[$bytePos]) & (1 << $bitPos)) !== 0) {
199	11		++$count;
200			}
201			}
202			}
203
204			return $count;
205			}
206
207	2		/**
208			* Check if this EnumSet is the same as other
209	2		* @param EnumSet $other
210	2		* @return bool
211			*/
212			public function isEqual(EnumSet $other)
213			{
214			return $this->getEnumeration() === $other->getEnumeration()
215			&& $this->getBinaryBitsetLe() === $other->getBinaryBitsetLe();
216			}
217
218	4		/**
219			* Check if this EnumSet is a subset of other
220	4		* @param EnumSet $other
221	1		* @return bool
222			*/
223		View Code Duplication	public function isSubset(EnumSet $other)
			0 ignored issues – show Duplication introduced 2016-09-19 21: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...
224	3		{
225	3		if ($this->getEnumeration() !== $other->getEnumeration()) {
226			return false;
227			}
228
229			$thisBitset = $this->getBinaryBitsetLe();
230			return ($thisBitset & $other->getBinaryBitsetLe()) === $thisBitset;
231			}
232
233	4		/**
234			* Check if this EnumSet is a superset of other
235	4		* @param EnumSet $other
236	1		* @return bool
237			*/
238		View Code Duplication	public function isSuperset(EnumSet $other)
			0 ignored issues – show Duplication introduced 2016-09-19 21: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...
239	3		{
240	3		if ($this->getEnumeration() !== $other->getEnumeration()) {
241			return false;
242			}
243
244			$thisBitset = $this->getBinaryBitsetLe();
245			return ($thisBitset \| $other->getBinaryBitsetLe()) === $thisBitset;
246			}
247	8
248			/**
249	8		* Get ordinal numbers of the defined enumerators as array
250	8		* @return int[]
251			*/
252	8		public function getOrdinals()
253	8		{
254	8		$ordinals = array();
255			$byteLen = strlen($this->bitset);
256
257	8		for ($bytePos = 0; $bytePos < $byteLen; ++$bytePos) {
258	8		if ($this->bitset[$bytePos] === "\0") {
259	8		continue; // fast skip null byte
260	8		}
261	8
262	8		for ($bitPos = 0; $bitPos < 8; ++$bitPos) {
263			if ((ord($this->bitset[$bytePos]) & (1 << $bitPos)) !== 0) {
264	8		$ordinals[] = $bytePos * 8 + $bitPos;
265			}
266			}
267			}
268
269			return $ordinals;
270			}
271	2
272			/**
273	2		* Get values of the defined enumerators as array
274	2		* @return null[]\|bool[]\|int[]\|float[]\|string[]
275	2		*/
276	2		public function getValues()
277	2		{
278			$values = array();
279			foreach ($this->getEnumerators() as $enumerator) {
280			$values[] = $enumerator->getValue();
281			}
282			return $values;
283			}
284	2
285			/**
286	2		* Get names of the defined enumerators as array
287	2		* @return string[]
288	2		*/
289	2		public function getNames()
290	2		{
291			$names = array();
292			foreach ($this->getEnumerators() as $enumerator) {
293			$names[] = $enumerator->getName();
294			}
295			return $names;
296			}
297	6
298			/**
299	6		* Get the defined enumerators as array
300	6		* @return Enum[]
301	6		*/
302	6		public function getEnumerators()
303	6		{
304	6		$enumeration = $this->enumeration;
305			$enumerators = array();
306			foreach ($this->getOrdinals() as $ord) {
307			$enumerators[] = $enumeration::getByOrdinal($ord);
308			}
309			return $enumerators;
310			}
311
312	10		/**
313			* Get binary bitset in little-endian order
314	10		*
315			* @return string
316			*/
317			public function getBinaryBitsetLe()
318			{
319			return $this->bitset;
320			}
321
322			/**
323			* Set binary bitset in little-endian order
324			*
325			* NOTE: It resets the current position of the iterator
326	6		*
327			* @param string $bitset
328	6		* @return void
329	1		* @throws InvalidArgumentException On a non string is given as Parameter
330			*/
331			public function setBinaryBitsetLe($bitset)
332	5		{
333	5		if (!is_string($bitset)) {
334			throw new InvalidArgumentException('Bitset must be a string');
335	5		}
336
337	1		$size = ceil($this->ordinalMax / 8);
338	5		$sizeIn = strlen($bitset);
339	1
340	1		if ($sizeIn < $size) {
341			// add "\0" if the given bitset is not long enough
342	5		$bitset .= str_repeat("\0", $size - $sizeIn);
343			} elseif ($sizeIn > $size) {
344	5		$bitset = substr($bitset, 0, $size);
345	5		}
346
347			$this->bitset = $bitset;
348
349			$this->rewind();
350			}
351
352	2		/**
353			* Get binary bitset in big-endian order
354	2		*
355			* @return string
356			*/
357			public function getBinaryBitsetBe()
358			{
359			return strrev($this->bitset);
360			}
361
362			/**
363			* Set binary bitset in big-endian order
364			*
365			* NOTE: It resets the current position of the iterator
366	3		*
367			* @param string $bitset
368	3		* @return void
369	1		* @throws InvalidArgumentException On a non string is given as Parameter
370			*/
371			public function setBinaryBitsetBe($bitset)
372	2		{
373	2		if (!is_string($bitset)) {
374			throw new InvalidArgumentException('Bitset must be a string');
375			}
376
377			$this->setBinaryBitsetLe(strrev($bitset));
378			}
379
380			/**
381			* Get the binary bitset
382			*
383			* @return string Returns the binary bitset in big-endian order
384			* @deprecated Please use getBinaryBitsetBe() instead
385			*/
386			public function getBitset()
387			{
388			return $this->getBinaryBitsetBe();
389			}
390
391			/**
392			* Set the bitset.
393			* NOTE: It resets the current position of the iterator
394			*
395			* @param string $bitset The binary bitset in big-endian order
396			* @return void
397			* @throws InvalidArgumentException On a non string is given as Parameter
398			* @deprecated Please use setBinaryBitsetBe() instead
399			*/
400			public function setBitset($bitset)
401			{
402			$this->setBinaryBitsetBE($bitset);
403			}
404
405			/**
406	22		* Get a bit at the given ordinal number
407			*
408	22		* @param $ordinal int Ordinal number of bit to get
409			* @return boolean
410			*/
411			private function getBit($ordinal)
412			{
413			return (ord($this->bitset[(int) ($ordinal / 8)]) & 1 << ($ordinal % 8)) !== 0;
414			}
415
416			/**
417	31		* Set a bit at the given ordinal number
418			*
419	31		* @param $ordinal int Ordnal number of bit to set
420	31		* @return void
421	31		*/
422			private function setBit($ordinal)
423			{
424			$byte = (int) ($ordinal / 8);
425			$this->bitset[$byte] = $this->bitset[$byte] \| chr(1 << ($ordinal % 8));
426			}
427
428			/**
429	7		* Unset a bit at the given ordinal number
430			*
431	7		* @param $ordinal int Ordinal number of bit to unset
432	7		* @return void
433	7		*/
434			private function unsetBit($ordinal)
435			{
436			$byte = (int) ($ordinal / 8);
437			$this->bitset[$byte] = $this->bitset[$byte] & chr(~(1 << ($ordinal % 8)));
438			}
439			}
440

marc-mabe / php-enum

Pull Request — master (#67)

EnumSet::rewind() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like