php-doc-en/reference/intl/numberformatter-constants.xml
Christoph Michael Becker 86e6094e86 Use canonical type names
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00

860 lines
24 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="intl.numberformatter-constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
<section xml:id="intl.numberformatter-constants.unumberformatstyle">
<para>
These styles are used by the <function>numfmt_create</function>
to define the type of the formatter.
<variablelist>
<varlistentry xml:id="numberformatter.constants.pattern-decimal">
<term>
<constant>NumberFormatter::PATTERN_DECIMAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Decimal format defined by pattern</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.decimal">
<term>
<constant>NumberFormatter::DECIMAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Decimal format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.currency">
<term>
<constant>NumberFormatter::CURRENCY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Currency format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.percent">
<term>
<constant>NumberFormatter::PERCENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Percent format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.scientific">
<term>
<constant>NumberFormatter::SCIENTIFIC</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Scientific format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.spellout">
<term>
<constant>NumberFormatter::SPELLOUT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Spellout rule-based format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.ordinal">
<term>
<constant>NumberFormatter::ORDINAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Ordinal rule-based format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.duration">
<term>
<constant>NumberFormatter::DURATION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Duration rule-based format</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pattern-rulebased">
<term>
<constant>NumberFormatter::PATTERN_RULEBASED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rule-based format defined by pattern</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.currency-accounting">
<term>
<constant>NumberFormatter::CURRENCY_ACCOUNTING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Currency format for accounting, e.g., <literal>($3.00)</literal> for negative currency amount
instead of <literal>-$3.00</literal>. Available as of PHP 7.4.1 and ICU 53.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.default-style">
<term>
<constant>NumberFormatter::DEFAULT_STYLE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Default format for the locale</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.ignore">
<term>
<constant>NumberFormatter::IGNORE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Alias for PATTERN_DECIMAL</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section xml:id="intl.numberformatter-constants.types">
<para>
These constants define how the numbers are parsed or formatted. They should
be used as arguments to <function>numfmt_format</function>
and <function>numfmt_parse</function>.
<variablelist>
<varlistentry xml:id="numberformatter.constants.type-default">
<term>
<constant>NumberFormatter::TYPE_DEFAULT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Derive the type from variable type</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.type-int32">
<term>
<constant>NumberFormatter::TYPE_INT32</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Format/parse as 32-bit integer</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.type-int64">
<term>
<constant>NumberFormatter::TYPE_INT64</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Format/parse as 64-bit integer</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.type-double">
<term>
<constant>NumberFormatter::TYPE_DOUBLE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Format/parse as floating point value</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.type-currency">
<term>
<constant>NumberFormatter::TYPE_CURRENCY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Format/parse as currency value</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section xml:id="intl.numberformatter-constants.unumberformatattribute">
<para>
Number format attribute used by
<function>numfmt_get_attribute</function>
and
<function>numfmt_set_attribute</function>.
<variablelist>
<varlistentry xml:id="numberformatter.constants.parse-int-only">
<term>
<constant>NumberFormatter::PARSE_INT_ONLY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Parse integers only.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.grouping-used">
<term>
<constant>NumberFormatter::GROUPING_USED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Use grouping separator.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.decimal-always-shown">
<term>
<constant>NumberFormatter::DECIMAL_ALWAYS_SHOWN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Always show decimal point.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.max-integer-digits">
<term>
<constant>NumberFormatter::MAX_INTEGER_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Maximum integer digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.min-integer-digits">
<term>
<constant>NumberFormatter::MIN_INTEGER_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Minimum integer digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.integer-digits">
<term>
<constant>NumberFormatter::INTEGER_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Integer digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.max-fraction-digits">
<term>
<constant>NumberFormatter::MAX_FRACTION_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Maximum fraction digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.min-fraction-digits">
<term>
<constant>NumberFormatter::MIN_FRACTION_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Minimum fraction digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.fraction-digits">
<term>
<constant>NumberFormatter::FRACTION_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Fraction digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.multiplier">
<term>
<constant>NumberFormatter::MULTIPLIER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Multiplier.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.grouping-size">
<term>
<constant>NumberFormatter::GROUPING_SIZE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Grouping size.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.rounding-mode">
<term>
<constant>NumberFormatter::ROUNDING_MODE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding Mode.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.rounding-increment">
<term>
<constant>NumberFormatter::ROUNDING_INCREMENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding increment.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.format-width">
<term>
<constant>NumberFormatter::FORMAT_WIDTH</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The width to which the output of format() is padded.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.padding-position">
<term>
<constant>NumberFormatter::PADDING_POSITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The position at which padding will take place. See pad position
constants for possible argument values.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.secondary-grouping-size">
<term>
<constant>NumberFormatter::SECONDARY_GROUPING_SIZE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Secondary grouping size.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.significant-digits-used">
<term>
<constant>NumberFormatter::SIGNIFICANT_DIGITS_USED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Use significant digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.min-significant-digits">
<term>
<constant>NumberFormatter::MIN_SIGNIFICANT_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Minimum significant digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.max-significant-digits">
<term>
<constant>NumberFormatter::MAX_SIGNIFICANT_DIGITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Maximum significant digits.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.lenient-parse">
<term>
<constant>NumberFormatter::LENIENT_PARSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Lenient parse mode used by rule-based formats.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section
xml:id="intl.numberformatter-constants.unumberformattextattribute">
<para>
Number format text attribute used by
<function>numfmt_get_text_attribute</function> and
<function>numfmt_set_text_attribute</function>.
<variablelist>
<varlistentry xml:id="numberformatter.constants.positive-prefix">
<term>
<constant>NumberFormatter::POSITIVE_PREFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Positive prefix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.positive-suffix">
<term>
<constant>NumberFormatter::POSITIVE_SUFFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Positive suffix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.negative-prefix">
<term>
<constant>NumberFormatter::NEGATIVE_PREFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Negative prefix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.negative-suffix">
<term>
<constant>NumberFormatter::NEGATIVE_SUFFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Negative suffix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.padding-character">
<term>
<constant>NumberFormatter::PADDING_CHARACTER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The character used to pad to the format width.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.currency-code">
<term>
<constant>NumberFormatter::CURRENCY_CODE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The ISO currency code.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.default-ruleset">
<term>
<constant>NumberFormatter::DEFAULT_RULESET</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The default rule set. This is only available with rule-based
formatters.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.public-rulesets">
<term>
<constant>NumberFormatter::PUBLIC_RULESETS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
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).
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section xml:id="intl.numberformatter-constants.unumberformatsymbol">
<para>
Number format symbols used by <function>numfmt_get_symbol</function>
and <function>numfmt_set_symbol</function>.
<variablelist>
<varlistentry xml:id="numberformatter.constants.decimal-separator-symbol">
<term>
<constant>NumberFormatter::DECIMAL_SEPARATOR_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The decimal separator.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.grouping-separator-symbol">
<term>
<constant>NumberFormatter::GROUPING_SEPARATOR_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The grouping separator.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pattern-separator-symbol">
<term>
<constant>NumberFormatter::PATTERN_SEPARATOR_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The pattern separator.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.percent-symbol">
<term>
<constant>NumberFormatter::PERCENT_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The percent sign.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.zero-digit-symbol">
<term>
<constant>NumberFormatter::ZERO_DIGIT_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Zero.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.digit-symbol">
<term>
<constant>NumberFormatter::DIGIT_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Character representing a digit in the pattern.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.minus-sign-symbol">
<term>
<constant>NumberFormatter::MINUS_SIGN_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The minus sign.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.plus-sign-symbol">
<term>
<constant>NumberFormatter::PLUS_SIGN_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The plus sign.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.currency-symbol">
<term>
<constant>NumberFormatter::CURRENCY_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The currency symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.intl-currency-symbol">
<term>
<constant>NumberFormatter::INTL_CURRENCY_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The international currency symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.monetary-separator-symbol">
<term>
<constant>NumberFormatter::MONETARY_SEPARATOR_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The monetary separator.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.exponential-symbol">
<term>
<constant>NumberFormatter::EXPONENTIAL_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The exponential symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.permill-symbol">
<term>
<constant>NumberFormatter::PERMILL_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Per mill symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pad-escape-symbol">
<term>
<constant>NumberFormatter::PAD_ESCAPE_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Escape padding character.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.infinity-symbol">
<term>
<constant>NumberFormatter::INFINITY_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Infinity symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.nan-symbol">
<term>
<constant>NumberFormatter::NAN_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Not-a-number symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.significant-digit-symbol">
<term>
<constant>NumberFormatter::SIGNIFICANT_DIGIT_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Significant digit symbol.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.monetary-grouping-separator-symbol">
<term>
<constant>NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>The monetary grouping separator.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section xml:id="intl.numberformatter-constants.unumberformatroundingmode">
<para>
Rounding mode values used by <function>numfmt_get_attribute</function>
and <function>numfmt_set_attribute</function> with
<constant>NumberFormatter::ROUNDING_MODE</constant> attribute.
<variablelist>
<varlistentry xml:id="numberformatter.constants.round-ceiling">
<term>
<constant>NumberFormatter::ROUND_CEILING</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding mode to round towards positive infinity.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-down">
<term>
<constant>NumberFormatter::ROUND_DOWN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding mode to round towards zero.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-floor">
<term>
<constant>NumberFormatter::ROUND_FLOOR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding mode to round towards negative infinity.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-halfdown">
<term>
<constant>NumberFormatter::ROUND_HALFDOWN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Rounding mode to round towards "nearest neighbor" unless both neighbors
are equidistant, in which case round down.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-halfeven">
<term>
<constant>NumberFormatter::ROUND_HALFEVEN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Rounding mode to round towards the "nearest neighbor" unless both
neighbors are equidistant, in which case, round towards the even
neighbor.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-halfup">
<term>
<constant>NumberFormatter::ROUND_HALFUP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Rounding mode to round towards "nearest neighbor" unless both neighbors
are equidistant, in which case round up.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.round-up">
<term>
<constant>NumberFormatter::ROUND_UP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Rounding mode to round away from zero.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section xml:id="intl.numberformatter-constants.unumberformatpadposition">
<para>
Pad position values used by <function>numfmt_get_attribute</function>
and <function>numfmt_set_attribute</function> with
<constant>NumberFormatter::PADDING_POSITION</constant> attribute.
<variablelist>
<varlistentry xml:id="numberformatter.constants.pad-after-prefix">
<term>
<constant>NumberFormatter::PAD_AFTER_PREFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Pad characters inserted after the prefix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pad-after-suffix">
<term>
<constant>NumberFormatter::PAD_AFTER_SUFFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Pad characters inserted after the suffix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pad-before-prefix">
<term>
<constant>NumberFormatter::PAD_BEFORE_PREFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Pad characters inserted before the prefix.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="numberformatter.constants.pad-before-suffix">
<term>
<constant>NumberFormatter::PAD_BEFORE_SUFFIX</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>Pad characters inserted before the suffix.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->