# The NumberFormatter class

(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)

## Introduction

Programs store and operate on numbers using a locale-independent binary representation. When displaying or printing a number it is converted to a locale-specific string. For example, the number 12345.67 is "12,345.67" in the US, "12 345,67" in France and "12.345,67" in Germany.

By invoking the methods provided by the NumberFormatter class, you can format numbers, currencies, and percentages according to the specified or default locale. NumberFormatter is locale-sensitive so you need to create a new NumberFormatter for each locale. NumberFormatter methods format primitive-type numbers, such as double and output the number as a locale-specific string.

For currencies you can use currency format type to create a formatter that returns a string with the formatted number and the appropriate currency sign. Of course, the NumberFormatter class is unaware of exchange rates so, the number output is the same regardless of the specified currency. This means that the same number has different monetary values depending on the currency locale. If the number is 9988776.65 the results will be:

- 9 988 776,65 € in France
- 9.988.776,65 € in Germany
- $9,988,776.65 in the United States

In order to format percentages, create a locale-specific formatter with percentage format type. With this formatter, a decimal fraction such as 0.75 is displayed as 75%.

For more complex formatting, like spelled-out numbers, the rule-based number formatters are used.

## Class synopsis

NumberFormatter {
/* Methods */
public __construct ( string `$locale` , int `$style` [, string `$pattern` ] )
public static create ( string `$locale` , int `$style` [, string `$pattern` ] ) : NumberFormatter
public formatCurrency ( float `$value` , string `$currency` ) : string
public format ( number `$value` [, int `$type` ] ) : string
public getAttribute ( int `$attr` ) : int
public getErrorCode ( void ) : int
public getErrorMessage ( void ) : string
public getLocale ([ int `$type` ] ) : string
public getPattern ( void ) : string
public getSymbol ( int `$attr` ) : string
public getTextAttribute ( int `$attr` ) : string
public parseCurrency ( string `$value` , string `&$currency` [, int `&$position` ] ) : float
public parse ( string `$value` [, int `$type` [, int `&$position` ]] ) : mixed
public setAttribute ( int `$attr` , int `$value` ) : bool
public setPattern ( string `$pattern` ) : bool
public setSymbol ( int `$attr` , string `$value` ) : bool
public setTextAttribute ( int `$attr` , string `$value` ) : bool
}

## Predefined Constants

These styles are used by the numfmt_create() to define the type of the formatter.

`NumberFormatter::PATTERN_DECIMAL` (integer)
  Decimal format defined by pattern
`NumberFormatter::DECIMAL` (integer)
  Decimal format
`NumberFormatter::CURRENCY` (integer)
  Currency format
`NumberFormatter::PERCENT` (integer)
  Percent format
`NumberFormatter::SCIENTIFIC` (integer)
  Scientific format
`NumberFormatter::SPELLOUT` (integer)
  Spellout rule-based format
`NumberFormatter::ORDINAL` (integer)
  Ordinal rule-based format
`NumberFormatter::DURATION` (integer)
  Duration rule-based format
`NumberFormatter::PATTERN_RULEBASED` (integer)
  Rule-based format defined by pattern
`NumberFormatter::CURRENCY_ACCOUNTING` (integer)
  Currency format for accounting, e.g., ($3.00) for negative currency amount instead of -$3.00. Available as of PHP 7.4.1 and ICU 53.
`NumberFormatter::DEFAULT_STYLE` (integer)
  Default format for the locale
`NumberFormatter::IGNORE` (integer)
  Alias for PATTERN_DECIMAL

These constants define how the numbers are parsed or formatted. They should be used as arguments to numfmt_format() and numfmt_parse().

`NumberFormatter::TYPE_DEFAULT` (integer)
  Derive the type from variable type
`NumberFormatter::TYPE_INT32` (integer)
  Format/parse as 32-bit integer
`NumberFormatter::TYPE_INT64` (integer)
  Format/parse as 64-bit integer
`NumberFormatter::TYPE_DOUBLE` (integer)
  Format/parse as floating point value
`NumberFormatter::TYPE_CURRENCY` (integer)
  Format/parse as currency value

Number format attribute used by numfmt_get_attribute() and numfmt_set_attribute().

`NumberFormatter::PARSE_INT_ONLY` (integer)
  Parse integers only.
`NumberFormatter::GROUPING_USED` (integer)
  Use grouping separator.
`NumberFormatter::DECIMAL_ALWAYS_SHOWN` (integer)
  Always show decimal point.
`NumberFormatter::MAX_INTEGER_DIGITS` (integer)
  Maximum integer digits.
`NumberFormatter::MIN_INTEGER_DIGITS` (integer)
  Minimum integer digits.
`NumberFormatter::INTEGER_DIGITS` (integer)
  Integer digits.
`NumberFormatter::MAX_FRACTION_DIGITS` (integer)
  Maximum fraction digits.
`NumberFormatter::MIN_FRACTION_DIGITS` (integer)
  Minimum fraction digits.
`NumberFormatter::FRACTION_DIGITS` (integer)
  Fraction digits.
`NumberFormatter::MULTIPLIER` (integer)
  Multiplier.
`NumberFormatter::GROUPING_SIZE` (integer)
  Grouping size.
`NumberFormatter::ROUNDING_MODE` (integer)
  Rounding Mode.
`NumberFormatter::ROUNDING_INCREMENT` (integer)
  Rounding increment.
`NumberFormatter::FORMAT_WIDTH` (integer)
  The width to which the output of format() is padded.
`NumberFormatter::PADDING_POSITION` (integer)
  The position at which padding will take place. See pad position constants for possible argument values.
`NumberFormatter::SECONDARY_GROUPING_SIZE` (integer)
  Secondary grouping size.
`NumberFormatter::SIGNIFICANT_DIGITS_USED` (integer)
  Use significant digits.
`NumberFormatter::MIN_SIGNIFICANT_DIGITS` (integer)
  Minimum significant digits.
`NumberFormatter::MAX_SIGNIFICANT_DIGITS` (integer)
  Maximum significant digits.
`NumberFormatter::LENIENT_PARSE` (integer)
  Lenient parse mode used by rule-based formats.

Number format text attribute used by numfmt_get_text_attribute() and numfmt_set_text_attribute().

`NumberFormatter::POSITIVE_PREFIX` (integer)
  Positive prefix.
`NumberFormatter::POSITIVE_SUFFIX` (integer)
  Positive suffix.
`NumberFormatter::NEGATIVE_PREFIX` (integer)
  Negative prefix.
`NumberFormatter::NEGATIVE_SUFFIX` (integer)
  Negative suffix.
`NumberFormatter::PADDING_CHARACTER` (integer)
  The character used to pad to the format width.
`NumberFormatter::CURRENCY_CODE` (integer)
  The ISO currency code.
`NumberFormatter::DEFAULT_RULESET` (integer)
  The default rule set. This is only available with rule-based formatters.
`NumberFormatter::PUBLIC_RULESETS` (integer)
  The public rule sets. This is only available with rule-based formatters. This is a read-only attribute. The public rulesets are returned as a single string, with each ruleset name delimited by ';' (semicolon).

Number format symbols used by numfmt_get_symbol() and numfmt_set_symbol().

`NumberFormatter::DECIMAL_SEPARATOR_SYMBOL` (integer)
  The decimal separator.
`NumberFormatter::GROUPING_SEPARATOR_SYMBOL` (integer)
  The grouping separator.
`NumberFormatter::PATTERN_SEPARATOR_SYMBOL` (integer)
  The pattern separator.
`NumberFormatter::PERCENT_SYMBOL` (integer)
  The percent sign.
`NumberFormatter::ZERO_DIGIT_SYMBOL` (integer)
  Zero.
`NumberFormatter::DIGIT_SYMBOL` (integer)
  Character representing a digit in the pattern.
`NumberFormatter::MINUS_SIGN_SYMBOL` (integer)
  The minus sign.
`NumberFormatter::PLUS_SIGN_SYMBOL` (integer)
  The plus sign.
`NumberFormatter::CURRENCY_SYMBOL` (integer)
  The currency symbol.
`NumberFormatter::INTL_CURRENCY_SYMBOL` (integer)
  The international currency symbol.
`NumberFormatter::MONETARY_SEPARATOR_SYMBOL` (integer)
  The monetary separator.
`NumberFormatter::EXPONENTIAL_SYMBOL` (integer)
  The exponential symbol.
`NumberFormatter::PERMILL_SYMBOL` (integer)
  Per mill symbol.
`NumberFormatter::PAD_ESCAPE_SYMBOL` (integer)
  Escape padding character.
`NumberFormatter::INFINITY_SYMBOL` (integer)
  Infinity symbol.
`NumberFormatter::NAN_SYMBOL` (integer)
  Not-a-number symbol.
`NumberFormatter::SIGNIFICANT_DIGIT_SYMBOL` (integer)
  Significant digit symbol.
`NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL` (integer)
  The monetary grouping separator.

Rounding mode values used by numfmt_get_attribute() and numfmt_set_attribute() with `NumberFormatter::ROUNDING_MODE` attribute.

`NumberFormatter::ROUND_CEILING` (integer)
  Rounding mode to round towards positive infinity.
`NumberFormatter::ROUND_DOWN` (integer)
  Rounding mode to round towards zero.
`NumberFormatter::ROUND_FLOOR` (integer)
  Rounding mode to round towards negative infinity.
`NumberFormatter::ROUND_HALFDOWN` (integer)
  Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
`NumberFormatter::ROUND_HALFEVEN` (integer)
  Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.
`NumberFormatter::ROUND_HALFUP` (integer)
  Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
`NumberFormatter::ROUND_UP` (integer)
  Rounding mode to round away from zero.

Pad position values used by numfmt_get_attribute() and numfmt_set_attribute() with `NumberFormatter::PADDING_POSITION` attribute.

`NumberFormatter::PAD_AFTER_PREFIX` (integer)
  Pad characters inserted after the prefix.
`NumberFormatter::PAD_AFTER_SUFFIX` (integer)
  Pad characters inserted after the suffix.
`NumberFormatter::PAD_BEFORE_PREFIX` (integer)
  Pad characters inserted before the prefix.
`NumberFormatter::PAD_BEFORE_SUFFIX` (integer)
  Pad characters inserted before the suffix.

## See Also

- » ICU formatting documentation
- » ICU number formatters
- » ICU decimal formatters
- » ICU rule-based number formatters

## Table of Contents

- NumberFormatter::create — Create a number formatter
- NumberFormatter::formatCurrency — Format a currency value
- NumberFormatter::format — Format a number
- NumberFormatter::getAttribute — Get an attribute
- NumberFormatter::getErrorCode — Get formatter's last error code
- NumberFormatter::getErrorMessage — Get formatter's last error message
- NumberFormatter::getLocale — Get formatter locale
- NumberFormatter::getPattern — Get formatter pattern
- NumberFormatter::getSymbol — Get a symbol value
- NumberFormatter::getTextAttribute — Get a text attribute
- NumberFormatter::parseCurrency — Parse a currency number
- NumberFormatter::parse — Parse a number
- NumberFormatter::setAttribute — Set an attribute
- NumberFormatter::setPattern — Set formatter pattern
- NumberFormatter::setSymbol — Set a symbol value
- NumberFormatter::setTextAttribute — Set a text attribute