marc-mabe /
php-enum
| Total Complexity | 53 |
| Total Lines | 421 |
| Duplicated Lines | 0 % |
| Coverage | 95.16% |
| Changes | 0 | ||
Complex classes like Enum often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Enum, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | abstract class Enum |
||
| 17 | { |
||
| 18 | /** |
||
| 19 | * The selected enumerator value |
||
| 20 | * |
||
| 21 | * @var null|bool|int|float|string |
||
| 22 | */ |
||
| 23 | private $value; |
||
|
1 ignored issue
–
show
|
|||
| 24 | |||
| 25 | /** |
||
| 26 | * The ordinal number of the enumerator |
||
| 27 | * |
||
| 28 | * @var null|int |
||
| 29 | */ |
||
| 30 | private $ordinal; |
||
|
1 ignored issue
–
show
|
|||
| 31 | |||
| 32 | /** |
||
| 33 | * An array of available constants by class |
||
| 34 | * |
||
| 35 | * @var array ["$class" => ["$name" => $value, ...], ...] |
||
| 36 | */ |
||
| 37 | private static $constants = array(); |
||
|
1 ignored issue
–
show
|
|||
| 38 | |||
| 39 | /** |
||
| 40 | * Already instantiated enumerators |
||
| 41 | * |
||
| 42 | * @var array ["$class" => ["$name" => $instance, ...], ...] |
||
| 43 | */ |
||
| 44 | private static $instances = array(); |
||
|
1 ignored issue
–
show
|
|||
| 45 | |||
| 46 | /** |
||
| 47 | * Constructor |
||
| 48 | * |
||
| 49 | * @param null|bool|int|float|string $value The value of the enumerator |
||
|
2 ignored issues
–
show
|
|||
| 50 | * @param int|null $ordinal The ordinal number of the enumerator |
||
|
2 ignored issues
–
show
|
|||
| 51 | */ |
||
| 52 | 16 | final private function __construct($value, $ordinal = null) |
|
|
2 ignored issues
–
show
|
|||
| 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() |
|
| 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() |
|
| 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 |
||
|
1 ignored issue
–
show
|
|||
| 100 | */ |
||
| 101 | 22 | final public function getValue() |
|
| 102 | { |
||
| 103 | 22 | 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 |
||
|
1 ignored issue
–
show
|
|||
| 120 | */ |
||
| 121 | 44 | final public function getOrdinal() |
|
| 122 | { |
||
| 123 | 44 | if ($this->ordinal !== null) { |
|
| 124 | 43 | 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 |
||
|
1 ignored issue
–
show
|
|||
| 146 | */ |
||
| 147 | 2 | final public function is($enumerator) |
|
| 148 | { |
||
| 149 | 2 | return $this === $enumerator || $this->value === $enumerator |
|
| 150 | |||
| 151 | // The following additional conditions are required only because of the issue of serializable singletons |
||
|
1 ignored issue
–
show
|
|||
| 152 | 2 | || ($enumerator instanceof static |
|
| 153 | 2 | && get_class($enumerator) === get_called_class() |
|
| 154 | 2 | && $enumerator->value === $this->value |
|
| 155 | 2 | ); |
|
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Get an enumerator instance of the given value or instance |
||
| 160 | * |
||
| 161 | * @param static|null|bool|int|float|string $value |
||
|
1 ignored issue
–
show
|
|||
| 162 | * @return static |
||
| 163 | * @throws InvalidArgumentException On an unknwon or invalid value |
||
| 164 | * @throws LogicException On ambiguous constant values |
||
| 165 | */ |
||
| 166 | 67 | final public static function get($value) |
|
| 167 | { |
||
| 168 | 67 | if ($value instanceof static && get_class($value) === get_called_class()) { |
|
| 169 | 26 | return $value; |
|
| 170 | } |
||
| 171 | |||
| 172 | 48 | return static::byValue($value); |
|
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 176 | * Get an enumerator instance by the given value |
||
| 177 | * |
||
| 178 | * @param mixed $value |
||
| 179 | * @return static |
||
| 180 | * @throws InvalidArgumentException On an unknwon or invalid value |
||
| 181 | * @throws LogicException On ambiguous constant values |
||
| 182 | */ |
||
| 183 | 48 | final public static function byValue($value) |
|
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Get an enumerator instance by the given name |
||
| 204 | * |
||
| 205 | * @param string $name The name of the enumerator |
||
|
1 ignored issue
–
show
|
|||
| 206 | * @return static |
||
| 207 | * @throws InvalidArgumentException On an invalid or unknown name |
||
| 208 | * @throws LogicException On ambiguous values |
||
| 209 | */ |
||
| 210 | 37 | final public static function byName($name) |
|
| 211 | { |
||
| 212 | 37 | $name = (string) $name; |
|
| 213 | 37 | $class = get_called_class(); |
|
| 214 | 37 | if (isset(self::$instances[$class][$name])) { |
|
| 215 | 31 | return self::$instances[$class][$name]; |
|
| 216 | } |
||
| 217 | |||
| 218 | 8 | $const = $class . '::' . $name; |
|
| 219 | 8 | if (!defined($const)) { |
|
| 220 | 1 | throw new InvalidArgumentException($const . ' not defined'); |
|
| 221 | } |
||
| 222 | |||
| 223 | 7 | return self::$instances[$class][$name] = new $class(constant($const)); |
|
| 224 | } |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Get an enumeration instance by the given ordinal number |
||
| 228 | * |
||
| 229 | * @param int $ordinal The ordinal number or the enumerator |
||
|
2 ignored issues
–
show
|
|||
| 230 | * @return static |
||
| 231 | * @throws InvalidArgumentException On an invalid ordinal number |
||
| 232 | * @throws LogicException On ambiguous values |
||
| 233 | */ |
||
| 234 | 19 | final public static function byOrdinal($ordinal) |
|
| 235 | { |
||
| 236 | 19 | $ordinal = (int) $ordinal; |
|
| 237 | 19 | $class = get_called_class(); |
|
| 238 | 19 | $constants = self::detectConstants($class); |
|
| 239 | 19 | $item = array_slice($constants, $ordinal, 1, true); |
|
| 240 | 19 | if (empty($item)) { |
|
| 241 | 1 | throw new InvalidArgumentException(sprintf( |
|
| 242 | 1 | 'Invalid ordinal number, must between 0 and %s', |
|
| 243 | 1 | count($constants) - 1 |
|
| 244 | 1 | )); |
|
| 245 | } |
||
| 246 | |||
| 247 | 18 | $name = key($item); |
|
| 248 | 18 | if (isset(self::$instances[$class][$name])) { |
|
| 249 | 17 | return self::$instances[$class][$name]; |
|
| 250 | } |
||
| 251 | |||
| 252 | 2 | return self::$instances[$class][$name] = new $class(current($item), $ordinal); |
|
| 253 | } |
||
| 254 | |||
| 255 | /** |
||
| 256 | * Get an enumerator instance by the given name |
||
| 257 | * |
||
| 258 | * @param string $name The name of the enumerator |
||
|
1 ignored issue
–
show
|
|||
| 259 | * @return static |
||
| 260 | * @throws InvalidArgumentException On an invalid or unknown name |
||
| 261 | * @throws LogicException On ambiguous values |
||
| 262 | * @deprecated |
||
| 263 | */ |
||
| 264 | final public static function getByName($name) |
||
| 265 | { |
||
| 266 | return static::byName($name); |
||
| 267 | } |
||
| 268 | |||
| 269 | /** |
||
| 270 | * Get an enumeration instance by the given ordinal number |
||
| 271 | * |
||
| 272 | * @param int $ordinal The ordinal number or the enumerator |
||
|
2 ignored issues
–
show
|
|||
| 273 | * @return static |
||
| 274 | * @throws InvalidArgumentException On an invalid ordinal number |
||
| 275 | * @throws LogicException On ambiguous values |
||
| 276 | * @deprecated |
||
| 277 | */ |
||
| 278 | final public static function getByOrdinal($ordinal) |
||
| 279 | { |
||
| 280 | return static::byOrdinal($ordinal); |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Clear all instantiated enumerators of the called class |
||
| 285 | * |
||
| 286 | * NOTE: This can break singleton behavior ... use it with caution! |
||
| 287 | * |
||
| 288 | * @return void |
||
| 289 | * @deprecated |
||
| 290 | */ |
||
| 291 | final public static function clear() |
||
| 292 | { |
||
| 293 | $class = get_called_class(); |
||
| 294 | unset(self::$instances[$class], self::$constants[$class]); |
||
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * Get a list of enumerator instances ordered by ordinal number |
||
| 299 | * |
||
| 300 | * @return static[] |
||
| 301 | */ |
||
| 302 | 13 | final public static function getEnumerators() |
|
| 303 | { |
||
| 304 | 13 | return array_map('self::byName', array_keys(self::detectConstants(get_called_class()))); |
|
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Get a list of enumerator values ordered by ordinal number |
||
| 309 | * |
||
| 310 | * @return mixed[] |
||
| 311 | */ |
||
| 312 | 1 | final public static function getValues() |
|
| 313 | { |
||
| 314 | 1 | return array_values(self::detectConstants(get_called_class())); |
|
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Get a list of enumerator names ordered by ordinal number |
||
| 319 | * |
||
| 320 | * @return string[] |
||
| 321 | */ |
||
| 322 | 1 | final public static function getNames() |
|
| 325 | } |
||
| 326 | /* |
||
| 327 | * Get a list of enumerator ordinal numbers |
||
| 328 | * |
||
| 329 | * @return int[] |
||
| 330 | */ |
||
| 331 | 1 | final public static function getOrdinals() |
|
| 332 | { |
||
| 333 | 1 | $count = count(self::detectConstants(get_called_class())); |
|
| 334 | 1 | return $count === 0 ? array() : range(0, $count - 1); |
|
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Get all available constants of the called class |
||
| 339 | * |
||
| 340 | * @return array |
||
| 341 | * @throws LogicException On ambiguous constant values |
||
| 342 | */ |
||
| 343 | 62 | final public static function getConstants() |
|
| 346 | } |
||
| 347 | |||
| 348 | /** |
||
| 349 | * Is the given enumerator part of this enumeration |
||
| 350 | * |
||
| 351 | * @param static|null|bool|int|float|string $value |
||
|
1 ignored issue
–
show
|
|||
| 352 | * @return bool |
||
|
1 ignored issue
–
show
|
|||
| 353 | */ |
||
| 354 | 1 | final public static function has($value) |
|
| 364 | } |
||
| 365 | |||
| 366 | /** |
||
| 367 | * Detect all available constants by the given class |
||
| 368 | * |
||
| 369 | * @param string $class |
||
| 370 | * @return array |
||
| 371 | * @throws LogicException On ambiguous constant values |
||
| 372 | */ |
||
| 373 | 82 | private static function detectConstants($class) |
|
| 420 | } |
||
| 421 | |||
| 422 | /** |
||
| 423 | * Get an enumerator instance by the given name. |
||
| 424 | * |
||
| 425 | * This will be called automatically on calling a method |
||
| 426 | * with the same name of a defined enumerator. |
||
| 427 | * |
||
| 428 | * @param string $method The name of the enumeraotr (called as method) |
||
|
1 ignored issue
–
show
|
|||
| 429 | * @param array $args There should be no arguments |
||
|
1 ignored issue
–
show
|
|||
| 430 | * @return static |
||
| 431 | * @throws InvalidArgumentException On an invalid or unknown name |
||
| 432 | * @throws LogicException On ambiguous constant values |
||
| 433 | */ |
||
| 434 | 22 | final public static function __callStatic($method, array $args) |
|
| 439 |
Loading history...
