View/Helper/Currency.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] 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

>VPropertyprotected\Zend_Currency $_currency
Currency object
Details
Type
\Zend_Currency

Methods

methodpublic__construct(\Zend_Currency $currency = null) : void

Constructor for manually handling

Parameters
NameTypeDescription
$currency\Zend_Currency

Instance of Zend_Currency

methodpubliccurrency(integer | float $value = null, string | \Zend_Locale | array $currency = null) : string

Output a formatted currency

Parameters
NameTypeDescription
$valueinteger | float

Currency value to output

$currencystring | \Zend_Locale | array

OPTIONAL Currency to use for this call

Returns
TypeDescription
stringFormatted currency
methodpublicgetCurrency() : \Zend_Currency | null

Retrieve currency object

Returns
TypeDescription
\Zend_Currency | null
methodpublicsetCurrency(\Zend_Currency | String | \Zend_Locale $currency = null) : \Zend_View_Helper_Currency

Sets a currency to use

Parameters
NameTypeDescription
$currency\Zend_Currency | String | \Zend_Locale

Currency to use

Returns
TypeDescription
\Zend_View_Helper_Currency
Throws
ExceptionDescription
\Zend_View_ExceptionWhen no or a false currency was set
Documentation was generated by phpDocumentor 2.2.0 .