Page Contents

CakeNumber

class CakeNumber

If you need NumberHelper functionalities outside of a View, use the CakeNumber class:

class UsersController extends AppController {

    public $components = array('Auth');

    public function afterLogin() {
        App::uses('CakeNumber', 'Utility');
        $storageUsed = $this->Auth->user('storage_used');
        if ($storageUsed > 5000000) {
            // notify users of quota
            $this->Session->setFlash(__('You are using %s storage', CakeNumber::toReadableSize($storageUsed)));
        }
    }
}

New in version 2.1: CakeNumber has been factored out from NumberHelper.

All of these functions return the formatted number; They do not automatically echo the output into the view.

CakeNumber::currency(float $number, string $currency = 'USD', array $options = array())
Parameters:
  • $number (float) – The value to covert.
  • $currency (string) – The known currency format to use.
  • $options (array) – Options, see below.

This method is used to display a number in common currency formats (EUR,GBP,USD). Usage in a view looks like:

// called as NumberHelper
echo $this->Number->currency($number, $currency);

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::currency($number, $currency);

The first parameter, $number, should be a floating point number that represents the amount of money you are expressing. The second parameter is used to choose a predefined currency formatting scheme:

$currency 1234.56, formatted by currency type
EUR €1.234,56
GBP £1,234.56
USD $1,234.56

The third parameter is an array of options for further defining the output. The following options are available:

Option Description
before The currency symbol to place before whole numbers ie. ‘$’
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.
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
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 htmlentity escaped? Defaults to true
wholeSymbol String to use for whole numbers ie. ‘ dollars’
wholePosition Either ‘before’ or ‘after’ to place the whole symbol
fractionSymbol String to use for fraction numbers ie. ‘ cents’
fractionPosition Either ‘before’ or ‘after’ to place the fraction symbol
fractionExponent Fraction exponent of this specific currency. Defaults to 2.

If a non-recognized $currency value is supplied, it is prepended to a USD formatted number. For example:

// called as NumberHelper
echo $this->Number->currency('1234.56', 'FOO');

// Outputs
FOO 1,234.56

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::currency('1234.56', 'FOO');

Changed in version 2.4: The fractionExponent option was added.

CakeNumber::defaultCurrency(string $currency)
Parameters:

Setter/getter for default currency. This removes the need always passing the currency to CakeNumber::currency() and change all currency outputs by setting other default.

New in version 2.3: This method was added in 2.3

CakeNumber::addFormat(string $formatName, array $options)
Parameters:
  • $formatName (string) – The format name to be used in the future
  • $options (array) – The array of options for this format. Uses the same $options keys as CakeNumber::currency().

Add a currency format to the Number helper. Makes reusing currency formats easier:

// called as NumberHelper
$this->Number->addFormat('BRL', array('before' => 'R$', 'thousands' => '.', 'decimals' => ','));

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
CakeNumber::addFormat('BRL', array('before' => 'R$', 'thousands' => '.', 'decimals' => ','));

You can now use BRL as a short form when formatting currency amounts:

// called as NumberHelper
echo $this->Number->currency($value, 'BRL');

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::currency($value, 'BRL');

Added formats are merged with the following defaults:

array(
    'wholeSymbol'      => '',
    'wholePosition'    => 'before',
    'fractionSymbol'   => false,
    'fractionPosition' => 'after',
    'zero'             => 0,
    'places'           => 2,
    'thousands'        => ',',
    'decimals'         => '.',
    'negative'         => '()',
    'escape'           => true,
    'fractionExponent' => 2
)
CakeNumber::precision(mixed $number, int $precision = 3)
Parameters:
  • $number (float) – The value to covert
  • $precision (integer) – The number of decimal places to display

This method displays a number with the specified amount of precision (decimal places). It will round in order to maintain the level of precision defined.

// called as NumberHelper
echo $this->Number->precision(456.91873645, 2);

// Outputs
456.92

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::precision(456.91873645, 2);
CakeNumber::toPercentage(mixed $number, int $precision = 2, array $options = array())
Parameters:
  • $number (float) – The value to covert.
  • $precision (integer) – The number of decimal places to display.
  • $options (array) – Options, see below.
Option Description
multiply Boolean to indicate whether the value has to be multiplied by 100. Useful for decimal percentages.

Like precision(), this method formats a number according to the supplied precision (where numbers are rounded to meet the given precision). This method also expresses the number as a percentage and prepends the output with a percent sign.

// Called as NumberHelper. Output: 45.69%
echo $this->Number->toPercentage(45.691873645);

// Called as CakeNumber. Output: 45.69%
App::uses('CakeNumber', 'Utility');
echo CakeNumber::toPercentage(45.691873645);

// Called with multiply. Output: 45.69%
echo CakeNumber::toPercentage(0.45691, 2, array(
    'multiply' => true
));

New in version 2.4: The $options argument with the multiply option was added.

CakeNumber::fromReadableSize(string $size, $default)
Parameters:
  • $size (string) – The formatted human readable value.

This method unformats a number from a human readable byte size to an integer number of bytes.

New in version 2.3: This method was added in 2.3

CakeNumber::toReadableSize(string $dataSize)
Parameters:
  • $dataSize (string) – The number of bytes to make readable.

This method formats data sizes in human readable forms. It provides a shortcut way to convert bytes to KB, MB, GB, and TB. The size is displayed with a two-digit precision level, according to the size of data supplied (i.e. higher sizes are expressed in larger terms):

// called as NumberHelper
echo $this->Number->toReadableSize(0); // 0 Bytes
echo $this->Number->toReadableSize(1024); // 1 KB
echo $this->Number->toReadableSize(1321205.76); // 1.26 MB
echo $this->Number->toReadableSize(5368709120); // 5.00 GB

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::toReadableSize(0); // 0 Bytes
echo CakeNumber::toReadableSize(1024); // 1 KB
echo CakeNumber::toReadableSize(1321205.76); // 1.26 MB
echo CakeNumber::toReadableSize(5368709120); // 5.00 GB
CakeNumber::format(mixed $number, mixed $options=false)

This method gives you much more control over the formatting of numbers for use in your views (and is used as the main method by most of the other NumberHelper methods). Using this method might looks like:

// called as NumberHelper
$this->Number->format($number, $options);

// called as CakeNumber
CakeNumber::format($number, $options);

The $number parameter is the number that you are planning on formatting for output. With no $options supplied, the number 1236.334 would output as 1,236. Note that the default precision is zero decimal places.

The $options parameter is where the real magic for this method resides.

  • If you pass an integer then this becomes the amount of precision or places for the function.
  • If you pass an associated array, you can use the following keys:
    • places (integer): the amount of desired precision
    • before (string): to be put before the outputted number
    • escape (boolean): if you want the value in before to be escaped
    • decimals (string): used to delimit the decimal places in a number
    • thousands (string): used to mark off thousand, millions, … places

Example:

// called as NumberHelper
echo $this->Number->format('123456.7890', array(
    'places' => 2,
    'before' => '¥ ',
    'escape' => false,
    'decimals' => '.',
    'thousands' => ','
));
// output '¥ 123,456.79'

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::format('123456.7890', array(
    'places' => 2,
    'before' => '¥ ',
    'escape' => false,
    'decimals' => '.',
    'thousands' => ','
));
// output '¥ 123,456.79'
CakeNumber::formatDelta(mixed $number, mixed $options=array())

This method displays differences in value as a signed number:

// called as NumberHelper
$this->Number->formatDelta($number, $options);

// called as CakeNumber
CakeNumber::formatDelta($number, $options);

The $number parameter is the number that you are planning on formatting for output. With no $options supplied, the number 1236.334 would output as 1,236. Note that the default precision is zero decimal places.

The $options parameter takes the same keys as CakeNumber::format() itself:

  • places (integer): the amount of desired precision
  • before (string): to be put before the outputted number
  • after (string): to be put after the outputted number
  • decimals (string): used to delimit the decimal places in a number
  • thousands (string): used to mark off thousand, millions, … places

Example:

// called as NumberHelper
echo $this->Number->formatDelta('123456.7890', array(
    'places' => 2,
    'decimals' => '.',
    'thousands' => ','
));
// output '+123,456.79'

// called as CakeNumber
App::uses('CakeNumber', 'Utility');
echo CakeNumber::formatDelta('123456.7890', array(
    'places' => 2,
    'decimals' => '.',
    'thousands' => ','
));
// output '+123,456.79'

New in version 2.3: This method was added in 2.3