classes-TCPDF2DBarcode

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.
Tags
class

TCPDF2DBarcode PHP class to creates array representations for 2D barcodes to be used with TCPDF (http://www.tcpdf.org).

version
1.0.015
author

Nicola Asuni

Table of Contents

$barcode_array  : mixed
Array representation of barcode.
__construct()  : mixed
This is the class constructor.
getBarcodeArray()  : array<string|int, mixed>
Return an array representations of barcode.
getBarcodeHTML()  : string
Return an HTML representation of barcode.
getBarcodePNG()  : mixed
Send a PNG image representation of barcode (requires GD or Imagick library).
getBarcodePngData()  : image
Return a PNG image representation of barcode (requires GD or Imagick library).
getBarcodeSVG()  : mixed
Send barcode as SVG image object to the standard output.
getBarcodeSVGcode()  : string
Return a SVG string representation of barcode.
setBarcode()  : array<string|int, mixed>
Set the barcode.

Properties

$barcode_array

Array representation of barcode.

protected mixed $barcode_array = alse
Tags
protected

Methods

__construct()

This is the class constructor.

public __construct( $code,  $type) : mixed

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
$code :

(string) code to print

$type :

(string) 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 parametrs 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 values
mixed

getBarcodeArray()

Return an array representations of barcode.

public getBarcodeArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBarcodeHTML()

Return an HTML representation of barcode.

public getBarcodeHTML([ $w = 10 ][,  $h = 10 ][,  $color = 'black' ]) : string
Parameters
$w : = 10

(int) Width of a single rectangle element in pixels.

$h : = 10

(int) Height of a single rectangle element in pixels.

$color : = 'black'

(string) Foreground color for bar elements (background is transparent).

Tags
public
Return values
string

HTML code.

getBarcodePNG()

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

public getBarcodePNG([ $w = 3 ][,  $h = 3 ][,  $color = array(0, 0, 0) ]) : mixed
Parameters
$w : = 3

(int) Width of a single rectangle element in pixels.

$h : = 3

(int) Height of a single rectangle element in pixels.

$color : = array(0, 0, 0)

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

Tags
public
Return values
mixed

getBarcodePngData()

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

public getBarcodePngData([ $w = 3 ][,  $h = 3 ][,  $color = array(0, 0, 0) ]) : image
Parameters
$w : = 3

(int) Width of a single rectangle element in pixels.

$h : = 3

(int) Height of a single rectangle element in pixels.

$color : = array(0, 0, 0)

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

Tags
public
Return values
image

or false in case of error.

getBarcodeSVG()

Send barcode as SVG image object to the standard output.

public getBarcodeSVG([ $w = 3 ][,  $h = 3 ][,  $color = 'black' ]) : mixed
Parameters
$w : = 3

(int) Width of a single rectangle element in user units.

$h : = 3

(int) Height of a single rectangle element in user units.

$color : = 'black'

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

Tags
public
Return values
mixed

getBarcodeSVGcode()

Return a SVG string representation of barcode.

public getBarcodeSVGcode([ $w = 3 ][,  $h = 3 ][,  $color = 'black' ]) : string
Parameters
$w : = 3

(int) Width of a single rectangle element in user units.

$h : = 3

(int) Height of a single rectangle element in user units.

$color : = 'black'

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

Tags
public
Return values
string

SVG code.

setBarcode()

Set the barcode.

public setBarcode( $code,  $type) : array<string|int, mixed>
Parameters
$code :

(string) code to print

$type :

(string) 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 parametrs 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 values
array<string|int, mixed>
 

© 2004-2021 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy