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.
	getExample ($langs, $objproduct=null)
	Return an example of result returned by getNextValue.
	literalBarcodeType ($db, $type=0)
	Return literal barcode type code from numerical rowid type of barcode.
	getNextValue ($objproduct=null, $type='')
	Return next value.
	verif ($db, &$code, $product, $thirdparty_type, $type)
	Check validity of code according to its rules.
	verif_dispo ($db, $code, $product)
	Return if a code is used (by other element)
	verif_syntax ($codefortest, $typefortest)
	Return if a barcode value match syntax.
Public Member Functions inherited from ModeleNumRefBarCode
	getToolTip ($langs, $soc, $type)
	Return description of module parameters.
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.

Detailed Description

Class to manage barcode with standard rule.

Definition at line 36 of file mod_barcode_product_standard.php.

Member Function Documentation

getExample()

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

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 115 of file mod_barcode_product_standard.php.

References getNextValue().

getNextValue()

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

Return next value.

Parameters

?CommonObject	$objproduct	Object product (not used)
string	$type	Type of barcode (EAN, ISBN, ...)

Returns

string|int<-1,-1> Value if OK, '' if module not configured, <0 if KO

Reimplemented from ModeleNumRefBarCode.

Definition at line 166 of file mod_barcode_product_standard.php.

References barcode_gen_ean_sum(), dol_now(), dol_syslog(), get_next_value(), getDolGlobalString(), and literalBarcodeType().

Referenced by getExample().

info()

mod_barcode_product_standard::info

(

$langs

)

Return description of module.

Parameters

Translate

$langs

Object langs

Returns

string Description of module

Reimplemented from CommonNumRefGenerator.

Definition at line 69 of file mod_barcode_product_standard.php.

References getDolGlobalString().

literalBarcodeType()

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

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

Parameters

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

Returns

string

Definition at line 135 of file mod_barcode_product_standard.php.

References dol_print_error().

Referenced by getNextValue().

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 235 of file mod_barcode_product_standard.php.

References dol_strlen(), dol_syslog(), getDolGlobalString(), verif_dispo(), and verif_syntax().

verif_dispo()

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

Return if a code is used (by other element)

Parameters

DoliDB	$db	Handler access base
string	$code	Code to check
Product	$product	Object product

Returns

int 0 if available, <0 if KO

Definition at line 281 of file mod_barcode_product_standard.php.

Referenced by verif().

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 312 of file mod_barcode_product_standard.php.

References check_value(), dol_syslog(), and getDolGlobalString().

Referenced by verif().

---

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

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