__call()source public

__call( string $method , array $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

Overrides

Cake\View\Helper::__call()

__construct()source 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.

Overrides

Cake\View\Helper::__construct()

currency()source public

currency( float $number , string|null $currency = null , 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 $number

Value to format.

string|null $currency optional null

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

array $options optional []

Options list.

Returns

string
Number formatted as a currency.

defaultCurrency()source public

defaultCurrency( string|boolean $currency )

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

format()source public

format( float $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 $number

A floating point number.

array $options optional []

An array with options.

Returns

string
Formatted number

Link

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

formatDelta()source public

formatDelta( float $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 $value

A floating point number

array $options optional []

Options list.

Returns

string
formatted delta

implementedEvents()source public

implementedEvents( )

Event listeners.

Returns

array

Overrides

Cake\View\Helper::implementedEvents()

ordinal()source public

ordinal( integer|float $value , array $options = [] )

Formats a number into locale specific ordinal suffix.

Parameters

integer|float $value

An integer

array $options optional []

An array with options.

Returns

string
formatted number

precision()source public

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

Formats a number with a level of precision.

Parameters

float $number

A floating point number.

integer $precision optional 3

The precision of the returned number.

Returns

string
Formatted float.

See

\Cake\I18n\Number::precision()

Link

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

toPercentage()source public

toPercentage( float $number , integer $precision = 2 , array $options = [] )

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 optional 2

The precision of the returned number

array $options optional []

Options

Returns

string
Percentage string

See

\Cake\I18n\Number::toPercentage()

Link

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

toReadableSize()source public

toReadableSize( integer $size )

Returns a formatted-for-humans file size.

Parameters

integer $size

Size in bytes

Returns

string
Human readable size

See

\Cake\I18n\Number::toReadableSize()

Link

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

__debugInfo()source public

__debugInfo( )

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

Returns

array

__get()source public

__get( string $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()source public

__set( string $name , mixed $value )

Magic setter for removed properties.

Parameters

string $name

Property name.

mixed $value

Value to set.

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Returns a string read to be used in confirm()

Parameters

string $message

The message to clean

Returns

mixed

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $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()source public

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

Adds the given class to the element options

Parameters

array $options optional []

Array options/attributes to add a class to

string|null $class optional null

The class name being added.

string $key optional 'class'

the key to use for class.

Returns

array
Array of options with $key set.

getView()source public

getView( )

Get the view instance this helper is bound to.

Returns

Cake\View\View
The bound view instance.

initialize()source 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.

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source protected

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

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

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

config()source public deprecated

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

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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null

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

mixed|null $value optional null

The value to set.

boolean $merge optional true

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

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

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 null

The value to set.

Returns

$this

getConfig()source public

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

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 null

The key to get or null for the whole config.

mixed $default optional null

The return value when the key does not exist.

Returns

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

setConfig()source public

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

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 null

The value to set.

boolean $merge optional true

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.

[
    'engine' => 'Cake\I18n\Number'
]