SpareParts\Enum\Enum

Complexity

Total Complexity

10

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
A	__toString()	0	4	1
A	__callStatic()	0	4	1
A	instance()	0	8	2
A	__clone()	0	4	1
A	__sleep()	0	4	1
A	__wakeup()	0	4	1

<?php
namespace SpareParts\Enum;

use SpareParts\Enum\Exception\InvalidEnumSetupException;
use SpareParts\Enum\Exception\InvalidEnumValueException;
use SpareParts\Enum\Exception\OperationNotAllowedException;

/**
 *
 */
abstract class Enum
{

    /**
     * @var string[]
     */
    protected static $values = [];

    /**
     * @var $this[]
     */
    protected static $instances = [];

    /**
     * @var string
     */
    protected $value;

    /**
     * PROTECTED!! Not callable directly.
     * @see static::instance()
     * @see static::__callStatic()
     * @internal
     *
     * @param string $value
     */
    protected function __construct($value)
    {
        if (empty(static::$values)) {
            throw new InvalidEnumSetupException('Incorrect setup! Enum '.get_called_class().' doesn\'t have its static::$values set.');
        }
        if (!in_array($value, static::$values)) {
            throw new InvalidEnumValueException('Enum '.get_called_class().'does not contain value '.$value.'. Possible values are: '.implode(', ', static::$values));
        }
        $this->value = $value;
    }

    /**
     * String representation
     */
    public function __toString()
    {
        return $this->value;
    }

    /**
     * @param string $method
     * @param array $args
     *
     * @return \SpareParts\Enum\Enum
     */
    public static function __callStatic($method, $args)
    {
        return static::instance($method);
    }

    /**
     * @param string $value
     *
     * @return $this
     */
    public static function instance($value)
    {
        if (!isset(static::$instances[get_called_class()][$value])) {
            static::$instances[get_called_class()][$value] = new static($value);
        }

        return static::$instances[get_called_class()][$value];
    }

    public function __clone()
    {
        throw new OperationNotAllowedException('Singleton cannot be cloned.');
    }

    public function __sleep()
    {
        throw new OperationNotAllowedException('Singleton cannot be serialized.');
    }

    public function __wakeup()
    {
        throw new OperationNotAllowedException('Singleton cannot be serialized');
    }
}