mod_barcode_product_standard Class Reference

Class to manage barcode with standard rule. More...

Inheritance diagram for mod_barcode_product_standard:

Collaboration diagram for mod_barcode_product_standard:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of module. More...
	getExample ($langs, $objproduct=0)
	Return an example of result returned by getNextValue. More...
	literalBarcodeType ($db, $type='')
	Return literal barcode type code from numerical rowid type of barcode. More...
	getNextValue ($objproduct, $type='')
	Return next value. More...
	verif ($db, &$code, $product, $thirdparty_type, $type)
	Check validity of code according to its rules. More...
	verif_dispo ($db, $code, $product)
	Return if a code is used (by other element) More...
	verif_syntax ($codefortest, $typefortest)
	Return if a barcode value match syntax. More...
Public Member Functions inherited from ModeleNumRefBarCode
	getNom ($langs)
	Return model name. More...
	getExample ($langs)
	Return a numbering example. More...
	getVersion ()
	Return version of module. More...
	getToolTip ($langs, $soc, $type)
	Return description of module parameters. More...

Detailed Description

Class to manage barcode with standard rule.

Definition at line 34 of file mod_barcode_product_standard.php.

Member Function Documentation

getExample()

mod_barcode_product_standard::getExample	(		$langs,
			$objproduct = 0
	)

Return an example of result returned by getNextValue.

Parameters

Translate	$langs	Object langs
Product	$objproduct	Object product

Returns

string Return string example

Definition at line 129 of file mod_barcode_product_standard.php.

getNextValue()

mod_barcode_product_standard::getNextValue	(		$objproduct,
			$type = ''
	)

Return next value.

Parameters

Product	$objproduct	Object product
string	$type	Type of barcode (EAN, ISBN, ...)

Returns

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

Reimplemented from ModeleNumRefBarCode.

Definition at line 179 of file mod_barcode_product_standard.php.

info()

mod_barcode_product_standard::info

(

$langs

)

Return description of module.

Parameters

Translate

$langs

Object langs

Returns

string Description of module

Reimplemented from ModeleNumRefBarCode.

Definition at line 83 of file mod_barcode_product_standard.php.

literalBarcodeType()

mod_barcode_product_standard::literalBarcodeType	(		$db,
			$type = ''
	)

Return literal barcode type code from numerical rowid type of barcode.

Parameters

Database	$db	Database
int	$type	Type of barcode (EAN, ISBN, ...) as rowid

Returns

string

Definition at line 149 of file mod_barcode_product_standard.php.

verif()

mod_barcode_product_standard::verif	(		$db,
		&	$code,
			$product,
			$thirdparty_type,
			$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	$thirdparty_type	0 = customer/prospect , 1 = supplier
string	$type	type of barcode (EAN, ISBN, ...)

Returns

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

Definition at line 246 of file mod_barcode_product_standard.php.

verif_dispo()

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

Return if a code is used (by other element)

Parameters

DoliDB	$db	Handler acces base
string	$code	Code to check
Product	$product	Objet product

Returns

int 0 if available, <0 if KO

Definition at line 292 of file mod_barcode_product_standard.php.

verif_syntax()

mod_barcode_product_standard::verif_syntax	(		$codefortest,
			$typefortest
	)

Return if a barcode value match syntax.

Parameters

string	$codefortest	Code to check syntax
string	$typefortest	Type of barcode (ISBN, EAN, ...)

Returns

int 0 if OK, <0 if KO

Definition at line 321 of file mod_barcode_product_standard.php.

---

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

• htdocs/core/modules/barcode/mod_barcode_product_standard.php