CRM/Utils/Money.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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
  53    *   The monetary amount to display (1234.56).
  54    * @param string $currency
  55    *   The three-letter ISO currency code ('USD').
  56    * @param string $format
  57    *   The desired currency format.
  58    * @param bool $onlyNumber
  59    * @param string $valueFormat
  60    *   The desired monetary value display format (e.g. '%!i').
  61    *
  62    * @return string  formatted monetary string
  63    *
  64    * @static
  65    */
  66   public static function format($amount, $currency = NULL, $format = NULL, $onlyNumber = FALSE, $valueFormat = NULL) {
  67
  68     if (CRM_Utils_System::isNull($amount)) {
  69       return '';
  70     }
  71
  72     $config = CRM_Core_Config::singleton();
  73
  74     if (!$format) {
  75       $format = $config->moneyformat;
  76     }
  77
  78     if (!$valueFormat) {
  79       $valueFormat = $config->moneyvalueformat;
  80     }
  81
  82     if ($onlyNumber) {
  83       // money_format() exists only in certain PHP install (CRM-650)
  84       if (is_numeric($amount) and function_exists('money_format')) {
  85         $amount = money_format($valueFormat, $amount);
  86       }
  87       return $amount;
  88     }
  89
  90     if (!self::$_currencySymbols) {
  91       self::$_currencySymbols = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('keyColumn' => 'name', 'labelColumn' => 'symbol'));
  92     }
  93
  94     if (!$currency) {
  95       $currency = $config->defaultCurrency;
  96     }
  97
  98     // money_format() exists only in certain PHP install (CRM-650)
  99     // setlocale() affects native gettext (CRM-11054, CRM-9976)
 100     if (is_numeric($amount) && function_exists('money_format')) {
 101       $lc = setlocale(LC_MONETARY, 0);
 102       setlocale(LC_MONETARY, 'en_US.utf8', 'en_US', 'en_US.utf8', 'en_US', 'C');
 103       $amount = money_format($valueFormat, $amount);
 104       setlocale(LC_MONETARY, $lc);
 105     }
 106
 107     $rep = array(
 108       ',' => $config->monetaryThousandSeparator,
 109       '.' => $config->monetaryDecimalPoint,
 110     );
 111
 112     // If it contains tags, means that HTML was passed and the
 113     // amount is already converted properly,
 114     // so don't mess with it again.
 115     if (strpos($amount, '<') === FALSE) {
 116       $amount = strtr($amount, $rep);
 117     }
 118
 119     $replacements = array(
 120       '%a' => $amount,
 121       '%C' => $currency,
 122       '%c' => CRM_Utils_Array::value($currency, self::$_currencySymbols, $currency),
 123     );
 124     return strtr($format, $replacements);
 125   }
 126 }