Reference documentation and code samples for the Google API Common Protos Client class Money.
Represents an amount of money with its currency type.
Generated from protobuf message google.type.Money
Namespace
Google \ TypeMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ currency_code |
string
The three-letter currency code defined in ISO 4217. |
↳ units |
int|string
The whole units of the amount. For example if |
↳ nanos |
int
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If |
getCurrencyCode
The three-letter currency code defined in ISO 4217.
Returns | |
---|---|
Type | Description |
string |
setCurrencyCode
The three-letter currency code defined in ISO 4217.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUnits
The whole units of the amount.
For example if currencyCode
is "USD"
, then 1 unit is one US dollar.
Returns | |
---|---|
Type | Description |
int|string |
setUnits
The whole units of the amount.
For example if currencyCode
is "USD"
, then 1 unit is one US dollar.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getNanos
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units
is positive, nanos
must be positive or zero.
If units
is zero, nanos
can be positive, zero, or negative.
If units
is negative, nanos
must be negative or zero.
For example $-1.75 is represented as units
=-1 and nanos
=-750,000,000.
Returns | |
---|---|
Type | Description |
int |
setNanos
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units
is positive, nanos
must be positive or zero.
If units
is zero, nanos
can be positive, zero, or negative.
If units
is negative, nanos
must be negative or zero.
For example $-1.75 is represented as units
=-1 and nanos
=-750,000,000.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |