[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/include/fields/ -> CurrencyField.php (summary)

(no description)

File Size: 439 lines (15 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CurrencyField:: (15 methods):
  __construct()
  initialize()
  getCurrencySymbol()
  convertToUserFormat()
  getDisplayValue()
  getDisplayValueWithSymbol()
  appendCurrencySymbol()
  _formatCurrencyValue()
  getDBInsertedValue()
  convertToDBFormat()
  getDBCurrencyId()
  convertToDollar()
  convertFromDollar()
  convertFromMasterCurrency()
  currencyDecimalFormat()


Class: CurrencyField  - X-Ref

__construct($value)   X-Ref
Constructor

param: Number $value

initialize($user=null)   X-Ref
Initializes the User's Currency Details

param: Users $user

getCurrencySymbol()   X-Ref
No description

convertToUserFormat($value, $user=null, $skipConversion=false, $skipFormatting=false)   X-Ref
Returns the Formatted Currency value for the User

param: Users $user
param: Boolean $skipConversion
return: String - Formatted Currency

getDisplayValue($user=null, $skipConversion=false, $skipFormatting=false)   X-Ref
Function that converts the Number into Users Currency

param: Users $user
param: Boolean $skipConversion
return: Formatted Currency

getDisplayValueWithSymbol($user=null, $skipConversion=false)   X-Ref
Function that converts the Number into Users Currency along with currency symbol

param: Users $user
param: Boolean $skipConversion
return: Formatted Currency

appendCurrencySymbol($currencyValue, $currencySymbol, $currencySymbolPlacement='')   X-Ref
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

_formatCurrencyValue($value)   X-Ref
Function that formats the Number based on the User configured Pattern, Currency separator and Decimal separator

param: Number $value
return: Formatted Currency

getDBInsertedValue($user=null, $skipConversion=false)   X-Ref
Returns the Currency value without formatting for DB Operations

param: Users $user
param: Boolean $skipConversion
return: Number

convertToDBFormat($value, $user=null, $skipConversion=false)   X-Ref
Returns the Currency value without formatting for DB Operations

param: Number $value
param: Users $user
param: Boolean $skipConversion
return: Number

getDBCurrencyId()   X-Ref
Function to get the default CRM currency

return: Integer Default system currency id

convertToDollar($amount, $conversionRate)   X-Ref
No description

convertFromDollar($amount, $conversionRate)   X-Ref
No description

convertFromMasterCurrency($amount, $conversionRate)   X-Ref
No description

currencyDecimalFormat($value, $user = null)   X-Ref
No description



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1