1. class
  2. WHMCS
  3. View
  4. Formatter
  5. Price

Price

Price Formatter.

class Price

Constants

PREFIX

PRICE

SUFFIX

Properties summary

Type Property Description
protected $price
protected $currency
protected $defaultFormat
protected $defaultCurrencyDescriptor

Methods summary

Return Type Method Name Description
__construct(float $price, array $currency = null) Construct price object.
string __toString() Return the default price format with prefix and suffix.
string toFull() Return price with prefix and suffix.
string toPrefixed() Return price with prefix only.
string toSuffixed() Return price with suffix only.
string toNumeric() Return numeric price only.
string format(string|null $format = null, array|null $currency = null) Format a price in a given format.
getCurrency() -

Details

__construct (float $price, array $currency = null)

Construct price object.

Parameters

float $price
array $currency

string __toString ()

Return the default price format with prefix and suffix.

Return Value

string

string toFull ()

Return price with prefix and suffix.

Return Value

string

string toPrefixed ()

Return price with prefix only.

Return Value

string

string toSuffixed ()

Return price with suffix only.

Return Value

string

string toNumeric ()

Return numeric price only.

Return Value

string

string format (string|null $format = null, array|null $currency = null)

Format a price in a given format.

Parameters

string|null $format
array|null $currency

Return Value

string

getCurrency ()