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

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

Inheritance diagram for ModeleAccountancyCode:
Inheritance graph
[legend]

Public Member Functions

 info ($langs)
 Return description of module. More...
 
 getExample ($langs, $objsoc=0, $type=-1)
 Return an example of result returned by getNextValue. More...
 
 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...
 
 get_code ($db, $societe, $type='')
 Set accountancy account code for a third party into this->code. More...
 

Detailed Description

Parent class for third parties accountancy code generators.

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

Member Function Documentation

◆ canBeActivated()

ModeleAccountancyCode::canBeActivated ( )

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns
boolean false if conflict, true if ok

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

◆ get_code()

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

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

Parameters
DoliDB$dbDatabase handler
Societe$societeThird party object
int$type'customer' or 'supplier'
Returns
int >=0 if OK, <0 if KO

Reimplemented in mod_codecompta_digitaria, mod_codecompta_aquarium, and mod_codecompta_panicum.

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

◆ getExample()

ModeleAccountancyCode::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 Example

Reimplemented in mod_codecompta_digitaria, mod_codecompta_aquarium, and mod_codecompta_panicum.

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

◆ getToolTip()

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

Return description of module parameters.

Parameters
Translate$langsOutput language
Societe$socThird party object
int$type-1=Nothing, 0=Customer, 1=Supplier
Returns
string HTML translated description

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

◆ getVersion()

ModeleAccountancyCode::getVersion ( )

Return version of module.

Returns
string Version

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

◆ info()

ModeleAccountancyCode::info (   $langs)

Return description of module.

Parameters
Translate$langsObject langs
Returns
string Description of module

Reimplemented in mod_codecompta_digitaria, mod_codecompta_aquarium, and mod_codecompta_panicum.

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


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