Number helper library.
Methods to make numbers more readable.
Cake\I18n\Number
__call( string $method , array $params )
Call methods from Cake\I18n\Number utility class
$method
$params
mixed
Cake\View\Helper::__call()
__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
$config
optional [] Cake\Core\Exception\Exception
Cake\View\Helper::__construct()
currency( float $number , string $currency null , 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 #,###.00useIntlCode
- Whether or not to replace the currency symbol with the international currency code.escape
- Whether or not to escape html in resulting string$number
$currency
optional null $options
optional [] string
defaultCurrency( string|boolean $currency )
Getter/setter for default currency
$currency
string
format( float $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 string$number
$options
optional [] string
formatDelta( float $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 escaping$value
$options
optional [] string
implementedEvents( )
Event listeners.
array
Cake\View\Helper::implementedEvents()
ordinal( integer|float $value , array $options [] )
Formats a number into locale specific ordinal suffix.
$value
$options
optional [] string
precision( float $number , integer $precision 3 )
Formats a number with a level of precision.
$number
$precision
optional 3 float
Cake\I18n\Number::precision()
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.$number
$precision
optional 2 $options
optional [] string
Cake\I18n\Number::toPercentage()
toReadableSize( integer $size )
Returns a formatted-for-humans file size.
$size
string
Cake\I18n\Number::toReadableSize()
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
array
__get( string $name )
Lazy loads helpers.
$name
Cake\View\Helper|null
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Returns a string to be used as onclick handler for confirm dialogs.
$message
$okCode
$cancelCode
optional '' $options
optional [] string
addClass( array $options [] , string $class null , string $key 'class' )
Adds the given class to the element options
$options
optional [] $class
optional null $key
optional 'class' array
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
$key
optional null $value
optional null $merge
optional true mixed
Cake\Core\Exception\Exception
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->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']);
$key
$value
optional null mixed
public array
Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']
[]
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.View.Helper.NumberHelper.html