Members/shoshi/webvirt: cake/libs/view/helpers/number.php annotate

author	Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp>
date	Sun, 24 Jul 2011 21:08:31 +0900
parents
children

rev	line source
0 261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	1 <?php
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	2 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	3 * Number Helper.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	4 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	5 * Methods to make numbers more readable.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	6 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	7 * PHP versions 4 and 5
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	8 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	9 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	10 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	11 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	12 * Licensed under The MIT License
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	13 * Redistributions of files must retain the above copyright notice.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	14 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	15 * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	16 * @link http://cakephp.org CakePHP(tm) Project
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	17 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	18 * @subpackage cake.cake.libs.view.helpers
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	19 * @since CakePHP(tm) v 0.10.0.1076
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	20 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	21 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	22
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	23 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	24 * Number helper library.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	25 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	26 * Methods to make numbers more readable.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	27 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	28 * @package cake
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	29 * @subpackage cake.cake.libs.view.helpers
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	30 * @link http://book.cakephp.org/view/1452/Number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	31 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	32 class NumberHelper extends AppHelper {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	33
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	34 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	35 * Currencies supported by the helper. You can add additional currency formats
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	36 * with NumberHelper::addFormat
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	37 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	38 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	39 * @access protected
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	40 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	41 var $_currencies = array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	42 'USD' => array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	43 'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',',
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	44 'decimals' => '.', 'negative' => '()', 'escape' => true
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	45 ),
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	46 'GBP' => array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	47 'before'=>'£', 'after' => 'p', 'zero' => 0, 'places' => 2, 'thousands' => ',',
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	48 'decimals' => '.', 'negative' => '()','escape' => false
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	49 ),
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	50 'EUR' => array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	51 'before'=>'€', 'after' => false, 'zero' => 0, 'places' => 2, 'thousands' => '.',
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	52 'decimals' => ',', 'negative' => '()', 'escape' => false
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	53 )
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	54 );
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	55
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	56 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	57 * Default options for currency formats
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	58 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	59 * @var array
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	60 * @access protected
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	61 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	62 var $_currencyDefaults = array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	63 'before'=>'', 'after' => '', 'zero' => '0', 'places' => 2, 'thousands' => ',',
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	64 'decimals' => '.','negative' => '()', 'escape' => true
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	65 );
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	66
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	67 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	68 * Formats a number with a level of precision.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	69 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	70 * @param float $number A floating point number.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	71 * @param integer $precision The precision of the returned number.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	72 * @return float Formatted float.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	73 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	74 * @link http://book.cakephp.org/view/1454/precision
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	75 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	76 function precision($number, $precision = 3) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	77 return sprintf("%01.{$precision}f", $number);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	78 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	79
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	80 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	81 * Returns a formatted-for-humans file size.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	82 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	83 * @param integer $length Size in bytes
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	84 * @return string Human readable size
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	85 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	86 * @link http://book.cakephp.org/view/1456/toReadableSize
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	87 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	88 function toReadableSize($size) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	89 switch (true) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	90 case $size < 1024:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	91 return sprintf(__n('%d Byte', '%d Bytes', $size, true), $size);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	92 case round($size / 1024) < 1024:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	93 return sprintf(__('%d KB', true), $this->precision($size / 1024, 0));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	94 case round($size / 1024 / 1024, 2) < 1024:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	95 return sprintf(__('%.2f MB', true), $this->precision($size / 1024 / 1024, 2));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	96 case round($size / 1024 / 1024 / 1024, 2) < 1024:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	97 return sprintf(__('%.2f GB', true), $this->precision($size / 1024 / 1024 / 1024, 2));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	98 default:
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	99 return sprintf(__('%.2f TB', true), $this->precision($size / 1024 / 1024 / 1024 / 1024, 2));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	100 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	101 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	102
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	103 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	104 * Formats a number into a percentage string.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	105 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	106 * @param float $number A floating point number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	107 * @param integer $precision The precision of the returned number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	108 * @return string Percentage string
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	109 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	110 * @link http://book.cakephp.org/view/1455/toPercentage
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	111 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	112 function toPercentage($number, $precision = 2) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	113 return $this->precision($number, $precision) . '%';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	114 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	115
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	116 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	117 * Formats a number into a currency format.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	118 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	119 * @param float $number A floating point number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	120 * @param integer $options if int then places, if string then before, if (,.-) then use it
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	121 * or array with places and before keys
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	122 * @return string formatted number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	123 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	124 * @link http://book.cakephp.org/view/1457/format
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	125 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	126 function format($number, $options = false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	127 $places = 0;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	128 if (is_int($options)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	129 $places = $options;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	130 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	131
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	132 $separators = array(',', '.', '-', ':');
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	133
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	134 $before = $after = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	135 if (is_string($options) && !in_array($options, $separators)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	136 $before = $options;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	137 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	138 $thousands = ',';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	139 if (!is_array($options) && in_array($options, $separators)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	140 $thousands = $options;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	141 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	142 $decimals = '.';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	143 if (!is_array($options) && in_array($options, $separators)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	144 $decimals = $options;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	145 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	146
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	147 $escape = true;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	148 if (is_array($options)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	149 $options = array_merge(array('before'=>'$', 'places' => 2, 'thousands' => ',', 'decimals' => '.'), $options);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	150 extract($options);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	151 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	152
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	153 $out = $before . number_format($number, $places, $decimals, $thousands) . $after;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	154
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	155 if ($escape) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	156 return h($out);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	157 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	158 return $out;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	159 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	160
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	161 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	162 * Formats a number into a currency format.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	163 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	164 * ### Options
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	165 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	166 * - `before` - The currency symbol to place before whole numbers ie. '$'
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	167 * - `after` - The currency symbol to place after decimal numbers ie. 'c'. Set to boolean false to
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	168 * use no decimal symbol. eg. 0.35 => $0.35.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	169 * - `zero` - The text to use for zero values, can be a string or a number. ie. 0, 'Free!'
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	170 * - `places` - Number of decimal places to use. ie. 2
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	171 * - `thousands` - Thousands separator ie. ','
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	172 * - `decimals` - Decimal separator symbol ie. '.'
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	173 * - `negative` - Symbol for negative numbers. If equal to '()', the number will be wrapped with ( and )
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	174 * - `escape` - Should the output be htmlentity escaped? Defaults to true
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	175 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	176 * @param float $number
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	177 * @param string $currency Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	178 * set at least 'before' and 'after' options.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	179 * @param array $options
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	180 * @return string Number formatted as a currency.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	181 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	182 * @link http://book.cakephp.org/view/1453/currency
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	183 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	184 function currency($number, $currency = 'USD', $options = array()) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	185 $default = $this->_currencyDefaults;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	186
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	187 if (isset($this->_currencies[$currency])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	188 $default = $this->_currencies[$currency];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	189 } elseif (is_string($currency)) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	190 $options['before'] = $currency;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	191 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	192
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	193 $options = array_merge($default, $options);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	194
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	195 $result = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	196
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	197 if ($number == 0 ) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	198 if ($options['zero'] !== 0 ) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	199 return $options['zero'];
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	200 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	201 $options['after'] = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	202 } elseif ($number < 1 && $number > -1 ) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	203 if ($options['after'] !== false) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	204 $multiply = intval('1' . str_pad('', $options['places'], '0'));
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	205 $number = $number * $multiply;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	206 $options['before'] = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	207 $options['places'] = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	208 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	209 } elseif (empty($options['before'])) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	210 $options['before'] = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	211 } else {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	212 $options['after'] = null;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	213 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	214
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	215 $abs = abs($number);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	216 $result = $this->format($abs, $options);
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	217
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	218 if ($number < 0 ) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	219 if ($options['negative'] == '()') {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	220 $result = '(' . $result .')';
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	221 } else {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	222 $result = $options['negative'] . $result;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	223 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	224 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	225 return $result;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	226 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	227
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	228 /**
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	229 * Add a currency format to the Number helper. Makes reusing
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	230 * currency formats easier.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	231 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	232 * {{{ $number->addFormat('NOK', array('before' => 'Kr. ')); }}}
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	233 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	234 * You can now use `NOK` as a shortform when formatting currency amounts.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	235 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	236 * {{{ $number->currency($value, 'NOK'); }}}
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	237 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	238 * Added formats are merged with the following defaults.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	239 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	240 * {{{
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	241 * array(
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	242 * 'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',',
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	243 * 'decimals' => '.', 'negative' => '()', 'escape' => true
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	244 * )
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	245 * }}}
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	246 *
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	247 * @param string $formatName The format name to be used in the future.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	248 * @param array $options The array of options for this format.
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	249 * @return void
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	250 * @see NumberHelper::currency()
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	251 * @access public
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	252 */
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	253 function addFormat($formatName, $options) {
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	254 $this->_currencies[$formatName] = $options + $this->_currencyDefaults;
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	255 }
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	256
261e66bd5a0c hg init Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	257 }

0

261e66bd5a0c hg init