Amount formatting

assets/js/admin/admin-scripts.js

@@ -727,7 +727,70 @@ jQuery.noConflict();
             $('.give_user_search_results span').html('');
         });
 
-    });
+        /**
+         *  Amount format validation form price field setting
+         */
+        var $give_money_fields = $('input.give-money-field, input.give-price-field');
+        if( $give_money_fields.length ) {
+            var thousand_separator = give_vars.thousands_separator.trim(),
+                decimal_separator = give_vars.decimal_separator.trim(),
+                thousand_separator_count = '',
+                price_string = '',
+
+                // Thousand separation limit in price depends upon decimal separator symbol.
+                // If thousand separator is equal to decimal separator then price does not have more then 1 thousand separator otherwise limit is zero.
+                thousand_separator_limit = ( decimal_separator === thousand_separator ? 1 : 0 );
+
+            // Add qtip to all money input fields.
+            $give_money_fields.each(function() {
+                $(this).qtip({
+                    style: 'qtip-dark qtip-tipsy',
+                    content: {
+                        text: give_vars.price_format_guide.trim()
+                    },
+                    show: '',
+                    position: {
+                        my: 'bottom center',
+                        at: 'top center'
+                    }
+                });
+            });
+
+            // Check & show message on keyup event.
+            $give_money_fields.bind( 'keyup', function(){
+                // Count thousand separator in price string.
+                thousand_separator_count = ( $(this).val().match( new RegExp( thousand_separator, 'g' ) ) || [] ).length;
+
+                // Show qtip conditionally if thousand separator detected on price string.
+                if(
+                    ( -1 !== $(this).val().indexOf( thousand_separator ) )
+                    && ( thousand_separator_limit < thousand_separator_count )
+                ) {
+                    $(this).qtip('show');
+                }else{
+                    $(this).qtip('hide');
+                }
+
+                // Reset thousand separator count.
+                thousand_separator_count = '';
+            });
 
+            // Format price sting of input field on focuout.
+            $give_money_fields.on( 'focusout', function(){
+                price_string = $(this).val();
+                thousand_separator_count = ( price_string.match( new RegExp( thousand_separator, 'g' ) ) || [] ).length;
+
+                // Replace all thousand separator except one.
+                while ( thousand_separator_limit < thousand_separator_count ) {
+                    price_string = price_string.replace( thousand_separator, '' );
+                    --thousand_separator_count;
+                }
+
+                // Update format price string in input field.
+                $(this).val( price_string );
+            });
+        }
+
+    });
 
 })(jQuery);

includes/admin/class-give-settings.php

@@ -327,6 +327,7 @@ public function give_settings( $active_tab ) {
 							'desc'    => __( 'The symbol (typically , or .) to separate thousands', 'give' ),
 							'id'      => 'thousands_separator',
 							'type'    => 'text_small',
+							'sanitization_cb' => 'give_sanitize_thousand_separator',
 							'default' => ',',
 						),
 						array(

includes/admin/forms/metabox.php

@@ -75,9 +75,10 @@ function give_single_forms_cmb2_metaboxes( array $meta_boxes ) {
 					'row_classes'  => 'give-subfield',
 					'before_field' => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
 					'after_field'  => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
-					'attributes'   => array(
-						'placeholder' => give_format_amount( '1.00' ),
-						'value'       => give_format_amount( $price ),
+                    'sanitization_cb'   => 'give_sanitize_amount',
+                    'attributes'   => array(
+						'placeholder' => give_format_decimal( '1.00' ),
+						'value'       => give_format_decimal( $price ),
 						'class'       => 'cmb-type-text-small give-money-field',
 					),
 				),
@@ -104,13 +105,14 @@ function give_single_forms_cmb2_metaboxes( array $meta_boxes ) {
 							'type' => 'levels_id',
 						),
 						array(
-							'name'         => __( 'Amount', 'give' ),
-							'id'           => $prefix . 'amount',
-							'type'         => 'text_small',
-							'before_field' => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol  give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
-							'after_field'  => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol  give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
-							'attributes'   => array(
-								'placeholder' => give_format_amount( '1.00' ),
+							'name'              => __( 'Amount', 'give' ),
+							'id'                => $prefix . 'amount',
+							'type'              => 'text_small',
+							'before_field'      => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol  give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
+							'after_field'       => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol  give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
+							'sanitization_cb'   => 'give_sanitize_amount',
+                            'attributes'        => array(
+								'placeholder' => '1.00',
 								'class'       => 'cmb-type-text-small give-money-field',
 							),
 							'before'       => 'give_format_admin_multilevel_amount',
@@ -164,9 +166,10 @@ function give_single_forms_cmb2_metaboxes( array $meta_boxes ) {
 					'row_classes'  => 'give-subfield',
 					'before_field' => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
 					'after_field'  => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
-					'attributes'   => array(
-						'placeholder' => give_format_amount( '1.00' ),
-						'value'       => give_format_amount( $custom_amount_minimum ),
+                    'sanitization_cb'   => 'give_sanitize_amount',
+                    'attributes'   => array(
+						'placeholder' => give_format_decimal('1.00'),
+						'value'       => give_format_decimal( $custom_amount_minimum ),
 						'class'       => 'cmb-type-text-small give-money-field',
 					),
 				),
@@ -194,16 +197,17 @@ function give_single_forms_cmb2_metaboxes( array $meta_boxes ) {
 					),
 				),
 				array(
-					'name'         => __( 'Goal Amount', 'give' ),
-					'description'  => __( 'This is the monetary goal amount you want to reach for this donation form.', 'give' ),
-					'id'           => $prefix . 'set_goal',
-					'type'         => 'text_small',
-					'row_classes'  => 'give-subfield',
-					'before_field' => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
-					'after_field'  => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
-					'attributes'   => array(
-						'placeholder' => give_format_amount( '0.00' ),
-						'value'       => isset( $goal ) ? esc_attr( give_format_amount( $goal ) ) : '',
+					'name'              => __( 'Goal Amount', 'give' ),
+					'description'       => __( 'This is the monetary goal amount you want to reach for this donation form.', 'give' ),
+					'id'                => $prefix . 'set_goal',
+					'type'              => 'text_small',
+					'row_classes'       => 'give-subfield',
+					'before_field'      => give_get_option( 'currency_position' ) == 'before' ? '<span class="give-money-symbol give-money-symbol-before">' . give_currency_symbol() . '</span>' : '',
+					'after_field'       => give_get_option( 'currency_position' ) == 'after' ? '<span class="give-money-symbol give-money-symbol-after">' . give_currency_symbol() . '</span>' : '',
+					'sanitization_cb'   => 'give_sanitize_amount',
+					'attributes'        => array(
+						'placeholder' => give_format_decimal( '0.00' ),
+						'value'       => give_format_decimal( $goal ),
 						'class'       => 'cmb-type-text-small give-money-field',
 					),
 				),

includes/admin/payments/view-order-details.php

@@ -125,7 +125,7 @@
 										<div class="give-order-payment give-admin-box-inside">
 											<p>
 												<span class="label"><?php _e( 'Total Donation', 'give' ); ?>:</span>&nbsp;
-												<?php echo give_currency_symbol( $payment->currency ); ?>&nbsp;<input name="give-payment-total" type="text" class="small-text give-price-field" value="<?php echo esc_attr( give_format_amount( give_get_payment_amount( $payment_id ) ) ); ?>"/>
+												<?php echo give_currency_symbol( $payment->currency ); ?>&nbsp;<input name="give-payment-total" type="text" class="small-text give-price-field" value="<?php echo esc_attr( give_format_decimal( give_get_payment_amount( $payment_id ) ) ); ?>"/>
 											</p>
 										</div>
 

includes/formatting.php

@@ -14,48 +14,89 @@
 	exit;
 }
 
+
+/**
+ * Get decimal count
+ *
+ * @since 1.6
+ *
+ * @return mixed
+ */
+function give_get_price_decimals() {
+    return apply_filters( 'give_sanitize_amount_decimals', 2 );
+}
+
+/**
+ * Get thousand separator
+ *
+ * @since 1.6
+ *
+ * @return mixed
+ */
+function give_get_price_thousand_separator() {
+    return give_get_option( 'thousands_separator', ',' );
+}
+
+/**
+ * Get decimal separator
+ *
+ * @since 1.6
+ *
+ * @return mixed
+ */
+function give_get_price_decimal_separator() {
+    return give_get_option( 'decimal_separator', '.' );
+}
+
 /**
  * Sanitize Amount
  *
  * @description: Returns a sanitized amount by stripping out thousands separators.
  *
  * @since      1.0
  *
- * @param string $amount Price amount to format
+ * @param  float|string $number     Expects either a float or a string with a decimal separator only (no thousands)
+ * @param  bool         $trim_zeros From end of string
+ *
  *
  * @return string $amount Newly sanitized amount
  */
-function give_sanitize_amount( $amount ) {
-	$is_negative   = false;
-	$thousands_sep = give_get_option( 'thousands_separator', ',' );
-	$decimal_sep   = give_get_option( 'decimal_separator', '.' );
+function give_sanitize_amount( $number, $trim_zeros = false ) {
+    $thousand_separator = give_get_price_thousand_separator();
 
-	// Sanitize the amount
-	if ( $decimal_sep == ',' && false !== ( $found = strpos( $amount, $decimal_sep ) ) ) {
-		if ( ( $thousands_sep == '.' || $thousands_sep == ' ' ) && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-			$amount = str_replace( $thousands_sep, '', $amount );
-		} elseif ( empty( $thousands_sep ) && false !== ( $found = strpos( $amount, '.' ) ) ) {
-			$amount = str_replace( '.', '', $amount );
-		}
+    $locale   = localeconv();
+    $decimals = array( give_get_price_decimal_separator(), $locale['decimal_point'], $locale['mon_decimal_point'] );
 
-		$amount = str_replace( $decimal_sep, '.', $amount );
-	} elseif ( $thousands_sep == ',' && false !== ( $found = strpos( $amount, $thousands_sep ) ) ) {
-		$amount = str_replace( $thousands_sep, '', $amount );
-	}
+    // Remove locale from string
+    if ( ! is_float( $number ) ) {
+        $number = str_replace( $decimals, '.', $number );
+    }
 
-	if ( $amount < 0 ) {
-		$is_negative = true;
-	}
+    // Remove thousand amount formatting if amount has.
+    // This condition use to add backward compatibility to version before 1.6, because before version 1.6 we were saving formatted amount to db.
+    if( false !== strpos( $number, $thousand_separator ) ) {
+        $number = str_replace( $thousand_separator, '', $number );
+    }
+
+    // Remove non numeric entity before decimal separator.
+    $number   = preg_replace( '/[^0-9\.]/', '', $number );
+
+    $decimals = give_get_price_decimals();
+    $decimals = apply_filters( 'give_sanitize_amount_decimals', $decimals, $number );
 
-	$amount   = preg_replace( '/[^0-9\.]/', '', $amount );
-	$decimals = apply_filters( 'give_sanitize_amount_decimals', 2, $amount );
-	$amount   = number_format( (double) $amount, $decimals, '.', '' );
+    $number = number_format( floatval( $number ), $decimals, '.', '' );
 
-	if ( $is_negative ) {
-		$amount *= - 1;
+    // Reset negative amount to zero.
+	if ( 0 > $number ) {
+		$number = number_format( 0, 2, '.' );
 	}
 
-	return apply_filters( 'give_sanitize_amount', $amount );
+    // Trim zeros.
+    if ( $trim_zeros && strstr( $number, '.' ) ) {
+        $number = rtrim( rtrim( $number, '0' ), '.' );
+    }
+
+	return apply_filters( 'give_sanitize_amount', $number );
 }
 
 /**
@@ -104,13 +145,34 @@ function give_format_amount( $amount, $decimals = true ) {
 		$amount = 0;
 	}
 
-	$decimals = apply_filters( 'give_format_amount_decimals', $decimals ? 2 : 0, $amount );
+	$decimals = give_get_price_decimals();
 
 	$formatted = number_format( $amount, $decimals, $decimal_sep, $thousands_sep );
 
 	return apply_filters( 'give_format_amount', $formatted, $amount, $decimals, $decimal_sep, $thousands_sep );
 }
 
+/**
+ * Returns a nicely formatted amount with custom decimal separator.
+ *
+ * @since 1.0
+ *
+ * @param string      $amount   Formatted or sanitized price
+ *
+ * @return string $amount Newly formatted amount or Price Not Available
+ */
+function give_format_decimal( $amount ){
+    $decimal_separator = give_get_price_decimal_separator();
+    $formatted_amount  = give_sanitize_amount( $amount );
+
+    if( false !== strpos( $formatted_amount, '.' ) ) {
+        $formatted_amount = str_replace( '.', $decimal_separator, $formatted_amount );
+    }
+
+    return apply_filters( 'give_format_decimal', $formatted_amount, $amount, $decimal_separator );
+}
+
+
 /**
  * Format Multi-level Amount
  *
@@ -127,8 +189,7 @@ function give_format_admin_multilevel_amount( $field_args, $field ) {
 		return false;
 	}
 
-	$field->value = give_format_amount( $field->value );
-
+	$field->value = give_format_decimal( $field->value );
 }
 
 /**
@@ -270,4 +331,19 @@ function give_currency_decimal_filter( $decimals = 2 ) {
 }
 
 add_filter( 'give_sanitize_amount_decimals', 'give_currency_decimal_filter' );
-add_filter( 'give_format_amount_decimals', 'give_currency_decimal_filter' );
+add_filter( 'give_format_amount_decimals', 'give_currency_decimal_filter' );
+
+/**
+ * Sanitize thousand separator
+ *
+ * @since 1.6
+ *
+ * @param string $value
+ * @param array  $field_args
+ * @param object $field
+ *
+ * @return mixed
+ */
+function give_sanitize_thousand_separator( $value, $field_args, $field ){
+    return $value;
+}