aboutsummaryrefslogtreecommitdiffstats
path: root/library/intl/src/NumberFormat/NumberFormatInterface.php
blob: fa382df700260af9b2c39f6c8198e52c6184b68c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php

namespace CommerceGuys\Intl\NumberFormat;

interface NumberFormatInterface
{
    // Arabic-Indic digits.
    const NUMBERING_SYSTEM_ARABIC = 'arab';
    // Extended Arabic-Indic digits.
    const NUMBERING_SYSTEM_ARABIC_EXTENDED = 'arabext';
    // Bengali digits.
    const NUMBERING_SYSTEM_BENGALI = 'beng';
    // Devanagari digits.
    const NUMBERING_SYSTEM_DEVANAGARI = 'deva';
    // Latin digits
    const NUMBERING_SYSTEM_LATIN = 'latn';

    /**
     * Gets the locale.
     *
     * @return string
     */
    public function getLocale();

    /**
     * Sets the locale.
     *
     * @param string $locale The locale (i.e. "en_US").
     */
    public function setLocale($locale);

    /**
     * Gets the numbering system.
     *
     * The value is one of the NUMBERING_SYSTEM_ constants.
     *
     * @return string
     */
    public function getNumberingSystem();

    /**
     * Sets the numbering system.
     *
     * @param string $numberingSystem One of the NUMBERING_SYSTEM_ constants.
     */
    public function setNumberingSystem($numberingSystem);

    /**
     * Gets the decimal separator.
     *
     * @return string
     */
    public function getDecimalSeparator();

    /**
     * Sets the decimal separator.
     *
     * @var string $decimalSeparator
     */
    public function setDecimalSeparator($decimalSeparator);

    /**
     * Gets the grouping separator.
     *
     * @return string
     */
    public function getGroupingSeparator();

    /**
     * Sets the grouping separator.
     *
     * @var string $groupingSeparator
     */
    public function setGroupingSeparator($groupingSeparator);

    /**
     * Gets the plus sign.
     *
     * @return string
     */
    public function getPlusSign();

    /**
     * Sets the plus sign.
     *
     * @var string $plusSign
     */
    public function setPlusSign($plusSign);

    /**
     * Gets the minus sign.
     *
     * @return string
     */
    public function getMinusSign();

    /**
     * Sets the minus sign.
     *
     * @var string $minusSign
     */
    public function setMinusSign($minusSign);

    /**
     * Gets the percent sign.
     *
     * @return string
     */
    public function getPercentSign();

    /**
     * Sets the percent sign.
     *
     * @var string $percentSign
     */
    public function setPercentSign($percentSign);

    /**
     * Gets the number pattern used to format decimal numbers.
     *
     * @return string
     *
     * @see http://cldr.unicode.org/translation/number-patterns
     */
    public function getDecimalPattern();

    /**
     * Sets the number pattern used to format decimal numbers.
     *
     * @param string $decimalPattern The decimal pattern.
     */
    public function setDecimalPattern($decimalPattern);

    /**
     * Gets the number pattern used to format percentages.
     *
     * @return string
     *
     * @see http://cldr.unicode.org/translation/number-patterns
     */
    public function getPercentPattern();

    /**
     * Sets the number pattern used to format percentages.
     *
     * @param string $percentPattern The percent pattern.
     */
    public function setPercentPattern($percentPattern);

    /**
     * Gets the number pattern used to format currency amounts.
     *
     * @return string
     *
     * @see http://cldr.unicode.org/translation/number-patterns
     */
    public function getCurrencyPattern();

    /**
     * Sets the number pattern used to format currency amounts.
     *
     * @param string $currencyPattern The currency pattern.
     */
    public function setCurrencyPattern($currencyPattern);

    /**
     * Gets the number pattern used to format accounting currency amounts.
     *
     * Most commonly used when formatting amounts on invoices.
     *
     * @return string
     *
     * @see http://cldr.unicode.org/translation/number-patterns
     */
    public function getAccountingCurrencyPattern();

    /**
     * Sets the number pattern used to format accounting currency amounts.
     *
     * Most commonly used when formatting amounts on invoices.
     *
     * @param string $accountingCurrencyPattern The accounting currency pattern.
     */
    public function setAccountingCurrencyPattern($accountingCurrencyPattern);
}