libraries/tcpdf/2dbarcodes.php

   1 <?php
   2 //============================================================+
   3 // File name   : 2dbarcodes.php
   4 // Version     : 1.0.007
   5 // Begin       : 2009-04-07
   6 // Last Update : 2010-12-16
   7 // Author      : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
   8 // License     : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
   9 // -------------------------------------------------------------------
  10 // Copyright (C) 2009-2010  Nicola Asuni - Tecnick.com S.r.l.
  11 //
  12 // This file is part of TCPDF software library.
  13 //
  14 // TCPDF is free software: you can redistribute it and/or modify it
  15 // under the terms of the GNU Lesser General Public License as
  16 // published by the Free Software Foundation, either version 3 of the
  17 // License, or (at your option) any later version.
  18 //
  19 // TCPDF is distributed in the hope that it will be useful, but
  20 // WITHOUT ANY WARRANTY; without even the implied warranty of
  21 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22 // See the GNU Lesser General Public License for more details.
  23 //
  24 // You should have received a copy of the GNU Lesser General Public License
  25 // along with TCPDF.  If not, see <http://www.gnu.org/licenses/>.
  26 //
  27 // See LICENSE.TXT file for more information.
  28 // -------------------------------------------------------------------
  29 //
  30 // Description : PHP class to creates array representations for
  31 //               2D barcodes to be used with TCPDF.
  32 //
  33 //============================================================+
  34
  35 /**
  36  * @file
  37  * PHP class to creates array representations for 2D barcodes to be used with TCPDF.
  38  * @package com.tecnick.tcpdf
  39  * @author Nicola Asuni
  40  * @version 1.0.007
  41  */
  42
  43 /**
  44  * @class TCPDF2DBarcode
  45  * PHP class to creates array representations for 2D barcodes to be used with TCPDF (http://www.tcpdf.org).
  46  * @package com.tecnick.tcpdf
  47  * @version 1.0.007
  48  * @author Nicola Asuni
  49  */
  50 class TCPDF2DBarcode {
  51
  52         /**
  53          * Array representation of barcode.
  54          * @protected
  55          */
  56         protected $barcode_array = false;
  57
  58         /**
  59          * This is the class constructor.
  60          * Return an array representations for 2D barcodes:<ul>
  61          * <li>$arrcode['code'] code to be printed on text label</li>
  62          * <li>$arrcode['num_rows'] required number of rows</li>
  63          * <li>$arrcode['num_cols'] required number of columns</li>
  64          * <li>$arrcode['bcode'][$r][$c] value of the cell is $r row and $c column (0 = transparent, 1 = black)</li></ul>
  65          * @param $code (string) code to print
  66          * @param $type (string) type of barcode: <ul><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>QRCODE : QR-CODE Low error correction</li><li>QRCODE,L : QR-CODE Low error correction</li><li>QRCODE,M : QR-CODE Medium error correction</li><li>QRCODE,Q : QR-CODE Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</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></ul>
  67          */
  68         public function __construct($code, $type) {
  69                 $this->setBarcode($code, $type);
  70         }
  71
  72         /**
  73          * Return an array representations of barcode.
  74          * @return array
  75          */
  76         public function getBarcodeArray() {
  77                 return $this->barcode_array;
  78         }
  79
  80         /**
  81          * Set the barcode.
  82          * @param $code (string) code to print
  83          * @param $type (string) type of barcode: <ul><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>QRCODE : QR-CODE Low error correction</li><li>QRCODE,L : QR-CODE Low error correction</li><li>QRCODE,M : QR-CODE Medium error correction</li><li>QRCODE,Q : QR-CODE Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</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></ul>
  84          * @return array
  85          */
  86         public function setBarcode($code, $type) {
  87                 $mode = explode(',', $type);
  88                 $qrtype = strtoupper($mode[0]);
  89                 switch ($qrtype) {
  90                         case 'QRCODE': { // QR-CODE
  91                                 require_once(dirname(__FILE__).'/qrcode.php');
  92                                 if (!isset($mode[1]) OR (!in_array($mode[1],array('L','M','Q','H')))) {
  93                                         $mode[1] = 'L'; // Ddefault: Low error correction
  94                                 }
  95                                 $qrcode = new QRcode($code, strtoupper($mode[1]));
  96                                 $this->barcode_array = $qrcode->getBarcodeArray();
  97                                 break;
  98                         }
  99                         case 'PDF417': { // PDF417 (ISO/IEC 15438:2006)
 100                                 require_once(dirname(__FILE__).'/pdf417.php');
 101                                 if (!isset($mode[1]) OR ($mode[1] === '')) {
 102                                         $aspectratio = 2; // default aspect ratio (width / height)
 103                                 } else {
 104                                         $aspectratio = floatval($mode[1]);
 105                                 }
 106                                 if (!isset($mode[2]) OR ($mode[2] === '')) {
 107                                         $ecl = -1; // default error correction level (auto)
 108                                 } else {
 109                                         $ecl = intval($mode[2]);
 110                                 }
 111                                 // set macro block
 112                                 $macro = array();
 113                                 if (isset($mode[3]) AND ($mode[3] !== '') AND isset($mode[4]) AND ($mode[4] !== '') AND isset($mode[5]) AND ($mode[5] !== '')) {
 114                                         $macro['segment_total'] = intval($mode[3]);
 115                                         $macro['segment_index'] = intval($mode[4]);
 116                                         $macro['file_id'] = strtr($mode[5], "\xff", ',');
 117                                         for ($i = 0; $i < 7; ++$i) {
 118                                                 $o = $i + 6;
 119                                                 if (isset($mode[$o]) AND ($mode[$o] !== '')) {
 120                                                         // add option
 121                                                         $macro['option_'.$i] = strtr($mode[$o], "\xff", ',');
 122                                                 }
 123                                         }
 124                                 }
 125                                 $qrcode = new PDF417($code, $ecl, $aspectratio, $macro);
 126                                 $this->barcode_array = $qrcode->getBarcodeArray();
 127                                 break;
 128                         }
 129                         case 'RAW':
 130                         case 'RAW2': { // RAW MODE
 131                                 // remove spaces
 132                                 $code = preg_replace('/[\s]*/si', '', $code);
 133                                 if (strlen($code) < 3) {
 134                                         break;
 135                                 }
 136                                 if ($qrtype == 'RAW') {
 137                                         // comma-separated rows
 138                                         $rows = explode(',', $code);
 139                                 } else { // RAW2
 140                                         // rows enclosed in square parentheses
 141                                         $code = substr($code, 1, -1);
 142                                         $rows = explode('][', $code);
 143                                 }
 144                                 $this->barcode_array['num_rows'] = count($rows);
 145                                 $this->barcode_array['num_cols'] = strlen($rows[0]);
 146                                 $this->barcode_array['bcode'] = array();
 147                                 foreach ($rows as $r) {
 148                                         $this->barcode_array['bcode'][] = str_split($r, 1);
 149                                 }
 150                                 break;
 151                         }
 152                         case 'TEST': { // TEST MODE
 153                                 $this->barcode_array['num_rows'] = 5;
 154                                 $this->barcode_array['num_cols'] = 15;
 155                                 $this->barcode_array['bcode'] = array(
 156                                         array(1,1,1,0,1,1,1,0,1,1,1,0,1,1,1),
 157                                         array(0,1,0,0,1,0,0,0,1,0,0,0,0,1,0),
 158                                         array(0,1,0,0,1,1,0,0,1,1,1,0,0,1,0),
 159                                         array(0,1,0,0,1,0,0,0,0,0,1,0,0,1,0),
 160                                         array(0,1,0,0,1,1,1,0,1,1,1,0,0,1,0));
 161                                 break;
 162                         }
 163                         default: {
 164                                 $this->barcode_array = false;
 165                         }
 166                 }
 167         }
 168 } // end of class
 169
 170 //============================================================+
 171 // END OF FILE
 172 //============================================================+