PHP Class Bitpay\Currency

See also: http://en.wikipedia.org/wiki/ISO_4217

Inheritance: implements bitpay\CurrencyInterface

Show file Open project: bitpay/php-client

Protected Properties

Property	Type	Description
$alts	array
$availableCurrencies	array
$code	string
$exchangePercentageFee	string
$name	string
$payoutEnabled	boolean
$payoutFields	array
$pluralName	string
$precision	integer
$symbol	string

Public Methods

Method	Description
__construct ( string $code = null )
getAlts ( )
getCode ( )
getExchangePctFee ( )
getName ( )
getPayoutFields ( )
getPluralName ( )
getPrecision ( )
getSymbol ( )
isPayoutEnabled ( )
setAlts ( array $alts ) : bitpay\CurrencyInterface
setCode ( string $code ) : bitpay\CurrencyInterface	This will change the $code to all uppercase
setExchangePctFee ( string $fee ) : bitpay\CurrencyInterface
setName ( string $name ) : bitpay\CurrencyInterface
setPayoutEnabled ( boolean $enabled ) : bitpay\CurrencyInterface
setPayoutFields ( array $payoutFields ) : bitpay\CurrencyInterface
setPluralName ( string $pluralName ) : bitpay\CurrencyInterface
setPrecision ( integer $precision ) : bitpay\CurrencyInterface
setSymbol ( string $symbol ) : bitpay\CurrencyInterface

Method Details

__construct() public method

public __construct ( string $code = null )
$code	string	The Currency Code to use, ie USD

getAlts() public method

public getAlts ( )

getCode() public method

public getCode ( )

getExchangePctFee() public method

public getExchangePctFee ( )

getName() public method

public getName ( )

getPayoutFields() public method

public getPayoutFields ( )

getPluralName() public method

public getPluralName ( )

getPrecision() public method

public getPrecision ( )

getSymbol() public method

public getSymbol ( )

isPayoutEnabled() public method

public isPayoutEnabled ( )

setAlts() public method

public setAlts ( array $alts ) : bitpay\CurrencyInterface
$alts	array
return	bitpay\CurrencyInterface

setCode() public method

This will change the $code to all uppercase

public setCode ( string $code ) : bitpay\CurrencyInterface
$code	string	The Currency Code to use, ie USD
return	bitpay\CurrencyInterface

setExchangePctFee() public method

public setExchangePctFee ( string $fee ) : bitpay\CurrencyInterface
$fee	string
return	bitpay\CurrencyInterface

setName() public method

public setName ( string $name ) : bitpay\CurrencyInterface
$name	string
return	bitpay\CurrencyInterface

setPayoutEnabled() public method

public setPayoutEnabled ( boolean $enabled ) : bitpay\CurrencyInterface
$enabled	boolean
return	bitpay\CurrencyInterface

setPayoutFields() public method

public setPayoutFields ( array $payoutFields ) : bitpay\CurrencyInterface
$payoutFields	array
return	bitpay\CurrencyInterface

setPluralName() public method

public setPluralName ( string $pluralName ) : bitpay\CurrencyInterface
$pluralName	string
return	bitpay\CurrencyInterface

setPrecision() public method

public setPrecision ( integer $precision ) : bitpay\CurrencyInterface
$precision	integer
return	bitpay\CurrencyInterface

setSymbol() public method

public setSymbol ( string $symbol ) : bitpay\CurrencyInterface
$symbol	string
return	bitpay\CurrencyInterface

Property Details

$alts protected property

protected array $alts
return	array

$availableCurrencies protected static property

See also: https://bitpay.com/currencies

protected static array $availableCurrencies
return	array

$code protected property

protected string $code
return	string

$exchangePercentageFee protected property

protected string $exchangePercentageFee
return	string

$name protected property

protected string $name
return	string

$payoutEnabled protected property

protected bool $payoutEnabled
return	boolean

$payoutFields protected property

protected array $payoutFields
return	array

$pluralName protected property

protected string $pluralName
return	string

$precision protected property

protected int $precision
return	integer

$symbol protected property

protected string $symbol
return	string