API Documentation
Back to top  

EmptyCurrencyCode

Extends \CurrencyCode

EmptyCurrencyCode

The purpose of this class is to return an empty string as representation of a empty currency code value.

category

System
package

Shared

Methods

Constructor

__construct(\StringType $code, \DecimalType $currencyValue = null)
inherited

Validates the parameter and saves it to the property in uppercase format.

Throws
\InvalidArgumentException

if Argument is not exactly 3 letters

Arguments

$code

\StringType

The currency Code (e.g. EUR)

$currencyValue

\DecimalType

Value of the currency

Get Code

getCode() : string
inherited

Returns the currency code as a string.

Response

string

Get Currency Value

getCurrencyValue() : \DecimalType
inherited

Returns the currency value as a decimal type.

Response

\DecimalType

Properties

Holds the currency code as a string.

code : string
inherited
var

Type(s)

string

Holds the currency value as a decimal type.

currencyValue : float
inherited
var

Type(s)

float