ModeleBarCode

abstract class ModeleBarCode (View source)

Parent class for barcode document generators (image)

Properties

string $error
"development"|"experimental"|"dolibarr" $version

Dolibarr version of loaded document

Methods

bool
isEnabled()

Return if a model can be used or not

string
info($langs)

Return description

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)

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

int
encodingIsSupported($encoding)

Return true if encoding is supported

Details

at line 48
bool isEnabled()

Return if a model can be used or not

Return Value

bool

true if model can be used

at line 60
abstract string info($langs)

Return description

@param Translate $langs Lang object to use for output

Parameters

$langs

Return Value

string

Descriptive text

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

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

Return Value

int

Return integer <0 if KO, >0 if OK

at line 99
abstract int encodingIsSupported($encoding)

Return true if encoding is supported

@param string $encoding Encoding norm

Parameters

$encoding

Return Value

int

0 if supported, 0 if not