Enum::getConstants() - Code Metrics - Inspection of "deprecated Enum::clear()" - marc-mabe/php-enum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — deprecate_enum_clear ( f66221 )

by Marc

created 2016-12-05 22:31 UTC

Enum::getConstants() A

↳ Parent: Enum

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace MabeEnum;

use ReflectionClass;
use InvalidArgumentException;
use LogicException;

/**
 * Class to implement enumerations for PHP 5 (without SplEnum)
 *
 * @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
 */
abstract class Enum
{
    /**
     * The selected enumerator value
     *
     * @var null|bool|int|float|string
     */
    private $value;

    /**
     * The ordinal number of the enumerator
     *
     * @var null|int
     */
    private $ordinal;

    /**
     * An array of available constants by class
     *
     * @var array ["$class" => ["$name" => $value, ...], ...]
     */
    private static $constants = array();

    /**
     * Already instantiated enumerators
     *
     * @var array ["$class" => ["$name" => $instance, ...], ...]
     */
    private static $instances = array();

    /**
     * Constructor
     *
     * @param null|bool|int|float|string $value   The value of the enumerator
     * @param int|null                   $ordinal The ordinal number of the enumerator
     */
    final private function __construct($value, $ordinal = null)
    {
        $this->value   = $value;
        $this->ordinal = $ordinal;
    }

    /**
     * Get the name of the enumerator
     *
     * @return string
     * @see getName()
     */
    public function __toString()
    {
        return $this->getName();
    }

    /**
     * @throws LogicException Enums are not cloneable
     *                        because instances are implemented as singletons
     */
    final private function __clone()
    {
        throw new LogicException('Enums are not cloneable');
    }

    /**
     * @throws LogicException Enums are not serializable
     *                        because instances are implemented as singletons
     */
    final public function __sleep()
    {
        throw new LogicException('Enums are not serializable');
    }

    /**
     * @throws LogicException Enums are not serializable
     *                        because instances are implemented as singletons
     */
    final public function __wakeup()
    {
        throw new LogicException('Enums are not serializable');
    }

    /**
     * Get the value of the enumerator
     *
     * @return null|bool|int|float|string
     */
    final public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the name of the enumerator
     *
     * @return string
     */
    final public function getName()
    {
        return array_search($this->value, self::detectConstants(get_called_class()), true);
    }

    /**
     * Get the ordinal number of the enumerator
     *
     * @return int
     */
    final public function getOrdinal()
    {
        if ($this->ordinal !== null) {
            return $this->ordinal;
        }

        // detect ordinal
        $ordinal = 0;
        $value   = $this->value;
        foreach (self::detectConstants(get_called_class()) as $constValue) {
            if ($value === $constValue) {
                break;
            }
            ++$ordinal;
        }

        $this->ordinal = $ordinal;
        return $ordinal;
    }

    /**
     * Compare this enumerator against another and check if it's the same.
     *
     * @param mixed $enumerator
     * @return bool
     */
    final public function is($enumerator)
    {
        return $this === $enumerator || $this->value === $enumerator;
    }

    /**
     * Get an enumerator instance of the given value or instance
     *
     * @param static|null|bool|int|float|string $value
     * @return static
     * @throws InvalidArgumentException On an unknwon or invalid value
     * @throws LogicException           On ambiguous constant values
     */
    final public static function get($value)
    {
        if ($value instanceof static && get_class($value) === get_called_class()) {
            return $value;
        }

        $class     = get_called_class();
        $constants = self::detectConstants($class);
        $name      = array_search($value, $constants, true);
        if ($name === false) {
            $message = is_scalar($value)
                ? 'Unknown value ' . var_export($value, true)
                : 'Invalid value of type ' . (is_object($value) ? get_class($value) : gettype($value));
            throw new InvalidArgumentException($message);
        }

        if (!isset(self::$instances[$class][$name])) {
            self::$instances[$class][$name] = new $class($constants[$name]);
        }

        return self::$instances[$class][$name];
    }

    /**
     * Get an enumerator instance by the given name
     *
     * @param string $name The name of the enumerator
     * @return static
     * @throws InvalidArgumentException On an invalid or unknown name
     * @throws LogicException           On ambiguous values
     */
    final public static function getByName($name)
    {
        $name  = (string) $name;
        $class = get_called_class();
        if (isset(self::$instances[$class][$name])) {
            return self::$instances[$class][$name];
        }

        $const = $class . '::' . $name;
        if (!defined($const)) {
            throw new InvalidArgumentException($const . ' not defined');
        }

        return self::$instances[$class][$name] = new $class(constant($const));
    }

    /**
     * Get an enumeration instance by the given ordinal number
     *
     * @param int $ordinal The ordinal number or the enumerator
     * @return static
     * @throws InvalidArgumentException On an invalid ordinal number
     * @throws LogicException           On ambiguous values
     */
    final public static function getByOrdinal($ordinal)
    {
        $ordinal   = (int) $ordinal;
        $class     = get_called_class();
        $constants = self::detectConstants($class);
        $item      = array_slice($constants, $ordinal, 1, true);
        if (empty($item)) {
            throw new InvalidArgumentException(sprintf(
                'Invalid ordinal number, must between 0 and %s',
                count($constants) - 1
            ));
        }

        $name = key($item);
        if (isset(self::$instances[$class][$name])) {
            return self::$instances[$class][$name];
        }

        return self::$instances[$class][$name] = new $class(current($item), $ordinal);
    }

    /**
     * Clear all instantiated enumerators of the called class
     *
     * NOTE: This can break singleton behavior ... use it with caution!
     *
     * @return void
     * @deprecated
     */
    final public static function clear()
    {
        $class = get_called_class();
        unset(self::$instances[$class], self::$constants[$class]);
    }

    /**
     * Get a list of enumerator instances ordered by ordinal number
     *
     * @return static[]
     */
    final public static function getEnumerators()
    {
        return array_map('self::getByName', array_keys(self::detectConstants(get_called_class())));
    }

    /**
     * Get all available constants of the called class
     *
     * @return array
     * @throws LogicException On ambiguous constant values
     */
    final public static function getConstants()
    {
        return self::detectConstants(get_called_class());
    }

    /**
     * Is the given enumerator part of this enumeration
     * 
     * @param static|null|bool|int|float|string $value
     * @return bool
     */
    final public static function has($value)
    {
        if ($value instanceof static && get_class($value) === get_called_class()) {
            return true;
        }

        $class     = get_called_class();
        $constants = self::detectConstants($class);

        return in_array($value, $constants, true);
    }

    /**
     * Detect all available constants by the given class
     *
     * @param string $class
     * @return array
     * @throws LogicException On ambiguous constant values
     */
    private static function detectConstants($class)
    {
        if (!isset(self::$constants[$class])) {
            $reflection = new ReflectionClass($class);
            $constants  = array();

            do {
                $scopeConstants = array();
                if (PHP_VERSION_ID >= 70100) {
                    // Since PHP-7.1 visibility modifiers are allowed for class constants
                    // for enumerations we are only interested in public once.
                    foreach ($reflection->getReflectionConstants() as $reflConstant) {
                        if ($reflConstant->isPublic()) {
                            $scopeConstants[ $reflConstant->getName() ] = $reflConstant->getValue();
                        }
                    }
                } else {
                    // In PHP < 7.1 all class constants were public by definition
                    $scopeConstants = $reflection->getConstants();
                }

                $constants = $scopeConstants + $constants;
            } while (($reflection = $reflection->getParentClass()) && $reflection->name !== __CLASS__);

            // Detect ambiguous values and report names
            $ambiguous = array();
            foreach ($constants as $value) {
                $names = array_keys($constants, $value, true);
                if (count($names) > 1) {
                    $ambiguous[var_export($value, true)] = $names;
                }
            }
            if (!empty($ambiguous)) {
                throw new LogicException(
                    'All possible values needs to be unique. The following are ambiguous: '
                    . implode(', ', array_map(function ($names) use ($constants) {
                        return implode('/', $names) . '=' . var_export($constants[$names[0]], true);
                    }, $ambiguous))
                );
            }

            self::$constants[$class] = $constants;
        }

        return self::$constants[$class];
    }

    /**
     * Get an enumerator instance by the given name.
     *
     * This will be called automatically on calling a method
     * with the same name of a defined enumerator.
     *
     * @param string $method The name of the enumeraotr (called as method)
     * @param array  $args   There should be no arguments
     * @return static
     * @throws InvalidArgumentException On an invalid or unknown name
     * @throws LogicException           On ambiguous constant values
     */
    final public static function __callStatic($method, array $args)
    {
        return self::getByName($method);
    }
}


1			<?php
2
3			namespace MabeEnum;
4
5			use ReflectionClass;
6			use InvalidArgumentException;
7			use LogicException;
8
9			/**
10			* Class to implement enumerations for PHP 5 (without SplEnum)
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			abstract class Enum
17			{
18			/**
19			* The selected enumerator value
20			*
21			* @var null\|bool\|int\|float\|string
22			*/
23			private $value;
24
25			/**
26			* The ordinal number of the enumerator
27			*
28			* @var null\|int
29			*/
30			private $ordinal;
31
32			/**
33			* An array of available constants by class
34			*
35			* @var array ["$class" => ["$name" => $value, ...], ...]
36			*/
37			private static $constants = array();
38
39			/**
40			* Already instantiated enumerators
41			*
42			* @var array ["$class" => ["$name" => $instance, ...], ...]
43			*/
44			private static $instances = array();
45
46			/**
47			* Constructor
48			*
49			* @param null\|bool\|int\|float\|string $value The value of the enumerator
50			* @param int\|null $ordinal The ordinal number of the enumerator
51			*/
52	16		final private function __construct($value, $ordinal = null)
53			{
54	16		$this->value = $value;
55	16		$this->ordinal = $ordinal;
56	16		}
57
58			/**
59			* Get the name of the enumerator
60			*
61			* @return string
62			* @see getName()
63			*/
64	1		public function __toString()
65			{
66	1		return $this->getName();
67			}
68
69			/**
70			* @throws LogicException Enums are not cloneable
71			* because instances are implemented as singletons
72			*/
73	1		final private function __clone()
74			{
75	1		throw new LogicException('Enums are not cloneable');
76			}
77
78			/**
79			* @throws LogicException Enums are not serializable
80			* because instances are implemented as singletons
81			*/
82	1		final public function __sleep()
83			{
84	1		throw new LogicException('Enums are not serializable');
85			}
86
87			/**
88			* @throws LogicException Enums are not serializable
89			* because instances are implemented as singletons
90			*/
91	1		final public function __wakeup()
92			{
93	1		throw new LogicException('Enums are not serializable');
94			}
95
96			/**
97			* Get the value of the enumerator
98			*
99			* @return null\|bool\|int\|float\|string
100			*/
101	21		final public function getValue()
102			{
103	21		return $this->value;
104			}
105
106			/**
107			* Get the name of the enumerator
108			*
109			* @return string
110			*/
111	8		final public function getName()
112			{
113	8		return array_search($this->value, self::detectConstants(get_called_class()), true);
114			}
115
116			/**
117			* Get the ordinal number of the enumerator
118			*
119			* @return int
120			*/
121	44		final public function getOrdinal()
122			{
123	44		if ($this->ordinal !== null) {
124	44		return $this->ordinal;
125			}
126
127			// detect ordinal
128	9		$ordinal = 0;
129	9		$value = $this->value;
130	9		foreach (self::detectConstants(get_called_class()) as $constValue) {
131	9		if ($value === $constValue) {
132	9		break;
133			}
134	9		++$ordinal;
135	9		}
136
137	9		$this->ordinal = $ordinal;
138	9		return $ordinal;
139			}
140
141			/**
142			* Compare this enumerator against another and check if it's the same.
143			*
144			* @param mixed $enumerator
145			* @return bool
146			*/
147	1		final public function is($enumerator)
148			{
149	1		return $this === $enumerator \|\| $this->value === $enumerator;
150			}
151
152			/**
153			* Get an enumerator instance of the given value or instance
154			*
155			* @param static\|null\|bool\|int\|float\|string $value
156			* @return static
157			* @throws InvalidArgumentException On an unknwon or invalid value
158			* @throws LogicException On ambiguous constant values
159			*/
160	67		final public static function get($value)
161			{
162	67		if ($value instanceof static && get_class($value) === get_called_class()) {
163	26		return $value;
164			}
165
166	48		$class = get_called_class();
167	48		$constants = self::detectConstants($class);
168	46		$name = array_search($value, $constants, true);
169	46	View Code Duplication	if ($name === false) {
170	7		$message = is_scalar($value)
171	7		? 'Unknown value ' . var_export($value, true)
172	7		: 'Invalid value of type ' . (is_object($value) ? get_class($value) : gettype($value));
173	7		throw new InvalidArgumentException($message);
174			}
175
176	40		if (!isset(self::$instances[$class][$name])) {
177	7		self::$instances[$class][$name] = new $class($constants[$name]);
178	7		}
179
180	40		return self::$instances[$class][$name];
181			}
182
183			/**
184			* Get an enumerator instance by the given name
185			*
186			* @param string $name The name of the enumerator
187			* @return static
188			* @throws InvalidArgumentException On an invalid or unknown name
189			* @throws LogicException On ambiguous values
190			*/
191	36		final public static function getByName($name)
192			{
193	36		$name = (string) $name;
194	36		$class = get_called_class();
195	36		if (isset(self::$instances[$class][$name])) {
196	31		return self::$instances[$class][$name];
197			}
198
199	8		$const = $class . '::' . $name;
200	8		if (!defined($const)) {
201	1		throw new InvalidArgumentException($const . ' not defined');
202			}
203
204	7		return self::$instances[$class][$name] = new $class(constant($const));
205			}
206
207			/**
208			* Get an enumeration instance by the given ordinal number
209			*
210			* @param int $ordinal The ordinal number or the enumerator
211			* @return static
212			* @throws InvalidArgumentException On an invalid ordinal number
213			* @throws LogicException On ambiguous values
214			*/
215	19		final public static function getByOrdinal($ordinal)
216			{
217	19		$ordinal = (int) $ordinal;
218	19		$class = get_called_class();
219	19		$constants = self::detectConstants($class);
220	19		$item = array_slice($constants, $ordinal, 1, true);
221	19		if (empty($item)) {
222	1		throw new InvalidArgumentException(sprintf(
223	1		'Invalid ordinal number, must between 0 and %s',
224	1		count($constants) - 1
225	1		));
226			}
227
228	18		$name = key($item);
229	18		if (isset(self::$instances[$class][$name])) {
230	17		return self::$instances[$class][$name];
231			}
232
233	2		return self::$instances[$class][$name] = new $class(current($item), $ordinal);
234			}
235
236			/**
237			* Clear all instantiated enumerators of the called class
238			*
239			* NOTE: This can break singleton behavior ... use it with caution!
240			*
241			* @return void
242			* @deprecated
243			*/
244			final public static function clear()
245			{
246			$class = get_called_class();
247			unset(self::$instances[$class], self::$constants[$class]);
248			}
249
250			/**
251			* Get a list of enumerator instances ordered by ordinal number
252			*
253			* @return static[]
254			*/
255	13		final public static function getEnumerators()
256			{
257	13		return array_map('self::getByName', array_keys(self::detectConstants(get_called_class())));
258			}
259
260			/**
261			* Get all available constants of the called class
262			*
263			* @return array
264			* @throws LogicException On ambiguous constant values
265			*/
266	58		final public static function getConstants()
267			{
268	58		return self::detectConstants(get_called_class());
269			}
270
271			/**
272			* Is the given enumerator part of this enumeration
273			*
274			* @param static\|null\|bool\|int\|float\|string $value
275			* @return bool
276			*/
277	1		final public static function has($value)
278			{
279	1		if ($value instanceof static && get_class($value) === get_called_class()) {
280	1		return true;
281			}
282
283	1		$class = get_called_class();
284	1		$constants = self::detectConstants($class);
285
286	1		return in_array($value, $constants, true);
287			}
288
289			/**
290			* Detect all available constants by the given class
291			*
292			* @param string $class
293			* @return array
294			* @throws LogicException On ambiguous constant values
295			*/
296	78		private static function detectConstants($class)
297			{
298	78		if (!isset(self::$constants[$class])) {
299	12		$reflection = new ReflectionClass($class);
300	12		$constants = array();
301
302			do {
303	12		$scopeConstants = array();
304	12		if (PHP_VERSION_ID >= 70100) {
305			// Since PHP-7.1 visibility modifiers are allowed for class constants
306			// for enumerations we are only interested in public once.
307			foreach ($reflection->getReflectionConstants() as $reflConstant) {
308			if ($reflConstant->isPublic()) {
309			$scopeConstants[ $reflConstant->getName() ] = $reflConstant->getValue();
310			}
311			}
312			} else {
313			// In PHP < 7.1 all class constants were public by definition
314	12		$scopeConstants = $reflection->getConstants();
315			}
316
317	12		$constants = $scopeConstants + $constants;
318	12		} while (($reflection = $reflection->getParentClass()) && $reflection->name !== __CLASS__);
319
320			// Detect ambiguous values and report names
321	12		$ambiguous = array();
322	12		foreach ($constants as $value) {
323	11		$names = array_keys($constants, $value, true);
324	11		if (count($names) > 1) {
325	2		$ambiguous[var_export($value, true)] = $names;
326	2		}
327	12		}
328	12		if (!empty($ambiguous)) {
329	2		throw new LogicException(
330			'All possible values needs to be unique. The following are ambiguous: '
331	2		. implode(', ', array_map(function ($names) use ($constants) {
332	2		return implode('/', $names) . '=' . var_export($constants[$names[0]], true);
333	2		}, $ambiguous))
334	2		);
335			}
336
337	10		self::$constants[$class] = $constants;
338	10		}
339
340	76		return self::$constants[$class];
341			}
342
343			/**
344			* Get an enumerator instance by the given name.
345			*
346			* This will be called automatically on calling a method
347			* with the same name of a defined enumerator.
348			*
349			* @param string $method The name of the enumeraotr (called as method)
350			* @param array $args There should be no arguments
351			* @return static
352			* @throws InvalidArgumentException On an invalid or unknown name
353			* @throws LogicException On ambiguous constant values
354			*/
355	21		final public static function __callStatic($method, array $args)
356			{
357	21		return self::getByName($method);
358			}
359			}
360

marc-mabe / php-enum

Push — deprecate_enum_clear ( f66221 )

Enum::getConstants() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like