|
Server : Apache System : Linux srv.rainic.com 4.18.0-553.47.1.el8_10.x86_64 #1 SMP Wed Apr 2 05:45:37 EDT 2025 x86_64 User : rainic ( 1014) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/akaindir/public_html/crm/include/fields/ |
Upload File : |
<?php
/*+**********************************************************************************
* The contents of this file are subject to the vtiger CRM Public License Version 1.0
* ("License"); You may not use this file except in compliance with the License
* The Original Code is: vtiger CRM Open Source
* The Initial Developer of the Original Code is vtiger.
* Portions created by vtiger are Copyright (C) vtiger.
* All Rights Reserved.
************************************************************************************/
class CurrencyField {
private $CURRENCY_PATTERN_PLAIN = '123456789';
private $CURRENCY_PATTERN_SINGLE_GROUPING = '123456,789';
private $CURRENCY_PATTERN_THOUSAND_GROUPING = '123,456,789';
private $CURRENCY_PATTERN_MIXED_GROUPING = '12,34,56,789';
/**
* Currency Format(3,3,3) or (2,2,3)
* @var String
*/
var $currencyFormat = '123,456,789';
/**
* Currency Separator for example (comma, dot, hash)
* @var String
*/
var $currencySeparator = ',';
/**
* Decimal Separator for example (dot, comma, space)
* @var <type>
*/
var $decimalSeparator = '.';
/**
* Number of Decimal Numbers
* @var Integer
*/
var $numberOfDecimal = 3;
/**
* Currency Id
* @var Integer
*/
var $currencyId = 1;
/**
* Currency Symbol
* @var String
*/
var $currencySymbol;
/**
* Currency Symbol Placement
*/
var $currencySymbolPlacement;
/**
* Currency Conversion Rate
* @var Number
*/
var $conversionRate = 1;
/**
* Value to be converted
* @param Number $value
*/
var $value = null;
/**
* Maximum Number Of Currency Decimals
* @var Number
*/
var $maxNumberOfDecimals = 5;
/**
* Constructor
* @param Number $value
*/
public function __construct($value) {
$this->value = $value;
}
/**
* Initializes the User's Currency Details
* @global Users $current_user
* @param Users $user
*/
public function initialize($user=null) {
global $current_user,$default_charset;
if(empty($user)) {
$user = $current_user;
}
if(!empty($user->currency_grouping_pattern)) {
$this->currencyFormat = html_entity_decode($user->currency_grouping_pattern, ENT_QUOTES, $default_charset);
$this->currencySeparator = str_replace("\xC2\xA0", ' ', html_entity_decode($user->currency_grouping_separator, ENT_QUOTES, $default_charset));
$this->decimalSeparator = str_replace("\xC2\xA0", ' ', html_entity_decode($user->currency_decimal_separator, ENT_QUOTES, $default_charset));
}
if(!empty($user->currency_id)) {
$this->currencyId = $user->currency_id;
} else {
$this->currencyId = self::getDBCurrencyId();
}
$currencyRateAndSymbol = getCurrencySymbolandCRate($this->currencyId);
$this->currencySymbol = $currencyRateAndSymbol['symbol'];
$this->conversionRate = $currencyRateAndSymbol['rate'];
$this->currencySymbolPlacement = $user->currency_symbol_placement;
$this->numberOfDecimal = getCurrencyDecimalPlaces($user);
}
public function getCurrencySymbol() {
return $this->currencySymbol;
}
/**
* Returns the Formatted Currency value for the User
* @global Users $current_user
* @param Users $user
* @param Boolean $skipConversion
* @return String - Formatted Currency
*/
public static function convertToUserFormat($value, $user=null, $skipConversion=false, $skipFormatting=false) {
// To support negative values
$negative = false;
if(stripos($value, '-') === 0) {
$negative = true;
$value = substr($value, 1);
}
$self = new self($value);
$value = $self->getDisplayValue($user,$skipConversion,$skipFormatting);
return ($negative) ? '-'.$value : $value;
}
/**
* Function that converts the Number into Users Currency
* @param Users $user
* @param Boolean $skipConversion
* @return Formatted Currency
*/
public function getDisplayValue($user=null, $skipConversion=false, $skipFormatting=false) {
global $current_user;
if(empty($user)) {
$user = $current_user;
}
$this->initialize($user);
$value = $this->value;
if($skipConversion == false) {
$value = self::convertFromDollar($value,$this->conversionRate);
}
if($skipFormatting == false) {
$value = $this->_formatCurrencyValue($value);
}
return $this->currencyDecimalFormat($value, $user);
}
/**
* Function that converts the Number into Users Currency along with currency symbol
* @param Users $user
* @param Boolean $skipConversion
* @return Formatted Currency
*/
public function getDisplayValueWithSymbol($user=null, $skipConversion=false) {
$formattedValue = $this->getDisplayValue($user, $skipConversion);
return self::appendCurrencySymbol($formattedValue, $this->currencySymbol, $this->currencySymbolPlacement);
}
/**
* Static Function that appends the currency symbol to a given currency value, based on the preferred symbol placement
* @param Number $currencyValue
* @param String $currencySymbol
* @param String $currencySymbolPlacement
* @return Currency value appended with the currency symbol
*/
public static function appendCurrencySymbol($currencyValue, $currencySymbol, $currencySymbolPlacement='') {
global $current_user;
if(empty($currencySymbolPlacement)) {
$currencySymbolPlacement = $current_user->currency_symbol_placement;
}
switch($currencySymbolPlacement) {
case '1.0$' : $returnValue = $currencyValue . $currencySymbol;
break;
case '$1.0' :
default : $returnValue = $currencySymbol . $currencyValue;
}
return $returnValue;
}
/**
* Function that formats the Number based on the User configured Pattern, Currency separator and Decimal separator
* @param Number $value
* @return Formatted Currency
*/
private function _formatCurrencyValue($value) {
if(empty($value)) {
$value = 0;
}
$currencyPattern = $this->currencyFormat;
$currencySeparator = $this->currencySeparator;
$decimalSeparator = $this->decimalSeparator;
$currencyDecimalPlaces = $this->numberOfDecimal;
$value = number_format($value, $currencyDecimalPlaces,'.','');
if(empty($currencySeparator)) $currencySeparator = ' ';
if(empty($decimalSeparator)) $decimalSeparator = ' ';
if($currencyPattern == $this->CURRENCY_PATTERN_PLAIN) {
// Replace '.' with Decimal Separator
$number = str_replace('.', $decimalSeparator, $value);
return $number;
}
if($currencyPattern == $this->CURRENCY_PATTERN_SINGLE_GROUPING) {
// Separate the numeric and decimal parts
$numericParts = explode('.', $value);
$wholeNumber = $numericParts[0];
// First part of the number which remains intact
if(strlen($wholeNumber) > 3) {
$wholeNumberFirstPart = substr($wholeNumber,0,strlen($wholeNumber)-3);
}
// Second Part of the number (last 3 digits) which should be separated from the First part using Currency Separator
$wholeNumberLastPart = substr($wholeNumber,-3);
// Re-create the whole number with user's configured currency separator
if(!empty($wholeNumberFirstPart)) {
$numericParts[0] = $wholeNumberFirstPart.$currencySeparator.$wholeNumberLastPart;
} else {
$numericParts[0] = $wholeNumberLastPart;
}
// Re-create the currency value combining the whole number and the decimal part using Decimal separator
$number = implode($decimalSeparator, $numericParts);
return $number;
}
if($currencyPattern == $this->CURRENCY_PATTERN_THOUSAND_GROUPING) {
$negativeNumber = false;
if($value < 0) {
$negativeNumber = true;
}
// Separate the numeric and decimal parts
$numericParts = explode('.', $value);
$wholeNumber = $numericParts[0];
//check the whole number is negative value, then separate the negative symbol from whole number
if($wholeNumber < 0 || $negativeNumber) {
$negativeNumber = true;
$positiveValues = explode('-', $wholeNumber);
$wholeNumber = $positiveValues[1];
}
// Pad the rest of the length in the number string with Leading 0, to get it to the multiples of 3
$numberLength = strlen($wholeNumber);
// First grouping digits length
$OddGroupLength = $numberLength%3;
$gapsToBeFilled = 0;
if($OddGroupLength > 0) $gapsToBeFilled = 3 - $OddGroupLength;
$wholeNumber = str_pad($wholeNumber, $numberLength+$gapsToBeFilled, '0', STR_PAD_LEFT);
// Split the whole number into chunks of 3 digits
$wholeNumberParts = str_split($wholeNumber,3);
// Re-create the whole number with user's configured currency separator
$numericParts[0] = $wholeNumber = implode($currencySeparator, $wholeNumberParts);
if($wholeNumber != 0) {
$numericParts[0] = ltrim($wholeNumber, '0');
} else {
$numericParts[0] = 0;
}
//if its negative number, append-back the negative symbol to the whole number part
if($negativeNumber) {
$numericParts[0] = '-'.$numericParts[0];
}
// Re-create the currency value combining the whole number and the decimal part using Decimal separator
$number = implode($decimalSeparator, $numericParts);
return $number;
}
if($currencyPattern == $this->CURRENCY_PATTERN_MIXED_GROUPING) {
$negativeNumber = false;
if($value < 0) {
$negativeNumber = true;
}
// Separate the numeric and decimal parts
$numericParts = explode('.', $value);
$wholeNumber = $numericParts[0];
//check the whole number is negative value, then separate the negative symbol from whole number
if($wholeNumber < 0 || $negativeNumber) {
$negativeNumber = true;
$positiveValues = explode('-', $wholeNumber);
$wholeNumber = $positiveValues[1];
}
// First part of the number which needs separate division
if(strlen($wholeNumber) > 3) {
$wholeNumberFirstPart = substr($wholeNumber,0,strlen($wholeNumber)-3);
}
// Second Part of the number (last 3 digits) which should be separated from the First part using Currency Separator
$wholeNumberLastPart = substr($wholeNumber,-3);
if(!empty($wholeNumberFirstPart)) {
// Pad the rest of the length in the number string with Leading 0, to get it to the multiples of 2
$numberLength = strlen($wholeNumberFirstPart);
// First grouping digits length
$OddGroupLength = $numberLength%2;
$gapsToBeFilled = 0;
if($OddGroupLength > 0) $gapsToBeFilled = 2 - $OddGroupLength;
$wholeNumberFirstPart = str_pad($wholeNumberFirstPart, $numberLength+$gapsToBeFilled, '0', STR_PAD_LEFT);
// Split the first part of tne number into chunks of 2 digits
$wholeNumberFirstPartElements = str_split($wholeNumberFirstPart,2);
$wholeNumberFirstPart = ltrim(implode($currencySeparator, $wholeNumberFirstPartElements), '0');
$wholeNumberFirstPart = implode($currencySeparator, $wholeNumberFirstPartElements);
if($wholeNumberFirstPart != 0) {
$wholeNumberFirstPart = ltrim($wholeNumberFirstPart, '0');
} else {
$wholeNumberFirstPart = 0;
}
// Re-create the whole number with user's configured currency separator
$numericParts[0] = $wholeNumberFirstPart.$currencySeparator.$wholeNumberLastPart;
} else {
$numericParts[0] = $wholeNumberLastPart;
}
//if its negative number, append-back the negative symbol to the whole number part
if($negativeNumber) {
$numericParts[0] = '-'.$numericParts[0];
}
// Re-create the currency value combining the whole number and the decimal part using Decimal separator
$number = implode($decimalSeparator, $numericParts);
return $number;
}
return $number;
}
/**
* Returns the Currency value without formatting for DB Operations
* @global Users $current_user
* @param Users $user
* @param Boolean $skipConversion
* @return Number
*/
public function getDBInsertedValue($user=null, $skipConversion=false) {
global $current_user;
if(empty($user)) {
$user = $current_user;
}
$this->initialize($user);
$value = $this->value;
$currencySeparator = $this->currencySeparator;
$decimalSeparator = $this->decimalSeparator;
if(empty($currencySeparator)) $currencySeparator = ' ';
if(empty($decimalSeparator)) $decimalSeparator = ' ';
$value = str_replace("$currencySeparator", "", $value);
$value = str_replace("$decimalSeparator", ".", $value);
if($skipConversion == false) {
$value = self::convertToDollar($value,$this->conversionRate);
}
//$value = round($value, $this->maxNumberOfDecimals);
return $value;
}
/**
* Returns the Currency value without formatting for DB Operations
* @param Number $value
* @param Users $user
* @param Boolean $skipConversion
* @return Number
*/
public static function convertToDBFormat($value, $user=null, $skipConversion=false) {
$self = new self($value);
return $self->getDBInsertedValue($user, $skipConversion);
}
/**
* Function to get the default CRM currency
* @return Integer Default system currency id
*/
public static function getDBCurrencyId() {
$adb = PearDatabase::getInstance();
$result = $adb->pquery('SELECT id FROM vtiger_currency_info WHERE defaultid < 0', array());
$noOfRows = $adb->num_rows($result);
if($noOfRows > 0) {
return $adb->query_result($result, 0, 'id');
}
return null;
}
/**
* Function to get the currencyInfo with currencyName
* @return CurrencyId
*/
public static function getCurrencyInfoFromName($currencyName) {
$db = PearDatabase::getInstance();
$currencyInfo = array();
$result = $db->pquery('SELECT * FROM vtiger_currency_info WHERE currency_name=?', array(trim($currencyName)));
if ($db->num_rows($result) > 0) {
$currencyInfo = $db->fetch_array($result);
}
return $currencyInfo;
}
public static function convertToDollar($amount, $conversionRate) {
if ($conversionRate == 0) return 0;
return $amount / $conversionRate;
}
public static function convertFromDollar($amount, $conversionRate) {
$currencyField = new CurrencyField($amount);
return round($amount * $conversionRate, $currencyField->maxNumberOfDecimals);
}
/** This function returns the amount converted from master currency.
* param $amount - amount to be converted.
* param $crate - conversion rate.
*/
public static function convertFromMasterCurrency($amount, $conversionRate) {
return $amount * $conversionRate;
}
function currencyDecimalFormat($value, $user = null){
global $current_user;
if (!$user) {
$user = $current_user;
}
if($user->truncate_trailing_zeros == true) {
if(strpos($value, $user->currency_decimal_separator) != 0){
/**
* We should trim extra zero's if only the value had decimal separator(Ex :- 1600.00)
* else it'll change orginal value
*/
$value = rtrim($value, '0');
}
if($user->currency_decimal_separator == ' ') {
$value = rtrim($value, '0');
$decimalSeparator = ' ';
} else {
$decimalSeparator = $user->currency_decimal_separator;
}
$fieldValue = explode(decode_html($decimalSeparator), $value);
if(strlen($fieldValue[1]) <= 1){
if(strlen($fieldValue[1]) == 1) {
return $value = $fieldValue[0].$decimalSeparator.$fieldValue[1];
} else if (!strlen($fieldValue[1])) {
return $value = $fieldValue[0];
} else {
return $value = $fieldValue[0].$decimalSeparator;
}
}else{
return preg_replace("/(?<=\\.[0-9])[0]+\$/","",$value);
}
}else{
return $value;
}
}
}
?>