modTcpdfbarcode Class Reference

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

Inheritance diagram for modTcpdfbarcode:

Collaboration diagram for modTcpdfbarcode:

Public Member Functions
	info ($langs)
	Return description of numbering model.
	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.
	encodingIsSupported ($encoding)
	Return true if encoding is supported.
	buildBarCode ($code, $encoding, $readable='Y', $scale=1, $nooutputiferror=0, $filebarcode='')
	Return an image file on the fly (no need to write on disk) with the HTTP content-type (generated by TCPDF) of image.
	writeBarCode ($code, $encoding, $readable='Y', $scale=1, $nooutputiferror=0)
	Save an image file on disk (with no output)
	getTcpdfEncodingType ($dolEncodingType)
	get available output_modes for tcpdf class with its translated description

Detailed Description

Class to generate barcode images using tcpdf barcode generator.

Definition at line 33 of file tcpdfbarcode.modules.php.

Member Function Documentation

buildBarCode()

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

Return an image file on the fly (no need to write on disk) with the HTTP content-type (generated by TCPDF) 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 (not used with this engine)
integer	$nooutputiferror	No output if error (not used with this engine)
string	$filebarcode	Filename to store barcode image file (instead of output it). Not supported by this driver.

Returns

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

Definition at line 108 of file tcpdfbarcode.modules.php.

References dol_syslog(), and getTcpdfEncodingType().

canBeActivated()

modTcpdfbarcode::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 76 of file tcpdfbarcode.modules.php.

encodingIsSupported()

modTcpdfbarcode::encodingIsSupported

(

$encoding

)

Return true if encoding is supported.

Parameters

string

$encoding

Encoding norm

Returns

int >0 if supported, 0 if not

Definition at line 87 of file tcpdfbarcode.modules.php.

References getTcpdfEncodingType().

getTcpdfEncodingType()

modTcpdfbarcode::getTcpdfEncodingType

(

$dolEncodingType

)

get available output_modes for tcpdf class with its translated description

Parameters

string

$dolEncodingType

dolibarr barcode encoding type

Returns

string tcpdf encoding type

Definition at line 237 of file tcpdfbarcode.modules.php.

Referenced by buildBarCode(), encodingIsSupported(), and writeBarCode().

info()

modTcpdfbarcode::info

(

$langs

)

Return description of numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Definition at line 54 of file tcpdfbarcode.modules.php.

isEnabled()

modTcpdfbarcode::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Reimplemented from ModeleBarCode.

Definition at line 64 of file tcpdfbarcode.modules.php.

writeBarCode()

modTcpdfbarcode::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 ('QRCODE', 'EAN13', ...)
string	$readable	Code can be read
integer	$scale	Scale (not used with this engine)
integer	$nooutputiferror	No output if error (not used with this engine)

Returns

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

Reimplemented from ModeleBarCode.

Definition at line 154 of file tcpdfbarcode.modules.php.

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

---

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

• dolibarr_20.0/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php