mod_codeproduct_elephant Class Reference

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

Inheritance diagram for mod_codeproduct_elephant:

Collaboration diagram for mod_codeproduct_elephant:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of module. More...
	getExample ($langs, $objproduct=0, $type=-1)
	Return an example of result returned by getNextValue. More...
	getNextValue ($objproduct=0, $type=-1)
	Return next value. More...
	verif_prefixIsUsed ()
	Check if mask/numbering use prefix. More...
	verif ($db, &$code, $product, $type)
	Check validity of code according to its rules. More...
	verif_dispo ($db, $code, $product)
	Renvoi si un code est pris ou non (par autre tiers) More...
Public Member Functions inherited from ModeleProductCode
	getNom ($langs)
	Renvoi nom module. More...
	getExample ($langs)
	Return an example of numbering. 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, $product, $type)
	Return description of module parameters. More...

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

Detailed Description

Class to manage product code with elephant rule.

Definition at line 35 of file mod_codeproduct_elephant.php.

Member Function Documentation

getExample()

mod_codeproduct_elephant::getExample	(		$langs,
			$objproduct = 0,
			$type = -1
	)

Return an example of result returned by getNextValue.

Parameters

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

Returns

string Return string example

Definition at line 146 of file mod_codeproduct_elephant.php.

getNextValue()

mod_codeproduct_elephant::getNextValue	(		$objproduct = 0,
			$type = -1
	)

Return next value.

Parameters

Product	$objproduct	Object product
int	$type	Produit ou service (0:product, 1:service)

Returns

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

Reimplemented from ModeleProductCode.

Definition at line 187 of file mod_codeproduct_elephant.php.

info()

mod_codeproduct_elephant::info

(

$langs

)

Return description of module.

Parameters

Translate

$langs

Object langs

Returns

string Description of module

Reimplemented from ModeleProductCode.

Definition at line 95 of file mod_codeproduct_elephant.php.

verif()

mod_codeproduct_elephant::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 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 Other (see this->error)

Definition at line 269 of file mod_codeproduct_elephant.php.

verif_dispo()

mod_codeproduct_elephant::verif_dispo	(		$db,
			$code,
			$product
	)

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

Parameters

DoliDB	$db	Handler acces base
string	$code	Code a verifier
Product	$product	Objet product

Returns

int 0 if available, <0 if KO

Definition at line 317 of file mod_codeproduct_elephant.php.

verif_prefixIsUsed()

mod_codeproduct_elephant::verif_prefixIsUsed

(

)

Check if mask/numbering use prefix.

Returns

int 0 or 1

Reimplemented from ModeleProductCode.

Definition at line 236 of file mod_codeproduct_elephant.php.

---

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

• dolibarr_17.0/htdocs/core/modules/product/mod_codeproduct_elephant.php