dolibarr  21.0.0-alpha
Public Member Functions | List of all members
ModeleBarCode Class Reference

Parent class for barcode document generators (image) More...

Inheritance diagram for ModeleBarCode:
Inheritance graph
[legend]

Public Member Functions

 isEnabled ()
 Return if a model can be used or not. More...
 
 writeBarCode ($code, $encoding, $readable='Y', $scale=1, $nooutputiferror=0)
 Save an image file on disk (with no output) More...
 

Detailed Description

Parent class for barcode document generators (image)

Definition at line 33 of file modules_barcode.class.php.

Member Function Documentation

◆ isEnabled()

ModeleBarCode::isEnabled ( )

Return if a model can be used or not.

Returns
boolean true if model can be used

Reimplemented in modTcpdfbarcode, and modPhpbarcode.

Definition at line 46 of file modules_barcode.class.php.

◆ writeBarCode()

ModeleBarCode::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 ('QRCODE', 'EAN13', ...)
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

Reimplemented in modTcpdfbarcode, and modPhpbarcode.

Definition at line 61 of file modules_barcode.class.php.


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