ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Protected Attributes
TCPDF2DBarcode Class Reference

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

+ Collaboration diagram for TCPDF2DBarcode:

Public Member Functions

 __construct ($code, $type)
 This is the class constructor. More...
 
 getBarcodeArray ()
 Return an array representations of barcode. More...
 
 getBarcodeSVG ($w=3, $h=3, $color='black')
 Send barcode as SVG image object to the standard output. More...
 
 getBarcodeSVGcode ($w=3, $h=3, $color='black')
 Return a SVG string representation of barcode. More...
 
 getBarcodeHTML ($w=10, $h=10, $color='black')
 Return an HTML representation of barcode. More...
 
 getBarcodePNG ($w=3, $h=3, $color=array(0, 0, 0))
 Send a PNG image representation of barcode (requires GD or Imagick library). More...
 
 getBarcodePngData ($w=3, $h=3, $color=array(0, 0, 0))
 Return a PNG image representation of barcode (requires GD or Imagick library). More...
 
 setBarcode ($code, $type)
 Set the barcode. More...
 

Protected Attributes

 $barcode_array = false
 Array representation of barcode. More...
 

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 tcpdf_barcodes_2d.php.

Constructor & Destructor Documentation

◆ __construct()

TCPDF2DBarcode::__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 tcpdf_barcodes_2d.php.

References $code, and setBarcode().

68  {
69  $this->setBarcode($code, $type);
70  }
$code
$code
Definition: example_050.php:99
TCPDF2DBarcode\setBarcode
setBarcode($code, $type)
Set the barcode.
Definition: tcpdf_barcodes_2d.php:252
+ Here is the call graph for this function:

Member Function Documentation

◆ getBarcodeArray()

TCPDF2DBarcode::getBarcodeArray ( )

Return an array representations of barcode.

Returns
array

Definition at line 76 of file tcpdf_barcodes_2d.php.

References $barcode_array.

76  {
77  return $this->barcode_array;
78  }
TCPDF2DBarcode\$barcode_array
$barcode_array
Array representation of barcode.
Definition: tcpdf_barcodes_2d.php:56

◆ getBarcodeHTML()

TCPDF2DBarcode::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 tcpdf_barcodes_2d.php.

References $h, $html, $r, $w, $x, and $y.

144  {
145  $html = '<div style="font-size:0;position:relative;width:'.($w * $this->barcode_array['num_cols']).'px;height:'.($h * $this->barcode_array['num_rows']).'px;">'."\n";
146  // print barcode elements
147  $y = 0;
148  // for each row
149  for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) {
150  $x = 0;
151  // for each column
152  for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) {
153  if ($this->barcode_array['bcode'][$r][$c] == 1) {
154  // draw a single barcode cell
155  $html .= '<div style="background-color:'.$color.';width:'.$w.'px;height:'.$h.'px;position:absolute;left:'.$x.'px;top:'.$y.'px;">&nbsp;</div>'."\n";
156  }
157  $x += $w;
158  }
159  $y += $h;
160  }
161  $html .= '</div>'."\n";
162  return $html;
163  }
$x
$x
Definition: example_009.php:98
$h
$h
Definition: example_009.php:101
$w
$w
Definition: example_009.php:100
$r
$r
Definition: example_031.php:79
$y
$y
Definition: example_007.php:83
$html
$html
Definition: example_001.php:87

◆ getBarcodePNG()

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

Send 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).

Definition at line 172 of file tcpdf_barcodes_2d.php.

References $data, $h, $w, getBarcodePngData(), and header.

172  {
173  $data = $this->getBarcodePngData($w, $h, $color);
174  // send headers
175  header('Content-Type: image/png');
176  header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
177  header('Pragma: public');
178  header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
179  header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
180  //header('Content-Length: '.strlen($data));
181  echo $data;
182 
183  }
$h
$h
Definition: example_009.php:101
$w
$w
Definition: example_009.php:100
TCPDF2DBarcode\getBarcodePngData
getBarcodePngData($w=3, $h=3, $color=array(0, 0, 0))
Return a PNG image representation of barcode (requires GD or Imagick library).
Definition: tcpdf_barcodes_2d.php:193
header
Add a drawing to the header
Definition: 04printing.php:69
+ Here is the call graph for this function:

◆ getBarcodePngData()

TCPDF2DBarcode::getBarcodePngData (   $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 193 of file tcpdf_barcodes_2d.php.

References $h, $r, $w, $x, and $y.

Referenced by getBarcodePNG().

193  {
194  // calculate image size
195  $width = ($this->barcode_array['num_cols'] * $w);
196  $height = ($this->barcode_array['num_rows'] * $h);
197  if (function_exists('imagecreate')) {
198  // GD library
199  $imagick = false;
200  $png = imagecreate($width, $height);
201  $bgcol = imagecolorallocate($png, 255, 255, 255);
202  imagecolortransparent($png, $bgcol);
203  $fgcol = imagecolorallocate($png, $color[0], $color[1], $color[2]);
204  } elseif (extension_loaded('imagick')) {
205  $imagick = true;
206  $bgcol = new imagickpixel('rgb(255,255,255');
207  $fgcol = new imagickpixel('rgb('.$color[0].','.$color[1].','.$color[2].')');
208  $png = new Imagick();
209  $png->newImage($width, $height, 'none', 'png');
210  $bar = new imagickdraw();
211  $bar->setfillcolor($fgcol);
212  } else {
213  return false;
214  }
215  // print barcode elements
216  $y = 0;
217  // for each row
218  for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) {
219  $x = 0;
220  // for each column
221  for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) {
222  if ($this->barcode_array['bcode'][$r][$c] == 1) {
223  // draw a single barcode cell
224  if ($imagick) {
225  $bar->rectangle($x, $y, ($x + $w - 1), ($y + $h - 1));
226  } else {
227  imagefilledrectangle($png, $x, $y, ($x + $w - 1), ($y + $h - 1), $fgcol);
228  }
229  }
230  $x += $w;
231  }
232  $y += $h;
233  }
234  if ($imagick) {
235  $png->drawimage($bar);
236  return $png;
237  } else {
238  ob_start();
239  imagepng($png);
240  $imagedata = ob_get_clean();
241  imagedestroy($png);
242  return $imagedata;
243  }
244  }
$x
$x
Definition: example_009.php:98
$h
$h
Definition: example_009.php:101
$w
$w
Definition: example_009.php:100
$r
$r
Definition: example_031.php:79
$y
$y
Definition: example_007.php:83
+ Here is the caller graph for this function:

◆ getBarcodeSVG()

TCPDF2DBarcode::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 tcpdf_barcodes_2d.php.

References $code, $h, $w, getBarcodeSVGcode(), and header.

87  {
88  // send headers
89  $code = $this->getBarcodeSVGcode($w, $h, $color);
90  header('Content-Type: application/svg+xml');
91  header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
92  header('Pragma: public');
93  header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
94  header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
95  header('Content-Disposition: inline; filename="'.md5($code).'.svg";');
96  //header('Content-Length: '.strlen($code));
97  echo $code;
98  }
TCPDF2DBarcode\getBarcodeSVGcode
getBarcodeSVGcode($w=3, $h=3, $color='black')
Return a SVG string representation of barcode.
Definition: tcpdf_barcodes_2d.php:108
$h
$h
Definition: example_009.php:101
$code
$code
Definition: example_050.php:99
$w
$w
Definition: example_009.php:100
header
Add a drawing to the header
Definition: 04printing.php:69
+ Here is the call graph for this function:

◆ getBarcodeSVGcode()

TCPDF2DBarcode::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 tcpdf_barcodes_2d.php.

References $h, $r, $w, $x, $y, and array.

Referenced by getBarcodeSVG().

108  {
109  // replace table for special characters
110  $repstr = array("\0" => '', '&' => '&amp;', '<' => '&lt;', '>' => '&gt;');
111  $svg = '<'.'?'.'xml version="1.0" standalone="no"'.'?'.'>'."\n";
112  $svg .= '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">'."\n";
113  $svg .= '<svg width="'.round(($this->barcode_array['num_cols'] * $w), 3).'" height="'.round(($this->barcode_array['num_rows'] * $h), 3).'" version="1.1" xmlns="http://www.w3.org/2000/svg">'."\n";
114  $svg .= "\t".'<desc>'.strtr($this->barcode_array['code'], $repstr).'</desc>'."\n";
115  $svg .= "\t".'<g id="elements" fill="'.$color.'" stroke="none">'."\n";
116  // print barcode elements
117  $y = 0;
118  // for each row
119  for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) {
120  $x = 0;
121  // for each column
122  for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) {
123  if ($this->barcode_array['bcode'][$r][$c] == 1) {
124  // draw a single barcode cell
125  $svg .= "\t\t".'<rect x="'.$x.'" y="'.$y.'" width="'.$w.'" height="'.$h.'" />'."\n";
126  }
127  $x += $w;
128  }
129  $y += $h;
130  }
131  $svg .= "\t".'</g>'."\n";
132  $svg .= '</svg>'."\n";
133  return $svg;
134  }
$x
$x
Definition: example_009.php:98
$h
$h
Definition: example_009.php:101
$w
$w
Definition: example_009.php:100
$r
$r
Definition: example_031.php:79
$y
$y
Definition: example_007.php:83
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
+ Here is the caller graph for this function:

◆ setBarcode()

TCPDF2DBarcode::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 252 of file tcpdf_barcodes_2d.php.

References $code, $r, and array.

Referenced by __construct().

252  {
253  $mode = explode(',', $type);
254  $qrtype = strtoupper($mode[0]);
255  switch ($qrtype) {
256  case 'DATAMATRIX': { // DATAMATRIX (ISO/IEC 16022)
257  require_once(dirname(__FILE__).'/include/barcodes/datamatrix.php');
258  $qrcode = new Datamatrix($code);
259  $this->barcode_array = $qrcode->getBarcodeArray();
260  $this->barcode_array['code'] = $code;
261  break;
262  }
263  case 'PDF417': { // PDF417 (ISO/IEC 15438:2006)
264  require_once(dirname(__FILE__).'/include/barcodes/pdf417.php');
265  if (!isset($mode[1]) OR ($mode[1] === '')) {
266  $aspectratio = 2; // default aspect ratio (width / height)
267  } else {
268  $aspectratio = floatval($mode[1]);
269  }
270  if (!isset($mode[2]) OR ($mode[2] === '')) {
271  $ecl = -1; // default error correction level (auto)
272  } else {
273  $ecl = intval($mode[2]);
274  }
275  // set macro block
276  $macro = array();
277  if (isset($mode[3]) AND ($mode[3] !== '') AND isset($mode[4]) AND ($mode[4] !== '') AND isset($mode[5]) AND ($mode[5] !== '')) {
278  $macro['segment_total'] = intval($mode[3]);
279  $macro['segment_index'] = intval($mode[4]);
280  $macro['file_id'] = strtr($mode[5], "\xff", ',');
281  for ($i = 0; $i < 7; ++$i) {
282  $o = $i + 6;
283  if (isset($mode[$o]) AND ($mode[$o] !== '')) {
284  // add option
285  $macro['option_'.$i] = strtr($mode[$o], "\xff", ',');
286  }
287  }
288  }
289  $qrcode = new PDF417($code, $ecl, $aspectratio, $macro);
290  $this->barcode_array = $qrcode->getBarcodeArray();
291  $this->barcode_array['code'] = $code;
292  break;
293  }
294  case 'QRCODE': { // QR-CODE
295  require_once(dirname(__FILE__).'/include/barcodes/qrcode.php');
296  if (!isset($mode[1]) OR (!in_array($mode[1],array('L','M','Q','H')))) {
297  $mode[1] = 'L'; // Ddefault: Low error correction
298  }
299  $qrcode = new QRcode($code, strtoupper($mode[1]));
300  $this->barcode_array = $qrcode->getBarcodeArray();
301  $this->barcode_array['code'] = $code;
302  break;
303  }
304  case 'RAW':
305  case 'RAW2': { // RAW MODE
306  // remove spaces
307  $code = preg_replace('/[\s]*/si', '', $code);
308  if (strlen($code) < 3) {
309  break;
310  }
311  if ($qrtype == 'RAW') {
312  // comma-separated rows
313  $rows = explode(',', $code);
314  } else { // RAW2
315  // rows enclosed in square parentheses
316  $code = substr($code, 1, -1);
317  $rows = explode('][', $code);
318  }
319  $this->barcode_array['num_rows'] = count($rows);
320  $this->barcode_array['num_cols'] = strlen($rows[0]);
321  $this->barcode_array['bcode'] = array();
322  foreach ($rows as $r) {
323  $this->barcode_array['bcode'][] = str_split($r, 1);
324  }
325  $this->barcode_array['code'] = $code;
326  break;
327  }
328  case 'TEST': { // TEST MODE
329  $this->barcode_array['num_rows'] = 5;
330  $this->barcode_array['num_cols'] = 15;
331  $this->barcode_array['bcode'] = array(
332  array(1,1,1,0,1,1,1,0,1,1,1,0,1,1,1),
333  array(0,1,0,0,1,0,0,0,1,0,0,0,0,1,0),
334  array(0,1,0,0,1,1,0,0,1,1,1,0,0,1,0),
335  array(0,1,0,0,1,0,0,0,0,0,1,0,0,1,0),
336  array(0,1,0,0,1,1,1,0,1,1,1,0,0,1,0));
337  $this->barcode_array['code'] = $code;
338  break;
339  }
340  default: {
341  $this->barcode_array = false;
342  }
343  }
344  }
$code
$code
Definition: example_050.php:99
$r
$r
Definition: example_031.php:79
QRcode
Class to create QR-code arrays for TCPDF class.
Definition: qrcode.php:291
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
PDF417
Class to create PDF417 barcode arrays for TCPDF class.
Definition: pdf417.php:93
Datamatrix
Class to create DataMatrix ECC 200 barcode arrays for TCPDF class.
Definition: datamatrix.php:110
+ Here is the caller graph for this function:

Field Documentation

◆ $barcode_array

TCPDF2DBarcode::$barcode_array = false
protected

Array representation of barcode.

Definition at line 56 of file tcpdf_barcodes_2d.php.

Referenced by getBarcodeArray().

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