uruba/FinanCalc

<?php

namespace FinanCalc\Utils {

    use Exception;
    use FinanCalc\Constants\ErrorMessages;

    /**
     * util Enum class pulled in its entirety from here: http://www.codeproject.com/Articles/683009/Enum-support-in-PHP
     *
     * @author Johan Ohlin
     */
    abstract class Enum
    {
        protected $value;

        /**
         * Return string representation of this enum
         *
         * @return integer
         */
        public function getValue()
        {
            return $this->value;
        }

        /**
         * Tries to set the value  of this enum
         *
         * @param int $value
         * @throws Exception If value is not part of this enum
         */
        public function setValue($value)
        {
            if ($this->isValidEnumValue($value)) {
                $this->value = $value;
            } else {
                throw new Exception(ErrorMessages::getInvalidTypeMessage());
            }
        }

        /**
         * Validates if the type given is part of this enum class
         *
         * @param string $checkValue
         * @return bool
         */
        public function isValidEnumValue($checkValue)
        {
            $reflector = new \ReflectionClass(get_class($this));
            foreach ($reflector->getConstants() as $validValue) {
                if ($validValue == $checkValue) {
                    return true;
                }
            }
            return false;
        }

        /**
         * @param string $value Value for this display type
         */
        public function __construct($value)
        {
            $this->setValue($value);
        }

        /**
         * With a magic getter you can get the value from this enum using
         * any variable name as in:
         *
         * <code>
         *   $myEnum = new MyEnum(MyEnum::start);
         *   echo $myEnum->v;
         * </code>
         *
         * @param string $property
         * @return integer
         */
        public function __get($property)
        {
            return $this->value;
        }

        /**
         * With a magic setter you can set the enum value using any variable
         * name as in:
         *
         * <code>
         *   $myEnum = new MyEnum(MyEnum::Start);
         *   $myEnum->v = MyEnum::End;
         * </code>
         *
         * @param string $property
         * @param string $value
         * @throws Exception Throws exception if an invalid type is used
         */
        public function __set($property, $value)
        {
            $this->setValue($value);
        }

        /**
         * If the enum is requested as a string then this function will be automatically
         * called and the value of this enum will be returned as a string.
         *
         * @return string
         */
        public function __toString()
        {
            return (string)$this->value;
        }
    }
}