mod_codeclient_monkey Class Reference

Classe permettant la gestion monkey des codes tiers. More...

Inheritance diagram for mod_codeclient_monkey:

Collaboration diagram for mod_codeclient_monkey:

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.
	getNextValue ($objsoc=0, $type=-1)
	Return next value.
	verif ($db, &$code, $soc, $type)
	Check validity of code according to its rules.
	verif_dispo ($db, $code, $soc, $type=0)
	Renvoi si un code est pris ou non (par autre tiers)
	verif_syntax ($code)
	Renvoi si un code respecte la syntaxe.
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 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.

Additional Inherited Members
Static Public Member Functions inherited from ModeleThirdPartyCode
static	liste_modeles ($dbs, $maxfilenamelength=0)
	Renvoie la liste des modeles de numérotation.

Detailed Description

Classe permettant la gestion monkey des codes tiers.

Definition at line 33 of file mod_codeclient_monkey.php.

Member Function Documentation

getExample()

mod_codeclient_monkey::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 100 of file mod_codeclient_monkey.php.

getNextValue()

mod_codeclient_monkey::getNextValue	(		$objsoc = 0,
			$type = -1 )

Return next value.

Parameters

Societe	$objsoc	Object third party
int	$type	Client ou fournisseur (1:client, 2:fournisseur)

Returns

string Value if OK, '' if module not configured, <0 if KO

Reimplemented from ModeleThirdPartyCode.

Definition at line 113 of file mod_codeclient_monkey.php.

References dol_now(), dol_print_date(), and dol_syslog().

info()

mod_codeclient_monkey::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_codeclient_monkey.php.

verif()

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

Check validity of code according to its rules.

Parameters

DoliDB	$db	Database handler
string	$code	Code to check/correct
Societe	$soc	Object third party
int	$type	0 = customer/prospect , 1 = supplier

Returns

int 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired

Definition at line 177 of file mod_codeclient_monkey.php.

References dol_strlen(), dol_syslog(), getDolGlobalString(), verif_dispo(), and verif_syntax().

verif_dispo()

mod_codeclient_monkey::verif_dispo	(		$db,
			$code,
			$soc,
			$type = 0 )

Renvoi si un code est pris ou non (par autre tiers)

Parameters

DoliDB	$db	Handler acces base
string	$code	Code a verifier
Societe	$soc	Objet societe
int	$type	0 = customer/prospect , 1 = supplier

Returns

int 0 if available, <0 if KO

Definition at line 220 of file mod_codeclient_monkey.php.

References dol_syslog().

Referenced by verif().

verif_syntax()

mod_codeclient_monkey::verif_syntax

(

$code

)

Renvoi si un code respecte la syntaxe.

Parameters

string

$code

Code a verifier

Returns

int 0 si OK, <0 si KO

Definition at line 257 of file mod_codeclient_monkey.php.

References dol_strlen().

Referenced by verif().

---

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

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