Mage_Directory_Model_Mysql4_Currency Class Reference

Inheritance diagram for Mage_Directory_Model_Mysql4_Currency:

List of all members.

Public Member Functions
	__construct ()
	getRate ($currencyFrom, $currencyTo)
	saveRates ($rates)
	getConfigCurrencies ($model, $path)
	getCurrencyRates ($currency, $toCurrencies=null)
Protected Member Functions
	_construct ()
	_getRatesByCode ($code, $toCurrencies=null)
Protected Attributes
	$_currencyRateTable
Static Protected Attributes
static	$_rateCache

---

Detailed Description

Definition at line 34 of file Currency.php.

---

Constructor & Destructor Documentation

__construct

(

)

Reimplemented from Mage_Core_Model_Resource_Abstract.

Definition at line 55 of file Currency.php.

    {
        $resource = Mage::getSingleton('core/resource');
        $this->_currencyRateTable   = $resource->getTableName('directory/currency_rate');

        parent::__construct();
    }

---

Member Function Documentation

_construct

(

)

[protected]

Resource initialization

Reimplemented from Mage_Core_Model_Resource_Abstract.

Definition at line 50 of file Currency.php.

    {
        $this->_init('directory/currency', 'currency_code');
    }

_getRatesByCode	(	$	code,
		$	toCurrencies = null
	)			[protected]

Protected method used by getCurrencyRates() method

Parameters:

	string	$code
	array	$toCurrencies

Returns:

array

Definition at line 183 of file Currency.php.

    {
        $read = $this->_getReadAdapter();
        $select = $read->select()
            ->from($this->getTable('directory/currency_rate'), array('currency_to', 'rate'))
            ->where($read->quoteInto('currency_from = ?', $code))
            ->where($read->quoteInto('currency_to IN(?)', $toCurrencies));

        $data = $read->fetchAll($select);

        $tmp_array = array();
        foreach( $data as $currencyFrom => $rate ) {
            $tmp_array[$rate['currency_to']] = $rate['rate'];
        }
        $data = $tmp_array;

        return $data;
    }

getConfigCurrencies	(	$	model,
		$	path
	)

Retrieve config currency data by config path

Parameters:

	object	$model
	string	$path

Returns:

array

Definition at line 136 of file Currency.php.

    {
        $read = $this->_getReadAdapter();
        $select = $read->select()
                ->from($this->getTable('core/config_data'))
                ->where($read->quoteInto(' path = ? ', $path))
                //->where('inherit = 0')
                ->order(' value ASC ');

        $data = $read->fetchAll($select);
        $tmp_array = array();
        foreach( $data as $configRecord ) {
            $tmp_array = array_merge($tmp_array, explode(',', $configRecord['value']));
        }

        $data = array_unique($tmp_array);
        return $data;
    }

getCurrencyRates	(	$	currency,
		$	toCurrencies = null
	)

Retieve currency rates

Parameters:

	string|array	$currency
	array	$toCurrencies

Returns:

array

Definition at line 162 of file Currency.php.

    {
        $rates = array();
        if( is_array($currency) ) {
            foreach( $currency as $code ) {
                $rates[$code] = $this->_getRatesByCode($code, $toCurrencies);
            }
        } else {
            $rates = $this->_getRatesByCode($currency, $toCurrencies);
        }

        return $rates;
    }

getRate	(	$	currencyFrom,
		$	currencyTo
	)

Retrieve currency rate

Parameters:

	string	$currencyFrom
	string	$currencyTo

Returns:

float

Definition at line 70 of file Currency.php.

    {
        if ($currencyFrom instanceof Mage_Directory_Model_Currency) {
            $currencyFrom = $currencyFrom->getCode();
        }

        if ($currencyTo instanceof Mage_Directory_Model_Currency) {
            $currencyTo = $currencyTo->getCode();
        }

        if ($currencyFrom == $currencyTo) {
            return 1;
        }

        if (!isset(self::$_rateCache[$currencyFrom][$currencyTo])) {
            $read = $this->_getReadAdapter();
            $select = $read->select()
                ->from($this->_currencyRateTable, 'rate')
                ->where('currency_from=?', strtoupper($currencyFrom))
                ->where('currency_to=?', strtoupper($currencyTo));

            self::$_rateCache[$currencyFrom][$currencyTo] = $read->fetchOne($select);
        }

        return self::$_rateCache[$currencyFrom][$currencyTo];
    }

saveRates

(

$

rates

)

Saving currency rates

Parameters:

array

$rates

Definition at line 102 of file Currency.php.

    {
        if( is_array($rates) && sizeof($rates) > 0 ) {
            $write = $this->_getWriteAdapter();
            $table  = $write->quoteIdentifier($this->_currencyRateTable);
            $colFrom= $write->quoteIdentifier('currency_from');
            $colTo  = $write->quoteIdentifier('currency_to');
            $colRate= $write->quoteIdentifier('rate');

            $sql = 'REPLACE INTO ' . $table . ' (' . $colFrom . ', ' . $colTo . ', ' . $colRate . ') VALUES ';
            $values = array();
            foreach ($rates as $currencyCode => $rate) {
                foreach( $rate as $currencyTo => $value ) {
                    $value = abs($value);
                    if( $value == 0 ) {
                        continue;
                    }
                    $values[] = $write->quoteInto('(?)', array($currencyCode, $currencyTo, $value));
                }
            }
            $sql.= implode(',', $values);
            $write->query($sql);
        } else {
            Mage::throwException(Mage::helper('directory')->__('Invalid rates received'));
        }
    }

---

Member Data Documentation

$_currencyRateTable [protected]

Definition at line 41 of file Currency.php.

$_rateCache [static, protected]

Definition at line 48 of file Currency.php.

---

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

• app/code/core/Mage/Directory/Model/Mysql4/Currency.php