Number helper library.
Methods to make numbers more readable.
\Cake\View\View
The View instance this helper is attached to
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this class
\Cake\I18n\Number
Cake\I18n\Number instance
array
A helper lookup table used to lazy load helper objects.
array
List of helpers used by this helper
Returns an array that can be used to describe the internal state of this object.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Formats a number into the correct locale format to show deltas (signed differences in value).
__call(string $method, array $params)
Call methods from Cake\I18n\Number utility class
string
$method Method to invoke
array
$params Array of params for the method.
mixed
Whatever is returned by called method, or false on failure
__construct(\Cake\View\View $view, array $config)
Default Constructor
engine
Class name to use to replace Cake\I18n\Number functionality The class needs to be placed in the Utility
directory.\Cake\View\View
$view The View this helper is being attached to.
array
$config optional Configuration settings for the helper
Cake\Core\Exception\Exception
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Lazy loads helpers.
string
$name Name of the property being accessed.
\Cake\View\Helper|null|void
Helper instance if helper with provided name exists
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception
_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string
$okCode Code to be executed after user chose 'OK'
string
$cancelCode Code to be executed after user chose 'Cancel'
string
"onclick" JS code
addClass(array $options, string $class, string $key)
Adds the given class to the element options
array
$options Array options/attributes to add a class to
string
$class The class name being added.
string
$key optional the key to use for class. Defaults to 'class'
.
array
Array of options with $key set.
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
currency(mixed $number, ?string $currency, array $options)
Formats a number into a currency format.
locale
- The locale name to use for formatting the number, e.g. fr_FRfractionSymbol
- 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 numberafter
- Text to display after the rendered numberzero
- 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. 2precision
- Maximum Number of decimal places to use, e.g. 2pattern
- An ICU number pattern to use for formatting the number. e.g #,##0.00useIntlCode
- Whether or not to replace the currency symbol with the international currency code.escape
- Whether or not to escape html in resulting stringfloat|string
$number Value to format.
string|null
$currency optional International currency name such as 'USD', 'EUR', 'JPY', 'CAD'
array
$options optional Options list.
string
Number formatted as a currency.
defaultCurrency(mixed $currency)
Getter/setter for default currency
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.
string|null
Currency
format(mixed $number, array $options)
Formats a number into the correct locale format
Options:
places
- Minimum number or decimals to use, e.g 0precision
- Maximum Number of decimal places to use, e.g. 2locale
- The locale name to use for formatting the number, e.g. fr_FRbefore
- 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 stringfloat|string
$number A floating point number.
array
$options optional An array with options.
string
Formatted number
formatDelta(mixed $value, array $options)
Formats a number into the correct locale format to show deltas (signed differences in value).
places
- Minimum number or decimals to use, e.g 0precision
- Maximum Number of decimal places to use, e.g. 2locale
- The locale name to use for formatting the number, e.g. fr_FRbefore
- 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 escapingfloat|string
$value A floating point number
array
$options optional Options list.
string
formatted delta
getConfig(?string $key, mixed $default)
Returns the config.
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');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getView()
Get the view instance this helper is bound to.
\Cake\View\View
The bound view instance.
implementedEvents()
Event listeners.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this helper.
ordinal(mixed $value, array $options)
Formats a number into locale specific ordinal suffix.
int|float
$value An integer
array
$options optional An array with options.
string
formatted number
precision(mixed $number, int $precision, array $options)
Formats a number with a level of precision.
float|string
$number A floating point number.
int
$precision optional The precision of the returned number.
array
$options optional Additional options.
string
Formatted float.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
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.
$this
Cake\Core\Exception\Exception
toPercentage(mixed $number, int $precision, array $options)
Formats a number into a percentage string.
Options:
multiply
: Multiply the input value by 100 for decimal percentages.float|string
$number A floating point number
int
$precision optional The precision of the returned number
array
$options optional Options
string
Percentage string
toReadableSize(mixed $size)
Returns a formatted-for-humans file size.
int|string
$size Size in bytes
string
Human readable size
The View instance this helper is attached to
\Cake\View\View
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this class
array
Cake\I18n\Number instance
\Cake\I18n\Number
A helper lookup table used to lazy load helper objects.
array
List of helpers used by this helper
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/4.1/class-Cake.View.Helper.NumberHelper.html