mod_codeproduct_leopard Class Reference

Class to manage product code with leopard rule. More...

Inheritance diagram for mod_codeproduct_leopard:

Collaboration diagram for mod_codeproduct_leopard:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of module.
	getExample ($langs=null, $objproduct='', $type=-1)
	Return an example of result returned by getNextValue.
	getNextValue ($objproduct='', $type=-1)
	Return an example of result returned by getNextValue.
	verif ($db, &$code, $product, $type)
	Check validity of code according to its rules.
Public Member Functions inherited from ModeleProductCode
	getToolTip ($langs, $product, $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 ModeleProductCode
static	liste_modeles ($dbs, $maxfilenamelength=0)
	Renvoi la liste des modeles de numérotation.

Detailed Description

Class to manage product code with leopard rule.

Class permettant la gestion leopard des codes produits.

Definition at line 35 of file mod_codeproduct_leopard.php.

Member Function Documentation

getExample()

mod_codeproduct_leopard::getExample	(		$langs = null,
			$objproduct = '',
			$type = -1 )

Return an example of result returned by getNextValue.

Parameters

?Translate	$langs	Object langs
Product | string	$objproduct	Object product
	int<-1,2>	$type Type of third party (1:customer, 2:supplier, -1:autodetect)

Returns

string Return string example

Reimplemented from ModeleProductCode.

Definition at line 86 of file mod_codeproduct_leopard.php.

getNextValue()

mod_codeproduct_leopard::getNextValue	(		$objproduct = '',
			$type = -1 )

Return an example of result returned by getNextValue.

Parameters

Product | string	$objproduct	Object product
int	$type	Type of third party (1:customer, 2:supplier, -1:autodetect)

Returns

string Return next value

Reimplemented from ModeleProductCode.

Definition at line 98 of file mod_codeproduct_leopard.php.

info()

mod_codeproduct_leopard::info

(

$langs

)

Return description of module.

Parameters

Translate

$langs

Object langs

Returns

string Description of module

Reimplemented from CommonNumRefGenerator.

Definition at line 72 of file mod_codeproduct_leopard.php.

verif()

mod_codeproduct_leopard::verif	(		$db,
		&	$code,
			$product,
			$type )

Check validity of code according to its rules.

Parameters

DoliDB	$db	Database handler
string	$code	Code to check/correct
Product	$product	Object product
int	$type	0 = product , 1 = service

Returns

int 0 if OK -1 ErrorBadProductCodeSyntax -2 ErrorProductCodeRequired -3 ErrorProductCodeAlreadyUsed -4 ErrorPrefixRequired

Definition at line 117 of file mod_codeproduct_leopard.php.

References dol_syslog(), and getDolGlobalString().

---

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

• dolibarr_dev/htdocs/core/modules/product/mod_codeproduct_leopard.php