EnumSet::isSubset() - Code Metrics - Inspection of "EnumSet: added isEqual(), isSubset() and isSuperse..." - marc-mabe/php-enum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — enumset_isequal_issubset_issup... ( 9365c6 )

by Marc

created 2016-09-19 21:13 UTC

EnumSet::isSubset() A

↳ Parent: EnumSet

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	10
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	10
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	6
nc	2
nop	1
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()
    {
        $cnt = 0;
        $ord = 0;

        while ($ord !== $this->ordinalMax) {
            if ($this->getBit($ord++)) {
                ++$cnt;
            }
        }

        return $cnt;
    }

    /**
     * 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();
        $otherBitset = $other->getBinaryBitsetLe();
        return ($thisBitset & $otherBitset) === $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();
        $otherBitset = $other->getBinaryBitsetLe();
        return ($otherBitset | $thisBitset) === $thisBitset;
    }

    /**
     * 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	34		public function __construct($enumeration)
49			{
50	34	View Code Duplication	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	33		$this->enumeration = $enumeration;
58	33		$this->ordinalMax = count($enumeration::getConstants());
59
60			// init the bitset with zeros
61	33		$this->bitset = str_repeat("\0", ceil($this->ordinalMax / 8));
62	33		}
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	23		public function attach($enumerator)
90			{
91	23		$enumeration = $this->enumeration;
92	23		$this->setBit($enumeration::get($enumerator)->getOrdinal());
93	23		}
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	5		public function current()
125			{
126	5		if ($this->valid()) {
127	5		$enumeration = $this->enumeration;
128	5		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	12		public function next()
149			{
150			do {
151	12		if (++$this->ordinal >= $this->ordinalMax) {
152	4		$this->ordinal = $this->ordinalMax;
153	4		return;
154			}
155	12		} while (!$this->getBit($this->ordinal));
156	12		}
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	6		public function valid()
178			{
179	6		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		$cnt = 0;
191	11		$ord = 0;
192
193	11		while ($ord !== $this->ordinalMax) {
194	10		if ($this->getBit($ord++)) {
195	10		++$cnt;
196	10		}
197	10		}
198
199	11		return $cnt;
200			}
201
202			/**
203			* Check if this EnumSet is the same as other
204			* @param EnumSet $other
205			* @return bool
206			*/
207	2		public function isEqual(EnumSet $other)
208			{
209	2		return $this->getEnumeration() === $other->getEnumeration()
210	2		&& $this->getBinaryBitsetLe() === $other->getBinaryBitsetLe();
211			}
212
213			/**
214			* Check if this EnumSet is a subset of other
215			* @param EnumSet $other
216			* @return bool
217			*/
218	4	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...
219			{
220	4		if ($this->getEnumeration() !== $other->getEnumeration()) {
221	1		return false;
222			}
223
224	3		$thisBitset = $this->getBinaryBitsetLe();
225	3		$otherBitset = $other->getBinaryBitsetLe();
226	3		return ($thisBitset & $otherBitset) === $thisBitset;
227			}
228
229			/**
230			* Check if this EnumSet is a superset of other
231			* @param EnumSet $other
232			* @return bool
233			*/
234	4	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...
235			{
236	4		if ($this->getEnumeration() !== $other->getEnumeration()) {
237	1		return false;
238			}
239
240	3		$thisBitset = $this->getBinaryBitsetLe();
241	3		$otherBitset = $other->getBinaryBitsetLe();
242	3		return ($otherBitset \| $thisBitset) === $thisBitset;
243			}
244
245			/**
246			* Get binary bitset in little-endian order
247			*
248			* @return string
249			*/
250	10		public function getBinaryBitsetLe()
251			{
252	10		return $this->bitset;
253			}
254
255			/**
256			* Set binary bitset in little-endian order
257			*
258			* NOTE: It resets the current position of the iterator
259			*
260			* @param string $bitset
261			* @return void
262			* @throws InvalidArgumentException On a non string is given as Parameter
263			*/
264	6		public function setBinaryBitsetLe($bitset)
265			{
266	6		if (!is_string($bitset)) {
267	1		throw new InvalidArgumentException('Bitset must be a string');
268			}
269
270	5		$size = ceil($this->ordinalMax / 8);
271	5		$sizeIn = strlen($bitset);
272
273	5		if ($sizeIn < $size) {
274			// add "\0" if the given bitset is not long enough
275	1		$bitset .= str_repeat("\0", $size - $sizeIn);
276	5		} elseif ($sizeIn > $size) {
277	1		$bitset = substr($bitset, 0, $size);
278	1		}
279
280	5		$this->bitset = $bitset;
281
282	5		$this->rewind();
283	5		}
284
285			/**
286			* Get binary bitset in big-endian order
287			*
288			* @return string
289			*/
290	2		public function getBinaryBitsetBe()
291			{
292	2		return strrev($this->bitset);
293			}
294
295			/**
296			* Set binary bitset in big-endian order
297			*
298			* NOTE: It resets the current position of the iterator
299			*
300			* @param string $bitset
301			* @return void
302			* @throws InvalidArgumentException On a non string is given as Parameter
303			*/
304	3		public function setBinaryBitsetBe($bitset)
305			{
306	3		if (!is_string($bitset)) {
307	1		throw new InvalidArgumentException('Bitset must be a string');
308			}
309
310	2		$this->setBinaryBitsetLe(strrev($bitset));
311	2		}
312
313			/**
314			* Get the binary bitset
315			*
316			* @return string Returns the binary bitset in big-endian order
317			* @deprecated Please use getBinaryBitsetBe() instead
318			*/
319			public function getBitset()
320			{
321			return $this->getBinaryBitsetBe();
322			}
323
324			/**
325			* Set the bitset.
326			* NOTE: It resets the current position of the iterator
327			*
328			* @param string $bitset The binary bitset in big-endian order
329			* @return void
330			* @throws InvalidArgumentException On a non string is given as Parameter
331			* @deprecated Please use setBinaryBitsetBe() instead
332			*/
333			public function setBitset($bitset)
334			{
335			$this->setBinaryBitsetBE($bitset);
336			}
337
338			/**
339			* Get a bit at the given ordinal number
340			*
341			* @param $ordinal int Ordinal number of bit to get
342			* @return boolean
343			*/
344	18		private function getBit($ordinal)
345			{
346	18		return (ord($this->bitset[(int) ($ordinal / 8)]) & 1 << ($ordinal % 8)) !== 0;
347			}
348
349			/**
350			* Set a bit at the given ordinal number
351			*
352			* @param $ordinal int Ordnal number of bit to set
353			* @return void
354			*/
355	23		private function setBit($ordinal)
356			{
357	23		$byte = (int) ($ordinal / 8);
358	23		$this->bitset[$byte] = $this->bitset[$byte] \| chr(1 << ($ordinal % 8));
359	23		}
360
361			/**
362			* Unset a bit at the given ordinal number
363			*
364			* @param $ordinal int Ordinal number of bit to unset
365			* @return void
366			*/
367	7		private function unsetBit($ordinal)
368			{
369	7		$byte = (int) ($ordinal / 8);
370	7		$this->bitset[$byte] = $this->bitset[$byte] & chr(~(1 << ($ordinal % 8)));
371	7		}
372			}
373

marc-mabe / php-enum

Push — enumset_isequal_issubset_issup... ( 9365c6 )

EnumSet::isSubset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like