Currency
in package
Object containing currency information.
Tags
Table of Contents
Constants
- AED = "AED"
- AFN = "AFN"
- ALL = "ALL"
- AMD = "AMD"
- ANG = "ANG"
- AOA = "AOA"
- ARS = "ARS"
- AUD = "AUD"
- AWG = "AWG"
- AZN = "AZN"
- BAM = "BAM"
- BBD = "BBD"
- BCH = "BCH"
- BDT = "BDT"
- BGN = "BGN"
- BHD = "BHD"
- BIF = "BIF"
- BMD = "BMD"
- BND = "BND"
- BOB = "BOB"
- BOV = "BOV"
- BRL = "BRL"
- BSD = "BSD"
- BTC = "BTC"
- BTN = "BTN"
- BUSD = "BUSD"
- BWP = "BWP"
- BYR = "BYR"
- BZD = "BZD"
- CAD = "CAD"
- CDF = "CDF"
- CHE = "CHE"
- CHF = "CHF"
- CHW = "CHW"
- CLF = "CLF"
- CLP = "CLP"
- CNY = "CNY"
- COP = "COP"
- COU = "COU"
- CRC = "CRC"
- CUC = "CUC"
- CUP = "CUP"
- CVE = "CVE"
- CZK = "CZK"
- DJF = "DJF"
- DKK = "DKK"
- DOGE = "DOGE"
- DOP = "DOP"
- DZD = "DZD"
- EGP = "EGP"
- ERN = "ERN"
- ETB = "ETB"
- ETH = "ETH"
- EUR = "EUR"
- FJD = "FJD"
- FKP = "FKP"
- GBP = "GBP"
- GEL = "GEL"
- GHS = "GHS"
- GIP = "GIP"
- GMD = "GMD"
- GNF = "GNF"
- GTQ = "GTQ"
- GUSD = "GUSD"
- GYD = "GYD"
- HKD = "HKD"
- HNL = "HNL"
- HRK = "HRK"
- HTG = "HTG"
- HUF = "HUF"
- IDR = "IDR"
- ILS = "ILS"
- INR = "INR"
- IQD = "IQD"
- IRR = "IRR"
- ISK = "ISK"
- JMD = "JMD"
- JOD = "JOD"
- JPY = "JPY"
- KES = "KES"
- KGS = "KGS"
- KHR = "KHR"
- KMF = "KMF"
- KPW = "KPW"
- KRW = "KRW"
- KWD = "KWD"
- KYD = "KYD"
- KZT = "KZT"
- LAK = "LAK"
- LBP = "LBP"
- LKR = "LKR"
- LRD = "LRD"
- LSL = "LSL"
- LTC = "LTC"
- LYD = "LYD"
- MAD = "MAD"
- MDL = "MDL"
- MGA = "MGA"
- MKD = "MKD"
- MMK = "MMK"
- MNT = "MNT"
- MOP = "MOP"
- MRU = "MRU"
- MUR = "MUR"
- MVR = "MVR"
- MWK = "MWK"
- MXN = "MXN"
- MXV = "MXV"
- MYR = "MYR"
- MZN = "MZN"
- NAD = "NAD"
- NGN = "NGN"
- NIO = "NIO"
- NOK = "NOK"
- NPR = "NPR"
- NZD = "NZD"
- OMR = "OMR"
- PAB = "PAB"
- PAX = "PAX"
- PEN = "PEN"
- PGK = "PGK"
- PHP = "PHP"
- PKR = "PKR"
- PLN = "PLN"
- PYG = "PYG"
- QAR = "QAR"
- RON = "RON"
- RSD = "RSD"
- RUB = "RUB"
- RWF = "RWF"
- SAR = "SAR"
- SBD = "SBD"
- SCR = "SCR"
- SDG = "SDG"
- SEK = "SEK"
- SGD = "SGD"
- SHIB = "SHIB"
- SHP = "SHP"
- SLL = "SLL"
- SOS = "SOS"
- SRD = "SRD"
- SSP = "SSP"
- STN = "STN"
- SVC = "SVC"
- SYP = "SYP"
- SZL = "SZL"
- THB = "THB"
- TJS = "TJS"
- TMT = "TMT"
- TND = "TND"
- TOP = "TOP"
- TRY = "TRY"
- TTD = "TTD"
- TWD = "TWD"
- TZS = "TZS"
- UAH = "UAH"
- UGX = "UGX"
- USD = "USD"
- USDC = "USDC"
- USN = "USN"
- UYI = "UYI"
- UYU = "UYU"
- UZS = "UZS"
- VEF = "VEF"
- VND = "VND"
- VUV = "VUV"
- WST = "WST"
- XAF = "XAF"
- XCD = "XCD"
- XDR = "XDR"
- XOF = "XOF"
- XPF = "XPF"
- XRP = "XRP"
- XSU = "XSU"
- XUA = "XUA"
- YER = "YER"
- ZAR = "ZAR"
- ZMW = "ZMW"
- ZWL = "ZWL"
Properties
- $alts : string|null
- $chain : string|null
- $code : string|null
- $contractAddress : string|null
- $currentlySettled : bool|null
- $decimals : int|null
- $displayCode : string|null
- $maxSupply : string|null
- $minimum : string|null
- $name : string|null
- $plural : string|null
- $precision : int|null
- $sanctioned : bool|null
- $symbol : string|null
- $trancheDecimals : int|null
Methods
- __construct() : mixed
- getAlts() : string|null
- Gets alternative currency name(s)
- getChain() : string|null
- getCode() : string|null
- Get ISO 4217 3-character currency code
- getContractAddress() : string|null
- getCurrentlySettled() : bool|null
- Gets currently settled value
- getDecimals() : int|null
- Gets decimal precision
- getDisplayCode() : string|null
- getMaxSupply() : string|null
- getMinimum() : string|null
- Gets minimum supported value when creating an invoice, bill or payout for instance
- getName() : string|null
- Gets currency name
- getPlural() : string|null
- Gets English plural form
- getPrecision() : int|null
- Number of decimal places
- getSanctioned() : bool|null
- Gets if the currency is linked to a sanctionned country
- getSymbol() : string|null
- Display symbol
- getTrancheDecimals() : int|null
- isValid() : bool
- Currency validation
- setAlts() : void
- Sets alternative currency name(s)
- setChain() : void
- setCode() : void
- Sets ISO 4217 3-character currency code
- setContractAddress() : void
- setCurrentlySettled() : void
- Sets currently settled value
- setDecimals() : void
- Sets decimal precision
- setDisplayCode() : void
- setMaxSupply() : void
- setMinimum() : void
- Sets minimum supported value when creating an invoice, bill or payout for instance
- setName() : void
- Sets currency name
- setPlural() : void
- Sets English plural form
- setPrecision() : void
- Sets number of decimal places
- setSanctioned() : void
- Sets if the currency is linked to a sanctionned country
- setSymbol() : void
- Sets symbol
- setTrancheDecimals() : void
- toArray() : array<string|int, mixed>
- Gets currency data as array
Constants
AED
public
mixed
AED
= "AED"
AFN
public
mixed
AFN
= "AFN"
ALL
public
mixed
ALL
= "ALL"
AMD
public
mixed
AMD
= "AMD"
ANG
public
mixed
ANG
= "ANG"
AOA
public
mixed
AOA
= "AOA"
ARS
public
mixed
ARS
= "ARS"
AUD
public
mixed
AUD
= "AUD"
AWG
public
mixed
AWG
= "AWG"
AZN
public
mixed
AZN
= "AZN"
BAM
public
mixed
BAM
= "BAM"
BBD
public
mixed
BBD
= "BBD"
BCH
public
mixed
BCH
= "BCH"
BDT
public
mixed
BDT
= "BDT"
BGN
public
mixed
BGN
= "BGN"
BHD
public
mixed
BHD
= "BHD"
BIF
public
mixed
BIF
= "BIF"
BMD
public
mixed
BMD
= "BMD"
BND
public
mixed
BND
= "BND"
BOB
public
mixed
BOB
= "BOB"
BOV
public
mixed
BOV
= "BOV"
BRL
public
mixed
BRL
= "BRL"
BSD
public
mixed
BSD
= "BSD"
BTC
public
mixed
BTC
= "BTC"
BTN
public
mixed
BTN
= "BTN"
BUSD
public
mixed
BUSD
= "BUSD"
BWP
public
mixed
BWP
= "BWP"
BYR
public
mixed
BYR
= "BYR"
BZD
public
mixed
BZD
= "BZD"
CAD
public
mixed
CAD
= "CAD"
CDF
public
mixed
CDF
= "CDF"
CHE
public
mixed
CHE
= "CHE"
CHF
public
mixed
CHF
= "CHF"
CHW
public
mixed
CHW
= "CHW"
CLF
public
mixed
CLF
= "CLF"
CLP
public
mixed
CLP
= "CLP"
CNY
public
mixed
CNY
= "CNY"
COP
public
mixed
COP
= "COP"
COU
public
mixed
COU
= "COU"
CRC
public
mixed
CRC
= "CRC"
CUC
public
mixed
CUC
= "CUC"
CUP
public
mixed
CUP
= "CUP"
CVE
public
mixed
CVE
= "CVE"
CZK
public
mixed
CZK
= "CZK"
DJF
public
mixed
DJF
= "DJF"
DKK
public
mixed
DKK
= "DKK"
DOGE
public
mixed
DOGE
= "DOGE"
DOP
public
mixed
DOP
= "DOP"
DZD
public
mixed
DZD
= "DZD"
EGP
public
mixed
EGP
= "EGP"
ERN
public
mixed
ERN
= "ERN"
ETB
public
mixed
ETB
= "ETB"
ETH
public
mixed
ETH
= "ETH"
EUR
public
mixed
EUR
= "EUR"
FJD
public
mixed
FJD
= "FJD"
FKP
public
mixed
FKP
= "FKP"
GBP
public
mixed
GBP
= "GBP"
GEL
public
mixed
GEL
= "GEL"
GHS
public
mixed
GHS
= "GHS"
GIP
public
mixed
GIP
= "GIP"
GMD
public
mixed
GMD
= "GMD"
GNF
public
mixed
GNF
= "GNF"
GTQ
public
mixed
GTQ
= "GTQ"
GUSD
public
mixed
GUSD
= "GUSD"
GYD
public
mixed
GYD
= "GYD"
HKD
public
mixed
HKD
= "HKD"
HNL
public
mixed
HNL
= "HNL"
HRK
public
mixed
HRK
= "HRK"
HTG
public
mixed
HTG
= "HTG"
HUF
public
mixed
HUF
= "HUF"
IDR
public
mixed
IDR
= "IDR"
ILS
public
mixed
ILS
= "ILS"
INR
public
mixed
INR
= "INR"
IQD
public
mixed
IQD
= "IQD"
IRR
public
mixed
IRR
= "IRR"
ISK
public
mixed
ISK
= "ISK"
JMD
public
mixed
JMD
= "JMD"
JOD
public
mixed
JOD
= "JOD"
JPY
public
mixed
JPY
= "JPY"
KES
public
mixed
KES
= "KES"
KGS
public
mixed
KGS
= "KGS"
KHR
public
mixed
KHR
= "KHR"
KMF
public
mixed
KMF
= "KMF"
KPW
public
mixed
KPW
= "KPW"
KRW
public
mixed
KRW
= "KRW"
KWD
public
mixed
KWD
= "KWD"
KYD
public
mixed
KYD
= "KYD"
KZT
public
mixed
KZT
= "KZT"
LAK
public
mixed
LAK
= "LAK"
LBP
public
mixed
LBP
= "LBP"
LKR
public
mixed
LKR
= "LKR"
LRD
public
mixed
LRD
= "LRD"
LSL
public
mixed
LSL
= "LSL"
LTC
public
mixed
LTC
= "LTC"
LYD
public
mixed
LYD
= "LYD"
MAD
public
mixed
MAD
= "MAD"
MDL
public
mixed
MDL
= "MDL"
MGA
public
mixed
MGA
= "MGA"
MKD
public
mixed
MKD
= "MKD"
MMK
public
mixed
MMK
= "MMK"
MNT
public
mixed
MNT
= "MNT"
MOP
public
mixed
MOP
= "MOP"
MRU
public
mixed
MRU
= "MRU"
MUR
public
mixed
MUR
= "MUR"
MVR
public
mixed
MVR
= "MVR"
MWK
public
mixed
MWK
= "MWK"
MXN
public
mixed
MXN
= "MXN"
MXV
public
mixed
MXV
= "MXV"
MYR
public
mixed
MYR
= "MYR"
MZN
public
mixed
MZN
= "MZN"
NAD
public
mixed
NAD
= "NAD"
NGN
public
mixed
NGN
= "NGN"
NIO
public
mixed
NIO
= "NIO"
NOK
public
mixed
NOK
= "NOK"
NPR
public
mixed
NPR
= "NPR"
NZD
public
mixed
NZD
= "NZD"
OMR
public
mixed
OMR
= "OMR"
PAB
public
mixed
PAB
= "PAB"
PAX
public
mixed
PAX
= "PAX"
PEN
public
mixed
PEN
= "PEN"
PGK
public
mixed
PGK
= "PGK"
PHP
public
mixed
PHP
= "PHP"
PKR
public
mixed
PKR
= "PKR"
PLN
public
mixed
PLN
= "PLN"
PYG
public
mixed
PYG
= "PYG"
QAR
public
mixed
QAR
= "QAR"
RON
public
mixed
RON
= "RON"
RSD
public
mixed
RSD
= "RSD"
RUB
public
mixed
RUB
= "RUB"
RWF
public
mixed
RWF
= "RWF"
SAR
public
mixed
SAR
= "SAR"
SBD
public
mixed
SBD
= "SBD"
SCR
public
mixed
SCR
= "SCR"
SDG
public
mixed
SDG
= "SDG"
SEK
public
mixed
SEK
= "SEK"
SGD
public
mixed
SGD
= "SGD"
SHIB
public
mixed
SHIB
= "SHIB"
SHP
public
mixed
SHP
= "SHP"
SLL
public
mixed
SLL
= "SLL"
SOS
public
mixed
SOS
= "SOS"
SRD
public
mixed
SRD
= "SRD"
SSP
public
mixed
SSP
= "SSP"
STN
public
mixed
STN
= "STN"
SVC
public
mixed
SVC
= "SVC"
SYP
public
mixed
SYP
= "SYP"
SZL
public
mixed
SZL
= "SZL"
THB
public
mixed
THB
= "THB"
TJS
public
mixed
TJS
= "TJS"
TMT
public
mixed
TMT
= "TMT"
TND
public
mixed
TND
= "TND"
TOP
public
mixed
TOP
= "TOP"
TRY
public
mixed
TRY
= "TRY"
TTD
public
mixed
TTD
= "TTD"
TWD
public
mixed
TWD
= "TWD"
TZS
public
mixed
TZS
= "TZS"
UAH
public
mixed
UAH
= "UAH"
UGX
public
mixed
UGX
= "UGX"
USD
public
mixed
USD
= "USD"
USDC
public
mixed
USDC
= "USDC"
USN
public
mixed
USN
= "USN"
UYI
public
mixed
UYI
= "UYI"
UYU
public
mixed
UYU
= "UYU"
UZS
public
mixed
UZS
= "UZS"
VEF
public
mixed
VEF
= "VEF"
VND
public
mixed
VND
= "VND"
VUV
public
mixed
VUV
= "VUV"
WST
public
mixed
WST
= "WST"
XAF
public
mixed
XAF
= "XAF"
XCD
public
mixed
XCD
= "XCD"
XDR
public
mixed
XDR
= "XDR"
XOF
public
mixed
XOF
= "XOF"
XPF
public
mixed
XPF
= "XPF"
XRP
public
mixed
XRP
= "XRP"
XSU
public
mixed
XSU
= "XSU"
XUA
public
mixed
XUA
= "XUA"
YER
public
mixed
YER
= "YER"
ZAR
public
mixed
ZAR
= "ZAR"
ZMW
public
mixed
ZMW
= "ZMW"
ZWL
public
mixed
ZWL
= "ZWL"
Properties
$alts
protected
string|null
$alts
= null
$chain
protected
string|null
$chain
= null
$code
protected
string|null
$code
= null
$contractAddress
protected
string|null
$contractAddress
= null
$currentlySettled
protected
bool|null
$currentlySettled
= null
$decimals
protected
int|null
$decimals
= null
$displayCode
protected
string|null
$displayCode
= null
$maxSupply
protected
string|null
$maxSupply
= null
$minimum
protected
string|null
$minimum
= null
$name
protected
string|null
$name
= null
$plural
protected
string|null
$plural
= null
$precision
protected
int|null
$precision
= null
$sanctioned
protected
bool|null
$sanctioned
= null
$symbol
protected
string|null
$symbol
= null
$trancheDecimals
protected
int|null
$trancheDecimals
= null
Methods
__construct()
public
__construct() : mixed
getAlts()
Gets alternative currency name(s)
public
getAlts() : string|null
Return values
string|null —the alts
getChain()
public
getChain() : string|null
Return values
string|nullgetCode()
Get ISO 4217 3-character currency code
public
getCode() : string|null
Return values
string|null —the code
getContractAddress()
public
getContractAddress() : string|null
Return values
string|nullgetCurrentlySettled()
Gets currently settled value
public
getCurrentlySettled() : bool|null
Return values
bool|nullgetDecimals()
Gets decimal precision
public
getDecimals() : int|null
Return values
int|null —decimals
getDisplayCode()
public
getDisplayCode() : string|null
Return values
string|nullgetMaxSupply()
public
getMaxSupply() : string|null
Return values
string|nullgetMinimum()
Gets minimum supported value when creating an invoice, bill or payout for instance
public
getMinimum() : string|null
Return values
string|null —the minimum
getName()
Gets currency name
public
getName() : string|null
Return values
string|null —the name
getPlural()
Gets English plural form
public
getPlural() : string|null
Return values
string|null —the plural form
getPrecision()
Number of decimal places
public
getPrecision() : int|null
Return values
int|null —the precision
getSanctioned()
Gets if the currency is linked to a sanctionned country
public
getSanctioned() : bool|null
Return values
bool|null —the sanctioned
getSymbol()
Display symbol
public
getSymbol() : string|null
Return values
string|null —the symbol
getTrancheDecimals()
public
getTrancheDecimals() : int|null
Return values
int|nullisValid()
Currency validation
public
static isValid(string $value) : bool
Parameters
- $value : string
-
the currency value
Return values
boolsetAlts()
Sets alternative currency name(s)
public
setAlts(string $alts) : void
Parameters
- $alts : string
-
the alts
setChain()
public
setChain(string|null $chain) : void
Parameters
- $chain : string|null
setCode()
Sets ISO 4217 3-character currency code
public
setCode(string $code) : void
Parameters
- $code : string
-
the code
setContractAddress()
public
setContractAddress(string|null $contractAddress) : void
Parameters
- $contractAddress : string|null
setCurrentlySettled()
Sets currently settled value
public
setCurrentlySettled(bool $currentlySettled) : void
Parameters
- $currentlySettled : bool
setDecimals()
Sets decimal precision
public
setDecimals(int|null $decimals) : void
Parameters
- $decimals : int|null
-
decimals
setDisplayCode()
public
setDisplayCode(string|null $displayCode) : void
Parameters
- $displayCode : string|null
setMaxSupply()
public
setMaxSupply(string|null $maxSupply) : void
Parameters
- $maxSupply : string|null
setMinimum()
Sets minimum supported value when creating an invoice, bill or payout for instance
public
setMinimum(string $minimum) : void
Parameters
- $minimum : string
-
the minimum
setName()
Sets currency name
public
setName(string $name) : void
Parameters
- $name : string
-
the name
setPlural()
Sets English plural form
public
setPlural(string $plural) : void
Parameters
- $plural : string
-
the plural form
setPrecision()
Sets number of decimal places
public
setPrecision(int $precision) : void
Parameters
- $precision : int
-
the precision
setSanctioned()
Sets if the currency is linked to a sanctionned country
public
setSanctioned(bool $sanctioned) : void
Parameters
- $sanctioned : bool
-
the sanctioned
setSymbol()
Sets symbol
public
setSymbol([string|null $symbol = null ]) : void
Parameters
- $symbol : string|null = null
setTrancheDecimals()
public
setTrancheDecimals(int|null $trancheDecimals) : void
Parameters
- $trancheDecimals : int|null
toArray()
Gets currency data as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —currency data as array