eonx-com / currencies
兼容 ISO 4217 的货币处理库
Requires
- php: >=7.1
Requires (Dev)
- eonx-com/standards: ^0.2
- phpmd/phpmd: ^2.6
- phpstan/phpstan: ^0.9
- phpunit/phpunit: ^7.0
- roave/security-advisories: dev-master
- sebastian/phpcpd: ^4.0
- squizlabs/php_codesniffer: 3.*
Replaces
This package is auto-updated.
Last update: 2021-12-09 02:31:04 UTC
README
此库允许通过 ISO4217 码或数字标识符查找货币,并根据不同地区格式化显示。
此库包含三个主要部分:货币、地区和翻译器。
货币
货币是由以下属性组成的简单文件
属性 | 描述 |
---|---|
小数单位 | 货币使用的小数位数,例如澳大利亚元为2位 |
名称 | 货币名称,例如澳大利亚元 |
数字码 | ISO4217数字码,例如澳大利亚元的036 |
符号 | UTF-8货币符号,例如$ |
货币类名是PSR-2格式的ISO4217字母码,例如澳大利亚元的代码为Aud
。
查找货币
您可以使用 ISO4217
类查找货币。此类提供了两种方法
方法 | 描述 |
---|---|
find($code): CurrencyInterface |
通过字母*或数字码查找货币 |
getSupportedAlphaCodes(): array |
获取支持的字母码列表 |
* 字母码不区分大小写
注意:目前并非所有货币都受支持,将会尽快添加更多货币,您可以打开一个拉取请求添加所需的货币。
与货币一起工作
如果成功找到货币,您将收到一个带有以下方法的货币对象
方法 | 描述 |
---|---|
getAlphaCode(): string |
获取货币的字母码 |
getMinorUnit(): int |
获取货币使用的小数位数 |
getName(): string |
获取货币的全称 |
getNumericCode(): string |
获取货币的ISO4217数字码 |
getCurrencySymbol(): string |
获取货币的UTF-8符号 |
地区
地区也是由以下属性组成的简单文件
属性 | 描述 |
---|---|
标识符 | 地区的IETF语言标签,例如澳大利亚英语为en-AU |
货币格式 | 使用符号替换来格式化货币的方法,例如澳大利亚英语为'-¤ #' |
小数分隔符 | 在数字显示中代表小数的方法,例如澳大利亚英语为点 |
负号 | 此地区使用的负号,例如澳大利亚英语为连字符 |
数字格式 | 使用符号替换来格式化数字值的方法,例如澳大利亚英语为'-#' |
千位分隔符 | 用于将千位组合在一起的分隔符,例如澳大利亚英语为逗号 |
为什么不是php-intl?
此代码似乎重复了php-intl通过NumberFormatter类提供的功能,但是此扩展在不同操作系统和区域设置上的工作方式不同,导致格式化的数字和货币不一致。《symfony/intl》包只支持en-US,如果已安装则回退到php-intl
,这也会引起相同的问题。
此库在格式化数字或货币以供显示时,独立于php-intl
在所有操作系统上提供一致性。
查找区域设置
您可以使用Translator
类查找货币。此类提供两种方法
方法 | 描述 |
---|---|
find($code): LocaleInterface |
根据IETF语言代码查找区域设置* |
getSupportedLocales(): 数组 |
获取支持的IETF语言代码列表 |
* IETF不区分大小写且忽略特殊字符:en-au、en_AU、enAu和en((au都将正确解析
注意:目前并非所有区域设置都受支持,将尽快添加更多区域设置,您还可以通过打开一个拉取请求添加您需要的区域设置。
与区域设置一起工作
如果成功找到区域设置,您将收到一个包含以下方法的区域设置对象
方法 | 描述 |
---|---|
getIdentifier(): 字符串 |
获取当前区域设置的IETF语言代码 |
格式化
此类的实际用途是基于区域设置格式化数字和货币,这是通过Formatter
类完成的,该类提供四种方法
方法 | 描述 |
---|---|
currency(string $locale): 字符串 |
根据IETF区域设置语言代码获取使用货币显示的精度和符号格式化的金额 |
decimal(): 字符串 |
使用货币的精度格式化金额,例如,澳大利亚元有两位小数 |
numeric(string $locale): 字符串 |
根据IETF区域设置语言代码使用货币的精度格式化金额 |
实例化格式化器时,必须向构造函数传递一个金额和ISO4217 alpha或numeric代码。
/**
* Format a currency based on locale
*/
// Create formatter based on bitcoin with negative value
$formatter = new \EoneoPay\Currencies\Formatter('-1.051', 'xbt');
// Australia
echo $formatter->currency('en-AU'); // -฿1,601.05100000
// China
echo $formatter->currency('zh-CN'); // -฿ 1601.05100000
// France
echo $formatter->currency('fr-FR'); // -1 601,05100000 ฿
// Netherlands
echo $formatter->currency('nl-NL'); // ฿ -1.601,05100000
// Oman
echo $formatter->currency('ar-OM'); // ฿ -١٬٦٠١٫٠٥١٠٠٠٠٠
/**
* Format a number based on locale
*/
// Create formatter based on bitcoin with positive value
$formatter = new \EoneoPay\Currencies\Formatter('1.051', 'xbt');
// Australia
echo $formatter->numeric('en-AU'); // 1,601.05100000
// China
echo $formatter->numeric('zh-CN'); // 1601.05100000
// France
echo $formatter->numeric('fr-FR'); // 1 601,05100000
// Netherlands
echo $formatter->numeric('nl-NL'); // 1.601,05100000
// Oman
echo $formatter->numeric('ar-OM'); // ١٬٦٠١٫٠٥١٠٠٠٠٠
注意:由于输出为RTL格式,阿拉伯语可能无法正确显示。