|
Size: | 20129 |
Storage flags: | no_autoload,compress/gzip (20%) |
The CurrencyFormat view helper can be used to simplify rendering of localized currency values. It acts as a wrapper for the NumberFormatter class within the Internationalization extension (Intl).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | // Within your view
echo $this->currencyFormat(1234.56, 'USD', null, 'en_US');
// This returns: "$1,234.56"
echo $this->currencyFormat(1234.56, 'EUR', null, 'de_DE');
// This returns: "1.234,56 €"
echo $this->currencyFormat(1234.56, 'USD', true, 'en_US');
// This returns: "$1,234.56"
echo $this->currencyFormat(1234.56, 'USD', false, 'en_US');
// This returns: "$1,235"
echo $this->currencyFormat(12345678.90, 'EUR', true, 'de_DE', '#0.# kg');
// This returns: "12345678,90 kg"
echo $this->currencyFormat(12345678.90, 'EUR', false, 'de_DE', '#0.# kg');
// This returns: "12345679 kg"
|
Format a number
Parameters: |
|
---|---|
Return type: | string |
Set the currency code and the locale
The $currencyCode and $locale options can be set prior to formatting and will be applied each time the helper is used:
1 2 3 4 5 6 7 8 9 | // Within your view
$this->plugin('currencyformat')->setCurrencyCode('USD')->setLocale('en_US');
echo $this->currencyFormat(1234.56);
// This returns: "$1,234.56"
echo $this->currencyFormat(5678.90);
// This returns: "$5,678.90"
|
The 3-letter ISO 4217 currency code indicating the currency to use
Parameters: | $currencyCode – The 3-letter ISO 4217 currency code. |
---|---|
Return type: | Zend\I18n\View\Helper\CurrencyFormat |
Set locale to use instead of the default
Parameters: | $locale – Locale in which the number would be formatted. |
---|---|
Return type: | Zend\I18n\View\Helper\CurrencyFormat |
Show decimals
1 2 3 4 5 6 | // Within your view
$this->plugin('currencyformat')->setShouldShowDecimals(false);
echo $this->currencyFormat(1234.56, 'USD', null, 'en_US');
// This returns: "$1,235"
|
Set if the view helper should show two decimals
Parameters: | $showDecimals – Whether or not to show the decimals. |
---|---|
Return type: | Zend\I18n\View\Helper\CurrencyFormat |
Set currency pattern
1 2 3 4 5 6 | // Within your view
$this->plugin('currencyformat')->setCurrencyPattern('#0.# kg');
echo $this->currencyFormat(12345678.90, 'EUR', null, 'de_DE');
// This returns: "12345678,90 kg"
|
Set the currency pattern used by the formatter. (See the NumberFormatter::setPattern PHP method for more information.)
Parameters: | $currencyPattern – Pattern in syntax described in ICU DecimalFormat documentation |
---|---|
Return type: | Zend\I18n\View\Helper\CurrencyFormat |
The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.