ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
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))
 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.

68 {
69 $this->setBarcode($code, $type);
70 }
TCPDF2DBarcode\setBarcode
setBarcode($code, $type)
Set the barcode.
Definition: tcpdf_barcodes_2d.php:235

References setBarcode().

+ 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.

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

References $barcode_array.

◆ 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.

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 }

◆ getBarcodePNG()

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

173 {
174 // calculate image size
175 $width = ($this->barcode_array['num_cols'] * $w);
176 $height = ($this->barcode_array['num_rows'] * $h);
177 if (function_exists('imagecreate')) {
178 // GD library
179 $imagick = false;
180 $png = imagecreate($width, $height);
181 $bgcol = imagecolorallocate($png, 255, 255, 255);
182 imagecolortransparent($png, $bgcol);
183 $fgcol = imagecolorallocate($png, $color[0], $color[1], $color[2]);
184 } elseif (extension_loaded('imagick')) {
185 $imagick = true;
186 $bgcol = new imagickpixel('rgb(255,255,255');
187 $fgcol = new imagickpixel('rgb('.$color[0].','.$color[1].','.$color[2].')');
188 $png = new Imagick();
189 $png->newImage($width, $height, 'none', 'png');
190 $bar = new imagickdraw();
191 $bar->setfillcolor($fgcol);
192 } else {
193 return false;
194 }
195 // print barcode elements
196 $y = 0;
197 // for each row
198 for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) {
199 $x = 0;
200 // for each column
201 for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) {
202 if ($this->barcode_array['bcode'][$r][$c] == 1) {
203 // draw a single barcode cell
204 if ($imagick) {
205 $bar->rectangle($x, $y, ($x + $w - 1), ($y + $h - 1));
206 } else {
207 imagefilledrectangle($png, $x, $y, ($x + $w - 1), ($y + $h - 1), $fgcol);
208 }
209 }
210 $x += $w;
211 }
212 $y += $h;
213 }
214 // send headers
215 header('Content-Type: image/png');
216 header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
217 header('Pragma: public');
218 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
219 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
220 if ($imagick) {
221 $png->drawimage($bar);
222 echo $png;
223 } else {
224 imagepng($png);
225 imagedestroy($png);
226 }
227 }

◆ 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.

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

References getBarcodeSVGcode().

+ 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.

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 }

Referenced by getBarcodeSVG().

+ 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 235 of file tcpdf_barcodes_2d.php.

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

Referenced by __construct().

+ 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: