dolibarr  16.0.5
Public Member Functions | List of all members
mod_codecompta_aquarium Class Reference

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

Inheritance diagram for mod_codecompta_aquarium:
Inheritance graph
[legend]
Collaboration diagram for mod_codecompta_aquarium:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 info ($langs)
 Return description of module. More...
 
 getExample ($langs, $objsoc=0, $type=-1)
 Return an example of result returned by getNextValue. More...
 
 get_code ($db, $societe, $type='')
 Set accountancy account code for a third party into this->code. More...
 
 verif ($db, $code, $societe, $type)
 Return if a code is available. More...
 
- Public Member Functions inherited from ModeleAccountancyCode
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Return version of module. More...
 
 getToolTip ($langs, $soc, $type)
 Return description of module parameters. More...
 

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$dbDatabase handler
Societe$societeThird party object
string$type'customer' or 'supplier'
Returns
int >=0 if OK, <0 if KO

Reimplemented from ModeleAccountancyCode.

Definition at line 140 of file mod_codecompta_aquarium.php.

◆ getExample()

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

Return an example of result returned by getNextValue.

Parameters
Translate$langsObject langs
societe$objsocObject thirdparty
int$typeType of third party (1:customer, 2:supplier, -1:autodetect)
Returns
string Return string example

Reimplemented from ModeleAccountancyCode.

Definition at line 121 of file mod_codecompta_aquarium.php.

◆ info()

mod_codecompta_aquarium::info (   $langs)

Return description of module.

Parameters
Translate$langsObject langs
Returns
string Description of module

Reimplemented from ModeleAccountancyCode.

Definition at line 75 of file mod_codecompta_aquarium.php.

◆ verif()

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

Return if a code is available.

Parameters
DoliDB$dbDatabase handler
string$codeCode of third party
Societe$societeObject 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 200 of file mod_codecompta_aquarium.php.


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