ModeleAccountancyCode Class Reference

Parent class for third parties accountancy code generators. More...

Inheritance diagram for ModeleAccountancyCode:

Collaboration diagram for ModeleAccountancyCode:

Public Member Functions
	getToolTip ($langs, $soc, $type)
	Return description of module parameters.
	get_code ($db, $societe, $type='')
	Set accountancy account code for a third party into this->code.
	getExample ($langs=null, $objsoc='', $type=-1)
	Return an example of result returned by getNextValue.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name.
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	info ($langs)
	Returns the default description of the numbering template.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Parent class for third parties accountancy code generators.

Definition at line 245 of file modules_societe.class.php.

Member Function Documentation

get_code()

ModeleAccountancyCode::get_code	(		$db,
			$societe,
			$type = '' )

Set accountancy account code for a third party into this->code.

Parameters

DoliDB	$db	Database handler
?Societe	$societe	Third party object
	'customer'|'supplier'|''	$type 'customer' or 'supplier'

Returns

int<-1,1> >=0 if success, -1 if failure

Reimplemented in mod_codecompta_aquarium, mod_codecompta_digitaria, and mod_codecompta_panicum.

Definition at line 302 of file modules_societe.class.php.

References dol_syslog().

Referenced by getToolTip().

getExample()

ModeleAccountancyCode::getExample ( $langs = null, $objsoc = '', $type = -1 )

abstract

Return an example of result returned by getNextValue.

Parameters

?Translate	$langs	Object langs
Societe | string	$objsoc	Object thirdparty
	int<-1,2>	$type Type of third party (1:customer, 2:supplier, -1:autodetect)

Returns

string Return string example

Reimplemented in mod_codecompta_aquarium, mod_codecompta_digitaria, and mod_codecompta_panicum.

getToolTip()

ModeleAccountancyCode::getToolTip	(		$langs,
			$soc,
			$type )

Return description of module parameters.

Parameters

Translate	$langs	Output language
?Societe	$soc	Third party object
	int<-1,1>	$type -1=Nothing, 0=Customer, 1=Supplier

Returns

string HTML translated description

Definition at line 260 of file modules_societe.class.php.

References get_code(), CommonNumRefGenerator\getVersion(), and name.

---

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

• dolibarr_23.0/htdocs/core/modules/societe/modules_societe.class.php