Class OpenExchangeRates

Open Exchange Rates Currency Exchange Rate Processor

ExchangeRate

OpenExchangeRates

Package: blesta\components\exchange\rates\open\exchange\rates
Copyright: Copyright (c) 2017, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/exchange_rates/open_exchange_rates/open_exchange_rates.php

Methods summary
`public`	# `__construct( Http $Http )` Initializes the exchange rate processor Initializes the exchange rate processor Parameters `$Http` The Http component to more easily facilitate HTTP requests to fetch data
`public boolean`	# `requiresKey( )` Determines whether an API key is necessary to retrieve exchange rates via the processor Determines whether an API key is necessary to retrieve exchange rates via the processor Returns boolean True if an API key is required, or false otherwise Overrides `ExchangeRate::requiresKey()`
`public boolean\|array`	# `getRate( string $currency_from, string $currency_to, float $amount = 1.0 )` Fetches the exchange rate from currency A to currency B using the given amount Fetches the exchange rate from currency A to currency B using the given amount Parameters `$currency_from` The ISO 4217 currency code to convert from `$currency_to` The ISO 4217 currency code to convert to `$amount` The amount to convert Returns boolean\|array False on error or an array containing the exchange rate information including: rate The exchange rate for the supplied amount updated The date/time of the last update in YYYY-MM-DD HH:MM:SS format in UTC time

Methods inherited from ExchangeRate
`convertRates(), setKey()`

Properties inherited from ExchangeRate
`$key`