\Cake\View\HelperNumberHelper

Number helper library.

Methods to make numbers more readable.

Summary

Methods

Properties

Constants

__construct()
__call()
__get()
__set()
getView()
addClass()
implementedEvents()
initialize()
__debugInfo()
setConfig()
getConfig()
config()
configShallow()
precision()
toReadableSize()
toPercentage()
format()
currency()
formatDelta()
defaultCurrency()
ordinal()

$fieldset
$tags

No constants found

_confirm()
_cleanConfirmMessage()
_configRead()
_configWrite()
_configDelete()

$helpers
$_defaultConfig
$_helperMap
$_View
$_config
$_configInitialized
$_engine

N/A

No private methods found

No private properties found

N/A

Properties

$fieldset

$fieldset : array

Unused.

Type

array

$tags

$tags : array

Unused.

Type

array

$helpers

$helpers : array

List of helpers used by this helper

Type

array

$_defaultConfig

$_defaultConfig : array

Default config for this class

Type

array

$_helperMap

$_helperMap : array

A helper lookup table used to lazy load helper objects.

Type

array

$_View

$_View : \Cake\View\View

The View instance this helper is attached to

Type

\Cake\View\View

$_config

$_config : array

Runtime config

Type

array

$_configInitialized

$_configInitialized : boolean

Whether the config property has already been configured with defaults

Type

boolean

$_engine

$_engine : \Cake\I18n\Number

Cake\I18n\Number instance

Type

\Cake\I18n\Number

Methods

__construct()

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

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	Configuration settings for the helper

Throws

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

__call()

__call(string  $method, array  $params) : mixed

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

__get()

__get(string  $name) : \Cake\View\Helper|null

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

__set(string  $name, mixed  $value) : void

Magic setter for removed properties.

Parameters

string	$name	Property name.
mixed	$value	Value to set.

getView()

getView() : \Cake\View\View

Get the view instance this helper is bound to.

Returns

\Cake\View\View —

The bound view instance.

addClass()

addClass(array  $options = array(), string|null  $class = null, string  $key = 'class') : array

Adds the given class to the element options

Parameters

array	$options	Array options/attributes to add a class to
string\|null	$class	The class name being added.
string	$key	the key to use for class.

Returns

array —

Array of options with $key set.

implementedEvents()

implementedEvents() : array

Event listeners.

By defining one of the callback methods a helper is assumed to be interested in the related event.

Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.

Returns

array

initialize()

initialize(array  $config) : void

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.

__debugInfo()

__debugInfo() : array

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

Returns

array

setConfig()

setConfig(string|array  $key, mixed|null  $value = null, boolean  $merge = true) : $this

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	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

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

Returns

$this

getConfig()

getConfig(string|null  $key = null, mixed  $default = null) : mixed

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	The key to get or null for the whole config.
mixed	$default	The return value when the key does not exist.

Returns

mixed —

Config value being read.

config()

config(string|array|null  $key = null, mixed|null  $value = null, boolean  $merge = true) : mixed

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	The key to get/set, or a complete array of configs.
mixed\|null	$value	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

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

Returns

mixed —

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

configShallow()

configShallow(string|array  $key, mixed|null  $value = null) : $this

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	The value to set.

Returns

$this

precision()

precision(float  $number, integer  $precision = 3) : string

Formats a number with a level of precision.

Parameters

float	$number	A floating point number.
integer	$precision	The precision of the returned number.

Returns

string —

Formatted float.

toReadableSize()

toReadableSize(integer  $size) : string

Returns a formatted-for-humans file size.

Parameters

integer

$size

Size in bytes

Returns

string —

Human readable size

toPercentage()

toPercentage(float  $number, integer  $precision = 2, array  $options = array()) : string

Formats a number into a percentage string.

Options:

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

Parameters

float	$number	A floating point number
integer	$precision	The precision of the returned number
array	$options	Options

Returns

string —

Percentage string

format()

format(float  $number, array  $options = array()) : string

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	$number	A floating point number.
array	$options	An array with options.

Returns

string —

Formatted number

currency()

currency(float  $number, string|null  $currency = null, array  $options = array()) : string

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 #,###.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	$number	Value to format.
string\|null	$currency	International currency name such as 'USD', 'EUR', 'JPY', 'CAD'
array	$options	Options list.

Returns

string —

Number formatted as a currency.

formatDelta()

formatDelta(float  $value, array  $options = array()) : string

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	$value	A floating point number
array	$options	Options list.

Returns

string —

formatted delta

defaultCurrency()

defaultCurrency(string|boolean  $currency) : string

Getter/setter for default currency

Parameters

string|boolean

$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

Returns

string —

Currency

ordinal()

ordinal(integer|float  $value, array  $options = array()) : string

Formats a number into locale specific ordinal suffix.

Parameters

integer\|float	$value	An integer
array	$options	An array with options.

Returns

string —

formatted number

_confirm()

_confirm(string  $message, string  $okCode, string  $cancelCode = '', array  $options = array()) : string

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	Code to be executed after user chose 'Cancel'
array	$options	Array of options

Returns

string —

onclick JS code

_cleanConfirmMessage()

_cleanConfirmMessage(string  $message) : mixed

Returns a string read to be used in confirm()

Parameters

string

$message

The message to clean

Returns

mixed

_configRead()

_configRead(string|null  $key) : mixed

Reads a config key.

Parameters

string|null

$key

Key to read.

Returns

mixed

_configWrite()

_configWrite(string|array  $key, mixed  $value, boolean|string  $merge = false) : void

Writes a config key.

Parameters

string\|array	$key	Key to write to.
mixed	$value	Value to write.
boolean\|string	$merge	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

_configDelete()

_configDelete(string  $key) : void

Deletes a single config key.

Parameters

string

$key

Key to delete.

Throws

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