Number helper library.
Methods to make numbers more readable.
Cake\View\View
The View instance this helper is attached to
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this class
Cake\I18n\Number
Cake\I18n\Number instance
array<string, array>
A helper lookup table used to lazy load helper objects.
array
List of helpers used by this helper
Call methods from Cake\I18n\Number utility class
Default Constructor
Returns an array that can be used to describe the internal state of this object.
Lazy loads helpers.
Deletes a single config key.
Reads a config key.
Writes a config key.
Returns a string to be used as onclick handler for confirm dialogs.
Adds the given class to the element options
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 a currency format.
Getter/setter for default currency
Formats a number into the correct locale format
Formats a number into the correct locale format to show deltas (signed differences in value).
Returns the config.
Returns the config for this specific key.
Get the view instance this helper is bound to.
Event listeners.
Constructor hook method.
Formats a number into locale specific ordinal suffix.
Formats a number with a level of precision.
Sets the config.
Formats a number into a percentage string.
Returns a formatted-for-humans file size.
__call(string $method, array $params): mixed
Call methods from Cake\I18n\Number utility class
string
$method Method to invoke
array
$params Array of params for the method.
mixed
__construct(Cake\View\View $view, array<string, mixed> $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<string, mixed>
$config optional Configuration settings for the helper
Cake\Core\Exception\CakeException
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
array<string, mixed>
__get(string $name): Cake\View\Helper|null|void
Lazy loads helpers.
string
$name Name of the property being accessed.
Cake\View\Helper|null|void
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
_confirm(string $okCode, string $cancelCode): string
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
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>
Adds the given class to the element options
array<string, mixed>
$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<string, mixed>
configShallow(array<string, mixed>|string $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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
currency(string|float $number, string|null $currency = null, array<string, mixed> $options = []): string
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 to replace the currency symbol with the international currency code.escape
- Whether to escape html in resulting stringstring|float
$number Value to format.
string|null
$currency optional International currency name such as 'USD', 'EUR', 'JPY', 'CAD'
array<string, mixed>
$options optional Options list.
string
defaultCurrency(string|false|null $currency): string|null
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
format(string|int|float $number, array<string, mixed> $options = []): string
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 to escape html in resulting stringstring|int|float
$number A floating point number.
array<string, mixed>
$options optional An array with options.
string
formatDelta(string|float $value, array<string, mixed> $options = []): string
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 escapingstring|float
$value A floating point number
array<string, mixed>
$options optional Options list.
string
getConfig(string|null $key = null, mixed $default = null): mixed
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
getConfigOrFail(string $key): mixed
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
InvalidArgumentException
getView(): Cake\View\View
Get the view instance this helper is bound to.
Cake\View\View
implementedEvents(): array<string, mixed>
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.
array<string, mixed>
initialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed>
$config The configuration settings provided to this helper.
void
ordinal(float|int $value, array<string, mixed> $options = []): string
Formats a number into locale specific ordinal suffix.
float|int
$value An integer
array<string, mixed>
$options optional An array with options.
string
precision(string|float $number, int $precision = 3, array<string, mixed> $options = []): string
Formats a number with a level of precision.
string|float
$number A floating point number.
int
$precision optional The precision of the returned number.
array<string, mixed>
$options optional Additional options.
string
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string
$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\CakeException
toPercentage(string|float $number, int $precision = 2, array<string, mixed> $options = []): string
Formats a number into a percentage string.
Options:
multiply
: Multiply the input value by 100 for decimal percentages.string|float
$number A floating point number
int
$precision optional The precision of the returned number
array<string, mixed>
$options optional Options
string
toReadableSize(string|int $size): string
Returns a formatted-for-humans file size.
string|int
$size Size in bytes
string
The View instance this helper is attached to
Cake\View\View
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this class
array<string, mixed>
Cake\I18n\Number instance
Cake\I18n\Number
A helper lookup table used to lazy load helper objects.
array<string, 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.4/class-Cake.View.Helper.NumberHelper.html