dolibarr 21.0.0-alpha
mod_codeclient_leopard Class Reference

Class to manage numbering of thirdparties code. More...

Inheritance diagram for mod_codeclient_leopard:
Collaboration diagram for mod_codeclient_leopard:

Public Member Functions

 __construct ($db)
 Constructor.
 
 info ($langs)
 Return description of module.
 
 getExample ($langs=null, $objsoc='', $type=-1)
 Return an example of result returned by getNextValue.
 
 getNextValue ($objsoc='', $type=-1)
 Return an example of result returned by getNextValue.
 
 verif ($db, &$code, $soc, $type)
 Check validity of code according to its rules.
 
- Public Member Functions inherited from ModeleThirdPartyCode
 getToolTip ($langs, $soc, $type)
 Return description of module parameters.
 
 verif_prefixIsUsed ()
 Check if mask/numbering use prefix.
 
- 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.
 
 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from ModeleThirdPartyCode
static liste_modeles ($dbs, $maxfilenamelength=0)
 Return list of active generation modules.
 

Detailed Description

Class to manage numbering of thirdparties code.

Definition at line 34 of file mod_codeclient_leopard.php.

Constructor & Destructor Documentation

◆ __construct()

mod_codeclient_leopard::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase object

Reimplemented from ModeleThirdPartyCode.

Definition at line 53 of file mod_codeclient_leopard.php.

Member Function Documentation

◆ getExample()

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

Return an example of result returned by getNextValue.

Parameters
?Translate$langsObject langs
Societe | string$objsocObject thirdparty
int<-1,2>$type Type of third party (1:customer, 2:supplier, -1:autodetect)
Returns
string Return string example

Definition at line 85 of file mod_codeclient_leopard.php.

◆ getNextValue()

mod_codeclient_leopard::getNextValue ( $objsoc = '',
$type = -1 )

Return an example of result returned by getNextValue.

Parameters
Societe | string$objsocObject thirdparty
int$typeType of third party (1:customer, 2:supplier, -1:autodetect)
Returns
string Return next value

Reimplemented from ModeleThirdPartyCode.

Definition at line 97 of file mod_codeclient_leopard.php.

◆ info()

mod_codeclient_leopard::info ( $langs)

Return description of module.

Parameters
Translate$langsObject langs
Returns
string Description of module

Reimplemented from CommonNumRefGenerator.

Definition at line 71 of file mod_codeclient_leopard.php.

◆ verif()

mod_codeclient_leopard::verif ( $db,
& $code,
$soc,
$type )

Check validity of code according to its rules.

Parameters
DoliDB$dbDatabase handler
string$codeCode to check/correct
Societe$socObject third party
int<0,1>$type 0 = customer/prospect , 1 = supplier
Returns
int<-6,0> 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 NotConfigured - Setup empty so any value may be ok or not -6 Other (see this->error)

Reimplemented from ModeleThirdPartyCode.

Definition at line 118 of file mod_codeclient_leopard.php.

References dol_syslog(), and getDolGlobalString().


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