Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zend.i18n.view.helper.currency.format.html

Size:20129
Storage flags:no_autoload,compress/gzip (20%)

CurrencyFormat Helper — Zend Framework 2 2.4.2 documentation

CurrencyFormat Helper

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).

Basic Usage

 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"
currencyFormat(float $number[, string $currencyCode = null[, bool $showDecimals = null[, string $locale = null[, string $pattern = null]]]])

Format a number

Parameters:
  • $number – The numeric currency value.
  • $currencyCode – (Optional) The 3-letter ISO 4217 currency code indicating the currency to use. If unset, it will use the default value null (getCurrencyCode()).
  • $showDecimals – (Optional) Boolean false as third argument shows no decimals. If unset, it will use the default value true (shouldShowDecimals()).
  • $locale – (Optional) Locale in which the currency would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()).
  • $pattern – (Optional) Pattern string that is used by the formatter. If unset, it will use the default value null (getCurrencyPattern()).
Return type:

string

Available Methods

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"
setCurrencyCode(string $currencyCode)

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
setLocale(string $locale)

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"
setShouldShowDecimals(bool $showDecimals)

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"
setCurrencyPattern(string $currencyPattern)

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

Table Of Contents

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

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.

  1. Login with your GitHub account.
  2. Go to CurrencyFormat Helper on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.

For more information about the PHK package format: http://phk.tekwire.net