<?php

namespace dgsoft\EnumType;

/**
 * This class stands for AmountDeterminationType EnumType
 * @package Dg
 * @subpackage Enumerations
 */
class DgAmountDeterminationType
{
    /**
     * Constant for value 'Inclusive'
     * @return string 'Inclusive'
     */
    const VALUE_INCLUSIVE = 'Inclusive';
    /**
     * Constant for value 'Exclusive'
     * @return string 'Exclusive'
     */
    const VALUE_EXCLUSIVE = 'Exclusive';
    /**
     * Constant for value 'Cumulative'
     * @return string 'Cumulative'
     */
    const VALUE_CUMULATIVE = 'Cumulative';
    /**
     * Return true if value is allowed
     * @uses self::getValidValues()
     * @param mixed $value value
     * @return bool true|false
     */
    public static function valueIsValid($value)
    {
        return ($value === null) || in_array($value, self::getValidValues(), true);
    }
    /**
     * Return allowed values
     * @uses self::VALUE_INCLUSIVE
     * @uses self::VALUE_EXCLUSIVE
     * @uses self::VALUE_CUMULATIVE
     * @return string[]
     */
    public static function getValidValues()
    {
        return array(
            self::VALUE_INCLUSIVE,
            self::VALUE_EXCLUSIVE,
            self::VALUE_CUMULATIVE,
        );
    }
    /**
     * Method returning the class name
     * @return string __CLASS__
     */
    public function __toString()
    {
        return __CLASS__;
    }
}
