Moodle  2.2.1
http://www.collinsharper.com
Public Member Functions | Protected Attributes
TCPDF2DBarcode Class Reference

Public Member Functions

 __construct ($code, $type)
 getBarcodeArray ()
 getBarcodeSVG ($w=3, $h=3, $color='black')
 getBarcodeSVGcode ($w=3, $h=3, $color='black')
 getBarcodeHTML ($w=10, $h=10, $color='black')
 getBarcodePNG ($w=3, $h=3, $color=array(0, 0, 0))
 setBarcode ($code, $type)

Protected Attributes

 $barcode_array = false

Detailed Description

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

Definition at line 50 of file 2dbarcodes.php.

Constructor & Destructor Documentation

__construct ( $  code,
$  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:
$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

Definition at line 68 of file 2dbarcodes.php.

Here is the call graph for this function:

Member Function Documentation

getBarcodeArray ( )

Return an array representations of barcode.

Returns:
array

Definition at line 76 of file 2dbarcodes.php.

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

Return an HTML representation of barcode.

Parameters:
$w(int) Width of a single rectangle element in pixels.
$h(int) Height of a single rectangle element in pixels.
$color(string) Foreground color for bar elements (background is transparent).
Returns:
string HTML code.

Definition at line 144 of file 2dbarcodes.php.

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

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

Parameters:
$w(int) Width of a single rectangle element in pixels.
$h(int) Height of a single rectangle element in pixels.
$color(array) RGB (0-255) foreground color for bar elements (background is transparent).
Returns:
image or false in case of error.

Definition at line 174 of file 2dbarcodes.php.

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

Send barcode as SVG image object to the standard output.

Parameters:
$w(int) Width of a single rectangle element in user units.
$h(int) Height of a single rectangle element in user units.
$color(string) Foreground color (in SVG format) for bar elements (background is transparent).

Definition at line 87 of file 2dbarcodes.php.

Here is the call graph for this function:

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

Return a SVG string representation of barcode.

Parameters:
$w(int) Width of a single rectangle element in user units.
$h(int) Height of a single rectangle element in user units.
$color(string) Foreground color (in SVG format) for bar elements (background is transparent).
Returns:
string SVG code.

Definition at line 108 of file 2dbarcodes.php.

Here is the caller graph for this function:

setBarcode ( $  code,
$  type 
)

Set the barcode.

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
Returns:
array

Definition at line 236 of file 2dbarcodes.php.

Here is the caller graph for this function:

Field Documentation

$barcode_array = false [protected]

Array representation of barcode.

Definition at line 56 of file 2dbarcodes.php.

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations