EEH_Money

Complexity

Total Complexity

37

Size/Duplication

Total Lines	209
Duplicated Lines	14.83 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	strip_localized_money_formatting()	0	20	1
A	convert_to_float_from_localized_money()	0	4	1
C	compare_floats()	28	66	26
A	get_format_for_jqplot()	0	10	2
A	get_format_for_google_charts()	0	23	3
A	get_currency_config()	3	14	4

<?php
/**
 * This file contains a helper class for money type actions.
 *
 * @since %VER%
 * @package  Event Espresso
 * @subpackage helper
 */
if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 /**
 *
 * Money helper class.
 * This class has helper methods that help with money related conversions and calculations.
 *
 * @since %VER%
 *
 * @package		Event Espresso
 * @subpackage	helpers
 * @author		Darren Ethier
 *
 * ------------------------------------------------------------------------
 */
class EEH_Money extends EEH_Base  {


    /**
     * This removes all localized money formatting from the incoming value
     *
     * @param int|float|string $money_value
     * @param string           $CNT_ISO
     * @return float
     * @throws EE_Error
     */
	public static function strip_localized_money_formatting($money_value, $CNT_ISO = '') {
        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
        $money_value = str_replace(
		    array(
                $currency_config->thsnds,
                $currency_config->dec_mrk,
            ),
            array(
                '', // remove thousands separator
                '.', // convert decimal mark to what PHP expects
            ),
            $money_value
        );
        $money_value = filter_var(
            $money_value,
            FILTER_SANITIZE_NUMBER_FLOAT,
            FILTER_FLAG_ALLOW_FRACTION
        );
        return $money_value;
    }



    /**
     * This converts an incoming localized money value into a standard float item (to three decimal places)
     *
     * @param int|string $money_value
     * @return float
     * @throws EE_Error
     */
	public static function convert_to_float_from_localized_money($money_value ) {
		//float it! and round to three decimal places
        return round ( (float) EEH_Money::strip_localized_money_formatting($money_value), 3 );
	}



	/**
	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
	 * This should be used to compare floats instead of normal '==' because floats
	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
	 * but actually differ by 0.00000001.
	 *
	 * @see http://biostall.com/php-function-to-compare-floating-point-numbers
	 * @param float  $float1
	 * @param float  $float2
	 * @param string $operator  The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
	 * @return bool whether the equation is true or false
	 * @throws EE_Error
	 */

	public static function compare_floats( $float1, $float2, $operator='=' ) {
		// Check numbers to 5 digits of precision
		$epsilon = 0.00001;

		$float1 = (float)$float1;
		$float2 = (float)$float2;

		switch ($operator) {
			// equal
			case "=":
			case "==":
			case "===":
			case "eq":
				if (abs($float1 - $float2) < $epsilon) {
					return true;
				}
				break;
			// less than
			case "<":
			case "lt":
				if (abs($float1 - $float2) < $epsilon) {
					return false;
				} else {
					if ($float1 < $float2) {
						return true;
					}
				}
				break;
			// less than or equal
			case "<=":
			case "lte":
				if (self::compare_floats($float1, $float2, '<') || self::compare_floats($float1, $float2, '=')) {
					return true;
				}
				break;
			// greater than
			case ">":
			case "gt":
				if (abs($float1 - $float2) < $epsilon) {
					return false;
				} else {
					if ($float1 > $float2) {
						return true;
					}
				}
				break;
			// greater than or equal
			case ">=":
			case "gte":
				if (self::compare_floats($float1, $float2, '>') || self::compare_floats($float1, $float2, '=')) {
					return true;
				}
				break;
			case "<>":
			case "!=":
			case "ne":
				if (abs($float1 - $float2) > $epsilon) {
					return true;
				}
				break;
			default:
				throw new EE_Error(__( "Unknown operator '" . $operator . "' in EEH_Money::compare_floats()", 'event_espresso' ) );
		}

		return false;
	}



    /**
     * This returns a localized format string suitable for jQplot.
     *
     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
     *                         Otherwise will use currency settings for current active country on site.
     * @return string
     * @throws EE_Error
     */
	public static function get_format_for_jqplot( $CNT_ISO = '') {
		//default format
		$format = 'f';
		$currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
        //first get the decimal place and number of places
		$format = "%'." . $currency_config->dec_plc . $format;
		//currency symbol on right side.
		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
		return $format;
	}



    /**
     * This returns a localized format string suitable for usage with the Google Charts API format param.
     *
     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
     *                         Otherwise will use currency settings for current active country on site.
     *                         Note: GoogleCharts uses ICU pattern set
     *                         (@see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
     * @return string
     * @throws EE_Error
     */
	public static function get_format_for_google_charts( $CNT_ISO = '' ) {
		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
		$decimal_places_placeholder = str_pad( '', $currency_config->dec_plc, '0' );
		//first get the decimal place and number of places
		$format = '#,##0.' . $decimal_places_placeholder;

		//currency symbol on right side.
		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
		$formatterObject = array(
			'decimalSymbol' => $currency_config->dec_mrk,
			'groupingSymbol' => $currency_config->thsnds,
			'fractionDigits' => $currency_config->dec_plc,
		);
		if ( $currency_config->sign_b4 ) {
			$formatterObject['prefix'] = $currency_config->sign;
		} else {
			$formatterObject['suffix'] = $currency_config->sign;
		}
		return array(
			'format' => $format,
			'formatterObject' => $formatterObject,
		);
	}



    /**
     * @param string $CNT_ISO
     * @return EE_Currency_Config|null
     * @throws EE_Error
     */
    public static function get_currency_config($CNT_ISO = '')
    {
        //if CNT_ISO passed lets try to get currency settings for it.
        $currency_config = $CNT_ISO !== ''
            ? new EE_Currency_Config($CNT_ISO)
            : null;
        //default currency settings for site if not set
        if (! $currency_config instanceof EE_Currency_Config) {
            $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                ? EE_Registry::instance()->CFG->currency
                : new EE_Currency_Config();
        }
        return $currency_config;
    }

} //end class EEH_Money