3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 class CRM_Utils_Money
{
22 public static $_currencySymbols = NULL;
25 * Format a monetary string.
27 * Format a monetary string basing on the amount provided,
28 * ISO currency code provided and a format string consisting of:
30 * %a - the formatted amount
31 * %C - the currency ISO code (e.g., 'USD') if provided
32 * %c - the currency symbol (e.g., '$') if available
34 * @param float $amount
35 * The monetary amount to display (1234.56).
36 * @param string $currency
37 * The three-letter ISO currency code ('USD').
38 * @param string $format
39 * The desired currency format.
40 * @param bool $onlyNumber
41 * @param string $valueFormat
42 * The desired monetary value display format (e.g. '%!i').
45 * formatted monetary string
48 public static function format($amount, $currency = NULL, $format = NULL, $onlyNumber = FALSE, $valueFormat = NULL) {
50 if (CRM_Utils_System
::isNull($amount)) {
54 $config = CRM_Core_Config
::singleton();
57 $format = $config->moneyformat
;
61 $valueFormat = $config->moneyvalueformat
;
64 if (!empty($valueFormat) && $valueFormat !== '%!i') {
65 CRM_Core_Error
::deprecatedFunctionWarning('Having a Money Value format other than !%i is deprecated, please report this on the GitLab Issue https://lab.civicrm.org/dev/core/-/issues/1494 with the relevant moneyValueFormat you use.');
69 // money_format() exists only in certain PHP install (CRM-650)
70 if (is_numeric($amount) and function_exists('money_format')) {
71 $amount = money_format($valueFormat, $amount);
76 if (!self
::$_currencySymbols) {
77 self
::$_currencySymbols = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', [
78 'keyColumn' => 'name',
79 'labelColumn' => 'symbol',
84 $currency = $config->defaultCurrency
;
87 // ensure $currency is a valid currency code
88 // for backwards-compatibility, also accept one space instead of a currency
89 if ($currency != ' ' && !array_key_exists($currency, self
::$_currencySymbols)) {
90 throw new CRM_Core_Exception("Invalid currency \"{$currency}\"");
93 $amount = self
::formatNumericByFormat($amount, $valueFormat);
94 // If it contains tags, means that HTML was passed and the
95 // amount is already converted properly,
96 // so don't mess with it again.
97 // @todo deprecate handling for the html tags because .... WTF
98 if (strpos($amount, '<') === FALSE) {
99 $amount = self
::replaceCurrencySeparators($amount);
105 '%c' => CRM_Utils_Array
::value($currency, self
::$_currencySymbols, $currency),
107 return strtr($format, $replacements);
111 * This is a placeholder function for calculating the number of decimal places for a currency.
113 * Currently code assumes 2 decimal places but some currencies (bitcoin, middle eastern) have
114 * more. By using this function we can signpost the locations where the number of decimal places is
115 * currency specific for future enhancement.
117 * @param string $currency
120 * Number of decimal places.
122 public static function getCurrencyPrecision($currency = NULL) {
127 * Subtract currencies using integers instead of floats, to preserve precision
129 * @param string|float $leftOp
130 * @param string|float $rightOp
131 * @param string $currency
134 * Result of subtracting $rightOp from $leftOp to the precision of $currency
136 public static function subtractCurrencies($leftOp, $rightOp, $currency) {
137 if (is_numeric($leftOp) && is_numeric($rightOp)) {
138 $precision = pow(10, self
::getCurrencyPrecision($currency));
139 return (($leftOp * $precision) - ($rightOp * $precision)) / $precision;
144 * Tests if two currency values are equal, taking into account the currency's
145 * precision, so that the two values are compared as integers after rounding.
149 * 1.231 == 1.232 with a currency precision of 2 decimal points
150 * 1.234 != 1.236 with a currency precision of 2 decimal points
151 * 1.300 != 1.200 with a currency precision of 2 decimal points
159 public static function equals($value1, $value2, $currency) {
160 $precision = pow(10, self
::getCurrencyPrecision($currency));
162 return (int) round($value1 * $precision) == (int) round($value2 * $precision);
166 * Format money for display (just numeric part) according to the current locale.
168 * This calls the underlying system function but does not handle currency separators.
170 * It's not totally clear when it changes the $amount value but has historical usage.
176 protected static function formatLocaleNumeric($amount) {
177 if (CRM_Core_Config
::singleton()->moneyvalueformat
!== '%!i') {
178 CRM_Core_Error
::deprecatedFunctionWarning('Having a Money Value format other than !%i is deprecated, please report this on GitLab with the relevant moneyValueFormat you use.');
180 return self
::formatNumericByFormat($amount, CRM_Core_Config
::singleton()->moneyvalueformat
);
184 * Format money for display (just numeric part) according to the current locale with rounding.
186 * At this stage this is conceived as an internal function with the currency wrapper
187 * functions determining the number of places.
189 * This calls the underlying system function but does not handle currency separators.
191 * It's not totally clear when it changes the $amount value but has historical usage.
193 * @param string $amount
194 * @param int $numberOfPlaces
198 protected static function formatLocaleNumericRounded($amount, $numberOfPlaces) {
199 return self
::formatLocaleNumeric(round($amount, $numberOfPlaces));
203 * Format money for display (just numeric part) according to the current locale with rounding.
205 * This handles both rounding & replacement of the currency separators for the locale.
207 * @param string $amount
208 * @param string $currency
213 public static function formatLocaleNumericRoundedByCurrency($amount, $currency) {
214 $amount = self
::formatLocaleNumericRounded($amount, self
::getCurrencyPrecision($currency));
215 return self
::replaceCurrencySeparators($amount);
219 * Format money for display (just numeric part) according to the current locale with rounding based on the
220 * default currency for the site.
225 public static function formatLocaleNumericRoundedForDefaultCurrency($amount) {
226 return self
::formatLocaleNumericRoundedByCurrency($amount, self
::getCurrencyPrecision(CRM_Core_Config
::singleton()->defaultCurrency
));
230 * Replace currency separators.
232 * @param string $amount
236 protected static function replaceCurrencySeparators($amount) {
237 $config = CRM_Core_Config
::singleton();
239 ',' => $config->monetaryThousandSeparator
,
240 '.' => $config->monetaryDecimalPoint
,
242 return strtr($amount, $rep);
246 * Format numeric part of currency by the passed in format.
248 * This is envisaged as an internal function, with wrapper functions defining valueFormat
249 * into easily understood functions / variables and handling separator conversions and
252 * @param string $amount
253 * @param string $valueFormat
257 protected static function formatNumericByFormat($amount, $valueFormat) {
258 // money_format() exists only in certain PHP install (CRM-650)
259 // setlocale() affects native gettext (CRM-11054, CRM-9976)
260 if (is_numeric($amount) && function_exists('money_format')) {
261 $lc = setlocale(LC_MONETARY
, 0);
262 setlocale(LC_MONETARY
, 'en_US.utf8', 'en_US', 'en_US.utf8', 'en_US', 'C');
263 $amount = money_format($valueFormat, $amount);
264 setlocale(LC_MONETARY
, $lc);