]>
git.immae.eu Git - github/wallabag/wallabag.git/blob - inc/3rdparty/libraries/tcpdf/tcpdf_barcodes_2d.php
2 //============================================================+
3 // File name : tcpdf_barcodes_2d.php
6 // Last Update : 2014-05-20
7 // Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
8 // License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
9 // -------------------------------------------------------------------
10 // Copyright (C) 2009-2014 Nicola Asuni - Tecnick.com LTD
12 // This file is part of TCPDF software library.
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.
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.
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/>.
27 // See LICENSE.TXT file for more information.
28 // -------------------------------------------------------------------
30 // Description : PHP class to creates array representations for
31 // 2D barcodes to be used with TCPDF.
33 //============================================================+
37 * PHP class to creates array representations for 2D barcodes to be used with TCPDF.
38 * @package com.tecnick.tcpdf
39 * @author Nicola Asuni
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
48 * @author Nicola Asuni
50 class TCPDF2DBarcode
{
53 * Array representation of barcode.
56 protected $barcode_array = false ;
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>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>
68 public function __construct ( $code , $type ) {
69 $this- > setBarcode ( $code , $type );
73 * Return an array representations of barcode.
76 public function getBarcodeArray () {
77 return $this- > barcode_array
;
81 * Send barcode as SVG image object to the standard output.
82 * @param $w (int) Width of a single rectangle element in user units.
83 * @param $h (int) Height of a single rectangle element in user units.
84 * @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
87 public function getBarcodeSVG ( $w = 3 , $h = 3 , $color = 'black' ) {
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));
101 * Return a SVG string representation of barcode.
102 * @param $w (int) Width of a single rectangle element in user units.
103 * @param $h (int) Height of a single rectangle element in user units.
104 * @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
105 * @return string SVG code.
108 public function getBarcodeSVGcode ( $w = 3 , $h = 3 , $color = 'black' ) {
109 // replace table for special characters
110 $repstr = array ( "\0" => '' , '&' => '&' , '<' => '<' , '>' => '>' );
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
119 for ( $r = 0 ; $r < $this- > barcode_array
[ 'num_rows' ]; ++
$r ) {
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 " ;
131 $svg .= " \t " . '</g>' . " \n " ;
132 $svg .= '</svg>' . " \n " ;
137 * Return an HTML representation of barcode.
138 * @param $w (int) Width of a single rectangle element in pixels.
139 * @param $h (int) Height of a single rectangle element in pixels.
140 * @param $color (string) Foreground color for bar elements (background is transparent).
141 * @return string HTML code.
144 public function getBarcodeHTML ( $w = 10 , $h = 10 , $color = 'black' ) {
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
149 for ( $r = 0 ; $r < $this- > barcode_array
[ 'num_rows' ]; ++
$r ) {
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;"> </div>' . " \n " ;
161 $html .= '</div>' . " \n " ;
166 * Send a PNG image representation of barcode (requires GD or Imagick library).
167 * @param $w (int) Width of a single rectangle element in pixels.
168 * @param $h (int) Height of a single rectangle element in pixels.
169 * @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
172 public function getBarcodePNG ( $w = 3 , $h = 3 , $color = array ( 0 , 0 , 0 )) {
173 $data = $this- > getBarcodePngData ( $w , $h , $color );
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));
186 * Return a PNG image representation of barcode (requires GD or Imagick library).
187 * @param $w (int) Width of a single rectangle element in pixels.
188 * @param $h (int) Height of a single rectangle element in pixels.
189 * @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
190 * @return image or false in case of error.
193 public function getBarcodePngData ( $w = 3 , $h = 3 , $color = array ( 0 , 0 , 0 )) {
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' )) {
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' )) {
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 );
215 // print barcode elements
218 for ( $r = 0 ; $r < $this- > barcode_array
[ 'num_rows' ]; ++
$r ) {
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
225 $bar- > rectangle ( $x , $y , ( $x +
$w - 1 ), ( $y +
$h - 1 ));
227 imagefilledrectangle ( $png , $x , $y , ( $x +
$w - 1 ), ( $y +
$h - 1 ), $fgcol );
235 $png- > drawimage ( $bar );
240 $imagedata = ob_get_clean ();
248 * @param $code (string) code to print
249 * @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>
252 public function setBarcode ( $code , $type ) {
253 $mode = explode ( ',' , $type );
254 $qrtype = strtoupper ( $mode [ 0 ]);
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 ;
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)
268 $aspectratio = floatval ( $mode [ 1 ]);
270 if (! isset ( $mode [ 2 ]) OR ( $mode [ 2 ] === '' )) {
271 $ecl = - 1 ; // default error correction level (auto)
273 $ecl = intval ( $mode [ 2 ]);
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 ) {
283 if ( isset ( $mode [ $o ]) AND ( $mode [ $o ] !== '' )) {
285 $macro [ 'option_' . $i ] = strtr ( $mode [ $o ], " \xff " , ',' );
289 $qrcode = new PDF417 ( $code , $ecl , $aspectratio , $macro );
290 $this- > barcode_array
= $qrcode- > getBarcodeArray ();
291 $this- > barcode_array
[ 'code' ] = $code ;
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
299 $qrcode = new QRcode ( $code , strtoupper ( $mode [ 1 ]));
300 $this- > barcode_array
= $qrcode- > getBarcodeArray ();
301 $this- > barcode_array
[ 'code' ] = $code ;
305 case 'RAW2' : { // RAW MODE
307 $code = preg_replace ( '/[\s]*/si' , '' , $code );
308 if ( strlen ( $code ) < 3 ) {
311 if ( $qrtype == 'RAW' ) {
312 // comma-separated rows
313 $rows = explode ( ',' , $code );
315 // rows enclosed in square parentheses
316 $code = substr ( $code , 1 , - 1 );
317 $rows = explode ( '][' , $code );
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 );
325 $this- > barcode_array
[ 'code' ] = $code ;
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 ;
341 $this- > barcode_array
= false ;
347 //============================================================+
349 //============================================================+