1. class
  2. Lunar
  3. \
  4. DataTypes
  5. \
  6. Price

Price

class Price (View source)

Methods

__construct(mixed $value, Currency $currency, int $unitQty = 1)

Initialise the Price datatype.

void
__get(string $name)

Getter for methods/properties.

string
__toString()

Cast class as a string.

float
decimal($rounding = true)

Get the decimal value.

float
unitDecimal($rounding = true)

Get the decimal unit value.

string
formatted($locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

Format the value with the currency.

string
unitFormatted($locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

Format the unit value with the currency.

formatValue($value, $locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

No description

Details

at line 17
__construct(mixed $value, Currency $currency, int $unitQty = 1)

Initialise the Price datatype.

Parameters

mixed $value
Currency $currency
int $unitQty

at line 38
void __get(string $name)

Getter for methods/properties.

Parameters

string $name

Return Value

void

at line 50
string __toString()

Cast class as a string.

Return Value

string

at line 60
float decimal($rounding = true)

Get the decimal value.

Parameters

$rounding

Return Value

float

at line 72
float unitDecimal($rounding = true)

Get the decimal unit value.

Parameters

$rounding

Return Value

float

at line 84
string formatted($locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

Format the value with the currency.

Parameters

$locale
$formatterStyle
$decimalPlaces
$trimTrailingZeros

Return Value

string

at line 94
string unitFormatted($locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

Format the unit value with the currency.

Parameters

$locale
$formatterStyle
$decimalPlaces
$trimTrailingZeros

Return Value

string

at line 99
protected formatValue($value, $locale = null, $formatterStyle = NumberFormatter::CURRENCY, $decimalPlaces = null, $trimTrailingZeros = true)

No description

Parameters

$value
$locale
$formatterStyle
$decimalPlaces
$trimTrailingZeros