StraTDeS\VO\Single\Enum

Complexity

Total Complexity

7

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

75%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	value()	0	3	1
A	valueNotValidMessage()	0	3	1
A	fromValue()	0	3	1
A	__construct()	0	4	1
A	checkValueIsValid()	0	4	2
A	equal()	0	3	1

<?php

namespace StraTDeS\VO\Single;

abstract class Enum
{
    protected $value;

    private function __construct($value)
    {
        $this->checkValueIsValid($value);
        $this->value = $value;
    }

    /**
     * @param $value
     * @return static
     */
    public static function fromValue($value)
    {
        return new static($value);
    }

    /**
     * Returns value.
     *
     * Override this method to strict type your Enum.
     *
     * @return mixed
     */
    public function value()
    {
        return $this->value;
    }

    public abstract function allowedValues(): array;

    /**
     * Checks whether the value is valid for this Enum.
     *
     * Override this method to add other validations.
     *
     * @param $value
     */
    protected function checkValueIsValid($value): void
    {
        if (!in_array($value, $this->allowedValues())) {
            throw new \InvalidArgumentException($this->valueNotValidMessage($value));
        }
    }

    /**
     * Generates the error message.
     *
     * Override this method if the validation is ok but you want a different message.
     *
     * @param $value
     * @return string
     */
    protected function valueNotValidMessage($value): string
    {
        return "$value is not a valid value for this Enum";
    }

    public function equal(Enum $enum): bool
    {
        return $this->value == $enum->value;
    }
}