<?php

namespace EnumType;

/**
 * This class stands for FlatShippingRateOptionCodeType EnumType
 * Meta informations extracted from the WSDL
 * - documentation: This enumerated type is deprecated.
 * @subpackage Enumerations
 */
class FlatShippingRateOptionCodeType
{
    /**
     * Constant for value 'ChargeAmountForEachAdditionalItem'
     * @return string 'ChargeAmountForEachAdditionalItem'
     */
    const VALUE_CHARGE_AMOUNT_FOR_EACH_ADDITIONAL_ITEM = 'ChargeAmountForEachAdditionalItem';
    /**
     * Constant for value 'DeductAmountFromEachAdditionalItem'
     * @return string 'DeductAmountFromEachAdditionalItem'
     */
    const VALUE_DEDUCT_AMOUNT_FROM_EACH_ADDITIONAL_ITEM = 'DeductAmountFromEachAdditionalItem';
    /**
     * Constant for value 'ShipAdditionalItemsFree'
     * @return string 'ShipAdditionalItemsFree'
     */
    const VALUE_SHIP_ADDITIONAL_ITEMS_FREE = 'ShipAdditionalItemsFree';
    /**
     * Constant for value 'CustomCode'
     * @return string 'CustomCode'
     */
    const VALUE_CUSTOM_CODE = 'CustomCode';
    /**
     * 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_CHARGE_AMOUNT_FOR_EACH_ADDITIONAL_ITEM
     * @uses self::VALUE_DEDUCT_AMOUNT_FROM_EACH_ADDITIONAL_ITEM
     * @uses self::VALUE_SHIP_ADDITIONAL_ITEMS_FREE
     * @uses self::VALUE_CUSTOM_CODE
     * @return string[]
     */
    public static function getValidValues()
    {
        return array(
            self::VALUE_CHARGE_AMOUNT_FOR_EACH_ADDITIONAL_ITEM,
            self::VALUE_DEDUCT_AMOUNT_FROM_EACH_ADDITIONAL_ITEM,
            self::VALUE_SHIP_ADDITIONAL_ITEMS_FREE,
            self::VALUE_CUSTOM_CODE,
        );
    }
    /**
     * Method returning the class name
     * @return string __CLASS__
     */
    public function __toString()
    {
        return __CLASS__;
    }
}
