interface Openclerk\Currencies \ MultiBalanceableCurrency

All implemented interfaces:
Currency, AddressableCurrency
All known implementing classes:
Ripple

A "MultiBalanceableCurrency" is a AddressableCurrency where we can obtain multiple balances in multiple currencies for a given account identifier.

A MultiBalanceableCurrency may also be a BalanceableCurrency if there is a single currency balance which is the prime balance for that account.


Method Summary

Name Description
getMultiBalances($id, Logger $logger) Get the account balances, in an array of (currency code => balance), of the given account. This method blocks until the balances have been obtained.

public function getMultiBalances($id, Logger $logger)

Get the account balances, in an array of (currency code => balance), of the given account. This method blocks until the balances have been obtained.

Parameters:
$logger - a logger to log info/error messages to
Returns:
an array of (currency code => balance)
Throws:
BalanceException if something happened and the balance could not be obtained