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. More...
	info ($langs)
	Return description of module. More...
	getExample ($langs, $objsoc='', $type=-1)
	Return an example of result returned by getNextValue. More...
	getNextValue ($objsoc='', $type=-1)
	Return an example of result returned by getNextValue. More...
	verif ($db, &$code, $soc, $type)
	Check validity of code according to its rules. More...
Public Member Functions inherited from ModeleThirdPartyCode
	getToolTip ($langs, $soc, $type)
	Return description of module parameters. More...
	verif_prefixIsUsed ()
	Check if mask/numbering use prefix. More...
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name. More...
	getName ($langs)
	Return model name. More...
	isEnabled ()
	Return if a module can be used or not. More...
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
	getVersion ()
	Returns version of numbering module. More...

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

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

$db

Database object

Reimplemented from ModeleThirdPartyCode.

Definition at line 53 of file mod_codeclient_leopard.php.

Member Function Documentation

getExample()

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

Return an example of result returned by getNextValue.

Parameters

Translate	$langs	Object langs
Societe | string	$objsoc	Object thirdparty
int	$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	$objsoc	Object thirdparty
int	$type	Type 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

$langs

Object 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	$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 116 of file mod_codeclient_leopard.php.

---

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

• dolibarr_dev/htdocs/core/modules/societe/mod_codeclient_leopard.php