View/Helper/Currency.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_View
- Subpackage
- Helper
- Version
- $Id$
\Zend_View_Helper_Currency
Package: Zend_View\Helper
Currency view helper
- Parent(s)
- \Zend_View_Helper_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(\Zend_Currency $currency = null) : void
Constructor for manually handling
Parameters
Name | Type | Description |
---|---|---|
$currency | \Zend_Currency | Instance of Zend_Currency |
currency(integer | float $value = null, string | \Zend_Locale | array $currency = null) : string
Output a formatted currency
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | integer | float | Currency value to output |
$currency | string | \Zend_Locale | array | OPTIONAL Currency to use for this call |
Type | Description |
---|---|
string | Formatted currency |
getCurrency() : \Zend_Currency | null
Retrieve currency object
Returns
Type | Description |
---|---|
\Zend_Currency | null |
setCurrency(\Zend_Currency | String | \Zend_Locale $currency = null) : \Zend_View_Helper_Currency
Sets a currency to use
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$currency | \Zend_Currency | String | \Zend_Locale | Currency to use |
Type | Description |
---|---|
\Zend_View_Helper_Currency |
Exception | Description |
---|---|
\Zend_View_Exception | When no or a false currency was set |