ZingleCom\Enum\AbstractEnum

Complexity

Total Complexity

11

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getConstantName()	0	3	1
A	getGenerator()	0	7	2
A	__toString()	0	3	1
A	getOptions()	0	3	1
A	getMeta()	0	3	1
A	is()	0	3	1
A	__construct()	0	10	2
A	getValue()	0	3	1
A	getDisplayName()	0	6	1

<?php

namespace ZingleCom\Enum;

use ZingleCom\Enum\Exception\InvalidValueException;
use ZingleCom\Enum\Meta\GeneratorFactory;
use ZingleCom\Enum\Meta\GeneratorInterface;

/**
 * Class AbstractEnum
 */
abstract class AbstractEnum implements EnumInterface
{
    /**
     * @var GeneratorInterface
     */
    private static $generator;

    /**
     * @var string
     */
    private $constantName;

    /**
     * @var mixed
     */
    private $value;


    /**
     * AbstractEnum constructor.
     * @param mixed $value
     * @throws Exception\EnumException
     * @throws Exception\MissingValueException
     * @throws InvalidValueException
     */
    public function __construct($value)
    {
        $meta = self::getMeta();

        if (!$meta->isValid($value)) {
            throw new InvalidValueException($value);
        }

        $this->constantName = $meta->getConstantName($value);
        $this->value        = $value;
    }

    /**
     * @return string
     */
    public function getConstantName(): string
    {
        return $this->constantName;
    }

    /**
     * @return mixed
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * @return string
     */
    public function getDisplayName(): string
    {
        return mb_convert_case(
            strtolower(str_replace('_', ' ', $this->constantName)),
            MB_CASE_TITLE,
            'UTF-8'
        );
    }

    /**
     * @param mixed $value
     * @return bool
     */
    public function is($value): bool
    {
        return $value === $this->getValue();
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return strval($this->getValue());
    }

    /**
     * @return GeneratorInterface
     */
    private static function getGenerator(): GeneratorInterface
    {
        if (null === self::$generator) {
            self::$generator = GeneratorFactory::create();
        }

        return self::$generator;
    }

    /**
     * @return MetaInterface
     */
    private static function getMeta(): MetaInterface
    {
        return self::getGenerator()->get(get_called_class());
    }

    /**
     * Makes this compatible with Symfony
     * 
     * @return array
     */
    public static function getOptions(): array 
    {
        return array_flip(self::getMeta()->getConstants()->toArray());

The expression return array_flip(self::getMeta()->getConstants()->toArray()) could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }
}