CRM/Core/Smarty/plugins/modifier.crmNumberFormat.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  * Add thousands separator to numeric strings using
  38  * PHP number_format() function.
  39  *
  40  * @param float  $number        numeric value to be formatted
  41  * @param int    $decimals      number of decimal places
  42  * @param string $dec_point     decimal point character (if other than ".")
  43  * @param string $thousands_sep thousands sep character (if other than ",")
  44  *
  45  * @return string        the formatted string
  46  * @access public
  47  *
  48  * For alternate decimal point and thousands separator, delimit values with single quotes in the template.
  49  * EXAMPLE:   {$number|crmNumberFormat:2:',':' '} for French notation - 1234.56 becomes 1 234,56
  50  */
  51 function smarty_modifier_crmNumberFormat($number, $decimals = NULL, $dec_point = NULL, $thousands_sep = NULL) {
  52   if (is_numeric($number)) {
  53     // Both dec_point AND thousands_sep are required if one is not specified
  54     // then use the config defaults
  55     if (!$dec_point || !$thousands_sep) {
  56       $config        = CRM_Core_Config::singleton();
  57       $dec_point     = $config->monetaryDecimalPoint;
  58       $thousands_sep = $config->monetaryThousandSeparator;
  59     }
  60
  61     return number_format($number, $decimals, $dec_point, $thousands_sep);
  62   }
  63
  64   return '';
  65 }
  66