dolibarr 19.0.3
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)
 Return an image file on the fly (no need to write on disk)
 
 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 wth its translated description
 

Detailed Description

Class to generate barcode images using tcpdf barcode generator.

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

Member Function Documentation

◆ buildBarCode()

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

Return an image file on the fly (no need to write on disk)

Parameters
string$codeValue to encode
string$encodingMode of encoding
string$readableCode can be read (What is this ? is this used ?)
integer$scaleScale (not used with this engine)
integer$nooutputiferrorNo output if error (not used with this engine)
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 106 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$objectObject we need next value for
Returns
boolean false if KO (there is a conflict), true if OK

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

◆ encodingIsSupported()

modTcpdfbarcode::encodingIsSupported ( $encoding)

Return true if encoding is supported.

Parameters
string$encodingEncoding norm
Returns
int >0 if supported, 0 if not

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

References getTcpdfEncodingType().

◆ getTcpdfEncodingType()

modTcpdfbarcode::getTcpdfEncodingType ( $dolEncodingType)

get available output_modes for tcpdf class wth its translated description

Parameters
string$dolEncodingTypedolibarr barcode encoding type
Returns
string tcpdf encoding type

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

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

◆ info()

modTcpdfbarcode::info ( $langs)

Return description of numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Definition at line 53 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 63 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$codeValue to encode
string$encodingMode of encoding
string$readableCode can be read
integer$scaleScale (not used with this engine)
integer$nooutputiferrorNo output if error (not used with this engine)
Returns
int Return integer <0 if KO, >0 if OK

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

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


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