Teabugger\Enum\Enum

Complexity

Total Complexity

7

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	17	3
A	__construct()	0	4	1
A	__toString()	0	3	1
A	getConstants()	0	4	1
A	__debugInfo()	0	5	1

<?php

declare(strict_types=1);

namespace Teabugger\Enum;

use ReflectionClass;
use ReflectionException;

abstract class Enum
{
    private string $value;

    /**
     * Enum constructor.
     * @param string $value
     * @throws EnumException
     */
    public function __construct(string $value)
    {
        $this->validate($value);
        $this->value = $value;
    }

    /**
     * @param string $value
     * @throws EnumException
     */
    private function validate(string $value): void
    {
        $constants = $this->getConstants();
        $valid = in_array($value, $constants, true);
        if (!$valid) {
            $class = get_class($this);
            if (!empty($constants)) {
                $implodedConstants = implode(PHP_EOL, $constants);
                $message = <<< EOD
                Invalid ENUM option for class {$class}.
                Given: {$value}. Expected one of:
                $implodedConstants
                EOD;
            } else {
                $message = "Invalid ENUM: missing options. Class: {$class}.";
            }
            throw new EnumException($message);
        }
    }

    /**
     * @return string[]
     * @throws ReflectionException
     */
    private function getConstants(): array
    {
        $class = new ReflectionClass($this);
        return $class->getConstants();
    }

    public function __toString(): string
    {
        return $this->value;
    }

    /**
     * @return mixed[]
     * @throws ReflectionException
     */
    public function __debugInfo(): array
    {
        return [
            'value' => $this->value,
            'options' => $this->getConstants(),
        ];
    }
}