DEFAULT_LOCALE
DEFAULT_LOCALE = 'en_US' : string
Default locale
Number helper library.
Methods to make numbers more readable.
precision(float $value, integer $precision = 3, array $options = array()) : string
Formats a number with a level of precision.
Options:
locale: The locale name to use for formatting the number, e.g. fr_FR| float | $value | A floating point number. |
| integer | $precision | The precision of the returned number. |
| array | $options | Additional options |
Formatted float.
toPercentage(float $value, 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.locale: The locale name to use for formatting the number, e.g. fr_FR| float | $value | A floating point number |
| integer | $precision | The precision of the returned number |
| array | $options | Options |
Percentage string
format(float $value, array $options = array()) : 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. 2pattern - An ICU number pattern to use for formatting the number. e.g #,###.00locale - 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. ']'| float | $value | A floating point number. |
| array | $options | An array with options. |
Formatted number
parseFloat(string $value, array $options = array()) : float
Parse a localized numeric string and transform it in a float point
Options:
locale - The locale name to use for parsing the number, e.g. fr_FRtype - The formatter type to construct, set it to currency if you need to parse
numbers representing money.| string | $value | A numeric string. |
| array | $options | An array with options. |
point number
formatDelta(float $value, array $options = array()) : 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. ']'| float | $value | A floating point number |
| array | $options | Options list. |
formatted delta
currency(float $value, string|null $currency = null, array $options = array()) : 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 #,###.00useIntlCode - Whether or not to replace the currency symbol with the international
currency code.| float | $value | Value to format. |
| string|null | $currency | International currency name such as 'USD', 'EUR', 'JPY', 'CAD' |
| array | $options | Options list. |
Number formatted as a currency.
defaultCurrency(string|boolean|null $currency = null) : string|null
Getter/setter for default currency
| string|boolean|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 |
Currency
formatter(array $options = array()) : \NumberFormatter
Returns a formatter object that can be reused for similar formatting task under the same locale and options. This is often a speedier alternative to using other methods in this class as only one formatter object needs to be constructed.
locale - The locale name to use for formatting the number, e.g. fr_FRtype - The formatter type to construct, set it to currency if you need to format
numbers representing money or a NumberFormatter constant.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.| array | $options | An array with options. |
The configured formatter instance
config(string $locale, integer $type = \NumberFormatter::DECIMAL, array $options = array()) : void
Configure formatters.
| string | $locale | The locale name to use for formatting the number, e.g. fr_FR |
| integer | $type | The formatter type to construct. Defaults to NumberFormatter::DECIMAL. |
| array | $options | See Number::formatter() for possible options. |
ordinal(integer|float $value, array $options = array()) : string
Returns a formatted integer as an ordinal number string (e.g. 1st, 2nd, 3rd, 4th, [.
..])
type - The formatter type to construct, set it to currency if you need to format
numbers representing money or a NumberFormatter constant.For all other options see formatter().
| integer|float | $value | An integer |
| array | $options | An array with options. |
Loading…