<?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

 * @package   Zend_Currency

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 * @version   $Id: Currency.php 22708 2010-07-28 07:25:16Z thomas $

 */

/**

 * include needed classes

 */

require_once 'Zend/Locale.php';

require_once 'Zend/Locale/Data.php';

require_once 'Zend/Locale/Format.php';

/**

 * Class for handling currency notations

 *

 * @category  Zend

 * @package   Zend_Currency

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Currency

{

    // Constants for defining what currency symbol should be displayed

    const NO_SYMBOL     = 1;

    const USE_SYMBOL    = 2;

    const USE_SHORTNAME = 3;

    const USE_NAME      = 4;

    // Constants for defining the position of the currencysign

    const STANDARD = 8;

    const RIGHT    = 16;

    const LEFT     = 32;

    /**

     * Options array

     *

     * The following options are available

     * 'position'  => Position for the currency sign

     * 'script'    => Script for the output

     * 'format'    => Locale for numeric output

     * 'display'   => Currency detail to show

     * 'precision' => Precision for the currency

     * 'name'      => Name for this currency

     * 'currency'  => 3 lettered international abbreviation

     * 'symbol'    => Currency symbol

     * 'locale'    => Locale for this currency

     * 'value'     => Money value

     * 'service'   => Exchange service to use

     *

     * @var array

     * @see Zend_Locale

     */

    protected $_options = array(

        'position'  => self::STANDARD,

        'script'    => null,

        'format'    => null,

        'display'   => self::NO_SYMBOL,

        'precision' => 2,

        'name'      => null,

        'currency'  => null,

        'symbol'    => null,

        'locale'    => null,

        'value'     => 0,

        'service'   => null,

        'tag'       => 'Zend_Locale'

    );

    /**

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

     *

     * @param  string|array       $options OPTIONAL Options array or currency short name

     *                                              when string is given

     * @param  string|Zend_Locale $locale  OPTIONAL locale name

     * @throws Zend_Currency_Exception When currency is invalid

     */

    public function __construct($options = null, $locale = null)

    {

        if (is_array($options)) {

            $this->setLocale($locale);

            $this->setFormat($options);

        } else if (Zend_Locale::isLocale($options, false, false)) {

            $this->setLocale($options);

            $options = $locale;

        } else {

            $this->setLocale($locale);

        }

        // Get currency details

        if (!isset($this->_options['currency']) || !is_array($options)) {

            $this->_options['currency'] = self::getShortName($options, $this->_options['locale']);

        }

        if (!isset($this->_options['name']) || !is_array($options)) {

            $this->_options['name']     = self::getName($options, $this->_options['locale']);

        }

        if (!isset($this->_options['symbol']) || !is_array($options)) {

            $this->_options['symbol']   = self::getSymbol($options, $this->_options['locale']);

        }

        if (($this->_options['currency'] === null) and ($this->_options['name'] === null)) {

            require_once 'Zend/Currency/Exception.php';

            throw new Zend_Currency_Exception("Currency '$options' not found");

        }

        // Get the format

        if (!empty($this->_options['symbol'])) {

            $this->_options['display'] = self::USE_SYMBOL;

        } else if (!empty($this->_options['currency'])) {

            $this->_options['display'] = self::USE_SHORTNAME;

        }

    }

    /**

     * Returns a localized currency string

     *

     * @param  integer|float $value   OPTIONAL Currency value

     * @param  array         $options OPTIONAL options to set temporary

     * @throws Zend_Currency_Exception When the value is not a number

     * @return string

     */

    public function toCurrency($value = null, array $options = array())

    {

        if ($value === null) {

            if (is_array($options) && isset($options['value'])) {

                $value = $options['value'];

            } else {

                $value = $this->_options['value'];

            }

        }

        if (is_array($value)) {

            $options += $value;

            if (isset($options['value'])) {

                $value = $options['value'];

            }

        }

        // Validate the passed number

        if (!(isset($value)) or (is_numeric($value) === false)) {

            require_once 'Zend/Currency/Exception.php';

            throw new Zend_Currency_Exception("Value '$value' has to be numeric");

        }

        if (isset($options['currency'])) {

            if (!isset($options['locale'])) {

                $options['locale'] = $this->_options['locale'];

            }

            $options['currency'] = self::getShortName($options['currency'], $options['locale']);

            $options['name']     = self::getName($options['currency'], $options['locale']);

            $options['symbol']   = self::getSymbol($options['currency'], $options['locale']);

        }

        $options = $this->_checkOptions($options) + $this->_options;

        // Format the number

        $format = $options['format'];

        $locale = $options['locale'];

        if (empty($format)) {

            $format = Zend_Locale_Data::getContent($locale, 'currencynumber');

        } else if (Zend_Locale::isLocale($format, true, false)) {

            $locale = $format;

            $format = Zend_Locale_Data::getContent($format, 'currencynumber');

        }

        $original = $value;

        $value    = Zend_Locale_Format::toNumber($value, array('locale'        => $locale,

                                                               'number_format' => $format,

                                                               'precision'     => $options['precision']));

        if ($options['position'] !== self::STANDARD) {

            $value = str_replace('¤', '', $value);

            $space = '';

            if (iconv_strpos($value, ' ') !== false) {

                $value = str_replace(' ', '', $value);

                $space = ' ';

            }

            if ($options['position'] == self::LEFT) {

                $value = '¤' . $space . $value;

            } else {

                $value = $value . $space . '¤';

            }

        }

        // Localize the number digits

        if (empty($options['script']) === false) {

            $value = Zend_Locale_Format::convertNumerals($value, 'Latn', $options['script']);

        }

        // Get the sign to be placed next to the number

        if (is_numeric($options['display']) === false) {

            $sign = $options['display'];

        } else {

            switch($options['display']) {

                case self::USE_SYMBOL:

                    $sign = $this->_extractPattern($options['symbol'], $original);

                    break;

                case self::USE_SHORTNAME:

                    $sign = $options['currency'];

                    break;

                case self::USE_NAME:

                    $sign = $options['name'];

                    break;

                default:

                    $sign = '';

                    $value = str_replace(' ', '', $value);

                    break;

            }

        }

        $value = str_replace('¤', $sign, $value);

        return $value;

    }

    /**

     * Internal method to extract the currency pattern

     * when a choice is given based on the given value

     *

     * @param  string $pattern

     * @param  float|integer $value

     * @return string

     */

    private function _extractPattern($pattern, $value)

    {

        if (strpos($pattern, '|') === false) {

            return $pattern;

        }

        $patterns = explode('|', $pattern);

        $token    = $pattern;

        $value    = trim(str_replace('¤', '', $value));

        krsort($patterns);

        foreach($patterns as $content) {

            if (strpos($content, '<') !== false) {

                $check = iconv_substr($content, 0, iconv_strpos($content, '<'));

                $token = iconv_substr($content, iconv_strpos($content, '<') + 1);

                if ($check < $value) {

                    return $token;

                }

            } else {

                $check = iconv_substr($content, 0, iconv_strpos($content, '≤'));

                $token = iconv_substr($content, iconv_strpos($content, '≤') + 1);

                if ($check <= $value) {

                    return $token;

                }

            }

        }

        return $token;

    }

    /**

     * Sets the formating options of the localized currency string

     * If no parameter is passed, the standard setting of the

     * actual set locale will be used

     *

     * @param  array $options (Optional) Options to set

     * @return Zend_Currency

     */

    public function setFormat(array $options = array())

    {

        $this->_options = $this->_checkOptions($options) + $this->_options;

        return $this;

    }

    /**

     * Internal function for checking static given locale parameter

     *

     * @param  string             $currency (Optional) Currency name

     * @param  string|Zend_Locale $locale   (Optional) Locale to display informations

     * @throws Zend_Currency_Exception When locale contains no region

     * @return string The extracted locale representation as string

     */

    private function _checkParams($currency = null, $locale = null)

    {

        // Manage the params

        if ((empty($locale)) and (!empty($currency)) and

            (Zend_Locale::isLocale($currency, true, false))) {

            $locale   = $currency;

            $currency = null;

        }

        // Validate the locale and get the country short name

        $country = null;

        if ((Zend_Locale::isLocale($locale, true, false)) and (strlen($locale) > 4)) {

            $country = substr($locale, (strpos($locale, '_') + 1));

        } else {

            require_once 'Zend/Currency/Exception.php';

            throw new Zend_Currency_Exception("No region found within the locale '" . (string) $locale . "'");

        }

        // Get the available currencies for this country

        $data = Zend_Locale_Data::getContent($locale, 'currencytoregion', $country);

        if ((empty($currency) === false) and (empty($data) === false)) {

            $abbreviation = $currency;

        } else {

            $abbreviation = $data;

        }

        return array('locale' => $locale, 'currency' => $currency, 'name' => $abbreviation, 'country' => $country);

    }

    /**

     * Returns the actual or details of other currency symbols,

     * when no symbol is available it returns the currency shortname (f.e. FIM for Finnian Mark)

     *

     * @param  string             $currency (Optional) Currency name

     * @param  string|Zend_Locale $locale   (Optional) Locale to display informations

     * @return string

     */

    public function getSymbol($currency = null, $locale = null)

    {

        if (($currency === null) and ($locale === null)) {

            return $this->_options['symbol'];

        }

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

        // Get the symbol

        $symbol = Zend_Locale_Data::getContent($params['locale'], 'currencysymbol', $params['currency']);

        if (empty($symbol) === true) {

            $symbol = Zend_Locale_Data::getContent($params['locale'], 'currencysymbol', $params['name']);

        }

        if (empty($symbol) === true) {

            return null;

        }

        return $symbol;

    }

    /**

     * Returns the actual or details of other currency shortnames

     *

     * @param  string             $currency OPTIONAL Currency's name

     * @param  string|Zend_Locale $locale   OPTIONAL The locale

     * @return string

     */

    public function getShortName($currency = null, $locale = null)

    {

        if (($currency === null) and ($locale === null)) {

            return $this->_options['currency'];

        }

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

        // Get the shortname

        if (empty($params['currency']) === true) {

            return $params['name'];

        }

        $list = Zend_Locale_Data::getContent($params['locale'], 'currencytoname', $params['currency']);

        if (empty($list) === true) {

            $list = Zend_Locale_Data::getContent($params['locale'], 'nametocurrency', $params['currency']);

            if (empty($list) === false) {

                $list = $params['currency'];

            }

        }

        if (empty($list) === true) {

            return null;

        }

        return $list;

    }

    /**

     * Returns the actual or details of other currency names

     *

     * @param  string             $currency (Optional) Currency's short name

     * @param  string|Zend_Locale $locale   (Optional) The locale

     * @return string

     */

    public function getName($currency = null, $locale = null)

    {

        if (($currency === null) and ($locale === null)) {

            return $this->_options['name'];

        }

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

        // Get the name

        $name = Zend_Locale_Data::getContent($params['locale'], 'nametocurrency', $params['currency']);

        if (empty($name) === true) {

            $name = Zend_Locale_Data::getContent($params['locale'], 'nametocurrency', $params['name']);

        }

        if (empty($name) === true) {

            return null;

        }

        return $name;