<?php
/**
* @package   ZOO Component
* @file      number.php
* @version   2.4.10 June 2011
* @author    YOOtheme http://www.yootheme.com
* @copyright Copyright (C) 2007 - 2011 YOOtheme GmbH
* @license   http://www.gnu.org/licenses/gpl-2.0.html GNU/GPLv2 only
*/

/*
	Class: NumberHelper
		Helper for formatting numbers.
		Based on Number Helper (http://cakephp.org, Cake Software Foundation, Inc., MIT License)
*/
class NumberHelper extends AppHelper {

	/* default currency format */
	public $currency = 'EUR';
    
	/* supported currencies */
	protected $_currencies = array(
		'USD' => array(
			'currency' => 'USD', 'before' => '$', 'after' => '', 'zero' => 0,
			'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '-'
		),
		'GBP' => array(
			'currency' => 'GBP', 'before'=> '£', 'after' => '', 'zero' => 0,
			'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '-'
		),
		'EUR' => array(
			'currency' => 'EUR', 'before' => '', 'after' => ' €', 'zero' => 0,
			'places' => 2, 'thousands' => '.', 'decimals' => ',', 'negative' => '-'
		),
		'DEFAULT' => array(
			'before' => '', 'after' => '', 'zero' => '0', 'places' => 2,
			'thousands' => ',', 'decimals' => '.', 'negative' => '-'
		)
	);

	/**
	* Formats a number with a level of precision.
	*
	* @param float $number	A floating point number.
	* @param integer $precision The precision of the returned number.
	* @return float Enter description here...
	* @access public
	* @link http://book.cakephp.org/view/1454/precision
	*/
	public function precision($number, $precision = 3) {
		return sprintf("%01.{$precision}f", $number);
	}

	/**
	* Returns a formatted-for-humans file size.
	*
	* @param integer $length Size in bytes
	* @return string Human readable size
	* @access public
	* @link http://book.cakephp.org/view/1456/toReadableSize
	*/
	public function toReadableSize($size) {
		switch (true) {
			case $size < 1024:
				return sprintf(__n('%d Byte', '%d Bytes', $size, true), $size);
			case round($size / 1024) < 1024:
				return sprintf(__('%d KB', true), $this->precision($size / 1024, 0));
			case round($size / 1024 / 1024, 2) < 1024:
				return sprintf(__('%.2f MB', true), $this->precision($size / 1024 / 1024, 2));
			case round($size / 1024 / 1024 / 1024, 2) < 1024:
				return sprintf(__('%.2f GB', true), $this->precision($size / 1024 / 1024 / 1024, 2));
			default:
				return sprintf(__('%.2f TB', true), $this->precision($size / 1024 / 1024 / 1024 / 1024, 2));
		}
	}

	/**
	* Formats a number into a percentage string.
	*
	* @param float $number A floating point number
	* @param integer $precision The precision of the returned number
	* @return string Percentage string
	* @access public
	* @link http://book.cakephp.org/view/1455/toPercentage
	*/
	public function toPercentage($number, $precision = 2) {
		return $this->precision($number, $precision) . '%';
	}

	/**
	* Formats a number into a currency format.
	*
	* @param float $number A floating point number
	* @param integer $options if int then places, if string then before, if (,.-) then use it
	*   or array with places and before keys
	* @return string formatted number
	* @access public
	* @link http://book.cakephp.org/view/1457/format
	*/
	public function format($number, $options = false) {
		$places = 0;
		
		if (is_int($options)) {
			$places = $options;
		}

		$separators = array(',', '.', '-', ':');

		$before = $after = null;
		if (is_string($options) && !in_array($options, $separators)) {
			$before = $options;
		}
		
		$thousands = ',';
		if (!is_array($options) && in_array($options, $separators)) {
			$thousands = $options;
		}
		
		$decimals = '.';
		if (!is_array($options) && in_array($options, $separators)) {
			$decimals = $options;
		}

		if (is_array($options)) {
			$options = array_merge(array('before'=>'$', 'places' => 2, 'thousands' => ',', 'decimals' => '.'), $options);
			extract($options);
		}

		return $before.number_format($number, $places, $decimals, $thousands).$after;
	}

	/**
	* Formats a number into a currency format.
	*
	* ### Options
	*
	* - `before` - The currency symbol to place before whole numbers ie. '$'
	* - `after` - The currency symbol to place after decimal numbers ie. 'c'. Set to boolean false to 
	*    use no decimal symbol.  eg. 0.35 => $0.35.
	* - `zero` - The text to use for zero values, can be a string or a number. ie. 0, 'Free!'
	* - `places` - Number of decimal places to use. ie. 2
	* - `thousands` - Thousands separator ie. ','
	* - `decimals` - Decimal separator symbol ie. '.'
	* - `negative` - Symbol for negative numbers. If equal to '()', the number will be wrapped with ( and )
	* - `escape` - Should the output be htmlentity escaped? Defaults to true
	*
	* @param float $number
	* @param string $currency Shortcut to default options. Valid values are 'USD', 'EUR', 'GBP', otherwise
	*   set at least 'before' and 'after' options.
	* @param array $options
	* @return string Number formatted as a currency.
	* @access public
	* @link http://book.cakephp.org/view/1453/currency
	*/
	public function currency($number, $options = array()) {

		$currency = isset($options['currency']) ? $options['currency'] : $this->currency;
		$default  = isset($this->_currencies[$currency]) ? $this->_currencies[$currency] : $this->_currencies['DEFAULT'];
		$options  = array_merge($default, $options);
		$result   = null;

		// zero ?
		if ($number == 0 && $options['zero'] !== 0 ) {
			return $options['zero'];
		}

		// apply format
		$result = $this->format(abs($number), $options);

		// negative ?
		if ($number < 0 ) {
			$result = $options['negative'] == '()' ? '('.$result.')' : $options['negative'].$result;
		}

		return $result;
	}

	/**
	* Add a currency format to the Number helper.  Makes reusing
	* currency formats easier.
	*
	* {{{ $number->addFormat('NOK', array('before' => 'Kr. ')); }}}
	* 
	* You can now use `NOK` as a shortform when formatting currency amounts.
	*
	* {{{ $number->currency($value, 'NOK'); }}}
	*
	* Added formats are merged with the following defaults.
	*
	* {{{
	*	array(
	*		'before' => '$', 'after' => 'c', 'zero' => 0, 'places' => 2, 'thousands' => ',',
	*		'decimals' => '.', 'negative' => '()', 'escape' => true
	*	)
	* }}}
	*
	* @param string $formatName The format name to be used in the future.
	* @param array $options The array of options for this format.
	* @return void
	* @see NumberHelper::currency()
	* @access public
	*/
	public function addFormat($formatName, $options) {
		$this->_currencies[$formatName] = $options + $this->_currencyDefaults;
	}

}