Prado\I18N\core\NumberFormatInfo

Complexity

Total Complexity

64

Size/Duplication

Total Lines	600
Duplicated Lines	0 %

Importance

Changes

0

42 Methods

Rating	Name	Duplication	Size	Complexity
A	setDigitSize()	0	3	1
F	parsePattern()	0	101	15
A	setDecimalDigits()	0	3	1
A	getScientificInstance()	0	3	1
A	setNaNSymbol()	0	3	1
A	getNaNSymbol()	0	3	1
A	getNegativeSign()	0	3	1
A	getDigitSize()	0	3	1
A	getPositiveInfinitySymbol()	0	3	1
A	setNegativeInfinitySymbol()	0	3	1
A	getPrePostfix()	0	5	1
A	__get()	0	7	2
A	getDecimalDigits()	0	3	1
A	setPositiveSign()	0	3	1
A	setPercentSymbol()	0	3	1
A	getGroupSizes()	0	6	1
A	setPositivePattern()	0	4	1
A	getPositiveSign()	0	3	1
A	getPerMilleSymbol()	0	3	1
A	setGroupSeparator()	0	3	1
A	getNegativeInfinitySymbol()	0	3	1
A	getPercentageInstance()	0	3	1
A	getCurrencySymbol()	0	6	2
A	getPositivePattern()	0	5	1
A	setPattern()	0	15	2
A	setDecimalSeparator()	0	3	1
A	setPerMilleSymbol()	0	3	1
A	getInvariantInfo()	0	10	2
A	__construct()	0	10	2
A	getGroupSeparator()	0	3	1
A	getPattern()	0	3	1
A	setNegativeSign()	0	3	1
A	setCurrencySymbol()	0	3	1
A	setPositiveInfinitySymbol()	0	3	1
A	getCurrencyInstance()	0	3	1
A	getNegativePattern()	0	5	1
A	getDecimalSeparator()	0	3	1
A	__set()	0	7	2
A	getPercentSymbol()	0	3	1
A	getInstance()	0	22	3
A	setNegativePattern()	0	4	1
A	setGroupSizes()	0	4	1

<?php

/**
 * NumberFormatInfo class file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the BSD License.
 *
 * Copyright(c) 2004 by Qiang Xue. All rights reserved.
 *
 * To contact the author write to {@link mailto:qiang.xue@gmail.com Qiang Xue}
 * The latest version of PRADO can be obtained from:
 * {@link http://prado.sourceforge.net/}
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @package Prado\I18N\core
 */

namespace Prado\I18N\core;

/**
 * Get the CultureInfo class file.
 */
use Exception;

require_once(dirname(__FILE__) . '/CultureInfo.php');

/**
 * NumberFormatInfo class
 *
 * Defines how numeric values are formatted and displayed,
 * depending on the culture. Numeric values are formatted using
 * standard or custom patterns stored in the properties of a
 * NumberFormatInfo.
 *
 * This class contains information, such as currency, decimal
 * separators, and other numeric symbols.
 *
 * To create a NumberFormatInfo for a specific culture,
 * create a CultureInfo for that culture and retrieve the
 * CultureInfo->NumberFormat property. Or use
 * NumberFormatInfo::getInstance($culture).
 * To create a NumberFormatInfo for the invariant culture, use the
 * InvariantInfo::getInvariantInfo().
 *
 *
 * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @package Prado\I18N\core
 */
class NumberFormatInfo
{

	/**
	 * ICU number formatting data.
	 * @var array
	 */
	private $data = [];

	/**
	 * A list of properties that are accessable/writable.
	 * @var array
	 */
	protected $properties = [];

	/**
	 * The number pattern.
	 * @var array
	 */
	protected $pattern = [];

	const DECIMAL = 0;
	const CURRENCY = 1;
	const PERCENTAGE = 2;
	const SCIENTIFIC = 3;

	/**
	 * Allow functions that begins with 'set' to be called directly
	 * as an attribute/property to retrieve the value.
	 * @return mixed
	 */
	public function __get($name)
	{
		$getProperty = 'get' . $name;
		if(in_array($getProperty, $this->properties))
			return $this->$getProperty();
		else
			throw new Exception('Property ' . $name . ' does not exists.');
	}

	/**
	 * Allow functions that begins with 'set' to be called directly
	 * as an attribute/property to set the value.
	 */
	public function __set($name, $value)
	{
		$setProperty = 'set' . $name;
		if(in_array($setProperty, $this->properties))
			$this->$setProperty($value);
		else
			throw new Exception('Property ' . $name . ' can not be set.');
	}

	/**
	 * Initializes a new writable instance of the NumberFormatInfo class
	 * that is dependent on the ICU data for number, decimal, and currency

The type Prado\I18N\core\ICU was not found. Maybe you did not declare it correctly or list all dependencies?

	 * formatting information. <b>N.B.</b>You should not initialize this
	 * class directly unless you know what you are doing. Please use use
	 * NumberFormatInfo::getInstance() to create an instance.
	 * @param array ICU data for date time formatting.
	 * @see getInstance()
	 */
	public function __construct($data = [], $type = NumberFormatInfo::DECIMAL)
	{
		$this->properties = get_class_methods($this);

		if(empty($data))
			throw new Exception('Please provide the ICU data to initialize.');

		$this->data = $data;

		$this->setPattern($type);
	}

	/**
	 * Set the pattern for a specific number pattern. The validate patterns

The type Prado\I18N\core\pattern was not found. Maybe you did not declare it correctly or list all dependencies?

	 * NumberFormatInfo::DECIMAL, NumberFormatInfo::CURRENCY,
	 * NumberFormatInfo::PERCENTAGE, or NumberFormatInfo::SCIENTIFIC
	 * @param int pattern type.
	 */
	public function setPattern($type = NumberFormatInfo::DECIMAL)
	{
		if(is_int($type))
			$this->pattern =
				$this->parsePattern($this->data['NumberPatterns'][$type]);
		else
			$this->pattern = $this->parsePattern($type);

		$this->pattern['negInfty'] =
			$this->data['NumberElements'][6] .
			$this->data['NumberElements'][9];

		$this->pattern['posInfty'] =
			$this->data['NumberElements'][11] .
			$this->data['NumberElements'][9];
	}

	public function getPattern()
	{
		return $this->pattern;
	}

	/**
	 * Gets the default NumberFormatInfo that is culture-independent
	 * (invariant).
	 * @return NumberFormatInfo default NumberFormatInfo.
	 */
	public static function getInvariantInfo($type = NumberFormatInfo::DECIMAL)
	{
		static $invariant;
		if($invariant === null)
		{
			$culture = CultureInfo::getInvariantCulture();
			$invariant = $culture->NumberFormat;

The property NumberFormat does not exist on Prado\I18N\core\CultureInfo. Since you implemented __get, consider adding a @property annotation.

			$invariant->setPattern($type);
		}
		return $invariant;
	}

	/**
	 * Returns the NumberFormatInfo associated with the specified culture.

The type Prado\I18N\core\the was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param CultureInfo the culture that gets the NumberFormat property.
	 * @param int the number formatting type, it should be
	 * NumberFormatInfo::DECIMAL, NumberFormatInfo::CURRENCY,
	 * NumberFormatInfo::PERCENTAGE, or NumberFormatInfo::SCIENTIFIC
	 * @return NumberFormatInfo NumberFormatInfo for the specified
	 * culture.
	 * @see getCurrencyInstance();
	 * @see getPercentageInstance();
	 * @see getScientificInstance();
	 */
	public static function getInstance($culture = null,
									   $type = NumberFormatInfo::DECIMAL)
	{
		if ($culture instanceof CultureInfo)
		{
			$formatInfo = $culture->NumberFormat;

The property NumberFormat does not exist on Prado\I18N\core\CultureInfo. Since you implemented __get, consider adding a @property annotation.

			$formatInfo->setPattern($type);
			return $formatInfo;
		}
		   elseif(is_string($culture))
		   {
			   $cultureInfo = new CultureInfo($culture);
			   $formatInfo = $cultureInfo->NumberFormat;
			   $formatInfo->setPattern($type);
			   return $formatInfo;
		   }
		   else
		   {
			$cultureInfo = new CultureInfo();
			   $formatInfo = $cultureInfo->NumberFormat;
			   $formatInfo->setPattern($type);
			   return $formatInfo;
		   }
	}

	/**
	 * Returns the currency format info associated with the specified culture.
	 * @param CultureInfo the culture that gets the NumberFormat property.
	 * @return NumberFormatInfo NumberFormatInfo for the specified
	 * culture.
	 */
	public static function getCurrencyInstance($culture = null)
	{
		return self::getInstance($culture, self::CURRENCY);
	}

	/**
	 * Returns the percentage format info associated with the specified culture.
	 * @param CultureInfo the culture that gets the NumberFormat property.
	 * @return NumberFormatInfo NumberFormatInfo for the specified
	 * culture.
	 */
	public static function getPercentageInstance($culture = null)
	{
		return self::getInstance($culture, self::PERCENTAGE);
	}

	/**
	 * Returns the scientific format info associated with the specified culture.
	 * @param CultureInfo the culture that gets the NumberFormat property.
	 * @return NumberFormatInfo NumberFormatInfo for the specified
	 * culture.
	 */
	public static function getScientificInstance($culture = null)
	{
		return self::getInstance($culture, self::SCIENTIFIC);
	}

	/**
	 * Parse the given pattern and return a list of known properties.

The type Prado\I18N\core\a was not found. Did you mean a? If so, make sure to prefix the type with \.

	 * @param string a number pattern.
	 * @return array list of pattern properties.
	 */
	protected function parsePattern($pattern)
	{
		$pattern = explode(';', $pattern);

		$negative = null;
		if(count($pattern) > 1)
			$negative = $pattern[1];
		$pattern = $pattern[0];

		$comma = ',';
		$dot = '.';
		$digit = '0';
		$hash = '#';

		//find the first group point, and decimal point
		$groupPos1 = strrpos($pattern, $comma);
		$decimalPos = strrpos($pattern, $dot);

		$groupPos2 = false;
		$groupSize1 = false;
		$groupSize2 = false;
		$decimalPoints = is_int($decimalPos)?-1:false;

The condition is_int($decimalPos) can never be false.

		$info['negPref'] = $this->data['NumberElements'][6];

$info was never initialized. Although not strictly required by PHP, it is generally a good practice to add $info = array(); before regardless.

		$info['negPost'] = '';

		$info['negative'] = $negative;
		$info['positive'] = $pattern;

		//find the negative prefix and postfix
		if($negative)
		{
			$prefixPostfix = $this->getPrePostfix($negative);
			$info['negPref'] = $prefixPostfix[0];
			$info['negPost'] = $prefixPostfix[1];
		}

		$posfix = $this->getPrePostfix($pattern);
		$info['posPref'] = $posfix[0];
		$info['posPost'] = $posfix[1];

		//var_dump($pattern);
		//var_dump($decimalPos);
		if(is_int($groupPos1))

The condition is_int($groupPos1) can never be false.

		{
			//get the second group
			$groupPos2 = strrpos(substr($pattern, 0, $groupPos1), $comma);

			//get the number of decimal digits
			if(is_int($decimalPos))

The condition is_int($decimalPos) can never be false.

			{
				$groupSize1 = $decimalPos - $groupPos1 - 1;

			}
			else
			{
				//no decimal point, so traverse from the back
				//to find the groupsize 1.
				for($i = strlen($pattern) - 1; $i >= 0; $i--)
				{
					if($pattern{$i} == $digit || $pattern{$i} == $hash)
					{
						$groupSize1 = $i - $groupPos1;
						break;
					}
				}
			}

			//get the second group size
			if(is_int($groupPos2))

The condition is_int($groupPos2) can never be false.

				$groupSize2 = $groupPos1 - $groupPos2 - 1;
		}

		if(is_int($decimalPos))

The condition is_int($decimalPos) can never be false.

		{
			for($i = strlen($pattern) - 1; $i >= 0; $i--)
			{
				if($pattern{$i} == $dot) break;
				if($pattern{$i} == $digit)
				{
					$decimalPoints = $i - $decimalPos;
					break;
				}
			}
		}

		if(is_int($decimalPos))

The condition is_int($decimalPos) can never be false.

			$digitPattern = substr($pattern, 0, $decimalPos);
		else
			$digitPattern = $pattern;

		$digitPattern = preg_replace('/[^0]/', '', $digitPattern);

		$info['groupPos1'] = $groupPos1;
		$info['groupSize1'] = $groupSize1;
		$info['groupPos2'] = $groupPos2;
		$info['groupSize2'] = $groupSize2;
		$info['decimalPos'] = $decimalPos;
		$info['decimalPoints'] = $decimalPoints;
		$info['digitSize'] = strlen($digitPattern);
		return $info;
	}

	/**
	 * Get the prefix and postfix of a pattern.
	 * @param string pattern
	 * @return array of prefix and postfix, array(prefix,postfix).
	 */
	protected function getPrePostfix($pattern)
	{
		$regexp = '/[#,\.0]+/';
		$result = preg_split($regexp, $pattern);
		return [$result[0],$result[1]];
	}


	/**
	 * Indicates the number of decimal places.
	 * @return int number of decimal places.
	 */
	public function getDecimalDigits()
	{
		return $this->pattern['decimalPoints'];
	}

	/**
	 * Set the number of decimal places.
	 * @param int number of decimal places.
	 */
	public function setDecimalDigits($value)
	{
		return $this->pattern['decimalPoints'] = $value;
	}

	public function getDigitSize()
	{
		return $this->pattern['digitSize'];
	}

	public function setDigitSize($value)
	{
		$this->pattern['digitSize'] = $value;
	}

	/**
	 * Gets the string to use as the decimal separator.
	 * @return string decimal separator.
	 */
	public function getDecimalSeparator()
	{
		return $this->data['NumberElements'][0];
	}

	/**
	 * Set the string to use as the decimal separator.
	 * @param string the decimal point
	 */
	public function setDecimalSeparator($value)
	{
		return $this->data['NumberElements'][0] = $value;
	}

	/**
	 * Gets the string that separates groups of digits to the left
	 * of the decimal in currency values.
	 * @param parameter
	 * @return string currency group separator.
	 */
	public function getGroupSeparator()
	{
		return $this->data['NumberElements'][1];
	}

	/**
	 * Set the string to use as the group separator.
	 * @param string the group separator.
	 */
	public function setGroupSeparator($value)
	{
		return $this->data['NumberElements'][1] = $value;
	}

	/**
	 * Gets the number of digits in each group to the left of the decimal
	 * There can be two grouping sizes, this fucntion
	 * returns <b>array(group1, group2)</b>, if there is only 1 grouping size,
	 * group2 will be false.
	 * @return array grouping size(s).
	 */
	public function getGroupSizes()
	{
		$group1 = $this->pattern['groupSize1'];
		$group2 = $this->pattern['groupSize2'];

		return [$group1, $group2];
	}

	/**
	 * Set the number of digits in each group to the left of the decimal.
	 * There can be two grouping sizes, the value should

The type Prado\I18N\core\grouping was not found. Maybe you did not declare it correctly or list all dependencies?

	 * be an <b>array(group1, group2)</b>, if there is only 1 grouping size,
	 * group2 should be false.
	 * @param array grouping size(s).
	 */
	public function setGroupSizes($groupSize)
	{
		$this->pattern['groupSize1'] = $groupSize[0];
		$this->pattern['groupSize2'] = $groupSize[1];
	}

	/**
	 * Gets the format pattern for negative values.
	 * The negative pattern is composed of a prefix, and postfix.
	 * This function returns <b>array(prefix, postfix)</b>.
	 * @return arary negative pattern.

The type Prado\I18N\core\arary was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function getNegativePattern()
	{
		$prefix = $this->pattern['negPref'];
		$postfix = $this->pattern['negPost'];
		return [$prefix, $postfix];

The expression return array($prefix, $postfix) returns the type array which is incompatible with the documented return type Prado\I18N\core\arary.

	}

	/**
	 * Set the format pattern for negative values.

The type Prado\I18N\core\negative was not found. Maybe you did not declare it correctly or list all dependencies?

	 * The negative pattern is composed of a prefix, and postfix in the form
	 * <b>array(prefix, postfix)</b>.
	 * @param arary negative pattern.
	 */
	public function setNegativePattern($pattern)
	{
		$this->pattern['negPref'] = $pattern[0];
		$this->pattern['negPost'] = $pattern[1];
	}

	/**
	 * Gets the format pattern for positive values.
	 * The positive pattern is composed of a prefix, and postfix.
	 * This function returns <b>array(prefix, postfix)</b>.
	 * @return arary positive pattern.
	 */
	public function getPositivePattern()
	{
		$prefix = $this->pattern['posPref'];
		$postfix = $this->pattern['posPost'];
		return [$prefix, $postfix];

The expression return array($prefix, $postfix) returns the type array which is incompatible with the documented return type Prado\I18N\core\arary.

	}

	/**
	 * Set the format pattern for positive values.

The type Prado\I18N\core\positive was not found. Maybe you did not declare it correctly or list all dependencies?

	 * The positive pattern is composed of a prefix, and postfix in the form
	 * <b>array(prefix, postfix)</b>.
	 * @param arary positive pattern.
	 */
	public function setPositivePattern($pattern)
	{
		$this->pattern['posPref'] = $pattern[0];
		$this->pattern['posPost'] = $pattern[1];
	}

	/**
	 * Gets the string to use as the currency symbol.
	 * @return string currency symbol.
	 */
	public function getCurrencySymbol($currency = 'USD')
	{
		if(isset($this->pattern['symbol']))
			return $this->pattern['symbol'];
		else
			return $this->data['Currencies'][$currency][0];
	}


	/**
	 * Set the string to use as the currency symbol.

The type Prado\I18N\core\currency was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param string currency symbol.
	 */
	public function setCurrencySymbol($symbol)
	{
		$this->pattern['symbol'] = $symbol;
	}

	/**
	 * Gets the string that represents negative infinity.
	 * @return string negative infinity.
	 */
	public function getNegativeInfinitySymbol()
	{
		return $this->pattern['negInfty'];
	}

	/**
	 * Set the string that represents negative infinity.
	 * @param string negative infinity.
	 */
	public function setNegativeInfinitySymbol($value)
	{
		$this->pattern['negInfty'] = $value;
	}

	/**
	 * Gets the string that represents positive infinity.
	 * @return string positive infinity.
	 */
	public function getPositiveInfinitySymbol()
	{
		return $this->pattern['posInfty'];
	}

	/**
	 * Set the string that represents positive infinity.
	 * @param string positive infinity.
	 */
	public function setPositiveInfinitySymbol($value)
	{
		$this->pattern['posInfty'] = $value;
	}

	/**
	 * Gets the string that denotes that the associated number is negative.
	 * @return string negative sign.
	 */
	public function getNegativeSign()
	{
		return $this->data['NumberElements'][6];
	}

	/**
	 * Set the string that denotes that the associated number is negative.
	 * @param string negative sign.
	 */
	public function setNegativeSign($value)
	{
		$this->data['NumberElements'][6] = $value;
	}

	/**
	 * Gets the string that denotes that the associated number is positive.
	 * @return string positive sign.
	 */
	public function getPositiveSign()
	{
		return $this->data['NumberElements'][11];
	}

	/**
	 * Set the string that denotes that the associated number is positive.
	 * @param string positive sign.
	 */
	public function setPositiveSign($value)
	{
		$this->data['NumberElements'][11] = $value;
	}

	/**
	 * Gets the string that represents the IEEE NaN (not a number) value.
	 * @return string NaN symbol.
	 */
	public function getNaNSymbol()
	{
		return $this->data['NumberElements'][10];
	}

	/**
	 * Set the string that represents the IEEE NaN (not a number) value.

The type Prado\I18N\core\NaN was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param string NaN symbol.
	 */
	public function setNaNSymbol($value)
	{
		$this->data['NumberElements'][10] = $value;
	}

	/**
	 * Gets the string to use as the percent symbol.
	 * @return string percent symbol.
	 */
	public function getPercentSymbol()
	{
		return $this->data['NumberElements'][3];
	}

	/**
	 * Set the string to use as the percent symbol.

The type Prado\I18N\core\percent was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param string percent symbol.
	 */
	public function setPercentSymbol($value)
	{
		$this->data['NumberElements'][3] = $value;
	}

	/**
	 * Gets the string to use as the per mille symbol.
	 * @return string percent symbol.
	 */
	public function getPerMilleSymbol()
	{
		return $this->data['NumberElements'][8];
	}

	/**
	 * Set the string to use as the per mille symbol.
	 * @param string percent symbol.
	 */
	public function setPerMilleSymbol($value)
	{
		$this->data['NumberElements'][8] = $value;
	}
}