API Documentation

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: Currency.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_Currency

Currency view helper

Extends from
\Zend_View_Helper_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  

Properties

Propertyprotected\Zend_Currency  $_currency= ''

Currency object

Details
Type
\Zend_Currency

Methods

methodpublic__construct( \Zend_Currency $currency = null ) : void

Constructor for manually handling

Parameters
Name Type Description
$currency \Zend_Currency Instance of Zend_Currency
methodpubliccurrency( integer|float $value = null, string|\Zend_Locale|\Zend_Currency $currency = null ) : string

Output a formatted currency

Parameters
Name Type Description
$value integer|float Currency value to output
$currency string|\Zend_Locale|\Zend_Currency OPTIONAL Currency to use for this call
Returns
Type Description
string Formatted currency
methodpublicdirect( ) : void

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
methodpublicgetCurrency( ) : \Zend_Currency|null

Retrieve currency object

Returns
Type Description
\Zend_Currencynull
methodpublicsetCurrency( \Zend_Currency|String|\Zend_Locale $currency = null ) : \Zend_View_Helper_Currency

Sets a currency to use

Parameters
Name Type Description
$currency \Zend_Currency|String|\Zend_Locale Currency to use
Returns
Type Description
\Zend_View_Helper_Currency
Throws
Exception Description
\Zend_View_Exception When no or a false currency was set
methodpublicsetView( \Zend_View_Interface $view ) : \Zend_View_Helper_Abstract

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
Documentation was generated by DocBlox 0.13.3.