Mage_Core_Model_Locale_Currency Class Reference

List of all members.

Public Member Functions
	__construct ($currency=null, $locale=null)
	getSymbolChoice ($currency=null, $locale=null)
	setLocale ($locale=null)
	getStore ()
Public Attributes
const	XML_PATH_TRIM_CURRENCY_SIGN = 'currency/options/trim_sign'
const	US_LOCALE = 'en_US'
Protected Member Functions
	_concatSign ($value, $sign, $options)
Protected Attributes
	$_locale

---

Detailed Description

Locale model

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Currency.php.

---

Constructor & Destructor Documentation

__construct	(	$	currency = null,
		$	locale = null
	)

Creates a currency instance. Every supressed parameter is used from the actual or the given locale.

Parameters:

	string	$currency OPTIONAL currency short name
	string|Zend_Locale	$locale OPTIONAL locale name

Exceptions:

Zend_Currency_Exception

When currency is invalid

Definition at line 45 of file Currency.php.

    {
        parent::__construct($currency, $locale);
        $this->_options['symbol_choice'] = self::getSymbolChoice($currency, $this->_locale);
    }

---

Member Function Documentation

_concatSign	(	$	value,
		$	sign,
		$	options
	)			[protected]

Place the sign next to the number

Parameters:

	string	$value
	string	$sign
	array	$options

Returns:

string

Definition at line 92 of file Currency.php.

    {
        $trimSign = $this->getStore()->getConfig(self::XML_PATH_TRIM_CURRENCY_SIGN);
        if (is_null($trimSign) && $this->_locale && $this->_locale == self::US_LOCALE) {
            $trimSign = true;
        }
        if ($trimSign) {
            $sign = trim($sign);
        }

        // Place the sign next to the number
        if ($options['position'] === self::RIGHT) {
            $result = $value . $sign;
        } else if ($options['position'] === self::LEFT) {
            // Do not place sign before minus. And do not allow space between minus and sign
            if (0 === strpos($value, '-', 0)) {
                $result = '-' . ltrim($sign) . substr($value, 1);
            } else {
                $result = $sign . $value;
            }
        }
        return $result;
    }

getStore

(

)

Get store instance

Returns:

Mage_Core_Model_Store

Definition at line 121 of file Currency.php.

    {
        return Mage::app()->getStore();
    }

getSymbolChoice	(	$	currency = null,
		$	locale = null
	)

Returns the actual or details of available currency symbol choice,

Parameters:

	string	$currency (Optional) Currency name
	string|Zend_Locale	$locale (Optional) Locale to display informations

Returns:

string

Definition at line 58 of file Currency.php.

    {
        if (($currency === null) and ($locale === null)) {
            return $this->_options['symbol_choice'];
        }

        $params = self::_checkParams($currency, $locale);

        //Get the symbol choice
        $symbolChoice = Zend_Locale_Data::getContent($params['locale'], 'currencysymbolchoice', $params['currency']);
        if (empty($symbolChoice) === true) {
            $symbolChoice = Zend_Locale_Data::getContent($params['locale'], 'currencysymbolchoice', $params['name']);
        }
        if (empty($symbolChoice) === true) {
            return null;
        }
        return $symbolChoice;
    }

setLocale

(

$

locale = null

)

Definition at line 77 of file Currency.php.

    {
        $this->_locale = $locale;
        parent::setLocale($locale);
        return $this;
    }

---

Member Data Documentation

$_locale [protected]

Definition at line 36 of file Currency.php.

const US_LOCALE = 'en_US'

Definition at line 35 of file Currency.php.

const XML_PATH_TRIM_CURRENCY_SIGN = 'currency/options/trim_sign'

Definition at line 34 of file Currency.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Core/Model/Locale/Currency.php