Class CakeNumber

_numberFormat()source protected static

_numberFormat( float $value , integer $places 0 , string $decimals '.' , string $thousands ',' )

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

Parameters

float $value

Value to format.

integer $places optional 0

Decimal places to use.

string $decimals optional '.'

Decimal position string.

string $thousands optional ','

Thousands separator string.

Returns

string

addFormat()source public static

addFormat( string $formatName , array $options )

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.

Parameters

string $formatName

The format name to be used in the future.

array $options

The array of options for this format.

See

NumberHelper::currency()

Link

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

currency()source public static

currency( float $value , string $currency null , array $options array() )

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.

Parameters

float $value

Value to format.

string $currency optional null

Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise set at least 'before' and 'after' options.

array $options optional array()

Options list.

Returns

string
Number formatted as a currency.

Link

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

defaultCurrency()source public static

defaultCurrency( string $currency null )

Getter/setter for default currency

Parameters

string $currency optional null

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

Returns

string
Currency

Link

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

format()source public static

format( float $value , integer $options false )

Formats a number into a currency format.

Parameters

float $value

A floating point number

integer $options optional false

If integer then places, if string then before, if (,.-) then use it or array with places and before keys

Returns

string
formatted number

Link

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

formatDelta()source public static

formatDelta( float $value , array $options array() )

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. '.'

Parameters

float $value

A floating point number

array $options optional array()

Options list.

Returns

string
formatted delta

Link

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

fromReadableSize()source public static

fromReadableSize( string $size , mixed $default false )

Converts filesize from human readable string to bytes

Parameters

string $size

Size in human readable string like '5MB', '5M', '500B', '50kb' etc.

mixed $default optional false

Value to be returned when invalid size was used, for example 'Unknown type'

Returns

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

precision()source public static

precision( float $value , integer $precision 3 )

Formats a number with a level of precision.

Parameters

float $value

A floating point number.

integer $precision optional 3

The precision of the returned number.

Returns

float
Formatted float.

Link

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

toPercentage()source public static

toPercentage( float $value , integer $precision 2 , array $options array() )

Formats a number into a percentage string.

Options:

• multiply: Multiply the input value by 100 for decimal percentages.

Parameters

float $value

A floating point number

integer $precision optional 2

The precision of the returned number

array $options optional array()

Options

Returns

string
Percentage string

Link

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

toReadableSize()source public static

toReadableSize( integer $size )

Returns a formatted-for-humans file size.

Parameters

integer $size

Size in bytes

Returns

string
Human readable size

Link

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

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
    ),
)

array(
    'wholeSymbol' => '', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',
    'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
    'fractionExponent' => 2
)

'USD'

null