mod_codecompta_aquarium Class Reference

Class to manage accountancy code of thirdparties with Aquarium rules. More...

Inheritance diagram for mod_codecompta_aquarium:

Collaboration diagram for mod_codecompta_aquarium:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of module.
	getExample ($langs, $objsoc=0, $type=-1)
	Return an example of result returned by getNextValue.
	get_code ($db, $societe, $type='')
	Set accountancy account code for a third party into this->code.
	verif ($db, $code, $societe, $type)
	Return if a code is available.
Public Member Functions inherited from ModeleAccountancyCode
	getToolTip ($langs, $soc, $type)
	Return description of module parameters.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name TODO Replace with getName()
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	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

Class to manage accountancy code of thirdparties with Aquarium rules.

Definition at line 32 of file mod_codecompta_aquarium.php.

Member Function Documentation

get_code()

mod_codecompta_aquarium::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
string	$type	'customer' or 'supplier'

Returns

int >=0 if OK, <0 if KO

Reimplemented from ModeleAccountancyCode.

Definition at line 155 of file mod_codecompta_aquarium.php.

References dol_syslog(), getDolGlobalString(), and verif().

getExample()

mod_codecompta_aquarium::getExample	(		$langs,
			$objsoc = 0,
			$type = -1 )

Return an example of result returned by getNextValue.

Parameters

Translate	$langs	Object langs
societe	$objsoc	Object thirdparty
int	$type	Type of third party (1:customer, 2:supplier, -1:autodetect)

Returns

string Return string example

Definition at line 136 of file mod_codecompta_aquarium.php.

info()

mod_codecompta_aquarium::info

(

$langs

)

Return description of module.

Parameters

Translate

$langs

Object langs

Returns

string Description of module

Reimplemented from CommonNumRefGenerator.

Definition at line 86 of file mod_codecompta_aquarium.php.

References getDolGlobalString(), name, and yn().

verif()

mod_codecompta_aquarium::verif	(		$db,
			$code,
			$societe,
			$type )

Return if a code is available.

Parameters

DoliDB	$db	Database handler
string	$code	Code of third party
Societe	$societe	Object third party
string	$type	'supplier' or 'customer'

Returns

int 0 if OK but not available, >0 if OK and available, <0 if KO

Definition at line 215 of file mod_codecompta_aquarium.php.

References dol_syslog().

Referenced by get_code().

---

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

• dolibarr_19.0/htdocs/core/modules/societe/mod_codecompta_aquarium.php