dolibarr  16.0.5
Functions
barcode.lib.php File Reference

Set of functions used for barcode generation (internal lib, also code 'phpbarcode') More...

Go to the source code of this file.

Functions

if(!empty($conf->global->GENBARCODE_LOCATION)) barcode_print ($code, $encoding="ANY", $scale=2, $mode="png")
 Print barcode. More...
 
 barcode_encode ($code, $encoding)
 Encodes $code with $encoding using genbarcode OR built-in encoder if you don't have genbarcode only EAN-13/ISBN or UPC is possible. More...
 
 barcode_gen_ean_sum ($ean)
 Calculate EAN sum. More...
 
 barcode_gen_ean_bars ($ean)
 Generate EAN bars. More...
 
 barcode_encode_ean ($ean, $encoding="EAN-13")
 Encode EAN. More...
 
 barcode_encode_upc ($upc, $encoding="UPC")
 Encode UPC. More...
 
 barcode_encode_genbarcode ($code, $encoding)
 Encode result of genbarcode command. More...
 
 barcode_outimage ($text, $bars, $scale=1, $mode="png", $total_y=0, $space='')
 Output image onto standard output, or onto disk if global filebarcode is defined. More...
 

Detailed Description

Set of functions used for barcode generation (internal lib, also code 'phpbarcode')

Definition in file barcode.lib.php.

Function Documentation

◆ barcode_encode()

barcode_encode (   $code,
  $encoding 
)

Encodes $code with $encoding using genbarcode OR built-in encoder if you don't have genbarcode only EAN-13/ISBN or UPC is possible.

You can use the following encodings (when you have genbarcode): ANY choose best-fit (default) EAN 8 or 13 EAN-Code UPC 12-digit EAN ISBN isbn numbers (still EAN-13) 39 code 39 128 code 128 (a,b,c: autoselection) 128C code 128 (compact form for digits) 128B code 128, full printable ascii I25 interleaved 2 of 5 (only digits) 128RAW Raw code 128 (by Leonid A. Broukhis) CBR Codabar (by Leonid A. Broukhis) MSI MSI (by Leonid A. Broukhis) PLS Plessey (by Leonid A. Broukhis)

Parameters
string$codeCode
string$encodingEncoding
Returns
array|false array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info)

Definition at line 127 of file barcode.lib.php.

◆ barcode_encode_ean()

barcode_encode_ean (   $ean,
  $encoding = "EAN-13" 
)

Encode EAN.

Parameters
string$eanCode
string$encodingEncoding
Returns
array array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info, 'error': error message if error)

Definition at line 229 of file barcode.lib.php.

◆ barcode_encode_genbarcode()

barcode_encode_genbarcode (   $code,
  $encoding 
)

Encode result of genbarcode command.

Parameters
string$codeCode
string$encodingEncoding
Returns
array|false array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info)

Definition at line 335 of file barcode.lib.php.

◆ barcode_encode_upc()

barcode_encode_upc (   $upc,
  $encoding = "UPC" 
)

Encode UPC.

Parameters
string$upcCode
string$encodingEncoding
Returns
array array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info, 'error': error message if error)

Definition at line 285 of file barcode.lib.php.

◆ barcode_gen_ean_bars()

barcode_gen_ean_bars (   $ean)

Generate EAN bars.

Parameters
string$eanEAN to encode
Returns
string Encoded EAN

Definition at line 199 of file barcode.lib.php.

◆ barcode_gen_ean_sum()

barcode_gen_ean_sum (   $ean)

Calculate EAN sum.

Parameters
string$eanEAN to encode
Returns
integer Sum

Definition at line 175 of file barcode.lib.php.

◆ barcode_outimage()

barcode_outimage (   $text,
  $bars,
  $scale = 1,
  $mode = "png",
  $total_y = 0,
  $space = '' 
)

Output image onto standard output, or onto disk if global filebarcode is defined.

Parameters
string$textthe text-line (<position>:<font-size>:<character> ...)
string$barswhere to place the bars (<space-width><bar-width><space-width><bar-width>...)
int$scalescale factor ( 1 < scale < unlimited (scale 50 will produce 5400x300 pixels when using EAN-13!!!))
string$modepng,gif,jpg (default='png')
int$total_ythe total height of the image ( default: scale * 60 )
array$spacedefault: $space[top] = 2 * $scale; $space[bottom]= 2 * $scale; $space[left] = 2 * $scale; $space[right] = 2 * $scale;
Returns
string|null

Definition at line 403 of file barcode.lib.php.

◆ barcode_print()

if (!empty( $conf->global->GENBARCODE_LOCATION)) barcode_print (   $code,
  $encoding = "ANY",
  $scale = 2,
  $mode = "png" 
)

Print barcode.

Parameters
string$codeCode
string$encodingEncoding ('EAN13', 'ISBN', 'C128', 'UPC', 'CBR', 'QRCODE', 'DATAMATRIX', 'ANY'...)
integer$scaleScale
string$mode'png' or 'jpg' ...
Returns
array|string $bars array('encoding': the encoding which has been used, 'bars': the bars, 'text': text-positioning info) or string with error message

Definition at line 80 of file barcode.lib.php.