CRM/Utils/Money.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Money utilties
  38  */
  39 class CRM_Utils_Money {
  40   static $_currencySymbols = NULL;
  41
  42   /**
  43    * format a monetary string
  44    *
  45    * Format a monetary string basing on the amount provided,
  46    * ISO currency code provided and a format string consisting of:
  47    *
  48    * %a - the formatted amount
  49    * %C - the currency ISO code (e.g., 'USD') if provided
  50    * %c - the currency symbol (e.g., '$') if available
  51    *
  52    * @param float  $amount      the monetary amount to display (1234.56)
  53    * @param string $currency    the three-letter ISO currency code ('USD')
  54    * @param string $format      the desired currency format
  55    * @param string $valueFormat the desired monetary value display format (e.g. '%!i')
  56    *
  57    * @return string  formatted monetary string
  58    *
  59    * @static
  60    */
  61   static function format($amount, $currency = NULL, $format = NULL, $onlyNumber = FALSE, $valueFormat = NULL) {
  62
  63     if (CRM_Utils_System::isNull($amount)) {
  64       return '';
  65     }
  66
  67     $config = CRM_Core_Config::singleton();
  68
  69     if (!$format) {
  70       $format = $config->moneyformat;
  71     }
  72
  73     if (!$valueFormat) {
  74       $valueFormat = $config->moneyvalueformat;
  75     }
  76
  77     if ($onlyNumber) {
  78       // money_format() exists only in certain PHP install (CRM-650)
  79       if (is_numeric($amount) and function_exists('money_format')) {
  80         $amount = money_format($valueFormat, $amount);
  81       }
  82       return $amount;
  83     }
  84
  85     if (!self::$_currencySymbols) {
  86       self::$_currencySymbols = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('keyColumn' => 'name', 'labelColumn' => 'symbol'));
  87     }
  88
  89     if (!$currency) {
  90       $currency = $config->defaultCurrency;
  91     }
  92
  93     // money_format() exists only in certain PHP install (CRM-650)
  94     // setlocale() affects native gettext (CRM-11054, CRM-9976)
  95     if (is_numeric($amount) && function_exists('money_format')) {
  96       $lc = setlocale(LC_MONETARY, 0);
  97       setlocale(LC_MONETARY, 'en_US.utf8', 'en_US', 'en_US.utf8', 'en_US', 'C');
  98       $amount = money_format($valueFormat, $amount);
  99       setlocale(LC_MONETARY, $lc);
 100     }
 101
 102     $rep = array(
 103       ',' => $config->monetaryThousandSeparator,
 104       '.' => $config->monetaryDecimalPoint,
 105     );
 106
 107     // If it contains tags, means that HTML was passed and the
 108     // amount is already converted properly,
 109     // so don't mess with it again.
 110     if (strpos($amount, '<') === FALSE) {
 111       $amount = strtr($amount, $rep);
 112     }
 113
 114     $replacements = array(
 115       '%a' => $amount,
 116       '%C' => $currency,
 117       '%c' => CRM_Utils_Array::value($currency, self::$_currencySymbols, $currency),
 118     );
 119     return strtr($format, $replacements);
 120   }
 121 }
 122