API Documentation
\

\RippleRestAmount

An Amount on the Ripple Protocol, used also for XRP in the ripple-rest API

Summary

Methods
Properties
Constants
__construct()
getValue()
setValue()
getCurrency()
setCurrency()
getIssuer()
setIssuer()
getCounterparty()
setCounterparty()
toArray()
toString()
fromString()
$value
$currency
$issuer
$counterparty
PATTERN_TYPE_HASH256
PATTERN_TYPE_HASH128
PATTERN_TYPE_TIMESTAMP
PATTERN_TYPE_RIPPLEADDRESS
PATTERN_TYPE_RESOURCEID
PATTERN_TYPE_FLOATSTRING
PATTERN_TYPE_URL
PATTERN_TYPE_CURRENCY
PATTERN_TYPE_UINT32
PATTERN_ISSUER
PATTERN_COUNTERPARTY
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

PATTERN_TYPE_HASH256

PATTERN_TYPE_HASH256

The hex representation of a 256-bit hash

PATTERN_TYPE_HASH128

PATTERN_TYPE_HASH128

The hex representation of a 128-bit hash

PATTERN_TYPE_TIMESTAMP

PATTERN_TYPE_TIMESTAMP

An ISO 8601 combined date and time timestamp

PATTERN_TYPE_RIPPLEADDRESS

PATTERN_TYPE_RIPPLEADDRESS

A Ripple account address

PATTERN_TYPE_RESOURCEID

PATTERN_TYPE_RESOURCEID

A client-supplied unique identifier (ideally a UUID) for this transaction used to prevent duplicate payments and help confirm the transaction's final status. All ASCII printable characters are allowed. Note that 256-bit hex strings are disallowed because of the potential confusion with transaction hashes.

PATTERN_TYPE_FLOATSTRING

PATTERN_TYPE_FLOATSTRING

A string representation of a floating point number

PATTERN_TYPE_URL

PATTERN_TYPE_URL

A standard URL

PATTERN_TYPE_CURRENCY

PATTERN_TYPE_CURRENCY

The three-character code or hex string used to denote currencies

PATTERN_TYPE_UINT32

PATTERN_TYPE_UINT32

A string representation of an unsigned 32-bit integer (0-4294967295)

PATTERN_ISSUER

PATTERN_ISSUER

Pattern Rule for field `RippleRestAmount::$issuer`

PATTERN_COUNTERPARTY

PATTERN_COUNTERPARTY

Pattern Rule for field `RippleRestAmount::$counterparty`

Properties

$value

$value : string

The quantity of the currency, denoted as a string to retain floating point precision

Type

string

$currency

$currency : string

(Currency) The currency expressed as a three-character code

Type

string

$issuer

$issuer : string

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/) The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Type

string

$counterparty

$counterparty : string

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/) The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Type

string

Methods

__construct()

__construct(array $data) : \RippleRestAmount

Create a new instance of RippleRestAmount.

Parameters

array $data

(defaults to null) PHP Array (result of json_decode($json, true))

Returns

\RippleRestAmount

getValue()

getValue() : string

The quantity of the currency, denoted as a string to retain floating point precision

Returns

string

setValue()

setValue(string $value) : null

The quantity of the currency, denoted as a string to retain floating point precision

Parameters

string $value

Returns

null

getCurrency()

getCurrency() : string

The currency expressed as a three-character code

Returns

string —

(Currency)

setCurrency()

setCurrency(string $value) : null

The currency expressed as a three-character code

Parameters

string $value

(Currency)

Returns

null

getIssuer()

getIssuer() : string

The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Returns

string —

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/)

setIssuer()

setIssuer(string $value) : null

The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Parameters

string $value

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/)

Returns

null

getCounterparty()

getCounterparty() : string

The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Returns

string —

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/)

setCounterparty()

setCounterparty(string $value) : null

The Ripple account address of the currency's issuer or gateway, or an empty string if the currency is XRP

Parameters

string $value

(/^$|^r[1-9A-HJ-NP-Za-km-z]{25,33}$/)

Returns

null

toArray()

toArray() : array

Convert this object to PHP native Array for serializing to JSON.

Returns

array

toString()

toString() : string

Converts to a string.

Returns

string

fromString()

fromString(string $s) : \RippleRestAmount

Convert a string to RippleRestAmount

Parameters

string $s

a String like "1+XRP" or "1+USD+r..."

Returns

\RippleRestAmount