Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
<?php
//============================================================+
// File name   : tcpdf_barcodes_2d.php
// Version     : 1.0.015
// Begin       : 2009-04-07
// Last Update : 2014-05-20
// Author      : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License     : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2009-2014 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF.  If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : PHP class to creates array representations for
//               2D barcodes to be used with TCPDF.
//
//============================================================+

/**
 * @file
 * PHP class to creates array representations for 2D barcodes to be used with TCPDF.
 * @package com.tecnick.tcpdf
 * @author Nicola Asuni
 * @version 1.0.015
 */

/**
 * @class TCPDF2DBarcode
 * PHP class to creates array representations for 2D barcodes to be used with TCPDF (http://www.tcpdf.org).
 * @package com.tecnick.tcpdf
 * @version 1.0.015
 * @author Nicola Asuni
 */
class TCPDF2DBarcode {

	/**
	 * Array representation of barcode.
	 * @protected
	 */
< protected $barcode_array = false;
> protected $barcode_array = array();
/** * This is the class constructor. * Return an array representations for 2D barcodes:<ul> * <li>$arrcode['code'] code to be printed on text label</li> * <li>$arrcode['num_rows'] required number of rows</li> * <li>$arrcode['num_cols'] required number of columns</li> * <li>$arrcode['bcode'][$r][$c] value of the cell is $r row and $c column (0 = transparent, 1 = black)</li></ul>
< * @param $code (string) code to print < * @param $type (string) type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>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".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul>
> * @param string $code code to print > * @param string $type type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>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".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul>
*/ public function __construct($code, $type) { $this->setBarcode($code, $type); } /** * Return an array representations of barcode. * @return array */ public function getBarcodeArray() { return $this->barcode_array; } /** * Send barcode as SVG image object to the standard output.
< * @param $w (int) Width of a single rectangle element in user units. < * @param $h (int) Height of a single rectangle element in user units. < * @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
> * @param int $w Width of a single rectangle element in user units. > * @param int $h Height of a single rectangle element in user units. > * @param string $color Foreground color (in SVG format) for bar elements (background is transparent).
* @public */ public function getBarcodeSVG($w=3, $h=3, $color='black') { // send headers $code = $this->getBarcodeSVGcode($w, $h, $color); header('Content-Type: application/svg+xml'); header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1 header('Pragma: public'); header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); header('Content-Disposition: inline; filename="'.md5($code).'.svg";'); //header('Content-Length: '.strlen($code)); echo $code; } /** * Return a SVG string representation of barcode.
< * @param $w (int) Width of a single rectangle element in user units. < * @param $h (int) Height of a single rectangle element in user units. < * @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
> * @param int $w Width of a single rectangle element in user units. > * @param int $h Height of a single rectangle element in user units. > * @param string $color Foreground color (in SVG format) for bar elements (background is transparent).
* @return string SVG code. * @public */ public function getBarcodeSVGcode($w=3, $h=3, $color='black') { // replace table for special characters $repstr = array("\0" => '', '&' => '&amp;', '<' => '&lt;', '>' => '&gt;'); $svg = '<'.'?'.'xml version="1.0" standalone="no"'.'?'.'>'."\n"; $svg .= '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">'."\n"; $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"; $svg .= "\t".'<desc>'.strtr($this->barcode_array['code'], $repstr).'</desc>'."\n"; $svg .= "\t".'<g id="elements" fill="'.$color.'" stroke="none">'."\n"; // print barcode elements $y = 0; // for each row for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) { $x = 0; // for each column for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) { if ($this->barcode_array['bcode'][$r][$c] == 1) { // draw a single barcode cell $svg .= "\t\t".'<rect x="'.$x.'" y="'.$y.'" width="'.$w.'" height="'.$h.'" />'."\n"; } $x += $w; } $y += $h; } $svg .= "\t".'</g>'."\n"; $svg .= '</svg>'."\n"; return $svg; } /** * Return an HTML representation of barcode.
< * @param $w (int) Width of a single rectangle element in pixels. < * @param $h (int) Height of a single rectangle element in pixels. < * @param $color (string) Foreground color for bar elements (background is transparent).
> * @param int $w Width of a single rectangle element in pixels. > * @param int $h Height of a single rectangle element in pixels. > * @param string $color Foreground color for bar elements (background is transparent).
* @return string HTML code. * @public */ public function getBarcodeHTML($w=10, $h=10, $color='black') { $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"; // print barcode elements $y = 0; // for each row for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) { $x = 0; // for each column for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) { if ($this->barcode_array['bcode'][$r][$c] == 1) { // draw a single barcode cell $html .= '<div style="background-color:'.$color.';width:'.$w.'px;height:'.$h.'px;position:absolute;left:'.$x.'px;top:'.$y.'px;">&nbsp;</div>'."\n"; } $x += $w; } $y += $h; } $html .= '</div>'."\n"; return $html; } /** * Send a PNG image representation of barcode (requires GD or Imagick library).
< * @param $w (int) Width of a single rectangle element in pixels. < * @param $h (int) Height of a single rectangle element in pixels. < * @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
> * @param int $w Width of a single rectangle element in pixels. > * @param int $h Height of a single rectangle element in pixels. > * @param array $color RGB (0-255) foreground color for bar elements (background is transparent).
* @public */ public function getBarcodePNG($w=3, $h=3, $color=array(0,0,0)) { $data = $this->getBarcodePngData($w, $h, $color); // send headers header('Content-Type: image/png'); header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1 header('Pragma: public'); header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); //header('Content-Length: '.strlen($data)); echo $data; } /** * Return a PNG image representation of barcode (requires GD or Imagick library).
< * @param $w (int) Width of a single rectangle element in pixels. < * @param $h (int) Height of a single rectangle element in pixels. < * @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent). < * @return image or false in case of error.
> * @param int $w Width of a single rectangle element in pixels. > * @param int $h Height of a single rectangle element in pixels. > * @param array $color RGB (0-255) foreground color for bar elements (background is transparent). > * @return string|Imagick|false image or false in case of error.
* @public */ public function getBarcodePngData($w=3, $h=3, $color=array(0,0,0)) { // calculate image size $width = ($this->barcode_array['num_cols'] * $w); $height = ($this->barcode_array['num_rows'] * $h); if (function_exists('imagecreate')) { // GD library $imagick = false; $png = imagecreate($width, $height); $bgcol = imagecolorallocate($png, 255, 255, 255); imagecolortransparent($png, $bgcol); $fgcol = imagecolorallocate($png, $color[0], $color[1], $color[2]); } elseif (extension_loaded('imagick')) { $imagick = true; $bgcol = new imagickpixel('rgb(255,255,255'); $fgcol = new imagickpixel('rgb('.$color[0].','.$color[1].','.$color[2].')'); $png = new Imagick(); $png->newImage($width, $height, 'none', 'png'); $bar = new imagickdraw(); $bar->setfillcolor($fgcol); } else { return false; } // print barcode elements $y = 0; // for each row for ($r = 0; $r < $this->barcode_array['num_rows']; ++$r) { $x = 0; // for each column for ($c = 0; $c < $this->barcode_array['num_cols']; ++$c) { if ($this->barcode_array['bcode'][$r][$c] == 1) { // draw a single barcode cell if ($imagick) { $bar->rectangle($x, $y, ($x + $w - 1), ($y + $h - 1)); } else { imagefilledrectangle($png, $x, $y, ($x + $w - 1), ($y + $h - 1), $fgcol); } } $x += $w; } $y += $h; } if ($imagick) { $png->drawimage($bar); return $png; } else { ob_start(); imagepng($png); $imagedata = ob_get_clean(); imagedestroy($png); return $imagedata; } } /** * Set the barcode.
< * @param $code (string) code to print < * @param $type (string) type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>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".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul> < * @return array
> * @param string $code code to print > * @param string $type type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>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".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul> > * @return void
*/ public function setBarcode($code, $type) { $mode = explode(',', $type); $qrtype = strtoupper($mode[0]); switch ($qrtype) { case 'DATAMATRIX': { // DATAMATRIX (ISO/IEC 16022) require_once(dirname(__FILE__).'/include/barcodes/datamatrix.php'); $qrcode = new Datamatrix($code); $this->barcode_array = $qrcode->getBarcodeArray(); $this->barcode_array['code'] = $code; break; } case 'PDF417': { // PDF417 (ISO/IEC 15438:2006) require_once(dirname(__FILE__).'/include/barcodes/pdf417.php'); if (!isset($mode[1]) OR ($mode[1] === '')) { $aspectratio = 2; // default aspect ratio (width / height) } else { $aspectratio = floatval($mode[1]); } if (!isset($mode[2]) OR ($mode[2] === '')) { $ecl = -1; // default error correction level (auto) } else { $ecl = intval($mode[2]); } // set macro block $macro = array(); if (isset($mode[3]) AND ($mode[3] !== '') AND isset($mode[4]) AND ($mode[4] !== '') AND isset($mode[5]) AND ($mode[5] !== '')) { $macro['segment_total'] = intval($mode[3]); $macro['segment_index'] = intval($mode[4]); $macro['file_id'] = strtr($mode[5], "\xff", ','); for ($i = 0; $i < 7; ++$i) { $o = $i + 6; if (isset($mode[$o]) AND ($mode[$o] !== '')) { // add option $macro['option_'.$i] = strtr($mode[$o], "\xff", ','); } } } $qrcode = new PDF417($code, $ecl, $aspectratio, $macro); $this->barcode_array = $qrcode->getBarcodeArray(); $this->barcode_array['code'] = $code; break; } case 'QRCODE': { // QR-CODE require_once(dirname(__FILE__).'/include/barcodes/qrcode.php'); if (!isset($mode[1]) OR (!in_array($mode[1],array('L','M','Q','H')))) { $mode[1] = 'L'; // Ddefault: Low error correction } $qrcode = new QRcode($code, strtoupper($mode[1])); $this->barcode_array = $qrcode->getBarcodeArray(); $this->barcode_array['code'] = $code; break; } case 'RAW': case 'RAW2': { // RAW MODE // remove spaces $code = preg_replace('/[\s]*/si', '', $code); if (strlen($code) < 3) { break; } if ($qrtype == 'RAW') { // comma-separated rows $rows = explode(',', $code); } else { // RAW2 // rows enclosed in square parentheses $code = substr($code, 1, -1); $rows = explode('][', $code); } $this->barcode_array['num_rows'] = count($rows); $this->barcode_array['num_cols'] = strlen($rows[0]); $this->barcode_array['bcode'] = array(); foreach ($rows as $r) { $this->barcode_array['bcode'][] = str_split($r, 1); } $this->barcode_array['code'] = $code; break; } case 'TEST': { // TEST MODE $this->barcode_array['num_rows'] = 5; $this->barcode_array['num_cols'] = 15; $this->barcode_array['bcode'] = array( array(1,1,1,0,1,1,1,0,1,1,1,0,1,1,1), array(0,1,0,0,1,0,0,0,1,0,0,0,0,1,0), array(0,1,0,0,1,1,0,0,1,1,1,0,0,1,0), array(0,1,0,0,1,0,0,0,0,0,1,0,0,1,0), array(0,1,0,0,1,1,1,0,1,1,1,0,0,1,0)); $this->barcode_array['code'] = $code; break; } default: {
< $this->barcode_array = false;
> $this->barcode_array = array();
} } } } // end of class //============================================================+ // END OF FILE //============================================================+