modTcpdfbarcode

class modTcpdfbarcode extends ModeleBarCode (View source)

Class to generate barcode images using tcpdf barcode generator

Properties

string $error
string $version

Dolibarr version of the loaded document
bool $is2d

Methods

bool
isEnabled()

Return if a module can be used or not

string
info($langs)

Return description of numbering model

int
writeBarCode(string $code, string $encoding, string $readable = 'Y', int $scale = 1, $nooutputiferror = 0)

Save an image file on disk (with no output)

int
buildBarCode(string $code, string $encoding, string $readable = 'Y', int $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.

int
encodingIsSupported($encoding)

Return true if encoding is supported

canBeActivated(object $object)

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

string
getTcpdfEncodingType(string $dolEncodingType)

get available output_modes for tcpdf class with its translated description

Details

at line 68
bool isEnabled()

Return if a module can be used or not

Return Value

bool

true if model can be used

at line 58
string info($langs)

Return description of numbering model

Parameters

$langs

Return Value

string

Descriptive text

at line 158
int writeBarCode(string $code, string $encoding, string $readable = 'Y', int $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
int $scale

Scale (not used with this engine) @param integer $nooutputiferror No output if error (not used with this engine)
$nooutputiferror

Return Value

int

Return integer <0 if KO, >0 if OK

at line 112
int buildBarCode(string $code, string $encoding, string $readable = 'Y', int $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 ?)
int $scale

Scale @param integer $nooutputiferror No output if error
$nooutputiferror
$filebarcode

Return Value

int

Return integer <0 if KO, >0 if OK

at line 91
int encodingIsSupported($encoding)

Return true if encoding is supported

Parameters

$encoding

Return Value

int

0 if supported, 0 if not

at line 80
canBeActivated(object $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 @return boolean false if KO (there is a conflict), true if OK

at line 241
string getTcpdfEncodingType(string $dolEncodingType)

get available output_modes for tcpdf class with its translated description

Parameters

string $dolEncodingType

dolibarr barcode encoding type

Return Value

string

tcpdf encoding type