Class NumberHelper

Number helper library.

Methods to make numbers more readable.

Namespace: Cake\View\Helper

Properties summary

  • $_View protected
    \Cake\View\View

    The View instance this helper is attached to

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for this class

  • $_engine protected
    \Cake\I18n\Number

    Cake\I18n\Number instance

  • $_helperMap protected
    array

    A helper lookup table used to lazy load helper objects.

  • $fieldset public
    array

    Unused.

  • $helpers protected
    array

    List of helpers used by this helper

  • $tags public
    array

    Unused.

Method Summary

  • __call() public

    Call methods from Cake\I18n\Number utility class

  • __construct() public

    Default Constructor

  • __debugInfo() public

    Returns an array that can be used to describe the internal state of this object.

  • __get() public

    Lazy loads helpers.

  • __set() public

    Magic setter for removed properties.

  • _cleanConfirmMessage() protected

    Returns a string read to be used in confirm()

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _confirm() protected

    Returns a string to be used as onclick handler for confirm dialogs.

  • addClass() public

    Adds the given class to the element options

  • config() public

    Gets/Sets the config.

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • currency() public

    Formats a number into a currency format.

  • defaultCurrency() public

    Getter/setter for default currency

  • format() public

    Formats a number into the correct locale format

  • formatDelta() public

    Formats a number into the correct locale format to show deltas (signed differences in value).

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • getView() public

    Get the view instance this helper is bound to.

  • implementedEvents() public

    Event listeners.

  • initialize() public

    Constructor hook method.

  • ordinal() public

    Formats a number into locale specific ordinal suffix.

  • precision() public

    Formats a number with a level of precision.

  • setConfig() public

    Sets the config.

  • toPercentage() public

    Formats a number into a percentage string.

  • toReadableSize() public

    Returns a formatted-for-humans file size.

Method Detail

__call() public 

__call(mixed $method, mixed $params)

Call methods from Cake\I18n\Number utility class

Parameters

string $method

Method to invoke

array $params

Array of params for the method.

Returns

mixed

Whatever is returned by called method, or false on failure

__construct() public 

__construct(\Cake\View\View $View, array $config)

Default Constructor

Settings:

  • engine Class name to use to replace Cake\I18n\Number functionality The class needs to be placed in the Utility directory.

Parameters

\Cake\View\View $View

The View this helper is being attached to.

array $config optional

Configuration settings for the helper

Throws

Cake\Core\Exception\Exception
When the engine class could not be found.

__debugInfo() public 

__debugInfo()

Returns an array that can be used to describe the internal state of this object.

Returns

array

__get() public 

__get(mixed $name)

Lazy loads helpers.

Parameters

string $name

Name of the property being accessed.

Returns

\Cake\View\Helper|null

Helper instance if helper with provided name exists

__set() public 

__set(mixed $name, mixed $value)

Magic setter for removed properties.

Parameters

string $name

Property name.

mixed $value

Value to set.

_cleanConfirmMessage() protected 

_cleanConfirmMessage(mixed $message)

Returns a string read to be used in confirm()

Parameters

string $message

The message to clean

Returns

mixed

_configDelete() protected 

_configDelete(mixed $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected 

_configRead(mixed $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_confirm() protected 

_confirm(mixed $message, mixed $okCode, mixed $cancelCode, mixed $options)

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message

Message to be displayed

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode optional

Code to be executed after user chose 'Cancel'

array $options optional

Array of options

Returns

string

onclick JS code

addClass() public 

addClass(array $options, mixed $class, mixed $key)

Adds the given class to the element options

Parameters

array $options optional

Array options/attributes to add a class to

string|null $class optional

The class name being added.

string $key optional

the key to use for class. Defaults to 'class'.

Returns

array

Array of options with $key set.

config() public 

config(mixed $key, mixed $value, mixed $merge)

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array|null $key optional

The key to get/set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed

Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() public 

configShallow(mixed $key, mixed $value)

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

currency() public 

currency(mixed $number, mixed $currency, array $options)

Formats a number into a currency format.

Options

  • locale - The locale name to use for formatting the number, e.g. fr_FR
  • fractionSymbol - The currency symbol to use for fractional numbers.
  • fractionPosition - The position the fraction symbol should be placed valid options are 'before' & 'after'.
  • before - Text to display before the rendered number
  • after - Text to display after the rendered number
  • zero - The text to use for zero values, can be a string or a number. e.g. 0, 'Free!'
  • places - Number of decimal places to use. e.g. 2
  • precision - Maximum Number of decimal places to use, e.g. 2
  • pattern - An ICU number pattern to use for formatting the number. e.g #,##0.00
  • useIntlCode - Whether or not to replace the currency symbol with the international currency code.
  • escape - Whether or not to escape html in resulting string

Parameters

float|string $number

Value to format.

string|null $currency optional

International currency name such as 'USD', 'EUR', 'JPY', 'CAD'

array $options optional

Options list.

Returns

string

Number formatted as a currency.

defaultCurrency() public 

defaultCurrency(mixed $currency)

Getter/setter for default currency

Parameters

string|false|null $currency

Default currency string to be used by currency() if $currency argument is not provided. If boolean false is passed, it will clear the currently stored value. Null reads the current default.

Returns

string|null

Currency

format() public 

format(mixed $number, array $options)

Formats a number into the correct locale format

Options:

  • places - Minimum number or decimals to use, e.g 0
  • precision - Maximum Number of decimal places to use, e.g. 2
  • locale - The locale name to use for formatting the number, e.g. fr_FR
  • before - The string to place before whole numbers, e.g. '['
  • after - The string to place after decimal numbers, e.g. ']'
  • escape - Whether or not to escape html in resulting string

Parameters

float|string $number

A floating point number.

array $options optional

An array with options.

Returns

string

Formatted number

Links

https://book.cakephp.org/3/en/views/helpers/number.html#formatting-numbers

formatDelta() public 

formatDelta(mixed $value, array $options)

Formats a number into the correct locale format to show deltas (signed differences in value).

Options

  • places - Minimum number or decimals to use, e.g 0
  • precision - Maximum Number of decimal places to use, e.g. 2
  • locale - The locale name to use for formatting the number, e.g. fr_FR
  • before - The string to place before whole numbers, e.g. '['
  • after - The string to place after decimal numbers, e.g. ']'
  • escape - Set to false to prevent escaping

Parameters

float|string $value

A floating point number

array $options optional

Options list.

Returns

string

formatted delta

getConfig() public 

getConfig(mixed $key, mixed $default)

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional

The key to get or null for the whole config.

mixed|null $default optional

The return value when the key does not exist.

Returns

mixed|null

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(mixed $key)

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string|null $key

The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getView() public 

getView()

Get the view instance this helper is bound to.

Returns

\Cake\View\View

The bound view instance.

implementedEvents() public 

implementedEvents()

Event listeners.

Returns

array

initialize() public 

initialize(array $config)

Constructor hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config

The configuration settings provided to this helper.

ordinal() public 

ordinal(mixed $value, array $options)

Formats a number into locale specific ordinal suffix.

Parameters

int|float $value

An integer

array $options optional

An array with options.

Returns

string

formatted number

precision() public 

precision(mixed $number, mixed $precision, array $options)

Formats a number with a level of precision.

Parameters

float $number

A floating point number.

int $precision optional

The precision of the returned number.

array $options optional

Additional options.

Returns

string

Formatted float.

See Also

\Cake\I18n\Number::precision()

Links

https://book.cakephp.org/3/en/views/helpers/number.html#formatting-floating-point-numbers

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

toPercentage() public 

toPercentage(mixed $number, mixed $precision, array $options)

Formats a number into a percentage string.

Options:

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

Parameters

float|string $number

A floating point number

int $precision optional

The precision of the returned number

array $options optional

Options

Returns

string

Percentage string

See Also

\Cake\I18n\Number::toPercentage()

Links

https://book.cakephp.org/3/en/views/helpers/number.html#formatting-percentages

toReadableSize() public 

toReadableSize(mixed $size)

Returns a formatted-for-humans file size.

Parameters

int $size

Size in bytes

Returns

string

Human readable size

See Also

\Cake\I18n\Number::toReadableSize()

Links

https://book.cakephp.org/3/en/views/helpers/number.html#interacting-with-human-readable-values

Property Detail

$_View protected

The View instance this helper is attached to

Type

\Cake\View\View

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

Default config for this class

Type

array

$_engine protected

Cake\I18n\Number instance

Type

\Cake\I18n\Number

$_helperMap protected

A helper lookup table used to lazy load helper objects.

Type

array

$fieldset public

Unused.

Type

array

$helpers protected

List of helpers used by this helper

Type

array

$tags public

Unused.

Type

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.View.Helper.NumberHelper.html