modPhpbarcode Class Reference

Class to generate barcode images using php barcode generator. More...

Inheritance diagram for modPhpbarcode:

Collaboration diagram for modPhpbarcode:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	info ($langs)
	Return description.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	encodingIsSupported ($encoding)
	Return true if encoding is supported.
	buildBarCode ($code, $encoding, $readable='Y', $scale=1, $nooutputiferror=0)
	Return an image file on the fly (no need to write on disk) with the HTTP content-type of image.
	writeBarCode ($code, $encoding, $readable='Y', $scale=1, $nooutputiferror=0)
	Save an image file on disk (with no output)

Detailed Description

Class to generate barcode images using php barcode generator.

Definition at line 34 of file phpbarcode.modules.php.

Member Function Documentation

buildBarCode()

modPhpbarcode::buildBarCode	(		$code,
			$encoding,
			$readable = 'Y',
			$scale = 1,
			$nooutputiferror = 0 )

Return an image file on the fly (no need to write on disk) with the HTTP content-type of image.

Parameters

string	$code	Value to encode
string	$encoding	Mode of encoding
string	$readable	Code can be read (What is this ? is this used ?)
integer	$scale	Scale
integer	$nooutputiferror	No output if error

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 137 of file phpbarcode.modules.php.

References barcode_print(), dol_escape_htmltag(), dol_syslog(), and encodingIsSupported().

Referenced by writeBarCode().

canBeActivated()

modPhpbarcode::canBeActivated

(

$object

)

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

Parameters

Object

$object

Object we need next value for

Returns

boolean false if KO (there is a conflict), true if OK

Definition at line 82 of file phpbarcode.modules.php.

encodingIsSupported()

modPhpbarcode::encodingIsSupported

(

$encoding

)

Return true if encoding is supported.

Parameters

string

$encoding

Encoding norm

Returns

int >0 if supported, 0 if not

Reimplemented from ModeleBarCode.

Definition at line 96 of file phpbarcode.modules.php.

Referenced by buildBarCode().

info()

modPhpbarcode::info

(

$langs

)

Return description.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from ModeleBarCode.

Definition at line 65 of file phpbarcode.modules.php.

isEnabled()

modPhpbarcode::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Reimplemented from ModeleBarCode.

Definition at line 53 of file phpbarcode.modules.php.

writeBarCode()

modPhpbarcode::writeBarCode	(		$code,
			$encoding,
			$readable = 'Y',
			$scale = 1,
			$nooutputiferror = 0 )

Save an image file on disk (with no output)

Parameters

string	$code	Value to encode
string	$encoding	Mode of encoding
string	$readable	Code can be read
integer	$scale	Scale
integer	$nooutputiferror	No output if error

Returns

int Return integer <0 if KO, >0 if OK

Reimplemented from ModeleBarCode.

Definition at line 188 of file phpbarcode.modules.php.

References buildBarCode(), dol_hash(), dol_mkdir(), dol_strlen(), and dol_syslog().

---

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

• dolibarr_dev/htdocs/core/modules/barcode/doc/phpbarcode.modules.php