Fully Qualified Name: | Zend\I18n\View\Helper\CurrencyFormat |
Extends: | AbstractHelper |
View helper for formatting currency.
Name | Description | Defined By |
---|---|---|
__construct() | CurrencyFormat | |
__invoke() | Format a number | CurrencyFormat |
getCurrencyCode() | Get the 3-letter ISO 4217 currency code indicating the currency to use | CurrencyFormat |
getCurrencyPattern() | Get the currency pattern | CurrencyFormat |
getLocale() | Get the locale to use | CurrencyFormat |
getView() | Get the view object | AbstractHelper |
setCurrencyCode() | The 3-letter ISO 4217 currency code indicating the currency to use | CurrencyFormat |
setCurrencyPattern() | Set the currency pattern | CurrencyFormat |
setLocale() | Set locale to use instead of the default | CurrencyFormat |
setShouldShowDecimals() | Set if the view helper should show two decimals | CurrencyFormat |
setView() | Set the View object | AbstractHelper |
shouldShowDecimals() | Get if the view helper should show two decimals | CurrencyFormat |
Returns:
Format a number
Parameter Name | Type | Description |
---|---|---|
$number | float | |
$currencyCode | string | |
$showDecimals | bool | |
$locale | string | |
$pattern | string |
Returns: string
Get the 3-letter ISO 4217 currency code indicating the currency to use
Returns: string
Get the currency pattern
Returns: string
Get the locale to use
Returns: string|null
Get the view object
Returns: null|\Renderer
The 3-letter ISO 4217 currency code indicating the currency to use
Parameter Name | Type | Description |
---|---|---|
$currencyCode | string |
Returns: \CurrencyFormat
Set the currency pattern
Parameter Name | Type | Description |
---|---|---|
$currencyPattern | string |
Returns: \CurrencyFormat
Set locale to use instead of the default
Parameter Name | Type | Description |
---|---|---|
$locale | string |
Returns: \CurrencyFormat
Set if the view helper should show two decimals
Parameter Name | Type | Description |
---|---|---|
$showDecimals | bool |
Returns: \CurrencyFormat
Set the View object
Parameter Name | Type | Description |
---|---|---|
$view | \Renderer |
Returns: \AbstractHelper
Get if the view helper should show two decimals
Returns: bool