pictcode

<?php

/**

 * CakeNumber Utility.

 *

 * Methods to make numbers more readable.

 *

 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)

 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 *

 * Licensed under The MIT License

 * For full copyright and license information, please see the LICENSE.txt

 * Redistributions of files must retain the above copyright notice.

 *

 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 * @link          http://cakephp.org CakePHP(tm) Project

 * @package       Cake.Utility

 * @since         CakePHP(tm) v 0.10.0.1076

 * @license       http://www.opensource.org/licenses/mit-license.php MIT License

 */

/**

 * Number helper library.

 *

 * Methods to make numbers more readable.

 *

 * @package       Cake.Utility

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html

 */

class CakeNumber {

/**

 * Currencies supported by the helper. You can add additional currency formats

 * with CakeNumber::addFormat

 *

 * @var array

 */

        protected static $_currencies = array(

                'AUD' => array(

                        'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 2

                ),

                'CAD' => array(

                        'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 2

                ),

                'USD' => array(

                        'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 2

                ),

                'EUR' => array(

                        'wholeSymbol' => '€', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => '.', 'decimals' => ',', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 0

                ),

                'GBP' => array(

                        'wholeSymbol' => '£', 'wholePosition' => 'before', 'fractionSymbol' => 'p', 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 2

                ),

                'JPY' => array(

                        'wholeSymbol' => '¥', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',

                        'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                        'fractionExponent' => 0

                ),

        );

/**

 * Default options for currency formats

 *

 * @var array

 */

        protected static $_currencyDefaults = array(

                'wholeSymbol' => '', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',

                'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,

                'fractionExponent' => 2

        );

/**

 * Default currency used by CakeNumber::currency()

 *

 * @var string

 */

        protected static $_defaultCurrency = 'USD';

/**

 * If native number_format() should be used. If >= PHP5.4

 *

 * @var bool

 */

        protected static $_numberFormatSupport = null;

/**

 * Formats a number with a level of precision.

 *

 * @param float $value A floating point number.

 * @param int $precision The precision of the returned number.

 * @return float Formatted float.

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::precision

 */

        public static function precision($value, $precision = 3) {

                return sprintf("%01.{$precision}f", $value);

        }

/**

 * Returns a formatted-for-humans file size.

 *

 * @param int $size Size in bytes

 * @return string Human readable size

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::toReadableSize

 */

        public static function toReadableSize($size) {

                switch (true) {

                        case $size < 1024:

                                return __dn('cake', '%d Byte', '%d Bytes', $size, $size);

                        case round($size / 1024) < 1024:

                                return __d('cake', '%s KB', static::precision($size / 1024, 0));

                        case round($size / 1024 / 1024, 2) < 1024:

                                return __d('cake', '%s MB', static::precision($size / 1024 / 1024, 2));

                        case round($size / 1024 / 1024 / 1024, 2) < 1024:

                                return __d('cake', '%s GB', static::precision($size / 1024 / 1024 / 1024, 2));

                        default:

                                return __d('cake', '%s TB', static::precision($size / 1024 / 1024 / 1024 / 1024, 2));

                }

        }

/**

 * Converts filesize from human readable string to bytes

 *

 * @param string $size Size in human readable string like '5MB', '5M', '500B', '50kb' etc.

 * @param mixed $default Value to be returned when invalid size was used, for example 'Unknown type'

 * @return mixed Number of bytes as integer on success, `$default` on failure if not false

 * @throws CakeException On invalid Unit type.

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::fromReadableSize

 */

        public static function fromReadableSize($size, $default = false) {

                if (ctype_digit($size)) {

                        return (int)$size;

                }

                $size = strtoupper($size);

                $l = -2;

                $i = array_search(substr($size, -2), array('KB', 'MB', 'GB', 'TB', 'PB'));

                if ($i === false) {

                        $l = -1;

                        $i = array_search(substr($size, -1), array('K', 'M', 'G', 'T', 'P'));

                }

                if ($i !== false) {

                        $size = substr($size, 0, $l);

                        return $size * pow(1024, $i + 1);

                }

                if (substr($size, -1) === 'B' && ctype_digit(substr($size, 0, -1))) {

                        $size = substr($size, 0, -1);

                        return (int)$size;

                }

                if ($default !== false) {

                        return $default;

                }

                throw new CakeException(__d('cake_dev', 'No unit type.'));

        }

/**

 * Formats a number into a percentage string.

 *

 * Options:

 *

 * - `multiply`: Multiply the input value by 100 for decimal percentages.

 *

 * @param float $value A floating point number

 * @param int $precision The precision of the returned number

 * @param array $options Options

 * @return string Percentage string

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::toPercentage

 */

        public static function toPercentage($value, $precision = 2, $options = array()) {

                $options += array('multiply' => false);

                if ($options['multiply']) {

                        $value *= 100;

                }

                return static::precision($value, $precision) . '%';

        }

/**

 * Formats a number into a currency format.

 *

 * @param float $value A floating point number

 * @param int $options If integer then places, if string then before, if (,.-) then use it

 *   or array with places and before keys

 * @return string formatted number

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::format

 */

        public static function format($value, $options = false) {

                $places = 0;

                if (is_int($options)) {

                        $places = $options;

                }

                $separators = array(',', '.', '-', ':');

                $before = $after = null;

                if (is_string($options) && !in_array($options, $separators)) {

                        $before = $options;

                }

                $thousands = ',';

                if (!is_array($options) && in_array($options, $separators)) {

                        $thousands = $options;

                }

                $decimals = '.';

                if (!is_array($options) && in_array($options, $separators)) {

                        $decimals = $options;

                }

                $escape = true;

                if (is_array($options)) {

                        $defaults = array('before' => '$', 'places' => 2, 'thousands' => ',', 'decimals' => '.');

                        $options += $defaults;

                        extract($options);

                }

                $value = static::_numberFormat($value, $places, '.', '');

                $out = $before . static::_numberFormat($value, $places, $decimals, $thousands) . $after;

                if ($escape) {

                        return h($out);

                }

                return $out;

        }

/**

 * Formats a number into a currency format to show deltas (signed differences in value).

 *

 * ### Options

 *

 * - `places` - Number of decimal places to use. ie. 2

 * - `fractionExponent` - Fraction exponent of this specific currency. Defaults to 2.

 * - `before` - The string to place before whole numbers. ie. '['

 * - `after` - The string to place after decimal numbers. ie. ']'

 * - `thousands` - Thousands separator ie. ','

 * - `decimals` - Decimal separator symbol ie. '.'

 *

 * @param float $value A floating point number

 * @param array $options Options list.

 * @return string formatted delta

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::formatDelta

 */

        public static function formatDelta($value, $options = array()) {

                $places = isset($options['places']) ? $options['places'] : 0;

                $value = static::_numberFormat($value, $places, '.', '');

                $sign = $value > 0 ? '+' : '';

                $options['before'] = isset($options['before']) ? $options['before'] . $sign : $sign;

                return static::format($value, $options);

        }

/**

 * Alternative number_format() to accommodate multibyte decimals and thousands < PHP 5.4

 *

 * @param float $value Value to format.

 * @param int $places Decimal places to use.

 * @param string $decimals Decimal position string.

 * @param string $thousands Thousands separator string.

 * @return string

 */

        protected static function _numberFormat($value, $places = 0, $decimals = '.', $thousands = ',') {

                if (!isset(static::$_numberFormatSupport)) {

                        static::$_numberFormatSupport = version_compare(PHP_VERSION, '5.4.0', '>=');

                }

                if (static::$_numberFormatSupport) {

                        return number_format($value, $places, $decimals, $thousands);

                }

                $value = number_format($value, $places, '.', '');

                $after = '';

                $foundDecimal = strpos($value, '.');

                if ($foundDecimal !== false) {

                        $after = substr($value, $foundDecimal);

                        $value = substr($value, 0, $foundDecimal);

                }

                while (($foundThousand = preg_replace('/(\d+)(\d\d\d)/', '\1 \2', $value)) !== $value) {

                        $value = $foundThousand;

                }

                $value .= $after;

                return strtr($value, array(' ' => $thousands, '.' => $decimals));

        }

/**

 * Formats a number into a currency format.

 *

 * ### Options

 *

 * - `wholeSymbol` - The currency symbol to use for whole numbers,

 *   greater than 1, or less than -1.

 * - `wholePosition` - The position the whole symbol should be placed

 *   valid options are 'before' & 'after'.

 * - `fractionSymbol` - The currency symbol to use for fractional numbers.

 * - `fractionPosition` - The position the fraction symbol should be placed

 *   valid options are 'before' & 'after'.

 * - `before` - The currency symbol to place before whole numbers

 *   ie. '$'. `before` is an alias for `wholeSymbol`.

 * - `after` - The currency symbol to place after decimal numbers

 *   ie. 'c'. Set to boolean false to use no decimal symbol.

 *   eg. 0.35 => $0.35. `after` is an alias for `fractionSymbol`

 * - `zero` - The text to use for zero values, can be a

 *   string or a number. ie. 0, 'Free!'

 * - `places` - Number of decimal places to use. ie. 2

 * - `fractionExponent` - Fraction exponent of this specific currency. Defaults to 2.

 * - `thousands` - Thousands separator ie. ','

 * - `decimals` - Decimal separator symbol ie. '.'

 * - `negative` - Symbol for negative numbers. If equal to '()',

 *   the number will be wrapped with ( and )

 * - `escape` - Should the output be escaped for html special characters.

 *   The default value for this option is controlled by the currency settings.

 *   By default all currencies contain utf-8 symbols and don't need this changed. If you require

 *   non HTML encoded symbols you will need to update the settings with the correct bytes.

 *

 * @param float $value Value to format.

 * @param string $currency Shortcut to default options. Valid values are

 *   'USD', 'EUR', 'GBP', otherwise set at least 'before' and 'after' options.

 * @param array $options Options list.

 * @return string Number formatted as a currency.

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::currency

 */

        public static function currency($value, $currency = null, $options = array()) {

                $defaults = static::$_currencyDefaults;

                if ($currency === null) {

                        $currency = static::defaultCurrency();

                }

                if (isset(static::$_currencies[$currency])) {

                        $defaults = static::$_currencies[$currency];

                } elseif (is_string($currency)) {

                        $options['before'] = $currency;

                }

                $options += $defaults;

                if (isset($options['before']) && $options['before'] !== '') {

                        $options['wholeSymbol'] = $options['before'];

                }

                if (isset($options['after']) && !$options['after'] !== '') {

                        $options['fractionSymbol'] = $options['after'];

                }

                $result = $options['before'] = $options['after'] = null;

                $symbolKey = 'whole';

                $value = (float)$value;

                if (!$value) {

                        if ($options['zero'] !== 0) {

                                return $options['zero'];

                        }

                } elseif ($value < 1 && $value > -1) {

                        if ($options['fractionSymbol'] !== false) {

                                $multiply = pow(10, $options['fractionExponent']);

                                $value = $value * $multiply;

                                $options['places'] = null;

                                $symbolKey = 'fraction';

                        }

                }

                $position = $options[$symbolKey . 'Position'] !== 'after' ? 'before' : 'after';

                $options[$position] = $options[$symbolKey . 'Symbol'];

                $abs = abs($value);

                $result = static::format($abs, $options);

                if ($value < 0) {

                        if ($options['negative'] === '()') {

                                $result = '(' . $result . ')';

                        } else {

                                $result = $options['negative'] . $result;

                        }

                }

                return $result;

        }

/**

 * Add a currency format to the Number helper. Makes reusing

 * currency formats easier.

 *

 * ``` $number->addFormat('NOK', array('before' => 'Kr. ')); ```

 *

 * You can now use `NOK` as a shortform when formatting currency amounts.

 *

 * ``` $number->currency($value, 'NOK'); ```

 *

 * Added formats are merged with the defaults defined in CakeNumber::$_currencyDefaults

 * See CakeNumber::currency() for more information on the various options and their function.

 *

 * @param string $formatName The format name to be used in the future.

 * @param array $options The array of options for this format.

 * @return void

 * @see NumberHelper::currency()

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::addFormat

 */

        public static function addFormat($formatName, $options) {

                static::$_currencies[$formatName] = $options + static::$_currencyDefaults;

        }

/**

 * Getter/setter for default currency

 *

 * @param string $currency Default currency string used by currency() if $currency argument is not provided

 * @return string Currency

 * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::defaultCurrency

 */

        public static function defaultCurrency($currency = null) {

                if ($currency) {

                        static::$_defaultCurrency = $currency;

                }

                return static::$_defaultCurrency;

        }

}