SubjectivePHP\Spl\Types\AbstractEnum

Complexity

Total Complexity

7

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__toString()	0	4	1
A	__callStatic()	0	9	2
A	all()	0	12	3

<?php
namespace SubjectivePHP\Spl\Types;

/**
 * Defines the base AbstractEnum class.
 */
abstract class AbstractEnum
{
    /**
     * String value of enum.
     *
     * @var string
     */
    private $value;

    /**
     * Construct a new AbstractEnum object.
     *
     * @param string $value The string value of the enum.
     */
    final private function __construct(string $value)
    {
        $this->value = strtolower($value);
    }

    /**
     * Returns the string value of the enum.
     *
     * @return string
     */
    final public function __toString() : string
    {
        return $this->value;
    }

    /**
     * Returns a new instance of the AbstractEnum class.
     *
     * @param string $name      The string value of the enum.
     * @param array  $arguments Unused.
     *
     * @return AbstractEnum
     *
     * @throws \UnexpectedValueException Thrown if $name is not a defined Enum constant.
     */
    final public static function __callStatic(string $name, /** @scrutinizer ignore-unused */array $arguments) : self
    {
        $class = get_called_class();
        if (defined("{$class}::" . strtoupper($name))) {
            return new static($name);
        }

        throw new \UnexpectedValueException("'{$name}' is not a valid {$class}");
    }

    /**
     * Returns an array of all enums.
     *
     * @return AbstractEnum[]
     */
    final public static function all() : array
    {
        static $all = null;

        if ($all === null) {
            foreach ((new \ReflectionClass(get_called_class()))->getConstants() as $constant) {
                $all[] = new static($constant);
            }
        }

        return $all;
    }
}