TCPDF2DBarcode

class TCPDF2DBarcode (View source)

Properties

protected $barcode_array

Array representation of barcode.

Methods

__construct(string $code, string $type)

This is the class constructor.

array
getBarcodeArray()

Return an array representations of barcode.

getBarcodeSVG(int $w = 3, int $h = 3, string $color = 'black')

Send barcode as SVG image object to the standard output.

string
getBarcodeSVGcode(int $w = 3, int $h = 3, string $color = 'black')

Return a SVG string representation of barcode.

string
getBarcodeHTML(int $w = 10, int $h = 10, string $color = 'black')

Return an HTML representation of barcode.

getBarcodePNG(int $w = 3, int $h = 3, array $color = array(0, 0, 0))

Send a PNG image representation of barcode (requires GD or Imagick library).

string|Imagick|false
getBarcodePngData(int $w = 3, int $h = 3, array $color = array(0, 0, 0))

Return a PNG image representation of barcode (requires GD or Imagick library).

void
setBarcode(string $code, string $type)

Set the barcode.

Details

at line 68
__construct(string $code, string $type)

This is the class constructor.

Return an array representations for 2D barcodes:

  • $arrcode['code'] code to be printed on text label
  • $arrcode['num_rows'] required number of rows
  • $arrcode['num_cols'] required number of columns
  • $arrcode['bcode'][$r][$c] value of the cell is $r row and $c column (0 = transparent, 1 = black)

Parameters

string $code

code to print
string $type

type of barcode:

  • DATAMATRIX : Datamatrix (ISO/IEC 16022)
  • PDF417 : PDF417 (ISO/IEC 15438:2006)
  • PDF417,a,e,t,s,f,o0,o1,o2,o3,o4,o5,o6 : PDF417 with parameters: a = aspect ratio (width/height); e = error correction level (0-8); t = total number of macro segments; s = macro segment index (0-99998); f = file ID; o0 = File Name (text); o1 = Segment Count (numeric); o2 = Time Stamp (numeric); o3 = Sender (text); o4 = Addressee (text); o5 = File Size (numeric); o6 = Checksum (numeric). NOTES: Parameters t, s and f are required for a Macro Control Block, all other parameters are optional. To use a comma character ',' on text options, replace it with the character 255: "\xff".
  • QRCODE : QRcode Low error correction
  • QRCODE,L : QRcode Low error correction
  • QRCODE,M : QRcode Medium error correction
  • QRCODE,Q : QRcode Better error correction
  • QRCODE,H : QR-CODE Best error correction
  • RAW: raw mode - comma-separad list of array rows
  • RAW2: raw mode - array rows are surrounded by square parenthesis.
  • TEST : Test matrix

at line 76
array getBarcodeArray()

Return an array representations of barcode.

Return Value

array

at line 87
getBarcodeSVG(int $w = 3, int $h = 3, string $color = 'black')

Send barcode as SVG image object to the standard output.

Parameters

int $w

Width of a single rectangle element in user units.
int $h

Height of a single rectangle element in user units.
string $color

Foreground color (in SVG format) for bar elements (background is transparent).

at line 108
string getBarcodeSVGcode(int $w = 3, int $h = 3, string $color = 'black')

Return a SVG string representation of barcode.

Parameters

int $w

Width of a single rectangle element in user units.
int $h

Height of a single rectangle element in user units.
string $color

Foreground color (in SVG format) for bar elements (background is transparent).

Return Value

string

SVG code.

at line 144
string getBarcodeHTML(int $w = 10, int $h = 10, string $color = 'black')

Return an HTML representation of barcode.

Parameters

int $w

Width of a single rectangle element in pixels.
int $h

Height of a single rectangle element in pixels.
string $color

Foreground color for bar elements (background is transparent).

Return Value

string

HTML code.

at line 172
getBarcodePNG(int $w = 3, int $h = 3, array $color = array(0, 0, 0))

Send a PNG image representation of barcode (requires GD or Imagick library).

Parameters

int $w

Width of a single rectangle element in pixels.
int $h

Height of a single rectangle element in pixels.
array $color

RGB (0-255) foreground color for bar elements (background is transparent).

at line 193
string|Imagick|false getBarcodePngData(int $w = 3, int $h = 3, array $color = array(0, 0, 0))

Return a PNG image representation of barcode (requires GD or Imagick library).

Parameters

int $w

Width of a single rectangle element in pixels.
int $h

Height of a single rectangle element in pixels.
array $color

RGB (0-255) foreground color for bar elements (background is transparent).

Return Value

string|Imagick|false

image or false in case of error.

at line 252
void setBarcode(string $code, string $type)

Set the barcode.

Parameters

string $code

code to print
string $type

type of barcode:

  • DATAMATRIX : Datamatrix (ISO/IEC 16022)
  • PDF417 : PDF417 (ISO/IEC 15438:2006)
  • PDF417,a,e,t,s,f,o0,o1,o2,o3,o4,o5,o6 : PDF417 with parameters: a = aspect ratio (width/height); e = error correction level (0-8); t = total number of macro segments; s = macro segment index (0-99998); f = file ID; o0 = File Name (text); o1 = Segment Count (numeric); o2 = Time Stamp (numeric); o3 = Sender (text); o4 = Addressee (text); o5 = File Size (numeric); o6 = Checksum (numeric). NOTES: Parameters t, s and f are required for a Macro Control Block, all other parameters are optional. To use a comma character ',' on text options, replace it with the character 255: "\xff".
  • QRCODE : QRcode Low error correction
  • QRCODE,L : QRcode Low error correction
  • QRCODE,M : QRcode Medium error correction
  • QRCODE,Q : QRcode Better error correction
  • QRCODE,H : QR-CODE Best error correction
  • RAW: raw mode - comma-separad list of array rows
  • RAW2: raw mode - array rows are surrounded by square parenthesis.
  • TEST : Test matrix

Return Value

void