MultiCurrency Class Reference

Class Currency. More...

Inheritance diagram for MultiCurrency:

Collaboration diagram for MultiCurrency:

Public Member Functions
	__construct (DoliDB $db)
	Constructor. More...
	create (User $user, $trigger=true)
	Create object into database. More...
	fetch ($id, $code=null)
	Load object in memory from the database. More...
	fetchAllCurrencyRate ()
	Load all rates in object from the database. More...
	update (User $user, $trigger=true)
	Update object into database. More...
	delete ($trigger=true)
	Delete object in database. More...
	deleteRates ()
	Delete rates in database. More...
	addRate ($rate)
	Add a Rate into database. More...
	addRateFromDolibarr ($code, $rate)
	Try get label of code in llx_currency then add rate. More...
	updateRate ($rate)
	Add new entry into llx_multicurrency_rate. More...
	getRate ()
	Fetch CurrencyRate object in $this->rate. More...
Public Member Functions inherited from CommonObject
	errorsToString ()
	Method to output saved errors. More...
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output. More...
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output. More...
	getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
	Return full name (civility+' '+name+' '+lastname) More...
	setUpperOrLowerCase ()
	Set to upper or ucwords/lower if needed. More...
	getKanbanView ($option= '')
	Return clicable link of object (with eventually picto) More...
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode= '')
	Return full address of contact. More...
	getBannerAddress ($htmlkey, $object)
	Return full address for banner. More...
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download. More...
	add_contact ($fk_socpeople, $type_contact, $source= 'external', $notrigger=0)
	Add a link between element $this->element and a contact. More...
	copy_linked_contact ($objFrom, $source= 'internal')
	Copy contact from one element to current. More...
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line. More...
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line. More...
	delete_linked_contact ($source= '', $code= '')
	Delete all links between an object $this and all its contacts. More...
	liste_contact ($status=-1, $source= 'external', $list=0, $code= '')
	Get array of all contacts for an object. More...
	swapContactStatus ($rowid)
	Update status of a contact linked to object. More...
	liste_type_contact ($source= 'internal', $order= 'position', $option=0, $activeonly=0, $code= '')
	Return array with list of possible values for type of contacts. More...
	listeTypeContacts ($source= 'internal', $option=0, $activeonly=0, $code= '', $element= '', $excludeelement= '')
	Return array with list of possible values for type of contacts. More...
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code. More...
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact. More...
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
	fetch_projet ()
	Load the project with id $this->fk_project into this->project. More...
	fetch_product ()
	Load the product with id $this->fk_product into this->product. More...
	fetch_user ($userid)
	Load the user with id $userid into this->user. More...
	fetch_origin ()
	Read linked origin object. More...
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field. More...
	getValueFrom ($table, $id, $field)
	Getter generic. More...
	setValueFrom ($field, $value, $table= '', $id=null, $format= '', $id_field= '', $fuser=null, $trigkey= '', $fk_user_field= 'fk_user_modif')
	Setter generic. More...
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
	getListContactId ($source= 'external')
	Return list of id of contacts of object. More...
	setProject ($projectid)
	Link element with a project. More...
	setPaymentMethods ($id)
	Change the payments methods. More...
	setMulticurrencyCode ($code)
	Change the multicurrency code. More...
	setMulticurrencyRate ($rate, $mode=1)
	Change the multicurrency rate. More...
	setPaymentTerms ($id)
	Change the payments terms. More...
	setTransportMode ($id)
	Change the transport mode methods. More...
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms. More...
	setDeliveryAddress ($id)
	Define delivery address. More...
	setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
	Change the shipping method. More...
	setWarehouse ($warehouse_id)
	Change the warehouse. More...
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator. More...
	setBankAccount ($fk_account, $notrigger=false, $userused=null)
	Change the bank account. More...
	line_order ($renum=false, $rowidorder= 'ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines. More...
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line. More...
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank. More...
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank. More...
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang) More...
	line_ajaxorder ($rows)
	Update position of line with ajax (rang) More...
	updateLineUp ($rowid, $rang)
	Update position of line up (rang) More...
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang) More...
	getRangOfLine ($rowid)
	Get position of line (rang) More...
	getIdOfLine ($rang)
	Get rowid of the line relative to its position. More...
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang) More...
	update_ref_ext ($ref_ext)
	Update external ref of element. More...
	update_note ($note, $suffix= '')
	Update note of element. More...
	update_note_public ($note)
	Update public note (kept for backward compatibility) More...
	update_price ($exclspec=0, $roundingadjust= 'none', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
	add_object_linked ($origin=null, $origin_id=null)
	Add objects linked in llx_element_element. More...
	fetchObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $clause= 'OR', $alsosametype=1, $orderby= 'sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only). More...
	updateObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '')
	Update object linked of a current object. More...
	deleteObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $rowid= '')
	Delete all links between an object $this. More...
	setStatut ($status, $elementId=null, $elementType= '', $trigkey= '')
	Set status of an object. More...
	getCanvas ($id=0, $ref= '')
	Load type of canvas of an object if it exists. More...
	getSpecialCode ($lineid)
	Get special code of a line. More...
	isObjectUsed ($id=0)
	Function to check if an object is used by others. More...
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains. More...
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines. More...
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
	setExtraParameters ()
	Set extra parameters. More...
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir= '/core/tpl')
	Show add free and predefined products/services form. More...
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir= '/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir= '/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
	printOriginLinesList ($restrictlist= '', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
	printOriginLine ($line, $var, $restrictlist= '', $defaulttpldir= '/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line. More...
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references. More...
	addThumbs ($file)
	Build thumb. More...
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
	Return the default value to use for a field when showing the create form of object. More...
	call_trigger ($triggerName, $user)
	Call trigger based on this instance. More...
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. More...
	setValuesForExtraLanguages ($onlykey= '')
	Fill array_options property of object by extrafields value (using for data sent by forms) More...
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before. More...
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
	deleteExtraFields ()
	Delete all extra fields values for the current object. More...
	insertExtraFields ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...
	insertExtraLanguages ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object. More...
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object. More...
	showInputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
	showOutputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss= '')
	Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
	showOptionals ($extrafields, $mode= 'view', $params=null, $keysuffix= '', $keyprefix= '', $onetrtd=0)
	Function to show lines of extrafields with output datas. More...
	getJSListDependancies ($type= '_extra')
	getRights ()
	Returns the rights used for this class. More...
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation. More...
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
	Show photos of an object (nbmax maximum), into several columns. More...
	isDate ($info)
	Function test if type is date. More...
	isDuration ($info)
	Function test if type is duration. More...
	isInt ($info)
	Function test if type is integer. More...
	isFloat ($info)
	Function test if type is float. More...
	isText ($info)
	Function test if type is text. More...
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this. More...
	createCommon (User $user, $notrigger=false)
	Create object into database. More...
	fetchCommon ($id, $ref=null, $morewhere= '')
	Load object in memory from the database. More...
	fetchLinesCommon ($morewhere= '')
	Load object in memory from the database. More...
	updateCommon (User $user, $notrigger=false)
	Update object into database. More...
	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database. More...
	deleteByParentField ($parentId=0, $parentField= '')
	Delete all child object from a parent ID. More...
	deleteLineCommon (User $user, $idline, $notrigger=false)
	Delete a line of object in database. More...
	setStatusCommon ($user, $status, $notrigger=0, $triggercode= '')
	Set to a status. More...
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen. More...
	fetchComments ()
	Load comments linked with current task. More...
	getNbComments ()
	Return nb comments already posted. More...
	trimParameters ($parameters)
	Trim object parameters. More...
	getCategoriesCommon ($type_categ)
	Sets object to given categories. More...
	setCategoriesCommon ($categories, $type_categ)
	Sets object to given categories. More...
	cloneCategories ($fromId, $toId, $type= '')
	Copy related categories to another object. More...
	deleteEcmFiles ($mode=0)
	Delete related files of object in database. More...

Static Public Member Functions
static	getIdFromCode ($db, $code)
	Get id of currency from code. More...
static	getIdAndTxFromCode ($db, $code, $date_document= '')
	Get id and rate of currency from code. More...
static	getAmountConversionFromInvoiceRate ($fk_facture, $amount, $way= 'dolibarr', $table= 'facture')
	Get the conversion of amount with invoice rate. More...
static	getInvoiceRate ($fk_facture, $table= 'facture')
	Get current invoite rate. More...
static	recalculRates (&$TRate)
	With free account we can't set source then recalcul all rates to force another source. More...
static	syncRates ($key, $addifnotfound=0)
	Sync rates from API. More...
static	checkCodeAlreadyExists ($code)
	Check in database if the current code already exists. More...
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref= '', $ref_ext= '')
	Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
static	commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one. More...

Additional Inherited Members
Public Attributes inherited from CommonObject
	$projet
	$note
Protected Member Functions inherited from CommonObject
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents. More...
	isArray ($info)
	Function test if type is array. More...
	canBeNull ($info)
	Function test if field can be null. More...
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty. More...
	isIndex ($info)
	Function test if is indexed. More...
	setSaveQuery ()
	Function to prepare a part of the query for insert. More...
	getFieldList ()
	Function to concat keys of fields. More...
	quote ($value, $fieldsentry)
	Add quote to field value if necessary. More...

Detailed Description

Class Currency.

Put here description of your class

See Also

CommonObject

Definition at line 39 of file multicurrency.class.php.

Constructor & Destructor Documentation

MultiCurrency::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDb

$db

Database handler

Definition at line 102 of file multicurrency.class.php.

References db.

Member Function Documentation

MultiCurrency::addRate

(

$rate

)

Add a Rate into database.

Parameters

double

$rate

rate value

Returns

int -1 if KO, 1 if OK

Definition at line 403 of file multicurrency.class.php.

References db, and price2num().

Referenced by updateRate().

MultiCurrency::addRateFromDolibarr	(		$code,
			$rate
	)

Try get label of code in llx_currency then add rate.

Parameters

string	$code	currency code
double	$rate	new rate

Returns

int -1 if KO, 1 if OK, 2 if label found and OK

Definition at line 426 of file multicurrency.class.php.

References $resql, db, and dol_syslog().

static MultiCurrency::checkCodeAlreadyExists (   $code )

static

Check in database if the current code already exists.

Parameters

string

$code

current code to search

Returns

boolean True if exists, false if not exists

Definition at line 682 of file multicurrency.class.php.

Referenced by modMultiCurrency\createFirstCurrency().

MultiCurrency::create	(	User	$user,
			$trigger = true
	)

Create object into database.

Parameters

User	$user	User that creates
bool	$trigger	true=launch triggers after, false=disable triggers

Returns

int <0 if KO, Id of created object if OK

Definition at line 116 of file multicurrency.class.php.

References $resql, CommonObject\call_trigger(), code, db, dol_syslog(), and name.

MultiCurrency::delete

(

$trigger = true

)

Delete object in database.

Parameters

bool

$trigger

true=launch triggers after, false=disable triggers

Returns

int <0 if KO, >0 if OK

Definition at line 332 of file multicurrency.class.php.

References $resql, CommonObject\call_trigger(), db, deleteRates(), and dol_syslog().

MultiCurrency::deleteRates

(

)

Delete rates in database.

Returns

bool false if KO, true if OK

Definition at line 384 of file multicurrency.class.php.

Referenced by delete().

MultiCurrency::fetch	(		$id,
			$code = null
	)

Load object in memory from the database.

Parameters

int	$id	Id object
string	$code	code

Returns

int <0 if KO, 0 if not found, >0 if OK

Definition at line 188 of file multicurrency.class.php.

References dol_syslog().

MultiCurrency::fetchAllCurrencyRate

(

)

Load all rates in object from the database.

Returns

int <0 if KO, >=0 if OK

Definition at line 238 of file multicurrency.class.php.

static MultiCurrency::getAmountConversionFromInvoiceRate (   $fk_facture,   $amount,   $way = 'dolibarr',   $table = 'facture'  )

static

Get the conversion of amount with invoice rate.

Parameters

int	$fk_facture	id of facture
double	$amount	amount to convert
string	$way	'dolibarr' mean the amount is in dolibarr currency
string	$table	facture or facture_fourn

Returns

double amount converted

Definition at line 555 of file multicurrency.class.php.

References price2num().

static MultiCurrency::getIdAndTxFromCode (   $db,   $code,   $date_document = ''  )

static

Get id and rate of currency from code.

Parameters

DoliDB	$db	Object db
string	$code	Code value search
integer	$date_document	Date from document (propal, order, invoice, ...)

Returns

array [0] => id currency [1] => rate

Definition at line 515 of file multicurrency.class.php.

References $resql, dol_getdate(), dol_mktime(), and dol_syslog().

Referenced by FactureFournisseur\create(), Facture\create(), SupplierProposal\create(), Commande\create(), Propal\create(), CommandeFournisseur\create(), CommandeFournisseurLigne\insert(), and SupplierProposal\updateOrCreatePriceFournisseur().

static MultiCurrency::getIdFromCode (   $db,   $code  )

static

Get id of currency from code.

Parameters

DoliDB	$db	object db
string	$code	code value search

Returns

int 0 if not found, >0 if OK

Definition at line 493 of file multicurrency.class.php.

References $resql, and dol_syslog().

Referenced by FactureFournisseur\create(), Facture\create(), Societe\create(), Commande\create(), Propal\create(), CommandeFournisseur\create(), Societe\update(), and ProductFournisseur\update_buyprice().

static MultiCurrency::getInvoiceRate (   $fk_facture,   $table = 'facture'  )

static

Get current invoite rate.

Parameters

int	$fk_facture	id of facture
string	$table	facture or facture_fourn

Returns

bool

Definition at line 573 of file multicurrency.class.php.

References $resql, and dol_syslog().

MultiCurrency::getRate

(

)

Fetch CurrencyRate object in $this->rate.

Returns

int <0 if KO, 0 if not found, >0 if OK

Definition at line 470 of file multicurrency.class.php.

References $resql, db, and dol_syslog().

static MultiCurrency::recalculRates ( &  $TRate )

static

With free account we can't set source then recalcul all rates to force another source.

This modify the array &$TRate.

Parameters

stdClass

$TRate

Object containing all currencies rates

Returns

int -1 if KO, 0 if nothing, 1 if OK

Definition at line 596 of file multicurrency.class.php.

static MultiCurrency::syncRates (   $key,   $addifnotfound = 0  )

static

Sync rates from API.

Parameters

string	$key	Key to use. Come from $conf->global->MULTICURRENCY_APP_ID.
int	$addifnotfound	Add if not found

Returns

int <0 if KO, >0 if OK

Definition at line 627 of file multicurrency.class.php.

References dol_syslog(), getURLContent(), and setEventMessages().

MultiCurrency::update	(	User	$user,
			$trigger = true
	)

Update object into database.

Parameters

User	$user	User that modifies
bool	$trigger	true=launch triggers after, false=disable triggers

Returns

int <0 if KO, >0 if OK

Definition at line 276 of file multicurrency.class.php.

References dol_syslog().

MultiCurrency::updateRate

(

$rate

)

Add new entry into llx_multicurrency_rate.

Parameters

double

$rate

rate value

Returns

int <0 if KO, >0 if OK

Definition at line 460 of file multicurrency.class.php.

References addRate().

---

The documentation for this class was generated from the following file:

• htdocs/multicurrency/class/multicurrency.class.php