ModeleProductCode Class Reference

Class template for classes of numbering product. More...

Inheritance diagram for ModeleProductCode:

Public Member Functions
	info ($langs)
	Renvoi la description par defaut du modele de numerotation. More...
	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...
	getNextValue ($objproduct=0, $type=-1)
	Return next value available. More...
	getVersion ()
	Return version of module. More...
	getToolTip ($langs, $product, $type)
	Return description of module parameters. More...
	verif_prefixIsUsed ()
	Check if mask/numbering use prefix. More...

Static Public Member Functions
static	liste_modeles ($db, $maxfilenamelength=0)
	Renvoi la liste des modeles de numérotation. More...

Detailed Description

Class template for classes of numbering product.

Parent class for product code generators.

Definition at line 67 of file modules_product.class.php.

Member Function Documentation

ModeleProductCode::canBeActivated

(

)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns

boolean false if conflict, true if ok

Definition at line 112 of file modules_product.class.php.

ModeleProductCode::getExample

(

$langs

)

Return an example of numbering.

Parameters

Translate

$langs

Object langs

Returns

string Example

Definition at line 101 of file modules_product.class.php.

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

Return next value available.

Parameters

Product	$objproduct	Object product
int	$type	Type

Returns

string Value

Definition at line 124 of file modules_product.class.php.

Referenced by getToolTip().

ModeleProductCode::getNom

(

$langs

)

Renvoi nom module.

Parameters

Translate

$langs

Object langs

Returns

string Nom du module

Definition at line 90 of file modules_product.class.php.

References name, and nom.

Referenced by getToolTip().

ModeleProductCode::getToolTip	(		$langs,
			$product,
			$type
	)

Return description of module parameters.

Parameters

Translate	$langs	Output language
Product	$product	Product object
int	$type	-1=Nothing, 0=Customer, 1=Supplier

Returns

string HTML translated description

Definition at line 192 of file modules_product.class.php.

References getNextValue(), getNom(), getVersion(), and yn().

ModeleProductCode::getVersion

(

)

Return version of module.

Returns

string Version

Definition at line 135 of file modules_product.class.php.

Referenced by getToolTip().

ModeleProductCode::info

(

$langs

)

Renvoi la description par defaut du modele de numerotation.

Parameters

Translate

$langs

Object langs

Returns

string Texte descripif

Definition at line 79 of file modules_product.class.php.

static ModeleProductCode::liste_modeles (   $db,   $maxfilenamelength = 0  )

static

Renvoi la liste des modeles de numérotation.

Parameters

DoliDB	$db	Database handler
integer	$maxfilenamelength	Max length of value to show

Returns

array List of numbers

Definition at line 163 of file modules_product.class.php.

References $resql.

ModeleProductCode::verif_prefixIsUsed

(

)

Check if mask/numbering use prefix.

Returns

int 0=no, 1=yes

Definition at line 259 of file modules_product.class.php.

---

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

• htdocs/core/modules/product/modules_product.class.php