'."\n";
}
//============================================================+
-// END OF FILE
+// END OF FILE
//============================================================+
diff --git a/htdocs/includes/tcpdf/htmlcolors.php b/htdocs/includes/tcpdf/htmlcolors.php
index fd7dff241dc..d1075dd4749 100644
--- a/htdocs/includes/tcpdf/htmlcolors.php
+++ b/htdocs/includes/tcpdf/htmlcolors.php
@@ -3,7 +3,7 @@
// File name : htmlcolors.php
// Version : 1.0.008
// Begin : 2002-04-09
-// Last Update : 2010-11-11
+// Last Update : 2010-12-16
// Author : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
@@ -32,14 +32,12 @@
//============================================================+
/**
+ * @file
* Array of WEB safe colors
* @author Nicola Asuni
- * @copyright 2002-2009 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
* @package com.tecnick.tcpdf
- * @link http://www.tcpdf.org
- * @license http://www.gnu.org/copyleft/lesser.html LGPL
* @since 2.9.000 (2008-03-26)
-*/
+ */
/**
* Array of WEB safe colors
diff --git a/htdocs/includes/tcpdf/pdf417.php b/htdocs/includes/tcpdf/pdf417.php
index d31163b9ed8..995daa261bb 100644
--- a/htdocs/includes/tcpdf/pdf417.php
+++ b/htdocs/includes/tcpdf/pdf417.php
@@ -3,7 +3,7 @@
// File name : pdf417.php
// Version : 1.0.003
// Begin : 2010-06-03
-// Last Update : 2010-08-08
+// Last Update : 2010-12-16
// Author : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
@@ -44,15 +44,12 @@
//============================================================+
/**
+ * @file
* Class to create PDF417 barcode arrays for TCPDF class.
* PDF417 (ISO/IEC 15438:2006) is a 2-dimensional stacked bar code created by Symbol Technologies in 1991.
* (requires PHP bcmath extension)
* @package com.tecnick.tcpdf
- * @abstract Class to create PDF417 barcode arrays for TCPDF class.
* @author Nicola Asuni
- * @copyright 2010-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
- * @link http://www.tcpdf.org
- * @license http://www.gnu.org/copyleft/lesser.html LGPL
* @version 1.0.003
*/
@@ -81,923 +78,914 @@ if (!defined('PDF417DEFS')) {
*/
define('QUIETV', 2);
-
-
} // end of definitions
// #*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#
-if (!class_exists('PDF417', false)) {
+/**
+ * @class PDF417
+ * Class to create PDF417 barcode arrays for TCPDF class.
+ * PDF417 (ISO/IEC 15438:2006) is a 2-dimensional stacked bar code created by Symbol Technologies in 1991.
+ * @package com.tecnick.tcpdf
+ * @author Nicola Asuni
+ * @version 1.0.003
+ */
+class PDF417 {
/**
- * Class to create PDF417 barcode arrays for TCPDF class.
- * PDF417 (ISO/IEC 15438:2006) is a 2-dimensional stacked bar code created by Symbol Technologies in 1991.
- * @name PDF417
- * @package com.tecnick.tcpdf
- * @abstract Class to create PDF417 barcode arrays for TCPDF class.
- * @author Nicola Asuni
- * @copyright 2010-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
- * @link http://www.tcpdf.org
- * @license http://www.gnu.org/copyleft/lesser.html LGPL
- * @version 1.0.003
+ * Barcode array to be returned which is readable by TCPDF.
+ * @protected
*/
- class PDF417 {
+ protected $barcode_array = array();
- /**
- * @var barcode array to be returned which is readable by TCPDF
- * @access protected
- */
- protected $barcode_array = array();
+ /**
+ * Start pattern.
+ * @protected
+ */
+ protected $start_pattern = '11111111010101000';
- /**
- * @var start pattern
- * @access protected
- */
- protected $start_pattern = '11111111010101000';
+ /**
+ * Stop pattern.
+ * @protected
+ */
+ protected $stop_pattern = '111111101000101001';
- /**
- * @var start pattern
- * @access protected
- */
- protected $stop_pattern = '111111101000101001';
+ /**
+ * Array of text Compaction Sub-Modes (values 0xFB - 0xFF are used for submode changers).
+ * @protected
+ */
+ protected $textsubmodes = array(
+ array(0x41,0x42,0x43,0x44,0x45,0x46,0x47,0x48,0x49,0x4a,0x4b,0x4c,0x4d,0x4e,0x4f,0x50,0x51,0x52,0x53,0x54,0x55,0x56,0x57,0x58,0x59,0x5a,0x20,0xFD,0xFE,0xFF), // Alpha
+ array(0x61,0x62,0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6a,0x6b,0x6c,0x6d,0x6e,0x6f,0x70,0x71,0x72,0x73,0x74,0x75,0x76,0x77,0x78,0x79,0x7a,0x20,0xFD,0xFE,0xFF), // Lower
+ array(0x30,0x31,0x32,0x33,0x34,0x35,0x36,0x37,0x38,0x39,0x26,0x0d,0x09,0x2c,0x3a,0x23,0x2d,0x2e,0x24,0x2f,0x2b,0x25,0x2a,0x3d,0x5e,0xFB,0x20,0xFD,0xFE,0xFF), // Mixed
+ array(0x3b,0x3c,0x3e,0x40,0x5b,0x5c,0x5d,0x5f,0x60,0x7e,0x21,0x0d,0x09,0x2c,0x3a,0x0a,0x2d,0x2e,0x24,0x2f,0x22,0x7c,0x2a,0x28,0x29,0x3f,0x7b,0x7d,0x27,0xFF) // Puntuaction
+ );
- /**
- * @var Text Compaction Sub-Modes (values 0xFB - 0xFF are used for submode changers)
- * @access protected
- */
- protected $textsubmodes = array(
- array(0x41,0x42,0x43,0x44,0x45,0x46,0x47,0x48,0x49,0x4a,0x4b,0x4c,0x4d,0x4e,0x4f,0x50,0x51,0x52,0x53,0x54,0x55,0x56,0x57,0x58,0x59,0x5a,0x20,0xFD,0xFE,0xFF), // Alpha
- array(0x61,0x62,0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6a,0x6b,0x6c,0x6d,0x6e,0x6f,0x70,0x71,0x72,0x73,0x74,0x75,0x76,0x77,0x78,0x79,0x7a,0x20,0xFD,0xFE,0xFF), // Lower
- array(0x30,0x31,0x32,0x33,0x34,0x35,0x36,0x37,0x38,0x39,0x26,0x0d,0x09,0x2c,0x3a,0x23,0x2d,0x2e,0x24,0x2f,0x2b,0x25,0x2a,0x3d,0x5e,0xFB,0x20,0xFD,0xFE,0xFF), // Mixed
- array(0x3b,0x3c,0x3e,0x40,0x5b,0x5c,0x5d,0x5f,0x60,0x7e,0x21,0x0d,0x09,0x2c,0x3a,0x0a,0x2d,0x2e,0x24,0x2f,0x22,0x7c,0x2a,0x28,0x29,0x3f,0x7b,0x7d,0x27,0xFF) // Puntuaction
- );
+ /**
+ * Array of switching codes for Text Compaction Sub-Modes.
+ * @protected
+ */
+ protected $textlatch = array(
+ '01' => array(27), '02' => array(28), '03' => array(28,25), //
+ '10' => array(28,28), '12' => array(28), '13' => array(28,25), //
+ '20' => array(28), '21' => array(27), '23' => array(25), //
+ '30' => array(29), '31' => array(29,27), '32' => array(29,28) //
+ );
- /**
- * @var Switching codes for Text Compaction Sub-Modes
- * @access protected
- */
- protected $textlatch = array(
- '01' => array(27), '02' => array(28), '03' => array(28,25), //
- '10' => array(28,28), '12' => array(28), '13' => array(28,25), //
- '20' => array(28), '21' => array(27), '23' => array(25), //
- '30' => array(29), '31' => array(29,27), '32' => array(29,28) //
- );
+ /**
+ * Clusters of codewords (0, 3, 6)
+ * Values are hex equivalents of binary representation of bars (1 = bar, 0 = space).
+ * The codewords numbered from 900 to 928 have special meaning, some enable to switch between modes in order to optimise the code:
+ * - 900 : Switch to "Text" mode
+ * - 901 : Switch to "Byte" mode
+ * - 902 : Switch to "Numeric" mode
+ * - 903 - 912 : Reserved
+ * - 913 : Switch to "Octet" only for the next codeword
+ * - 914 - 920 : Reserved
+ * - 921 : Initialization
+ * - 922 : Terminator codeword for Macro PDF control block
+ * - 923 : Sequence tag to identify the beginning of optional fields in the Macro PDF control block
+ * - 924 : Switch to "Byte" mode (If the total number of byte is multiple of 6)
+ * - 925 : Identifier for a user defined Extended Channel Interpretation (ECI)
+ * - 926 : Identifier for a general purpose ECI format
+ * - 927 : Identifier for an ECI of a character set or code page
+ * - 928 : Macro marker codeword to indicate the beginning of a Macro PDF Control Block
+ *
+ * @protected
+ */
+ protected $clusters = array(
+ array( // cluster 0 -----------------------------------------------------------------------
+ 0x1d5c0,0x1eaf0,0x1f57c,0x1d4e0,0x1ea78,0x1f53e,0x1a8c0,0x1d470,0x1a860,0x15040, // 10
+ 0x1a830,0x15020,0x1adc0,0x1d6f0,0x1eb7c,0x1ace0,0x1d678,0x1eb3e,0x158c0,0x1ac70, // 20
+ 0x15860,0x15dc0,0x1aef0,0x1d77c,0x15ce0,0x1ae78,0x1d73e,0x15c70,0x1ae3c,0x15ef0, // 30
+ 0x1af7c,0x15e78,0x1af3e,0x15f7c,0x1f5fa,0x1d2e0,0x1e978,0x1f4be,0x1a4c0,0x1d270, // 40
+ 0x1e93c,0x1a460,0x1d238,0x14840,0x1a430,0x1d21c,0x14820,0x1a418,0x14810,0x1a6e0, // 50
+ 0x1d378,0x1e9be,0x14cc0,0x1a670,0x1d33c,0x14c60,0x1a638,0x1d31e,0x14c30,0x1a61c, // 60
+ 0x14ee0,0x1a778,0x1d3be,0x14e70,0x1a73c,0x14e38,0x1a71e,0x14f78,0x1a7be,0x14f3c, // 70
+ 0x14f1e,0x1a2c0,0x1d170,0x1e8bc,0x1a260,0x1d138,0x1e89e,0x14440,0x1a230,0x1d11c, // 80
+ 0x14420,0x1a218,0x14410,0x14408,0x146c0,0x1a370,0x1d1bc,0x14660,0x1a338,0x1d19e, // 90
+ 0x14630,0x1a31c,0x14618,0x1460c,0x14770,0x1a3bc,0x14738,0x1a39e,0x1471c,0x147bc, // 100
+ 0x1a160,0x1d0b8,0x1e85e,0x14240,0x1a130,0x1d09c,0x14220,0x1a118,0x1d08e,0x14210, // 110
+ 0x1a10c,0x14208,0x1a106,0x14360,0x1a1b8,0x1d0de,0x14330,0x1a19c,0x14318,0x1a18e, // 120
+ 0x1430c,0x14306,0x1a1de,0x1438e,0x14140,0x1a0b0,0x1d05c,0x14120,0x1a098,0x1d04e, // 130
+ 0x14110,0x1a08c,0x14108,0x1a086,0x14104,0x141b0,0x14198,0x1418c,0x140a0,0x1d02e, // 140
+ 0x1a04c,0x1a046,0x14082,0x1cae0,0x1e578,0x1f2be,0x194c0,0x1ca70,0x1e53c,0x19460, // 150
+ 0x1ca38,0x1e51e,0x12840,0x19430,0x12820,0x196e0,0x1cb78,0x1e5be,0x12cc0,0x19670, // 160
+ 0x1cb3c,0x12c60,0x19638,0x12c30,0x12c18,0x12ee0,0x19778,0x1cbbe,0x12e70,0x1973c, // 170
+ 0x12e38,0x12e1c,0x12f78,0x197be,0x12f3c,0x12fbe,0x1dac0,0x1ed70,0x1f6bc,0x1da60, // 180
+ 0x1ed38,0x1f69e,0x1b440,0x1da30,0x1ed1c,0x1b420,0x1da18,0x1ed0e,0x1b410,0x1da0c, // 190
+ 0x192c0,0x1c970,0x1e4bc,0x1b6c0,0x19260,0x1c938,0x1e49e,0x1b660,0x1db38,0x1ed9e, // 200
+ 0x16c40,0x12420,0x19218,0x1c90e,0x16c20,0x1b618,0x16c10,0x126c0,0x19370,0x1c9bc, // 210
+ 0x16ec0,0x12660,0x19338,0x1c99e,0x16e60,0x1b738,0x1db9e,0x16e30,0x12618,0x16e18, // 220
+ 0x12770,0x193bc,0x16f70,0x12738,0x1939e,0x16f38,0x1b79e,0x16f1c,0x127bc,0x16fbc, // 230
+ 0x1279e,0x16f9e,0x1d960,0x1ecb8,0x1f65e,0x1b240,0x1d930,0x1ec9c,0x1b220,0x1d918, // 240
+ 0x1ec8e,0x1b210,0x1d90c,0x1b208,0x1b204,0x19160,0x1c8b8,0x1e45e,0x1b360,0x19130, // 250
+ 0x1c89c,0x16640,0x12220,0x1d99c,0x1c88e,0x16620,0x12210,0x1910c,0x16610,0x1b30c, // 260
+ 0x19106,0x12204,0x12360,0x191b8,0x1c8de,0x16760,0x12330,0x1919c,0x16730,0x1b39c, // 270
+ 0x1918e,0x16718,0x1230c,0x12306,0x123b8,0x191de,0x167b8,0x1239c,0x1679c,0x1238e, // 280
+ 0x1678e,0x167de,0x1b140,0x1d8b0,0x1ec5c,0x1b120,0x1d898,0x1ec4e,0x1b110,0x1d88c, // 290
+ 0x1b108,0x1d886,0x1b104,0x1b102,0x12140,0x190b0,0x1c85c,0x16340,0x12120,0x19098, // 300
+ 0x1c84e,0x16320,0x1b198,0x1d8ce,0x16310,0x12108,0x19086,0x16308,0x1b186,0x16304, // 310
+ 0x121b0,0x190dc,0x163b0,0x12198,0x190ce,0x16398,0x1b1ce,0x1638c,0x12186,0x16386, // 320
+ 0x163dc,0x163ce,0x1b0a0,0x1d858,0x1ec2e,0x1b090,0x1d84c,0x1b088,0x1d846,0x1b084, // 330
+ 0x1b082,0x120a0,0x19058,0x1c82e,0x161a0,0x12090,0x1904c,0x16190,0x1b0cc,0x19046, // 340
+ 0x16188,0x12084,0x16184,0x12082,0x120d8,0x161d8,0x161cc,0x161c6,0x1d82c,0x1d826, // 350
+ 0x1b042,0x1902c,0x12048,0x160c8,0x160c4,0x160c2,0x18ac0,0x1c570,0x1e2bc,0x18a60, // 360
+ 0x1c538,0x11440,0x18a30,0x1c51c,0x11420,0x18a18,0x11410,0x11408,0x116c0,0x18b70, // 370
+ 0x1c5bc,0x11660,0x18b38,0x1c59e,0x11630,0x18b1c,0x11618,0x1160c,0x11770,0x18bbc, // 380
+ 0x11738,0x18b9e,0x1171c,0x117bc,0x1179e,0x1cd60,0x1e6b8,0x1f35e,0x19a40,0x1cd30, // 390
+ 0x1e69c,0x19a20,0x1cd18,0x1e68e,0x19a10,0x1cd0c,0x19a08,0x1cd06,0x18960,0x1c4b8, // 400
+ 0x1e25e,0x19b60,0x18930,0x1c49c,0x13640,0x11220,0x1cd9c,0x1c48e,0x13620,0x19b18, // 410
+ 0x1890c,0x13610,0x11208,0x13608,0x11360,0x189b8,0x1c4de,0x13760,0x11330,0x1cdde, // 420
+ 0x13730,0x19b9c,0x1898e,0x13718,0x1130c,0x1370c,0x113b8,0x189de,0x137b8,0x1139c, // 430
+ 0x1379c,0x1138e,0x113de,0x137de,0x1dd40,0x1eeb0,0x1f75c,0x1dd20,0x1ee98,0x1f74e, // 440
+ 0x1dd10,0x1ee8c,0x1dd08,0x1ee86,0x1dd04,0x19940,0x1ccb0,0x1e65c,0x1bb40,0x19920, // 450
+ 0x1eedc,0x1e64e,0x1bb20,0x1dd98,0x1eece,0x1bb10,0x19908,0x1cc86,0x1bb08,0x1dd86, // 460
+ 0x19902,0x11140,0x188b0,0x1c45c,0x13340,0x11120,0x18898,0x1c44e,0x17740,0x13320, // 470
+ 0x19998,0x1ccce,0x17720,0x1bb98,0x1ddce,0x18886,0x17710,0x13308,0x19986,0x17708, // 480
+ 0x11102,0x111b0,0x188dc,0x133b0,0x11198,0x188ce,0x177b0,0x13398,0x199ce,0x17798, // 490
+ 0x1bbce,0x11186,0x13386,0x111dc,0x133dc,0x111ce,0x177dc,0x133ce,0x1dca0,0x1ee58, // 500
+ 0x1f72e,0x1dc90,0x1ee4c,0x1dc88,0x1ee46,0x1dc84,0x1dc82,0x198a0,0x1cc58,0x1e62e, // 510
+ 0x1b9a0,0x19890,0x1ee6e,0x1b990,0x1dccc,0x1cc46,0x1b988,0x19884,0x1b984,0x19882, // 520
+ 0x1b982,0x110a0,0x18858,0x1c42e,0x131a0,0x11090,0x1884c,0x173a0,0x13190,0x198cc, // 530
+ 0x18846,0x17390,0x1b9cc,0x11084,0x17388,0x13184,0x11082,0x13182,0x110d8,0x1886e, // 540
+ 0x131d8,0x110cc,0x173d8,0x131cc,0x110c6,0x173cc,0x131c6,0x110ee,0x173ee,0x1dc50, // 550
+ 0x1ee2c,0x1dc48,0x1ee26,0x1dc44,0x1dc42,0x19850,0x1cc2c,0x1b8d0,0x19848,0x1cc26, // 560
+ 0x1b8c8,0x1dc66,0x1b8c4,0x19842,0x1b8c2,0x11050,0x1882c,0x130d0,0x11048,0x18826, // 570
+ 0x171d0,0x130c8,0x19866,0x171c8,0x1b8e6,0x11042,0x171c4,0x130c2,0x171c2,0x130ec, // 580
+ 0x171ec,0x171e6,0x1ee16,0x1dc22,0x1cc16,0x19824,0x19822,0x11028,0x13068,0x170e8, // 590
+ 0x11022,0x13062,0x18560,0x10a40,0x18530,0x10a20,0x18518,0x1c28e,0x10a10,0x1850c, // 600
+ 0x10a08,0x18506,0x10b60,0x185b8,0x1c2de,0x10b30,0x1859c,0x10b18,0x1858e,0x10b0c, // 610
+ 0x10b06,0x10bb8,0x185de,0x10b9c,0x10b8e,0x10bde,0x18d40,0x1c6b0,0x1e35c,0x18d20, // 620
+ 0x1c698,0x18d10,0x1c68c,0x18d08,0x1c686,0x18d04,0x10940,0x184b0,0x1c25c,0x11b40, // 630
+ 0x10920,0x1c6dc,0x1c24e,0x11b20,0x18d98,0x1c6ce,0x11b10,0x10908,0x18486,0x11b08, // 640
+ 0x18d86,0x10902,0x109b0,0x184dc,0x11bb0,0x10998,0x184ce,0x11b98,0x18dce,0x11b8c, // 650
+ 0x10986,0x109dc,0x11bdc,0x109ce,0x11bce,0x1cea0,0x1e758,0x1f3ae,0x1ce90,0x1e74c, // 660
+ 0x1ce88,0x1e746,0x1ce84,0x1ce82,0x18ca0,0x1c658,0x19da0,0x18c90,0x1c64c,0x19d90, // 670
+ 0x1cecc,0x1c646,0x19d88,0x18c84,0x19d84,0x18c82,0x19d82,0x108a0,0x18458,0x119a0, // 680
+ 0x10890,0x1c66e,0x13ba0,0x11990,0x18ccc,0x18446,0x13b90,0x19dcc,0x10884,0x13b88, // 690
+ 0x11984,0x10882,0x11982,0x108d8,0x1846e,0x119d8,0x108cc,0x13bd8,0x119cc,0x108c6, // 700
+ 0x13bcc,0x119c6,0x108ee,0x119ee,0x13bee,0x1ef50,0x1f7ac,0x1ef48,0x1f7a6,0x1ef44, // 710
+ 0x1ef42,0x1ce50,0x1e72c,0x1ded0,0x1ef6c,0x1e726,0x1dec8,0x1ef66,0x1dec4,0x1ce42, // 720
+ 0x1dec2,0x18c50,0x1c62c,0x19cd0,0x18c48,0x1c626,0x1bdd0,0x19cc8,0x1ce66,0x1bdc8, // 730
+ 0x1dee6,0x18c42,0x1bdc4,0x19cc2,0x1bdc2,0x10850,0x1842c,0x118d0,0x10848,0x18426, // 740
+ 0x139d0,0x118c8,0x18c66,0x17bd0,0x139c8,0x19ce6,0x10842,0x17bc8,0x1bde6,0x118c2, // 750
+ 0x17bc4,0x1086c,0x118ec,0x10866,0x139ec,0x118e6,0x17bec,0x139e6,0x17be6,0x1ef28, // 760
+ 0x1f796,0x1ef24,0x1ef22,0x1ce28,0x1e716,0x1de68,0x1ef36,0x1de64,0x1ce22,0x1de62, // 770
+ 0x18c28,0x1c616,0x19c68,0x18c24,0x1bce8,0x19c64,0x18c22,0x1bce4,0x19c62,0x1bce2, // 780
+ 0x10828,0x18416,0x11868,0x18c36,0x138e8,0x11864,0x10822,0x179e8,0x138e4,0x11862, // 790
+ 0x179e4,0x138e2,0x179e2,0x11876,0x179f6,0x1ef12,0x1de34,0x1de32,0x19c34,0x1bc74, // 800
+ 0x1bc72,0x11834,0x13874,0x178f4,0x178f2,0x10540,0x10520,0x18298,0x10510,0x10508, // 810
+ 0x10504,0x105b0,0x10598,0x1058c,0x10586,0x105dc,0x105ce,0x186a0,0x18690,0x1c34c, // 820
+ 0x18688,0x1c346,0x18684,0x18682,0x104a0,0x18258,0x10da0,0x186d8,0x1824c,0x10d90, // 830
+ 0x186cc,0x10d88,0x186c6,0x10d84,0x10482,0x10d82,0x104d8,0x1826e,0x10dd8,0x186ee, // 840
+ 0x10dcc,0x104c6,0x10dc6,0x104ee,0x10dee,0x1c750,0x1c748,0x1c744,0x1c742,0x18650, // 850
+ 0x18ed0,0x1c76c,0x1c326,0x18ec8,0x1c766,0x18ec4,0x18642,0x18ec2,0x10450,0x10cd0, // 860
+ 0x10448,0x18226,0x11dd0,0x10cc8,0x10444,0x11dc8,0x10cc4,0x10442,0x11dc4,0x10cc2, // 870
+ 0x1046c,0x10cec,0x10466,0x11dec,0x10ce6,0x11de6,0x1e7a8,0x1e7a4,0x1e7a2,0x1c728, // 880
+ 0x1cf68,0x1e7b6,0x1cf64,0x1c722,0x1cf62,0x18628,0x1c316,0x18e68,0x1c736,0x19ee8, // 890
+ 0x18e64,0x18622,0x19ee4,0x18e62,0x19ee2,0x10428,0x18216,0x10c68,0x18636,0x11ce8, // 900
+ 0x10c64,0x10422,0x13de8,0x11ce4,0x10c62,0x13de4,0x11ce2,0x10436,0x10c76,0x11cf6, // 910
+ 0x13df6,0x1f7d4,0x1f7d2,0x1e794,0x1efb4,0x1e792,0x1efb2,0x1c714,0x1cf34,0x1c712, // 920
+ 0x1df74,0x1cf32,0x1df72,0x18614,0x18e34,0x18612,0x19e74,0x18e32,0x1bef4), // 929
+ array( // cluster 3 -----------------------------------------------------------------------
+ 0x1f560,0x1fab8,0x1ea40,0x1f530,0x1fa9c,0x1ea20,0x1f518,0x1fa8e,0x1ea10,0x1f50c, // 10
+ 0x1ea08,0x1f506,0x1ea04,0x1eb60,0x1f5b8,0x1fade,0x1d640,0x1eb30,0x1f59c,0x1d620, // 20
+ 0x1eb18,0x1f58e,0x1d610,0x1eb0c,0x1d608,0x1eb06,0x1d604,0x1d760,0x1ebb8,0x1f5de, // 30
+ 0x1ae40,0x1d730,0x1eb9c,0x1ae20,0x1d718,0x1eb8e,0x1ae10,0x1d70c,0x1ae08,0x1d706, // 40
+ 0x1ae04,0x1af60,0x1d7b8,0x1ebde,0x15e40,0x1af30,0x1d79c,0x15e20,0x1af18,0x1d78e, // 50
+ 0x15e10,0x1af0c,0x15e08,0x1af06,0x15f60,0x1afb8,0x1d7de,0x15f30,0x1af9c,0x15f18, // 60
+ 0x1af8e,0x15f0c,0x15fb8,0x1afde,0x15f9c,0x15f8e,0x1e940,0x1f4b0,0x1fa5c,0x1e920, // 70
+ 0x1f498,0x1fa4e,0x1e910,0x1f48c,0x1e908,0x1f486,0x1e904,0x1e902,0x1d340,0x1e9b0, // 80
+ 0x1f4dc,0x1d320,0x1e998,0x1f4ce,0x1d310,0x1e98c,0x1d308,0x1e986,0x1d304,0x1d302, // 90
+ 0x1a740,0x1d3b0,0x1e9dc,0x1a720,0x1d398,0x1e9ce,0x1a710,0x1d38c,0x1a708,0x1d386, // 100
+ 0x1a704,0x1a702,0x14f40,0x1a7b0,0x1d3dc,0x14f20,0x1a798,0x1d3ce,0x14f10,0x1a78c, // 110
+ 0x14f08,0x1a786,0x14f04,0x14fb0,0x1a7dc,0x14f98,0x1a7ce,0x14f8c,0x14f86,0x14fdc, // 120
+ 0x14fce,0x1e8a0,0x1f458,0x1fa2e,0x1e890,0x1f44c,0x1e888,0x1f446,0x1e884,0x1e882, // 130
+ 0x1d1a0,0x1e8d8,0x1f46e,0x1d190,0x1e8cc,0x1d188,0x1e8c6,0x1d184,0x1d182,0x1a3a0, // 140
+ 0x1d1d8,0x1e8ee,0x1a390,0x1d1cc,0x1a388,0x1d1c6,0x1a384,0x1a382,0x147a0,0x1a3d8, // 150
+ 0x1d1ee,0x14790,0x1a3cc,0x14788,0x1a3c6,0x14784,0x14782,0x147d8,0x1a3ee,0x147cc, // 160
+ 0x147c6,0x147ee,0x1e850,0x1f42c,0x1e848,0x1f426,0x1e844,0x1e842,0x1d0d0,0x1e86c, // 170
+ 0x1d0c8,0x1e866,0x1d0c4,0x1d0c2,0x1a1d0,0x1d0ec,0x1a1c8,0x1d0e6,0x1a1c4,0x1a1c2, // 180
+ 0x143d0,0x1a1ec,0x143c8,0x1a1e6,0x143c4,0x143c2,0x143ec,0x143e6,0x1e828,0x1f416, // 190
+ 0x1e824,0x1e822,0x1d068,0x1e836,0x1d064,0x1d062,0x1a0e8,0x1d076,0x1a0e4,0x1a0e2, // 200
+ 0x141e8,0x1a0f6,0x141e4,0x141e2,0x1e814,0x1e812,0x1d034,0x1d032,0x1a074,0x1a072, // 210
+ 0x1e540,0x1f2b0,0x1f95c,0x1e520,0x1f298,0x1f94e,0x1e510,0x1f28c,0x1e508,0x1f286, // 220
+ 0x1e504,0x1e502,0x1cb40,0x1e5b0,0x1f2dc,0x1cb20,0x1e598,0x1f2ce,0x1cb10,0x1e58c, // 230
+ 0x1cb08,0x1e586,0x1cb04,0x1cb02,0x19740,0x1cbb0,0x1e5dc,0x19720,0x1cb98,0x1e5ce, // 240
+ 0x19710,0x1cb8c,0x19708,0x1cb86,0x19704,0x19702,0x12f40,0x197b0,0x1cbdc,0x12f20, // 250
+ 0x19798,0x1cbce,0x12f10,0x1978c,0x12f08,0x19786,0x12f04,0x12fb0,0x197dc,0x12f98, // 260
+ 0x197ce,0x12f8c,0x12f86,0x12fdc,0x12fce,0x1f6a0,0x1fb58,0x16bf0,0x1f690,0x1fb4c, // 270
+ 0x169f8,0x1f688,0x1fb46,0x168fc,0x1f684,0x1f682,0x1e4a0,0x1f258,0x1f92e,0x1eda0, // 280
+ 0x1e490,0x1fb6e,0x1ed90,0x1f6cc,0x1f246,0x1ed88,0x1e484,0x1ed84,0x1e482,0x1ed82, // 290
+ 0x1c9a0,0x1e4d8,0x1f26e,0x1dba0,0x1c990,0x1e4cc,0x1db90,0x1edcc,0x1e4c6,0x1db88, // 300
+ 0x1c984,0x1db84,0x1c982,0x1db82,0x193a0,0x1c9d8,0x1e4ee,0x1b7a0,0x19390,0x1c9cc, // 310
+ 0x1b790,0x1dbcc,0x1c9c6,0x1b788,0x19384,0x1b784,0x19382,0x1b782,0x127a0,0x193d8, // 320
+ 0x1c9ee,0x16fa0,0x12790,0x193cc,0x16f90,0x1b7cc,0x193c6,0x16f88,0x12784,0x16f84, // 330
+ 0x12782,0x127d8,0x193ee,0x16fd8,0x127cc,0x16fcc,0x127c6,0x16fc6,0x127ee,0x1f650, // 340
+ 0x1fb2c,0x165f8,0x1f648,0x1fb26,0x164fc,0x1f644,0x1647e,0x1f642,0x1e450,0x1f22c, // 350
+ 0x1ecd0,0x1e448,0x1f226,0x1ecc8,0x1f666,0x1ecc4,0x1e442,0x1ecc2,0x1c8d0,0x1e46c, // 360
+ 0x1d9d0,0x1c8c8,0x1e466,0x1d9c8,0x1ece6,0x1d9c4,0x1c8c2,0x1d9c2,0x191d0,0x1c8ec, // 370
+ 0x1b3d0,0x191c8,0x1c8e6,0x1b3c8,0x1d9e6,0x1b3c4,0x191c2,0x1b3c2,0x123d0,0x191ec, // 380
+ 0x167d0,0x123c8,0x191e6,0x167c8,0x1b3e6,0x167c4,0x123c2,0x167c2,0x123ec,0x167ec, // 390
+ 0x123e6,0x167e6,0x1f628,0x1fb16,0x162fc,0x1f624,0x1627e,0x1f622,0x1e428,0x1f216, // 400
+ 0x1ec68,0x1f636,0x1ec64,0x1e422,0x1ec62,0x1c868,0x1e436,0x1d8e8,0x1c864,0x1d8e4, // 410
+ 0x1c862,0x1d8e2,0x190e8,0x1c876,0x1b1e8,0x1d8f6,0x1b1e4,0x190e2,0x1b1e2,0x121e8, // 420
+ 0x190f6,0x163e8,0x121e4,0x163e4,0x121e2,0x163e2,0x121f6,0x163f6,0x1f614,0x1617e, // 430
+ 0x1f612,0x1e414,0x1ec34,0x1e412,0x1ec32,0x1c834,0x1d874,0x1c832,0x1d872,0x19074, // 440
+ 0x1b0f4,0x19072,0x1b0f2,0x120f4,0x161f4,0x120f2,0x161f2,0x1f60a,0x1e40a,0x1ec1a, // 450
+ 0x1c81a,0x1d83a,0x1903a,0x1b07a,0x1e2a0,0x1f158,0x1f8ae,0x1e290,0x1f14c,0x1e288, // 460
+ 0x1f146,0x1e284,0x1e282,0x1c5a0,0x1e2d8,0x1f16e,0x1c590,0x1e2cc,0x1c588,0x1e2c6, // 470
+ 0x1c584,0x1c582,0x18ba0,0x1c5d8,0x1e2ee,0x18b90,0x1c5cc,0x18b88,0x1c5c6,0x18b84, // 480
+ 0x18b82,0x117a0,0x18bd8,0x1c5ee,0x11790,0x18bcc,0x11788,0x18bc6,0x11784,0x11782, // 490
+ 0x117d8,0x18bee,0x117cc,0x117c6,0x117ee,0x1f350,0x1f9ac,0x135f8,0x1f348,0x1f9a6, // 500
+ 0x134fc,0x1f344,0x1347e,0x1f342,0x1e250,0x1f12c,0x1e6d0,0x1e248,0x1f126,0x1e6c8, // 510
+ 0x1f366,0x1e6c4,0x1e242,0x1e6c2,0x1c4d0,0x1e26c,0x1cdd0,0x1c4c8,0x1e266,0x1cdc8, // 520
+ 0x1e6e6,0x1cdc4,0x1c4c2,0x1cdc2,0x189d0,0x1c4ec,0x19bd0,0x189c8,0x1c4e6,0x19bc8, // 530
+ 0x1cde6,0x19bc4,0x189c2,0x19bc2,0x113d0,0x189ec,0x137d0,0x113c8,0x189e6,0x137c8, // 540
+ 0x19be6,0x137c4,0x113c2,0x137c2,0x113ec,0x137ec,0x113e6,0x137e6,0x1fba8,0x175f0, // 550
+ 0x1bafc,0x1fba4,0x174f8,0x1ba7e,0x1fba2,0x1747c,0x1743e,0x1f328,0x1f996,0x132fc, // 560
+ 0x1f768,0x1fbb6,0x176fc,0x1327e,0x1f764,0x1f322,0x1767e,0x1f762,0x1e228,0x1f116, // 570
+ 0x1e668,0x1e224,0x1eee8,0x1f776,0x1e222,0x1eee4,0x1e662,0x1eee2,0x1c468,0x1e236, // 580
+ 0x1cce8,0x1c464,0x1dde8,0x1cce4,0x1c462,0x1dde4,0x1cce2,0x1dde2,0x188e8,0x1c476, // 590
+ 0x199e8,0x188e4,0x1bbe8,0x199e4,0x188e2,0x1bbe4,0x199e2,0x1bbe2,0x111e8,0x188f6, // 600
+ 0x133e8,0x111e4,0x177e8,0x133e4,0x111e2,0x177e4,0x133e2,0x177e2,0x111f6,0x133f6, // 610
+ 0x1fb94,0x172f8,0x1b97e,0x1fb92,0x1727c,0x1723e,0x1f314,0x1317e,0x1f734,0x1f312, // 620
+ 0x1737e,0x1f732,0x1e214,0x1e634,0x1e212,0x1ee74,0x1e632,0x1ee72,0x1c434,0x1cc74, // 630
+ 0x1c432,0x1dcf4,0x1cc72,0x1dcf2,0x18874,0x198f4,0x18872,0x1b9f4,0x198f2,0x1b9f2, // 640
+ 0x110f4,0x131f4,0x110f2,0x173f4,0x131f2,0x173f2,0x1fb8a,0x1717c,0x1713e,0x1f30a, // 650
+ 0x1f71a,0x1e20a,0x1e61a,0x1ee3a,0x1c41a,0x1cc3a,0x1dc7a,0x1883a,0x1987a,0x1b8fa, // 660
+ 0x1107a,0x130fa,0x171fa,0x170be,0x1e150,0x1f0ac,0x1e148,0x1f0a6,0x1e144,0x1e142, // 670
+ 0x1c2d0,0x1e16c,0x1c2c8,0x1e166,0x1c2c4,0x1c2c2,0x185d0,0x1c2ec,0x185c8,0x1c2e6, // 680
+ 0x185c4,0x185c2,0x10bd0,0x185ec,0x10bc8,0x185e6,0x10bc4,0x10bc2,0x10bec,0x10be6, // 690
+ 0x1f1a8,0x1f8d6,0x11afc,0x1f1a4,0x11a7e,0x1f1a2,0x1e128,0x1f096,0x1e368,0x1e124, // 700
+ 0x1e364,0x1e122,0x1e362,0x1c268,0x1e136,0x1c6e8,0x1c264,0x1c6e4,0x1c262,0x1c6e2, // 710
+ 0x184e8,0x1c276,0x18de8,0x184e4,0x18de4,0x184e2,0x18de2,0x109e8,0x184f6,0x11be8, // 720
+ 0x109e4,0x11be4,0x109e2,0x11be2,0x109f6,0x11bf6,0x1f9d4,0x13af8,0x19d7e,0x1f9d2, // 730
+ 0x13a7c,0x13a3e,0x1f194,0x1197e,0x1f3b4,0x1f192,0x13b7e,0x1f3b2,0x1e114,0x1e334, // 740
+ 0x1e112,0x1e774,0x1e332,0x1e772,0x1c234,0x1c674,0x1c232,0x1cef4,0x1c672,0x1cef2, // 750
+ 0x18474,0x18cf4,0x18472,0x19df4,0x18cf2,0x19df2,0x108f4,0x119f4,0x108f2,0x13bf4, // 760
+ 0x119f2,0x13bf2,0x17af0,0x1bd7c,0x17a78,0x1bd3e,0x17a3c,0x17a1e,0x1f9ca,0x1397c, // 770
+ 0x1fbda,0x17b7c,0x1393e,0x17b3e,0x1f18a,0x1f39a,0x1f7ba,0x1e10a,0x1e31a,0x1e73a, // 780
+ 0x1ef7a,0x1c21a,0x1c63a,0x1ce7a,0x1defa,0x1843a,0x18c7a,0x19cfa,0x1bdfa,0x1087a, // 790
+ 0x118fa,0x139fa,0x17978,0x1bcbe,0x1793c,0x1791e,0x138be,0x179be,0x178bc,0x1789e, // 800
+ 0x1785e,0x1e0a8,0x1e0a4,0x1e0a2,0x1c168,0x1e0b6,0x1c164,0x1c162,0x182e8,0x1c176, // 810
+ 0x182e4,0x182e2,0x105e8,0x182f6,0x105e4,0x105e2,0x105f6,0x1f0d4,0x10d7e,0x1f0d2, // 820
+ 0x1e094,0x1e1b4,0x1e092,0x1e1b2,0x1c134,0x1c374,0x1c132,0x1c372,0x18274,0x186f4, // 830
+ 0x18272,0x186f2,0x104f4,0x10df4,0x104f2,0x10df2,0x1f8ea,0x11d7c,0x11d3e,0x1f0ca, // 840
+ 0x1f1da,0x1e08a,0x1e19a,0x1e3ba,0x1c11a,0x1c33a,0x1c77a,0x1823a,0x1867a,0x18efa, // 850
+ 0x1047a,0x10cfa,0x11dfa,0x13d78,0x19ebe,0x13d3c,0x13d1e,0x11cbe,0x13dbe,0x17d70, // 860
+ 0x1bebc,0x17d38,0x1be9e,0x17d1c,0x17d0e,0x13cbc,0x17dbc,0x13c9e,0x17d9e,0x17cb8, // 870
+ 0x1be5e,0x17c9c,0x17c8e,0x13c5e,0x17cde,0x17c5c,0x17c4e,0x17c2e,0x1c0b4,0x1c0b2, // 880
+ 0x18174,0x18172,0x102f4,0x102f2,0x1e0da,0x1c09a,0x1c1ba,0x1813a,0x1837a,0x1027a, // 890
+ 0x106fa,0x10ebe,0x11ebc,0x11e9e,0x13eb8,0x19f5e,0x13e9c,0x13e8e,0x11e5e,0x13ede, // 900
+ 0x17eb0,0x1bf5c,0x17e98,0x1bf4e,0x17e8c,0x17e86,0x13e5c,0x17edc,0x13e4e,0x17ece, // 910
+ 0x17e58,0x1bf2e,0x17e4c,0x17e46,0x13e2e,0x17e6e,0x17e2c,0x17e26,0x10f5e,0x11f5c, // 920
+ 0x11f4e,0x13f58,0x19fae,0x13f4c,0x13f46,0x11f2e,0x13f6e,0x13f2c,0x13f26), // 929
+ array( // cluster 6 -----------------------------------------------------------------------
+ 0x1abe0,0x1d5f8,0x153c0,0x1a9f0,0x1d4fc,0x151e0,0x1a8f8,0x1d47e,0x150f0,0x1a87c, // 10
+ 0x15078,0x1fad0,0x15be0,0x1adf8,0x1fac8,0x159f0,0x1acfc,0x1fac4,0x158f8,0x1ac7e, // 20
+ 0x1fac2,0x1587c,0x1f5d0,0x1faec,0x15df8,0x1f5c8,0x1fae6,0x15cfc,0x1f5c4,0x15c7e, // 30
+ 0x1f5c2,0x1ebd0,0x1f5ec,0x1ebc8,0x1f5e6,0x1ebc4,0x1ebc2,0x1d7d0,0x1ebec,0x1d7c8, // 40
+ 0x1ebe6,0x1d7c4,0x1d7c2,0x1afd0,0x1d7ec,0x1afc8,0x1d7e6,0x1afc4,0x14bc0,0x1a5f0, // 50
+ 0x1d2fc,0x149e0,0x1a4f8,0x1d27e,0x148f0,0x1a47c,0x14878,0x1a43e,0x1483c,0x1fa68, // 60
+ 0x14df0,0x1a6fc,0x1fa64,0x14cf8,0x1a67e,0x1fa62,0x14c7c,0x14c3e,0x1f4e8,0x1fa76, // 70
+ 0x14efc,0x1f4e4,0x14e7e,0x1f4e2,0x1e9e8,0x1f4f6,0x1e9e4,0x1e9e2,0x1d3e8,0x1e9f6, // 80
+ 0x1d3e4,0x1d3e2,0x1a7e8,0x1d3f6,0x1a7e4,0x1a7e2,0x145e0,0x1a2f8,0x1d17e,0x144f0, // 90
+ 0x1a27c,0x14478,0x1a23e,0x1443c,0x1441e,0x1fa34,0x146f8,0x1a37e,0x1fa32,0x1467c, // 100
+ 0x1463e,0x1f474,0x1477e,0x1f472,0x1e8f4,0x1e8f2,0x1d1f4,0x1d1f2,0x1a3f4,0x1a3f2, // 110
+ 0x142f0,0x1a17c,0x14278,0x1a13e,0x1423c,0x1421e,0x1fa1a,0x1437c,0x1433e,0x1f43a, // 120
+ 0x1e87a,0x1d0fa,0x14178,0x1a0be,0x1413c,0x1411e,0x141be,0x140bc,0x1409e,0x12bc0, // 130
+ 0x195f0,0x1cafc,0x129e0,0x194f8,0x1ca7e,0x128f0,0x1947c,0x12878,0x1943e,0x1283c, // 140
+ 0x1f968,0x12df0,0x196fc,0x1f964,0x12cf8,0x1967e,0x1f962,0x12c7c,0x12c3e,0x1f2e8, // 150
+ 0x1f976,0x12efc,0x1f2e4,0x12e7e,0x1f2e2,0x1e5e8,0x1f2f6,0x1e5e4,0x1e5e2,0x1cbe8, // 160
+ 0x1e5f6,0x1cbe4,0x1cbe2,0x197e8,0x1cbf6,0x197e4,0x197e2,0x1b5e0,0x1daf8,0x1ed7e, // 170
+ 0x169c0,0x1b4f0,0x1da7c,0x168e0,0x1b478,0x1da3e,0x16870,0x1b43c,0x16838,0x1b41e, // 180
+ 0x1681c,0x125e0,0x192f8,0x1c97e,0x16de0,0x124f0,0x1927c,0x16cf0,0x1b67c,0x1923e, // 190
+ 0x16c78,0x1243c,0x16c3c,0x1241e,0x16c1e,0x1f934,0x126f8,0x1937e,0x1fb74,0x1f932, // 200
+ 0x16ef8,0x1267c,0x1fb72,0x16e7c,0x1263e,0x16e3e,0x1f274,0x1277e,0x1f6f4,0x1f272, // 210
+ 0x16f7e,0x1f6f2,0x1e4f4,0x1edf4,0x1e4f2,0x1edf2,0x1c9f4,0x1dbf4,0x1c9f2,0x1dbf2, // 220
+ 0x193f4,0x193f2,0x165c0,0x1b2f0,0x1d97c,0x164e0,0x1b278,0x1d93e,0x16470,0x1b23c, // 230
+ 0x16438,0x1b21e,0x1641c,0x1640e,0x122f0,0x1917c,0x166f0,0x12278,0x1913e,0x16678, // 240
+ 0x1b33e,0x1663c,0x1221e,0x1661e,0x1f91a,0x1237c,0x1fb3a,0x1677c,0x1233e,0x1673e, // 250
+ 0x1f23a,0x1f67a,0x1e47a,0x1ecfa,0x1c8fa,0x1d9fa,0x191fa,0x162e0,0x1b178,0x1d8be, // 260
+ 0x16270,0x1b13c,0x16238,0x1b11e,0x1621c,0x1620e,0x12178,0x190be,0x16378,0x1213c, // 270
+ 0x1633c,0x1211e,0x1631e,0x121be,0x163be,0x16170,0x1b0bc,0x16138,0x1b09e,0x1611c, // 280
+ 0x1610e,0x120bc,0x161bc,0x1209e,0x1619e,0x160b8,0x1b05e,0x1609c,0x1608e,0x1205e, // 290
+ 0x160de,0x1605c,0x1604e,0x115e0,0x18af8,0x1c57e,0x114f0,0x18a7c,0x11478,0x18a3e, // 300
+ 0x1143c,0x1141e,0x1f8b4,0x116f8,0x18b7e,0x1f8b2,0x1167c,0x1163e,0x1f174,0x1177e, // 310
+ 0x1f172,0x1e2f4,0x1e2f2,0x1c5f4,0x1c5f2,0x18bf4,0x18bf2,0x135c0,0x19af0,0x1cd7c, // 320
+ 0x134e0,0x19a78,0x1cd3e,0x13470,0x19a3c,0x13438,0x19a1e,0x1341c,0x1340e,0x112f0, // 330
+ 0x1897c,0x136f0,0x11278,0x1893e,0x13678,0x19b3e,0x1363c,0x1121e,0x1361e,0x1f89a, // 340
+ 0x1137c,0x1f9ba,0x1377c,0x1133e,0x1373e,0x1f13a,0x1f37a,0x1e27a,0x1e6fa,0x1c4fa, // 350
+ 0x1cdfa,0x189fa,0x1bae0,0x1dd78,0x1eebe,0x174c0,0x1ba70,0x1dd3c,0x17460,0x1ba38, // 360
+ 0x1dd1e,0x17430,0x1ba1c,0x17418,0x1ba0e,0x1740c,0x132e0,0x19978,0x1ccbe,0x176e0, // 370
+ 0x13270,0x1993c,0x17670,0x1bb3c,0x1991e,0x17638,0x1321c,0x1761c,0x1320e,0x1760e, // 380
+ 0x11178,0x188be,0x13378,0x1113c,0x17778,0x1333c,0x1111e,0x1773c,0x1331e,0x1771e, // 390
+ 0x111be,0x133be,0x177be,0x172c0,0x1b970,0x1dcbc,0x17260,0x1b938,0x1dc9e,0x17230, // 400
+ 0x1b91c,0x17218,0x1b90e,0x1720c,0x17206,0x13170,0x198bc,0x17370,0x13138,0x1989e, // 410
+ 0x17338,0x1b99e,0x1731c,0x1310e,0x1730e,0x110bc,0x131bc,0x1109e,0x173bc,0x1319e, // 420
+ 0x1739e,0x17160,0x1b8b8,0x1dc5e,0x17130,0x1b89c,0x17118,0x1b88e,0x1710c,0x17106, // 430
+ 0x130b8,0x1985e,0x171b8,0x1309c,0x1719c,0x1308e,0x1718e,0x1105e,0x130de,0x171de, // 440
+ 0x170b0,0x1b85c,0x17098,0x1b84e,0x1708c,0x17086,0x1305c,0x170dc,0x1304e,0x170ce, // 450
+ 0x17058,0x1b82e,0x1704c,0x17046,0x1302e,0x1706e,0x1702c,0x17026,0x10af0,0x1857c, // 460
+ 0x10a78,0x1853e,0x10a3c,0x10a1e,0x10b7c,0x10b3e,0x1f0ba,0x1e17a,0x1c2fa,0x185fa, // 470
+ 0x11ae0,0x18d78,0x1c6be,0x11a70,0x18d3c,0x11a38,0x18d1e,0x11a1c,0x11a0e,0x10978, // 480
+ 0x184be,0x11b78,0x1093c,0x11b3c,0x1091e,0x11b1e,0x109be,0x11bbe,0x13ac0,0x19d70, // 490
+ 0x1cebc,0x13a60,0x19d38,0x1ce9e,0x13a30,0x19d1c,0x13a18,0x19d0e,0x13a0c,0x13a06, // 500
+ 0x11970,0x18cbc,0x13b70,0x11938,0x18c9e,0x13b38,0x1191c,0x13b1c,0x1190e,0x13b0e, // 510
+ 0x108bc,0x119bc,0x1089e,0x13bbc,0x1199e,0x13b9e,0x1bd60,0x1deb8,0x1ef5e,0x17a40, // 520
+ 0x1bd30,0x1de9c,0x17a20,0x1bd18,0x1de8e,0x17a10,0x1bd0c,0x17a08,0x1bd06,0x17a04, // 530
+ 0x13960,0x19cb8,0x1ce5e,0x17b60,0x13930,0x19c9c,0x17b30,0x1bd9c,0x19c8e,0x17b18, // 540
+ 0x1390c,0x17b0c,0x13906,0x17b06,0x118b8,0x18c5e,0x139b8,0x1189c,0x17bb8,0x1399c, // 550
+ 0x1188e,0x17b9c,0x1398e,0x17b8e,0x1085e,0x118de,0x139de,0x17bde,0x17940,0x1bcb0, // 560
+ 0x1de5c,0x17920,0x1bc98,0x1de4e,0x17910,0x1bc8c,0x17908,0x1bc86,0x17904,0x17902, // 570
+ 0x138b0,0x19c5c,0x179b0,0x13898,0x19c4e,0x17998,0x1bcce,0x1798c,0x13886,0x17986, // 580
+ 0x1185c,0x138dc,0x1184e,0x179dc,0x138ce,0x179ce,0x178a0,0x1bc58,0x1de2e,0x17890, // 590
+ 0x1bc4c,0x17888,0x1bc46,0x17884,0x17882,0x13858,0x19c2e,0x178d8,0x1384c,0x178cc, // 600
+ 0x13846,0x178c6,0x1182e,0x1386e,0x178ee,0x17850,0x1bc2c,0x17848,0x1bc26,0x17844, // 610
+ 0x17842,0x1382c,0x1786c,0x13826,0x17866,0x17828,0x1bc16,0x17824,0x17822,0x13816, // 620
+ 0x17836,0x10578,0x182be,0x1053c,0x1051e,0x105be,0x10d70,0x186bc,0x10d38,0x1869e, // 630
+ 0x10d1c,0x10d0e,0x104bc,0x10dbc,0x1049e,0x10d9e,0x11d60,0x18eb8,0x1c75e,0x11d30, // 640
+ 0x18e9c,0x11d18,0x18e8e,0x11d0c,0x11d06,0x10cb8,0x1865e,0x11db8,0x10c9c,0x11d9c, // 650
+ 0x10c8e,0x11d8e,0x1045e,0x10cde,0x11dde,0x13d40,0x19eb0,0x1cf5c,0x13d20,0x19e98, // 660
+ 0x1cf4e,0x13d10,0x19e8c,0x13d08,0x19e86,0x13d04,0x13d02,0x11cb0,0x18e5c,0x13db0, // 670
+ 0x11c98,0x18e4e,0x13d98,0x19ece,0x13d8c,0x11c86,0x13d86,0x10c5c,0x11cdc,0x10c4e, // 680
+ 0x13ddc,0x11cce,0x13dce,0x1bea0,0x1df58,0x1efae,0x1be90,0x1df4c,0x1be88,0x1df46, // 690
+ 0x1be84,0x1be82,0x13ca0,0x19e58,0x1cf2e,0x17da0,0x13c90,0x19e4c,0x17d90,0x1becc, // 700
+ 0x19e46,0x17d88,0x13c84,0x17d84,0x13c82,0x17d82,0x11c58,0x18e2e,0x13cd8,0x11c4c, // 710
+ 0x17dd8,0x13ccc,0x11c46,0x17dcc,0x13cc6,0x17dc6,0x10c2e,0x11c6e,0x13cee,0x17dee, // 720
+ 0x1be50,0x1df2c,0x1be48,0x1df26,0x1be44,0x1be42,0x13c50,0x19e2c,0x17cd0,0x13c48, // 730
+ 0x19e26,0x17cc8,0x1be66,0x17cc4,0x13c42,0x17cc2,0x11c2c,0x13c6c,0x11c26,0x17cec, // 740
+ 0x13c66,0x17ce6,0x1be28,0x1df16,0x1be24,0x1be22,0x13c28,0x19e16,0x17c68,0x13c24, // 750
+ 0x17c64,0x13c22,0x17c62,0x11c16,0x13c36,0x17c76,0x1be14,0x1be12,0x13c14,0x17c34, // 760
+ 0x13c12,0x17c32,0x102bc,0x1029e,0x106b8,0x1835e,0x1069c,0x1068e,0x1025e,0x106de, // 770
+ 0x10eb0,0x1875c,0x10e98,0x1874e,0x10e8c,0x10e86,0x1065c,0x10edc,0x1064e,0x10ece, // 780
+ 0x11ea0,0x18f58,0x1c7ae,0x11e90,0x18f4c,0x11e88,0x18f46,0x11e84,0x11e82,0x10e58, // 790
+ 0x1872e,0x11ed8,0x18f6e,0x11ecc,0x10e46,0x11ec6,0x1062e,0x10e6e,0x11eee,0x19f50, // 800
+ 0x1cfac,0x19f48,0x1cfa6,0x19f44,0x19f42,0x11e50,0x18f2c,0x13ed0,0x19f6c,0x18f26, // 810
+ 0x13ec8,0x11e44,0x13ec4,0x11e42,0x13ec2,0x10e2c,0x11e6c,0x10e26,0x13eec,0x11e66, // 820
+ 0x13ee6,0x1dfa8,0x1efd6,0x1dfa4,0x1dfa2,0x19f28,0x1cf96,0x1bf68,0x19f24,0x1bf64, // 830
+ 0x19f22,0x1bf62,0x11e28,0x18f16,0x13e68,0x11e24,0x17ee8,0x13e64,0x11e22,0x17ee4, // 840
+ 0x13e62,0x17ee2,0x10e16,0x11e36,0x13e76,0x17ef6,0x1df94,0x1df92,0x19f14,0x1bf34, // 850
+ 0x19f12,0x1bf32,0x11e14,0x13e34,0x11e12,0x17e74,0x13e32,0x17e72,0x1df8a,0x19f0a, // 860
+ 0x1bf1a,0x11e0a,0x13e1a,0x17e3a,0x1035c,0x1034e,0x10758,0x183ae,0x1074c,0x10746, // 870
+ 0x1032e,0x1076e,0x10f50,0x187ac,0x10f48,0x187a6,0x10f44,0x10f42,0x1072c,0x10f6c, // 880
+ 0x10726,0x10f66,0x18fa8,0x1c7d6,0x18fa4,0x18fa2,0x10f28,0x18796,0x11f68,0x18fb6, // 890
+ 0x11f64,0x10f22,0x11f62,0x10716,0x10f36,0x11f76,0x1cfd4,0x1cfd2,0x18f94,0x19fb4, // 900
+ 0x18f92,0x19fb2,0x10f14,0x11f34,0x10f12,0x13f74,0x11f32,0x13f72,0x1cfca,0x18f8a, // 910
+ 0x19f9a,0x10f0a,0x11f1a,0x13f3a,0x103ac,0x103a6,0x107a8,0x183d6,0x107a4,0x107a2, // 920
+ 0x10396,0x107b6,0x187d4,0x187d2,0x10794,0x10fb4,0x10792,0x10fb2,0x1c7ea) // 929
+ ); // end of $clusters array
- /**
- * @var clusters of codewords (0, 3, 6)
- * Values are hex equivalents of binary representation of bars (1 = bar, 0 = space).
- * The codewords numbered from 900 to 928 have special meaning, some enable to switch between modes in order to optimise the code:
- * - 900 : Switch to "Text" mode
- * - 901 : Switch to "Byte" mode
- * - 902 : Switch to "Numeric" mode
- * - 903 - 912 : Reserved
- * - 913 : Switch to "Octet" only for the next codeword
- * - 914 - 920 : Reserved
- * - 921 : Initialization
- * - 922 : Terminator codeword for Macro PDF control block
- * - 923 : Sequence tag to identify the beginning of optional fields in the Macro PDF control block
- * - 924 : Switch to "Byte" mode (If the total number of byte is multiple of 6)
- * - 925 : Identifier for a user defined Extended Channel Interpretation (ECI)
- * - 926 : Identifier for a general purpose ECI format
- * - 927 : Identifier for an ECI of a character set or code page
- * - 928 : Macro marker codeword to indicate the beginning of a Macro PDF Control Block
- *
- * @access protected
- */
- protected $clusters = array(
- array( // cluster 0 -----------------------------------------------------------------------
- 0x1d5c0,0x1eaf0,0x1f57c,0x1d4e0,0x1ea78,0x1f53e,0x1a8c0,0x1d470,0x1a860,0x15040, // 10
- 0x1a830,0x15020,0x1adc0,0x1d6f0,0x1eb7c,0x1ace0,0x1d678,0x1eb3e,0x158c0,0x1ac70, // 20
- 0x15860,0x15dc0,0x1aef0,0x1d77c,0x15ce0,0x1ae78,0x1d73e,0x15c70,0x1ae3c,0x15ef0, // 30
- 0x1af7c,0x15e78,0x1af3e,0x15f7c,0x1f5fa,0x1d2e0,0x1e978,0x1f4be,0x1a4c0,0x1d270, // 40
- 0x1e93c,0x1a460,0x1d238,0x14840,0x1a430,0x1d21c,0x14820,0x1a418,0x14810,0x1a6e0, // 50
- 0x1d378,0x1e9be,0x14cc0,0x1a670,0x1d33c,0x14c60,0x1a638,0x1d31e,0x14c30,0x1a61c, // 60
- 0x14ee0,0x1a778,0x1d3be,0x14e70,0x1a73c,0x14e38,0x1a71e,0x14f78,0x1a7be,0x14f3c, // 70
- 0x14f1e,0x1a2c0,0x1d170,0x1e8bc,0x1a260,0x1d138,0x1e89e,0x14440,0x1a230,0x1d11c, // 80
- 0x14420,0x1a218,0x14410,0x14408,0x146c0,0x1a370,0x1d1bc,0x14660,0x1a338,0x1d19e, // 90
- 0x14630,0x1a31c,0x14618,0x1460c,0x14770,0x1a3bc,0x14738,0x1a39e,0x1471c,0x147bc, // 100
- 0x1a160,0x1d0b8,0x1e85e,0x14240,0x1a130,0x1d09c,0x14220,0x1a118,0x1d08e,0x14210, // 110
- 0x1a10c,0x14208,0x1a106,0x14360,0x1a1b8,0x1d0de,0x14330,0x1a19c,0x14318,0x1a18e, // 120
- 0x1430c,0x14306,0x1a1de,0x1438e,0x14140,0x1a0b0,0x1d05c,0x14120,0x1a098,0x1d04e, // 130
- 0x14110,0x1a08c,0x14108,0x1a086,0x14104,0x141b0,0x14198,0x1418c,0x140a0,0x1d02e, // 140
- 0x1a04c,0x1a046,0x14082,0x1cae0,0x1e578,0x1f2be,0x194c0,0x1ca70,0x1e53c,0x19460, // 150
- 0x1ca38,0x1e51e,0x12840,0x19430,0x12820,0x196e0,0x1cb78,0x1e5be,0x12cc0,0x19670, // 160
- 0x1cb3c,0x12c60,0x19638,0x12c30,0x12c18,0x12ee0,0x19778,0x1cbbe,0x12e70,0x1973c, // 170
- 0x12e38,0x12e1c,0x12f78,0x197be,0x12f3c,0x12fbe,0x1dac0,0x1ed70,0x1f6bc,0x1da60, // 180
- 0x1ed38,0x1f69e,0x1b440,0x1da30,0x1ed1c,0x1b420,0x1da18,0x1ed0e,0x1b410,0x1da0c, // 190
- 0x192c0,0x1c970,0x1e4bc,0x1b6c0,0x19260,0x1c938,0x1e49e,0x1b660,0x1db38,0x1ed9e, // 200
- 0x16c40,0x12420,0x19218,0x1c90e,0x16c20,0x1b618,0x16c10,0x126c0,0x19370,0x1c9bc, // 210
- 0x16ec0,0x12660,0x19338,0x1c99e,0x16e60,0x1b738,0x1db9e,0x16e30,0x12618,0x16e18, // 220
- 0x12770,0x193bc,0x16f70,0x12738,0x1939e,0x16f38,0x1b79e,0x16f1c,0x127bc,0x16fbc, // 230
- 0x1279e,0x16f9e,0x1d960,0x1ecb8,0x1f65e,0x1b240,0x1d930,0x1ec9c,0x1b220,0x1d918, // 240
- 0x1ec8e,0x1b210,0x1d90c,0x1b208,0x1b204,0x19160,0x1c8b8,0x1e45e,0x1b360,0x19130, // 250
- 0x1c89c,0x16640,0x12220,0x1d99c,0x1c88e,0x16620,0x12210,0x1910c,0x16610,0x1b30c, // 260
- 0x19106,0x12204,0x12360,0x191b8,0x1c8de,0x16760,0x12330,0x1919c,0x16730,0x1b39c, // 270
- 0x1918e,0x16718,0x1230c,0x12306,0x123b8,0x191de,0x167b8,0x1239c,0x1679c,0x1238e, // 280
- 0x1678e,0x167de,0x1b140,0x1d8b0,0x1ec5c,0x1b120,0x1d898,0x1ec4e,0x1b110,0x1d88c, // 290
- 0x1b108,0x1d886,0x1b104,0x1b102,0x12140,0x190b0,0x1c85c,0x16340,0x12120,0x19098, // 300
- 0x1c84e,0x16320,0x1b198,0x1d8ce,0x16310,0x12108,0x19086,0x16308,0x1b186,0x16304, // 310
- 0x121b0,0x190dc,0x163b0,0x12198,0x190ce,0x16398,0x1b1ce,0x1638c,0x12186,0x16386, // 320
- 0x163dc,0x163ce,0x1b0a0,0x1d858,0x1ec2e,0x1b090,0x1d84c,0x1b088,0x1d846,0x1b084, // 330
- 0x1b082,0x120a0,0x19058,0x1c82e,0x161a0,0x12090,0x1904c,0x16190,0x1b0cc,0x19046, // 340
- 0x16188,0x12084,0x16184,0x12082,0x120d8,0x161d8,0x161cc,0x161c6,0x1d82c,0x1d826, // 350
- 0x1b042,0x1902c,0x12048,0x160c8,0x160c4,0x160c2,0x18ac0,0x1c570,0x1e2bc,0x18a60, // 360
- 0x1c538,0x11440,0x18a30,0x1c51c,0x11420,0x18a18,0x11410,0x11408,0x116c0,0x18b70, // 370
- 0x1c5bc,0x11660,0x18b38,0x1c59e,0x11630,0x18b1c,0x11618,0x1160c,0x11770,0x18bbc, // 380
- 0x11738,0x18b9e,0x1171c,0x117bc,0x1179e,0x1cd60,0x1e6b8,0x1f35e,0x19a40,0x1cd30, // 390
- 0x1e69c,0x19a20,0x1cd18,0x1e68e,0x19a10,0x1cd0c,0x19a08,0x1cd06,0x18960,0x1c4b8, // 400
- 0x1e25e,0x19b60,0x18930,0x1c49c,0x13640,0x11220,0x1cd9c,0x1c48e,0x13620,0x19b18, // 410
- 0x1890c,0x13610,0x11208,0x13608,0x11360,0x189b8,0x1c4de,0x13760,0x11330,0x1cdde, // 420
- 0x13730,0x19b9c,0x1898e,0x13718,0x1130c,0x1370c,0x113b8,0x189de,0x137b8,0x1139c, // 430
- 0x1379c,0x1138e,0x113de,0x137de,0x1dd40,0x1eeb0,0x1f75c,0x1dd20,0x1ee98,0x1f74e, // 440
- 0x1dd10,0x1ee8c,0x1dd08,0x1ee86,0x1dd04,0x19940,0x1ccb0,0x1e65c,0x1bb40,0x19920, // 450
- 0x1eedc,0x1e64e,0x1bb20,0x1dd98,0x1eece,0x1bb10,0x19908,0x1cc86,0x1bb08,0x1dd86, // 460
- 0x19902,0x11140,0x188b0,0x1c45c,0x13340,0x11120,0x18898,0x1c44e,0x17740,0x13320, // 470
- 0x19998,0x1ccce,0x17720,0x1bb98,0x1ddce,0x18886,0x17710,0x13308,0x19986,0x17708, // 480
- 0x11102,0x111b0,0x188dc,0x133b0,0x11198,0x188ce,0x177b0,0x13398,0x199ce,0x17798, // 490
- 0x1bbce,0x11186,0x13386,0x111dc,0x133dc,0x111ce,0x177dc,0x133ce,0x1dca0,0x1ee58, // 500
- 0x1f72e,0x1dc90,0x1ee4c,0x1dc88,0x1ee46,0x1dc84,0x1dc82,0x198a0,0x1cc58,0x1e62e, // 510
- 0x1b9a0,0x19890,0x1ee6e,0x1b990,0x1dccc,0x1cc46,0x1b988,0x19884,0x1b984,0x19882, // 520
- 0x1b982,0x110a0,0x18858,0x1c42e,0x131a0,0x11090,0x1884c,0x173a0,0x13190,0x198cc, // 530
- 0x18846,0x17390,0x1b9cc,0x11084,0x17388,0x13184,0x11082,0x13182,0x110d8,0x1886e, // 540
- 0x131d8,0x110cc,0x173d8,0x131cc,0x110c6,0x173cc,0x131c6,0x110ee,0x173ee,0x1dc50, // 550
- 0x1ee2c,0x1dc48,0x1ee26,0x1dc44,0x1dc42,0x19850,0x1cc2c,0x1b8d0,0x19848,0x1cc26, // 560
- 0x1b8c8,0x1dc66,0x1b8c4,0x19842,0x1b8c2,0x11050,0x1882c,0x130d0,0x11048,0x18826, // 570
- 0x171d0,0x130c8,0x19866,0x171c8,0x1b8e6,0x11042,0x171c4,0x130c2,0x171c2,0x130ec, // 580
- 0x171ec,0x171e6,0x1ee16,0x1dc22,0x1cc16,0x19824,0x19822,0x11028,0x13068,0x170e8, // 590
- 0x11022,0x13062,0x18560,0x10a40,0x18530,0x10a20,0x18518,0x1c28e,0x10a10,0x1850c, // 600
- 0x10a08,0x18506,0x10b60,0x185b8,0x1c2de,0x10b30,0x1859c,0x10b18,0x1858e,0x10b0c, // 610
- 0x10b06,0x10bb8,0x185de,0x10b9c,0x10b8e,0x10bde,0x18d40,0x1c6b0,0x1e35c,0x18d20, // 620
- 0x1c698,0x18d10,0x1c68c,0x18d08,0x1c686,0x18d04,0x10940,0x184b0,0x1c25c,0x11b40, // 630
- 0x10920,0x1c6dc,0x1c24e,0x11b20,0x18d98,0x1c6ce,0x11b10,0x10908,0x18486,0x11b08, // 640
- 0x18d86,0x10902,0x109b0,0x184dc,0x11bb0,0x10998,0x184ce,0x11b98,0x18dce,0x11b8c, // 650
- 0x10986,0x109dc,0x11bdc,0x109ce,0x11bce,0x1cea0,0x1e758,0x1f3ae,0x1ce90,0x1e74c, // 660
- 0x1ce88,0x1e746,0x1ce84,0x1ce82,0x18ca0,0x1c658,0x19da0,0x18c90,0x1c64c,0x19d90, // 670
- 0x1cecc,0x1c646,0x19d88,0x18c84,0x19d84,0x18c82,0x19d82,0x108a0,0x18458,0x119a0, // 680
- 0x10890,0x1c66e,0x13ba0,0x11990,0x18ccc,0x18446,0x13b90,0x19dcc,0x10884,0x13b88, // 690
- 0x11984,0x10882,0x11982,0x108d8,0x1846e,0x119d8,0x108cc,0x13bd8,0x119cc,0x108c6, // 700
- 0x13bcc,0x119c6,0x108ee,0x119ee,0x13bee,0x1ef50,0x1f7ac,0x1ef48,0x1f7a6,0x1ef44, // 710
- 0x1ef42,0x1ce50,0x1e72c,0x1ded0,0x1ef6c,0x1e726,0x1dec8,0x1ef66,0x1dec4,0x1ce42, // 720
- 0x1dec2,0x18c50,0x1c62c,0x19cd0,0x18c48,0x1c626,0x1bdd0,0x19cc8,0x1ce66,0x1bdc8, // 730
- 0x1dee6,0x18c42,0x1bdc4,0x19cc2,0x1bdc2,0x10850,0x1842c,0x118d0,0x10848,0x18426, // 740
- 0x139d0,0x118c8,0x18c66,0x17bd0,0x139c8,0x19ce6,0x10842,0x17bc8,0x1bde6,0x118c2, // 750
- 0x17bc4,0x1086c,0x118ec,0x10866,0x139ec,0x118e6,0x17bec,0x139e6,0x17be6,0x1ef28, // 760
- 0x1f796,0x1ef24,0x1ef22,0x1ce28,0x1e716,0x1de68,0x1ef36,0x1de64,0x1ce22,0x1de62, // 770
- 0x18c28,0x1c616,0x19c68,0x18c24,0x1bce8,0x19c64,0x18c22,0x1bce4,0x19c62,0x1bce2, // 780
- 0x10828,0x18416,0x11868,0x18c36,0x138e8,0x11864,0x10822,0x179e8,0x138e4,0x11862, // 790
- 0x179e4,0x138e2,0x179e2,0x11876,0x179f6,0x1ef12,0x1de34,0x1de32,0x19c34,0x1bc74, // 800
- 0x1bc72,0x11834,0x13874,0x178f4,0x178f2,0x10540,0x10520,0x18298,0x10510,0x10508, // 810
- 0x10504,0x105b0,0x10598,0x1058c,0x10586,0x105dc,0x105ce,0x186a0,0x18690,0x1c34c, // 820
- 0x18688,0x1c346,0x18684,0x18682,0x104a0,0x18258,0x10da0,0x186d8,0x1824c,0x10d90, // 830
- 0x186cc,0x10d88,0x186c6,0x10d84,0x10482,0x10d82,0x104d8,0x1826e,0x10dd8,0x186ee, // 840
- 0x10dcc,0x104c6,0x10dc6,0x104ee,0x10dee,0x1c750,0x1c748,0x1c744,0x1c742,0x18650, // 850
- 0x18ed0,0x1c76c,0x1c326,0x18ec8,0x1c766,0x18ec4,0x18642,0x18ec2,0x10450,0x10cd0, // 860
- 0x10448,0x18226,0x11dd0,0x10cc8,0x10444,0x11dc8,0x10cc4,0x10442,0x11dc4,0x10cc2, // 870
- 0x1046c,0x10cec,0x10466,0x11dec,0x10ce6,0x11de6,0x1e7a8,0x1e7a4,0x1e7a2,0x1c728, // 880
- 0x1cf68,0x1e7b6,0x1cf64,0x1c722,0x1cf62,0x18628,0x1c316,0x18e68,0x1c736,0x19ee8, // 890
- 0x18e64,0x18622,0x19ee4,0x18e62,0x19ee2,0x10428,0x18216,0x10c68,0x18636,0x11ce8, // 900
- 0x10c64,0x10422,0x13de8,0x11ce4,0x10c62,0x13de4,0x11ce2,0x10436,0x10c76,0x11cf6, // 910
- 0x13df6,0x1f7d4,0x1f7d2,0x1e794,0x1efb4,0x1e792,0x1efb2,0x1c714,0x1cf34,0x1c712, // 920
- 0x1df74,0x1cf32,0x1df72,0x18614,0x18e34,0x18612,0x19e74,0x18e32,0x1bef4), // 929
- array( // cluster 3 -----------------------------------------------------------------------
- 0x1f560,0x1fab8,0x1ea40,0x1f530,0x1fa9c,0x1ea20,0x1f518,0x1fa8e,0x1ea10,0x1f50c, // 10
- 0x1ea08,0x1f506,0x1ea04,0x1eb60,0x1f5b8,0x1fade,0x1d640,0x1eb30,0x1f59c,0x1d620, // 20
- 0x1eb18,0x1f58e,0x1d610,0x1eb0c,0x1d608,0x1eb06,0x1d604,0x1d760,0x1ebb8,0x1f5de, // 30
- 0x1ae40,0x1d730,0x1eb9c,0x1ae20,0x1d718,0x1eb8e,0x1ae10,0x1d70c,0x1ae08,0x1d706, // 40
- 0x1ae04,0x1af60,0x1d7b8,0x1ebde,0x15e40,0x1af30,0x1d79c,0x15e20,0x1af18,0x1d78e, // 50
- 0x15e10,0x1af0c,0x15e08,0x1af06,0x15f60,0x1afb8,0x1d7de,0x15f30,0x1af9c,0x15f18, // 60
- 0x1af8e,0x15f0c,0x15fb8,0x1afde,0x15f9c,0x15f8e,0x1e940,0x1f4b0,0x1fa5c,0x1e920, // 70
- 0x1f498,0x1fa4e,0x1e910,0x1f48c,0x1e908,0x1f486,0x1e904,0x1e902,0x1d340,0x1e9b0, // 80
- 0x1f4dc,0x1d320,0x1e998,0x1f4ce,0x1d310,0x1e98c,0x1d308,0x1e986,0x1d304,0x1d302, // 90
- 0x1a740,0x1d3b0,0x1e9dc,0x1a720,0x1d398,0x1e9ce,0x1a710,0x1d38c,0x1a708,0x1d386, // 100
- 0x1a704,0x1a702,0x14f40,0x1a7b0,0x1d3dc,0x14f20,0x1a798,0x1d3ce,0x14f10,0x1a78c, // 110
- 0x14f08,0x1a786,0x14f04,0x14fb0,0x1a7dc,0x14f98,0x1a7ce,0x14f8c,0x14f86,0x14fdc, // 120
- 0x14fce,0x1e8a0,0x1f458,0x1fa2e,0x1e890,0x1f44c,0x1e888,0x1f446,0x1e884,0x1e882, // 130
- 0x1d1a0,0x1e8d8,0x1f46e,0x1d190,0x1e8cc,0x1d188,0x1e8c6,0x1d184,0x1d182,0x1a3a0, // 140
- 0x1d1d8,0x1e8ee,0x1a390,0x1d1cc,0x1a388,0x1d1c6,0x1a384,0x1a382,0x147a0,0x1a3d8, // 150
- 0x1d1ee,0x14790,0x1a3cc,0x14788,0x1a3c6,0x14784,0x14782,0x147d8,0x1a3ee,0x147cc, // 160
- 0x147c6,0x147ee,0x1e850,0x1f42c,0x1e848,0x1f426,0x1e844,0x1e842,0x1d0d0,0x1e86c, // 170
- 0x1d0c8,0x1e866,0x1d0c4,0x1d0c2,0x1a1d0,0x1d0ec,0x1a1c8,0x1d0e6,0x1a1c4,0x1a1c2, // 180
- 0x143d0,0x1a1ec,0x143c8,0x1a1e6,0x143c4,0x143c2,0x143ec,0x143e6,0x1e828,0x1f416, // 190
- 0x1e824,0x1e822,0x1d068,0x1e836,0x1d064,0x1d062,0x1a0e8,0x1d076,0x1a0e4,0x1a0e2, // 200
- 0x141e8,0x1a0f6,0x141e4,0x141e2,0x1e814,0x1e812,0x1d034,0x1d032,0x1a074,0x1a072, // 210
- 0x1e540,0x1f2b0,0x1f95c,0x1e520,0x1f298,0x1f94e,0x1e510,0x1f28c,0x1e508,0x1f286, // 220
- 0x1e504,0x1e502,0x1cb40,0x1e5b0,0x1f2dc,0x1cb20,0x1e598,0x1f2ce,0x1cb10,0x1e58c, // 230
- 0x1cb08,0x1e586,0x1cb04,0x1cb02,0x19740,0x1cbb0,0x1e5dc,0x19720,0x1cb98,0x1e5ce, // 240
- 0x19710,0x1cb8c,0x19708,0x1cb86,0x19704,0x19702,0x12f40,0x197b0,0x1cbdc,0x12f20, // 250
- 0x19798,0x1cbce,0x12f10,0x1978c,0x12f08,0x19786,0x12f04,0x12fb0,0x197dc,0x12f98, // 260
- 0x197ce,0x12f8c,0x12f86,0x12fdc,0x12fce,0x1f6a0,0x1fb58,0x16bf0,0x1f690,0x1fb4c, // 270
- 0x169f8,0x1f688,0x1fb46,0x168fc,0x1f684,0x1f682,0x1e4a0,0x1f258,0x1f92e,0x1eda0, // 280
- 0x1e490,0x1fb6e,0x1ed90,0x1f6cc,0x1f246,0x1ed88,0x1e484,0x1ed84,0x1e482,0x1ed82, // 290
- 0x1c9a0,0x1e4d8,0x1f26e,0x1dba0,0x1c990,0x1e4cc,0x1db90,0x1edcc,0x1e4c6,0x1db88, // 300
- 0x1c984,0x1db84,0x1c982,0x1db82,0x193a0,0x1c9d8,0x1e4ee,0x1b7a0,0x19390,0x1c9cc, // 310
- 0x1b790,0x1dbcc,0x1c9c6,0x1b788,0x19384,0x1b784,0x19382,0x1b782,0x127a0,0x193d8, // 320
- 0x1c9ee,0x16fa0,0x12790,0x193cc,0x16f90,0x1b7cc,0x193c6,0x16f88,0x12784,0x16f84, // 330
- 0x12782,0x127d8,0x193ee,0x16fd8,0x127cc,0x16fcc,0x127c6,0x16fc6,0x127ee,0x1f650, // 340
- 0x1fb2c,0x165f8,0x1f648,0x1fb26,0x164fc,0x1f644,0x1647e,0x1f642,0x1e450,0x1f22c, // 350
- 0x1ecd0,0x1e448,0x1f226,0x1ecc8,0x1f666,0x1ecc4,0x1e442,0x1ecc2,0x1c8d0,0x1e46c, // 360
- 0x1d9d0,0x1c8c8,0x1e466,0x1d9c8,0x1ece6,0x1d9c4,0x1c8c2,0x1d9c2,0x191d0,0x1c8ec, // 370
- 0x1b3d0,0x191c8,0x1c8e6,0x1b3c8,0x1d9e6,0x1b3c4,0x191c2,0x1b3c2,0x123d0,0x191ec, // 380
- 0x167d0,0x123c8,0x191e6,0x167c8,0x1b3e6,0x167c4,0x123c2,0x167c2,0x123ec,0x167ec, // 390
- 0x123e6,0x167e6,0x1f628,0x1fb16,0x162fc,0x1f624,0x1627e,0x1f622,0x1e428,0x1f216, // 400
- 0x1ec68,0x1f636,0x1ec64,0x1e422,0x1ec62,0x1c868,0x1e436,0x1d8e8,0x1c864,0x1d8e4, // 410
- 0x1c862,0x1d8e2,0x190e8,0x1c876,0x1b1e8,0x1d8f6,0x1b1e4,0x190e2,0x1b1e2,0x121e8, // 420
- 0x190f6,0x163e8,0x121e4,0x163e4,0x121e2,0x163e2,0x121f6,0x163f6,0x1f614,0x1617e, // 430
- 0x1f612,0x1e414,0x1ec34,0x1e412,0x1ec32,0x1c834,0x1d874,0x1c832,0x1d872,0x19074, // 440
- 0x1b0f4,0x19072,0x1b0f2,0x120f4,0x161f4,0x120f2,0x161f2,0x1f60a,0x1e40a,0x1ec1a, // 450
- 0x1c81a,0x1d83a,0x1903a,0x1b07a,0x1e2a0,0x1f158,0x1f8ae,0x1e290,0x1f14c,0x1e288, // 460
- 0x1f146,0x1e284,0x1e282,0x1c5a0,0x1e2d8,0x1f16e,0x1c590,0x1e2cc,0x1c588,0x1e2c6, // 470
- 0x1c584,0x1c582,0x18ba0,0x1c5d8,0x1e2ee,0x18b90,0x1c5cc,0x18b88,0x1c5c6,0x18b84, // 480
- 0x18b82,0x117a0,0x18bd8,0x1c5ee,0x11790,0x18bcc,0x11788,0x18bc6,0x11784,0x11782, // 490
- 0x117d8,0x18bee,0x117cc,0x117c6,0x117ee,0x1f350,0x1f9ac,0x135f8,0x1f348,0x1f9a6, // 500
- 0x134fc,0x1f344,0x1347e,0x1f342,0x1e250,0x1f12c,0x1e6d0,0x1e248,0x1f126,0x1e6c8, // 510
- 0x1f366,0x1e6c4,0x1e242,0x1e6c2,0x1c4d0,0x1e26c,0x1cdd0,0x1c4c8,0x1e266,0x1cdc8, // 520
- 0x1e6e6,0x1cdc4,0x1c4c2,0x1cdc2,0x189d0,0x1c4ec,0x19bd0,0x189c8,0x1c4e6,0x19bc8, // 530
- 0x1cde6,0x19bc4,0x189c2,0x19bc2,0x113d0,0x189ec,0x137d0,0x113c8,0x189e6,0x137c8, // 540
- 0x19be6,0x137c4,0x113c2,0x137c2,0x113ec,0x137ec,0x113e6,0x137e6,0x1fba8,0x175f0, // 550
- 0x1bafc,0x1fba4,0x174f8,0x1ba7e,0x1fba2,0x1747c,0x1743e,0x1f328,0x1f996,0x132fc, // 560
- 0x1f768,0x1fbb6,0x176fc,0x1327e,0x1f764,0x1f322,0x1767e,0x1f762,0x1e228,0x1f116, // 570
- 0x1e668,0x1e224,0x1eee8,0x1f776,0x1e222,0x1eee4,0x1e662,0x1eee2,0x1c468,0x1e236, // 580
- 0x1cce8,0x1c464,0x1dde8,0x1cce4,0x1c462,0x1dde4,0x1cce2,0x1dde2,0x188e8,0x1c476, // 590
- 0x199e8,0x188e4,0x1bbe8,0x199e4,0x188e2,0x1bbe4,0x199e2,0x1bbe2,0x111e8,0x188f6, // 600
- 0x133e8,0x111e4,0x177e8,0x133e4,0x111e2,0x177e4,0x133e2,0x177e2,0x111f6,0x133f6, // 610
- 0x1fb94,0x172f8,0x1b97e,0x1fb92,0x1727c,0x1723e,0x1f314,0x1317e,0x1f734,0x1f312, // 620
- 0x1737e,0x1f732,0x1e214,0x1e634,0x1e212,0x1ee74,0x1e632,0x1ee72,0x1c434,0x1cc74, // 630
- 0x1c432,0x1dcf4,0x1cc72,0x1dcf2,0x18874,0x198f4,0x18872,0x1b9f4,0x198f2,0x1b9f2, // 640
- 0x110f4,0x131f4,0x110f2,0x173f4,0x131f2,0x173f2,0x1fb8a,0x1717c,0x1713e,0x1f30a, // 650
- 0x1f71a,0x1e20a,0x1e61a,0x1ee3a,0x1c41a,0x1cc3a,0x1dc7a,0x1883a,0x1987a,0x1b8fa, // 660
- 0x1107a,0x130fa,0x171fa,0x170be,0x1e150,0x1f0ac,0x1e148,0x1f0a6,0x1e144,0x1e142, // 670
- 0x1c2d0,0x1e16c,0x1c2c8,0x1e166,0x1c2c4,0x1c2c2,0x185d0,0x1c2ec,0x185c8,0x1c2e6, // 680
- 0x185c4,0x185c2,0x10bd0,0x185ec,0x10bc8,0x185e6,0x10bc4,0x10bc2,0x10bec,0x10be6, // 690
- 0x1f1a8,0x1f8d6,0x11afc,0x1f1a4,0x11a7e,0x1f1a2,0x1e128,0x1f096,0x1e368,0x1e124, // 700
- 0x1e364,0x1e122,0x1e362,0x1c268,0x1e136,0x1c6e8,0x1c264,0x1c6e4,0x1c262,0x1c6e2, // 710
- 0x184e8,0x1c276,0x18de8,0x184e4,0x18de4,0x184e2,0x18de2,0x109e8,0x184f6,0x11be8, // 720
- 0x109e4,0x11be4,0x109e2,0x11be2,0x109f6,0x11bf6,0x1f9d4,0x13af8,0x19d7e,0x1f9d2, // 730
- 0x13a7c,0x13a3e,0x1f194,0x1197e,0x1f3b4,0x1f192,0x13b7e,0x1f3b2,0x1e114,0x1e334, // 740
- 0x1e112,0x1e774,0x1e332,0x1e772,0x1c234,0x1c674,0x1c232,0x1cef4,0x1c672,0x1cef2, // 750
- 0x18474,0x18cf4,0x18472,0x19df4,0x18cf2,0x19df2,0x108f4,0x119f4,0x108f2,0x13bf4, // 760
- 0x119f2,0x13bf2,0x17af0,0x1bd7c,0x17a78,0x1bd3e,0x17a3c,0x17a1e,0x1f9ca,0x1397c, // 770
- 0x1fbda,0x17b7c,0x1393e,0x17b3e,0x1f18a,0x1f39a,0x1f7ba,0x1e10a,0x1e31a,0x1e73a, // 780
- 0x1ef7a,0x1c21a,0x1c63a,0x1ce7a,0x1defa,0x1843a,0x18c7a,0x19cfa,0x1bdfa,0x1087a, // 790
- 0x118fa,0x139fa,0x17978,0x1bcbe,0x1793c,0x1791e,0x138be,0x179be,0x178bc,0x1789e, // 800
- 0x1785e,0x1e0a8,0x1e0a4,0x1e0a2,0x1c168,0x1e0b6,0x1c164,0x1c162,0x182e8,0x1c176, // 810
- 0x182e4,0x182e2,0x105e8,0x182f6,0x105e4,0x105e2,0x105f6,0x1f0d4,0x10d7e,0x1f0d2, // 820
- 0x1e094,0x1e1b4,0x1e092,0x1e1b2,0x1c134,0x1c374,0x1c132,0x1c372,0x18274,0x186f4, // 830
- 0x18272,0x186f2,0x104f4,0x10df4,0x104f2,0x10df2,0x1f8ea,0x11d7c,0x11d3e,0x1f0ca, // 840
- 0x1f1da,0x1e08a,0x1e19a,0x1e3ba,0x1c11a,0x1c33a,0x1c77a,0x1823a,0x1867a,0x18efa, // 850
- 0x1047a,0x10cfa,0x11dfa,0x13d78,0x19ebe,0x13d3c,0x13d1e,0x11cbe,0x13dbe,0x17d70, // 860
- 0x1bebc,0x17d38,0x1be9e,0x17d1c,0x17d0e,0x13cbc,0x17dbc,0x13c9e,0x17d9e,0x17cb8, // 870
- 0x1be5e,0x17c9c,0x17c8e,0x13c5e,0x17cde,0x17c5c,0x17c4e,0x17c2e,0x1c0b4,0x1c0b2, // 880
- 0x18174,0x18172,0x102f4,0x102f2,0x1e0da,0x1c09a,0x1c1ba,0x1813a,0x1837a,0x1027a, // 890
- 0x106fa,0x10ebe,0x11ebc,0x11e9e,0x13eb8,0x19f5e,0x13e9c,0x13e8e,0x11e5e,0x13ede, // 900
- 0x17eb0,0x1bf5c,0x17e98,0x1bf4e,0x17e8c,0x17e86,0x13e5c,0x17edc,0x13e4e,0x17ece, // 910
- 0x17e58,0x1bf2e,0x17e4c,0x17e46,0x13e2e,0x17e6e,0x17e2c,0x17e26,0x10f5e,0x11f5c, // 920
- 0x11f4e,0x13f58,0x19fae,0x13f4c,0x13f46,0x11f2e,0x13f6e,0x13f2c,0x13f26), // 929
- array( // cluster 6 -----------------------------------------------------------------------
- 0x1abe0,0x1d5f8,0x153c0,0x1a9f0,0x1d4fc,0x151e0,0x1a8f8,0x1d47e,0x150f0,0x1a87c, // 10
- 0x15078,0x1fad0,0x15be0,0x1adf8,0x1fac8,0x159f0,0x1acfc,0x1fac4,0x158f8,0x1ac7e, // 20
- 0x1fac2,0x1587c,0x1f5d0,0x1faec,0x15df8,0x1f5c8,0x1fae6,0x15cfc,0x1f5c4,0x15c7e, // 30
- 0x1f5c2,0x1ebd0,0x1f5ec,0x1ebc8,0x1f5e6,0x1ebc4,0x1ebc2,0x1d7d0,0x1ebec,0x1d7c8, // 40
- 0x1ebe6,0x1d7c4,0x1d7c2,0x1afd0,0x1d7ec,0x1afc8,0x1d7e6,0x1afc4,0x14bc0,0x1a5f0, // 50
- 0x1d2fc,0x149e0,0x1a4f8,0x1d27e,0x148f0,0x1a47c,0x14878,0x1a43e,0x1483c,0x1fa68, // 60
- 0x14df0,0x1a6fc,0x1fa64,0x14cf8,0x1a67e,0x1fa62,0x14c7c,0x14c3e,0x1f4e8,0x1fa76, // 70
- 0x14efc,0x1f4e4,0x14e7e,0x1f4e2,0x1e9e8,0x1f4f6,0x1e9e4,0x1e9e2,0x1d3e8,0x1e9f6, // 80
- 0x1d3e4,0x1d3e2,0x1a7e8,0x1d3f6,0x1a7e4,0x1a7e2,0x145e0,0x1a2f8,0x1d17e,0x144f0, // 90
- 0x1a27c,0x14478,0x1a23e,0x1443c,0x1441e,0x1fa34,0x146f8,0x1a37e,0x1fa32,0x1467c, // 100
- 0x1463e,0x1f474,0x1477e,0x1f472,0x1e8f4,0x1e8f2,0x1d1f4,0x1d1f2,0x1a3f4,0x1a3f2, // 110
- 0x142f0,0x1a17c,0x14278,0x1a13e,0x1423c,0x1421e,0x1fa1a,0x1437c,0x1433e,0x1f43a, // 120
- 0x1e87a,0x1d0fa,0x14178,0x1a0be,0x1413c,0x1411e,0x141be,0x140bc,0x1409e,0x12bc0, // 130
- 0x195f0,0x1cafc,0x129e0,0x194f8,0x1ca7e,0x128f0,0x1947c,0x12878,0x1943e,0x1283c, // 140
- 0x1f968,0x12df0,0x196fc,0x1f964,0x12cf8,0x1967e,0x1f962,0x12c7c,0x12c3e,0x1f2e8, // 150
- 0x1f976,0x12efc,0x1f2e4,0x12e7e,0x1f2e2,0x1e5e8,0x1f2f6,0x1e5e4,0x1e5e2,0x1cbe8, // 160
- 0x1e5f6,0x1cbe4,0x1cbe2,0x197e8,0x1cbf6,0x197e4,0x197e2,0x1b5e0,0x1daf8,0x1ed7e, // 170
- 0x169c0,0x1b4f0,0x1da7c,0x168e0,0x1b478,0x1da3e,0x16870,0x1b43c,0x16838,0x1b41e, // 180
- 0x1681c,0x125e0,0x192f8,0x1c97e,0x16de0,0x124f0,0x1927c,0x16cf0,0x1b67c,0x1923e, // 190
- 0x16c78,0x1243c,0x16c3c,0x1241e,0x16c1e,0x1f934,0x126f8,0x1937e,0x1fb74,0x1f932, // 200
- 0x16ef8,0x1267c,0x1fb72,0x16e7c,0x1263e,0x16e3e,0x1f274,0x1277e,0x1f6f4,0x1f272, // 210
- 0x16f7e,0x1f6f2,0x1e4f4,0x1edf4,0x1e4f2,0x1edf2,0x1c9f4,0x1dbf4,0x1c9f2,0x1dbf2, // 220
- 0x193f4,0x193f2,0x165c0,0x1b2f0,0x1d97c,0x164e0,0x1b278,0x1d93e,0x16470,0x1b23c, // 230
- 0x16438,0x1b21e,0x1641c,0x1640e,0x122f0,0x1917c,0x166f0,0x12278,0x1913e,0x16678, // 240
- 0x1b33e,0x1663c,0x1221e,0x1661e,0x1f91a,0x1237c,0x1fb3a,0x1677c,0x1233e,0x1673e, // 250
- 0x1f23a,0x1f67a,0x1e47a,0x1ecfa,0x1c8fa,0x1d9fa,0x191fa,0x162e0,0x1b178,0x1d8be, // 260
- 0x16270,0x1b13c,0x16238,0x1b11e,0x1621c,0x1620e,0x12178,0x190be,0x16378,0x1213c, // 270
- 0x1633c,0x1211e,0x1631e,0x121be,0x163be,0x16170,0x1b0bc,0x16138,0x1b09e,0x1611c, // 280
- 0x1610e,0x120bc,0x161bc,0x1209e,0x1619e,0x160b8,0x1b05e,0x1609c,0x1608e,0x1205e, // 290
- 0x160de,0x1605c,0x1604e,0x115e0,0x18af8,0x1c57e,0x114f0,0x18a7c,0x11478,0x18a3e, // 300
- 0x1143c,0x1141e,0x1f8b4,0x116f8,0x18b7e,0x1f8b2,0x1167c,0x1163e,0x1f174,0x1177e, // 310
- 0x1f172,0x1e2f4,0x1e2f2,0x1c5f4,0x1c5f2,0x18bf4,0x18bf2,0x135c0,0x19af0,0x1cd7c, // 320
- 0x134e0,0x19a78,0x1cd3e,0x13470,0x19a3c,0x13438,0x19a1e,0x1341c,0x1340e,0x112f0, // 330
- 0x1897c,0x136f0,0x11278,0x1893e,0x13678,0x19b3e,0x1363c,0x1121e,0x1361e,0x1f89a, // 340
- 0x1137c,0x1f9ba,0x1377c,0x1133e,0x1373e,0x1f13a,0x1f37a,0x1e27a,0x1e6fa,0x1c4fa, // 350
- 0x1cdfa,0x189fa,0x1bae0,0x1dd78,0x1eebe,0x174c0,0x1ba70,0x1dd3c,0x17460,0x1ba38, // 360
- 0x1dd1e,0x17430,0x1ba1c,0x17418,0x1ba0e,0x1740c,0x132e0,0x19978,0x1ccbe,0x176e0, // 370
- 0x13270,0x1993c,0x17670,0x1bb3c,0x1991e,0x17638,0x1321c,0x1761c,0x1320e,0x1760e, // 380
- 0x11178,0x188be,0x13378,0x1113c,0x17778,0x1333c,0x1111e,0x1773c,0x1331e,0x1771e, // 390
- 0x111be,0x133be,0x177be,0x172c0,0x1b970,0x1dcbc,0x17260,0x1b938,0x1dc9e,0x17230, // 400
- 0x1b91c,0x17218,0x1b90e,0x1720c,0x17206,0x13170,0x198bc,0x17370,0x13138,0x1989e, // 410
- 0x17338,0x1b99e,0x1731c,0x1310e,0x1730e,0x110bc,0x131bc,0x1109e,0x173bc,0x1319e, // 420
- 0x1739e,0x17160,0x1b8b8,0x1dc5e,0x17130,0x1b89c,0x17118,0x1b88e,0x1710c,0x17106, // 430
- 0x130b8,0x1985e,0x171b8,0x1309c,0x1719c,0x1308e,0x1718e,0x1105e,0x130de,0x171de, // 440
- 0x170b0,0x1b85c,0x17098,0x1b84e,0x1708c,0x17086,0x1305c,0x170dc,0x1304e,0x170ce, // 450
- 0x17058,0x1b82e,0x1704c,0x17046,0x1302e,0x1706e,0x1702c,0x17026,0x10af0,0x1857c, // 460
- 0x10a78,0x1853e,0x10a3c,0x10a1e,0x10b7c,0x10b3e,0x1f0ba,0x1e17a,0x1c2fa,0x185fa, // 470
- 0x11ae0,0x18d78,0x1c6be,0x11a70,0x18d3c,0x11a38,0x18d1e,0x11a1c,0x11a0e,0x10978, // 480
- 0x184be,0x11b78,0x1093c,0x11b3c,0x1091e,0x11b1e,0x109be,0x11bbe,0x13ac0,0x19d70, // 490
- 0x1cebc,0x13a60,0x19d38,0x1ce9e,0x13a30,0x19d1c,0x13a18,0x19d0e,0x13a0c,0x13a06, // 500
- 0x11970,0x18cbc,0x13b70,0x11938,0x18c9e,0x13b38,0x1191c,0x13b1c,0x1190e,0x13b0e, // 510
- 0x108bc,0x119bc,0x1089e,0x13bbc,0x1199e,0x13b9e,0x1bd60,0x1deb8,0x1ef5e,0x17a40, // 520
- 0x1bd30,0x1de9c,0x17a20,0x1bd18,0x1de8e,0x17a10,0x1bd0c,0x17a08,0x1bd06,0x17a04, // 530
- 0x13960,0x19cb8,0x1ce5e,0x17b60,0x13930,0x19c9c,0x17b30,0x1bd9c,0x19c8e,0x17b18, // 540
- 0x1390c,0x17b0c,0x13906,0x17b06,0x118b8,0x18c5e,0x139b8,0x1189c,0x17bb8,0x1399c, // 550
- 0x1188e,0x17b9c,0x1398e,0x17b8e,0x1085e,0x118de,0x139de,0x17bde,0x17940,0x1bcb0, // 560
- 0x1de5c,0x17920,0x1bc98,0x1de4e,0x17910,0x1bc8c,0x17908,0x1bc86,0x17904,0x17902, // 570
- 0x138b0,0x19c5c,0x179b0,0x13898,0x19c4e,0x17998,0x1bcce,0x1798c,0x13886,0x17986, // 580
- 0x1185c,0x138dc,0x1184e,0x179dc,0x138ce,0x179ce,0x178a0,0x1bc58,0x1de2e,0x17890, // 590
- 0x1bc4c,0x17888,0x1bc46,0x17884,0x17882,0x13858,0x19c2e,0x178d8,0x1384c,0x178cc, // 600
- 0x13846,0x178c6,0x1182e,0x1386e,0x178ee,0x17850,0x1bc2c,0x17848,0x1bc26,0x17844, // 610
- 0x17842,0x1382c,0x1786c,0x13826,0x17866,0x17828,0x1bc16,0x17824,0x17822,0x13816, // 620
- 0x17836,0x10578,0x182be,0x1053c,0x1051e,0x105be,0x10d70,0x186bc,0x10d38,0x1869e, // 630
- 0x10d1c,0x10d0e,0x104bc,0x10dbc,0x1049e,0x10d9e,0x11d60,0x18eb8,0x1c75e,0x11d30, // 640
- 0x18e9c,0x11d18,0x18e8e,0x11d0c,0x11d06,0x10cb8,0x1865e,0x11db8,0x10c9c,0x11d9c, // 650
- 0x10c8e,0x11d8e,0x1045e,0x10cde,0x11dde,0x13d40,0x19eb0,0x1cf5c,0x13d20,0x19e98, // 660
- 0x1cf4e,0x13d10,0x19e8c,0x13d08,0x19e86,0x13d04,0x13d02,0x11cb0,0x18e5c,0x13db0, // 670
- 0x11c98,0x18e4e,0x13d98,0x19ece,0x13d8c,0x11c86,0x13d86,0x10c5c,0x11cdc,0x10c4e, // 680
- 0x13ddc,0x11cce,0x13dce,0x1bea0,0x1df58,0x1efae,0x1be90,0x1df4c,0x1be88,0x1df46, // 690
- 0x1be84,0x1be82,0x13ca0,0x19e58,0x1cf2e,0x17da0,0x13c90,0x19e4c,0x17d90,0x1becc, // 700
- 0x19e46,0x17d88,0x13c84,0x17d84,0x13c82,0x17d82,0x11c58,0x18e2e,0x13cd8,0x11c4c, // 710
- 0x17dd8,0x13ccc,0x11c46,0x17dcc,0x13cc6,0x17dc6,0x10c2e,0x11c6e,0x13cee,0x17dee, // 720
- 0x1be50,0x1df2c,0x1be48,0x1df26,0x1be44,0x1be42,0x13c50,0x19e2c,0x17cd0,0x13c48, // 730
- 0x19e26,0x17cc8,0x1be66,0x17cc4,0x13c42,0x17cc2,0x11c2c,0x13c6c,0x11c26,0x17cec, // 740
- 0x13c66,0x17ce6,0x1be28,0x1df16,0x1be24,0x1be22,0x13c28,0x19e16,0x17c68,0x13c24, // 750
- 0x17c64,0x13c22,0x17c62,0x11c16,0x13c36,0x17c76,0x1be14,0x1be12,0x13c14,0x17c34, // 760
- 0x13c12,0x17c32,0x102bc,0x1029e,0x106b8,0x1835e,0x1069c,0x1068e,0x1025e,0x106de, // 770
- 0x10eb0,0x1875c,0x10e98,0x1874e,0x10e8c,0x10e86,0x1065c,0x10edc,0x1064e,0x10ece, // 780
- 0x11ea0,0x18f58,0x1c7ae,0x11e90,0x18f4c,0x11e88,0x18f46,0x11e84,0x11e82,0x10e58, // 790
- 0x1872e,0x11ed8,0x18f6e,0x11ecc,0x10e46,0x11ec6,0x1062e,0x10e6e,0x11eee,0x19f50, // 800
- 0x1cfac,0x19f48,0x1cfa6,0x19f44,0x19f42,0x11e50,0x18f2c,0x13ed0,0x19f6c,0x18f26, // 810
- 0x13ec8,0x11e44,0x13ec4,0x11e42,0x13ec2,0x10e2c,0x11e6c,0x10e26,0x13eec,0x11e66, // 820
- 0x13ee6,0x1dfa8,0x1efd6,0x1dfa4,0x1dfa2,0x19f28,0x1cf96,0x1bf68,0x19f24,0x1bf64, // 830
- 0x19f22,0x1bf62,0x11e28,0x18f16,0x13e68,0x11e24,0x17ee8,0x13e64,0x11e22,0x17ee4, // 840
- 0x13e62,0x17ee2,0x10e16,0x11e36,0x13e76,0x17ef6,0x1df94,0x1df92,0x19f14,0x1bf34, // 850
- 0x19f12,0x1bf32,0x11e14,0x13e34,0x11e12,0x17e74,0x13e32,0x17e72,0x1df8a,0x19f0a, // 860
- 0x1bf1a,0x11e0a,0x13e1a,0x17e3a,0x1035c,0x1034e,0x10758,0x183ae,0x1074c,0x10746, // 870
- 0x1032e,0x1076e,0x10f50,0x187ac,0x10f48,0x187a6,0x10f44,0x10f42,0x1072c,0x10f6c, // 880
- 0x10726,0x10f66,0x18fa8,0x1c7d6,0x18fa4,0x18fa2,0x10f28,0x18796,0x11f68,0x18fb6, // 890
- 0x11f64,0x10f22,0x11f62,0x10716,0x10f36,0x11f76,0x1cfd4,0x1cfd2,0x18f94,0x19fb4, // 900
- 0x18f92,0x19fb2,0x10f14,0x11f34,0x10f12,0x13f74,0x11f32,0x13f72,0x1cfca,0x18f8a, // 910
- 0x19f9a,0x10f0a,0x11f1a,0x13f3a,0x103ac,0x103a6,0x107a8,0x183d6,0x107a4,0x107a2, // 920
- 0x10396,0x107b6,0x187d4,0x187d2,0x10794,0x10fb4,0x10792,0x10fb2,0x1c7ea) // 929
- ); // end of $clusters array
+ /**
+ * Array of factors of the Reed-Solomon polynomial equations used for error correction; one sub array for each correction level (0-8).
+ * @protected
+ */
+ protected $rsfactors = array(
+ array( // ECL 0 (2 factors) -------------------------------------------------------------------------------
+ 0x01b,0x395), // 2
+ array( // ECL 1 (4 factors) -------------------------------------------------------------------------------
+ 0x20a,0x238,0x2d3,0x329), // 4
+ array( // ECL 2 (8 factors) -------------------------------------------------------------------------------
+ 0x0ed,0x134,0x1b4,0x11c,0x286,0x28d,0x1ac,0x17b), // 8
+ array( // ECL 3 (16 factors) ------------------------------------------------------------------------------
+ 0x112,0x232,0x0e8,0x2f3,0x257,0x20c,0x321,0x084,0x127,0x074,0x1ba,0x1ac,0x127,0x02a,0x0b0,0x041),// 16
+ array( // ECL 4 (32 factors) ------------------------------------------------------------------------------
+ 0x169,0x23f,0x39a,0x20d,0x0b0,0x24a,0x280,0x141,0x218,0x2e6,0x2a5,0x2e6,0x2af,0x11c,0x0c1,0x205, // 16
+ 0x111,0x1ee,0x107,0x093,0x251,0x320,0x23b,0x140,0x323,0x085,0x0e7,0x186,0x2ad,0x14a,0x03f,0x19a),// 32
+ array( // ECL 5 (64 factors) ------------------------------------------------------------------------------
+ 0x21b,0x1a6,0x006,0x05d,0x35e,0x303,0x1c5,0x06a,0x262,0x11f,0x06b,0x1f9,0x2dd,0x36d,0x17d,0x264, // 16
+ 0x2d3,0x1dc,0x1ce,0x0ac,0x1ae,0x261,0x35a,0x336,0x21f,0x178,0x1ff,0x190,0x2a0,0x2fa,0x11b,0x0b8, // 32
+ 0x1b8,0x023,0x207,0x01f,0x1cc,0x252,0x0e1,0x217,0x205,0x160,0x25d,0x09e,0x28b,0x0c9,0x1e8,0x1f6, // 48
+ 0x288,0x2dd,0x2cd,0x053,0x194,0x061,0x118,0x303,0x348,0x275,0x004,0x17d,0x34b,0x26f,0x108,0x21f),// 64
+ array( // ECL 6 (128 factors) -----------------------------------------------------------------------------
+ 0x209,0x136,0x360,0x223,0x35a,0x244,0x128,0x17b,0x035,0x30b,0x381,0x1bc,0x190,0x39d,0x2ed,0x19f, // 16
+ 0x336,0x05d,0x0d9,0x0d0,0x3a0,0x0f4,0x247,0x26c,0x0f6,0x094,0x1bf,0x277,0x124,0x38c,0x1ea,0x2c0, // 32
+ 0x204,0x102,0x1c9,0x38b,0x252,0x2d3,0x2a2,0x124,0x110,0x060,0x2ac,0x1b0,0x2ae,0x25e,0x35c,0x239, // 48
+ 0x0c1,0x0db,0x081,0x0ba,0x0ec,0x11f,0x0c0,0x307,0x116,0x0ad,0x028,0x17b,0x2c8,0x1cf,0x286,0x308, // 64
+ 0x0ab,0x1eb,0x129,0x2fb,0x09c,0x2dc,0x05f,0x10e,0x1bf,0x05a,0x1fb,0x030,0x0e4,0x335,0x328,0x382, // 80
+ 0x310,0x297,0x273,0x17a,0x17e,0x106,0x17c,0x25a,0x2f2,0x150,0x059,0x266,0x057,0x1b0,0x29e,0x268, // 96
+ 0x09d,0x176,0x0f2,0x2d6,0x258,0x10d,0x177,0x382,0x34d,0x1c6,0x162,0x082,0x32e,0x24b,0x324,0x022, // 112
+ 0x0d3,0x14a,0x21b,0x129,0x33b,0x361,0x025,0x205,0x342,0x13b,0x226,0x056,0x321,0x004,0x06c,0x21b),// 128
+ array( // ECL 7 (256 factors) -----------------------------------------------------------------------------
+ 0x20c,0x37e,0x04b,0x2fe,0x372,0x359,0x04a,0x0cc,0x052,0x24a,0x2c4,0x0fa,0x389,0x312,0x08a,0x2d0, // 16
+ 0x35a,0x0c2,0x137,0x391,0x113,0x0be,0x177,0x352,0x1b6,0x2dd,0x0c2,0x118,0x0c9,0x118,0x33c,0x2f5, // 32
+ 0x2c6,0x32e,0x397,0x059,0x044,0x239,0x00b,0x0cc,0x31c,0x25d,0x21c,0x391,0x321,0x2bc,0x31f,0x089, // 48
+ 0x1b7,0x1a2,0x250,0x29c,0x161,0x35b,0x172,0x2b6,0x145,0x0f0,0x0d8,0x101,0x11c,0x225,0x0d1,0x374, // 64
+ 0x13b,0x046,0x149,0x319,0x1ea,0x112,0x36d,0x0a2,0x2ed,0x32c,0x2ac,0x1cd,0x14e,0x178,0x351,0x209, // 80
+ 0x133,0x123,0x323,0x2c8,0x013,0x166,0x18f,0x38c,0x067,0x1ff,0x033,0x008,0x205,0x0e1,0x121,0x1d6, // 96
+ 0x27d,0x2db,0x042,0x0ff,0x395,0x10d,0x1cf,0x33e,0x2da,0x1b1,0x350,0x249,0x088,0x21a,0x38a,0x05a, // 112
+ 0x002,0x122,0x2e7,0x0c7,0x28f,0x387,0x149,0x031,0x322,0x244,0x163,0x24c,0x0bc,0x1ce,0x00a,0x086, // 128
+ 0x274,0x140,0x1df,0x082,0x2e3,0x047,0x107,0x13e,0x176,0x259,0x0c0,0x25d,0x08e,0x2a1,0x2af,0x0ea, // 144
+ 0x2d2,0x180,0x0b1,0x2f0,0x25f,0x280,0x1c7,0x0c1,0x2b1,0x2c3,0x325,0x281,0x030,0x03c,0x2dc,0x26d, // 160
+ 0x37f,0x220,0x105,0x354,0x28f,0x135,0x2b9,0x2f3,0x2f4,0x03c,0x0e7,0x305,0x1b2,0x1a5,0x2d6,0x210, // 176
+ 0x1f7,0x076,0x031,0x31b,0x020,0x090,0x1f4,0x0ee,0x344,0x18a,0x118,0x236,0x13f,0x009,0x287,0x226, // 192
+ 0x049,0x392,0x156,0x07e,0x020,0x2a9,0x14b,0x318,0x26c,0x03c,0x261,0x1b9,0x0b4,0x317,0x37d,0x2f2, // 208
+ 0x25d,0x17f,0x0e4,0x2ed,0x2f8,0x0d5,0x036,0x129,0x086,0x036,0x342,0x12b,0x39a,0x0bf,0x38e,0x214, // 224
+ 0x261,0x33d,0x0bd,0x014,0x0a7,0x01d,0x368,0x1c1,0x053,0x192,0x029,0x290,0x1f9,0x243,0x1e1,0x0ad, // 240
+ 0x194,0x0fb,0x2b0,0x05f,0x1f1,0x22b,0x282,0x21f,0x133,0x09f,0x39c,0x22e,0x288,0x037,0x1f1,0x00a),// 256
+ array( // ECL 8 (512 factors) -----------------------------------------------------------------------------
+ 0x160,0x04d,0x175,0x1f8,0x023,0x257,0x1ac,0x0cf,0x199,0x23e,0x076,0x1f2,0x11d,0x17c,0x15e,0x1ec, // 16
+ 0x0c5,0x109,0x398,0x09b,0x392,0x12b,0x0e5,0x283,0x126,0x367,0x132,0x058,0x057,0x0c1,0x160,0x30d, // 32
+ 0x34e,0x04b,0x147,0x208,0x1b3,0x21f,0x0cb,0x29a,0x0f9,0x15a,0x30d,0x26d,0x280,0x10c,0x31a,0x216, // 48
+ 0x21b,0x30d,0x198,0x186,0x284,0x066,0x1dc,0x1f3,0x122,0x278,0x221,0x025,0x35a,0x394,0x228,0x029, // 64
+ 0x21e,0x121,0x07a,0x110,0x17f,0x320,0x1e5,0x062,0x2f0,0x1d8,0x2f9,0x06b,0x310,0x35c,0x292,0x2e5, // 80
+ 0x122,0x0cc,0x2a9,0x197,0x357,0x055,0x063,0x03e,0x1e2,0x0b4,0x014,0x129,0x1c3,0x251,0x391,0x08e, // 96
+ 0x328,0x2ac,0x11f,0x218,0x231,0x04c,0x28d,0x383,0x2d9,0x237,0x2e8,0x186,0x201,0x0c0,0x204,0x102, // 112
+ 0x0f0,0x206,0x31a,0x18b,0x300,0x350,0x033,0x262,0x180,0x0a8,0x0be,0x33a,0x148,0x254,0x312,0x12f, // 128
+ 0x23a,0x17d,0x19f,0x281,0x09c,0x0ed,0x097,0x1ad,0x213,0x0cf,0x2a4,0x2c6,0x059,0x0a8,0x130,0x192, // 144
+ 0x028,0x2c4,0x23f,0x0a2,0x360,0x0e5,0x041,0x35d,0x349,0x200,0x0a4,0x1dd,0x0dd,0x05c,0x166,0x311, // 160
+ 0x120,0x165,0x352,0x344,0x33b,0x2e0,0x2c3,0x05e,0x008,0x1ee,0x072,0x209,0x002,0x1f3,0x353,0x21f, // 176
+ 0x098,0x2d9,0x303,0x05f,0x0f8,0x169,0x242,0x143,0x358,0x31d,0x121,0x033,0x2ac,0x1d2,0x215,0x334, // 192
+ 0x29d,0x02d,0x386,0x1c4,0x0a7,0x156,0x0f4,0x0ad,0x023,0x1cf,0x28b,0x033,0x2bb,0x24f,0x1c4,0x242, // 208
+ 0x025,0x07c,0x12a,0x14c,0x228,0x02b,0x1ab,0x077,0x296,0x309,0x1db,0x352,0x2fc,0x16c,0x242,0x38f, // 224
+ 0x11b,0x2c7,0x1d8,0x1a4,0x0f5,0x120,0x252,0x18a,0x1ff,0x147,0x24d,0x309,0x2bb,0x2b0,0x02b,0x198, // 240
+ 0x34a,0x17f,0x2d1,0x209,0x230,0x284,0x2ca,0x22f,0x03e,0x091,0x369,0x297,0x2c9,0x09f,0x2a0,0x2d9, // 256
+ 0x270,0x03b,0x0c1,0x1a1,0x09e,0x0d1,0x233,0x234,0x157,0x2b5,0x06d,0x260,0x233,0x16d,0x0b5,0x304, // 272
+ 0x2a5,0x136,0x0f8,0x161,0x2c4,0x19a,0x243,0x366,0x269,0x349,0x278,0x35c,0x121,0x218,0x023,0x309, // 288
+ 0x26a,0x24a,0x1a8,0x341,0x04d,0x255,0x15a,0x10d,0x2f5,0x278,0x2b7,0x2ef,0x14b,0x0f7,0x0b8,0x02d, // 304
+ 0x313,0x2a8,0x012,0x042,0x197,0x171,0x036,0x1ec,0x0e4,0x265,0x33e,0x39a,0x1b5,0x207,0x284,0x389, // 320
+ 0x315,0x1a4,0x131,0x1b9,0x0cf,0x12c,0x37c,0x33b,0x08d,0x219,0x17d,0x296,0x201,0x038,0x0fc,0x155, // 336
+ 0x0f2,0x31d,0x346,0x345,0x2d0,0x0e0,0x133,0x277,0x03d,0x057,0x230,0x136,0x2f4,0x299,0x18d,0x328, // 352
+ 0x353,0x135,0x1d9,0x31b,0x17a,0x01f,0x287,0x393,0x1cb,0x326,0x24e,0x2db,0x1a9,0x0d8,0x224,0x0f9, // 368
+ 0x141,0x371,0x2bb,0x217,0x2a1,0x30e,0x0d2,0x32f,0x389,0x12f,0x34b,0x39a,0x119,0x049,0x1d5,0x317, // 384
+ 0x294,0x0a2,0x1f2,0x134,0x09b,0x1a6,0x38b,0x331,0x0bb,0x03e,0x010,0x1a9,0x217,0x150,0x11e,0x1b5, // 400
+ 0x177,0x111,0x262,0x128,0x0b7,0x39b,0x074,0x29b,0x2ef,0x161,0x03e,0x16e,0x2b3,0x17b,0x2af,0x34a, // 416
+ 0x025,0x165,0x2d0,0x2e6,0x14a,0x005,0x027,0x39b,0x137,0x1a8,0x0f2,0x2ed,0x141,0x036,0x29d,0x13c, // 432
+ 0x156,0x12b,0x216,0x069,0x29b,0x1e8,0x280,0x2a0,0x240,0x21c,0x13c,0x1e6,0x2d1,0x262,0x02e,0x290, // 448
+ 0x1bf,0x0ab,0x268,0x1d0,0x0be,0x213,0x129,0x141,0x2fa,0x2f0,0x215,0x0af,0x086,0x00e,0x17d,0x1b1, // 464
+ 0x2cd,0x02d,0x06f,0x014,0x254,0x11c,0x2e0,0x08a,0x286,0x19b,0x36d,0x29d,0x08d,0x397,0x02d,0x30c, // 480
+ 0x197,0x0a4,0x14c,0x383,0x0a5,0x2d6,0x258,0x145,0x1f2,0x28f,0x165,0x2f0,0x300,0x0df,0x351,0x287, // 496
+ 0x03f,0x136,0x35f,0x0fb,0x16e,0x130,0x11a,0x2e2,0x2a3,0x19a,0x185,0x0f4,0x01f,0x079,0x12f,0x107) // 512
+ );
- /**
- * @var Factors of the Reed-Solomon polynomial equations used for error correction; one sub array for each correction level (0-8)
- * @access protected
- */
- protected $rsfactors = array(
- array( // ECL 0 (2 factors) -------------------------------------------------------------------------------
- 0x01b,0x395), // 2
- array( // ECL 1 (4 factors) -------------------------------------------------------------------------------
- 0x20a,0x238,0x2d3,0x329), // 4
- array( // ECL 2 (8 factors) -------------------------------------------------------------------------------
- 0x0ed,0x134,0x1b4,0x11c,0x286,0x28d,0x1ac,0x17b), // 8
- array( // ECL 3 (16 factors) ------------------------------------------------------------------------------
- 0x112,0x232,0x0e8,0x2f3,0x257,0x20c,0x321,0x084,0x127,0x074,0x1ba,0x1ac,0x127,0x02a,0x0b0,0x041),// 16
- array( // ECL 4 (32 factors) ------------------------------------------------------------------------------
- 0x169,0x23f,0x39a,0x20d,0x0b0,0x24a,0x280,0x141,0x218,0x2e6,0x2a5,0x2e6,0x2af,0x11c,0x0c1,0x205, // 16
- 0x111,0x1ee,0x107,0x093,0x251,0x320,0x23b,0x140,0x323,0x085,0x0e7,0x186,0x2ad,0x14a,0x03f,0x19a),// 32
- array( // ECL 5 (64 factors) ------------------------------------------------------------------------------
- 0x21b,0x1a6,0x006,0x05d,0x35e,0x303,0x1c5,0x06a,0x262,0x11f,0x06b,0x1f9,0x2dd,0x36d,0x17d,0x264, // 16
- 0x2d3,0x1dc,0x1ce,0x0ac,0x1ae,0x261,0x35a,0x336,0x21f,0x178,0x1ff,0x190,0x2a0,0x2fa,0x11b,0x0b8, // 32
- 0x1b8,0x023,0x207,0x01f,0x1cc,0x252,0x0e1,0x217,0x205,0x160,0x25d,0x09e,0x28b,0x0c9,0x1e8,0x1f6, // 48
- 0x288,0x2dd,0x2cd,0x053,0x194,0x061,0x118,0x303,0x348,0x275,0x004,0x17d,0x34b,0x26f,0x108,0x21f),// 64
- array( // ECL 6 (128 factors) -----------------------------------------------------------------------------
- 0x209,0x136,0x360,0x223,0x35a,0x244,0x128,0x17b,0x035,0x30b,0x381,0x1bc,0x190,0x39d,0x2ed,0x19f, // 16
- 0x336,0x05d,0x0d9,0x0d0,0x3a0,0x0f4,0x247,0x26c,0x0f6,0x094,0x1bf,0x277,0x124,0x38c,0x1ea,0x2c0, // 32
- 0x204,0x102,0x1c9,0x38b,0x252,0x2d3,0x2a2,0x124,0x110,0x060,0x2ac,0x1b0,0x2ae,0x25e,0x35c,0x239, // 48
- 0x0c1,0x0db,0x081,0x0ba,0x0ec,0x11f,0x0c0,0x307,0x116,0x0ad,0x028,0x17b,0x2c8,0x1cf,0x286,0x308, // 64
- 0x0ab,0x1eb,0x129,0x2fb,0x09c,0x2dc,0x05f,0x10e,0x1bf,0x05a,0x1fb,0x030,0x0e4,0x335,0x328,0x382, // 80
- 0x310,0x297,0x273,0x17a,0x17e,0x106,0x17c,0x25a,0x2f2,0x150,0x059,0x266,0x057,0x1b0,0x29e,0x268, // 96
- 0x09d,0x176,0x0f2,0x2d6,0x258,0x10d,0x177,0x382,0x34d,0x1c6,0x162,0x082,0x32e,0x24b,0x324,0x022, // 112
- 0x0d3,0x14a,0x21b,0x129,0x33b,0x361,0x025,0x205,0x342,0x13b,0x226,0x056,0x321,0x004,0x06c,0x21b),// 128
- array( // ECL 7 (256 factors) -----------------------------------------------------------------------------
- 0x20c,0x37e,0x04b,0x2fe,0x372,0x359,0x04a,0x0cc,0x052,0x24a,0x2c4,0x0fa,0x389,0x312,0x08a,0x2d0, // 16
- 0x35a,0x0c2,0x137,0x391,0x113,0x0be,0x177,0x352,0x1b6,0x2dd,0x0c2,0x118,0x0c9,0x118,0x33c,0x2f5, // 32
- 0x2c6,0x32e,0x397,0x059,0x044,0x239,0x00b,0x0cc,0x31c,0x25d,0x21c,0x391,0x321,0x2bc,0x31f,0x089, // 48
- 0x1b7,0x1a2,0x250,0x29c,0x161,0x35b,0x172,0x2b6,0x145,0x0f0,0x0d8,0x101,0x11c,0x225,0x0d1,0x374, // 64
- 0x13b,0x046,0x149,0x319,0x1ea,0x112,0x36d,0x0a2,0x2ed,0x32c,0x2ac,0x1cd,0x14e,0x178,0x351,0x209, // 80
- 0x133,0x123,0x323,0x2c8,0x013,0x166,0x18f,0x38c,0x067,0x1ff,0x033,0x008,0x205,0x0e1,0x121,0x1d6, // 96
- 0x27d,0x2db,0x042,0x0ff,0x395,0x10d,0x1cf,0x33e,0x2da,0x1b1,0x350,0x249,0x088,0x21a,0x38a,0x05a, // 112
- 0x002,0x122,0x2e7,0x0c7,0x28f,0x387,0x149,0x031,0x322,0x244,0x163,0x24c,0x0bc,0x1ce,0x00a,0x086, // 128
- 0x274,0x140,0x1df,0x082,0x2e3,0x047,0x107,0x13e,0x176,0x259,0x0c0,0x25d,0x08e,0x2a1,0x2af,0x0ea, // 144
- 0x2d2,0x180,0x0b1,0x2f0,0x25f,0x280,0x1c7,0x0c1,0x2b1,0x2c3,0x325,0x281,0x030,0x03c,0x2dc,0x26d, // 160
- 0x37f,0x220,0x105,0x354,0x28f,0x135,0x2b9,0x2f3,0x2f4,0x03c,0x0e7,0x305,0x1b2,0x1a5,0x2d6,0x210, // 176
- 0x1f7,0x076,0x031,0x31b,0x020,0x090,0x1f4,0x0ee,0x344,0x18a,0x118,0x236,0x13f,0x009,0x287,0x226, // 192
- 0x049,0x392,0x156,0x07e,0x020,0x2a9,0x14b,0x318,0x26c,0x03c,0x261,0x1b9,0x0b4,0x317,0x37d,0x2f2, // 208
- 0x25d,0x17f,0x0e4,0x2ed,0x2f8,0x0d5,0x036,0x129,0x086,0x036,0x342,0x12b,0x39a,0x0bf,0x38e,0x214, // 224
- 0x261,0x33d,0x0bd,0x014,0x0a7,0x01d,0x368,0x1c1,0x053,0x192,0x029,0x290,0x1f9,0x243,0x1e1,0x0ad, // 240
- 0x194,0x0fb,0x2b0,0x05f,0x1f1,0x22b,0x282,0x21f,0x133,0x09f,0x39c,0x22e,0x288,0x037,0x1f1,0x00a),// 256
- array( // ECL 8 (512 factors) -----------------------------------------------------------------------------
- 0x160,0x04d,0x175,0x1f8,0x023,0x257,0x1ac,0x0cf,0x199,0x23e,0x076,0x1f2,0x11d,0x17c,0x15e,0x1ec, // 16
- 0x0c5,0x109,0x398,0x09b,0x392,0x12b,0x0e5,0x283,0x126,0x367,0x132,0x058,0x057,0x0c1,0x160,0x30d, // 32
- 0x34e,0x04b,0x147,0x208,0x1b3,0x21f,0x0cb,0x29a,0x0f9,0x15a,0x30d,0x26d,0x280,0x10c,0x31a,0x216, // 48
- 0x21b,0x30d,0x198,0x186,0x284,0x066,0x1dc,0x1f3,0x122,0x278,0x221,0x025,0x35a,0x394,0x228,0x029, // 64
- 0x21e,0x121,0x07a,0x110,0x17f,0x320,0x1e5,0x062,0x2f0,0x1d8,0x2f9,0x06b,0x310,0x35c,0x292,0x2e5, // 80
- 0x122,0x0cc,0x2a9,0x197,0x357,0x055,0x063,0x03e,0x1e2,0x0b4,0x014,0x129,0x1c3,0x251,0x391,0x08e, // 96
- 0x328,0x2ac,0x11f,0x218,0x231,0x04c,0x28d,0x383,0x2d9,0x237,0x2e8,0x186,0x201,0x0c0,0x204,0x102, // 112
- 0x0f0,0x206,0x31a,0x18b,0x300,0x350,0x033,0x262,0x180,0x0a8,0x0be,0x33a,0x148,0x254,0x312,0x12f, // 128
- 0x23a,0x17d,0x19f,0x281,0x09c,0x0ed,0x097,0x1ad,0x213,0x0cf,0x2a4,0x2c6,0x059,0x0a8,0x130,0x192, // 144
- 0x028,0x2c4,0x23f,0x0a2,0x360,0x0e5,0x041,0x35d,0x349,0x200,0x0a4,0x1dd,0x0dd,0x05c,0x166,0x311, // 160
- 0x120,0x165,0x352,0x344,0x33b,0x2e0,0x2c3,0x05e,0x008,0x1ee,0x072,0x209,0x002,0x1f3,0x353,0x21f, // 176
- 0x098,0x2d9,0x303,0x05f,0x0f8,0x169,0x242,0x143,0x358,0x31d,0x121,0x033,0x2ac,0x1d2,0x215,0x334, // 192
- 0x29d,0x02d,0x386,0x1c4,0x0a7,0x156,0x0f4,0x0ad,0x023,0x1cf,0x28b,0x033,0x2bb,0x24f,0x1c4,0x242, // 208
- 0x025,0x07c,0x12a,0x14c,0x228,0x02b,0x1ab,0x077,0x296,0x309,0x1db,0x352,0x2fc,0x16c,0x242,0x38f, // 224
- 0x11b,0x2c7,0x1d8,0x1a4,0x0f5,0x120,0x252,0x18a,0x1ff,0x147,0x24d,0x309,0x2bb,0x2b0,0x02b,0x198, // 240
- 0x34a,0x17f,0x2d1,0x209,0x230,0x284,0x2ca,0x22f,0x03e,0x091,0x369,0x297,0x2c9,0x09f,0x2a0,0x2d9, // 256
- 0x270,0x03b,0x0c1,0x1a1,0x09e,0x0d1,0x233,0x234,0x157,0x2b5,0x06d,0x260,0x233,0x16d,0x0b5,0x304, // 272
- 0x2a5,0x136,0x0f8,0x161,0x2c4,0x19a,0x243,0x366,0x269,0x349,0x278,0x35c,0x121,0x218,0x023,0x309, // 288
- 0x26a,0x24a,0x1a8,0x341,0x04d,0x255,0x15a,0x10d,0x2f5,0x278,0x2b7,0x2ef,0x14b,0x0f7,0x0b8,0x02d, // 304
- 0x313,0x2a8,0x012,0x042,0x197,0x171,0x036,0x1ec,0x0e4,0x265,0x33e,0x39a,0x1b5,0x207,0x284,0x389, // 320
- 0x315,0x1a4,0x131,0x1b9,0x0cf,0x12c,0x37c,0x33b,0x08d,0x219,0x17d,0x296,0x201,0x038,0x0fc,0x155, // 336
- 0x0f2,0x31d,0x346,0x345,0x2d0,0x0e0,0x133,0x277,0x03d,0x057,0x230,0x136,0x2f4,0x299,0x18d,0x328, // 352
- 0x353,0x135,0x1d9,0x31b,0x17a,0x01f,0x287,0x393,0x1cb,0x326,0x24e,0x2db,0x1a9,0x0d8,0x224,0x0f9, // 368
- 0x141,0x371,0x2bb,0x217,0x2a1,0x30e,0x0d2,0x32f,0x389,0x12f,0x34b,0x39a,0x119,0x049,0x1d5,0x317, // 384
- 0x294,0x0a2,0x1f2,0x134,0x09b,0x1a6,0x38b,0x331,0x0bb,0x03e,0x010,0x1a9,0x217,0x150,0x11e,0x1b5, // 400
- 0x177,0x111,0x262,0x128,0x0b7,0x39b,0x074,0x29b,0x2ef,0x161,0x03e,0x16e,0x2b3,0x17b,0x2af,0x34a, // 416
- 0x025,0x165,0x2d0,0x2e6,0x14a,0x005,0x027,0x39b,0x137,0x1a8,0x0f2,0x2ed,0x141,0x036,0x29d,0x13c, // 432
- 0x156,0x12b,0x216,0x069,0x29b,0x1e8,0x280,0x2a0,0x240,0x21c,0x13c,0x1e6,0x2d1,0x262,0x02e,0x290, // 448
- 0x1bf,0x0ab,0x268,0x1d0,0x0be,0x213,0x129,0x141,0x2fa,0x2f0,0x215,0x0af,0x086,0x00e,0x17d,0x1b1, // 464
- 0x2cd,0x02d,0x06f,0x014,0x254,0x11c,0x2e0,0x08a,0x286,0x19b,0x36d,0x29d,0x08d,0x397,0x02d,0x30c, // 480
- 0x197,0x0a4,0x14c,0x383,0x0a5,0x2d6,0x258,0x145,0x1f2,0x28f,0x165,0x2f0,0x300,0x0df,0x351,0x287, // 496
- 0x03f,0x136,0x35f,0x0fb,0x16e,0x130,0x11a,0x2e2,0x2a3,0x19a,0x185,0x0f4,0x01f,0x079,0x12f,0x107) // 512
- );
-
- /**
- * This is the class constructor.
- * Creates a PDF417 object
- * @param string $code code to represent using PDF417
- * @param int $ecl error correction level (0-8); default -1 = automatic correction level
- * @param float $aspectratio the width to height of the symbol (excluding quiet zones)
- * òparam array $macro information for macro block
- * @access public
- */
- public function __construct($code, $ecl=-1, $aspectratio=2, $macro=array()) {
- $barcode_array = array();
- if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
- return false;
- }
- // get the input sequence array
- $sequence = $this->getInputSequences($code);
- $codewords = array(); // array of code-words
- foreach($sequence as $seq) {
- $cw = $this->getCompaction($seq[0], $seq[1], true);
- $codewords = array_merge($codewords, $cw);
- }
- if ($codewords[0] == 900) {
- // Text Alpha is the default mode, so remove the first code
- array_shift($codewords);
- }
- // count number of codewords
- $numcw = count($codewords);
- if ($numcw > 925) {
- // reached maximum data codeword capacity
- return false;
- }
- // build macro control block codewords
- if (!empty($macro)) {
- $macrocw = array();
- // beginning of macro control block
- $macrocw[] = 928;
- // segment index
- $cw = $this->getCompaction(902, sprintf('%05d', $macro['segment_index']), false);
- $macrocw = array_merge($macrocw, $cw);
- // file ID
- $cw = $this->getCompaction(900, $macro['file_id'], false);
- $macrocw = array_merge($macrocw, $cw);
- // optional fields
- $optmodes = array(900,902,902,900,900,902,902);
- $optsize = array(-1,2,4,-1,-1,-1,2);
- foreach ($optmodes as $k => $omode) {
- if (isset($macro['option_'.$k])) {
- $macrocw[] = 923;
- $macrocw[] = $k;
- if ($optsize[$k] == 2) {
- $macro['option_'.$k] = sprintf('%05d', $macro['option_'.$k]);
- } elseif ($optsize[$k] == 4) {
- $macro['option_'.$k] = sprintf('%010d', $macro['option_'.$k]);
- }
- $cw = $this->getCompaction($omode, $macro['option_'.$k], false);
- $macrocw = array_merge($macrocw, $cw);
+ /**
+ * This is the class constructor.
+ * Creates a PDF417 object
+ * @param $code (string) code to represent using PDF417
+ * @param $ecl (int) error correction level (0-8); default -1 = automatic correction level
+ * @param $aspectratio (float) the width to height of the symbol (excluding quiet zones)
+ * @param $macro (array) information for macro block
+ * @public
+ */
+ public function __construct($code, $ecl=-1, $aspectratio=2, $macro=array()) {
+ $barcode_array = array();
+ if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
+ return false;
+ }
+ // get the input sequence array
+ $sequence = $this->getInputSequences($code);
+ $codewords = array(); // array of code-words
+ foreach($sequence as $seq) {
+ $cw = $this->getCompaction($seq[0], $seq[1], true);
+ $codewords = array_merge($codewords, $cw);
+ }
+ if ($codewords[0] == 900) {
+ // Text Alpha is the default mode, so remove the first code
+ array_shift($codewords);
+ }
+ // count number of codewords
+ $numcw = count($codewords);
+ if ($numcw > 925) {
+ // reached maximum data codeword capacity
+ return false;
+ }
+ // build macro control block codewords
+ if (!empty($macro)) {
+ $macrocw = array();
+ // beginning of macro control block
+ $macrocw[] = 928;
+ // segment index
+ $cw = $this->getCompaction(902, sprintf('%05d', $macro['segment_index']), false);
+ $macrocw = array_merge($macrocw, $cw);
+ // file ID
+ $cw = $this->getCompaction(900, $macro['file_id'], false);
+ $macrocw = array_merge($macrocw, $cw);
+ // optional fields
+ $optmodes = array(900,902,902,900,900,902,902);
+ $optsize = array(-1,2,4,-1,-1,-1,2);
+ foreach ($optmodes as $k => $omode) {
+ if (isset($macro['option_'.$k])) {
+ $macrocw[] = 923;
+ $macrocw[] = $k;
+ if ($optsize[$k] == 2) {
+ $macro['option_'.$k] = sprintf('%05d', $macro['option_'.$k]);
+ } elseif ($optsize[$k] == 4) {
+ $macro['option_'.$k] = sprintf('%010d', $macro['option_'.$k]);
}
+ $cw = $this->getCompaction($omode, $macro['option_'.$k], false);
+ $macrocw = array_merge($macrocw, $cw);
}
- if ($macro['segment_index'] == ($macro['segment_total'] - 1)) {
- // end of control block
- $macrocw[] = 922;
- }
- // update total codewords
- $numcw += count($macrocw);
}
- // set error correction level
- $ecl = $this->getErrorCorrectionLevel($ecl, $numcw);
- // number of codewords for error correction
- $errsize = (2 << $ecl);
- // calculate number of columns (number of codewords per row) and rows
- $nce = ($numcw + $errsize + 1);
- $cols = round((sqrt(4761 + (68 * $aspectratio * ROWHEIGHT * $nce)) - 69) / 34);
- // adjust cols
- if ($cols < 1) {
- $cols = 1;
- } elseif ($cols > 30) {
- $cols = 30;
+ if ($macro['segment_index'] == ($macro['segment_total'] - 1)) {
+ // end of control block
+ $macrocw[] = 922;
}
- $rows = ceil($nce / $cols);
+ // update total codewords
+ $numcw += count($macrocw);
+ }
+ // set error correction level
+ $ecl = $this->getErrorCorrectionLevel($ecl, $numcw);
+ // number of codewords for error correction
+ $errsize = (2 << $ecl);
+ // calculate number of columns (number of codewords per row) and rows
+ $nce = ($numcw + $errsize + 1);
+ $cols = round((sqrt(4761 + (68 * $aspectratio * ROWHEIGHT * $nce)) - 69) / 34);
+ // adjust cols
+ if ($cols < 1) {
+ $cols = 1;
+ } elseif ($cols > 30) {
+ $cols = 30;
+ }
+ $rows = ceil($nce / $cols);
+ $size = ($cols * $rows);
+ // adjust rows
+ if (($rows < 3) OR ($rows > 90)) {
+ if ($rows < 3) {
+ $rows = 3;
+ } elseif ($rows > 90) {
+ $rows = 90;
+ }
+ $cols = ceil($size / $rows);
$size = ($cols * $rows);
- // adjust rows
- if (($rows < 3) OR ($rows > 90)) {
- if ($rows < 3) {
- $rows = 3;
- } elseif ($rows > 90) {
- $rows = 90;
- }
- $cols = ceil($size / $rows);
- $size = ($cols * $rows);
- }
- if ($size > 928) {
- // set dimensions to get maximum capacity
- if (abs($aspectratio - (17 * 29 / 32)) < abs($aspectratio - (17 * 16 / 58))) {
- $cols = 29;
- $rows = 32;
- } else {
- $cols = 16;
- $rows = 58;
- }
- $size = 928;
- }
- // calculate padding
- $pad = ($size - $nce);
- if ($pad > 0) {
- if (($size - $rows) == $nce) {
- --$rows;
- $size -= $rows;
- } else {
- // add pading
- $codewords = array_merge($codewords, array_fill(0, $pad, 900));
- }
- }
- if (!empty($macro)) {
- // add macro section
- $codewords = array_merge($codewords, $macrocw);
- }
- // Symbol Lenght Descriptor (number of data codewords including Symbol Lenght Descriptor and pad codewords)
- $sld = $size - $errsize;
- // add symbol length description
- array_unshift($codewords, $sld);
- // calculate error correction
- $ecw = $this->getErrorCorrection($codewords, $ecl);
- // add error correction codewords
- $codewords = array_merge($codewords, $ecw);
- // add horizontal quiet zones to start and stop patterns
- $pstart = str_repeat('0', QUIETH).$this->start_pattern;
- $pstop = $this->stop_pattern.str_repeat('0', QUIETH);
- $barcode_array['num_rows'] = ($rows * ROWHEIGHT) + (2 * QUIETV);
- $barcode_array['num_cols'] = (($cols + 2) * 17) + 35 + (2 * QUIETH);
- $barcode_array['bcode'] = array();
- // build rows for vertical quiet zone
- if (QUIETV > 0) {
- $empty_row = array_fill(0, $barcode_array['num_cols'], 0);
- for ($i = 0; $i < QUIETV; ++$i) {
- // add vertical quiet rows
- $barcode_array['bcode'][] = $empty_row;
- }
- }
- $k = 0; // codeword index
- $cid = 0; // initial cluster
- // for each row
- for ($r = 0; $r < $rows; ++$r) {
- // row start code
- $row = $pstart;
- switch ($cid) {
- case 0: {
- $L = ((30 * intval($r / 3)) + intval(($rows - 1) / 3));
- break;
- }
- case 1: {
- $L = ((30 * intval($r / 3)) + ($ecl * 3) + (($rows - 1) % 3));
- break;
- }
- case 2: {
- $L = ((30 * intval($r / 3)) + ($cols - 1));
- break;
- }
- }
- // left row indicator
- $row .= sprintf('%17b', $this->clusters[$cid][$L]);
- // for each column
- for ($c = 0; $c < $cols; ++$c) {
- $row .= sprintf('%17b', $this->clusters[$cid][$codewords[$k]]);
- ++$k;
- }
- switch ($cid) {
- case 0: {
- $L = ((30 * intval($r / 3)) + ($cols - 1));
- break;
- }
- case 1: {
- $L = ((30 * intval($r / 3)) + intval(($rows - 1) / 3));
- break;
- }
- case 2: {
- $L = ((30 * intval($r / 3)) + ($ecl * 3) + (($rows - 1) % 3));
- break;
- }
- }
- // right row indicator
- $row .= sprintf('%17b', $this->clusters[$cid][$L]);
- // row stop code
- $row .= $pstop;
- // convert the string to array
- $arow = preg_split('//', $row, -1, PREG_SPLIT_NO_EMPTY);
- // duplicate row to get the desired height
- for ($h = 0; $h < ROWHEIGHT; ++$h) {
- $barcode_array['bcode'][] = $arow;
- }
- ++$cid;
- if ($cid > 2) {
- $cid = 0;
- }
- }
- if (QUIETV > 0) {
- for ($i = 0; $i < QUIETV; ++$i) {
- // add vertical quiet rows
- $barcode_array['bcode'][] = $empty_row;
- }
- }
- $this->barcode_array = $barcode_array;
}
-
- /**
- * Returns a barcode array which is readable by TCPDF
- * @return array barcode array readable by TCPDF;
- * @access public
- */
- public function getBarcodeArray() {
- return $this->barcode_array;
+ if ($size > 928) {
+ // set dimensions to get maximum capacity
+ if (abs($aspectratio - (17 * 29 / 32)) < abs($aspectratio - (17 * 16 / 58))) {
+ $cols = 29;
+ $rows = 32;
+ } else {
+ $cols = 16;
+ $rows = 58;
+ }
+ $size = 928;
}
-
- /**
- * Returns the error correction level (0-8) to be used
- * @param int $ecl error correction level
- * @param int $numcw number of data codewords
- * @return int error correction level
- * @access protected
- */
- protected function getErrorCorrectionLevel($ecl, $numcw) {
- // get maximum correction level
- $maxecl = 8; // starting error level
- $maxerrsize = (928 - $numcw); // available codewords for error
- while ($maxecl > 0) {
- $errsize = (2 << $ecl);
- if ($maxerrsize >= $errsize) {
+ // calculate padding
+ $pad = ($size - $nce);
+ if ($pad > 0) {
+ if (($size - $rows) == $nce) {
+ --$rows;
+ $size -= $rows;
+ } else {
+ // add pading
+ $codewords = array_merge($codewords, array_fill(0, $pad, 900));
+ }
+ }
+ if (!empty($macro)) {
+ // add macro section
+ $codewords = array_merge($codewords, $macrocw);
+ }
+ // Symbol Lenght Descriptor (number of data codewords including Symbol Lenght Descriptor and pad codewords)
+ $sld = $size - $errsize;
+ // add symbol length description
+ array_unshift($codewords, $sld);
+ // calculate error correction
+ $ecw = $this->getErrorCorrection($codewords, $ecl);
+ // add error correction codewords
+ $codewords = array_merge($codewords, $ecw);
+ // add horizontal quiet zones to start and stop patterns
+ $pstart = str_repeat('0', QUIETH).$this->start_pattern;
+ $pstop = $this->stop_pattern.str_repeat('0', QUIETH);
+ $barcode_array['num_rows'] = ($rows * ROWHEIGHT) + (2 * QUIETV);
+ $barcode_array['num_cols'] = (($cols + 2) * 17) + 35 + (2 * QUIETH);
+ $barcode_array['bcode'] = array();
+ // build rows for vertical quiet zone
+ if (QUIETV > 0) {
+ $empty_row = array_fill(0, $barcode_array['num_cols'], 0);
+ for ($i = 0; $i < QUIETV; ++$i) {
+ // add vertical quiet rows
+ $barcode_array['bcode'][] = $empty_row;
+ }
+ }
+ $k = 0; // codeword index
+ $cid = 0; // initial cluster
+ // for each row
+ for ($r = 0; $r < $rows; ++$r) {
+ // row start code
+ $row = $pstart;
+ switch ($cid) {
+ case 0: {
+ $L = ((30 * intval($r / 3)) + intval(($rows - 1) / 3));
break;
}
- --$maxecl;
- }
- // check for automatic levels
- if (($ecl < 0) OR ($ecl > 8)) {
- if ($numcw < 41) {
- $ecl = 2;
- } elseif ($numcw < 161) {
- $ecl = 3;
- } elseif ($numcw < 321) {
- $ecl = 4;
- } elseif ($numcw < 864) {
- $ecl = 5;
- } else {
- $ecl = $maxecl;
+ case 1: {
+ $L = ((30 * intval($r / 3)) + ($ecl * 3) + (($rows - 1) % 3));
+ break;
+ }
+ case 2: {
+ $L = ((30 * intval($r / 3)) + ($cols - 1));
+ break;
}
}
- if ($ecl > $maxecl) {
+ // left row indicator
+ $row .= sprintf('%17b', $this->clusters[$cid][$L]);
+ // for each column
+ for ($c = 0; $c < $cols; ++$c) {
+ $row .= sprintf('%17b', $this->clusters[$cid][$codewords[$k]]);
+ ++$k;
+ }
+ switch ($cid) {
+ case 0: {
+ $L = ((30 * intval($r / 3)) + ($cols - 1));
+ break;
+ }
+ case 1: {
+ $L = ((30 * intval($r / 3)) + intval(($rows - 1) / 3));
+ break;
+ }
+ case 2: {
+ $L = ((30 * intval($r / 3)) + ($ecl * 3) + (($rows - 1) % 3));
+ break;
+ }
+ }
+ // right row indicator
+ $row .= sprintf('%17b', $this->clusters[$cid][$L]);
+ // row stop code
+ $row .= $pstop;
+ // convert the string to array
+ $arow = preg_split('//', $row, -1, PREG_SPLIT_NO_EMPTY);
+ // duplicate row to get the desired height
+ for ($h = 0; $h < ROWHEIGHT; ++$h) {
+ $barcode_array['bcode'][] = $arow;
+ }
+ ++$cid;
+ if ($cid > 2) {
+ $cid = 0;
+ }
+ }
+ if (QUIETV > 0) {
+ for ($i = 0; $i < QUIETV; ++$i) {
+ // add vertical quiet rows
+ $barcode_array['bcode'][] = $empty_row;
+ }
+ }
+ $this->barcode_array = $barcode_array;
+ }
+
+ /**
+ * Returns a barcode array which is readable by TCPDF
+ * @return array barcode array readable by TCPDF;
+ * @public
+ */
+ public function getBarcodeArray() {
+ return $this->barcode_array;
+ }
+
+ /**
+ * Returns the error correction level (0-8) to be used
+ * @param $ecl (int) error correction level
+ * @param $numcw (int) number of data codewords
+ * @return int error correction level
+ * @protected
+ */
+ protected function getErrorCorrectionLevel($ecl, $numcw) {
+ // get maximum correction level
+ $maxecl = 8; // starting error level
+ $maxerrsize = (928 - $numcw); // available codewords for error
+ while ($maxecl > 0) {
+ $errsize = (2 << $ecl);
+ if ($maxerrsize >= $errsize) {
+ break;
+ }
+ --$maxecl;
+ }
+ // check for automatic levels
+ if (($ecl < 0) OR ($ecl > 8)) {
+ if ($numcw < 41) {
+ $ecl = 2;
+ } elseif ($numcw < 161) {
+ $ecl = 3;
+ } elseif ($numcw < 321) {
+ $ecl = 4;
+ } elseif ($numcw < 864) {
+ $ecl = 5;
+ } else {
$ecl = $maxecl;
}
- return $ecl;
}
+ if ($ecl > $maxecl) {
+ $ecl = $maxecl;
+ }
+ return $ecl;
+ }
- /**
- * Returns the error correction codewords
- * @param array $cw array of codewords including Symbol Lenght Descriptor and pad
- * @param int $ecl error correction level 0-8
- * @return array of error correction codewords
- * @access protected
- */
- protected function getErrorCorrection($cw, $ecl) {
- // get error correction coefficients
- $ecc = $this->rsfactors[$ecl];
- // number of error correction factors
- $eclsize = (2 << $ecl);
- // maximum index for $rsfactors[$ecl]
- $eclmaxid = ($eclsize - 1);
- // initialize array of error correction codewords
- $ecw = array_fill(0, $eclsize, 0);
- // for each data codeword
- foreach($cw as $k => $d) {
- $t1 = ($d + $ecw[$eclmaxid]) % 929;
- for ($j = $eclmaxid; $j > 0; --$j) {
- $t2 = ($t1 * $ecc[$j]) % 929;
- $t3 = 929 - $t2;
- $ecw[$j] = ($ecw[($j - 1)] + $t3) % 929;
- }
- $t2 = ($t1 * $ecc[0]) % 929;
+ /**
+ * Returns the error correction codewords
+ * @param $cw (array) array of codewords including Symbol Lenght Descriptor and pad
+ * @param $ecl (int) error correction level 0-8
+ * @return array of error correction codewords
+ * @protected
+ */
+ protected function getErrorCorrection($cw, $ecl) {
+ // get error correction coefficients
+ $ecc = $this->rsfactors[$ecl];
+ // number of error correction factors
+ $eclsize = (2 << $ecl);
+ // maximum index for $rsfactors[$ecl]
+ $eclmaxid = ($eclsize - 1);
+ // initialize array of error correction codewords
+ $ecw = array_fill(0, $eclsize, 0);
+ // for each data codeword
+ foreach($cw as $k => $d) {
+ $t1 = ($d + $ecw[$eclmaxid]) % 929;
+ for ($j = $eclmaxid; $j > 0; --$j) {
+ $t2 = ($t1 * $ecc[$j]) % 929;
$t3 = 929 - $t2;
- $ecw[0] = $t3 % 929;
+ $ecw[$j] = ($ecw[($j - 1)] + $t3) % 929;
}
- foreach($ecw as $j => $e) {
- if ($e != 0) {
- $ecw[$j] = 929 - $e;
- }
- }
- $ecw = array_reverse($ecw);
- return $ecw;
+ $t2 = ($t1 * $ecc[0]) % 929;
+ $t3 = 929 - $t2;
+ $ecw[0] = $t3 % 929;
}
+ foreach($ecw as $j => $e) {
+ if ($e != 0) {
+ $ecw[$j] = 929 - $e;
+ }
+ }
+ $ecw = array_reverse($ecw);
+ return $ecw;
+ }
- /**
- * Create array of sequences from input
- * @param string $code code
- * @return bidimensional array containing characters and classification
- * @access protected
- */
- protected function getInputSequences($code) {
- $sequence_array = array(); // array to be returned
- $numseq = array();
- // get numeric sequences
- preg_match_all('/([0-9]{13,})/', $code, $numseq, PREG_OFFSET_CAPTURE);
- $numseq[1][] = array('', strlen($code));
- $offset = 0;
- foreach($numseq[1] as $seq) {
- $seqlen = strlen($seq[0]);
- if ($seq[1] > 0) {
- // extract text sequence before the number sequence
- $prevseq = substr($code, $offset, ($seq[1] - $offset));
- $textseq = array();
- // get text sequences
- preg_match_all('/([\x09\x0a\x0d\x20-\x7e]{5,})/', $prevseq, $textseq, PREG_OFFSET_CAPTURE);
- $textseq[1][] = array('', strlen($prevseq));
- $txtoffset = 0;
- foreach($textseq[1] as $txtseq) {
- $txtseqlen = strlen($txtseq[0]);
- if ($txtseq[1] > 0) {
- // extract byte sequence before the text sequence
- $prevtxtseq = substr($prevseq, $txtoffset, ($txtseq[1] - $txtoffset));
- if (strlen($prevtxtseq) > 0) {
- // add BYTE sequence
- if ((strlen($prevtxtseq) == 1) AND ((count($sequence_array) > 0) AND ($sequence_array[(count($sequence_array) - 1)][0] == 900))) {
- $sequence_array[] = array(913, $prevtxtseq);
- } elseif ((strlen($prevtxtseq) % 6) == 0) {
- $sequence_array[] = array(924, $prevtxtseq);
- } else {
- $sequence_array[] = array(901, $prevtxtseq);
- }
+ /**
+ * Create array of sequences from input
+ * @param $code (string) code
+ * @return bidimensional array containing characters and classification
+ * @protected
+ */
+ protected function getInputSequences($code) {
+ $sequence_array = array(); // array to be returned
+ $numseq = array();
+ // get numeric sequences
+ preg_match_all('/([0-9]{13,})/', $code, $numseq, PREG_OFFSET_CAPTURE);
+ $numseq[1][] = array('', strlen($code));
+ $offset = 0;
+ foreach($numseq[1] as $seq) {
+ $seqlen = strlen($seq[0]);
+ if ($seq[1] > 0) {
+ // extract text sequence before the number sequence
+ $prevseq = substr($code, $offset, ($seq[1] - $offset));
+ $textseq = array();
+ // get text sequences
+ preg_match_all('/([\x09\x0a\x0d\x20-\x7e]{5,})/', $prevseq, $textseq, PREG_OFFSET_CAPTURE);
+ $textseq[1][] = array('', strlen($prevseq));
+ $txtoffset = 0;
+ foreach($textseq[1] as $txtseq) {
+ $txtseqlen = strlen($txtseq[0]);
+ if ($txtseq[1] > 0) {
+ // extract byte sequence before the text sequence
+ $prevtxtseq = substr($prevseq, $txtoffset, ($txtseq[1] - $txtoffset));
+ if (strlen($prevtxtseq) > 0) {
+ // add BYTE sequence
+ if ((strlen($prevtxtseq) == 1) AND ((count($sequence_array) > 0) AND ($sequence_array[(count($sequence_array) - 1)][0] == 900))) {
+ $sequence_array[] = array(913, $prevtxtseq);
+ } elseif ((strlen($prevtxtseq) % 6) == 0) {
+ $sequence_array[] = array(924, $prevtxtseq);
+ } else {
+ $sequence_array[] = array(901, $prevtxtseq);
}
}
- if ($txtseqlen > 0) {
- // add numeric sequence
- $sequence_array[] = array(900, $txtseq[0]);
- }
- $txtoffset = $txtseq[1] + $txtseqlen;
}
+ if ($txtseqlen > 0) {
+ // add numeric sequence
+ $sequence_array[] = array(900, $txtseq[0]);
+ }
+ $txtoffset = $txtseq[1] + $txtseqlen;
}
- if ($seqlen > 0) {
- // add numeric sequence
- $sequence_array[] = array(902, $seq[0]);
- }
- $offset = $seq[1] + $seqlen;
}
- return $sequence_array;
+ if ($seqlen > 0) {
+ // add numeric sequence
+ $sequence_array[] = array(902, $seq[0]);
+ }
+ $offset = $seq[1] + $seqlen;
}
+ return $sequence_array;
+ }
- /**
- * Compact data by mode.
- * @param int $mode compaction mode number
- * @param string $code data to compact
- * @param boolean $addmode if true add the mode codeword at first position
- * @return array of codewords
- * @access protected
- */
- protected function getCompaction($mode, $code, $addmode=true) {
- $cw = array(); // array of codewords to return
- switch($mode) {
- case 900: { // Text Compaction mode latch
- $submode = 0; // default Alpha sub-mode
- $txtarr = array(); // array of characters and sub-mode switching characters
- $codelen = strlen($code);
- for ($i = 0; $i < $codelen; ++$i) {
- $chval = ord($code{$i});
- if (($k = array_search($chval, $this->textsubmodes[$submode])) !== false) {
- // we are on the same sub-mode
- $txtarr[] = $k;
- } else {
- // the sub-mode is changed
- for ($s = 0; $s < 4; ++$s) {
- // search new sub-mode
- if (($s != $submode) AND (($k = array_search($chval, $this->textsubmodes[$s])) !== false)) {
- // $s is the new submode
- if (((($i + 1) == $codelen) OR ((($i + 1) < $codelen) AND (array_search(ord($code{($i + 1)}), $this->textsubmodes[$submode]) !== false))) AND (($s == 3) OR (($s == 0) AND ($submode == 1)))) {
- // shift (temporary change only for this char)
- if ($s == 3) {
- // shift to puntuaction
- $txtarr[] = 29;
- } else {
- // shift from lower to alpha
- $txtarr[] = 27;
- }
+ /**
+ * Compact data by mode.
+ * @param $mode (int) compaction mode number
+ * @param $code (string) data to compact
+ * @param $addmode (boolean) if true add the mode codeword at first position
+ * @return array of codewords
+ * @protected
+ */
+ protected function getCompaction($mode, $code, $addmode=true) {
+ $cw = array(); // array of codewords to return
+ switch($mode) {
+ case 900: { // Text Compaction mode latch
+ $submode = 0; // default Alpha sub-mode
+ $txtarr = array(); // array of characters and sub-mode switching characters
+ $codelen = strlen($code);
+ for ($i = 0; $i < $codelen; ++$i) {
+ $chval = ord($code{$i});
+ if (($k = array_search($chval, $this->textsubmodes[$submode])) !== false) {
+ // we are on the same sub-mode
+ $txtarr[] = $k;
+ } else {
+ // the sub-mode is changed
+ for ($s = 0; $s < 4; ++$s) {
+ // search new sub-mode
+ if (($s != $submode) AND (($k = array_search($chval, $this->textsubmodes[$s])) !== false)) {
+ // $s is the new submode
+ if (((($i + 1) == $codelen) OR ((($i + 1) < $codelen) AND (array_search(ord($code{($i + 1)}), $this->textsubmodes[$submode]) !== false))) AND (($s == 3) OR (($s == 0) AND ($submode == 1)))) {
+ // shift (temporary change only for this char)
+ if ($s == 3) {
+ // shift to puntuaction
+ $txtarr[] = 29;
} else {
- // latch
- $txtarr = array_merge($txtarr, $this->textlatch[''.$submode.$s]);
- // set new submode
- $submode = $s;
+ // shift from lower to alpha
+ $txtarr[] = 27;
}
- // add characted code to array
- $txtarr[] = $k;
- break;
+ } else {
+ // latch
+ $txtarr = array_merge($txtarr, $this->textlatch[''.$submode.$s]);
+ // set new submode
+ $submode = $s;
}
+ // add characted code to array
+ $txtarr[] = $k;
+ break;
}
}
}
- $txtarrlen = count($txtarr);
- if (($txtarrlen % 2) != 0) {
- // add padding
- $txtarr[] = 29;
- ++$txtarrlen;
- }
- // calculate codewords
- for ($i = 0; $i < $txtarrlen; $i += 2) {
- $cw[] = (30 * $txtarr[$i]) + $txtarr[($i + 1)];
- }
- break;
}
- case 901:
- case 924: { // Byte Compaction mode latch
- while (($codelen = strlen($code)) > 0) {
- if ($codelen > 6) {
- $rest = substr($code, 6);
- $code = substr($code, 0, 6);
- $sublen = 6;
- } else {
- $rest = '';
- $sublen = strlen($code);
- }
- if ($sublen == 6) {
- $t = bcmul(''.ord($code{0}), '1099511627776');
- $t = bcadd($t, bcmul(''.ord($code{1}), '4294967296'));
- $t = bcadd($t, bcmul(''.ord($code{2}), '16777216'));
- $t = bcadd($t, bcmul(''.ord($code{3}), '65536'));
- $t = bcadd($t, bcmul(''.ord($code{4}), '256'));
- $t = bcadd($t, ''.ord($code{5}));
- do {
- $d = bcmod($t, '900');
- $t = bcdiv($t, '900');
- array_unshift($cw, $d);
- } while ($t != '0');
- } else {
- for ($i = 0; $i < $sublen; ++$i) {
- $cw[] = ord($code{$i});
- }
- }
- $code = $rest;
- }
- break;
+ $txtarrlen = count($txtarr);
+ if (($txtarrlen % 2) != 0) {
+ // add padding
+ $txtarr[] = 29;
+ ++$txtarrlen;
}
- case 902: { // Numeric Compaction mode latch
- while (($codelen = strlen($code)) > 0) {
- if ($codelen > 44) {
- $rest = substr($code, 44);
- $code = substr($code, 0, 44);
- } else {
- $rest = '';
- }
- $t = '1'.$code;
+ // calculate codewords
+ for ($i = 0; $i < $txtarrlen; $i += 2) {
+ $cw[] = (30 * $txtarr[$i]) + $txtarr[($i + 1)];
+ }
+ break;
+ }
+ case 901:
+ case 924: { // Byte Compaction mode latch
+ while (($codelen = strlen($code)) > 0) {
+ if ($codelen > 6) {
+ $rest = substr($code, 6);
+ $code = substr($code, 0, 6);
+ $sublen = 6;
+ } else {
+ $rest = '';
+ $sublen = strlen($code);
+ }
+ if ($sublen == 6) {
+ $t = bcmul(''.ord($code{0}), '1099511627776');
+ $t = bcadd($t, bcmul(''.ord($code{1}), '4294967296'));
+ $t = bcadd($t, bcmul(''.ord($code{2}), '16777216'));
+ $t = bcadd($t, bcmul(''.ord($code{3}), '65536'));
+ $t = bcadd($t, bcmul(''.ord($code{4}), '256'));
+ $t = bcadd($t, ''.ord($code{5}));
do {
$d = bcmod($t, '900');
$t = bcdiv($t, '900');
array_unshift($cw, $d);
} while ($t != '0');
- $code = $rest;
+ } else {
+ for ($i = 0; $i < $sublen; ++$i) {
+ $cw[] = ord($code{$i});
+ }
}
- break;
+ $code = $rest;
}
- case 913: { // Byte Compaction mode shift
- $cw[] = ord($code);
- break;
+ break;
+ }
+ case 902: { // Numeric Compaction mode latch
+ while (($codelen = strlen($code)) > 0) {
+ if ($codelen > 44) {
+ $rest = substr($code, 44);
+ $code = substr($code, 0, 44);
+ } else {
+ $rest = '';
+ }
+ $t = '1'.$code;
+ do {
+ $d = bcmod($t, '900');
+ $t = bcdiv($t, '900');
+ array_unshift($cw, $d);
+ } while ($t != '0');
+ $code = $rest;
}
+ break;
}
- if ($addmode) {
- // add the compaction mode codeword at the beginning
- array_unshift($cw, $mode);
+ case 913: { // Byte Compaction mode shift
+ $cw[] = ord($code);
+ break;
}
- return $cw;
}
+ if ($addmode) {
+ // add the compaction mode codeword at the beginning
+ array_unshift($cw, $mode);
+ }
+ return $cw;
+ }
- } // end PDF417 class
+} // end PDF417 class
-} // END OF "class_exists PDF417"
//============================================================+
// END OF FILE
//============================================================+
diff --git a/htdocs/includes/tcpdf/qrcode.php b/htdocs/includes/tcpdf/qrcode.php
index a065c4d4314..4f9167679d1 100644
--- a/htdocs/includes/tcpdf/qrcode.php
+++ b/htdocs/includes/tcpdf/qrcode.php
@@ -1,9 +1,9 @@
$split_length) OR (!$split_length)) {
- do {
- $c = strlen($string);
- $parts[] = substr($string, 0, $split_length);
- $string = substr($string, $split_length);
- } while ($string !== false);
- } else {
- $parts = array($string);
- }
- return $parts;
+// for compatibility with PHP4
+if (!function_exists('str_split')) {
+ /**
+ * Convert a string to an array (needed for PHP4 compatibility)
+ * @param $string (string) The input string.
+ * @param $split_length (int) Maximum length of the chunk.
+ * @return If the optional split_length parameter is specified, the returned array will be broken down into chunks with each being split_length in length, otherwise each chunk will be one character in length. FALSE is returned if split_length is less than 1. If the split_length length exceeds the length of string , the entire string is returned as the first (and only) array element.
+ */
+ function str_split($string, $split_length=1) {
+ if ((strlen($string) > $split_length) OR (!$split_length)) {
+ do {
+ $c = strlen($string);
+ $parts[] = substr($string, 0, $split_length);
+ $string = substr($string, $split_length);
+ } while ($string !== false);
+ } else {
+ $parts = array($string);
}
+ return $parts;
}
+}
- // #####################################################
+// #####################################################
+
+/**
+ * @class QRcode
+ * Class to create QR-code arrays for TCPDF class.
+ * QR Code symbol is a 2D barcode that can be scanned by handy terminals such as a mobile phone with CCD.
+ * The capacity of QR Code is up to 7000 digits or 4000 characters, and has high robustness.
+ * This class supports QR Code model 2, described in JIS (Japanese Industrial Standards) X0510:2004 or ISO/IEC 18004.
+ * Currently the following features are not supported: ECI and FNC1 mode, Micro QR Code, QR Code model 1, Structured mode.
+ *
+ * This class is derived from "PHP QR Code encoder" by Dominik Dzienia (http://phpqrcode.sourceforge.net/) based on "libqrencode C library 3.1.1." by Kentaro Fukuchi (http://megaui.net/fukuchi/works/qrencode/index.en.html), contains Reed-Solomon code written by Phil Karn, KA9Q. QR Code is registered trademark of DENSO WAVE INCORPORATED (http://www.denso-wave.com/qrcode/index-e.html).
+ * Please read comments on this class source file for full copyright and license information.
+ *
+ * @package com.tecnick.tcpdf
+ * @author Nicola Asuni
+ * @version 1.0.009
+ */
+class QRcode {
/**
- * Class to create QR-code arrays for TCPDF class.
- * QR Code symbol is a 2D barcode that can be scanned by handy terminals such as a mobile phone with CCD.
- * The capacity of QR Code is up to 7000 digits or 4000 characters, and has high robustness.
- * This class supports QR Code model 2, described in JIS (Japanese Industrial Standards) X0510:2004 or ISO/IEC 18004.
- * Currently the following features are not supported: ECI and FNC1 mode, Micro QR Code, QR Code model 1, Structured mode.
- *
- * This class is derived from "PHP QR Code encoder" by Dominik Dzienia (http://phpqrcode.sourceforge.net/) based on "libqrencode C library 3.1.1." by Kentaro Fukuchi (http://megaui.net/fukuchi/works/qrencode/index.en.html), contains Reed-Solomon code written by Phil Karn, KA9Q. QR Code is registered trademark of DENSO WAVE INCORPORATED (http://www.denso-wave.com/qrcode/index-e.html).
- * Please read comments on this class source file for full copyright and license information.
- *
- * @name QRcode
- * @package com.tecnick.tcpdf
- * @abstract Class for generating QR-code array for TCPDF.
- * @author Nicola Asuni
- * @copyright 2010-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
- * @link http://www.tcpdf.org
- * @license http://www.gnu.org/copyleft/lesser.html LGPL
- * @version 1.0.006
+ * Barcode array to be returned which is readable by TCPDF.
+ * @protected
*/
- class QRcode {
+ protected $barcode_array = array();
- /**
- * @var barcode array to be returned which is readable by TCPDF
- * @access protected
- */
- protected $barcode_array = array();
+ /**
+ * QR code version. Size of QRcode is defined as version. Version is from 1 to 40. Version 1 is 21*21 matrix. And 4 modules increases whenever 1 version increases. So version 40 is 177*177 matrix.
+ * @protected
+ */
+ protected $version = 0;
- /**
- * @var QR code version. Size of QRcode is defined as version. Version is from 1 to 40. Version 1 is 21*21 matrix. And 4 modules increases whenever 1 version increases. So version 40 is 177*177 matrix.
- * @access protected
- */
- protected $version = 0;
+ /**
+ * Levels of error correction. See definitions for possible values.
+ * @protected
+ */
+ protected $level = QR_ECLEVEL_L;
- /**
- * @var Levels of error correction. See definitions for possible values.
- * @access protected
- */
- protected $level = QR_ECLEVEL_L;
+ /**
+ * Encoding mode.
+ * @protected
+ */
+ protected $hint = QR_MODE_8B;
- /**
- * @var Encoding mode
- * @access protected
- */
- protected $hint = QR_MODE_8B;
+ /**
+ * Boolean flag, if true the input string will be converted to uppercase.
+ * @protected
+ */
+ protected $casesensitive = true;
- /**
- * @var if true the input string will be converted to uppercase
- * @access protected
- */
- protected $casesensitive = true;
+ /**
+ * Structured QR code (not supported yet).
+ * @protected
+ */
+ protected $structured = 0;
- /**
- * @var structured QR code (not supported yet)
- * @access protected
- */
- protected $structured = 0;
+ /**
+ * Mask data.
+ * @protected
+ */
+ protected $data;
- /**
- * @var mask data
- * @access protected
- */
- protected $data;
+ // FrameFiller
- // FrameFiller
+ /**
+ * Width.
+ * @protected
+ */
+ protected $width;
- /**
- * @var width
- * @access protected
- */
- protected $width;
+ /**
+ * Frame.
+ * @protected
+ */
+ protected $frame;
- /**
- * @var frame
- * @access protected
- */
- protected $frame;
+ /**
+ * X position of bit.
+ * @protected
+ */
+ protected $x;
- /**
- * @var X position of bit
- * @access protected
- */
- protected $x;
+ /**
+ * Y position of bit.
+ * @protected
+ */
+ protected $y;
- /**
- * @var Y position of bit
- * @access protected
- */
- protected $y;
+ /**
+ * Direction.
+ * @protected
+ */
+ protected $dir;
- /**
- * @var direction
- * @access protected
- */
- protected $dir;
+ /**
+ * Single bit value.
+ * @protected
+ */
+ protected $bit;
- /**
- * @var single bit
- * @access protected
- */
- protected $bit;
+ // ---- QRrawcode ----
- // ---- QRrawcode ----
+ /**
+ * Data code.
+ * @protected
+ */
+ protected $datacode = array();
- /**
- * @var data code
- * @access protected
- */
- protected $datacode = array();
+ /**
+ * Error correction code.
+ * @protected
+ */
+ protected $ecccode = array();
- /**
- * @var error correction code
- * @access protected
- */
- protected $ecccode = array();
+ /**
+ * Blocks.
+ * @protected
+ */
+ protected $blocks;
- /**
- * @var blocks
- * @access protected
- */
- protected $blocks;
+ /**
+ * Reed-Solomon blocks.
+ * @protected
+ */
+ protected $rsblocks = array(); //of RSblock
- /**
- * @var Reed-Solomon blocks
- * @access protected
- */
- protected $rsblocks = array(); //of RSblock
+ /**
+ * Counter.
+ * @protected
+ */
+ protected $count;
- /**
- * @var counter
- * @access protected
- */
- protected $count;
+ /**
+ * Data length.
+ * @protected
+ */
+ protected $dataLength;
- /**
- * @var data length
- * @access protected
- */
- protected $dataLength;
+ /**
+ * Error correction length.
+ * @protected
+ */
+ protected $eccLength;
- /**
- * @var error correction length
- * @access protected
- */
- protected $eccLength;
+ /**
+ * Value b1.
+ * @protected
+ */
+ protected $b1;
- /**
- * @var b1
- * @access protected
- */
- protected $b1;
+ // ---- QRmask ----
- // ---- QRmask ----
+ /**
+ * Run length.
+ * @protected
+ */
+ protected $runLength = array();
- /**
- * @var run length
- * @access protected
- */
- protected $runLength = array();
+ // ---- QRsplit ----
- // ---- QRsplit ----
+ /**
+ * Input data string.
+ * @protected
+ */
+ protected $dataStr = '';
- /**
- * @var input data string
- * @access protected
- */
- protected $dataStr = '';
+ /**
+ * Input items.
+ * @protected
+ */
+ protected $items;
- /**
- * @var input items
- * @access protected
- */
- protected $items;
+ // Reed-Solomon items
- // Reed-Solomon items
+ /**
+ * Reed-Solomon items.
+ * @protected
+ */
+ protected $rsitems = array();
- /**
- * @var Reed-Solomon items
- * @access protected
- */
- protected $rsitems = array();
+ /**
+ * Array of frames.
+ * @protected
+ */
+ protected $frames = array();
- /**
- * @var array of frames
- * @access protected
- */
- protected $frames = array();
-
- /**
- * @var alphabet-numeric convesion table
- * @access protected
- */
- protected $anTable = array(
- -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
- -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
- 36, -1, -1, -1, 37, 38, -1, -1, -1, -1, 39, 40, -1, 41, 42, 43, //
- 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 44, -1, -1, -1, -1, -1, //
- -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, //
- 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, -1, //
- -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
- -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 //
- );
-
- /**
- * @var array Table of the capacity of symbols
- * See Table 1 (pp.13) and Table 12-16 (pp.30-36), JIS X0510:2004.
- * @access protected
- */
- protected $capacity = array(
- array( 0, 0, 0, array( 0, 0, 0, 0)), //
- array( 21, 26, 0, array( 7, 10, 13, 17)), // 1
- array( 25, 44, 7, array( 10, 16, 22, 28)), //
- array( 29, 70, 7, array( 15, 26, 36, 44)), //
- array( 33, 100, 7, array( 20, 36, 52, 64)), //
- array( 37, 134, 7, array( 26, 48, 72, 88)), // 5
- array( 41, 172, 7, array( 36, 64, 96, 112)), //
- array( 45, 196, 0, array( 40, 72, 108, 130)), //
- array( 49, 242, 0, array( 48, 88, 132, 156)), //
- array( 53, 292, 0, array( 60, 110, 160, 192)), //
- array( 57, 346, 0, array( 72, 130, 192, 224)), // 10
- array( 61, 404, 0, array( 80, 150, 224, 264)), //
- array( 65, 466, 0, array( 96, 176, 260, 308)), //
- array( 69, 532, 0, array( 104, 198, 288, 352)), //
- array( 73, 581, 3, array( 120, 216, 320, 384)), //
- array( 77, 655, 3, array( 132, 240, 360, 432)), // 15
- array( 81, 733, 3, array( 144, 280, 408, 480)), //
- array( 85, 815, 3, array( 168, 308, 448, 532)), //
- array( 89, 901, 3, array( 180, 338, 504, 588)), //
- array( 93, 991, 3, array( 196, 364, 546, 650)), //
- array( 97, 1085, 3, array( 224, 416, 600, 700)), // 20
- array(101, 1156, 4, array( 224, 442, 644, 750)), //
- array(105, 1258, 4, array( 252, 476, 690, 816)), //
- array(109, 1364, 4, array( 270, 504, 750, 900)), //
- array(113, 1474, 4, array( 300, 560, 810, 960)), //
- array(117, 1588, 4, array( 312, 588, 870, 1050)), // 25
- array(121, 1706, 4, array( 336, 644, 952, 1110)), //
- array(125, 1828, 4, array( 360, 700, 1020, 1200)), //
- array(129, 1921, 3, array( 390, 728, 1050, 1260)), //
- array(133, 2051, 3, array( 420, 784, 1140, 1350)), //
- array(137, 2185, 3, array( 450, 812, 1200, 1440)), // 30
- array(141, 2323, 3, array( 480, 868, 1290, 1530)), //
- array(145, 2465, 3, array( 510, 924, 1350, 1620)), //
- array(149, 2611, 3, array( 540, 980, 1440, 1710)), //
- array(153, 2761, 3, array( 570, 1036, 1530, 1800)), //
- array(157, 2876, 0, array( 570, 1064, 1590, 1890)), // 35
- array(161, 3034, 0, array( 600, 1120, 1680, 1980)), //
- array(165, 3196, 0, array( 630, 1204, 1770, 2100)), //
- array(169, 3362, 0, array( 660, 1260, 1860, 2220)), //
- array(173, 3532, 0, array( 720, 1316, 1950, 2310)), //
- array(177, 3706, 0, array( 750, 1372, 2040, 2430)) // 40
+ /**
+ * Alphabet-numeric convesion table.
+ * @protected
+ */
+ protected $anTable = array(
+ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
+ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
+ 36, -1, -1, -1, 37, 38, -1, -1, -1, -1, 39, 40, -1, 41, 42, 43, //
+ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 44, -1, -1, -1, -1, -1, //
+ -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, //
+ 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, -1, //
+ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, //
+ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 //
);
- /**
- * @var array Length indicator
- * @access protected
- */
- protected $lengthTableBits = array(
- array(10, 12, 14),
- array( 9, 11, 13),
- array( 8, 16, 16),
- array( 8, 10, 12)
- );
+ /**
+ * Array Table of the capacity of symbols.
+ * See Table 1 (pp.13) and Table 12-16 (pp.30-36), JIS X0510:2004.
+ * @protected
+ */
+ protected $capacity = array(
+ array( 0, 0, 0, array( 0, 0, 0, 0)), //
+ array( 21, 26, 0, array( 7, 10, 13, 17)), // 1
+ array( 25, 44, 7, array( 10, 16, 22, 28)), //
+ array( 29, 70, 7, array( 15, 26, 36, 44)), //
+ array( 33, 100, 7, array( 20, 36, 52, 64)), //
+ array( 37, 134, 7, array( 26, 48, 72, 88)), // 5
+ array( 41, 172, 7, array( 36, 64, 96, 112)), //
+ array( 45, 196, 0, array( 40, 72, 108, 130)), //
+ array( 49, 242, 0, array( 48, 88, 132, 156)), //
+ array( 53, 292, 0, array( 60, 110, 160, 192)), //
+ array( 57, 346, 0, array( 72, 130, 192, 224)), // 10
+ array( 61, 404, 0, array( 80, 150, 224, 264)), //
+ array( 65, 466, 0, array( 96, 176, 260, 308)), //
+ array( 69, 532, 0, array( 104, 198, 288, 352)), //
+ array( 73, 581, 3, array( 120, 216, 320, 384)), //
+ array( 77, 655, 3, array( 132, 240, 360, 432)), // 15
+ array( 81, 733, 3, array( 144, 280, 408, 480)), //
+ array( 85, 815, 3, array( 168, 308, 448, 532)), //
+ array( 89, 901, 3, array( 180, 338, 504, 588)), //
+ array( 93, 991, 3, array( 196, 364, 546, 650)), //
+ array( 97, 1085, 3, array( 224, 416, 600, 700)), // 20
+ array(101, 1156, 4, array( 224, 442, 644, 750)), //
+ array(105, 1258, 4, array( 252, 476, 690, 816)), //
+ array(109, 1364, 4, array( 270, 504, 750, 900)), //
+ array(113, 1474, 4, array( 300, 560, 810, 960)), //
+ array(117, 1588, 4, array( 312, 588, 870, 1050)), // 25
+ array(121, 1706, 4, array( 336, 644, 952, 1110)), //
+ array(125, 1828, 4, array( 360, 700, 1020, 1200)), //
+ array(129, 1921, 3, array( 390, 728, 1050, 1260)), //
+ array(133, 2051, 3, array( 420, 784, 1140, 1350)), //
+ array(137, 2185, 3, array( 450, 812, 1200, 1440)), // 30
+ array(141, 2323, 3, array( 480, 868, 1290, 1530)), //
+ array(145, 2465, 3, array( 510, 924, 1350, 1620)), //
+ array(149, 2611, 3, array( 540, 980, 1440, 1710)), //
+ array(153, 2761, 3, array( 570, 1036, 1530, 1800)), //
+ array(157, 2876, 0, array( 570, 1064, 1590, 1890)), // 35
+ array(161, 3034, 0, array( 600, 1120, 1680, 1980)), //
+ array(165, 3196, 0, array( 630, 1204, 1770, 2100)), //
+ array(169, 3362, 0, array( 660, 1260, 1860, 2220)), //
+ array(173, 3532, 0, array( 720, 1316, 1950, 2310)), //
+ array(177, 3706, 0, array( 750, 1372, 2040, 2430)) // 40
+ );
- /**
- * @var array Table of the error correction code (Reed-Solomon block)
- * See Table 12-16 (pp.30-36), JIS X0510:2004.
- * @access protected
- */
- protected $eccTable = array(
- array(array( 0, 0), array( 0, 0), array( 0, 0), array( 0, 0)), //
- array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), // 1
- array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), //
- array(array( 1, 0), array( 1, 0), array( 2, 0), array( 2, 0)), //
- array(array( 1, 0), array( 2, 0), array( 2, 0), array( 4, 0)), //
- array(array( 1, 0), array( 2, 0), array( 2, 2), array( 2, 2)), // 5
- array(array( 2, 0), array( 4, 0), array( 4, 0), array( 4, 0)), //
- array(array( 2, 0), array( 4, 0), array( 2, 4), array( 4, 1)), //
- array(array( 2, 0), array( 2, 2), array( 4, 2), array( 4, 2)), //
- array(array( 2, 0), array( 3, 2), array( 4, 4), array( 4, 4)), //
- array(array( 2, 2), array( 4, 1), array( 6, 2), array( 6, 2)), // 10
- array(array( 4, 0), array( 1, 4), array( 4, 4), array( 3, 8)), //
- array(array( 2, 2), array( 6, 2), array( 4, 6), array( 7, 4)), //
- array(array( 4, 0), array( 8, 1), array( 8, 4), array(12, 4)), //
- array(array( 3, 1), array( 4, 5), array(11, 5), array(11, 5)), //
- array(array( 5, 1), array( 5, 5), array( 5, 7), array(11, 7)), // 15
- array(array( 5, 1), array( 7, 3), array(15, 2), array( 3, 13)), //
- array(array( 1, 5), array(10, 1), array( 1, 15), array( 2, 17)), //
- array(array( 5, 1), array( 9, 4), array(17, 1), array( 2, 19)), //
- array(array( 3, 4), array( 3, 11), array(17, 4), array( 9, 16)), //
- array(array( 3, 5), array( 3, 13), array(15, 5), array(15, 10)), // 20
- array(array( 4, 4), array(17, 0), array(17, 6), array(19, 6)), //
- array(array( 2, 7), array(17, 0), array( 7, 16), array(34, 0)), //
- array(array( 4, 5), array( 4, 14), array(11, 14), array(16, 14)), //
- array(array( 6, 4), array( 6, 14), array(11, 16), array(30, 2)), //
- array(array( 8, 4), array( 8, 13), array( 7, 22), array(22, 13)), // 25
- array(array(10, 2), array(19, 4), array(28, 6), array(33, 4)), //
- array(array( 8, 4), array(22, 3), array( 8, 26), array(12, 28)), //
- array(array( 3, 10), array( 3, 23), array( 4, 31), array(11, 31)), //
- array(array( 7, 7), array(21, 7), array( 1, 37), array(19, 26)), //
- array(array( 5, 10), array(19, 10), array(15, 25), array(23, 25)), // 30
- array(array(13, 3), array( 2, 29), array(42, 1), array(23, 28)), //
- array(array(17, 0), array(10, 23), array(10, 35), array(19, 35)), //
- array(array(17, 1), array(14, 21), array(29, 19), array(11, 46)), //
- array(array(13, 6), array(14, 23), array(44, 7), array(59, 1)), //
- array(array(12, 7), array(12, 26), array(39, 14), array(22, 41)), // 35
- array(array( 6, 14), array( 6, 34), array(46, 10), array( 2, 64)), //
- array(array(17, 4), array(29, 14), array(49, 10), array(24, 46)), //
- array(array( 4, 18), array(13, 32), array(48, 14), array(42, 32)), //
- array(array(20, 4), array(40, 7), array(43, 22), array(10, 67)), //
- array(array(19, 6), array(18, 31), array(34, 34), array(20, 61)) // 40
- );
+ /**
+ * Array Length indicator.
+ * @protected
+ */
+ protected $lengthTableBits = array(
+ array(10, 12, 14),
+ array( 9, 11, 13),
+ array( 8, 16, 16),
+ array( 8, 10, 12)
+ );
- /**
- * @var array Positions of alignment patterns.
- * This array includes only the second and the third position of the alignment patterns. Rest of them can be calculated from the distance between them.
- * See Table 1 in Appendix E (pp.71) of JIS X0510:2004.
- * @access protected
- */
- protected $alignmentPattern = array(
- array( 0, 0),
- array( 0, 0), array(18, 0), array(22, 0), array(26, 0), array(30, 0), // 1- 5
- array(34, 0), array(22, 38), array(24, 42), array(26, 46), array(28, 50), // 6-10
- array(30, 54), array(32, 58), array(34, 62), array(26, 46), array(26, 48), // 11-15
- array(26, 50), array(30, 54), array(30, 56), array(30, 58), array(34, 62), // 16-20
- array(28, 50), array(26, 50), array(30, 54), array(28, 54), array(32, 58), // 21-25
- array(30, 58), array(34, 62), array(26, 50), array(30, 54), array(26, 52), // 26-30
- array(30, 56), array(34, 60), array(30, 58), array(34, 62), array(30, 54), // 31-35
- array(24, 50), array(28, 54), array(32, 58), array(26, 54), array(30, 58) // 35-40
- );
+ /**
+ * Array Table of the error correction code (Reed-Solomon block).
+ * See Table 12-16 (pp.30-36), JIS X0510:2004.
+ * @protected
+ */
+ protected $eccTable = array(
+ array(array( 0, 0), array( 0, 0), array( 0, 0), array( 0, 0)), //
+ array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), // 1
+ array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), //
+ array(array( 1, 0), array( 1, 0), array( 2, 0), array( 2, 0)), //
+ array(array( 1, 0), array( 2, 0), array( 2, 0), array( 4, 0)), //
+ array(array( 1, 0), array( 2, 0), array( 2, 2), array( 2, 2)), // 5
+ array(array( 2, 0), array( 4, 0), array( 4, 0), array( 4, 0)), //
+ array(array( 2, 0), array( 4, 0), array( 2, 4), array( 4, 1)), //
+ array(array( 2, 0), array( 2, 2), array( 4, 2), array( 4, 2)), //
+ array(array( 2, 0), array( 3, 2), array( 4, 4), array( 4, 4)), //
+ array(array( 2, 2), array( 4, 1), array( 6, 2), array( 6, 2)), // 10
+ array(array( 4, 0), array( 1, 4), array( 4, 4), array( 3, 8)), //
+ array(array( 2, 2), array( 6, 2), array( 4, 6), array( 7, 4)), //
+ array(array( 4, 0), array( 8, 1), array( 8, 4), array(12, 4)), //
+ array(array( 3, 1), array( 4, 5), array(11, 5), array(11, 5)), //
+ array(array( 5, 1), array( 5, 5), array( 5, 7), array(11, 7)), // 15
+ array(array( 5, 1), array( 7, 3), array(15, 2), array( 3, 13)), //
+ array(array( 1, 5), array(10, 1), array( 1, 15), array( 2, 17)), //
+ array(array( 5, 1), array( 9, 4), array(17, 1), array( 2, 19)), //
+ array(array( 3, 4), array( 3, 11), array(17, 4), array( 9, 16)), //
+ array(array( 3, 5), array( 3, 13), array(15, 5), array(15, 10)), // 20
+ array(array( 4, 4), array(17, 0), array(17, 6), array(19, 6)), //
+ array(array( 2, 7), array(17, 0), array( 7, 16), array(34, 0)), //
+ array(array( 4, 5), array( 4, 14), array(11, 14), array(16, 14)), //
+ array(array( 6, 4), array( 6, 14), array(11, 16), array(30, 2)), //
+ array(array( 8, 4), array( 8, 13), array( 7, 22), array(22, 13)), // 25
+ array(array(10, 2), array(19, 4), array(28, 6), array(33, 4)), //
+ array(array( 8, 4), array(22, 3), array( 8, 26), array(12, 28)), //
+ array(array( 3, 10), array( 3, 23), array( 4, 31), array(11, 31)), //
+ array(array( 7, 7), array(21, 7), array( 1, 37), array(19, 26)), //
+ array(array( 5, 10), array(19, 10), array(15, 25), array(23, 25)), // 30
+ array(array(13, 3), array( 2, 29), array(42, 1), array(23, 28)), //
+ array(array(17, 0), array(10, 23), array(10, 35), array(19, 35)), //
+ array(array(17, 1), array(14, 21), array(29, 19), array(11, 46)), //
+ array(array(13, 6), array(14, 23), array(44, 7), array(59, 1)), //
+ array(array(12, 7), array(12, 26), array(39, 14), array(22, 41)), // 35
+ array(array( 6, 14), array( 6, 34), array(46, 10), array( 2, 64)), //
+ array(array(17, 4), array(29, 14), array(49, 10), array(24, 46)), //
+ array(array( 4, 18), array(13, 32), array(48, 14), array(42, 32)), //
+ array(array(20, 4), array(40, 7), array(43, 22), array(10, 67)), //
+ array(array(19, 6), array(18, 31), array(34, 34), array(20, 61)) // 40
+ );
- /**
- * @var array Version information pattern (BCH coded).
- * See Table 1 in Appendix D (pp.68) of JIS X0510:2004.
- * size: [QRSPEC_VERSION_MAX - 6]
- * @access protected
- */
- protected $versionPattern = array(
- 0x07c94, 0x085bc, 0x09a99, 0x0a4d3, 0x0bbf6, 0x0c762, 0x0d847, 0x0e60d, //
- 0x0f928, 0x10b78, 0x1145d, 0x12a17, 0x13532, 0x149a6, 0x15683, 0x168c9, //
- 0x177ec, 0x18ec4, 0x191e1, 0x1afab, 0x1b08e, 0x1cc1a, 0x1d33f, 0x1ed75, //
- 0x1f250, 0x209d5, 0x216f0, 0x228ba, 0x2379f, 0x24b0b, 0x2542e, 0x26a64, //
- 0x27541, 0x28c69
- );
+ /**
+ * Array Positions of alignment patterns.
+ * This array includes only the second and the third position of the alignment patterns. Rest of them can be calculated from the distance between them.
+ * See Table 1 in Appendix E (pp.71) of JIS X0510:2004.
+ * @protected
+ */
+ protected $alignmentPattern = array(
+ array( 0, 0),
+ array( 0, 0), array(18, 0), array(22, 0), array(26, 0), array(30, 0), // 1- 5
+ array(34, 0), array(22, 38), array(24, 42), array(26, 46), array(28, 50), // 6-10
+ array(30, 54), array(32, 58), array(34, 62), array(26, 46), array(26, 48), // 11-15
+ array(26, 50), array(30, 54), array(30, 56), array(30, 58), array(34, 62), // 16-20
+ array(28, 50), array(26, 50), array(30, 54), array(28, 54), array(32, 58), // 21-25
+ array(30, 58), array(34, 62), array(26, 50), array(30, 54), array(26, 52), // 26-30
+ array(30, 56), array(34, 60), array(30, 58), array(34, 62), array(30, 54), // 31-35
+ array(24, 50), array(28, 54), array(32, 58), array(26, 54), array(30, 58) // 35-40
+ );
- /**
- * @var array Format information
- * @access protected
- */
- protected $formatInfo = array(
- array(0x77c4, 0x72f3, 0x7daa, 0x789d, 0x662f, 0x6318, 0x6c41, 0x6976), //
- array(0x5412, 0x5125, 0x5e7c, 0x5b4b, 0x45f9, 0x40ce, 0x4f97, 0x4aa0), //
- array(0x355f, 0x3068, 0x3f31, 0x3a06, 0x24b4, 0x2183, 0x2eda, 0x2bed), //
- array(0x1689, 0x13be, 0x1ce7, 0x19d0, 0x0762, 0x0255, 0x0d0c, 0x083b) //
- );
+ /**
+ * Array Version information pattern (BCH coded).
+ * See Table 1 in Appendix D (pp.68) of JIS X0510:2004.
+ * size: [QRSPEC_VERSION_MAX - 6]
+ * @protected
+ */
+ protected $versionPattern = array(
+ 0x07c94, 0x085bc, 0x09a99, 0x0a4d3, 0x0bbf6, 0x0c762, 0x0d847, 0x0e60d, //
+ 0x0f928, 0x10b78, 0x1145d, 0x12a17, 0x13532, 0x149a6, 0x15683, 0x168c9, //
+ 0x177ec, 0x18ec4, 0x191e1, 0x1afab, 0x1b08e, 0x1cc1a, 0x1d33f, 0x1ed75, //
+ 0x1f250, 0x209d5, 0x216f0, 0x228ba, 0x2379f, 0x24b0b, 0x2542e, 0x26a64, //
+ 0x27541, 0x28c69
+ );
+
+ /**
+ * Array Format information
+ * @protected
+ */
+ protected $formatInfo = array(
+ array(0x77c4, 0x72f3, 0x7daa, 0x789d, 0x662f, 0x6318, 0x6c41, 0x6976), //
+ array(0x5412, 0x5125, 0x5e7c, 0x5b4b, 0x45f9, 0x40ce, 0x4f97, 0x4aa0), //
+ array(0x355f, 0x3068, 0x3f31, 0x3a06, 0x24b4, 0x2183, 0x2eda, 0x2bed), //
+ array(0x1689, 0x13be, 0x1ce7, 0x19d0, 0x0762, 0x0255, 0x0d0c, 0x083b) //
+ );
- // -------------------------------------------------
- // -------------------------------------------------
+ // -------------------------------------------------
+ // -------------------------------------------------
- /**
- * This is the class constructor.
- * Creates a QRcode object
- * @param string $code code to represent using QRcode
- * @param string $eclevel error level: - L : About 7% or less errors can be corrected.
- M : About 15% or less errors can be corrected.
- Q : About 25% or less errors can be corrected.
- H : About 30% or less errors can be corrected.
- * @access public
- * @since 1.0.000
- */
- public function __construct($code, $eclevel = 'L') {
- $barcode_array = array();
- if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
- return false;
- }
- // set error correction level
- $this->level = array_search($eclevel, array('L', 'M', 'Q', 'H'));
- if ($this->level === false) {
- $this->level = QR_ECLEVEL_L;
- }
- if (($this->hint != QR_MODE_8B) AND ($this->hint != QR_MODE_KJ)) {
- return false;
- }
- if (($this->version < 0) OR ($this->version > QRSPEC_VERSION_MAX)) {
- return false;
- }
- $this->items = array();
- $this->encodeString($code);
- if (is_null($this->data)) {
- return false;
- }
- $qrTab = $this->binarize($this->data);
- $size = count($qrTab);
- $barcode_array['num_rows'] = $size;
- $barcode_array['num_cols'] = $size;
- $barcode_array['bcode'] = array();
- foreach ($qrTab as $line) {
- $arrAdd = array();
- foreach (str_split($line) as $char) {
- $arrAdd[] = ($char=='1')?1:0;
- }
- $barcode_array['bcode'][] = $arrAdd;
- }
- $this->barcode_array = $barcode_array;
+ /**
+ * This is the class constructor.
+ * Creates a QRcode object
+ * @param $code (string) code to represent using QRcode
+ * @param $eclevel (string) error level: - L : About 7% or less errors can be corrected.
- M : About 15% or less errors can be corrected.
- Q : About 25% or less errors can be corrected.
- H : About 30% or less errors can be corrected.
+ * @public
+ * @since 1.0.000
+ */
+ public function __construct($code, $eclevel = 'L') {
+ $barcode_array = array();
+ if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
+ return false;
}
-
- /**
- * Returns a barcode array which is readable by TCPDF
- * @return array barcode array readable by TCPDF;
- * @access public
- */
- public function getBarcodeArray() {
- return $this->barcode_array;
+ // set error correction level
+ $this->level = array_search($eclevel, array('L', 'M', 'Q', 'H'));
+ if ($this->level === false) {
+ $this->level = QR_ECLEVEL_L;
}
-
- /**
- * Convert the frame in binary form
- * @param array $frame array to binarize
- * @return array frame in binary form
- */
- protected function binarize($frame) {
- $len = count($frame);
- // the frame is square (width = height)
- foreach ($frame as &$frameLine) {
- for ($i=0; $i<$len; $i++) {
- $frameLine[$i] = (ord($frameLine[$i])&1)?'1':'0';
- }
- }
- return $frame;
+ if (($this->hint != QR_MODE_8B) AND ($this->hint != QR_MODE_KJ)) {
+ return false;
}
-
- /**
- * Encode the input string to QR code
- * @param string $string input string to encode
- */
- protected function encodeString($string) {
- $this->dataStr = $string;
- if (!$this->casesensitive) {
- $this->toUpper();
- }
- $ret = $this->splitString();
- if ($ret < 0) {
- return NULL;
- }
- $this->encodeMask(-1);
+ if (($this->version < 0) OR ($this->version > QRSPEC_VERSION_MAX)) {
+ return false;
}
+ $this->items = array();
+ $this->encodeString($code);
+ if (is_null($this->data)) {
+ return false;
+ }
+ $qrTab = $this->binarize($this->data);
+ $size = count($qrTab);
+ $barcode_array['num_rows'] = $size;
+ $barcode_array['num_cols'] = $size;
+ $barcode_array['bcode'] = array();
+ foreach ($qrTab as $line) {
+ $arrAdd = array();
+ foreach (str_split($line) as $char) {
+ $arrAdd[] = ($char=='1')?1:0;
+ }
+ $barcode_array['bcode'][] = $arrAdd;
+ }
+ $this->barcode_array = $barcode_array;
+ }
- /**
- * Encode mask
- * @param int $mask masking mode
- */
- protected function encodeMask($mask) {
- $spec = array(0, 0, 0, 0, 0);
- $this->datacode = $this->getByteStream($this->items);
- if (is_null($this->datacode)) {
- return NULL;
+ /**
+ * Returns a barcode array which is readable by TCPDF
+ * @return array barcode array readable by TCPDF;
+ * @public
+ */
+ public function getBarcodeArray() {
+ return $this->barcode_array;
+ }
+
+ /**
+ * Convert the frame in binary form
+ * @param $frame (array) array to binarize
+ * @return array frame in binary form
+ */
+ protected function binarize($frame) {
+ $len = count($frame);
+ // the frame is square (width = height)
+ foreach ($frame as &$frameLine) {
+ for ($i=0; $i<$len; $i++) {
+ $frameLine[$i] = (ord($frameLine[$i])&1)?'1':'0';
}
- $spec = $this->getEccSpec($this->version, $this->level, $spec);
- $this->b1 = $this->rsBlockNum1($spec);
- $this->dataLength = $this->rsDataLength($spec);
- $this->eccLength = $this->rsEccLength($spec);
- $this->ecccode = array_fill(0, $this->eccLength, 0);
- $this->blocks = $this->rsBlockNum($spec);
- $ret = $this->init($spec);
- if ($ret < 0) {
- return NULL;
- }
- $this->count = 0;
- $this->width = $this->getWidth($this->version);
- $this->frame = $this->newFrame($this->version);
- $this->x = $this->width - 1;
- $this->y = $this->width - 1;
- $this->dir = -1;
- $this->bit = -1;
- // inteleaved data and ecc codes
- for ($i=0; $i < ($this->dataLength + $this->eccLength); $i++) {
- $code = $this->getCode();
- $bit = 0x80;
- for ($j=0; $j<8; $j++) {
- $addr = $this->getNextPosition();
- $this->setFrameAt($addr, 0x02 | (($bit & $code) != 0));
- $bit = $bit >> 1;
- }
- }
- // remainder bits
- $j = $this->getRemainder($this->version);
- for ($i=0; $i<$j; $i++) {
+ }
+ return $frame;
+ }
+
+ /**
+ * Encode the input string to QR code
+ * @param $string (string) input string to encode
+ */
+ protected function encodeString($string) {
+ $this->dataStr = $string;
+ if (!$this->casesensitive) {
+ $this->toUpper();
+ }
+ $ret = $this->splitString();
+ if ($ret < 0) {
+ return NULL;
+ }
+ $this->encodeMask(-1);
+ }
+
+ /**
+ * Encode mask
+ * @param $mask (int) masking mode
+ */
+ protected function encodeMask($mask) {
+ $spec = array(0, 0, 0, 0, 0);
+ $this->datacode = $this->getByteStream($this->items);
+ if (is_null($this->datacode)) {
+ return NULL;
+ }
+ $spec = $this->getEccSpec($this->version, $this->level, $spec);
+ $this->b1 = $this->rsBlockNum1($spec);
+ $this->dataLength = $this->rsDataLength($spec);
+ $this->eccLength = $this->rsEccLength($spec);
+ $this->ecccode = array_fill(0, $this->eccLength, 0);
+ $this->blocks = $this->rsBlockNum($spec);
+ $ret = $this->init($spec);
+ if ($ret < 0) {
+ return NULL;
+ }
+ $this->count = 0;
+ $this->width = $this->getWidth($this->version);
+ $this->frame = $this->newFrame($this->version);
+ $this->x = $this->width - 1;
+ $this->y = $this->width - 1;
+ $this->dir = -1;
+ $this->bit = -1;
+ // inteleaved data and ecc codes
+ for ($i=0; $i < ($this->dataLength + $this->eccLength); $i++) {
+ $code = $this->getCode();
+ $bit = 0x80;
+ for ($j=0; $j<8; $j++) {
$addr = $this->getNextPosition();
- $this->setFrameAt($addr, 0x02);
+ $this->setFrameAt($addr, 0x02 | (($bit & $code) != 0));
+ $bit = $bit >> 1;
}
- // masking
- $this->runLength = array_fill(0, QRSPEC_WIDTH_MAX + 1, 0);
- if ($mask < 0) {
- if (QR_FIND_BEST_MASK) {
- $masked = $this->mask($this->width, $this->frame, $this->level);
- } else {
- $masked = $this->makeMask($this->width, $this->frame, (intval(QR_DEFAULT_MASK) % 8), $this->level);
+ }
+ // remainder bits
+ $j = $this->getRemainder($this->version);
+ for ($i=0; $i<$j; $i++) {
+ $addr = $this->getNextPosition();
+ $this->setFrameAt($addr, 0x02);
+ }
+ // masking
+ $this->runLength = array_fill(0, QRSPEC_WIDTH_MAX + 1, 0);
+ if ($mask < 0) {
+ if (QR_FIND_BEST_MASK) {
+ $masked = $this->mask($this->width, $this->frame, $this->level);
+ } else {
+ $masked = $this->makeMask($this->width, $this->frame, (intval(QR_DEFAULT_MASK) % 8), $this->level);
+ }
+ } else {
+ $masked = $this->makeMask($this->width, $this->frame, $mask, $this->level);
+ }
+ if ($masked == NULL) {
+ return NULL;
+ }
+ $this->data = $masked;
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // FrameFiller
+
+ /**
+ * Set frame value at specified position
+ * @param $at (array) x,y position
+ * @param $val (int) value of the character to set
+ */
+ protected function setFrameAt($at, $val) {
+ $this->frame[$at['y']][$at['x']] = chr($val);
+ }
+
+ /**
+ * Get frame value at specified position
+ * @param $at (array) x,y position
+ * @return value at specified position
+ */
+ protected function getFrameAt($at) {
+ return ord($this->frame[$at['y']][$at['x']]);
+ }
+
+ /**
+ * Return the next frame position
+ * @return array of x,y coordinates
+ */
+ protected function getNextPosition() {
+ do {
+ if ($this->bit == -1) {
+ $this->bit = 0;
+ return array('x'=>$this->x, 'y'=>$this->y);
+ }
+ $x = $this->x;
+ $y = $this->y;
+ $w = $this->width;
+ if ($this->bit == 0) {
+ $x--;
+ $this->bit++;
+ } else {
+ $x++;
+ $y += $this->dir;
+ $this->bit--;
+ }
+ if ($this->dir < 0) {
+ if ($y < 0) {
+ $y = 0;
+ $x -= 2;
+ $this->dir = 1;
+ if ($x == 6) {
+ $x--;
+ $y = 9;
+ }
}
} else {
- $masked = $this->makeMask($this->width, $this->frame, $mask, $this->level);
+ if ($y == $w) {
+ $y = $w - 1;
+ $x -= 2;
+ $this->dir = -1;
+ if ($x == 6) {
+ $x--;
+ $y -= 8;
+ }
+ }
}
- if ($masked == NULL) {
+ if (($x < 0) OR ($y < 0)) {
return NULL;
}
- $this->data = $masked;
+ $this->x = $x;
+ $this->y = $y;
+ } while(ord($this->frame[$y][$x]) & 0x80);
+ return array('x'=>$x, 'y'=>$y);
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRrawcode
+
+ /**
+ * Initialize code.
+ * @param $spec (array) array of ECC specification
+ * @return 0 in case of success, -1 in case of error
+ */
+ protected function init($spec) {
+ $dl = $this->rsDataCodes1($spec);
+ $el = $this->rsEccCodes1($spec);
+ $rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
+ $blockNo = 0;
+ $dataPos = 0;
+ $eccPos = 0;
+ $endfor = $this->rsBlockNum1($spec);
+ for ($i=0; $i < $endfor; ++$i) {
+ $ecc = array_slice($this->ecccode, $eccPos);
+ $this->rsblocks[$blockNo] = array();
+ $this->rsblocks[$blockNo]['dataLength'] = $dl;
+ $this->rsblocks[$blockNo]['data'] = array_slice($this->datacode, $dataPos);
+ $this->rsblocks[$blockNo]['eccLength'] = $el;
+ $ecc = $this->encode_rs_char($rs, $this->rsblocks[$blockNo]['data'], $ecc);
+ $this->rsblocks[$blockNo]['ecc'] = $ecc;
+ $this->ecccode = array_merge(array_slice($this->ecccode,0, $eccPos), $ecc);
+ $dataPos += $dl;
+ $eccPos += $el;
+ $blockNo++;
}
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // FrameFiller
-
- /**
- * Set frame value at specified position
- * @param array $at x,y position
- * @param int $val value of the character to set
- */
- protected function setFrameAt($at, $val) {
- $this->frame[$at['y']][$at['x']] = chr($val);
- }
-
- /**
- * Get frame value at specified position
- * @param array $at x,y position
- * @return value at specified position
- */
- protected function getFrameAt($at) {
- return ord($this->frame[$at['y']][$at['x']]);
- }
-
- /**
- * Return the next frame position
- * @return array of x,y coordinates
- */
- protected function getNextPosition() {
- do {
- if ($this->bit == -1) {
- $this->bit = 0;
- return array('x'=>$this->x, 'y'=>$this->y);
- }
- $x = $this->x;
- $y = $this->y;
- $w = $this->width;
- if ($this->bit == 0) {
- $x--;
- $this->bit++;
- } else {
- $x++;
- $y += $this->dir;
- $this->bit--;
- }
- if ($this->dir < 0) {
- if ($y < 0) {
- $y = 0;
- $x -= 2;
- $this->dir = 1;
- if ($x == 6) {
- $x--;
- $y = 9;
- }
- }
- } else {
- if ($y == $w) {
- $y = $w - 1;
- $x -= 2;
- $this->dir = -1;
- if ($x == 6) {
- $x--;
- $y -= 8;
- }
- }
- }
- if (($x < 0) OR ($y < 0)) {
- return NULL;
- }
- $this->x = $x;
- $this->y = $y;
- } while(ord($this->frame[$y][$x]) & 0x80);
- return array('x'=>$x, 'y'=>$y);
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRrawcode
-
- /**
- * Initialize code.
- * @param array $spec array of ECC specification
- * @return 0 in case of success, -1 in case of error
- */
- protected function init($spec) {
- $dl = $this->rsDataCodes1($spec);
- $el = $this->rsEccCodes1($spec);
- $rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
- $blockNo = 0;
- $dataPos = 0;
- $eccPos = 0;
- $endfor = $this->rsBlockNum1($spec);
- for ($i=0; $i < $endfor; ++$i) {
- $ecc = array_slice($this->ecccode, $eccPos);
- $this->rsblocks[$blockNo] = array();
- $this->rsblocks[$blockNo]['dataLength'] = $dl;
- $this->rsblocks[$blockNo]['data'] = array_slice($this->datacode, $dataPos);
- $this->rsblocks[$blockNo]['eccLength'] = $el;
- $ecc = $this->encode_rs_char($rs, $this->rsblocks[$blockNo]['data'], $ecc);
- $this->rsblocks[$blockNo]['ecc'] = $ecc;
- $this->ecccode = array_merge(array_slice($this->ecccode,0, $eccPos), $ecc);
- $dataPos += $dl;
- $eccPos += $el;
- $blockNo++;
- }
- if ($this->rsBlockNum2($spec) == 0) {
- return 0;
- }
- $dl = $this->rsDataCodes2($spec);
- $el = $this->rsEccCodes2($spec);
- $rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
- if ($rs == NULL) {
- return -1;
- }
- $endfor = $this->rsBlockNum2($spec);
- for ($i=0; $i < $endfor; ++$i) {
- $ecc = array_slice($this->ecccode, $eccPos);
- $this->rsblocks[$blockNo] = array();
- $this->rsblocks[$blockNo]['dataLength'] = $dl;
- $this->rsblocks[$blockNo]['data'] = array_slice($this->datacode, $dataPos);
- $this->rsblocks[$blockNo]['eccLength'] = $el;
- $ecc = $this->encode_rs_char($rs, $this->rsblocks[$blockNo]['data'], $ecc);
- $this->rsblocks[$blockNo]['ecc'] = $ecc;
- $this->ecccode = array_merge(array_slice($this->ecccode, 0, $eccPos), $ecc);
- $dataPos += $dl;
- $eccPos += $el;
- $blockNo++;
- }
+ if ($this->rsBlockNum2($spec) == 0) {
return 0;
}
-
- /**
- * Return Reed-Solomon block code.
- * @return array rsblocks
- */
- protected function getCode() {
- if ($this->count < $this->dataLength) {
- $row = $this->count % $this->blocks;
- $col = $this->count / $this->blocks;
- if ($col >= $this->rsblocks[0]['dataLength']) {
- $row += $this->b1;
- }
- $ret = $this->rsblocks[$row]['data'][$col];
- } elseif ($this->count < $this->dataLength + $this->eccLength) {
- $row = ($this->count - $this->dataLength) % $this->blocks;
- $col = ($this->count - $this->dataLength) / $this->blocks;
- $ret = $this->rsblocks[$row]['ecc'][$col];
- } else {
- return 0;
- }
- $this->count++;
- return $ret;
+ $dl = $this->rsDataCodes2($spec);
+ $el = $this->rsEccCodes2($spec);
+ $rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
+ if ($rs == NULL) {
+ return -1;
}
+ $endfor = $this->rsBlockNum2($spec);
+ for ($i=0; $i < $endfor; ++$i) {
+ $ecc = array_slice($this->ecccode, $eccPos);
+ $this->rsblocks[$blockNo] = array();
+ $this->rsblocks[$blockNo]['dataLength'] = $dl;
+ $this->rsblocks[$blockNo]['data'] = array_slice($this->datacode, $dataPos);
+ $this->rsblocks[$blockNo]['eccLength'] = $el;
+ $ecc = $this->encode_rs_char($rs, $this->rsblocks[$blockNo]['data'], $ecc);
+ $this->rsblocks[$blockNo]['ecc'] = $ecc;
+ $this->ecccode = array_merge(array_slice($this->ecccode, 0, $eccPos), $ecc);
+ $dataPos += $dl;
+ $eccPos += $el;
+ $blockNo++;
+ }
+ return 0;
+ }
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRmask
-
- /**
- * Write Format Information on frame and returns the number of black bits
- * @param int $width frame width
- * @param array $frame frame
- * @param array $mask masking mode
- * @param int $level error correction level
- * @return int blacks
- */
- protected function writeFormatInformation($width, &$frame, $mask, $level) {
- $blacks = 0;
- $format = $this->getFormatInfo($mask, $level);
- for ($i=0; $i<8; ++$i) {
- if ($format & 1) {
- $blacks += 2;
- $v = 0x85;
- } else {
- $v = 0x84;
- }
- $frame[8][$width - 1 - $i] = chr($v);
- if ($i < 6) {
- $frame[$i][8] = chr($v);
- } else {
- $frame[$i + 1][8] = chr($v);
- }
- $format = $format >> 1;
+ /**
+ * Return Reed-Solomon block code.
+ * @return array rsblocks
+ */
+ protected function getCode() {
+ if ($this->count < $this->dataLength) {
+ $row = $this->count % $this->blocks;
+ $col = $this->count / $this->blocks;
+ if ($col >= $this->rsblocks[0]['dataLength']) {
+ $row += $this->b1;
}
- for ($i=0; $i<7; ++$i) {
+ $ret = $this->rsblocks[$row]['data'][$col];
+ } elseif ($this->count < $this->dataLength + $this->eccLength) {
+ $row = ($this->count - $this->dataLength) % $this->blocks;
+ $col = ($this->count - $this->dataLength) / $this->blocks;
+ $ret = $this->rsblocks[$row]['ecc'][$col];
+ } else {
+ return 0;
+ }
+ $this->count++;
+ return $ret;
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRmask
+
+ /**
+ * Write Format Information on frame and returns the number of black bits
+ * @param $width (int) frame width
+ * @param $frame (array) frame
+ * @param $mask (array) masking mode
+ * @param $level (int) error correction level
+ * @return int blacks
+ */
+ protected function writeFormatInformation($width, &$frame, $mask, $level) {
+ $blacks = 0;
+ $format = $this->getFormatInfo($mask, $level);
+ for ($i=0; $i<8; ++$i) {
if ($format & 1) {
$blacks += 2;
$v = 0x85;
} else {
$v = 0x84;
}
- $frame[$width - 7 + $i][8] = chr($v);
- if ($i == 0) {
- $frame[8][7] = chr($v);
+ $frame[8][$width - 1 - $i] = chr($v);
+ if ($i < 6) {
+ $frame[$i][8] = chr($v);
} else {
- $frame[8][6 - $i] = chr($v);
+ $frame[$i + 1][8] = chr($v);
}
$format = $format >> 1;
- }
- return $blacks;
}
-
- /**
- * mask0
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask0($x, $y) {
- return ($x + $y) & 1;
+ for ($i=0; $i<7; ++$i) {
+ if ($format & 1) {
+ $blacks += 2;
+ $v = 0x85;
+ } else {
+ $v = 0x84;
}
-
- /**
- * mask1
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask1($x, $y) {
- return ($y & 1);
+ $frame[$width - 7 + $i][8] = chr($v);
+ if ($i == 0) {
+ $frame[8][7] = chr($v);
+ } else {
+ $frame[8][6 - $i] = chr($v);
}
-
- /**
- * mask2
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask2($x, $y) {
- return ($x % 3);
+ $format = $format >> 1;
}
+ return $blacks;
+ }
- /**
- * mask3
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask3($x, $y) {
- return ($x + $y) % 3;
- }
+ /**
+ * mask0
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask0($x, $y) {
+ return ($x + $y) & 1;
+ }
- /**
- * mask4
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask4($x, $y) {
- return (((int)($y / 2)) + ((int)($x / 3))) & 1;
- }
+ /**
+ * mask1
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask1($x, $y) {
+ return ($y & 1);
+ }
- /**
- * mask5
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask5($x, $y) {
- return (($x * $y) & 1) + ($x * $y) % 3;
- }
+ /**
+ * mask2
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask2($x, $y) {
+ return ($x % 3);
+ }
- /**
- * mask6
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask6($x, $y) {
- return ((($x * $y) & 1) + ($x * $y) % 3) & 1;
- }
+ /**
+ * mask3
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask3($x, $y) {
+ return ($x + $y) % 3;
+ }
- /**
- * mask7
- * @param int $x X position
- * @param int $y Y position
- * @return int mask
- */
- protected function mask7($x, $y) {
- return ((($x * $y) % 3) + (($x + $y) & 1)) & 1;
- }
+ /**
+ * mask4
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask4($x, $y) {
+ return (((int)($y / 2)) + ((int)($x / 3))) & 1;
+ }
- /**
- * Return bitmask
- * @param int $maskNo mask number
- * @param int $width width
- * @param array $frame frame
- * @return array bitmask
- */
- protected function generateMaskNo($maskNo, $width, $frame) {
- $bitMask = array_fill(0, $width, array_fill(0, $width, 0));
- for ($y=0; $y<$width; ++$y) {
- for ($x=0; $x<$width; ++$x) {
- if (ord($frame[$y][$x]) & 0x80) {
- $bitMask[$y][$x] = 0;
- } else {
- $maskFunc = call_user_func(array($this, 'mask'.$maskNo), $x, $y);
- $bitMask[$y][$x] = ($maskFunc == 0)?1:0;
- }
+ /**
+ * mask5
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask5($x, $y) {
+ return (($x * $y) & 1) + ($x * $y) % 3;
+ }
+
+ /**
+ * mask6
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask6($x, $y) {
+ return ((($x * $y) & 1) + ($x * $y) % 3) & 1;
+ }
+
+ /**
+ * mask7
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @return int mask
+ */
+ protected function mask7($x, $y) {
+ return ((($x * $y) % 3) + (($x + $y) & 1)) & 1;
+ }
+
+ /**
+ * Return bitmask
+ * @param $maskNo (int) mask number
+ * @param $width (int) width
+ * @param $frame (array) frame
+ * @return array bitmask
+ */
+ protected function generateMaskNo($maskNo, $width, $frame) {
+ $bitMask = array_fill(0, $width, array_fill(0, $width, 0));
+ for ($y=0; $y<$width; ++$y) {
+ for ($x=0; $x<$width; ++$x) {
+ if (ord($frame[$y][$x]) & 0x80) {
+ $bitMask[$y][$x] = 0;
+ } else {
+ $maskFunc = call_user_func(array($this, 'mask'.$maskNo), $x, $y);
+ $bitMask[$y][$x] = ($maskFunc == 0)?1:0;
}
}
- return $bitMask;
}
+ return $bitMask;
+ }
- /**
- * makeMaskNo
- * @param int $maskNo
- * @param int $width
- * @param int $s
- * @param int $d
- * @param boolean $maskGenOnly
- * @return int b
- */
- protected function makeMaskNo($maskNo, $width, $s, &$d, $maskGenOnly=false) {
- $b = 0;
- $bitMask = array();
- $bitMask = $this->generateMaskNo($maskNo, $width, $s, $d);
- if ($maskGenOnly) {
- return;
- }
- $d = $s;
- for ($y=0; $y<$width; ++$y) {
- for ($x=0; $x<$width; ++$x) {
- if ($bitMask[$y][$x] == 1) {
- $d[$y][$x] = chr(ord($s[$y][$x]) ^ ((int)($bitMask[$y][$x])));
- }
- $b += (int)(ord($d[$y][$x]) & 1);
+ /**
+ * makeMaskNo
+ * @param $maskNo (int)
+ * @param $width (int)
+ * @param $s (int)
+ * @param $d (int)
+ * @param $maskGenOnly (boolean)
+ * @return int b
+ */
+ protected function makeMaskNo($maskNo, $width, $s, &$d, $maskGenOnly=false) {
+ $b = 0;
+ $bitMask = array();
+ $bitMask = $this->generateMaskNo($maskNo, $width, $s, $d);
+ if ($maskGenOnly) {
+ return;
+ }
+ $d = $s;
+ for ($y=0; $y<$width; ++$y) {
+ for ($x=0; $x<$width; ++$x) {
+ if ($bitMask[$y][$x] == 1) {
+ $d[$y][$x] = chr(ord($s[$y][$x]) ^ ((int)($bitMask[$y][$x])));
}
+ $b += (int)(ord($d[$y][$x]) & 1);
}
- return $b;
}
+ return $b;
+ }
- /**
- * makeMask
- * @param int $width
- * @param array $frame
- * @param int $maskNo
- * @param int $level
- * @return array mask
- */
- protected function makeMask($width, $frame, $maskNo, $level) {
- $masked = array_fill(0, $width, str_repeat("\0", $width));
- $this->makeMaskNo($maskNo, $width, $frame, $masked);
- $this->writeFormatInformation($width, $masked, $maskNo, $level);
- return $masked;
- }
+ /**
+ * makeMask
+ * @param $width (int)
+ * @param $frame (array)
+ * @param $maskNo (int)
+ * @param $level (int)
+ * @return array mask
+ */
+ protected function makeMask($width, $frame, $maskNo, $level) {
+ $masked = array_fill(0, $width, str_repeat("\0", $width));
+ $this->makeMaskNo($maskNo, $width, $frame, $masked);
+ $this->writeFormatInformation($width, $masked, $maskNo, $level);
+ return $masked;
+ }
- /**
- * calcN1N3
- * @param int $length
- * @return int demerit
- */
- protected function calcN1N3($length) {
- $demerit = 0;
- for ($i=0; $i<$length; ++$i) {
- if ($this->runLength[$i] >= 5) {
- $demerit += (N1 + ($this->runLength[$i] - 5));
- }
- if ($i & 1) {
- if (($i >= 3) AND ($i < ($length-2)) AND ($this->runLength[$i] % 3 == 0)) {
- $fact = (int)($this->runLength[$i] / 3);
- if (($this->runLength[$i-2] == $fact)
- AND ($this->runLength[$i-1] == $fact)
- AND ($this->runLength[$i+1] == $fact)
- AND ($this->runLength[$i+2] == $fact)) {
- if (($this->runLength[$i-3] < 0) OR ($this->runLength[$i-3] >= (4 * $fact))) {
- $demerit += N3;
- } elseif ((($i+3) >= $length) OR ($this->runLength[$i+3] >= (4 * $fact))) {
- $demerit += N3;
- }
+ /**
+ * calcN1N3
+ * @param $length (int)
+ * @return int demerit
+ */
+ protected function calcN1N3($length) {
+ $demerit = 0;
+ for ($i=0; $i<$length; ++$i) {
+ if ($this->runLength[$i] >= 5) {
+ $demerit += (N1 + ($this->runLength[$i] - 5));
+ }
+ if ($i & 1) {
+ if (($i >= 3) AND ($i < ($length-2)) AND ($this->runLength[$i] % 3 == 0)) {
+ $fact = (int)($this->runLength[$i] / 3);
+ if (($this->runLength[$i-2] == $fact)
+ AND ($this->runLength[$i-1] == $fact)
+ AND ($this->runLength[$i+1] == $fact)
+ AND ($this->runLength[$i+2] == $fact)) {
+ if (($this->runLength[$i-3] < 0) OR ($this->runLength[$i-3] >= (4 * $fact))) {
+ $demerit += N3;
+ } elseif ((($i+3) >= $length) OR ($this->runLength[$i+3] >= (4 * $fact))) {
+ $demerit += N3;
}
}
}
}
- return $demerit;
}
+ return $demerit;
+ }
- /**
- * evaluateSymbol
- * @param int $width
- * @param array $frame
- * @return int demerit
- */
- protected function evaluateSymbol($width, $frame) {
+ /**
+ * evaluateSymbol
+ * @param $width (int)
+ * @param $frame (array)
+ * @return int demerit
+ */
+ protected function evaluateSymbol($width, $frame) {
+ $head = 0;
+ $demerit = 0;
+ for ($y=0; $y<$width; ++$y) {
$head = 0;
- $demerit = 0;
- for ($y=0; $y<$width; ++$y) {
- $head = 0;
- $this->runLength[0] = 1;
- $frameY = $frame[$y];
- if ($y > 0) {
- $frameYM = $frame[$y-1];
- }
- for ($x=0; $x<$width; ++$x) {
- if (($x > 0) AND ($y > 0)) {
- $b22 = ord($frameY[$x]) & ord($frameY[$x-1]) & ord($frameYM[$x]) & ord($frameYM[$x-1]);
- $w22 = ord($frameY[$x]) | ord($frameY[$x-1]) | ord($frameYM[$x]) | ord($frameYM[$x-1]);
- if (($b22 | ($w22 ^ 1)) & 1) {
- $demerit += N2;
- }
- }
- if (($x == 0) AND (ord($frameY[$x]) & 1)) {
- $this->runLength[0] = -1;
- $head = 1;
- $this->runLength[$head] = 1;
- } elseif ($x > 0) {
- if ((ord($frameY[$x]) ^ ord($frameY[$x-1])) & 1) {
- $head++;
- $this->runLength[$head] = 1;
- } else {
- $this->runLength[$head]++;
- }
- }
- }
- $demerit += $this->calcN1N3($head+1);
+ $this->runLength[0] = 1;
+ $frameY = $frame[$y];
+ if ($y > 0) {
+ $frameYM = $frame[$y-1];
}
for ($x=0; $x<$width; ++$x) {
- $head = 0;
- $this->runLength[0] = 1;
- for ($y=0; $y<$width; ++$y) {
- if (($y == 0) AND (ord($frame[$y][$x]) & 1)) {
- $this->runLength[0] = -1;
- $head = 1;
+ if (($x > 0) AND ($y > 0)) {
+ $b22 = ord($frameY[$x]) & ord($frameY[$x-1]) & ord($frameYM[$x]) & ord($frameYM[$x-1]);
+ $w22 = ord($frameY[$x]) | ord($frameY[$x-1]) | ord($frameYM[$x]) | ord($frameYM[$x-1]);
+ if (($b22 | ($w22 ^ 1)) & 1) {
+ $demerit += N2;
+ }
+ }
+ if (($x == 0) AND (ord($frameY[$x]) & 1)) {
+ $this->runLength[0] = -1;
+ $head = 1;
+ $this->runLength[$head] = 1;
+ } elseif ($x > 0) {
+ if ((ord($frameY[$x]) ^ ord($frameY[$x-1])) & 1) {
+ $head++;
$this->runLength[$head] = 1;
- } elseif ($y > 0) {
- if ((ord($frame[$y][$x]) ^ ord($frame[$y-1][$x])) & 1) {
- $head++;
- $this->runLength[$head] = 1;
- } else {
- $this->runLength[$head]++;
- }
- }
- }
- $demerit += $this->calcN1N3($head+1);
- }
- return $demerit;
- }
-
- /**
- * mask
- * @param int $width
- * @param array $frame
- * @param int $level
- * @return array best mask
- */
- protected function mask($width, $frame, $level) {
- $minDemerit = PHP_INT_MAX;
- $bestMaskNum = 0;
- $bestMask = array();
- $checked_masks = array(0, 1, 2, 3, 4, 5, 6, 7);
- if (QR_FIND_FROM_RANDOM !== false) {
- $howManuOut = 8 - (QR_FIND_FROM_RANDOM % 9);
- for ($i = 0; $i < $howManuOut; ++$i) {
- $remPos = rand (0, count($checked_masks)-1);
- unset($checked_masks[$remPos]);
- $checked_masks = array_values($checked_masks);
- }
- }
- $bestMask = $frame;
- foreach ($checked_masks as $i) {
- $mask = array_fill(0, $width, str_repeat("\0", $width));
- $demerit = 0;
- $blacks = 0;
- $blacks = $this->makeMaskNo($i, $width, $frame, $mask);
- $blacks += $this->writeFormatInformation($width, $mask, $i, $level);
- $blacks = (int)(100 * $blacks / ($width * $width));
- $demerit = (int)((int)(abs($blacks - 50) / 5) * N4);
- $demerit += $this->evaluateSymbol($width, $mask);
- if ($demerit < $minDemerit) {
- $minDemerit = $demerit;
- $bestMask = $mask;
- $bestMaskNum = $i;
- }
- }
- return $bestMask;
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRsplit
-
- /**
- * Return true if the character at specified position is a number
- * @param string $str string
- * @param int $pos characted position
- * @return boolean true of false
- */
- protected function isdigitat($str, $pos) {
- if ($pos >= strlen($str)) {
- return false;
- }
- return ((ord($str[$pos]) >= ord('0'))&&(ord($str[$pos]) <= ord('9')));
- }
-
- /**
- * Return true if the character at specified position is an alphanumeric character
- * @param string $str string
- * @param int $pos characted position
- * @return boolean true of false
- */
- protected function isalnumat($str, $pos) {
- if ($pos >= strlen($str)) {
- return false;
- }
- return ($this->lookAnTable(ord($str[$pos])) >= 0);
- }
-
- /**
- * identifyMode
- * @param int $pos
- * @return int mode
- */
- protected function identifyMode($pos) {
- if ($pos >= strlen($this->dataStr)) {
- return QR_MODE_NL;
- }
- $c = $this->dataStr[$pos];
- if ($this->isdigitat($this->dataStr, $pos)) {
- return QR_MODE_NM;
- } elseif ($this->isalnumat($this->dataStr, $pos)) {
- return QR_MODE_AN;
- } elseif ($this->hint == QR_MODE_KJ) {
- if ($pos+1 < strlen($this->dataStr)) {
- $d = $this->dataStr[$pos+1];
- $word = (ord($c) << 8) | ord($d);
- if (($word >= 0x8140 && $word <= 0x9ffc) OR ($word >= 0xe040 && $word <= 0xebbf)) {
- return QR_MODE_KJ;
- }
- }
- }
- return QR_MODE_8B;
- }
-
- /**
- * eatNum
- * @return int run
- */
- protected function eatNum() {
- $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
- $p = 0;
- while($this->isdigitat($this->dataStr, $p)) {
- $p++;
- }
- $run = $p;
- $mode = $this->identifyMode($p);
- if ($mode == QR_MODE_8B) {
- $dif = $this->estimateBitsModeNum($run) + 4 + $ln
- + $this->estimateBitsMode8(1) // + 4 + l8
- - $this->estimateBitsMode8($run + 1); // - 4 - l8
- if ($dif > 0) {
- return $this->eat8();
- }
- }
- if ($mode == QR_MODE_AN) {
- $dif = $this->estimateBitsModeNum($run) + 4 + $ln
- + $this->estimateBitsModeAn(1) // + 4 + la
- - $this->estimateBitsModeAn($run + 1);// - 4 - la
- if ($dif > 0) {
- return $this->eatAn();
- }
- }
- $this->items = $this->appendNewInputItem($this->items, QR_MODE_NM, $run, str_split($this->dataStr));
- return $run;
- }
-
- /**
- * eatAn
- * @return int run
- */
- protected function eatAn() {
- $la = $this->lengthIndicator(QR_MODE_AN, $this->version);
- $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
- $p =1 ;
- while($this->isalnumat($this->dataStr, $p)) {
- if ($this->isdigitat($this->dataStr, $p)) {
- $q = $p;
- while($this->isdigitat($this->dataStr, $q)) {
- $q++;
- }
- $dif = $this->estimateBitsModeAn($p) // + 4 + la
- + $this->estimateBitsModeNum($q - $p) + 4 + $ln
- - $this->estimateBitsModeAn($q); // - 4 - la
- if ($dif < 0) {
- break;
} else {
- $p = $q;
+ $this->runLength[$head]++;
}
- } else {
- $p++;
}
}
- $run = $p;
- if (!$this->isalnumat($this->dataStr, $p)) {
- $dif = $this->estimateBitsModeAn($run) + 4 + $la
- + $this->estimateBitsMode8(1) // + 4 + l8
- - $this->estimateBitsMode8($run + 1); // - 4 - l8
- if ($dif > 0) {
- return $this->eat8();
- }
- }
- $this->items = $this->appendNewInputItem($this->items, QR_MODE_AN, $run, str_split($this->dataStr));
- return $run;
+ $demerit += $this->calcN1N3($head+1);
}
-
- /**
- * eatKanji
- * @return int run
- */
- protected function eatKanji() {
- $p = 0;
- while($this->identifyMode($p) == QR_MODE_KJ) {
- $p += 2;
- }
- $this->items = $this->appendNewInputItem($this->items, QR_MODE_KJ, $p, str_split($this->dataStr));
- return $run;
- }
-
- /**
- * eat8
- * @return int run
- */
- protected function eat8() {
- $la = $this->lengthIndicator(QR_MODE_AN, $this->version);
- $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
- $p = 1;
- $dataStrLen = strlen($this->dataStr);
- while($p < $dataStrLen) {
- $mode = $this->identifyMode($p);
- if ($mode == QR_MODE_KJ) {
- break;
- }
- if ($mode == QR_MODE_NM) {
- $q = $p;
- while($this->isdigitat($this->dataStr, $q)) {
- $q++;
- }
- $dif = $this->estimateBitsMode8($p) // + 4 + l8
- + $this->estimateBitsModeNum($q - $p) + 4 + $ln
- - $this->estimateBitsMode8($q); // - 4 - l8
- if ($dif < 0) {
- break;
+ for ($x=0; $x<$width; ++$x) {
+ $head = 0;
+ $this->runLength[0] = 1;
+ for ($y=0; $y<$width; ++$y) {
+ if (($y == 0) AND (ord($frame[$y][$x]) & 1)) {
+ $this->runLength[0] = -1;
+ $head = 1;
+ $this->runLength[$head] = 1;
+ } elseif ($y > 0) {
+ if ((ord($frame[$y][$x]) ^ ord($frame[$y-1][$x])) & 1) {
+ $head++;
+ $this->runLength[$head] = 1;
} else {
- $p = $q;
- }
- } elseif ($mode == QR_MODE_AN) {
- $q = $p;
- while($this->isalnumat($this->dataStr, $q)) {
- $q++;
- }
- $dif = $this->estimateBitsMode8($p) // + 4 + l8
- + $this->estimateBitsModeAn($q - $p) + 4 + $la
- - $this->estimateBitsMode8($q); // - 4 - l8
- if ($dif < 0) {
- break;
- } else {
- $p = $q;
- }
- } else {
- $p++;
- }
- }
- $run = $p;
- $this->items = $this->appendNewInputItem($this->items, QR_MODE_8B, $run, str_split($this->dataStr));
- return $run;
- }
-
- /**
- * splitString
- */
- protected function splitString() {
- while (strlen($this->dataStr) > 0) {
- if ($this->dataStr == '') {
- return 0;
- }
- $mode = $this->identifyMode(0);
- switch ($mode) {
- case QR_MODE_NM: {
- $length = $this->eatNum();
- break;
- }
- case QR_MODE_AN: {
- $length = $this->eatAn();
- break;
- }
- case QR_MODE_KJ: {
- if ($hint == QR_MODE_KJ) {
- $length = $this->eatKanji();
- } else {
- $length = $this->eat8();
- }
- break;
- }
- default: {
- $length = $this->eat8();
- break;
- }
- }
- if ($length == 0) {
- return 0;
- }
- if ($length < 0) {
- return -1;
- }
- $this->dataStr = substr($this->dataStr, $length);
- }
- }
-
- /**
- * toUpper
- */
- protected function toUpper() {
- $stringLen = strlen($this->dataStr);
- $p = 0;
- while ($p < $stringLen) {
- $mode = $this->identifyMode(substr($this->dataStr, $p), $this->hint);
- if ($mode == QR_MODE_KJ) {
- $p += 2;
- } else {
- if ((ord($this->dataStr[$p]) >= ord('a')) AND (ord($this->dataStr[$p]) <= ord('z'))) {
- $this->dataStr[$p] = chr(ord($this->dataStr[$p]) - 32);
- }
- $p++;
- }
- }
- return $this->dataStr;
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRinputItem
-
- /**
- * newInputItem
- * @param int $mode
- * @param int $size
- * @param array $data
- * @param array $bstream
- * @return array input item
- */
- protected function newInputItem($mode, $size, $data, $bstream=null) {
- $setData = array_slice($data, 0, $size);
- if (count($setData) < $size) {
- $setData = array_merge($setData, array_fill(0, ($size - count($setData)), 0));
- }
- if (!$this->check($mode, $size, $setData)) {
- return NULL;
- }
- $inputitem = array();
- $inputitem['mode'] = $mode;
- $inputitem['size'] = $size;
- $inputitem['data'] = $setData;
- $inputitem['bstream'] = $bstream;
- return $inputitem;
- }
-
- /**
- * encodeModeNum
- * @param array $inputitem
- * @param int $version
- * @return array input item
- */
- protected function encodeModeNum($inputitem, $version) {
- $words = (int)($inputitem['size'] / 3);
- $inputitem['bstream'] = array();
- $val = 0x1;
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_NM, $version), $inputitem['size']);
- for ($i=0; $i < $words; ++$i) {
- $val = (ord($inputitem['data'][$i*3 ]) - ord('0')) * 100;
- $val += (ord($inputitem['data'][$i*3+1]) - ord('0')) * 10;
- $val += (ord($inputitem['data'][$i*3+2]) - ord('0'));
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 10, $val);
- }
- if ($inputitem['size'] - $words * 3 == 1) {
- $val = ord($inputitem['data'][$words*3]) - ord('0');
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
- } elseif (($inputitem['size'] - ($words * 3)) == 2) {
- $val = (ord($inputitem['data'][$words*3 ]) - ord('0')) * 10;
- $val += (ord($inputitem['data'][$words*3+1]) - ord('0'));
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 7, $val);
- }
- return $inputitem;
- }
-
- /**
- * encodeModeAn
- * @param array $inputitem
- * @param int $version
- * @return array input item
- */
- protected function encodeModeAn($inputitem, $version) {
- $words = (int)($inputitem['size'] / 2);
- $inputitem['bstream'] = array();
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x02);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_AN, $version), $inputitem['size']);
- for ($i=0; $i < $words; ++$i) {
- $val = (int)($this->lookAnTable(ord($inputitem['data'][$i*2])) * 45);
- $val += (int)($this->lookAnTable(ord($inputitem['data'][($i*2)+1])));
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 11, $val);
- }
- if ($inputitem['size'] & 1) {
- $val = $this->lookAnTable(ord($inputitem['data'][($words * 2)]));
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 6, $val);
- }
- return $inputitem;
- }
-
- /**
- * encodeMode8
- * @param array $inputitem
- * @param int $version
- * @return array input item
- */
- protected function encodeMode8($inputitem, $version) {
- $inputitem['bstream'] = array();
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x4);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_8B, $version), $inputitem['size']);
- for ($i=0; $i < $inputitem['size']; ++$i) {
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][$i]));
- }
- return $inputitem;
- }
-
- /**
- * encodeModeKanji
- * @param array $inputitem
- * @param int $version
- * @return array input item
- */
- protected function encodeModeKanji($inputitem, $version) {
- $inputitem['bstream'] = array();
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x8);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_KJ, $version), (int)($inputitem['size'] / 2));
- for ($i=0; $i<$inputitem['size']; $i+=2) {
- $val = (ord($inputitem['data'][$i]) << 8) | ord($inputitem['data'][$i+1]);
- if ($val <= 0x9ffc) {
- $val -= 0x8140;
- } else {
- $val -= 0xc140;
- }
- $h = ($val >> 8) * 0xc0;
- $val = ($val & 0xff) + $h;
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 13, $val);
- }
- return $inputitem;
- }
-
- /**
- * encodeModeStructure
- * @param array $inputitem
- * @return array input item
- */
- protected function encodeModeStructure($inputitem) {
- $inputitem['bstream'] = array();
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x03);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][1]) - 1);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][0]) - 1);
- $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][2]));
- return $inputitem;
- }
-
- /**
- * encodeBitStream
- * @param array $inputitem
- * @param int $version
- * @return array input item
- */
- protected function encodeBitStream($inputitem, $version) {
- $inputitem['bstream'] = array();
- $words = $this->maximumWords($inputitem['mode'], $version);
- if ($inputitem['size'] > $words) {
- $st1 = $this->newInputItem($inputitem['mode'], $words, $inputitem['data']);
- $st2 = $this->newInputItem($inputitem['mode'], $inputitem['size'] - $words, array_slice($inputitem['data'], $words));
- $st1 = $this->encodeBitStream($st1, $version);
- $st2 = $this->encodeBitStream($st2, $version);
- $inputitem['bstream'] = array();
- $inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st1['bstream']);
- $inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st2['bstream']);
- } else {
- switch($inputitem['mode']) {
- case QR_MODE_NM: {
- $inputitem = $this->encodeModeNum($inputitem, $version);
- break;
- }
- case QR_MODE_AN: {
- $inputitem = $this->encodeModeAn($inputitem, $version);
- break;
- }
- case QR_MODE_8B: {
- $inputitem = $this->encodeMode8($inputitem, $version);
- break;
- }
- case QR_MODE_KJ: {
- $inputitem = $this->encodeModeKanji($inputitem, $version);
- break;
- }
- case QR_MODE_ST: {
- $inputitem = $this->encodeModeStructure($inputitem);
- break;
- }
- default: {
- break;
+ $this->runLength[$head]++;
}
}
}
- return $inputitem;
+ $demerit += $this->calcN1N3($head+1);
}
+ return $demerit;
+ }
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRinput
-
- /**
- * Append data to an input object.
- * The data is copied and appended to the input object.
- * @param array items input items
- * @param int $mode encoding mode.
- * @param int $size size of data (byte).
- * @param array $data array of input data.
- * @return items
- *
- */
- protected function appendNewInputItem($items, $mode, $size, $data) {
- $newitem = $this->newInputItem($mode, $size, $data);
- if (!empty($newitem)) {
- $items[] = $newitem;
+ /**
+ * mask
+ * @param $width (int)
+ * @param $frame (array)
+ * @param $level (int)
+ * @return array best mask
+ */
+ protected function mask($width, $frame, $level) {
+ $minDemerit = PHP_INT_MAX;
+ $bestMaskNum = 0;
+ $bestMask = array();
+ $checked_masks = array(0, 1, 2, 3, 4, 5, 6, 7);
+ if (QR_FIND_FROM_RANDOM !== false) {
+ $howManuOut = 8 - (QR_FIND_FROM_RANDOM % 9);
+ for ($i = 0; $i < $howManuOut; ++$i) {
+ $remPos = rand (0, count($checked_masks)-1);
+ unset($checked_masks[$remPos]);
+ $checked_masks = array_values($checked_masks);
}
- return $items;
}
-
- /**
- * insertStructuredAppendHeader
- * @param array $items
- * @param int $size
- * @param int $index
- * @param int $parity
- * @return array items
- */
- protected function insertStructuredAppendHeader($items, $size, $index, $parity) {
- if ($size > MAX_STRUCTURED_SYMBOLS) {
- return -1;
+ $bestMask = $frame;
+ foreach ($checked_masks as $i) {
+ $mask = array_fill(0, $width, str_repeat("\0", $width));
+ $demerit = 0;
+ $blacks = 0;
+ $blacks = $this->makeMaskNo($i, $width, $frame, $mask);
+ $blacks += $this->writeFormatInformation($width, $mask, $i, $level);
+ $blacks = (int)(100 * $blacks / ($width * $width));
+ $demerit = (int)((int)(abs($blacks - 50) / 5) * N4);
+ $demerit += $this->evaluateSymbol($width, $mask);
+ if ($demerit < $minDemerit) {
+ $minDemerit = $demerit;
+ $bestMask = $mask;
+ $bestMaskNum = $i;
}
- if (($index <= 0) OR ($index > MAX_STRUCTURED_SYMBOLS)) {
- return -1;
- }
- $buf = array($size, $index, $parity);
- $entry = $this->newInputItem(QR_MODE_ST, 3, buf);
- array_unshift($items, $entry);
- return $items;
}
+ return $bestMask;
+ }
- /**
- * calcParity
- * @param array $items
- * @return int parity
- */
- protected function calcParity($items) {
- $parity = 0;
- foreach ($items as $item) {
- if ($item['mode'] != QR_MODE_ST) {
- for ($i=$item['size']-1; $i>=0; --$i) {
- $parity ^= $item['data'][$i];
- }
- }
- }
- return $parity;
- }
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
- /**
- * checkModeNum
- * @param int $size
- * @param array $data
- * @return boolean true or false
- */
- protected function checkModeNum($size, $data) {
- for ($i=0; $i<$size; ++$i) {
- if ((ord($data[$i]) < ord('0')) OR (ord($data[$i]) > ord('9'))){
- return false;
- }
- }
- return true;
- }
+ // QRsplit
- /**
- * Look up the alphabet-numeric convesion table (see JIS X0510:2004, pp.19).
- * @param int $c character value
- * @return value
- */
- protected function lookAnTable($c) {
- return (($c > 127)?-1:$this->anTable[$c]);
- }
-
- /**
- * checkModeAn
- * @param int $size
- * @param array $data
- * @return boolean true or false
- */
- protected function checkModeAn($size, $data) {
- for ($i=0; $i<$size; ++$i) {
- if ($this->lookAnTable(ord($data[$i])) == -1) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * estimateBitsModeNum
- * @param int $size
- * @return int number of bits
- */
- protected function estimateBitsModeNum($size) {
- $w = (int)($size / 3);
- $bits = ($w * 10);
- switch($size - ($w * 3)) {
- case 1: {
- $bits += 4;
- break;
- }
- case 2: {
- $bits += 7;
- break;
- }
- }
- return $bits;
- }
-
- /**
- * estimateBitsModeAn
- * @param int $size
- * @return int number of bits
- */
- protected function estimateBitsModeAn($size) {
- $bits = (int)($size * 5.5); // (size / 2 ) * 11
- if ($size & 1) {
- $bits += 6;
- }
- return $bits;
- }
-
- /**
- * estimateBitsMode8
- * @param int $size
- * @return int number of bits
- */
- protected function estimateBitsMode8($size) {
- return (int)($size * 8);
- }
-
- /**
- * estimateBitsModeKanji
- * @param int $size
- * @return int number of bits
- */
- protected function estimateBitsModeKanji($size) {
- return (int)($size * 6.5); // (size / 2 ) * 13
- }
-
- /**
- * checkModeKanji
- * @param int $size
- * @param array $data
- * @return boolean true or false
- */
- protected function checkModeKanji($size, $data) {
- if ($size & 1) {
- return false;
- }
- for ($i=0; $i<$size; $i+=2) {
- $val = (ord($data[$i]) << 8) | ord($data[$i+1]);
- if (($val < 0x8140) OR (($val > 0x9ffc) AND ($val < 0xe040)) OR ($val > 0xebbf)) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * Validate the input data.
- * @param int $mode encoding mode.
- * @param int $size size of data (byte).
- * @param array data data to validate
- * @return boolean true in case of valid data, false otherwise
- */
- protected function check($mode, $size, $data) {
- if ($size <= 0) {
- return false;
- }
- switch($mode) {
- case QR_MODE_NM: {
- return $this->checkModeNum($size, $data);
- }
- case QR_MODE_AN: {
- return $this->checkModeAn($size, $data);
- }
- case QR_MODE_KJ: {
- return $this->checkModeKanji($size, $data);
- }
- case QR_MODE_8B: {
- return true;
- }
- case QR_MODE_ST: {
- return true;
- }
- default: {
- break;
- }
- }
+ /**
+ * Return true if the character at specified position is a number
+ * @param $str (string) string
+ * @param $pos (int) characted position
+ * @return boolean true of false
+ */
+ protected function isdigitat($str, $pos) {
+ if ($pos >= strlen($str)) {
return false;
}
+ return ((ord($str[$pos]) >= ord('0'))&&(ord($str[$pos]) <= ord('9')));
+ }
- /**
- * estimateBitStreamSize
- * @param array $items
- * @param int $version
- * @return int bits
- */
- protected function estimateBitStreamSize($items, $version) {
- $bits = 0;
- if ($version == 0) {
- $version = 1;
- }
- foreach ($items as $item) {
- switch($item['mode']) {
- case QR_MODE_NM: {
- $bits = $this->estimateBitsModeNum($item['size']);
- break;
- }
- case QR_MODE_AN: {
- $bits = $this->estimateBitsModeAn($item['size']);
- break;
- }
- case QR_MODE_8B: {
- $bits = $this->estimateBitsMode8($item['size']);
- break;
- }
- case QR_MODE_KJ: {
- $bits = $this->estimateBitsModeKanji($item['size']);
- break;
- }
- case QR_MODE_ST: {
- return STRUCTURE_HEADER_BITS;
- }
- default: {
- return 0;
- }
- }
- $l = $this->lengthIndicator($item['mode'], $version);
- $m = 1 << $l;
- $num = (int)(($item['size'] + $m - 1) / $m);
- $bits += $num * (4 + $l);
- }
- return $bits;
+ /**
+ * Return true if the character at specified position is an alphanumeric character
+ * @param $str (string) string
+ * @param $pos (int) characted position
+ * @return boolean true of false
+ */
+ protected function isalnumat($str, $pos) {
+ if ($pos >= strlen($str)) {
+ return false;
}
+ return ($this->lookAnTable(ord($str[$pos])) >= 0);
+ }
- /**
- * estimateVersion
- * @param array $items
- * @return int version
- */
- protected function estimateVersion($items) {
- $version = 0;
- $prev = 0;
- do {
- $prev = $version;
- $bits = $this->estimateBitStreamSize($items, $prev);
- $version = $this->getMinimumVersion((int)(($bits + 7) / 8), $this->level);
- if ($version < 0) {
- return -1;
- }
- } while ($version > $prev);
- return $version;
+ /**
+ * identifyMode
+ * @param $pos (int)
+ * @return int mode
+ */
+ protected function identifyMode($pos) {
+ if ($pos >= strlen($this->dataStr)) {
+ return QR_MODE_NL;
}
+ $c = $this->dataStr[$pos];
+ if ($this->isdigitat($this->dataStr, $pos)) {
+ return QR_MODE_NM;
+ } elseif ($this->isalnumat($this->dataStr, $pos)) {
+ return QR_MODE_AN;
+ } elseif ($this->hint == QR_MODE_KJ) {
+ if ($pos+1 < strlen($this->dataStr)) {
+ $d = $this->dataStr[$pos+1];
+ $word = (ord($c) << 8) | ord($d);
+ if (($word >= 0x8140 && $word <= 0x9ffc) OR ($word >= 0xe040 && $word <= 0xebbf)) {
+ return QR_MODE_KJ;
+ }
+ }
+ }
+ return QR_MODE_8B;
+ }
- /**
- * lengthOfCode
- * @param int $mode
- * @param int $version
- * @param int $bits
- * @return int size
- */
- protected function lengthOfCode($mode, $version, $bits) {
- $payload = $bits - 4 - $this->lengthIndicator($mode, $version);
- switch($mode) {
+ /**
+ * eatNum
+ * @return int run
+ */
+ protected function eatNum() {
+ $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
+ $p = 0;
+ while($this->isdigitat($this->dataStr, $p)) {
+ $p++;
+ }
+ $run = $p;
+ $mode = $this->identifyMode($p);
+ if ($mode == QR_MODE_8B) {
+ $dif = $this->estimateBitsModeNum($run) + 4 + $ln
+ + $this->estimateBitsMode8(1) // + 4 + l8
+ - $this->estimateBitsMode8($run + 1); // - 4 - l8
+ if ($dif > 0) {
+ return $this->eat8();
+ }
+ }
+ if ($mode == QR_MODE_AN) {
+ $dif = $this->estimateBitsModeNum($run) + 4 + $ln
+ + $this->estimateBitsModeAn(1) // + 4 + la
+ - $this->estimateBitsModeAn($run + 1);// - 4 - la
+ if ($dif > 0) {
+ return $this->eatAn();
+ }
+ }
+ $this->items = $this->appendNewInputItem($this->items, QR_MODE_NM, $run, str_split($this->dataStr));
+ return $run;
+ }
+
+ /**
+ * eatAn
+ * @return int run
+ */
+ protected function eatAn() {
+ $la = $this->lengthIndicator(QR_MODE_AN, $this->version);
+ $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
+ $p =1 ;
+ while($this->isalnumat($this->dataStr, $p)) {
+ if ($this->isdigitat($this->dataStr, $p)) {
+ $q = $p;
+ while($this->isdigitat($this->dataStr, $q)) {
+ $q++;
+ }
+ $dif = $this->estimateBitsModeAn($p) // + 4 + la
+ + $this->estimateBitsModeNum($q - $p) + 4 + $ln
+ - $this->estimateBitsModeAn($q); // - 4 - la
+ if ($dif < 0) {
+ break;
+ } else {
+ $p = $q;
+ }
+ } else {
+ $p++;
+ }
+ }
+ $run = $p;
+ if (!$this->isalnumat($this->dataStr, $p)) {
+ $dif = $this->estimateBitsModeAn($run) + 4 + $la
+ + $this->estimateBitsMode8(1) // + 4 + l8
+ - $this->estimateBitsMode8($run + 1); // - 4 - l8
+ if ($dif > 0) {
+ return $this->eat8();
+ }
+ }
+ $this->items = $this->appendNewInputItem($this->items, QR_MODE_AN, $run, str_split($this->dataStr));
+ return $run;
+ }
+
+ /**
+ * eatKanji
+ * @return int run
+ */
+ protected function eatKanji() {
+ $p = 0;
+ while($this->identifyMode($p) == QR_MODE_KJ) {
+ $p += 2;
+ }
+ $this->items = $this->appendNewInputItem($this->items, QR_MODE_KJ, $p, str_split($this->dataStr));
+ return $run;
+ }
+
+ /**
+ * eat8
+ * @return int run
+ */
+ protected function eat8() {
+ $la = $this->lengthIndicator(QR_MODE_AN, $this->version);
+ $ln = $this->lengthIndicator(QR_MODE_NM, $this->version);
+ $p = 1;
+ $dataStrLen = strlen($this->dataStr);
+ while($p < $dataStrLen) {
+ $mode = $this->identifyMode($p);
+ if ($mode == QR_MODE_KJ) {
+ break;
+ }
+ if ($mode == QR_MODE_NM) {
+ $q = $p;
+ while($this->isdigitat($this->dataStr, $q)) {
+ $q++;
+ }
+ $dif = $this->estimateBitsMode8($p) // + 4 + l8
+ + $this->estimateBitsModeNum($q - $p) + 4 + $ln
+ - $this->estimateBitsMode8($q); // - 4 - l8
+ if ($dif < 0) {
+ break;
+ } else {
+ $p = $q;
+ }
+ } elseif ($mode == QR_MODE_AN) {
+ $q = $p;
+ while($this->isalnumat($this->dataStr, $q)) {
+ $q++;
+ }
+ $dif = $this->estimateBitsMode8($p) // + 4 + l8
+ + $this->estimateBitsModeAn($q - $p) + 4 + $la
+ - $this->estimateBitsMode8($q); // - 4 - l8
+ if ($dif < 0) {
+ break;
+ } else {
+ $p = $q;
+ }
+ } else {
+ $p++;
+ }
+ }
+ $run = $p;
+ $this->items = $this->appendNewInputItem($this->items, QR_MODE_8B, $run, str_split($this->dataStr));
+ return $run;
+ }
+
+ /**
+ * splitString
+ */
+ protected function splitString() {
+ while (strlen($this->dataStr) > 0) {
+ if ($this->dataStr == '') {
+ return 0;
+ }
+ $mode = $this->identifyMode(0);
+ switch ($mode) {
case QR_MODE_NM: {
- $chunks = (int)($payload / 10);
- $remain = $payload - $chunks * 10;
- $size = $chunks * 3;
- if ($remain >= 7) {
- $size += 2;
- } elseif ($remain >= 4) {
- $size += 1;
- }
+ $length = $this->eatNum();
break;
}
case QR_MODE_AN: {
- $chunks = (int)($payload / 11);
- $remain = $payload - $chunks * 11;
- $size = $chunks * 2;
- if ($remain >= 6) {
- ++$size;
- }
- break;
- }
- case QR_MODE_8B: {
- $size = (int)($payload / 8);
+ $length = $this->eatAn();
break;
}
case QR_MODE_KJ: {
- $size = (int)(($payload / 13) * 2);
- break;
- }
- case QR_MODE_ST: {
- $size = (int)($payload / 8);
+ if ($hint == QR_MODE_KJ) {
+ $length = $this->eatKanji();
+ } else {
+ $length = $this->eat8();
+ }
break;
}
default: {
- $size = 0;
+ $length = $this->eat8();
break;
}
}
- $maxsize = $this->maximumWords($mode, $version);
- if ($size < 0) {
- $size = 0;
+ if ($length == 0) {
+ return 0;
}
- if ($size > $maxsize) {
- $size = $maxsize;
+ if ($length < 0) {
+ return -1;
}
- return $size;
+ $this->dataStr = substr($this->dataStr, $length);
}
+ }
- /**
- * createBitStream
- * @param array $items
- * @return array of items and total bits
- */
- protected function createBitStream($items) {
- $total = 0;
- foreach ($items as $key => $item) {
- $items[$key] = $this->encodeBitStream($item, $this->version);
- $bits = count($items[$key]['bstream']);
- $total += $bits;
- }
- return array($items, $total);
- }
-
- /**
- * convertData
- * @param array $items
- * @return array items
- */
- protected function convertData($items) {
- $ver = $this->estimateVersion($items);
- if ($ver > $this->version) {
- $this->version = $ver;
- }
- for (;;) {
- $cbs = $this->createBitStream($items);
- $items = $cbs[0];
- $bits = $cbs[1];
- if ($bits < 0) {
- return -1;
+ /**
+ * toUpper
+ */
+ protected function toUpper() {
+ $stringLen = strlen($this->dataStr);
+ $p = 0;
+ while ($p < $stringLen) {
+ $mode = $this->identifyMode(substr($this->dataStr, $p), $this->hint);
+ if ($mode == QR_MODE_KJ) {
+ $p += 2;
+ } else {
+ if ((ord($this->dataStr[$p]) >= ord('a')) AND (ord($this->dataStr[$p]) <= ord('z'))) {
+ $this->dataStr[$p] = chr(ord($this->dataStr[$p]) - 32);
}
- $ver = $this->getMinimumVersion((int)(($bits + 7) / 8), $this->level);
- if ($ver < 0) {
- return -1;
- } elseif ($ver > $this->version) {
- $this->version = $ver;
- } else {
+ $p++;
+ }
+ }
+ return $this->dataStr;
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRinputItem
+
+ /**
+ * newInputItem
+ * @param $mode (int)
+ * @param $size (int)
+ * @param $data (array)
+ * @param $bstream (array)
+ * @return array input item
+ */
+ protected function newInputItem($mode, $size, $data, $bstream=null) {
+ $setData = array_slice($data, 0, $size);
+ if (count($setData) < $size) {
+ $setData = array_merge($setData, array_fill(0, ($size - count($setData)), 0));
+ }
+ if (!$this->check($mode, $size, $setData)) {
+ return NULL;
+ }
+ $inputitem = array();
+ $inputitem['mode'] = $mode;
+ $inputitem['size'] = $size;
+ $inputitem['data'] = $setData;
+ $inputitem['bstream'] = $bstream;
+ return $inputitem;
+ }
+
+ /**
+ * encodeModeNum
+ * @param $inputitem (array)
+ * @param $version (int)
+ * @return array input item
+ */
+ protected function encodeModeNum($inputitem, $version) {
+ $words = (int)($inputitem['size'] / 3);
+ $inputitem['bstream'] = array();
+ $val = 0x1;
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_NM, $version), $inputitem['size']);
+ for ($i=0; $i < $words; ++$i) {
+ $val = (ord($inputitem['data'][$i*3 ]) - ord('0')) * 100;
+ $val += (ord($inputitem['data'][$i*3+1]) - ord('0')) * 10;
+ $val += (ord($inputitem['data'][$i*3+2]) - ord('0'));
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 10, $val);
+ }
+ if ($inputitem['size'] - $words * 3 == 1) {
+ $val = ord($inputitem['data'][$words*3]) - ord('0');
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
+ } elseif (($inputitem['size'] - ($words * 3)) == 2) {
+ $val = (ord($inputitem['data'][$words*3 ]) - ord('0')) * 10;
+ $val += (ord($inputitem['data'][$words*3+1]) - ord('0'));
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 7, $val);
+ }
+ return $inputitem;
+ }
+
+ /**
+ * encodeModeAn
+ * @param $inputitem (array)
+ * @param $version (int)
+ * @return array input item
+ */
+ protected function encodeModeAn($inputitem, $version) {
+ $words = (int)($inputitem['size'] / 2);
+ $inputitem['bstream'] = array();
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x02);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_AN, $version), $inputitem['size']);
+ for ($i=0; $i < $words; ++$i) {
+ $val = (int)($this->lookAnTable(ord($inputitem['data'][$i*2])) * 45);
+ $val += (int)($this->lookAnTable(ord($inputitem['data'][($i*2)+1])));
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 11, $val);
+ }
+ if ($inputitem['size'] & 1) {
+ $val = $this->lookAnTable(ord($inputitem['data'][($words * 2)]));
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 6, $val);
+ }
+ return $inputitem;
+ }
+
+ /**
+ * encodeMode8
+ * @param $inputitem (array)
+ * @param $version (int)
+ * @return array input item
+ */
+ protected function encodeMode8($inputitem, $version) {
+ $inputitem['bstream'] = array();
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x4);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_8B, $version), $inputitem['size']);
+ for ($i=0; $i < $inputitem['size']; ++$i) {
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][$i]));
+ }
+ return $inputitem;
+ }
+
+ /**
+ * encodeModeKanji
+ * @param $inputitem (array)
+ * @param $version (int)
+ * @return array input item
+ */
+ protected function encodeModeKanji($inputitem, $version) {
+ $inputitem['bstream'] = array();
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x8);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], $this->lengthIndicator(QR_MODE_KJ, $version), (int)($inputitem['size'] / 2));
+ for ($i=0; $i<$inputitem['size']; $i+=2) {
+ $val = (ord($inputitem['data'][$i]) << 8) | ord($inputitem['data'][$i+1]);
+ if ($val <= 0x9ffc) {
+ $val -= 0x8140;
+ } else {
+ $val -= 0xc140;
+ }
+ $h = ($val >> 8) * 0xc0;
+ $val = ($val & 0xff) + $h;
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 13, $val);
+ }
+ return $inputitem;
+ }
+
+ /**
+ * encodeModeStructure
+ * @param $inputitem (array)
+ * @return array input item
+ */
+ protected function encodeModeStructure($inputitem) {
+ $inputitem['bstream'] = array();
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x03);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][1]) - 1);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][0]) - 1);
+ $inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][2]));
+ return $inputitem;
+ }
+
+ /**
+ * encodeBitStream
+ * @param $inputitem (array)
+ * @param $version (int)
+ * @return array input item
+ */
+ protected function encodeBitStream($inputitem, $version) {
+ $inputitem['bstream'] = array();
+ $words = $this->maximumWords($inputitem['mode'], $version);
+ if ($inputitem['size'] > $words) {
+ $st1 = $this->newInputItem($inputitem['mode'], $words, $inputitem['data']);
+ $st2 = $this->newInputItem($inputitem['mode'], $inputitem['size'] - $words, array_slice($inputitem['data'], $words));
+ $st1 = $this->encodeBitStream($st1, $version);
+ $st2 = $this->encodeBitStream($st2, $version);
+ $inputitem['bstream'] = array();
+ $inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st1['bstream']);
+ $inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st2['bstream']);
+ } else {
+ switch($inputitem['mode']) {
+ case QR_MODE_NM: {
+ $inputitem = $this->encodeModeNum($inputitem, $version);
+ break;
+ }
+ case QR_MODE_AN: {
+ $inputitem = $this->encodeModeAn($inputitem, $version);
+ break;
+ }
+ case QR_MODE_8B: {
+ $inputitem = $this->encodeMode8($inputitem, $version);
+ break;
+ }
+ case QR_MODE_KJ: {
+ $inputitem = $this->encodeModeKanji($inputitem, $version);
+ break;
+ }
+ case QR_MODE_ST: {
+ $inputitem = $this->encodeModeStructure($inputitem);
+ break;
+ }
+ default: {
break;
}
}
- return $items;
}
+ return $inputitem;
+ }
- /**
- * Append Padding Bit to bitstream
- * @param array $bstream
- * @return array bitstream
- */
- protected function appendPaddingBit($bstream) {
- if (is_null($bstream)) {
- return null;
- }
- $bits = count($bstream);
- $maxwords = $this->getDataLength($this->version, $this->level);
- $maxbits = $maxwords * 8;
- if ($maxbits == $bits) {
- return $bstream;
- }
- if ($maxbits - $bits < 5) {
- return $this->appendNum($bstream, $maxbits - $bits, 0);
- }
- $bits += 4;
- $words = (int)(($bits + 7) / 8);
- $padding = array();
- $padding = $this->appendNum($padding, $words * 8 - $bits + 4, 0);
- $padlen = $maxwords - $words;
- if ($padlen > 0) {
- $padbuf = array();
- for ($i=0; $i<$padlen; ++$i) {
- $padbuf[$i] = ($i&1)?0x11:0xec;
- }
- $padding = $this->appendBytes($padding, $padlen, $padbuf);
- }
- return $this->appendBitstream($bstream, $padding);
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRinput
+
+ /**
+ * Append data to an input object.
+ * The data is copied and appended to the input object.
+ * @param $items (arrray) input items
+ * @param $mode (int) encoding mode.
+ * @param $size (int) size of data (byte).
+ * @param $data (array) array of input data.
+ * @return items
+ *
+ */
+ protected function appendNewInputItem($items, $mode, $size, $data) {
+ $newitem = $this->newInputItem($mode, $size, $data);
+ if (!empty($newitem)) {
+ $items[] = $newitem;
}
+ return $items;
+ }
- /**
- * mergeBitStream
- * @param array $bstream
- * @return array bitstream
- */
- protected function mergeBitStream($items) {
- $items = $this->convertData($items);
- if (!is_array($items)) {
- return null;
- }
- $bstream = array();
- foreach ($items as $item) {
- $bstream = $this->appendBitstream($bstream, $item['bstream']);
- }
- return $bstream;
- }
-
- /**
- * Returns a stream of bits.
- * @param int $items
- * @return array padded merged byte stream
- */
- protected function getBitStream($items) {
- $bstream = $this->mergeBitStream($items);
- return $this->appendPaddingBit($bstream);
- }
-
- /**
- * Pack all bit streams padding bits into a byte array.
- * @param int $items
- * @return array padded merged byte stream
- */
- protected function getByteStream($items) {
- $bstream = $this->getBitStream($items);
- return $this->bitstreamToByte($bstream);
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRbitstream
-
- /**
- * Return an array with zeros
- * @param int $setLength array size
- * @return array
- */
- protected function allocate($setLength) {
- return array_fill(0, $setLength, 0);
- }
-
- /**
- * Return new bitstream from number
- * @param int $bits number of bits
- * @param int $num number
- * @return array bitstream
- */
- protected function newFromNum($bits, $num) {
- $bstream = $this->allocate($bits);
- $mask = 1 << ($bits - 1);
- for ($i=0; $i<$bits; ++$i) {
- if ($num & $mask) {
- $bstream[$i] = 1;
- } else {
- $bstream[$i] = 0;
- }
- $mask = $mask >> 1;
- }
- return $bstream;
- }
-
- /**
- * Return new bitstream from bytes
- * @param int $size size
- * @param array $data bytes
- * @return array bitstream
- */
- protected function newFromBytes($size, $data) {
- $bstream = $this->allocate($size * 8);
- $p=0;
- for ($i=0; $i<$size; ++$i) {
- $mask = 0x80;
- for ($j=0; $j<8; ++$j) {
- if ($data[$i] & $mask) {
- $bstream[$p] = 1;
- } else {
- $bstream[$p] = 0;
- }
- $p++;
- $mask = $mask >> 1;
- }
- }
- return $bstream;
- }
-
- /**
- * Append one bitstream to another
- * @param array $bitstream original bitstream
- * @param array $append bitstream to append
- * @return array bitstream
- */
- protected function appendBitstream($bitstream, $append) {
- if ((!is_array($append)) OR (count($append) == 0)) {
- return $bitstream;
- }
- if (count($bitstream) == 0) {
- return $append;
- }
- return array_values(array_merge($bitstream, $append));
- }
-
- /**
- * Append one bitstream created from number to another
- * @param array $bitstream original bitstream
- * @param int $bits number of bits
- * @param int $num number
- * @return array bitstream
- */
- protected function appendNum($bitstream, $bits, $num) {
- if ($bits == 0) {
- return 0;
- }
- $b = $this->newFromNum($bits, $num);
- return $this->appendBitstream($bitstream, $b);
- }
-
- /**
- * Append one bitstream created from bytes to another
- * @param array $bitstream original bitstream
- * @param int $size size
- * @param array $data bytes
- * @return array bitstream
- */
- protected function appendBytes($bitstream, $size, $data) {
- if ($size == 0) {
- return 0;
- }
- $b = $this->newFromBytes($size, $data);
- return $this->appendBitstream($bitstream, $b);
- }
-
- /**
- * Convert bitstream to bytes
- * @param array $bitstream original bitstream
- * @return array of bytes
- */
- protected function bitstreamToByte($bstream) {
- if (is_null($bstream)) {
- return null;
- }
- $size = count($bstream);
- if ($size == 0) {
- return array();
- }
- $data = array_fill(0, (int)(($size + 7) / 8), 0);
- $bytes = (int)($size / 8);
- $p = 0;
- for ($i=0; $i<$bytes; $i++) {
- $v = 0;
- for ($j=0; $j<8; $j++) {
- $v = $v << 1;
- $v |= $bstream[$p];
- $p++;
- }
- $data[$i] = $v;
- }
- if ($size & 7) {
- $v = 0;
- for ($j=0; $j<($size & 7); $j++) {
- $v = $v << 1;
- $v |= $bstream[$p];
- $p++;
- }
- $data[$bytes] = $v;
- }
- return $data;
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRspec
-
- /**
- * Replace a value on the array at the specified position
- * @param array $srctab
- * @param int $x X position
- * @param int $y Y position
- * @param string $repl value to replace
- * @param int $replLen length of the repl string
- * @return array srctab
- */
- protected function qrstrset($srctab, $x, $y, $repl, $replLen=false) {
- $srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));
- return $srctab;
- }
-
- /**
- * Return maximum data code length (bytes) for the version.
- * @param int $version version
- * @param int $level error correction level
- * @return int maximum size (bytes)
- */
- protected function getDataLength($version, $level) {
- return $this->capacity[$version][QRCAP_WORDS] - $this->capacity[$version][QRCAP_EC][$level];
- }
-
- /**
- * Return maximum error correction code length (bytes) for the version.
- * @param int $version version
- * @param int $level error correction level
- * @return int ECC size (bytes)
- */
- protected function getECCLength($version, $level){
- return $this->capacity[$version][QRCAP_EC][$level];
- }
-
- /**
- * Return the width of the symbol for the version.
- * @param int $version version
- * @return int width
- */
- protected function getWidth($version) {
- return $this->capacity[$version][QRCAP_WIDTH];
- }
-
- /**
- * Return the numer of remainder bits.
- * @param int $version version
- * @return int number of remainder bits
- */
- protected function getRemainder($version) {
- return $this->capacity[$version][QRCAP_REMINDER];
- }
-
- /**
- * Return a version number that satisfies the input code length.
- * @param int $size input code length (byte)
- * @param int $level error correction level
- * @return int version number
- */
- protected function getMinimumVersion($size, $level) {
- for ($i=1; $i <= QRSPEC_VERSION_MAX; ++$i) {
- $words = $this->capacity[$i][QRCAP_WORDS] - $this->capacity[$i][QRCAP_EC][$level];
- if ($words >= $size) {
- return $i;
- }
- }
+ /**
+ * insertStructuredAppendHeader
+ * @param $items (array)
+ * @param $size (int)
+ * @param $index (int)
+ * @param $parity (int)
+ * @return array items
+ */
+ protected function insertStructuredAppendHeader($items, $size, $index, $parity) {
+ if ($size > MAX_STRUCTURED_SYMBOLS) {
return -1;
}
-
- /**
- * Return the size of length indicator for the mode and version.
- * @param int $mode encoding mode
- * @param int $version version
- * @return int the size of the appropriate length indicator (bits).
- */
- protected function lengthIndicator($mode, $version) {
- if ($mode == QR_MODE_ST) {
- return 0;
- }
- if ($version <= 9) {
- $l = 0;
- } elseif ($version <= 26) {
- $l = 1;
- } else {
- $l = 2;
- }
- return $this->lengthTableBits[$mode][$l];
+ if (($index <= 0) OR ($index > MAX_STRUCTURED_SYMBOLS)) {
+ return -1;
}
+ $buf = array($size, $index, $parity);
+ $entry = $this->newInputItem(QR_MODE_ST, 3, buf);
+ array_unshift($items, $entry);
+ return $items;
+ }
- /**
- * Return the maximum length for the mode and version.
- * @param int $mode encoding mode
- * @param int $version version
- * @return int the maximum length (bytes)
- */
- protected function maximumWords($mode, $version) {
- if ($mode == QR_MODE_ST) {
- return 3;
+ /**
+ * calcParity
+ * @param $items (array)
+ * @return int parity
+ */
+ protected function calcParity($items) {
+ $parity = 0;
+ foreach ($items as $item) {
+ if ($item['mode'] != QR_MODE_ST) {
+ for ($i=$item['size']-1; $i>=0; --$i) {
+ $parity ^= $item['data'][$i];
+ }
}
- if ($version <= 9) {
- $l = 0;
- } else if ($version <= 26) {
- $l = 1;
- } else {
- $l = 2;
- }
- $bits = $this->lengthTableBits[$mode][$l];
- $words = (1 << $bits) - 1;
- if ($mode == QR_MODE_KJ) {
- $words *= 2; // the number of bytes is required
- }
- return $words;
}
+ return $parity;
+ }
- /**
- * Return an array of ECC specification.
- * @param int $version version
- * @param int $level error correction level
- * @param array $spec an array of ECC specification contains as following: {# of type1 blocks, # of data code, # of ecc code, # of type2 blocks, # of data code}
- * @return array spec
- */
- protected function getEccSpec($version, $level, $spec) {
- if (count($spec) < 5) {
- $spec = array(0, 0, 0, 0, 0);
+ /**
+ * checkModeNum
+ * @param $size (int)
+ * @param $data (array)
+ * @return boolean true or false
+ */
+ protected function checkModeNum($size, $data) {
+ for ($i=0; $i<$size; ++$i) {
+ if ((ord($data[$i]) < ord('0')) OR (ord($data[$i]) > ord('9'))){
+ return false;
}
- $b1 = $this->eccTable[$version][$level][0];
- $b2 = $this->eccTable[$version][$level][1];
- $data = $this->getDataLength($version, $level);
- $ecc = $this->getECCLength($version, $level);
- if ($b2 == 0) {
- $spec[0] = $b1;
- $spec[1] = (int)($data / $b1);
- $spec[2] = (int)($ecc / $b1);
- $spec[3] = 0;
- $spec[4] = 0;
- } else {
- $spec[0] = $b1;
- $spec[1] = (int)($data / ($b1 + $b2));
- $spec[2] = (int)($ecc / ($b1 + $b2));
- $spec[3] = $b2;
- $spec[4] = $spec[1] + 1;
- }
- return $spec;
}
+ return true;
+ }
- /**
- * Put an alignment marker.
- * @param array $frame frame
- * @param int $width width
- * @param int $ox X center coordinate of the pattern
- * @param int $oy Y center coordinate of the pattern
- * @return array frame
- */
- protected function putAlignmentMarker($frame, $ox, $oy) {
- $finder = array(
- "\xa1\xa1\xa1\xa1\xa1",
- "\xa1\xa0\xa0\xa0\xa1",
- "\xa1\xa0\xa1\xa0\xa1",
- "\xa1\xa0\xa0\xa0\xa1",
- "\xa1\xa1\xa1\xa1\xa1"
- );
- $yStart = $oy - 2;
- $xStart = $ox - 2;
- for ($y=0; $y < 5; $y++) {
- $frame = $this->qrstrset($frame, $xStart, $yStart+$y, $finder[$y]);
+ /**
+ * Look up the alphabet-numeric convesion table (see JIS X0510:2004, pp.19).
+ * @param $c (int) character value
+ * @return value
+ */
+ protected function lookAnTable($c) {
+ return (($c > 127)?-1:$this->anTable[$c]);
+ }
+
+ /**
+ * checkModeAn
+ * @param $size (int)
+ * @param $data (array)
+ * @return boolean true or false
+ */
+ protected function checkModeAn($size, $data) {
+ for ($i=0; $i<$size; ++$i) {
+ if ($this->lookAnTable(ord($data[$i])) == -1) {
+ return false;
}
+ }
+ return true;
+ }
+
+ /**
+ * estimateBitsModeNum
+ * @param $size (int)
+ * @return int number of bits
+ */
+ protected function estimateBitsModeNum($size) {
+ $w = (int)($size / 3);
+ $bits = ($w * 10);
+ switch($size - ($w * 3)) {
+ case 1: {
+ $bits += 4;
+ break;
+ }
+ case 2: {
+ $bits += 7;
+ break;
+ }
+ }
+ return $bits;
+ }
+
+ /**
+ * estimateBitsModeAn
+ * @param $size (int)
+ * @return int number of bits
+ */
+ protected function estimateBitsModeAn($size) {
+ $bits = (int)($size * 5.5); // (size / 2 ) * 11
+ if ($size & 1) {
+ $bits += 6;
+ }
+ return $bits;
+ }
+
+ /**
+ * estimateBitsMode8
+ * @param $size (int)
+ * @return int number of bits
+ */
+ protected function estimateBitsMode8($size) {
+ return (int)($size * 8);
+ }
+
+ /**
+ * estimateBitsModeKanji
+ * @param $size (int)
+ * @return int number of bits
+ */
+ protected function estimateBitsModeKanji($size) {
+ return (int)($size * 6.5); // (size / 2 ) * 13
+ }
+
+ /**
+ * checkModeKanji
+ * @param $size (int)
+ * @param $data (array)
+ * @return boolean true or false
+ */
+ protected function checkModeKanji($size, $data) {
+ if ($size & 1) {
+ return false;
+ }
+ for ($i=0; $i<$size; $i+=2) {
+ $val = (ord($data[$i]) << 8) | ord($data[$i+1]);
+ if (($val < 0x8140) OR (($val > 0x9ffc) AND ($val < 0xe040)) OR ($val > 0xebbf)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Validate the input data.
+ * @param $mode (int) encoding mode.
+ * @param $size (int) size of data (byte).
+ * @param $data (array) data to validate
+ * @return boolean true in case of valid data, false otherwise
+ */
+ protected function check($mode, $size, $data) {
+ if ($size <= 0) {
+ return false;
+ }
+ switch($mode) {
+ case QR_MODE_NM: {
+ return $this->checkModeNum($size, $data);
+ }
+ case QR_MODE_AN: {
+ return $this->checkModeAn($size, $data);
+ }
+ case QR_MODE_KJ: {
+ return $this->checkModeKanji($size, $data);
+ }
+ case QR_MODE_8B: {
+ return true;
+ }
+ case QR_MODE_ST: {
+ return true;
+ }
+ default: {
+ break;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * estimateBitStreamSize
+ * @param $items (array)
+ * @param $version (int)
+ * @return int bits
+ */
+ protected function estimateBitStreamSize($items, $version) {
+ $bits = 0;
+ if ($version == 0) {
+ $version = 1;
+ }
+ foreach ($items as $item) {
+ switch($item['mode']) {
+ case QR_MODE_NM: {
+ $bits = $this->estimateBitsModeNum($item['size']);
+ break;
+ }
+ case QR_MODE_AN: {
+ $bits = $this->estimateBitsModeAn($item['size']);
+ break;
+ }
+ case QR_MODE_8B: {
+ $bits = $this->estimateBitsMode8($item['size']);
+ break;
+ }
+ case QR_MODE_KJ: {
+ $bits = $this->estimateBitsModeKanji($item['size']);
+ break;
+ }
+ case QR_MODE_ST: {
+ return STRUCTURE_HEADER_BITS;
+ }
+ default: {
+ return 0;
+ }
+ }
+ $l = $this->lengthIndicator($item['mode'], $version);
+ $m = 1 << $l;
+ $num = (int)(($item['size'] + $m - 1) / $m);
+ $bits += $num * (4 + $l);
+ }
+ return $bits;
+ }
+
+ /**
+ * estimateVersion
+ * @param $items (array)
+ * @return int version
+ */
+ protected function estimateVersion($items) {
+ $version = 0;
+ $prev = 0;
+ do {
+ $prev = $version;
+ $bits = $this->estimateBitStreamSize($items, $prev);
+ $version = $this->getMinimumVersion((int)(($bits + 7) / 8), $this->level);
+ if ($version < 0) {
+ return -1;
+ }
+ } while ($version > $prev);
+ return $version;
+ }
+
+ /**
+ * lengthOfCode
+ * @param $mode (int)
+ * @param $version (int)
+ * @param $bits (int)
+ * @return int size
+ */
+ protected function lengthOfCode($mode, $version, $bits) {
+ $payload = $bits - 4 - $this->lengthIndicator($mode, $version);
+ switch($mode) {
+ case QR_MODE_NM: {
+ $chunks = (int)($payload / 10);
+ $remain = $payload - $chunks * 10;
+ $size = $chunks * 3;
+ if ($remain >= 7) {
+ $size += 2;
+ } elseif ($remain >= 4) {
+ $size += 1;
+ }
+ break;
+ }
+ case QR_MODE_AN: {
+ $chunks = (int)($payload / 11);
+ $remain = $payload - $chunks * 11;
+ $size = $chunks * 2;
+ if ($remain >= 6) {
+ ++$size;
+ }
+ break;
+ }
+ case QR_MODE_8B: {
+ $size = (int)($payload / 8);
+ break;
+ }
+ case QR_MODE_KJ: {
+ $size = (int)(($payload / 13) * 2);
+ break;
+ }
+ case QR_MODE_ST: {
+ $size = (int)($payload / 8);
+ break;
+ }
+ default: {
+ $size = 0;
+ break;
+ }
+ }
+ $maxsize = $this->maximumWords($mode, $version);
+ if ($size < 0) {
+ $size = 0;
+ }
+ if ($size > $maxsize) {
+ $size = $maxsize;
+ }
+ return $size;
+ }
+
+ /**
+ * createBitStream
+ * @param $items (array)
+ * @return array of items and total bits
+ */
+ protected function createBitStream($items) {
+ $total = 0;
+ foreach ($items as $key => $item) {
+ $items[$key] = $this->encodeBitStream($item, $this->version);
+ $bits = count($items[$key]['bstream']);
+ $total += $bits;
+ }
+ return array($items, $total);
+ }
+
+ /**
+ * convertData
+ * @param $items (array)
+ * @return array items
+ */
+ protected function convertData($items) {
+ $ver = $this->estimateVersion($items);
+ if ($ver > $this->version) {
+ $this->version = $ver;
+ }
+ for (;;) {
+ $cbs = $this->createBitStream($items);
+ $items = $cbs[0];
+ $bits = $cbs[1];
+ if ($bits < 0) {
+ return -1;
+ }
+ $ver = $this->getMinimumVersion((int)(($bits + 7) / 8), $this->level);
+ if ($ver < 0) {
+ return -1;
+ } elseif ($ver > $this->version) {
+ $this->version = $ver;
+ } else {
+ break;
+ }
+ }
+ return $items;
+ }
+
+ /**
+ * Append Padding Bit to bitstream
+ * @param $bstream (array)
+ * @return array bitstream
+ */
+ protected function appendPaddingBit($bstream) {
+ if (is_null($bstream)) {
+ return null;
+ }
+ $bits = count($bstream);
+ $maxwords = $this->getDataLength($this->version, $this->level);
+ $maxbits = $maxwords * 8;
+ if ($maxbits == $bits) {
+ return $bstream;
+ }
+ if ($maxbits - $bits < 5) {
+ return $this->appendNum($bstream, $maxbits - $bits, 0);
+ }
+ $bits += 4;
+ $words = (int)(($bits + 7) / 8);
+ $padding = array();
+ $padding = $this->appendNum($padding, $words * 8 - $bits + 4, 0);
+ $padlen = $maxwords - $words;
+ if ($padlen > 0) {
+ $padbuf = array();
+ for ($i=0; $i<$padlen; ++$i) {
+ $padbuf[$i] = ($i&1)?0x11:0xec;
+ }
+ $padding = $this->appendBytes($padding, $padlen, $padbuf);
+ }
+ return $this->appendBitstream($bstream, $padding);
+ }
+
+ /**
+ * mergeBitStream
+ * @param $items (array) items
+ * @return array bitstream
+ */
+ protected function mergeBitStream($items) {
+ $items = $this->convertData($items);
+ if (!is_array($items)) {
+ return null;
+ }
+ $bstream = array();
+ foreach ($items as $item) {
+ $bstream = $this->appendBitstream($bstream, $item['bstream']);
+ }
+ return $bstream;
+ }
+
+ /**
+ * Returns a stream of bits.
+ * @param $items (int)
+ * @return array padded merged byte stream
+ */
+ protected function getBitStream($items) {
+ $bstream = $this->mergeBitStream($items);
+ return $this->appendPaddingBit($bstream);
+ }
+
+ /**
+ * Pack all bit streams padding bits into a byte array.
+ * @param $items (int)
+ * @return array padded merged byte stream
+ */
+ protected function getByteStream($items) {
+ $bstream = $this->getBitStream($items);
+ return $this->bitstreamToByte($bstream);
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRbitstream
+
+ /**
+ * Return an array with zeros
+ * @param $setLength (int) array size
+ * @return array
+ */
+ protected function allocate($setLength) {
+ return array_fill(0, $setLength, 0);
+ }
+
+ /**
+ * Return new bitstream from number
+ * @param $bits (int) number of bits
+ * @param $num (int) number
+ * @return array bitstream
+ */
+ protected function newFromNum($bits, $num) {
+ $bstream = $this->allocate($bits);
+ $mask = 1 << ($bits - 1);
+ for ($i=0; $i<$bits; ++$i) {
+ if ($num & $mask) {
+ $bstream[$i] = 1;
+ } else {
+ $bstream[$i] = 0;
+ }
+ $mask = $mask >> 1;
+ }
+ return $bstream;
+ }
+
+ /**
+ * Return new bitstream from bytes
+ * @param $size (int) size
+ * @param $data (array) bytes
+ * @return array bitstream
+ */
+ protected function newFromBytes($size, $data) {
+ $bstream = $this->allocate($size * 8);
+ $p=0;
+ for ($i=0; $i<$size; ++$i) {
+ $mask = 0x80;
+ for ($j=0; $j<8; ++$j) {
+ if ($data[$i] & $mask) {
+ $bstream[$p] = 1;
+ } else {
+ $bstream[$p] = 0;
+ }
+ $p++;
+ $mask = $mask >> 1;
+ }
+ }
+ return $bstream;
+ }
+
+ /**
+ * Append one bitstream to another
+ * @param $bitstream (array) original bitstream
+ * @param $append (array) bitstream to append
+ * @return array bitstream
+ */
+ protected function appendBitstream($bitstream, $append) {
+ if ((!is_array($append)) OR (count($append) == 0)) {
+ return $bitstream;
+ }
+ if (count($bitstream) == 0) {
+ return $append;
+ }
+ return array_values(array_merge($bitstream, $append));
+ }
+
+ /**
+ * Append one bitstream created from number to another
+ * @param $bitstream (array) original bitstream
+ * @param $bits (int) number of bits
+ * @param $num (int) number
+ * @return array bitstream
+ */
+ protected function appendNum($bitstream, $bits, $num) {
+ if ($bits == 0) {
+ return 0;
+ }
+ $b = $this->newFromNum($bits, $num);
+ return $this->appendBitstream($bitstream, $b);
+ }
+
+ /**
+ * Append one bitstream created from bytes to another
+ * @param $bitstream (array) original bitstream
+ * @param $size (int) size
+ * @param $data (array) bytes
+ * @return array bitstream
+ */
+ protected function appendBytes($bitstream, $size, $data) {
+ if ($size == 0) {
+ return 0;
+ }
+ $b = $this->newFromBytes($size, $data);
+ return $this->appendBitstream($bitstream, $b);
+ }
+
+ /**
+ * Convert bitstream to bytes
+ * @param $bstream (array) original bitstream
+ * @return array of bytes
+ */
+ protected function bitstreamToByte($bstream) {
+ if (is_null($bstream)) {
+ return null;
+ }
+ $size = count($bstream);
+ if ($size == 0) {
+ return array();
+ }
+ $data = array_fill(0, (int)(($size + 7) / 8), 0);
+ $bytes = (int)($size / 8);
+ $p = 0;
+ for ($i=0; $i<$bytes; $i++) {
+ $v = 0;
+ for ($j=0; $j<8; $j++) {
+ $v = $v << 1;
+ $v |= $bstream[$p];
+ $p++;
+ }
+ $data[$i] = $v;
+ }
+ if ($size & 7) {
+ $v = 0;
+ for ($j=0; $j<($size & 7); $j++) {
+ $v = $v << 1;
+ $v |= $bstream[$p];
+ $p++;
+ }
+ $data[$bytes] = $v;
+ }
+ return $data;
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRspec
+
+ /**
+ * Replace a value on the array at the specified position
+ * @param $srctab (array)
+ * @param $x (int) X position
+ * @param $y (int) Y position
+ * @param $repl (string) value to replace
+ * @param $replLen (int) length of the repl string
+ * @return array srctab
+ */
+ protected function qrstrset($srctab, $x, $y, $repl, $replLen=false) {
+ $srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));
+ return $srctab;
+ }
+
+ /**
+ * Return maximum data code length (bytes) for the version.
+ * @param $version (int) version
+ * @param $level (int) error correction level
+ * @return int maximum size (bytes)
+ */
+ protected function getDataLength($version, $level) {
+ return $this->capacity[$version][QRCAP_WORDS] - $this->capacity[$version][QRCAP_EC][$level];
+ }
+
+ /**
+ * Return maximum error correction code length (bytes) for the version.
+ * @param $version (int) version
+ * @param $level (int) error correction level
+ * @return int ECC size (bytes)
+ */
+ protected function getECCLength($version, $level){
+ return $this->capacity[$version][QRCAP_EC][$level];
+ }
+
+ /**
+ * Return the width of the symbol for the version.
+ * @param $version (int) version
+ * @return int width
+ */
+ protected function getWidth($version) {
+ return $this->capacity[$version][QRCAP_WIDTH];
+ }
+
+ /**
+ * Return the numer of remainder bits.
+ * @param $version (int) version
+ * @return int number of remainder bits
+ */
+ protected function getRemainder($version) {
+ return $this->capacity[$version][QRCAP_REMINDER];
+ }
+
+ /**
+ * Return a version number that satisfies the input code length.
+ * @param $size (int) input code length (byte)
+ * @param $level (int) error correction level
+ * @return int version number
+ */
+ protected function getMinimumVersion($size, $level) {
+ for ($i=1; $i <= QRSPEC_VERSION_MAX; ++$i) {
+ $words = $this->capacity[$i][QRCAP_WORDS] - $this->capacity[$i][QRCAP_EC][$level];
+ if ($words >= $size) {
+ return $i;
+ }
+ }
+ return -1;
+ }
+
+ /**
+ * Return the size of length indicator for the mode and version.
+ * @param $mode (int) encoding mode
+ * @param $version (int) version
+ * @return int the size of the appropriate length indicator (bits).
+ */
+ protected function lengthIndicator($mode, $version) {
+ if ($mode == QR_MODE_ST) {
+ return 0;
+ }
+ if ($version <= 9) {
+ $l = 0;
+ } elseif ($version <= 26) {
+ $l = 1;
+ } else {
+ $l = 2;
+ }
+ return $this->lengthTableBits[$mode][$l];
+ }
+
+ /**
+ * Return the maximum length for the mode and version.
+ * @param $mode (int) encoding mode
+ * @param $version (int) version
+ * @return int the maximum length (bytes)
+ */
+ protected function maximumWords($mode, $version) {
+ if ($mode == QR_MODE_ST) {
+ return 3;
+ }
+ if ($version <= 9) {
+ $l = 0;
+ } else if ($version <= 26) {
+ $l = 1;
+ } else {
+ $l = 2;
+ }
+ $bits = $this->lengthTableBits[$mode][$l];
+ $words = (1 << $bits) - 1;
+ if ($mode == QR_MODE_KJ) {
+ $words *= 2; // the number of bytes is required
+ }
+ return $words;
+ }
+
+ /**
+ * Return an array of ECC specification.
+ * @param $version (int) version
+ * @param $level (int) error correction level
+ * @param $spec (array) an array of ECC specification contains as following: {# of type1 blocks, # of data code, # of ecc code, # of type2 blocks, # of data code}
+ * @return array spec
+ */
+ protected function getEccSpec($version, $level, $spec) {
+ if (count($spec) < 5) {
+ $spec = array(0, 0, 0, 0, 0);
+ }
+ $b1 = $this->eccTable[$version][$level][0];
+ $b2 = $this->eccTable[$version][$level][1];
+ $data = $this->getDataLength($version, $level);
+ $ecc = $this->getECCLength($version, $level);
+ if ($b2 == 0) {
+ $spec[0] = $b1;
+ $spec[1] = (int)($data / $b1);
+ $spec[2] = (int)($ecc / $b1);
+ $spec[3] = 0;
+ $spec[4] = 0;
+ } else {
+ $spec[0] = $b1;
+ $spec[1] = (int)($data / ($b1 + $b2));
+ $spec[2] = (int)($ecc / ($b1 + $b2));
+ $spec[3] = $b2;
+ $spec[4] = $spec[1] + 1;
+ }
+ return $spec;
+ }
+
+ /**
+ * Put an alignment marker.
+ * @param $frame (array) frame
+ * @param $ox (int) X center coordinate of the pattern
+ * @param $oy (int) Y center coordinate of the pattern
+ * @return array frame
+ */
+ protected function putAlignmentMarker($frame, $ox, $oy) {
+ $finder = array(
+ "\xa1\xa1\xa1\xa1\xa1",
+ "\xa1\xa0\xa0\xa0\xa1",
+ "\xa1\xa0\xa1\xa0\xa1",
+ "\xa1\xa0\xa0\xa0\xa1",
+ "\xa1\xa1\xa1\xa1\xa1"
+ );
+ $yStart = $oy - 2;
+ $xStart = $ox - 2;
+ for ($y=0; $y < 5; $y++) {
+ $frame = $this->qrstrset($frame, $xStart, $yStart+$y, $finder[$y]);
+ }
+ return $frame;
+ }
+
+ /**
+ * Put an alignment pattern.
+ * @param $version (int) version
+ * @param $frame (array) frame
+ * @param $width (int) width
+ * @return array frame
+ */
+ protected function putAlignmentPattern($version, $frame, $width) {
+ if ($version < 2) {
return $frame;
}
-
- /**
- * Put an alignment pattern.
- * @param int $version version
- * @param array $fram frame
- * @param int $width width
- * @return array frame
- */
- protected function putAlignmentPattern($version, $frame, $width) {
- if ($version < 2) {
- return $frame;
- }
- $d = $this->alignmentPattern[$version][1] - $this->alignmentPattern[$version][0];
- if ($d < 0) {
- $w = 2;
- } else {
- $w = (int)(($width - $this->alignmentPattern[$version][0]) / $d + 2);
- }
- if ($w * $w - 3 == 1) {
- $x = $this->alignmentPattern[$version][0];
- $y = $this->alignmentPattern[$version][0];
- $frame = $this->putAlignmentMarker($frame, $x, $y);
- return $frame;
- }
+ $d = $this->alignmentPattern[$version][1] - $this->alignmentPattern[$version][0];
+ if ($d < 0) {
+ $w = 2;
+ } else {
+ $w = (int)(($width - $this->alignmentPattern[$version][0]) / $d + 2);
+ }
+ if ($w * $w - 3 == 1) {
+ $x = $this->alignmentPattern[$version][0];
+ $y = $this->alignmentPattern[$version][0];
+ $frame = $this->putAlignmentMarker($frame, $x, $y);
+ return $frame;
+ }
+ $cx = $this->alignmentPattern[$version][0];
+ $wo = $w - 1;
+ for ($x=1; $x < $wo; ++$x) {
+ $frame = $this->putAlignmentMarker($frame, 6, $cx);
+ $frame = $this->putAlignmentMarker($frame, $cx, 6);
+ $cx += $d;
+ }
+ $cy = $this->alignmentPattern[$version][0];
+ for ($y=0; $y < $wo; ++$y) {
$cx = $this->alignmentPattern[$version][0];
- $wo = $w - 1;
- for ($x=1; $x < $wo; ++$x) {
- $frame = $this->putAlignmentMarker($frame, 6, $cx);
- $frame = $this->putAlignmentMarker($frame, $cx, 6);
+ for ($x=0; $x < $wo; ++$x) {
+ $frame = $this->putAlignmentMarker($frame, $cx, $cy);
$cx += $d;
}
- $cy = $this->alignmentPattern[$version][0];
- for ($y=0; $y < $wo; ++$y) {
- $cx = $this->alignmentPattern[$version][0];
- for ($x=0; $x < $wo; ++$x) {
- $frame = $this->putAlignmentMarker($frame, $cx, $cy);
- $cx += $d;
- }
- $cy += $d;
- }
- return $frame;
+ $cy += $d;
}
+ return $frame;
+ }
- /**
- * Return BCH encoded version information pattern that is used for the symbol of version 7 or greater. Use lower 18 bits.
- * @param int $version version
- * @return BCH encoded version information pattern
- */
- protected function getVersionPattern($version) {
- if (($version < 7) OR ($version > QRSPEC_VERSION_MAX)) {
- return 0;
- }
- return $this->versionPattern[($version - 7)];
+ /**
+ * Return BCH encoded version information pattern that is used for the symbol of version 7 or greater. Use lower 18 bits.
+ * @param $version (int) version
+ * @return BCH encoded version information pattern
+ */
+ protected function getVersionPattern($version) {
+ if (($version < 7) OR ($version > QRSPEC_VERSION_MAX)) {
+ return 0;
}
+ return $this->versionPattern[($version - 7)];
+ }
- /**
- * Return BCH encoded format information pattern.
- * @param array $mask
- * @param int $level error correction level
- * @return BCH encoded format information pattern
- */
- protected function getFormatInfo($mask, $level) {
- if (($mask < 0) OR ($mask > 7)) {
- return 0;
- }
- if (($level < 0) OR ($level > 3)) {
- return 0;
- }
- return $this->formatInfo[$level][$mask];
+ /**
+ * Return BCH encoded format information pattern.
+ * @param $mask (array)
+ * @param $level (int) error correction level
+ * @return BCH encoded format information pattern
+ */
+ protected function getFormatInfo($mask, $level) {
+ if (($mask < 0) OR ($mask > 7)) {
+ return 0;
}
-
- /**
- * Put a finder pattern.
- * @param array $frame frame
- * @param int $width width
- * @param int $ox X center coordinate of the pattern
- * @param int $oy Y center coordinate of the pattern
- * @return array frame
- */
- protected function putFinderPattern($frame, $ox, $oy) {
- $finder = array(
- "\xc1\xc1\xc1\xc1\xc1\xc1\xc1",
- "\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
- "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
- "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
- "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
- "\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
- "\xc1\xc1\xc1\xc1\xc1\xc1\xc1"
- );
- for ($y=0; $y < 7; $y++) {
- $frame = $this->qrstrset($frame, $ox, ($oy + $y), $finder[$y]);
- }
- return $frame;
+ if (($level < 0) OR ($level > 3)) {
+ return 0;
}
+ return $this->formatInfo[$level][$mask];
+ }
- /**
- * Return a copy of initialized frame.
- * @param int $version version
- * @return Array of unsigned char.
- */
- protected function createFrame($version) {
- $width = $this->capacity[$version][QRCAP_WIDTH];
- $frameLine = str_repeat ("\0", $width);
- $frame = array_fill(0, $width, $frameLine);
- // Finder pattern
- $frame = $this->putFinderPattern($frame, 0, 0);
- $frame = $this->putFinderPattern($frame, $width - 7, 0);
- $frame = $this->putFinderPattern($frame, 0, $width - 7);
- // Separator
- $yOffset = $width - 7;
- for ($y=0; $y < 7; ++$y) {
- $frame[$y][7] = "\xc0";
- $frame[$y][$width - 8] = "\xc0";
- $frame[$yOffset][7] = "\xc0";
- ++$yOffset;
- }
- $setPattern = str_repeat("\xc0", 8);
- $frame = $this->qrstrset($frame, 0, 7, $setPattern);
- $frame = $this->qrstrset($frame, $width-8, 7, $setPattern);
- $frame = $this->qrstrset($frame, 0, $width - 8, $setPattern);
- // Format info
- $setPattern = str_repeat("\x84", 9);
- $frame = $this->qrstrset($frame, 0, 8, $setPattern);
- $frame = $this->qrstrset($frame, $width - 8, 8, $setPattern, 8);
- $yOffset = $width - 8;
- for ($y=0; $y < 8; ++$y,++$yOffset) {
- $frame[$y][8] = "\x84";
- $frame[$yOffset][8] = "\x84";
- }
- // Timing pattern
- $wo = $width - 15;
- for ($i=1; $i < $wo; ++$i) {
- $frame[6][7+$i] = chr(0x90 | ($i & 1));
- $frame[7+$i][6] = chr(0x90 | ($i & 1));
- }
- // Alignment pattern
- $frame = $this->putAlignmentPattern($version, $frame, $width);
- // Version information
- if ($version >= 7) {
- $vinf = $this->getVersionPattern($version);
- $v = $vinf;
- for ($x=0; $x<6; ++$x) {
- for ($y=0; $y<3; ++$y) {
- $frame[($width - 11)+$y][$x] = chr(0x88 | ($v & 1));
- $v = $v >> 1;
- }
- }
- $v = $vinf;
- for ($y=0; $y<6; ++$y) {
- for ($x=0; $x<3; ++$x) {
- $frame[$y][$x+($width - 11)] = chr(0x88 | ($v & 1));
- $v = $v >> 1;
- }
+ /**
+ * Put a finder pattern.
+ * @param $frame (array) frame
+ * @param $ox (int) X center coordinate of the pattern
+ * @param $oy (int) Y center coordinate of the pattern
+ * @return array frame
+ */
+ protected function putFinderPattern($frame, $ox, $oy) {
+ $finder = array(
+ "\xc1\xc1\xc1\xc1\xc1\xc1\xc1",
+ "\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
+ "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
+ "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
+ "\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
+ "\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
+ "\xc1\xc1\xc1\xc1\xc1\xc1\xc1"
+ );
+ for ($y=0; $y < 7; $y++) {
+ $frame = $this->qrstrset($frame, $ox, ($oy + $y), $finder[$y]);
+ }
+ return $frame;
+ }
+
+ /**
+ * Return a copy of initialized frame.
+ * @param $version (int) version
+ * @return Array of unsigned char.
+ */
+ protected function createFrame($version) {
+ $width = $this->capacity[$version][QRCAP_WIDTH];
+ $frameLine = str_repeat ("\0", $width);
+ $frame = array_fill(0, $width, $frameLine);
+ // Finder pattern
+ $frame = $this->putFinderPattern($frame, 0, 0);
+ $frame = $this->putFinderPattern($frame, $width - 7, 0);
+ $frame = $this->putFinderPattern($frame, 0, $width - 7);
+ // Separator
+ $yOffset = $width - 7;
+ for ($y=0; $y < 7; ++$y) {
+ $frame[$y][7] = "\xc0";
+ $frame[$y][$width - 8] = "\xc0";
+ $frame[$yOffset][7] = "\xc0";
+ ++$yOffset;
+ }
+ $setPattern = str_repeat("\xc0", 8);
+ $frame = $this->qrstrset($frame, 0, 7, $setPattern);
+ $frame = $this->qrstrset($frame, $width-8, 7, $setPattern);
+ $frame = $this->qrstrset($frame, 0, $width - 8, $setPattern);
+ // Format info
+ $setPattern = str_repeat("\x84", 9);
+ $frame = $this->qrstrset($frame, 0, 8, $setPattern);
+ $frame = $this->qrstrset($frame, $width - 8, 8, $setPattern, 8);
+ $yOffset = $width - 8;
+ for ($y=0; $y < 8; ++$y,++$yOffset) {
+ $frame[$y][8] = "\x84";
+ $frame[$yOffset][8] = "\x84";
+ }
+ // Timing pattern
+ $wo = $width - 15;
+ for ($i=1; $i < $wo; ++$i) {
+ $frame[6][7+$i] = chr(0x90 | ($i & 1));
+ $frame[7+$i][6] = chr(0x90 | ($i & 1));
+ }
+ // Alignment pattern
+ $frame = $this->putAlignmentPattern($version, $frame, $width);
+ // Version information
+ if ($version >= 7) {
+ $vinf = $this->getVersionPattern($version);
+ $v = $vinf;
+ for ($x=0; $x<6; ++$x) {
+ for ($y=0; $y<3; ++$y) {
+ $frame[($width - 11)+$y][$x] = chr(0x88 | ($v & 1));
+ $v = $v >> 1;
}
}
- // and a little bit...
- $frame[$width - 8][8] = "\x81";
- return $frame;
- }
-
- /**
- * Set new frame for the specified version.
- * @param int $version version
- * @return Array of unsigned char.
- */
- protected function newFrame($version) {
- if (($version < 1) OR ($version > QRSPEC_VERSION_MAX)) {
- return NULL;
- }
- if (!isset($this->frames[$version])) {
- $this->frames[$version] = $this->createFrame($version);
- }
- if (is_null($this->frames[$version])) {
- return NULL;
- }
- return $this->frames[$version];
- }
-
- /**
- * Return block number 0
- * @param array $spec
- * @return int value
- */
- protected function rsBlockNum($spec) {
- return ($spec[0] + $spec[3]);
- }
-
- /**
- * Return block number 1
- * @param array $spec
- * @return int value
- */
- protected function rsBlockNum1($spec) {
- return $spec[0];
- }
-
- /**
- * Return data codes 1
- * @param array $spec
- * @return int value
- */
- protected function rsDataCodes1($spec) {
- return $spec[1];
- }
-
- /**
- * Return ecc codes 1
- * @param array $spec
- * @return int value
- */
- protected function rsEccCodes1($spec) {
- return $spec[2];
- }
-
- /**
- * Return block number 2
- * @param array $spec
- * @return int value
- */
- protected function rsBlockNum2($spec) {
- return $spec[3];
- }
-
- /**
- * Return data codes 2
- * @param array $spec
- * @return int value
- */
- protected function rsDataCodes2($spec) {
- return $spec[4];
- }
-
- /**
- * Return ecc codes 2
- * @param array $spec
- * @return int value
- */
- protected function rsEccCodes2($spec) {
- return $spec[2];
- }
-
- /**
- * Return data length
- * @param array $spec
- * @return int value
- */
- protected function rsDataLength($spec) {
- return ($spec[0] * $spec[1]) + ($spec[3] * $spec[4]);
- }
-
- /**
- * Return ecc length
- * @param array $spec
- * @return int value
- */
- protected function rsEccLength($spec) {
- return ($spec[0] + $spec[3]) * $spec[2];
- }
-
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRrs
-
- /**
- * Initialize a Reed-Solomon codec and add it to existing rsitems
- * @param int $symsize symbol size, bits
- * @param int $gfpoly Field generator polynomial coefficients
- * @param int $fcr first root of RS code generator polynomial, index form
- * @param int $prim primitive element to generate polynomial roots
- * @param int $nroots RS code generator polynomial degree (number of roots)
- * @param int $pad padding bytes at front of shortened block
- * @return array Array of RS values:- mm = Bits per symbol;
- nn = Symbols per block;
- alpha_to = log lookup table array;
- index_of = Antilog lookup table array;
- genpoly = Generator polynomial array;
- nroots = Number of generator;
- roots = number of parity symbols;
- fcr = First consecutive root, index form;
- prim = Primitive element, index form;
- iprim = prim-th root of 1, index form;
- pad = Padding bytes in shortened block;
- gfpoly
.
- */
- protected function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
- foreach ($this->rsitems as $rs) {
- if (($rs['pad'] != $pad) OR ($rs['nroots'] != $nroots) OR ($rs['mm'] != $symsize)
- OR ($rs['gfpoly'] != $gfpoly) OR ($rs['fcr'] != $fcr) OR ($rs['prim'] != $prim)) {
- continue;
+ $v = $vinf;
+ for ($y=0; $y<6; ++$y) {
+ for ($x=0; $x<3; ++$x) {
+ $frame[$y][$x+($width - 11)] = chr(0x88 | ($v & 1));
+ $v = $v >> 1;
}
- return $rs;
}
- $rs = $this->init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad);
- array_unshift($this->rsitems, $rs);
- return $rs;
}
+ // and a little bit...
+ $frame[$width - 8][8] = "\x81";
+ return $frame;
+ }
- // - - - - - - - - - - - - - - - - - - - - - - - - -
-
- // QRrsItem
-
- /**
- * modnn
- * @param array RS values
- * @param int $x X position
- * @return int X osition
- */
- protected function modnn($rs, $x) {
- while ($x >= $rs['nn']) {
- $x -= $rs['nn'];
- $x = ($x >> $rs['mm']) + ($x & $rs['nn']);
- }
- return $x;
+ /**
+ * Set new frame for the specified version.
+ * @param $version (int) version
+ * @return Array of unsigned char.
+ */
+ protected function newFrame($version) {
+ if (($version < 1) OR ($version > QRSPEC_VERSION_MAX)) {
+ return NULL;
}
+ if (!isset($this->frames[$version])) {
+ $this->frames[$version] = $this->createFrame($version);
+ }
+ if (is_null($this->frames[$version])) {
+ return NULL;
+ }
+ return $this->frames[$version];
+ }
- /**
- * Initialize a Reed-Solomon codec and returns an array of values.
- * @param int $symsize symbol size, bits
- * @param int $gfpoly Field generator polynomial coefficients
- * @param int $fcr first root of RS code generator polynomial, index form
- * @param int $prim primitive element to generate polynomial roots
- * @param int $nroots RS code generator polynomial degree (number of roots)
- * @param int $pad padding bytes at front of shortened block
- * @return array Array of RS values:- mm = Bits per symbol;
- nn = Symbols per block;
- alpha_to = log lookup table array;
- index_of = Antilog lookup table array;
- genpoly = Generator polynomial array;
- nroots = Number of generator;
- roots = number of parity symbols;
- fcr = First consecutive root, index form;
- prim = Primitive element, index form;
- iprim = prim-th root of 1, index form;
- pad = Padding bytes in shortened block;
- gfpoly
.
- */
- protected function init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
- // Based on Reed solomon encoder by Phil Karn, KA9Q (GNU-LGPLv2)
- $rs = null;
- // Check parameter ranges
- if (($symsize < 0) OR ($symsize > 8)) {
- return $rs;
- }
- if (($fcr < 0) OR ($fcr >= (1<<$symsize))) {
- return $rs;
- }
- if (($prim <= 0) OR ($prim >= (1<<$symsize))) {
- return $rs;
- }
- if (($nroots < 0) OR ($nroots >= (1<<$symsize))) {
- return $rs;
- }
- if (($pad < 0) OR ($pad >= ((1<<$symsize) -1 - $nroots))) {
- return $rs;
- }
- $rs = array();
- $rs['mm'] = $symsize;
- $rs['nn'] = (1 << $symsize) - 1;
- $rs['pad'] = $pad;
- $rs['alpha_to'] = array_fill(0, ($rs['nn'] + 1), 0);
- $rs['index_of'] = array_fill(0, ($rs['nn'] + 1), 0);
- // PHP style macro replacement ;)
- $NN =& $rs['nn'];
- $A0 =& $NN;
- // Generate Galois field lookup tables
- $rs['index_of'][0] = $A0; // log(zero) = -inf
- $rs['alpha_to'][$A0] = 0; // alpha**-inf = 0
- $sr = 1;
- for ($i=0; $i<$rs['nn']; ++$i) {
- $rs['index_of'][$sr] = $i;
- $rs['alpha_to'][$i] = $sr;
- $sr <<= 1;
- if ($sr & (1 << $symsize)) {
- $sr ^= $gfpoly;
- }
- $sr &= $rs['nn'];
- }
- if ($sr != 1) {
- // field generator polynomial is not primitive!
- return NULL;
- }
- // Form RS code generator polynomial from its roots
- $rs['genpoly'] = array_fill(0, ($nroots + 1), 0);
- $rs['fcr'] = $fcr;
- $rs['prim'] = $prim;
- $rs['nroots'] = $nroots;
- $rs['gfpoly'] = $gfpoly;
- // Find prim-th root of 1, used in decoding
- for ($iprim=1; ($iprim % $prim) != 0; $iprim += $rs['nn']) {
- ; // intentional empty-body loop!
- }
- $rs['iprim'] = (int)($iprim / $prim);
- $rs['genpoly'][0] = 1;
- for ($i = 0,$root=$fcr*$prim; $i < $nroots; $i++, $root += $prim) {
- $rs['genpoly'][$i+1] = 1;
- // Multiply rs->genpoly[] by @**(root + x)
- for ($j = $i; $j > 0; --$j) {
- if ($rs['genpoly'][$j] != 0) {
- $rs['genpoly'][$j] = $rs['genpoly'][$j-1] ^ $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][$j]] + $root)];
- } else {
- $rs['genpoly'][$j] = $rs['genpoly'][$j-1];
- }
- }
- // rs->genpoly[0] can never be zero
- $rs['genpoly'][0] = $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][0]] + $root)];
- }
- // convert rs->genpoly[] to index form for quicker encoding
- for ($i = 0; $i <= $nroots; ++$i) {
- $rs['genpoly'][$i] = $rs['index_of'][$rs['genpoly'][$i]];
+ /**
+ * Return block number 0
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsBlockNum($spec) {
+ return ($spec[0] + $spec[3]);
+ }
+
+ /**
+ * Return block number 1
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsBlockNum1($spec) {
+ return $spec[0];
+ }
+
+ /**
+ * Return data codes 1
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsDataCodes1($spec) {
+ return $spec[1];
+ }
+
+ /**
+ * Return ecc codes 1
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsEccCodes1($spec) {
+ return $spec[2];
+ }
+
+ /**
+ * Return block number 2
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsBlockNum2($spec) {
+ return $spec[3];
+ }
+
+ /**
+ * Return data codes 2
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsDataCodes2($spec) {
+ return $spec[4];
+ }
+
+ /**
+ * Return ecc codes 2
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsEccCodes2($spec) {
+ return $spec[2];
+ }
+
+ /**
+ * Return data length
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsDataLength($spec) {
+ return ($spec[0] * $spec[1]) + ($spec[3] * $spec[4]);
+ }
+
+ /**
+ * Return ecc length
+ * @param $spec (array)
+ * @return int value
+ */
+ protected function rsEccLength($spec) {
+ return ($spec[0] + $spec[3]) * $spec[2];
+ }
+
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRrs
+
+ /**
+ * Initialize a Reed-Solomon codec and add it to existing rsitems
+ * @param $symsize (int) symbol size, bits
+ * @param $gfpoly (int) Field generator polynomial coefficients
+ * @param $fcr (int) first root of RS code generator polynomial, index form
+ * @param $prim (int) primitive element to generate polynomial roots
+ * @param $nroots (int) RS code generator polynomial degree (number of roots)
+ * @param $pad (int) padding bytes at front of shortened block
+ * @return array Array of RS values:- mm = Bits per symbol;
- nn = Symbols per block;
- alpha_to = log lookup table array;
- index_of = Antilog lookup table array;
- genpoly = Generator polynomial array;
- nroots = Number of generator;
- roots = number of parity symbols;
- fcr = First consecutive root, index form;
- prim = Primitive element, index form;
- iprim = prim-th root of 1, index form;
- pad = Padding bytes in shortened block;
- gfpoly
.
+ */
+ protected function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
+ foreach ($this->rsitems as $rs) {
+ if (($rs['pad'] != $pad) OR ($rs['nroots'] != $nroots) OR ($rs['mm'] != $symsize)
+ OR ($rs['gfpoly'] != $gfpoly) OR ($rs['fcr'] != $fcr) OR ($rs['prim'] != $prim)) {
+ continue;
}
return $rs;
}
+ $rs = $this->init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad);
+ array_unshift($this->rsitems, $rs);
+ return $rs;
+ }
- /**
- * Encode a Reed-Solomon codec and returns the parity array
- * @param array $rs RS values
- * @param array $data data
- * @param array $parity parity
- * @return parity array
- */
- protected function encode_rs_char($rs, $data, $parity) {
- $MM =& $rs['mm']; // bits per symbol
- $NN =& $rs['nn']; // the total number of symbols in a RS block
- $ALPHA_TO =& $rs['alpha_to']; // the address of an array of NN elements to convert Galois field elements in index (log) form to polynomial form
- $INDEX_OF =& $rs['index_of']; // the address of an array of NN elements to convert Galois field elements in polynomial form to index (log) form
- $GENPOLY =& $rs['genpoly']; // an array of NROOTS+1 elements containing the generator polynomial in index form
- $NROOTS =& $rs['nroots']; // the number of roots in the RS code generator polynomial, which is the same as the number of parity symbols in a block
- $FCR =& $rs['fcr']; // first consecutive root, index form
- $PRIM =& $rs['prim']; // primitive element, index form
- $IPRIM =& $rs['iprim']; // prim-th root of 1, index form
- $PAD =& $rs['pad']; // the number of pad symbols in a block
- $A0 =& $NN;
- $parity = array_fill(0, $NROOTS, 0);
- for ($i=0; $i < ($NN - $NROOTS - $PAD); $i++) {
- $feedback = $INDEX_OF[$data[$i] ^ $parity[0]];
- if ($feedback != $A0) {
- // feedback term is non-zero
- // This line is unnecessary when GENPOLY[NROOTS] is unity, as it must
- // always be for the polynomials constructed by init_rs()
- $feedback = $this->modnn($rs, $NN - $GENPOLY[$NROOTS] + $feedback);
- for ($j=1; $j < $NROOTS; ++$j) {
- $parity[$j] ^= $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[($NROOTS - $j)])];
- }
- }
- // Shift
- array_shift($parity);
- if ($feedback != $A0) {
- array_push($parity, $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[0])]);
+ // - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ // QRrsItem
+
+ /**
+ * modnn
+ * @param $rs (array) RS values
+ * @param $x (int) X position
+ * @return int X osition
+ */
+ protected function modnn($rs, $x) {
+ while ($x >= $rs['nn']) {
+ $x -= $rs['nn'];
+ $x = ($x >> $rs['mm']) + ($x & $rs['nn']);
+ }
+ return $x;
+ }
+
+ /**
+ * Initialize a Reed-Solomon codec and returns an array of values.
+ * @param $symsize (int) symbol size, bits
+ * @param $gfpoly (int) Field generator polynomial coefficients
+ * @param $fcr (int) first root of RS code generator polynomial, index form
+ * @param $prim (int) primitive element to generate polynomial roots
+ * @param $nroots (int) RS code generator polynomial degree (number of roots)
+ * @param $pad (int) padding bytes at front of shortened block
+ * @return array Array of RS values:- mm = Bits per symbol;
- nn = Symbols per block;
- alpha_to = log lookup table array;
- index_of = Antilog lookup table array;
- genpoly = Generator polynomial array;
- nroots = Number of generator;
- roots = number of parity symbols;
- fcr = First consecutive root, index form;
- prim = Primitive element, index form;
- iprim = prim-th root of 1, index form;
- pad = Padding bytes in shortened block;
- gfpoly
.
+ */
+ protected function init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
+ // Based on Reed solomon encoder by Phil Karn, KA9Q (GNU-LGPLv2)
+ $rs = null;
+ // Check parameter ranges
+ if (($symsize < 0) OR ($symsize > 8)) {
+ return $rs;
+ }
+ if (($fcr < 0) OR ($fcr >= (1<<$symsize))) {
+ return $rs;
+ }
+ if (($prim <= 0) OR ($prim >= (1<<$symsize))) {
+ return $rs;
+ }
+ if (($nroots < 0) OR ($nroots >= (1<<$symsize))) {
+ return $rs;
+ }
+ if (($pad < 0) OR ($pad >= ((1<<$symsize) -1 - $nroots))) {
+ return $rs;
+ }
+ $rs = array();
+ $rs['mm'] = $symsize;
+ $rs['nn'] = (1 << $symsize) - 1;
+ $rs['pad'] = $pad;
+ $rs['alpha_to'] = array_fill(0, ($rs['nn'] + 1), 0);
+ $rs['index_of'] = array_fill(0, ($rs['nn'] + 1), 0);
+ // PHP style macro replacement ;)
+ $NN =& $rs['nn'];
+ $A0 =& $NN;
+ // Generate Galois field lookup tables
+ $rs['index_of'][0] = $A0; // log(zero) = -inf
+ $rs['alpha_to'][$A0] = 0; // alpha**-inf = 0
+ $sr = 1;
+ for ($i=0; $i<$rs['nn']; ++$i) {
+ $rs['index_of'][$sr] = $i;
+ $rs['alpha_to'][$i] = $sr;
+ $sr <<= 1;
+ if ($sr & (1 << $symsize)) {
+ $sr ^= $gfpoly;
+ }
+ $sr &= $rs['nn'];
+ }
+ if ($sr != 1) {
+ // field generator polynomial is not primitive!
+ return NULL;
+ }
+ // Form RS code generator polynomial from its roots
+ $rs['genpoly'] = array_fill(0, ($nroots + 1), 0);
+ $rs['fcr'] = $fcr;
+ $rs['prim'] = $prim;
+ $rs['nroots'] = $nroots;
+ $rs['gfpoly'] = $gfpoly;
+ // Find prim-th root of 1, used in decoding
+ for ($iprim=1; ($iprim % $prim) != 0; $iprim += $rs['nn']) {
+ ; // intentional empty-body loop!
+ }
+ $rs['iprim'] = (int)($iprim / $prim);
+ $rs['genpoly'][0] = 1;
+ for ($i = 0,$root=$fcr*$prim; $i < $nroots; $i++, $root += $prim) {
+ $rs['genpoly'][$i+1] = 1;
+ // Multiply rs->genpoly[] by @**(root + x)
+ for ($j = $i; $j > 0; --$j) {
+ if ($rs['genpoly'][$j] != 0) {
+ $rs['genpoly'][$j] = $rs['genpoly'][$j-1] ^ $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][$j]] + $root)];
} else {
- array_push($parity, 0);
+ $rs['genpoly'][$j] = $rs['genpoly'][$j-1];
}
}
- return $parity;
+ // rs->genpoly[0] can never be zero
+ $rs['genpoly'][0] = $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][0]] + $root)];
}
+ // convert rs->genpoly[] to index form for quicker encoding
+ for ($i = 0; $i <= $nroots; ++$i) {
+ $rs['genpoly'][$i] = $rs['index_of'][$rs['genpoly'][$i]];
+ }
+ return $rs;
+ }
- } // end QRcode class
+ /**
+ * Encode a Reed-Solomon codec and returns the parity array
+ * @param $rs (array) RS values
+ * @param $data (array) data
+ * @param $parity (array) parity
+ * @return parity array
+ */
+ protected function encode_rs_char($rs, $data, $parity) {
+ $MM =& $rs['mm']; // bits per symbol
+ $NN =& $rs['nn']; // the total number of symbols in a RS block
+ $ALPHA_TO =& $rs['alpha_to']; // the address of an array of NN elements to convert Galois field elements in index (log) form to polynomial form
+ $INDEX_OF =& $rs['index_of']; // the address of an array of NN elements to convert Galois field elements in polynomial form to index (log) form
+ $GENPOLY =& $rs['genpoly']; // an array of NROOTS+1 elements containing the generator polynomial in index form
+ $NROOTS =& $rs['nroots']; // the number of roots in the RS code generator polynomial, which is the same as the number of parity symbols in a block
+ $FCR =& $rs['fcr']; // first consecutive root, index form
+ $PRIM =& $rs['prim']; // primitive element, index form
+ $IPRIM =& $rs['iprim']; // prim-th root of 1, index form
+ $PAD =& $rs['pad']; // the number of pad symbols in a block
+ $A0 =& $NN;
+ $parity = array_fill(0, $NROOTS, 0);
+ for ($i=0; $i < ($NN - $NROOTS - $PAD); $i++) {
+ $feedback = $INDEX_OF[$data[$i] ^ $parity[0]];
+ if ($feedback != $A0) {
+ // feedback term is non-zero
+ // This line is unnecessary when GENPOLY[NROOTS] is unity, as it must
+ // always be for the polynomials constructed by init_rs()
+ $feedback = $this->modnn($rs, $NN - $GENPOLY[$NROOTS] + $feedback);
+ for ($j=1; $j < $NROOTS; ++$j) {
+ $parity[$j] ^= $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[($NROOTS - $j)])];
+ }
+ }
+ // Shift
+ array_shift($parity);
+ if ($feedback != $A0) {
+ array_push($parity, $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[0])]);
+ } else {
+ array_push($parity, 0);
+ }
+ }
+ return $parity;
+ }
+
+} // end QRcode class
-} // END OF "class_exists QRcode"
//============================================================+
// END OF FILE
//============================================================+
diff --git a/htdocs/includes/tcpdf/spotcolors.php b/htdocs/includes/tcpdf/spotcolors.php
index 231079d237a..c7e1671123a 100644
--- a/htdocs/includes/tcpdf/spotcolors.php
+++ b/htdocs/includes/tcpdf/spotcolors.php
@@ -3,7 +3,7 @@
// File name : spotcolors.php
// Version : 1.0.000
// Begin : 2010-11-11
-// Last Update : 2010-11-25
+// Last Update : 2010-12-16
// Author : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
@@ -32,12 +32,10 @@
//============================================================+
/**
+ * @file
* Arrays of Spot Colors for TCPDF library
* @author Nicola Asuni
- * @copyright 2002-2009 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
* @package com.tecnick.tcpdf
- * @link http://www.tcpdf.org
- * @license http://www.gnu.org/copyleft/lesser.html LGPL
* @since 5.9.012 (2010-11-11)
*/
diff --git a/htdocs/includes/tcpdf/tcpdf.php b/htdocs/includes/tcpdf/tcpdf.php
index eb8c7baaaeb..34e6025c3f7 100644
--- a/htdocs/includes/tcpdf/tcpdf.php
+++ b/htdocs/includes/tcpdf/tcpdf.php
@@ -1,21 +1,21 @@
* TCPDF project (http://www.tcpdf.org) was originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
* TCPDF main features are:
@@ -132,625 +133,629 @@
*
* Tools to encode your unicode fonts are on fonts/utils directory.
* @package com.tecnick.tcpdf
- * @abstract Class for generating PDF files on-the-fly without requiring external extensions.
* @author Nicola Asuni
- * @copyright 2002-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
- * @link http://www.tcpdf.org
- * @license http://www.tecnick.com/pagefiles/tcpdf/LICENSE.TXT GNU-LGPLv3 + YOU CAN'T REMOVE ANY TCPDF COPYRIGHT NOTICE OR LINK FROM THE GENERATED PDF DOCUMENTS.
- * @version 5.9.023
+ * @version 5.9.060
*/
-/**
- * main configuration file
- * (define the K_TCPDF_EXTERNAL_CONFIG constant to skip this file)
- */
+// Main configuration file. Define the K_TCPDF_EXTERNAL_CONFIG constant to skip this file.
require_once(dirname(__FILE__).'/config/tcpdf_config.php');
/**
-* This is a PHP class for generating PDF documents without requiring external extensions.
-* TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
-* @name TCPDF
-* @package com.tecnick.tcpdf
-* @version 5.9.023
-* @author Nicola Asuni - info@tecnick.com
-* @link http://www.tcpdf.org
-* @license http://www.tecnick.com/pagefiles/tcpdf/LICENSE.TXT GNU-LGPLv3 + YOU CAN'T REMOVE ANY TCPDF COPYRIGHT NOTICE OR LINK FROM THE GENERATED PDF DOCUMENTS.
-*/
+ * @class TCPDF
+ * PHP class for generating PDF documents without requiring external extensions.
+ * TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
+ * @package com.tecnick.tcpdf
+ * @brief PHP class for generating PDF documents without requiring external extensions.
+ * @version 5.9.060
+ * @author Nicola Asuni - info@tecnick.com
+ */
class TCPDF {
// private properties
/**
- * @var current TCPDF version
- * @access private
+ * Current TCPDF version.
+ * @private
*/
- private $tcpdf_version = '5.9.023';
+ private $tcpdf_version = '5.9.060';
// Protected properties
/**
- * @var current page number
- * @access protected
+ * Current page number.
+ * @protected
*/
protected $page;
/**
- * @var current object number
- * @access protected
+ * Current object number.
+ * @protected
*/
protected $n;
/**
- * @var array of object offsets
- * @access protected
+ * Array of object offsets.
+ * @protected
*/
protected $offsets;
/**
- * @var buffer holding in-memory PDF
- * @access protected
+ * Buffer holding in-memory PDF.
+ * @protected
*/
protected $buffer;
/**
- * @var array containing pages
- * @access protected
+ * Array containing pages.
+ * @protected
*/
protected $pages = array();
/**
- * @var current document state
- * @access protected
+ * Current document state.
+ * @protected
*/
protected $state;
/**
- * @var compression flag
- * @access protected
+ * Compression flag.
+ * @protected
*/
protected $compress;
/**
- * @var current page orientation (P = Portrait, L = Landscape)
- * @access protected
+ * Current page orientation (P = Portrait, L = Landscape).
+ * @protected
*/
protected $CurOrientation;
/**
- * @var Page dimensions
- * @access protected
+ * Page dimensions.
+ * @protected
*/
protected $pagedim = array();
/**
- * @var scale factor (number of points in user unit)
- * @access protected
+ * Scale factor (number of points in user unit).
+ * @protected
*/
protected $k;
/**
- * @var width of page format in points
- * @access protected
+ * Width of page format in points.
+ * @protected
*/
protected $fwPt;
/**
- * @var height of page format in points
- * @access protected
+ * Height of page format in points.
+ * @protected
*/
protected $fhPt;
/**
- * @var current width of page in points
- * @access protected
+ * Current width of page in points.
+ * @protected
*/
protected $wPt;
/**
- * @var current height of page in points
- * @access protected
+ * Current height of page in points.
+ * @protected
*/
protected $hPt;
/**
- * @var current width of page in user unit
- * @access protected
+ * Current width of page in user unit.
+ * @protected
*/
protected $w;
/**
- * @var current height of page in user unit
- * @access protected
+ * Current height of page in user unit.
+ * @protected
*/
protected $h;
/**
- * @var left margin
- * @access protected
+ * Left margin.
+ * @protected
*/
protected $lMargin;
/**
- * @var top margin
- * @access protected
+ * Top margin.
+ * @protected
*/
protected $tMargin;
/**
- * @var right margin
- * @access protected
+ * Right margin.
+ * @protected
*/
protected $rMargin;
/**
- * @var page break margin
- * @access protected
+ * Page break margin.
+ * @protected
*/
protected $bMargin;
/**
- * @var array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left)
+ * Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
* @since 5.9.000 (2010-10-03)
- * @access protected
+ * @protected
*/
protected $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
/**
- * @var array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left)
+ * Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
* @since 5.9.000 (2010-10-04)
- * @access protected
+ * @protected
*/
protected $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
/**
- * @var current horizontal position in user unit for cell positioning
- * @access protected
+ * Current horizontal position in user unit for cell positioning.
+ * @protected
*/
protected $x;
/**
- * @var current vertical position in user unit for cell positioning
- * @access protected
+ * Current vertical position in user unit for cell positioning.
+ * @protected
*/
protected $y;
/**
- * @var height of last cell printed
- * @access protected
+ * Height of last cell printed.
+ * @protected
*/
protected $lasth;
/**
- * @var line width in user unit
- * @access protected
+ * Line width in user unit.
+ * @protected
*/
protected $LineWidth;
/**
- * @var array of standard font names
- * @access protected
+ * Array of standard font names.
+ * @protected
*/
protected $CoreFonts;
/**
- * @var array of used fonts
- * @access protected
+ * Array of used fonts.
+ * @protected
*/
protected $fonts = array();
/**
- * @var array of font files
- * @access protected
+ * Array of font files.
+ * @protected
*/
protected $FontFiles = array();
/**
- * @var array of encoding differences
- * @access protected
+ * Array of encoding differences.
+ * @protected
*/
protected $diffs = array();
/**
- * @var array of used images
- * @access protected
+ * Array of used images.
+ * @protected
*/
protected $images = array();
/**
- * @var array of Annotations in pages
- * @access protected
+ * Array of Annotations in pages.
+ * @protected
*/
protected $PageAnnots = array();
/**
- * @var array of internal links
- * @access protected
+ * Array of internal links.
+ * @protected
*/
protected $links = array();
/**
- * @var current font family
- * @access protected
+ * Current font family.
+ * @protected
*/
protected $FontFamily;
/**
- * @var current font style
- * @access protected
+ * Current font style.
+ * @protected
*/
protected $FontStyle;
/**
- * @var current font ascent (distance between font top and baseline)
- * @access protected
+ * Current font ascent (distance between font top and baseline).
+ * @protected
* @since 2.8.000 (2007-03-29)
*/
protected $FontAscent;
/**
- * @var current font descent (distance between font bottom and baseline)
- * @access protected
+ * Current font descent (distance between font bottom and baseline).
+ * @protected
* @since 2.8.000 (2007-03-29)
*/
protected $FontDescent;
/**
- * @var underlining flag
- * @access protected
+ * Underlining flag.
+ * @protected
*/
protected $underline;
/**
- * @var overlining flag
- * @access protected
+ * Overlining flag.
+ * @protected
*/
protected $overline;
/**
- * @var current font info
- * @access protected
+ * Current font info.
+ * @protected
*/
protected $CurrentFont;
/**
- * @var current font size in points
- * @access protected
+ * Current font size in points.
+ * @protected
*/
protected $FontSizePt;
/**
- * @var current font size in user unit
- * @access protected
+ * Current font size in user unit.
+ * @protected
*/
protected $FontSize;
/**
- * @var commands for drawing color
- * @access protected
+ * Commands for drawing color.
+ * @protected
*/
protected $DrawColor;
/**
- * @var commands for filling color
- * @access protected
+ * Commands for filling color.
+ * @protected
*/
protected $FillColor;
/**
- * @var commands for text color
- * @access protected
+ * Commands for text color.
+ * @protected
*/
protected $TextColor;
/**
- * @var indicates whether fill and text colors are different
- * @access protected
+ * Indicates whether fill and text colors are different.
+ * @protected
*/
protected $ColorFlag;
/**
- * @var automatic page breaking
- * @access protected
+ * Automatic page breaking.
+ * @protected
*/
protected $AutoPageBreak;
/**
- * @var threshold used to trigger page breaks
- * @access protected
+ * Threshold used to trigger page breaks.
+ * @protected
*/
protected $PageBreakTrigger;
/**
- * @var flag set when processing footer
- * @access protected
+ * Flag set when processing footer.
+ * @protected
*/
protected $InFooter = false;
/**
- * @var zoom display mode
- * @access protected
+ * Zoom display mode.
+ * @protected
*/
protected $ZoomMode;
/**
- * @var layout display mode
- * @access protected
+ * Layout display mode.
+ * @protected
*/
protected $LayoutMode;
/**
- * @var title
- * @access protected
+ * If true set the document information dictionary in Unicode.
+ * @protected
+ */
+ protected $docinfounicode = true;
+
+ /**
+ * Document title.
+ * @protected
*/
protected $title = '';
/**
- * @var subject
- * @access protected
+ * Document subject.
+ * @protected
*/
protected $subject = '';
/**
- * @var author
- * @access protected
+ * Document author.
+ * @protected
*/
protected $author = '';
/**
- * @var keywords
- * @access protected
+ * Document keywords.
+ * @protected
*/
protected $keywords = '';
/**
- * @var creator
- * @access protected
+ * Document creator.
+ * @protected
*/
protected $creator = '';
/**
- * @var alias for total number of pages
- * @access protected
+ * String alias for total number of pages.
+ * @protected
*/
protected $AliasNbPages = '{nb}';
/**
- * @var alias for page number
- * @access protected
+ * String alias for page number.
+ * @protected
*/
protected $AliasNumPage = '{pnb}';
/**
- * @var right-bottom corner X coordinate of inserted image
+ * The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
* @since 2002-07-31
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected $img_rb_x;
/**
- * @var right-bottom corner Y coordinate of inserted image
+ * The right-bottom corner Y coordinate of last inserted image.
* @since 2002-07-31
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected $img_rb_y;
/**
- * @var adjusting factor to convert pixels to user units.
+ * Adjusting factor to convert pixels to user units.
* @since 2004-06-14
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected $imgscale = 1;
/**
- * @var boolean set to true when the input text is unicode (require unicode fonts)
+ * Boolean flag set to true when the input text is unicode (require unicode fonts).
* @since 2005-01-02
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected $isunicode = false;
/**
- * @var object containing unicode data
+ * Object containing unicode data.
* @since 5.9.004 (2010-10-18)
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected $unicode;
/**
- * @var PDF version
+ * PDF version.
* @since 1.5.3
- * @access protected
+ * @protected
*/
protected $PDFVersion = '1.7';
/**
- * @var Minimum distance between header and top page margin.
- * @access protected
+ * ID of the stored default header template (-1 = not set).
+ * @protected
+ */
+ protected $header_xobjid = -1;
+
+ /**
+ * Minimum distance between header and top page margin.
+ * @protected
*/
protected $header_margin;
/**
- * @var Minimum distance between footer and bottom page margin.
- * @access protected
+ * Minimum distance between footer and bottom page margin.
+ * @protected
*/
protected $footer_margin;
/**
- * @var original left margin value
- * @access protected
+ * Original left margin value.
+ * @protected
* @since 1.53.0.TC013
*/
protected $original_lMargin;
/**
- * @var original right margin value
- * @access protected
+ * Original right margin value.
+ * @protected
* @since 1.53.0.TC013
*/
protected $original_rMargin;
/**
- * @var Header font.
- * @access protected
+ * Default font used on page header.
+ * @protected
*/
protected $header_font;
/**
- * @var Footer font.
- * @access protected
+ * Default font used on page footer.
+ * @protected
*/
protected $footer_font;
/**
- * @var Language templates.
- * @access protected
+ * Language templates.
+ * @protected
*/
protected $l;
/**
- * @var Barcode to print on page footer (only if set).
- * @access protected
+ * Barcode to print on page footer (only if set).
+ * @protected
*/
protected $barcode = false;
/**
- * @var If true prints header
- * @access protected
+ * Boolean flag to print/hide page header.
+ * @protected
*/
protected $print_header = true;
/**
- * @var If true prints footer.
- * @access protected
+ * Boolean flag to print/hide page footer.
+ * @protected
*/
protected $print_footer = true;
/**
- * @var Header image logo.
- * @access protected
+ * Header image logo.
+ * @protected
*/
protected $header_logo = '';
/**
- * @var Header image logo width in mm.
- * @access protected
+ * Width of header image logo in user units.
+ * @protected
*/
protected $header_logo_width = 30;
/**
- * @var String to print as title on document header.
- * @access protected
+ * Title to be printed on default page header.
+ * @protected
*/
protected $header_title = '';
/**
- * @var String to print on document header.
- * @access protected
+ * String to pring on page header after title.
+ * @protected
*/
protected $header_string = '';
/**
- * @var Default number of columns for html table.
- * @access protected
+ * Default number of columns for html table.
+ * @protected
*/
protected $default_table_columns = 4;
// variables for html parser
/**
- * @var HTML PARSER: array to store current link and rendering styles.
- * @access protected
+ * HTML PARSER: array to store current link and rendering styles.
+ * @protected
*/
protected $HREF = array();
/**
- * @var store a list of available fonts on filesystem.
- * @access protected
+ * List of available fonts on filesystem.
+ * @protected
*/
protected $fontlist = array();
/**
- * @var current foreground color
- * @access protected
+ * Current foreground color.
+ * @protected
*/
protected $fgcolor;
/**
- * @var HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
- * @access protected
+ * HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
+ * @protected
*/
protected $listordered = array();
/**
- * @var HTML PARSER: array count list items on nested lists.
- * @access protected
+ * HTML PARSER: array count list items on nested lists.
+ * @protected
*/
protected $listcount = array();
/**
- * @var HTML PARSER: current list nesting level.
- * @access protected
+ * HTML PARSER: current list nesting level.
+ * @protected
*/
protected $listnum = 0;
/**
- * @var HTML PARSER: indent amount for lists.
- * @access protected
+ * HTML PARSER: indent amount for lists.
+ * @protected
*/
protected $listindent = 0;
/**
- * @var HTML PARSER: current list indententation level.
- * @access protected
+ * HTML PARSER: current list indententation level.
+ * @protected
*/
protected $listindentlevel = 0;
/**
- * @var current background color
- * @access protected
+ * Current background color.
+ * @protected
*/
protected $bgcolor;
/**
- * @var Store temporary font size in points.
- * @access protected
+ * Temporary font size in points.
+ * @protected
*/
protected $tempfontsize = 10;
/**
- * @var spacer for LI tags.
- * @access protected
+ * Spacer string for LI tags.
+ * @protected
*/
protected $lispacer = '';
/**
- * @var default encoding
- * @access protected
+ * Default encoding.
+ * @protected
* @since 1.53.0.TC010
*/
protected $encoding = 'UTF-8';
/**
- * @var PHP internal encoding
- * @access protected
+ * PHP internal encoding.
+ * @protected
* @since 1.53.0.TC016
*/
protected $internal_encoding;
/**
- * @var indicates if the document language is Right-To-Left
- * @access protected
+ * Boolean flag to indicate if the document language is Right-To-Left.
+ * @protected
* @since 2.0.000
*/
protected $rtl = false;
/**
- * @var used to force RTL or LTR string inversion
- * @access protected
+ * Boolean flag used to force RTL or LTR string direction.
+ * @protected
* @since 2.0.000
*/
protected $tmprtl = false;
@@ -758,42 +763,42 @@ class TCPDF {
// --- Variables used for document encryption:
/**
- * Indicates whether document is protected
- * @access protected
+ * IBoolean flag indicating whether document is protected.
+ * @protected
* @since 2.0.000 (2008-01-02)
*/
protected $encrypted;
/**
- * Array containing encryption settings
- * @access protected
+ * Array containing encryption settings.
+ * @protected
* @since 5.0.005 (2010-05-11)
*/
protected $encryptdata = array();
/**
- * last RC4 key encrypted (cached for optimisation)
- * @access protected
+ * Last RC4 key encrypted (cached for optimisation).
+ * @protected
* @since 2.0.000 (2008-01-02)
*/
protected $last_enc_key;
/**
- * last RC4 computed key
- * @access protected
+ * Last RC4 computed key.
+ * @protected
* @since 2.0.000 (2008-01-02)
*/
protected $last_enc_key_c;
/**
- * Encryption padding
- * @access protected
+ * Encryption padding string.
+ * @protected
*/
protected $enc_padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A";
/**
- * File ID (used on trailer)
- * @access protected
+ * File ID (used on document trailer).
+ * @protected
* @since 5.0.005 (2010-05-12)
*/
protected $file_id;
@@ -801,15 +806,15 @@ class TCPDF {
// --- bookmark ---
/**
- * Outlines for bookmark
- * @access protected
+ * Outlines for bookmark.
+ * @protected
* @since 2.1.002 (2008-02-12)
*/
protected $outlines = array();
/**
- * Outline root for bookmark
- * @access protected
+ * Outline root for bookmark.
+ * @protected
* @since 2.1.002 (2008-02-12)
*/
protected $OutlineRoot;
@@ -817,307 +822,302 @@ class TCPDF {
// --- javascript and form ---
/**
- * javascript code
- * @access protected
+ * Javascript code.
+ * @protected
* @since 2.1.002 (2008-02-12)
*/
protected $javascript = '';
/**
- * javascript counter
- * @access protected
+ * Javascript counter.
+ * @protected
* @since 2.1.002 (2008-02-12)
*/
protected $n_js;
/**
* line trough state
- * @access protected
+ * @protected
* @since 2.8.000 (2008-03-19)
*/
protected $linethrough;
/**
* Array with additional document-wide usage rights for the document.
- * @access protected
+ * @protected
* @since 5.8.014 (2010-08-23)
*/
protected $ur = array();
/**
- * Dot Per Inch Document Resolution (do not change)
- * @access protected
+ * DPI (Dot Per Inch) Document Resolution (do not change).
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $dpi = 72;
/**
- * Array of page numbers were a new page group was started
- * @access protected
+ * Array of page numbers were a new page group was started.
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $newpagegroup = array();
/**
- * Contains the number of pages of the groups
- * @access protected
+ * Contains the number of pages of the groups.
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $pagegroups;
/**
- * Contains the alias of the current page group
- * @access protected
+ * Contains the alias of the current page group.
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $currpagegroup;
/**
* Restrict the rendering of some elements to screen or printout.
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $visibility = 'all';
/**
* Print visibility.
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $n_ocg_print;
/**
* View visibility.
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $n_ocg_view;
/**
* Array of transparency objects and parameters.
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $extgstates;
/**
- * Set the default JPEG compression quality (1-100)
- * @access protected
+ * Set the default JPEG compression quality (1-100).
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected $jpeg_quality;
/**
* Default cell height ratio.
- * @access protected
+ * @protected
* @since 3.0.014 (2008-05-23)
*/
protected $cell_height_ratio = K_CELL_HEIGHT_RATIO;
/**
* PDF viewer preferences.
- * @access protected
+ * @protected
* @since 3.1.000 (2008-06-09)
*/
protected $viewer_preferences;
/**
* A name object specifying how the document should be displayed when opened.
- * @access protected
+ * @protected
* @since 3.1.000 (2008-06-09)
*/
protected $PageMode;
/**
* Array for storing gradient information.
- * @access protected
+ * @protected
* @since 3.1.000 (2008-06-09)
*/
protected $gradients = array();
/**
- * Array used to store positions inside the pages buffer.
- * keys are the page numbers
- * @access protected
+ * Array used to store positions inside the pages buffer (keys are the page numbers).
+ * @protected
* @since 3.2.000 (2008-06-26)
*/
protected $intmrk = array();
/**
- * Array used to store positions inside the pages buffer.
- * keys are the page numbers
- * @access protected
+ * Array used to store positions inside the pages buffer (keys are the page numbers).
+ * @protected
* @since 5.7.000 (2010-08-03)
*/
protected $bordermrk = array();
/**
- * Array used to store page positions to track empty pages.
- * keys are the page numbers
- * @access protected
+ * Array used to store page positions to track empty pages (keys are the page numbers).
+ * @protected
* @since 5.8.007 (2010-08-18)
*/
protected $emptypagemrk = array();
/**
- * Array used to store content positions inside the pages buffer.
- * keys are the page numbers
- * @access protected
+ * Array used to store content positions inside the pages buffer (keys are the page numbers).
+ * @protected
* @since 4.6.021 (2009-07-20)
*/
protected $cntmrk = array();
/**
* Array used to store footer positions of each page.
- * @access protected
+ * @protected
* @since 3.2.000 (2008-07-01)
*/
protected $footerpos = array();
/**
* Array used to store footer length of each page.
- * @access protected
+ * @protected
* @since 4.0.014 (2008-07-29)
*/
protected $footerlen = array();
/**
- * True if a newline is created.
- * @access protected
+ * Boolean flag to indicate if a new line is created.
+ * @protected
* @since 3.2.000 (2008-07-01)
*/
protected $newline = true;
/**
- * End position of the latest inserted line
- * @access protected
+ * End position of the latest inserted line.
+ * @protected
* @since 3.2.000 (2008-07-01)
*/
protected $endlinex = 0;
/**
- * PDF string for last line width
- * @access protected
+ * PDF string for width value of the last line.
+ * @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleWidth = '';
/**
- * PDF string for last line width
- * @access protected
+ * PDF string for CAP value of the last line.
+ * @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleCap = '0 J';
/**
- * PDF string for last line width
- * @access protected
+ * PDF string for join value of the last line.
+ * @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleJoin = '0 j';
/**
- * PDF string for last line width
- * @access protected
+ * PDF string for dash value of the last line.
+ * @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleDash = '[] 0 d';
/**
- * True if marked-content sequence is open
- * @access protected
+ * Boolean flag to indicate if marked-content sequence is open.
+ * @protected
* @since 4.0.013 (2008-07-28)
*/
protected $openMarkedContent = false;
/**
- * Count the latest inserted vertical spaces on HTML
- * @access protected
+ * Count the latest inserted vertical spaces on HTML.
+ * @protected
* @since 4.0.021 (2008-08-24)
*/
protected $htmlvspace = 0;
/**
- * Array of Spot colors
- * @access protected
+ * Array of Spot colors.
+ * @protected
* @since 4.0.024 (2008-09-12)
*/
protected $spot_colors = array();
/**
- * Symbol used for HTML unordered list items
- * @access protected
+ * Symbol used for HTML unordered list items.
+ * @protected
* @since 4.0.028 (2008-09-26)
*/
protected $lisymbol = '';
/**
- * String used to mark the beginning and end of EPS image blocks
- * @access protected
+ * String used to mark the beginning and end of EPS image blocks.
+ * @protected
* @since 4.1.000 (2008-10-18)
*/
protected $epsmarker = 'x#!#EPS#!#x';
/**
- * Array of transformation matrix
- * @access protected
+ * Array of transformation matrix.
+ * @protected
* @since 4.2.000 (2008-10-29)
*/
protected $transfmatrix = array();
/**
- * Current key for transformation matrix
- * @access protected
+ * Current key for transformation matrix.
+ * @protected
* @since 4.8.005 (2009-09-17)
*/
protected $transfmatrix_key = 0;
/**
- * Booklet mode for double-sided pages
- * @access protected
+ * Booklet mode for double-sided pages.
+ * @protected
* @since 4.2.000 (2008-10-29)
*/
protected $booklet = false;
/**
- * Epsilon value used for float calculations
- * @access protected
+ * Epsilon value used for float calculations.
+ * @protected
* @since 4.2.000 (2008-10-29)
*/
protected $feps = 0.005;
/**
- * Array used for custom vertical spaces for HTML tags
- * @access protected
+ * Array used for custom vertical spaces for HTML tags.
+ * @protected
* @since 4.2.001 (2008-10-30)
*/
protected $tagvspaces = array();
/**
- * @var HTML PARSER: custom indent amount for lists.
- * Negative value means disabled.
- * @access protected
+ * HTML PARSER: custom indent amount for lists. Negative value means disabled.
+ * @protected
* @since 4.2.007 (2008-11-12)
*/
protected $customlistindent = -1;
/**
- * @var if true keeps the border open for the cell sides that cross the page.
- * @access protected
+ * Boolean flag to indicate if the border of the cell sides that cross the page should be removed.
+ * @protected
* @since 4.2.010 (2008-11-14)
*/
protected $opencell = true;
/**
- * @var array of files to embedd
- * @access protected
+ * Array of files to embedd.
+ * @protected
* @since 4.4.000 (2008-12-07)
*/
protected $embeddedfiles = array();
/**
- * @var boolean true when inside html pre tag
- * @access protected
+ * Boolean flag to indicate if we are inside a PRE tag.
+ * @protected
* @since 4.4.001 (2008-12-08)
*/
protected $premode = false;
@@ -1125,560 +1125,567 @@ class TCPDF {
/**
* Array used to store positions of graphics transformation blocks inside the page buffer.
* keys are the page numbers
- * @access protected
+ * @protected
* @since 4.4.002 (2008-12-09)
*/
protected $transfmrk = array();
/**
- * Default color for html links
- * @access protected
+ * Default color for html links.
+ * @protected
* @since 4.4.003 (2008-12-09)
*/
protected $htmlLinkColorArray = array(0, 0, 255);
/**
- * Default font style to add to html links
- * @access protected
+ * Default font style to add to html links.
+ * @protected
* @since 4.4.003 (2008-12-09)
*/
protected $htmlLinkFontStyle = 'U';
/**
* Counts the number of pages.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $numpages = 0;
/**
* Array containing page lengths in bytes.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $pagelen = array();
/**
* Counts the number of pages.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $numimages = 0;
/**
* Store the image keys.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $imagekeys = array();
/**
* Length of the buffer in bytes.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $bufferlen = 0;
/**
* If true enables disk caching.
- * @access protected
+ * @protected
* @since 4.5.000 (2008-12-31)
*/
protected $diskcache = false;
/**
* Counts the number of fonts.
- * @access protected
+ * @protected
* @since 4.5.000 (2009-01-02)
*/
protected $numfonts = 0;
/**
* Store the font keys.
- * @access protected
+ * @protected
* @since 4.5.000 (2009-01-02)
*/
protected $fontkeys = array();
/**
* Store the font object IDs.
- * @access protected
+ * @protected
* @since 4.8.001 (2009-09-09)
*/
protected $font_obj_ids = array();
/**
* Store the fage status (true when opened, false when closed).
- * @access protected
+ * @protected
* @since 4.5.000 (2009-01-02)
*/
protected $pageopen = array();
/**
- * Default monospaced font
- * @access protected
+ * Default monospace font.
+ * @protected
* @since 4.5.025 (2009-03-10)
*/
protected $default_monospaced_font = 'courier';
/**
- * Used to store a cloned copy of the current class object
- * @access protected
+ * Cloned copy of the current class object.
+ * @protected
* @since 4.5.029 (2009-03-19)
*/
protected $objcopy;
/**
- * Array used to store the lengths of cache files
- * @access protected
+ * Array used to store the lengths of cache files.
+ * @protected
* @since 4.5.029 (2009-03-19)
*/
protected $cache_file_length = array();
/**
- * Table header content to be repeated on each new page
- * @access protected
+ * Table header content to be repeated on each new page.
+ * @protected
* @since 4.5.030 (2009-03-20)
*/
protected $thead = '';
/**
* Margins used for table header.
- * @access protected
+ * @protected
* @since 4.5.030 (2009-03-20)
*/
protected $theadMargins = array();
/**
* Cache array for UTF8StringToArray() method.
- * @access protected
+ * @protected
* @since 4.5.037 (2009-04-07)
*/
protected $cache_UTF8StringToArray = array();
/**
* Maximum size of cache array used for UTF8StringToArray() method.
- * @access protected
+ * @protected
* @since 4.5.037 (2009-04-07)
*/
protected $cache_maxsize_UTF8StringToArray = 8;
/**
* Current size of cache array used for UTF8StringToArray() method.
- * @access protected
+ * @protected
* @since 4.5.037 (2009-04-07)
*/
protected $cache_size_UTF8StringToArray = 0;
/**
- * If true enables document signing
- * @access protected
+ * Boolean flag to enable document digital signature.
+ * @protected
* @since 4.6.005 (2009-04-24)
*/
protected $sign = false;
/**
- * Signature data
- * @access protected
+ * Digital signature data.
+ * @protected
* @since 4.6.005 (2009-04-24)
*/
protected $signature_data = array();
/**
- * Signature max length
- * @access protected
+ * Digital signature max length.
+ * @protected
* @since 4.6.005 (2009-04-24)
*/
protected $signature_max_length = 11742;
/**
- * data for signature appearance
- * @access protected
+ * Data for digital signature appearance.
+ * @protected
* @since 5.3.011 (2010-06-16)
*/
protected $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0');
/**
- * Regular expression used to find blank characters used for word-wrapping.
- * @access protected
+ * Regular expression used to find blank characters (required for word-wrapping).
+ * @protected
* @since 4.6.006 (2009-04-28)
*/
protected $re_spaces = '/[^\S\xa0]/';
/**
- * Array of parts $re_spaces
- * @access protected
+ * Array of $re_spaces parts.
+ * @protected
* @since 5.5.011 (2010-07-09)
*/
protected $re_space = array('p' => '[^\S\xa0]', 'm' => '');
/**
- * Signature object ID
- * @access protected
+ * Digital signature object ID.
+ * @protected
* @since 4.6.022 (2009-06-23)
*/
protected $sig_obj_id = 0;
/**
- * ByteRange placemark used during signature process.
- * @access protected
+ * ByteRange placemark used during digital signature process.
+ * @protected
* @since 4.6.028 (2009-08-25)
*/
protected $byterange_string = '/ByteRange[0 ********** ********** **********]';
/**
- * Placemark used during signature process.
- * @access protected
+ * Placemark used during digital signature process.
+ * @protected
* @since 4.6.028 (2009-08-25)
*/
protected $sig_annot_ref = '***SIGANNREF*** 0 R';
/**
- * ID of page objects
- * @access protected
+ * ID of page objects.
+ * @protected
* @since 4.7.000 (2009-08-29)
*/
protected $page_obj_id = array();
/**
- * List of form annotations IDs
- * @access protected
+ * List of form annotations IDs.
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_obj_id = array();
/**
* Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
- * @access protected
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128));
/**
- * Javascript objects array
- * @access protected
+ * Javascript objects array.
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $js_objects = array();
/**
- * Current form action (used during XHTML rendering)
- * @access protected
+ * Current form action (used during XHTML rendering).
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_action = '';
/**
- * Current form encryption type (used during XHTML rendering)
- * @access protected
+ * Current form encryption type (used during XHTML rendering).
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_enctype = 'application/x-www-form-urlencoded';
/**
* Current method to submit forms.
- * @access protected
+ * @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_mode = 'post';
/**
* List of fonts used on form fields (fontname => fontkey).
- * @access protected
+ * @protected
* @since 4.8.001 (2009-09-09)
*/
protected $annotation_fonts = array();
/**
* List of radio buttons parent objects.
- * @access protected
+ * @protected
* @since 4.8.001 (2009-09-09)
*/
protected $radiobutton_groups = array();
/**
- * List of radio group objects IDs
- * @access protected
+ * List of radio group objects IDs.
+ * @protected
* @since 4.8.001 (2009-09-09)
*/
protected $radio_groups = array();
/**
- * Text indentation value (used for text-indent CSS attribute)
- * @access protected
+ * Text indentation value (used for text-indent CSS attribute).
+ * @protected
* @since 4.8.006 (2009-09-23)
*/
protected $textindent = 0;
/**
* Store page number when startTransaction() is called.
- * @access protected
+ * @protected
* @since 4.8.006 (2009-09-23)
*/
protected $start_transaction_page = 0;
/**
* Store Y position when startTransaction() is called.
- * @access protected
+ * @protected
* @since 4.9.001 (2010-03-28)
*/
protected $start_transaction_y = 0;
/**
- * True when we are printing the thead section on a new page
- * @access protected
+ * True when we are printing the thead section on a new page.
+ * @protected
* @since 4.8.027 (2010-01-25)
*/
protected $inthead = false;
/**
- * Array of column measures (width, space, starting Y position)
- * @access protected
+ * Array of column measures (width, space, starting Y position).
+ * @protected
* @since 4.9.001 (2010-03-28)
*/
protected $columns = array();
/**
- * Number of colums
- * @access protected
+ * Number of colums.
+ * @protected
* @since 4.9.001 (2010-03-28)
*/
protected $num_columns = 1;
/**
- * Current column number
- * @access protected
+ * Current column number.
+ * @protected
* @since 4.9.001 (2010-03-28)
*/
protected $current_column = 0;
/**
- * Starting page for columns
- * @access protected
+ * Starting page for columns.
+ * @protected
* @since 4.9.001 (2010-03-28)
*/
protected $column_start_page = 0;
/**
- * Maximum page and column selected
- * @access protected
+ * Maximum page and column selected.
+ * @protected
* @since 5.8.000 (2010-08-11)
*/
protected $maxselcol = array('page' => 0, 'column' => 0);
/**
- * Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding
- * @access protected
+ * Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.
+ * @protected
* @since 5.8.000 (2010-08-11)
*/
protected $colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
/**
* Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping.
- * @access protected
+ * @protected
* @since 4.9.008 (2010-04-03)
*/
protected $textrendermode = 0;
/**
- * Text stroke width in doc units
- * @access protected
+ * Text stroke width in doc units.
+ * @protected
* @since 4.9.008 (2010-04-03)
*/
protected $textstrokewidth = 0;
/**
- * @var current stroke color
- * @access protected
+ * Current stroke color.
+ * @protected
* @since 4.9.008 (2010-04-03)
*/
protected $strokecolor;
/**
- * @var default unit of measure for document
- * @access protected
+ * Default unit of measure for document.
+ * @protected
* @since 5.0.000 (2010-04-22)
*/
protected $pdfunit = 'mm';
/**
- * @var true when we are on TOC (Table Of Content) page
- * @access protected
+ * Boolean flag true when we are on TOC (Table Of Content) page.
+ * @protected
*/
protected $tocpage = false;
/**
- * @var If true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
- * @access protected
+ * Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
+ * @protected
* @since 5.0.000 (2010-04-26)
*/
protected $rasterize_vector_images = false;
/**
- * @var If true enables font subsetting by default
- * @access protected
+ * Boolean flag: if true enables font subsetting by default.
+ * @protected
* @since 5.3.002 (2010-06-07)
*/
protected $font_subsetting = true;
/**
- * @var Array of default graphic settings
- * @access protected
+ * Array of default graphic settings.
+ * @protected
* @since 5.5.008 (2010-07-02)
*/
protected $default_graphic_vars = array();
/**
- * @var Array of XObjects
- * @access protected
+ * Array of XObjects.
+ * @protected
* @since 5.8.014 (2010-08-23)
*/
protected $xobjects = array();
/**
- * @var boolean true when we are inside an XObject
- * @access protected
+ * Boolean value true when we are inside an XObject.
+ * @protected
* @since 5.8.017 (2010-08-24)
*/
protected $inxobj = false;
/**
- * @var current XObject ID
- * @access protected
+ * Current XObject ID.
+ * @protected
* @since 5.8.017 (2010-08-24)
*/
protected $xobjid = '';
/**
- * @var percentage of character stretching
- * @access protected
+ * Percentage of character stretching.
+ * @protected
* @since 5.9.000 (2010-09-29)
*/
protected $font_stretching = 100;
/**
- * @var increases or decreases the space between characters in a text by the specified amount (tracking/kerning).
- * @access protected
+ * Increases or decreases the space between characters in a text by the specified amount (tracking/kerning).
+ * @protected
* @since 5.9.000 (2010-09-29)
*/
protected $font_spacing = 0;
/**
- * @var array of no-write regions
+ * Array of no-write regions.
* ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right)
- * @access protected
+ * @protected
* @since 5.9.003 (2010-10-14)
*/
protected $page_regions = array();
/**
- * @var array containing HTML color names and values
- * @access protected
+ * Array containing HTML color names and values.
+ * @protected
* @since 5.9.004 (2010-10-18)
*/
protected $webcolor = array();
/**
- * @var array containing spot color names and values
- * @access protected
+ * Array containing spot color names and values.
+ * @protected
* @since 5.9.012 (2010-11-11)
*/
protected $spotcolor = array();
/**
- * @var directory used for the last SVG image
- * @access protected
+ * Boolean value true when PDF layers are used.
+ * @protected
+ * @since 5.9.046 (2011-01-18)
+ */
+ protected $pdflayers = false;
+
+ /**
+ * Directory used for the last SVG image.
+ * @protected
* @since 5.0.000 (2010-05-05)
*/
protected $svgdir = '';
/**
- * @var Deafult unit of measure for SVG
- * @access protected
+ * Deafult unit of measure for SVG.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgunit = 'px';
/**
- * @var array of SVG gradients
- * @access protected
+ * Array of SVG gradients.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svggradients = array();
/**
- * @var ID of last SVG gradient
- * @access protected
+ * ID of last SVG gradient.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svggradientid = 0;
/**
- * @var true when in SVG defs group
- * @access protected
+ * Boolean value true when in SVG defs group.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgdefsmode = false;
/**
- * @var array of SVG defs
- * @access protected
+ * Array of SVG defs.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgdefs = array();
/**
- * @var true when in SVG clipPath tag
- * @access protected
+ * Boolean value true when in SVG clipPath tag.
+ * @protected
* @since 5.0.000 (2010-04-26)
*/
protected $svgclipmode = false;
/**
- * @var array of SVG clipPath commands
- * @access protected
+ * Array of SVG clipPath commands.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgclippaths = array();
/**
- * @var array of SVG clipPath tranformation matrix
- * @access protected
+ * Array of SVG clipPath tranformation matrix.
+ * @protected
* @since 5.8.022 (2010-08-31)
*/
protected $svgcliptm = array();
/**
- * @var ID of last SVG clipPath
- * @access protected
+ * ID of last SVG clipPath.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgclipid = 0;
/**
- * @var svg text
- * @access protected
+ * SVG text.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgtext = '';
/**
- * @var svg text properties
- * @access protected
+ * SVG text properties.
+ * @protected
* @since 5.8.013 (2010-08-23)
*/
protected $svgtextmode = array();
/**
- * @var array of hinheritable SVG properties
- * @access protected
+ * Array of hinheritable SVG properties.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode');
/**
- * @var array of SVG properties
- * @access protected
+ * Array of SVG properties.
+ * @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgstyles = array(array(
@@ -1754,13 +1761,13 @@ class TCPDF {
/**
* This is the class constructor.
* It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
- * @param string $orientation page orientation. Possible values are (case insensitive):- P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
- * @param string $unit User measure unit. Possible values are:- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
- * @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- * @param boolean $unicode TRUE means that the input text is unicode (default = true)
- * @param boolean $diskcache if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).
- * @param String $encoding charset encoding; default is UTF-8
- * @access public
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):- P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
+ * @param $unit (string) User measure unit. Possible values are:- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
+ * @param $unicode (boolean) TRUE means that the input text is unicode (default = true)
+ * @param $diskcache (boolean) if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).
+ * @param $encoding (string) charset encoding; default is UTF-8
+ * @public
* @see getPageSizeFromFormat(), setPageFormat()
*/
public function __construct($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false) {
@@ -1818,6 +1825,7 @@ class TCPDF {
$this->FillColor = '0 g';
$this->TextColor = '0 g';
$this->ColorFlag = false;
+ $this->pdflayers = false;
// encryption values
$this->encrypted = false;
$this->last_enc_key = '';
@@ -1908,7 +1916,7 @@ class TCPDF {
/**
* Default destructor.
- * @access public
+ * @public
* @since 1.53.0.TC016
*/
public function __destruct() {
@@ -1923,7 +1931,7 @@ class TCPDF {
/**
* Return the current TCPDF version.
* @return TCPDF version string
- * @access public
+ * @public
* @since 5.9.012 (2010-11-10)
*/
public function getTCPDFVersion() {
@@ -1932,8 +1940,8 @@ class TCPDF {
/**
* Set the units of measure for the document.
- * @param string $unit User measure unit. Possible values are:- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
- * @access public
+ * @param $unit (string) User measure unit. Possible values are:- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
+ * @public
* @since 3.0.015 (2008-06-06)
*/
public function setPageUnit($unit) {
@@ -1975,7 +1983,7 @@ class TCPDF {
/**
* Get page dimensions from format name.
- * @param mixed $format The format name. It can be:
+ * @param $format (mixed) The format name. It can be:
* - ISO 216 A Series + 2 SIS 014711 extensions
* - A0 (841x1189 mm ; 33.11x46.81 in)
* - A1 (594x841 mm ; 23.39x33.11 in)
@@ -2284,7 +2292,7 @@ class TCPDF {
* - FR_POT (310x400 mm ; 12.20x15.75 in)
*
* @return array containing page width and height in points
- * @access public
+ * @public
* @since 5.0.010 (2010-05-17)
*/
public function getPageSizeFromFormat($format) {
@@ -2643,7 +2651,7 @@ class TCPDF {
/**
* Change the format of the current page
- * @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
* - ['format'] = page format name (one of the above);
* - ['Rotate'] : The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
* - ['PZ'] : The page's preferred zoom (magnification) factor.
@@ -2687,12 +2695,12 @@ class TCPDF {
* - ['trans']['SS'] : (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
* - ['trans']['B'] : (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
*
- * @param string $orientation page orientation. Possible values are (case insensitive):
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):
* - P or Portrait (default)
* - L or Landscape
* - '' (empty string) for automatic orientation
*
- * @access protected
+ * @protected
* @since 3.0.015 (2008-06-06)
* @see getPageSizeFromFormat()
*/
@@ -2804,14 +2812,14 @@ class TCPDF {
/**
* Set page boundaries.
- * @param int $page page number
- * @param string $type valid values are: - 'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;
- 'CropBox' : the visible region of default user space;
- 'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;
- 'TrimBox' : the intended dimensions of the finished page after trimming;
- 'ArtBox' : the page's meaningful content (including potential white space).
- * @param float $llx lower-left x coordinate in user units
- * @param float $lly lower-left y coordinate in user units
- * @param float $urx upper-right x coordinate in user units
- * @param float $ury upper-right y coordinate in user units
- * @param boolean $points if true uses user units as unit of measure, otherwise uses PDF points
- * @access public
+ * @param $page (int) page number
+ * @param $type (string) valid values are: - 'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;
- 'CropBox' : the visible region of default user space;
- 'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;
- 'TrimBox' : the intended dimensions of the finished page after trimming;
- 'ArtBox' : the page's meaningful content (including potential white space).
+ * @param $llx (float) lower-left x coordinate in user units
+ * @param $lly (float) lower-left y coordinate in user units
+ * @param $urx (float) upper-right x coordinate in user units
+ * @param $ury (float) upper-right y coordinate in user units
+ * @param $points (boolean) if true uses user units as unit of measure, otherwise uses PDF points
+ * @public
* @since 5.0.010 (2010-05-17)
*/
public function setPageBoxes($page, $type, $llx, $lly, $urx, $ury, $points=false) {
@@ -2836,8 +2844,8 @@ class TCPDF {
/**
* Swap X and Y coordinates of page boxes (change page boxes orientation).
- * @param int $page page number
- * @access protected
+ * @param $page (int) page number
+ * @protected
* @since 5.0.010 (2010-05-17)
*/
protected function swapPageBoxCoordinates($page) {
@@ -2857,10 +2865,10 @@ class TCPDF {
/**
* Set page orientation.
- * @param string $orientation page orientation. Possible values are (case insensitive):- P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
- * @param boolean $autopagebreak Boolean indicating if auto-page-break mode should be on or off.
- * @param float $bottommargin bottom margin of the page.
- * @access public
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):- P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
+ * @param $autopagebreak (boolean) Boolean indicating if auto-page-break mode should be on or off.
+ * @param $bottommargin (float) bottom margin of the page.
+ * @public
* @since 3.0.015 (2008-06-06)
*/
public function setPageOrientation($orientation, $autopagebreak='', $bottommargin='') {
@@ -2953,19 +2961,19 @@ class TCPDF {
/**
* Set regular expression to detect withespaces or word separators.
- * The pattern delimiter must be the forward-slash character '/'.
+ * The pattern delimiter must be the forward-slash character "/".
* Some example patterns are:
*
- * Non-Unicode or missing PCRE unicode support: '/[^\S\xa0]/'
- * Unicode and PCRE unicode support: '/[^\S\P{Z}\xa0]/u'
- * Unicode and PCRE unicode support in Chinese mode: '/[^\S\P{Z}\P{Lo}\xa0]/u'
- * if PCRE unicode support is turned ON (\P is the negate class of \p):
- * \p{Z} or \p{Separator}: any kind of Unicode whitespace or invisible separator.
- * \p{Lo} or \p{Other_Letter}: a Unicode letter or ideograph that does not have lowercase and uppercase variants.
- * \p{Lo} is needed for Chinese characters because are packed next to each other without spaces in between.
+ * Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
+ * Unicode and PCRE unicode support: "/[^\S\P{Z}\xa0]/u"
+ * Unicode and PCRE unicode support in Chinese mode: "/[^\S\P{Z}\P{Lo}\xa0]/u"
+ * if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
+ * "\p{Z}" or "\p{Separator}": any kind of Unicode whitespace or invisible separator.
+ * "\p{Lo}" or "\p{Other_Letter}": a Unicode letter or ideograph that does not have lowercase and uppercase variants.
+ * "\p{Lo}" is needed for Chinese characters because are packed next to each other without spaces in between.
*
- * @param string $re regular expression (leave empty for default).
- * @access public
+ * @param $re (string) regular expression (leave empty for default).
+ * @public
* @since 4.6.016 (2009-06-15)
*/
public function setSpacesRE($re='/[^\S\xa0]/') {
@@ -2988,9 +2996,9 @@ class TCPDF {
/**
* Enable or disable Right-To-Left language mode
- * @param Boolean $enable if true enable Right-To-Left language mode.
- * @param Boolean $resetx if true reset the X position on direction change.
- * @access public
+ * @param $enable (Boolean) if true enable Right-To-Left language mode.
+ * @param $resetx (Boolean) if true reset the X position on direction change.
+ * @public
* @since 2.0.000 (2008-01-03)
*/
public function setRTL($enable, $resetx=true) {
@@ -3006,7 +3014,7 @@ class TCPDF {
/**
* Return the RTL status
* @return boolean
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getRTL() {
@@ -3015,8 +3023,8 @@ class TCPDF {
/**
* Force temporary RTL language direction
- * @param mixed $mode can be false, 'L' for LTR or 'R' for RTL
- * @access public
+ * @param $mode (mixed) can be false, 'L' for LTR or 'R' for RTL
+ * @public
* @since 2.1.000 (2008-01-09)
*/
public function setTempRTL($mode) {
@@ -3048,7 +3056,7 @@ class TCPDF {
/**
* Return the current temporary RTL status
* @return boolean
- * @access public
+ * @public
* @since 4.8.014 (2009-11-04)
*/
public function isRTLTextDir() {
@@ -3057,9 +3065,9 @@ class TCPDF {
/**
* Set the last cell height.
- * @param float $h cell height.
+ * @param $h (float) cell height.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.53.0.TC034
*/
public function setLastH($h) {
@@ -3068,7 +3076,7 @@ class TCPDF {
/**
* Reset the last cell height.
- * @access public
+ * @public
* @since 5.9.000 (2010-10-03)
*/
public function resetLastH() {
@@ -3078,7 +3086,7 @@ class TCPDF {
/**
* Get the last cell height.
* @return last cell height
- * @access public
+ * @public
* @since 4.0.017 (2008-08-05)
*/
public function getLastH() {
@@ -3087,9 +3095,9 @@ class TCPDF {
/**
* Set the adjusting factor to convert pixels to user units.
- * @param float $scale adjusting factor to convert pixels to user units.
+ * @param $scale (float) adjusting factor to convert pixels to user units.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
*/
public function setImageScale($scale) {
@@ -3100,7 +3108,7 @@ class TCPDF {
* Returns the adjusting factor to convert pixels to user units.
* @return float adjusting factor to convert pixels to user units.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
*/
public function getImageScale() {
@@ -3110,10 +3118,10 @@ class TCPDF {
/**
* Returns an array of page dimensions:
* - $this->pagedim[$this->page]['w'] = page width in points
- $this->pagedim[$this->page]['h'] = height in points
- $this->pagedim[$this->page]['wk'] = page width in user units
- $this->pagedim[$this->page]['hk'] = page height in user units
- $this->pagedim[$this->page]['tm'] = top margin
- $this->pagedim[$this->page]['bm'] = bottom margin
- $this->pagedim[$this->page]['lm'] = left margin
- $this->pagedim[$this->page]['rm'] = right margin
- $this->pagedim[$this->page]['pb'] = auto page break
- $this->pagedim[$this->page]['or'] = page orientation
- $this->pagedim[$this->page]['olm'] = original left margin
- $this->pagedim[$this->page]['orm'] = original right margin
- $this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
- $this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.
- $this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation
- $this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.
- $this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade
- $this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.
- $this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.
- $this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.
- $this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.
- $this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
- $this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
- $this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed
- $this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['CropBox'] : the visible region of default user space
- $this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment
- $this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming
- $this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content
- $this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points
- * @param int $pagenum page number (empty = current page)
+ * @param $pagenum (int) page number (empty = current page)
* @return array of page dimensions.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 4.5.027 (2009-03-16)
*/
public function getPageDimensions($pagenum='') {
@@ -3125,10 +3133,10 @@ class TCPDF {
/**
* Returns the page width in units.
- * @param int $pagenum page number (empty = current page)
+ * @param $pagenum (int) page number (empty = current page)
* @return int page width.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
* @see getPageDimensions()
*/
@@ -3141,10 +3149,10 @@ class TCPDF {
/**
* Returns the page height in units.
- * @param int $pagenum page number (empty = current page)
+ * @param $pagenum (int) page number (empty = current page)
* @return int page height.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
* @see getPageDimensions()
*/
@@ -3157,10 +3165,10 @@ class TCPDF {
/**
* Returns the page break margin.
- * @param int $pagenum page number (empty = current page)
+ * @param $pagenum (int) page number (empty = current page)
* @return int page break margin.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
* @see getPageDimensions()
*/
@@ -3175,7 +3183,7 @@ class TCPDF {
* Returns the scale factor (number of points in user unit).
* @return int scale factor.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.5.2
*/
public function getScaleFactor() {
@@ -3184,11 +3192,11 @@ class TCPDF {
/**
* Defines the left, top and right margins.
- * @param float $left Left margin.
- * @param float $top Top margin.
- * @param float $right Right margin. Default value is the left one.
- * @param boolean $keepmargins if true overwrites the default page margins
- * @access public
+ * @param $left (float) Left margin.
+ * @param $top (float) Top margin.
+ * @param $right (float) Right margin. Default value is the left one.
+ * @param $keepmargins (boolean) if true overwrites the default page margins
+ * @public
* @since 1.0
* @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
*/
@@ -3209,8 +3217,8 @@ class TCPDF {
/**
* Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
- * @param float $margin The margin.
- * @access public
+ * @param $margin (float) The margin.
+ * @public
* @since 1.4
* @see SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
*/
@@ -3224,8 +3232,8 @@ class TCPDF {
/**
* Defines the top margin. The method can be called before creating the first page.
- * @param float $margin The margin.
- * @access public
+ * @param $margin (float) The margin.
+ * @public
* @since 1.5
* @see SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
*/
@@ -3239,8 +3247,8 @@ class TCPDF {
/**
* Defines the right margin. The method can be called before creating the first page.
- * @param float $margin The margin.
- * @access public
+ * @param $margin (float) The margin.
+ * @public
* @since 1.5
* @see SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()
*/
@@ -3253,8 +3261,8 @@ class TCPDF {
/**
* Set the same internal Cell padding for top, right, bottom, left-
- * @param float $pad internal padding.
- * @access public
+ * @param $pad (float) internal padding.
+ * @public
* @since 2.1.000 (2008-01-09)
* @see getCellPaddings(), setCellPaddings()
*/
@@ -3269,11 +3277,11 @@ class TCPDF {
/**
* Set the internal Cell paddings.
- * @param float $left left padding
- * @param float $top top padding
- * @param float $right right padding
- * @param float $bottom bottom padding
- * @access public
+ * @param $left (float) left padding
+ * @param $top (float) top padding
+ * @param $right (float) right padding
+ * @param $bottom (float) bottom padding
+ * @public
* @since 5.9.000 (2010-10-03)
* @see getCellPaddings(), SetCellPadding()
*/
@@ -3295,7 +3303,7 @@ class TCPDF {
/**
* Get the internal Cell padding array.
* @return array of padding values
- * @access public
+ * @public
* @since 5.9.000 (2010-10-03)
* @see setCellPaddings(), SetCellPadding()
*/
@@ -3305,11 +3313,11 @@ class TCPDF {
/**
* Set the internal Cell margins.
- * @param float $left left margin
- * @param float $top top margin
- * @param float $right right margin
- * @param float $bottom bottom margin
- * @access public
+ * @param $left (float) left margin
+ * @param $top (float) top margin
+ * @param $right (float) right margin
+ * @param $bottom (float) bottom margin
+ * @public
* @since 5.9.000 (2010-10-03)
* @see getCellMargins()
*/
@@ -3331,7 +3339,7 @@ class TCPDF {
/**
* Get the internal Cell margin array.
* @return array of margin values
- * @access public
+ * @public
* @since 5.9.000 (2010-10-03)
* @see setCellMargins()
*/
@@ -3341,9 +3349,9 @@ class TCPDF {
/**
* Adjust the internal Cell padding array to take account of the line width.
- * @param mixed $brd Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return array of adjustments
- * @access public
+ * @public
* @since 5.9.000 (2010-10-03)
*/
protected function adjustCellPadding($brd=0) {
@@ -3415,14 +3423,13 @@ class TCPDF {
/**
* Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
- * @param boolean $auto Boolean indicating if mode should be on or off.
- * @param float $margin Distance from the bottom of the page.
- * @access public
+ * @param $auto (boolean) Boolean indicating if mode should be on or off.
+ * @param $margin (float) Distance from the bottom of the page.
+ * @public
* @since 1.0
* @see Cell(), MultiCell(), AcceptPageBreak()
*/
public function SetAutoPageBreak($auto, $margin=0) {
- //Set auto page break mode and triggering margin
$this->AutoPageBreak = $auto;
$this->bMargin = $margin;
$this->PageBreakTrigger = $this->h - $margin;
@@ -3430,14 +3437,13 @@ class TCPDF {
/**
* Defines the way the document is to be displayed by the viewer.
- * @param mixed $zoom The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. - fullpage: displays the entire page on screen
- fullwidth: uses maximum width of window
- real: uses real size (equivalent to 100% zoom)
- default: uses viewer default mode
- * @param string $layout The page layout. Possible values are:- SinglePage Display one page at a time
- OneColumn Display the pages in one column
- TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left
- TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right
- TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
- TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right
- * @param string $mode A name object specifying how the document should be displayed when opened:- UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible
- UseOC (PDF 1.5) Optional content group panel visible
- UseAttachments (PDF 1.6) Attachments panel visible
- * @access public
+ * @param $zoom (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. - fullpage: displays the entire page on screen
- fullwidth: uses maximum width of window
- real: uses real size (equivalent to 100% zoom)
- default: uses viewer default mode
+ * @param $layout (string) The page layout. Possible values are:- SinglePage Display one page at a time
- OneColumn Display the pages in one column
- TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left
- TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right
- TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
- TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right
+ * @param $mode (string) A name object specifying how the document should be displayed when opened:- UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible
- UseOC (PDF 1.5) Optional content group panel visible
- UseAttachments (PDF 1.6) Attachments panel visible
+ * @public
* @since 1.2
*/
public function SetDisplayMode($zoom, $layout='SinglePage', $mode='UseNone') {
- //Set display mode in viewer
if (($zoom == 'fullpage') OR ($zoom == 'fullwidth') OR ($zoom == 'real') OR ($zoom == 'default') OR (!is_string($zoom))) {
$this->ZoomMode = $zoom;
} else {
@@ -3510,12 +3516,11 @@ class TCPDF {
/**
* Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.
* Note: the Zlib extension is required for this feature. If not present, compression will be turned off.
- * @param boolean $compress Boolean indicating if compression must be enabled.
- * @access public
+ * @param $compress (boolean) Boolean indicating if compression must be enabled.
+ * @public
* @since 1.4
*/
public function SetCompression($compress) {
- //Set page compression
if (function_exists('gzcompress')) {
$this->compress = $compress ? true : false;
} else {
@@ -3523,71 +3528,77 @@ class TCPDF {
}
}
+ /**
+ * Turn on/off Unicode mode for document information dictionary (meta tags).
+ * This has effect only when unicode mode is set to false.
+ * @param $unicode (boolean) if true set the meta information in Unicode
+ * @since 5.9.027 (2010-12-01)
+ * @public
+ */
+ public function SetDocInfoUnicode($unicode=true) {
+ $this->docinfounicode = $unicode ? true : false;
+ }
+
/**
* Defines the title of the document.
- * @param string $title The title.
- * @access public
+ * @param $title (string) The title.
+ * @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetKeywords(), SetSubject()
*/
public function SetTitle($title) {
- //Title of document
$this->title = $title;
}
/**
* Defines the subject of the document.
- * @param string $subject The subject.
- * @access public
+ * @param $subject (string) The subject.
+ * @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetKeywords(), SetTitle()
*/
public function SetSubject($subject) {
- //Subject of document
$this->subject = $subject;
}
/**
* Defines the author of the document.
- * @param string $author The name of the author.
- * @access public
+ * @param $author (string) The name of the author.
+ * @public
* @since 1.2
* @see SetCreator(), SetKeywords(), SetSubject(), SetTitle()
*/
public function SetAuthor($author) {
- //Author of document
$this->author = $author;
}
/**
* Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
- * @param string $keywords The list of keywords.
- * @access public
+ * @param $keywords (string) The list of keywords.
+ * @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetSubject(), SetTitle()
*/
public function SetKeywords($keywords) {
- //Keywords of document
$this->keywords = $keywords;
}
/**
* Defines the creator of the document. This is typically the name of the application that generates the PDF.
- * @param string $creator The name of the creator.
- * @access public
+ * @param $creator (string) The name of the creator.
+ * @public
* @since 1.2
* @see SetAuthor(), SetKeywords(), SetSubject(), SetTitle()
*/
public function SetCreator($creator) {
- //Creator of document
$this->creator = $creator;
}
/**
* This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.
* 2004-06-11 :: Nicola Asuni : changed bold tag with strong
- * @param string $msg The error message
- * @access public
+ * @param $msg (string) The error message
+ * @public
* @since 1.0
*/
public function Error($msg) {
@@ -3601,12 +3612,11 @@ class TCPDF {
* This method begins the generation of the PDF document.
* It is not necessary to call it explicitly because AddPage() does it automatically.
* Note: no page is created by this method
- * @access public
+ * @public
* @since 1.0
* @see AddPage(), Close()
*/
public function Open() {
- //Begin document
$this->state = 1;
}
@@ -3614,7 +3624,7 @@ class TCPDF {
* Terminates the PDF document.
* It is not necessary to call this method explicitly because Output() does it automatically.
* If the document contains no page, AddPage() is called to prevent from getting an invalid document.
- * @access public
+ * @public
* @since 1.0
* @see Open(), Output()
*/
@@ -3652,9 +3662,9 @@ class TCPDF {
/**
* Move pointer at the specified document page and update page dimensions.
- * @param int $pnum page number (1 ... numpages)
- * @param boolean $resetmargins if true reset left, right, top margins and Y position.
- * @access public
+ * @param $pnum (int) page number (1 ... numpages)
+ * @param $resetmargins (boolean) if true reset left, right, top margins and Y position.
+ * @public
* @since 2.1.000 (2008-01-07)
* @see getPage(), lastpage(), getNumPages()
*/
@@ -3700,8 +3710,8 @@ class TCPDF {
/**
* Reset pointer to the last document page.
- * @param boolean $resetmargins if true reset left, right, top margins and Y position.
- * @access public
+ * @param $resetmargins (boolean) if true reset left, right, top margins and Y position.
+ * @public
* @since 2.0.000 (2008-01-04)
* @see setPage(), getPage(), getNumPages()
*/
@@ -3712,7 +3722,7 @@ class TCPDF {
/**
* Get current document page number.
* @return int page number
- * @access public
+ * @public
* @since 2.1.000 (2008-01-07)
* @see setPage(), lastpage(), getNumPages()
*/
@@ -3723,7 +3733,7 @@ class TCPDF {
/**
* Get the total number of insered pages.
* @return int number of pages
- * @access public
+ * @public
* @since 2.1.000 (2008-01-07)
* @see setPage(), getPage(), lastpage()
*/
@@ -3733,9 +3743,10 @@ class TCPDF {
/**
* Adds a new TOC (Table Of Content) page to the document.
- * @param string $orientation page orientation.
- * @param boolean $keepmargins if true overwrites the default page margins with the current margins
- * @access public
+ * @param $orientation (string) page orientation.
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
+ * @param $keepmargins (boolean) if true overwrites the default page margins with the current margins
+ * @public
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), endTOCPage()
*/
@@ -3745,7 +3756,7 @@ class TCPDF {
/**
* Terminate the current TOC (Table Of Content) page
- * @access public
+ * @public
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), addTOCPage()
*/
@@ -3756,11 +3767,11 @@ class TCPDF {
/**
* Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled).
* The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
- * @param string $orientation page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
- * @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- * @param boolean $keepmargins if true overwrites the default page margins with the current margins
- * @param boolean $tocpage if true set the tocpage state to true (the added page will be used to display Table Of Content).
- * @access public
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
+ * @param $keepmargins (boolean) if true overwrites the default page margins with the current margins
+ * @param $tocpage (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content).
+ * @public
* @since 1.0
* @see startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
*/
@@ -3783,8 +3794,8 @@ class TCPDF {
/**
* Terminate the current page
- * @param boolean $tocpage if true set the tocpage state to false (end the page used to display Table Of Content).
- * @access public
+ * @param $tocpage (boolean) if true set the tocpage state to false (end the page used to display Table Of Content).
+ * @public
* @since 4.2.010 (2008-11-14)
* @see AddPage(), startPage(), addTOCPage(), endTOCPage()
*/
@@ -3809,11 +3820,12 @@ class TCPDF {
/**
* Starts a new page to the document. The page must be closed using the endPage() function.
* The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
- * @param string $orientation page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
- * @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- * @access public
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
+ * @param $tocpage (boolean) if true the page is designated to contain the Table-Of-Content.
* @since 4.2.010 (2008-11-14)
* @see AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
+ * @public
*/
public function startPage($orientation='', $format='', $tocpage=false) {
if ($tocpage) {
@@ -3858,7 +3870,7 @@ class TCPDF {
* Borders and fills are always created after content and inserted on the position marked by this method.
* This function must be called after calling Image() function for a background image.
* Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
- * @access public
+ * @public
* @since 4.0.016 (2008-07-30)
*/
public function setPageMark() {
@@ -3870,8 +3882,8 @@ class TCPDF {
/**
* Set start-writing mark on selected page.
* Borders and fills are always created after content and inserted on the position marked by this method.
- * @param int $page page number (default is the current page)
- * @access protected
+ * @param $page (int) page number (default is the current page)
+ * @protected
* @since 4.6.021 (2009-07-20)
*/
protected function setContentMark($page=0) {
@@ -3887,11 +3899,11 @@ class TCPDF {
/**
* Set header data.
- * @param string $ln header image logo
- * @param string $lw header image logo width in mm
- * @param string $ht string to print as title on document header
- * @param string $hs string to print on document header
- * @access public
+ * @param $ln (string) header image logo
+ * @param $lw (string) header image logo width in mm
+ * @param $ht (string) string to print as title on document header
+ * @param $hs (string) string to print on document header
+ * @public
*/
public function setHeaderData($ln='', $lw=0, $ht='', $hs='') {
$this->header_logo = $ln;
@@ -3904,7 +3916,7 @@ class TCPDF {
* Returns header data:
* - $ret['logo'] = logo image
- $ret['logo_width'] = width of the image logo in user units
- $ret['title'] = header title
- $ret['string'] = header description string
* @return array()
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getHeaderData() {
@@ -3919,8 +3931,8 @@ class TCPDF {
/**
* Set header margin.
* (minimum distance between header and top page margin)
- * @param int $hm distance in user units
- * @access public
+ * @param $hm (int) distance in user units
+ * @public
*/
public function setHeaderMargin($hm=10) {
$this->header_margin = $hm;
@@ -3930,7 +3942,7 @@ class TCPDF {
* Returns header margin in user units.
* @return float
* @since 4.0.012 (2008-07-24)
- * @access public
+ * @public
*/
public function getHeaderMargin() {
return $this->header_margin;
@@ -3939,8 +3951,8 @@ class TCPDF {
/**
* Set footer margin.
* (minimum distance between footer and bottom page margin)
- * @param int $fm distance in user units
- * @access public
+ * @param $fm (int) distance in user units
+ * @public
*/
public function setFooterMargin($fm=10) {
$this->footer_margin = $fm;
@@ -3950,15 +3962,15 @@ class TCPDF {
* Returns footer margin in user units.
* @return float
* @since 4.0.012 (2008-07-24)
- * @access public
+ * @public
*/
public function getFooterMargin() {
return $this->footer_margin;
}
/**
* Set a flag to print page header.
- * @param boolean $val set to true to print the page header (default), false otherwise.
- * @access public
+ * @param $val (boolean) set to true to print the page header (default), false otherwise.
+ * @public
*/
public function setPrintHeader($val=true) {
$this->print_header = $val;
@@ -3966,8 +3978,8 @@ class TCPDF {
/**
* Set a flag to print page footer.
- * @param boolean $value set to true to print the page footer (default), false otherwise.
- * @access public
+ * @param $val (boolean) set to true to print the page footer (default), false otherwise.
+ * @public
*/
public function setPrintFooter($val=true) {
$this->print_footer = $val;
@@ -3976,7 +3988,7 @@ class TCPDF {
/**
* Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
* @return float
- * @access public
+ * @public
*/
public function getImageRBX() {
return $this->img_rb_x;
@@ -3985,7 +3997,7 @@ class TCPDF {
/**
* Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
* @return float
- * @access public
+ * @public
*/
public function getImageRBY() {
return $this->img_rb_y;
@@ -3994,69 +4006,92 @@ class TCPDF {
/**
* This method is used to render the page header.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
- * @access public
+ * @public
*/
public function Header() {
- $ormargins = $this->getOriginalMargins();
- $headerfont = $this->getHeaderFont();
- $headerdata = $this->getHeaderData();
- if (($headerdata['logo']) AND ($headerdata['logo'] != K_BLANK_IMAGE)) {
- $imgtype = $this->getImageFileType(K_PATH_IMAGES.$headerdata['logo']);
- if (($imgtype == 'eps') OR ($imgtype == 'ai')) {
- $this->ImageEps(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
- } elseif ($imgtype == 'svg') {
- $this->ImageSVG(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
+ if ($this->header_xobjid < 0) {
+ // start a new XObject Template
+ $this->header_xobjid = $this->startTemplate($this->w, $this->tMargin);
+ $headerfont = $this->getHeaderFont();
+ $headerdata = $this->getHeaderData();
+ $this->y = $this->header_margin;
+ if ($this->rtl) {
+ $this->x = $this->w - $this->original_rMargin;
} else {
- $this->Image(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
+ $this->x = $this->original_lMargin;
}
- $imgy = $this->getImageRBY();
- } else {
- $imgy = $this->GetY();
+ if (($headerdata['logo']) AND ($headerdata['logo'] != K_BLANK_IMAGE)) {
+ $imgtype = $this->getImageFileType(K_PATH_IMAGES.$headerdata['logo']);
+ if (($imgtype == 'eps') OR ($imgtype == 'ai')) {
+ $this->ImageEps(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
+ } elseif ($imgtype == 'svg') {
+ $this->ImageSVG(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
+ } else {
+ $this->Image(K_PATH_IMAGES.$headerdata['logo'], '', '', $headerdata['logo_width']);
+ }
+ $imgy = $this->getImageRBY();
+ } else {
+ $imgy = $this->y;
+ }
+ $cell_height = round(($this->cell_height_ratio * $headerfont[2]) / $this->k, 2);
+ // set starting margin for text data cell
+ if ($this->getRTL()) {
+ $header_x = $this->original_rMargin + ($headerdata['logo_width'] * 1.1);
+ } else {
+ $header_x = $this->original_lMargin + ($headerdata['logo_width'] * 1.1);
+ }
+ $cw = $this->w - $this->original_lMargin - $this->original_rMargin - ($headerdata['logo_width'] * 1.1);
+ $this->SetTextColor(0, 0, 0);
+ // header title
+ $this->SetFont($headerfont[0], 'B', $headerfont[2] + 1);
+ $this->SetX($header_x);
+ $this->Cell($cw, $cell_height, $headerdata['title'], 0, 1, '', 0, '', 0);
+ // header string
+ $this->SetFont($headerfont[0], $headerfont[1], $headerfont[2]);
+ $this->SetX($header_x);
+ $this->MultiCell($cw, $cell_height, $headerdata['string'], 0, '', 0, 1, '', '', true, 0, false);
+ // print an ending header line
+ $this->SetLineStyle(array('width' => 0.85 / $this->k, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)));
+ $this->SetY((2.835 / $this->k) + max($imgy, $this->y));
+ if ($this->rtl) {
+ $this->SetX($this->original_rMargin);
+ } else {
+ $this->SetX($this->original_lMargin);
+ }
+ $this->Cell(($this->w - $this->original_lMargin - $this->original_rMargin), 0, '', 'T', 0, 'C');
+ $this->endTemplate();
}
- $cell_height = round(($this->getCellHeightRatio() * $headerfont[2]) / $this->getScaleFactor(), 2);
- // set starting margin for text data cell
- if ($this->getRTL()) {
- $header_x = $ormargins['right'] + ($headerdata['logo_width'] * 1.1);
- } else {
- $header_x = $ormargins['left'] + ($headerdata['logo_width'] * 1.1);
+ // print header template
+ $x = 0;
+ $dx = 0;
+ if ($this->booklet AND (($this->page % 2) == 0)) {
+ // adjust margins for booklet mode
+ $dx = ($this->original_lMargin - $this->original_rMargin);
}
- $this->SetTextColor(0, 0, 0);
- // header title
- $this->SetFont($headerfont[0], 'B', $headerfont[2] + 1);
- $this->SetX($header_x);
- $this->Cell(0, $cell_height, $headerdata['title'], 0, 1, '', 0, '', 0);
- // header string
- $this->SetFont($headerfont[0], $headerfont[1], $headerfont[2]);
- $this->SetX($header_x);
- $this->MultiCell(0, $cell_height, $headerdata['string'], 0, '', 0, 1, '', '', true, 0, false);
- // print an ending header line
- $this->SetLineStyle(array('width' => 0.85 / $this->getScaleFactor(), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)));
- $this->SetY((2.835 / $this->getScaleFactor()) + max($imgy, $this->GetY()));
- if ($this->getRTL()) {
- $this->SetX($ormargins['right']);
+ if ($this->rtl) {
+ $x = $this->w + $dx;
} else {
- $this->SetX($ormargins['left']);
+ $x = 0 + $dx;
}
- $this->Cell(0, 0, '', 'T', 0, 'C');
+ $this->printTemplate($this->header_xobjid, $x, 0, 0, 0, '', '', false);
}
/**
* This method is used to render the page footer.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
- * @access public
+ * @public
*/
public function Footer() {
- $cur_y = $this->GetY();
- $ormargins = $this->getOriginalMargins();
+ $cur_y = $this->y;
$this->SetTextColor(0, 0, 0);
//set style for cell border
- $line_width = 0.85 / $this->getScaleFactor();
+ $line_width = 0.85 / $this->k;
$this->SetLineStyle(array('width' => $line_width, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)));
//print document barcode
$barcode = $this->getBarcode();
if (!empty($barcode)) {
$this->Ln($line_width);
- $barcode_width = round(($this->getPageWidth() - $ormargins['left'] - $ormargins['right']) / 3);
+ $barcode_width = round(($this->w - $this->original_lMargin - $this->original_rMargin) / 3);
$style = array(
'position' => $this->rtl?'R':'L',
'align' => $this->rtl?'R':'L',
@@ -4069,7 +4104,7 @@ class TCPDF {
'bgcolor' => false,
'text' => false
);
- $this->write1DBarcode($barcode, 'C128B', '', $cur_y + $line_width, '', (($this->getFooterMargin() / 3) - $line_width), 0.3, $style, '');
+ $this->write1DBarcode($barcode, 'C128B', '', $cur_y + $line_width, '', (($this->footer_margin / 3) - $line_width), 0.3, $style, '');
}
if (empty($this->pagegroups)) {
$pagenumtxt = $this->l['w_page'].' '.$this->getAliasNumPage().' / '.$this->getAliasNbPages();
@@ -4079,17 +4114,17 @@ class TCPDF {
$this->SetY($cur_y);
//Print page number
if ($this->getRTL()) {
- $this->SetX($ormargins['right']);
+ $this->SetX($this->original_rMargin);
$this->Cell(0, 0, $pagenumtxt, 'T', 0, 'L');
} else {
- $this->SetX($ormargins['left']);
+ $this->SetX($this->original_lMargin);
$this->Cell(0, 0, $pagenumtxt, 'T', 0, 'R');
}
}
/**
* This method is used to render the page header.
- * @access protected
+ * @protected
* @since 4.0.012 (2008-07-24)
*/
protected function setHeader() {
@@ -4126,7 +4161,7 @@ class TCPDF {
/**
* This method is used to render the page footer.
- * @access protected
+ * @protected
* @since 4.0.012 (2008-07-24)
*/
protected function setFooter() {
@@ -4177,7 +4212,7 @@ class TCPDF {
/**
* This method is used to render the table header on new page (if any).
- * @access protected
+ * @protected
* @since 4.5.030 (2009-03-25)
*/
protected function setTableHeader() {
@@ -4210,6 +4245,11 @@ class TCPDF {
if (!isset($this->theadMargins['top'])) {
$this->theadMargins['top'] = $this->tMargin;
}
+ // store end of header position
+ if (!isset($this->columns[0]['th'])) {
+ $this->columns[0]['th'] = array();
+ }
+ $this->columns[0]['th']['\''.$this->page.'\''] = $this->y;
$this->tMargin = $this->y;
$this->pagedim[$this->page]['tm'] = $this->tMargin;
$this->lasth = 0;
@@ -4222,7 +4262,7 @@ class TCPDF {
/**
* Returns the current page number.
* @return int page number
- * @access public
+ * @public
* @since 1.0
* @see AliasNbPages(), getAliasNbPages()
*/
@@ -4234,11 +4274,12 @@ class TCPDF {
* Defines a new spot color.
* It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
- * @param int $c Cyan color for CMYK. Value between 0 and 100
- * @param int $m Magenta color for CMYK. Value between 0 and 100
- * @param int $y Yellow color for CMYK. Value between 0 and 100
- * @param int $k Key (Black) color for CMYK. Value between 0 and 100
- * @access public
+ * @param $name (string) name of the spot color
+ * @param $c (int) Cyan color for CMYK. Value between 0 and 100
+ * @param $m (int) Magenta color for CMYK. Value between 0 and 100
+ * @param $y (int) Yellow color for CMYK. Value between 0 and 100
+ * @param $k (int) Key (Black) color for CMYK. Value between 0 and 100
+ * @public
* @since 4.0.024 (2008-09-12)
* @see SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor()
*/
@@ -4247,16 +4288,21 @@ class TCPDF {
$i = 1 + count($this->spot_colors);
$this->spot_colors[$name] = array('i' => $i, 'c' => $c, 'm' => $m, 'y' => $y, 'k' => $k);
}
+ $color = preg_replace('/[\s]*/', '', $name); // remove extra spaces
+ $color = strtolower($color);
+ if (!isset($this->spotcolor[$color])) {
+ $this->spotcolor[$color] = array($c, $m, $y, $k, $name);
+ }
}
/**
* Defines the color used for all drawing operations (lines, rectangles and cell borders).
* It can be expressed in RGB, CMYK or GRAY SCALE components.
* The method can be called before the first page is created and the value is retained from page to page.
- * @param array $color array of colors
- * @param boolean $ret if true do not send the PDF command.
+ * @param $color (array) array of colors
+ * @param $ret (boolean) if true do not send the PDF command.
* @return string the PDF command
- * @access public
+ * @public
* @since 3.1.000 (2008-06-11)
* @see SetDrawColor()
*/
@@ -4277,14 +4323,14 @@ class TCPDF {
/**
* Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
- * @param int $col1 GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
- * @param int $col2 GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
- * @param int $col3 BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
- * @param int $col4 KEY (BLACK) color for CMYK (0-100).
- * @param boolean $ret if true do not send the command.
- * @param string $name spot color name (if any)
+ * @param $col1 (int) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
+ * @param $col2 (int) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
+ * @param $col3 (int) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
+ * @param $col4 (int) KEY (BLACK) color for CMYK (0-100).
+ * @param $ret (boolean) if true do not send the command.
+ * @param $name (string) spot color name (if any)
* @return string the PDF command
- * @access public
+ * @public
* @since 1.3
* @see SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()
*/
@@ -4332,9 +4378,9 @@ class TCPDF {
/**
* Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
- * @param string $name name of the spot color
- * @param int $tint the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- * @access public
+ * @param $name (string) name of the spot color
+ * @param $tint (int) the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
+ * @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()
*/
@@ -4343,6 +4389,7 @@ class TCPDF {
$this->Error('Undefined spot color: '.$name);
}
$this->DrawColor = sprintf('/CS%d CS %.3F SCN', $this->spot_colors[$name]['i'], ($tint / 100));
+ $this->strokecolor = array('C' => $this->spot_colors[$name]['c'], 'M' => $this->spot_colors[$name]['m'], 'Y' => $this->spot_colors[$name]['y'], 'K' => $this->spot_colors[$name]['k'], 'name' => $name);
if ($this->page > 0) {
$this->_out($this->DrawColor);
}
@@ -4352,9 +4399,9 @@ class TCPDF {
* Defines the color used for all filling operations (filled rectangles and cell backgrounds).
* It can be expressed in RGB, CMYK or GRAY SCALE components.
* The method can be called before the first page is created and the value is retained from page to page.
- * @param array $color array of colors
- * @param boolean $ret if true do not send the PDF command.
- * @access public
+ * @param $color (array) array of colors
+ * @param $ret (boolean) if true do not send the PDF command.
+ * @public
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
@@ -4374,14 +4421,14 @@ class TCPDF {
/**
* Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
- * @param int $col1 GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
- * @param int $col2 GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
- * @param int $col3 BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
- * @param int $col4 KEY (BLACK) color for CMYK (0-100).
- * @param boolean $ret if true do not send the command.
- * @param string $name spot color name (if any)
+ * @param $col1 (int) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
+ * @param $col2 (int) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
+ * @param $col3 (int) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
+ * @param $col4 (int) KEY (BLACK) color for CMYK (0-100).
+ * @param $ret (boolean) if true do not send the command.
+ * @param $name (string) spot color name (if any)
* @return string the PDF command
- * @access public
+ * @public
* @since 1.3
* @see SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()
*/
@@ -4430,9 +4477,9 @@ class TCPDF {
/**
* Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
- * @param string $name name of the spot color
- * @param int $tint the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- * @access public
+ * @param $name (string) name of the spot color
+ * @param $tint (int) the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
+ * @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()
*/
@@ -4441,6 +4488,7 @@ class TCPDF {
$this->Error('Undefined spot color: '.$name);
}
$this->FillColor = sprintf('/CS%d cs %.3F scn', $this->spot_colors[$name]['i'], ($tint / 100));
+ $this->bgcolor = array('C' => $this->spot_colors[$name]['c'], 'M' => $this->spot_colors[$name]['m'], 'Y' => $this->spot_colors[$name]['y'], 'K' => $this->spot_colors[$name]['k'], 'name' => $name);
$this->ColorFlag = ($this->FillColor != $this->TextColor);
if ($this->page > 0) {
$this->_out($this->FillColor);
@@ -4450,9 +4498,9 @@ class TCPDF {
/**
* Defines the color used for text. It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
- * @param array $color array of colors
- * @param boolean $ret if true do not send the PDF command.
- * @access public
+ * @param $color (array) array of colors
+ * @param $ret (boolean) if true do not send the PDF command.
+ * @public
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
@@ -4472,13 +4520,13 @@ class TCPDF {
/**
* Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
- * @param int $col1 GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
- * @param int $col2 GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
- * @param int $col3 BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
- * @param int $col4 KEY (BLACK) color for CMYK (0-100).
- * @param boolean $ret if true do not send the command.
- * @param string $name spot color name (if any)
- * @access public
+ * @param $col1 (int) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
+ * @param $col2 (int) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
+ * @param $col3 (int) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
+ * @param $col4 (int) KEY (BLACK) color for CMYK (0-100).
+ * @param $ret (boolean) if true do not send the command.
+ * @param $name (string) spot color name (if any)
+ * @public
* @since 1.3
* @see SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
*/
@@ -4520,9 +4568,9 @@ class TCPDF {
/**
* Defines the spot color used for text.
- * @param string $name name of the spot color
- * @param int $tint the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- * @access public
+ * @param $name (string) name of the spot color
+ * @param $tint (int) the intensity of the color (from 0 to 100 ; 100 = full intensity by default).
+ * @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()
*/
@@ -4531,6 +4579,7 @@ class TCPDF {
$this->Error('Undefined spot color: '.$name);
}
$this->TextColor = sprintf('/CS%d cs %.3F scn', $this->spot_colors[$name]['i'], ($tint / 100));
+ $this->fgcolor = array('C' => $this->spot_colors[$name]['c'], 'M' => $this->spot_colors[$name]['m'], 'Y' => $this->spot_colors[$name]['y'], 'K' => $this->spot_colors[$name]['k'], 'name' => $name);
$this->ColorFlag = ($this->FillColor != $this->TextColor);
if ($this->page > 0) {
$this->_out($this->TextColor);
@@ -4539,14 +4588,14 @@ class TCPDF {
/**
* Returns the length of a string in user unit. A font must be selected.
- * @param string $s The string whose length is to be computed
- * @param string $fontname Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
- * @param string $fontstyle Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line-trough
- O: overline
or any combination. The default value is regular.
- * @param float $fontsize Font size in points. The default value is the current size.
- * @param boolean $getarray if true returns an array of characters widths, if false returns the total length.
+ * @param $s (string) The string whose length is to be computed
+ * @param $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
+ * @param $fontstyle (string) Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line-trough
- O: overline
or any combination. The default value is regular.
+ * @param $fontsize (float) Font size in points. The default value is the current size.
+ * @param $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.2
*/
public function GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) {
@@ -4555,14 +4604,14 @@ class TCPDF {
/**
* Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.
- * @param string $sa The array of chars whose total length is to be computed
- * @param string $fontname Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
- * @param string $fontstyle Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line trough
- O: overline
or any combination. The default value is regular.
- * @param float $fontsize Font size in points. The default value is the current size.
- * @param boolean $getarray if true returns an array of characters widths, if false returns the total length.
+ * @param $sa (string) The array of chars whose total length is to be computed
+ * @param $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
+ * @param $fontstyle (string) Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line trough
- O: overline
or any combination. The default value is regular.
+ * @param $fontsize (float) Font size in points. The default value is the current size.
+ * @param $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
* @author Nicola Asuni
- * @access public
+ * @public
* @since 2.4.000 (2008-03-06)
*/
public function GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) {
@@ -4595,11 +4644,11 @@ class TCPDF {
/**
* Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking/kerning).
- * @param int $char The char code whose length is to be returned
- * @param boolean $notlast set to false for the latest character on string, true otherwise (default)
+ * @param $char (int) The char code whose length is to be returned
+ * @param $notlast (boolean) set to false for the latest character on string, true otherwise (default)
* @return float char width
* @author Nicola Asuni
- * @access public
+ * @public
* @since 2.4.000 (2008-03-06)
*/
public function GetCharWidth($char, $notlast=true) {
@@ -4618,10 +4667,10 @@ class TCPDF {
/**
* Returns the length of the char in user unit for the current font.
- * @param int $char The char code whose length is to be returned
+ * @param $char (int) The char code whose length is to be returned
* @return float char width
* @author Nicola Asuni
- * @access public
+ * @public
* @since 5.9.000 (2010-09-28)
*/
public function getRawCharWidth($char) {
@@ -4646,9 +4695,9 @@ class TCPDF {
/**
* Returns the numbero of characters in a string.
- * @param string $s The input string.
+ * @param $s (string) The input string.
* @return int number of characters
- * @access public
+ * @public
* @since 2.0.0001 (2008-01-07)
*/
public function GetNumChars($s) {
@@ -4660,7 +4709,7 @@ class TCPDF {
/**
* Fill the list of available fonts ($this->fontlist).
- * @access protected
+ * @protected
* @since 4.0.013 (2008-07-28)
*/
protected function getFontsList() {
@@ -4677,12 +4726,12 @@ class TCPDF {
* Imports a TrueType, Type1, core, or CID0 font and makes it available.
* It is necessary to generate a font definition file first (read /fonts/utils/README.TXT).
* The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
- * @param string $family Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
- * @param string $style Font style. Possible values are (case insensitive):- empty string: regular (default)
- B: bold
- I: italic
- BI or IB: bold italic
- * @param string $fontfile The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
+ * @param $family (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
+ * @param $style (string) Font style. Possible values are (case insensitive):- empty string: regular (default)
- B: bold
- I: italic
- BI or IB: bold italic
+ * @param $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
* @return array containing the font data, or false in case of error.
- * @param mixed $subset if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
- * @access public
+ * @param $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
+ * @public
* @since 1.5
* @see SetFont(), setFontSubsetting()
*/
@@ -4915,13 +4964,13 @@ class TCPDF {
* The method can be called before the first page is created and the font is retained from page to page.
* If you just wish to change the current font size, it is simpler to call SetFontSize().
* Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant
- * @param string $family Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):- times (Times-Roman)
- timesb (Times-Bold)
- timesi (Times-Italic)
- timesbi (Times-BoldItalic)
- helvetica (Helvetica)
- helveticab (Helvetica-Bold)
- helveticai (Helvetica-Oblique)
- helveticabi (Helvetica-BoldOblique)
- courier (Courier)
- courierb (Courier-Bold)
- courieri (Courier-Oblique)
- courierbi (Courier-BoldOblique)
- symbol (Symbol)
- zapfdingbats (ZapfDingbats)
It is also possible to pass an empty string. In that case, the current family is retained.
- * @param string $style Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line trough
- O: overline
or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
- * @param float $size Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
- * @param string $fontfile The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
- * @param mixed $subset if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
+ * @param $family (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):- times (Times-Roman)
- timesb (Times-Bold)
- timesi (Times-Italic)
- timesbi (Times-BoldItalic)
- helvetica (Helvetica)
- helveticab (Helvetica-Bold)
- helveticai (Helvetica-Oblique)
- helveticabi (Helvetica-BoldOblique)
- courier (Courier)
- courierb (Courier-Bold)
- courieri (Courier-Oblique)
- courierbi (Courier-BoldOblique)
- symbol (Symbol)
- zapfdingbats (ZapfDingbats)
It is also possible to pass an empty string. In that case, the current family is retained.
+ * @param $style (string) Font style. Possible values are (case insensitive):- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line trough
- O: overline
or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
+ * @param $size (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
+ * @param $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
+ * @param $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 1.0
* @see AddFont(), SetFontSize()
*/
@@ -4940,9 +4989,9 @@ class TCPDF {
/**
* Defines the size of the current font.
- * @param float $size The size (in points)
- * @param boolean $out if true output the font size command, otherwise only set the font properties.
- * @access public
+ * @param $size (float) The size (in points)
+ * @param $out (boolean) if true output the font size command, otherwise only set the font properties.
+ * @public
* @since 1.0
* @see SetFont()
*/
@@ -4982,11 +5031,11 @@ class TCPDF {
/**
* Return the font descent value
- * @param string $font font name
- * @param string $style font style
- * @param float $size The size (in points)
+ * @param $font (string) font name
+ * @param $style (string) font style
+ * @param $size (float) The size (in points)
* @return int font descent
- * @access public
+ * @public
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
@@ -5003,11 +5052,11 @@ class TCPDF {
/**
* Return the font ascent value
- * @param string $font font name
- * @param string $style font style
- * @param float $size The size (in points)
+ * @param $font (string) font name
+ * @param $style (string) font style
+ * @param $size (float) The size (in points)
* @return int font ascent
- * @access public
+ * @public
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
@@ -5024,8 +5073,8 @@ class TCPDF {
/**
* Defines the default monospaced font.
- * @param string $font Font name.
- * @access public
+ * @param $font (string) Font name.
+ * @public
* @since 4.5.025
*/
public function SetDefaultMonospacedFont($font) {
@@ -5035,7 +5084,7 @@ class TCPDF {
/**
* Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
* The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
- * @access public
+ * @public
* @since 1.5
* @see Cell(), Write(), Image(), Link(), SetLink()
*/
@@ -5048,10 +5097,10 @@ class TCPDF {
/**
* Defines the page and position a link points to.
- * @param int $link The link identifier returned by AddLink()
- * @param float $y Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
- * @param int $page Number of target page; -1 indicates the current page. This is the default value
- * @access public
+ * @param $link (int) The link identifier returned by AddLink()
+ * @param $y (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
+ * @param $page (int) Number of target page; -1 indicates the current page. This is the default value
+ * @public
* @since 1.5
* @see AddLink()
*/
@@ -5068,13 +5117,13 @@ class TCPDF {
/**
* Puts a link on a rectangular area of the page.
* Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param float $w Width of the rectangle
- * @param float $h Height of the rectangle
- * @param mixed $link URL or identifier returned by AddLink()
- * @param int $spaces number of spaces on the text to link
- * @access public
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $w (float) Width of the rectangle
+ * @param $h (float) Height of the rectangle
+ * @param $link (mixed) URL or identifier returned by AddLink()
+ * @param $spaces (int) number of spaces on the text to link
+ * @public
* @since 1.5
* @see AddLink(), Annotation(), Cell(), Write(), Image()
*/
@@ -5085,14 +5134,14 @@ class TCPDF {
/**
* Puts a markup annotation on a rectangular area of the page.
* !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param float $w Width of the rectangle
- * @param float $h Height of the rectangle
- * @param string $text annotation text or alternate content
- * @param array $opt array of options (see section 8.4 of PDF reference 1.7).
- * @param int $spaces number of spaces on the text to link
- * @access public
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $w (float) Width of the rectangle
+ * @param $h (float) Height of the rectangle
+ * @param $text (string) annotation text or alternate content
+ * @param $opt (array) array of options (see section 8.4 of PDF reference 1.7).
+ * @param $spaces (int) number of spaces on the text to link
+ * @public
* @since 4.0.018 (2008-08-06)
*/
public function Annotation($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) {
@@ -5180,7 +5229,7 @@ class TCPDF {
/**
* Embedd the attached files.
* @since 4.4.000 (2008-12-07)
- * @access protected
+ * @protected
* @see Annotation()
*/
protected function _putEmbeddedFiles() {
@@ -5204,23 +5253,23 @@ class TCPDF {
/**
* Prints a text cell at the specified position.
* This method allows to place a string precisely on the page.
- * @param float $x Abscissa of the cell origin
- * @param float $y Ordinate of the cell origin
- * @param string $txt String to print
- * @param int $fstroke outline size in user units (false = disable)
- * @param boolean $fclip if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).
- * @param boolean $ffill if true fills the text
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param int $ln Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
- * @param string $align Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param mixed $link URL or identifier returned by AddLink().
- * @param int $stretch font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
- * @param boolean $ignore_min_height if true ignore automatic minimum height value.
- * @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- A : font top
- L : font baseline
- D : font bottom
- B : cell bottom
- * @param string $valign text vertical alignment inside the cell. Possible values are:- T : top
- C : center
- B : bottom
- * @param boolean $rtloff if true uses the page top-left corner as origin of axis for $x and $y initial position.
- * @access public
+ * @param $x (float) Abscissa of the cell origin
+ * @param $y (float) Ordinate of the cell origin
+ * @param $txt (string) String to print
+ * @param $fstroke (int) outline size in user units (false = disable)
+ * @param $fclip (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).
+ * @param $ffill (boolean) if true fills the text
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $ln (int) Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
+ * @param $align (string) Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $stretch (int) font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
+ * @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
+ * @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- A : font top
- L : font baseline
- D : font bottom
- B : cell bottom
+ * @param $valign (string) text vertical alignment inside the cell. Possible values are:- T : top
- C : center
- B : bottom
+ * @param $rtloff (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position.
+ * @public
* @since 1.0
* @see Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()
*/
@@ -5240,14 +5289,14 @@ class TCPDF {
* The default implementation returns a value according to the mode selected by SetAutoPageBreak().
* This method is called automatically and should not be called directly by the application.
* @return boolean
- * @access public
+ * @public
* @since 1.4
* @see SetAutoPageBreak()
*/
public function AcceptPageBreak() {
if ($this->num_columns > 1) {
// multi column mode
- if($this->current_column < ($this->num_columns - 1)) {
+ if ($this->current_column < ($this->num_columns - 1)) {
// go to next column
$this->selectColumn($this->current_column + 1);
} else {
@@ -5264,12 +5313,12 @@ class TCPDF {
/**
* Add page if needed.
- * @param float $h Cell height. Default value: 0.
- * @param mixed $y starting y position, leave empty for current position.
- * @param boolean $addpage if true add a page, otherwise only return the true/false state
+ * @param $h (float) Cell height. Default value: 0.
+ * @param $y (mixed) starting y position, leave empty for current position.
+ * @param $addpage (boolean) if true add a page, otherwise only return the true/false state
* @return boolean true in case of page break, false otherwise.
* @since 3.2.000 (2008-07-01)
- * @access protected
+ * @protected
*/
protected function checkPageBreak($h=0, $y='', $addpage=true) {
if ($this->empty_string($y)) {
@@ -5310,16 +5359,16 @@ class TCPDF {
* Removes SHY characters from text.
* Unicode Data:
* - Name : SOFT HYPHEN, commonly abbreviated as SHY
- * - HTML Entity (decimal): ­
- * - HTML Entity (hex): ­
- * - HTML Entity (named): ­
+ * - HTML Entity (decimal): "­"
+ * - HTML Entity (hex): "­"
+ * - HTML Entity (named): "­"
* - How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]
* - UTF-8 (hex): 0xC2 0xAD (c2ad)
* - UTF-8 character: chr(194).chr(173)
*
- * @param string $txt input string
+ * @param $txt (string) input string
* @return string without SHY characters.
- * @access public
+ * @public
* @since (4.5.019) 2009-02-28
*/
public function removeSHY($txt='') {
@@ -5333,19 +5382,19 @@ class TCPDF {
/**
* Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
- * @param float $w Cell width. If 0, the cell extends up to the right margin.
- * @param float $h Cell height. Default value: 0.
- * @param string $txt String to print. Default value: empty string.
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param int $ln Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
- * @param string $align Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param mixed $link URL or identifier returned by AddLink().
- * @param int $stretch font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
- * @param boolean $ignore_min_height if true ignore automatic minimum height value.
- * @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
- * @param string $valign text vertical alignment inside the cell. Possible values are:- T : top
- C : center
- B : bottom
- * @access public
+ * @param $w (float) Cell width. If 0, the cell extends up to the right margin.
+ * @param $h (float) Cell height. Default value: 0.
+ * @param $txt (string) String to print. Default value: empty string.
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $ln (int) Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
+ * @param $align (string) Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $stretch (int) font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
+ * @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
+ * @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
+ * @param $valign (string) text vertical alignment inside the cell. Possible values are:- T : top
- C : center
- B : bottom
+ * @public
* @since 1.0
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()
*/
@@ -5368,20 +5417,20 @@ class TCPDF {
/**
* Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
- * @param float $w Cell width. If 0, the cell extends up to the right margin.
- * @param float $h Cell height. Default value: 0.
- * @param string $txt String to print. Default value: empty string.
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param int $ln Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
- * @param string $align Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param mixed $link URL or identifier returned by AddLink().
- * @param int $stretch font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
- * @param boolean $ignore_min_height if true ignore automatic minimum height value.
- * @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
- * @param string $valign text vertical alignment inside the cell. Possible values are:- T : top
- M : middle
- B : bottom
+ * @param $w (float) Cell width. If 0, the cell extends up to the right margin.
+ * @param $h (float) Cell height. Default value: 0.
+ * @param $txt (string) String to print. Default value: empty string.
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $ln (int) Indicates where the current position should go after the call. Possible values are:- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
+ * @param $align (string) Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $stretch (int) font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
+ * @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
+ * @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:- T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
+ * @param $valign (string) text vertical alignment inside the cell. Possible values are:- T : top
- M : middle
- B : bottom
* @return string containing cell code
- * @access protected
+ * @protected
* @since 1.0
* @see Cell()
*/
@@ -5782,14 +5831,13 @@ class TCPDF {
/**
* Returns the code to draw the cell border
- * @param float $x X coordinate.
- * @param float $y Y coordinate.
- * @param float $w Cell width.
- * @param float $h Cell height.
- * @param mixed $brd Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param string $mode border position respect the square edge: normal: centered; ext: external; int: internal;
+ * @param $x (float) X coordinate.
+ * @param $y (float) Y coordinate.
+ * @param $w (float) Cell width.
+ * @param $h (float) Cell height.
+ * @param $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return string containing cell border code
- * @access protected
+ * @protected
* @see SetLineStyle()
* @since 5.7.000 (2010-08-02)
*/
@@ -5975,24 +6023,24 @@ class TCPDF {
* This method allows printing text with line breaks.
* They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.
* Text can be aligned, centered or justified. The cell block can be framed and the background painted.
- * @param float $w Width of cells. If 0, they extend up to the right margin of the page.
- * @param float $h Cell minimum height. The cell extends automatically if needed.
- * @param string $txt String to print
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param string $align Allows to center or align the text. Possible values are:- L or empty string: left align
- C: center
- R: right align
- J: justification (default value when $ishtml=false)
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param int $ln Indicates where the current position should go after the call. Possible values are:- 0: to the right
- 1: to the beginning of the next line [DEFAULT]
- 2: below
- * @param float $x x position in user units
- * @param float $y y position in user units
- * @param boolean $reseth if true reset the last cell height (default true).
- * @param int $stretch font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
- * @param boolean $ishtml set to true if $txt is HTML content (default = false).
- * @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
- * @param float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
- * @param string $valign Vertical alignment of text (requires $maxh = $h > 0). Possible values are:. This feature works only when $ishtml=false.
- * @param boolean $fitcell if true attempt to fit all the text within the cell by reducing the font size.
+ * @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
+ * @param $h (float) Cell minimum height. The cell extends automatically if needed.
+ * @param $txt (string) String to print
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $align (string) Allows to center or align the text. Possible values are:- L or empty string: left align
- C: center
- R: right align
- J: justification (default value when $ishtml=false)
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $ln (int) Indicates where the current position should go after the call. Possible values are:- 0: to the right
- 1: to the beginning of the next line [DEFAULT]
- 2: below
+ * @param $x (float) x position in user units
+ * @param $y (float) y position in user units
+ * @param $reseth (boolean) if true reset the last cell height (default true).
+ * @param $stretch (int) font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
+ * @param $ishtml (boolean) set to true if $txt is HTML content (default = false).
+ * @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.
+ * @param $maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
+ * @param $valign (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:. This feature works only when $ishtml=false.
+ * @param $fitcell (boolean) if true attempt to fit all the text within the cell by reducing the font size.
* @return int Return the number of cells or 1 for html mode.
- * @access public
+ * @public
* @since 1.3
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()
*/
@@ -6068,12 +6116,12 @@ class TCPDF {
$this->writeHTML($txt, true, 0, $reseth, true, $align);
$nl = 1;
} else { // ******* Write simple text
+ $prev_FontSizePt = $this->FontSizePt;
// vertical alignment
if ($maxh > 0) {
// get text height
$text_height = $this->getStringHeight($w, $txt, $reseth, $autopadding, $mc_padding, $border);
if ($fitcell) {
- $prev_FontSizePt = $this->FontSizePt;
// try to reduce font size to fit text on cell (use a quick search algorithm)
$fmin = 1;
$fmax = $this->FontSizePt;
@@ -6306,10 +6354,10 @@ class TCPDF {
/**
* Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
- * @param mixed $brd Indicates if borders must be drawn around the cell block. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param string multicell position: 'start', 'middle', 'end'
+ * @param $brd (mixed) Indicates if borders must be drawn around the cell block. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $position (string) multicell position: 'start', 'middle', 'end'
* @return border mode array
- * @access protected
+ * @protected
* @since 4.4.002 (2008-12-09)
*/
protected function getBorderMode($brd, $position='start') {
@@ -6379,15 +6427,15 @@ class TCPDF {
/**
* This method return the estimated number of lines for print a simple text string using Multicell() method.
- * @param string $txt String for calculating his height
- * @param float $w Width of cells. If 0, they extend up to the right margin of the page.
- * @param boolean $reseth if true reset the last cell height (default false).
- * @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width (default true).
- * @param float $cellpadding Internal cell padding, if empty uses default cell padding.
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $txt (string) String for calculating his height
+ * @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
+ * @param $reseth (boolean) if true reset the last cell height (default false).
+ * @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
+ * @param $cellpadding (float) Internal cell padding, if empty uses default cell padding.
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Alexander Escalona Fernández, Nicola Asuni
- * @access public
+ * @public
* @since 4.5.011
*/
public function getNumLines($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0) {
@@ -6449,7 +6497,7 @@ class TCPDF {
/**
* This method return the estimated needed height for print a simple text string in Multicell() method.
* Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
- *
+ * @pre
* // store current object
* $pdf->startTransaction();
* // store starting values
@@ -6482,16 +6530,16 @@ class TCPDF {
* }
* // restore previous object
* $pdf = $pdf->rollbackTransaction();
- *
- * @param float $w Width of cells. If 0, they extend up to the right margin of the page.
- * @param string $txt String for calculating his height
- * @param boolean $reseth if true reset the last cell height (default false).
- * @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width (default true).
- * @param float $cellpadding Internal cell padding, if empty uses default cell padding.
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ *
+ * @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
+ * @param $txt (string) String for calculating his height
+ * @param $reseth (boolean) if true reset the last cell height (default false).
+ * @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
+ * @param $cellpadding (float) Internal cell padding, if empty uses default cell padding.
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Nicola Asuni, Alexander Escalona Fernández
- * @access public
+ * @public
*/
public function getStringHeight($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0) {
// adjust internal padding
@@ -6514,20 +6562,20 @@ class TCPDF {
/**
* This method prints text from the current position.
- * @param float $h Line height
- * @param string $txt String to print
- * @param mixed $link URL or identifier returned by AddLink()
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param string $align Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
- * @param boolean $ln if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
- * @param int $stretch font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
- * @param boolean $firstline if true prints only the first line and return the remaining string.
- * @param boolean $firstblock if true the string is the starting of a line.
- * @param float $maxh maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
- * @param float $wadj first line width will be reduced by this amount (used in HTML mode).
- * @param array $margin margin array of the parent container
+ * @param $h (float) Line height
+ * @param $txt (string) String to print
+ * @param $link (mixed) URL or identifier returned by AddLink()
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $align (string) Allows to center or align the text. Possible values are:- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
+ * @param $ln (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
+ * @param $stretch (int) font stretch mode: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
General font stretching and scaling values will be preserved when possible.
+ * @param $firstline (boolean) if true prints only the first line and return the remaining string.
+ * @param $firstblock (boolean) if true the string is the starting of a line.
+ * @param $maxh (float) maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
+ * @param $wadj (float) first line width will be reduced by this amount (used in HTML mode).
+ * @param $margin (array) margin array of the parent container
* @return mixed Return the number of cells or the remaining string if $firstline = true.
- * @access public
+ * @public
* @since 1.5
*/
public function Write($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='') {
@@ -6570,6 +6618,8 @@ class TCPDF {
$shy_replacement_width = $this->GetCharWidth($shy_replacement);
// max Y
$maxy = $this->y + $maxh - $h - $this->cell_padding['T'] - $this->cell_padding['B'];
+ // page width
+ $pw = $w = $this->w - $this->lMargin - $this->rMargin;
// calculate remaining line width ($w)
if ($this->rtl) {
$w = $this->x - $this->lMargin;
@@ -6748,56 +6798,95 @@ class TCPDF {
} else {
$endspace = 0;
}
- if ($shy) {
- // add hypen (minus symbol) at the end of the line
- $shy_width = $tmp_shy_replacement_width;
- if ($this->rtl) {
- $shy_char_left = $tmp_shy_replacement_char;
- $shy_char_right = '';
- } else {
- $shy_char_left = '';
- $shy_char_right = $tmp_shy_replacement_char;
+ // check the lenght of the next string
+ $strrest = $this->UniArrSubString($uchars, ($sep + $endspace));
+ $nextstr = preg_split('/'.$this->re_space['p'].'/'.$this->re_space['m'], $this->stringTrim($strrest));
+ if (isset($nextstr[0]) AND ($this->GetStringWidth($nextstr[0]) > $pw)) {
+ // truncate the word because do not fit on a full page width
+ $tmpstr = $this->UniArrSubString($uchars, $j, $i);
+ if ($firstline) {
+ $startx = $this->x;
+ $tmparr = array_slice($chars, $j, ($i - $j));
+ if ($rtlmode) {
+ $tmparr = $this->utf8Bidi($tmparr, $tmpstr, $this->tmprtl);
+ }
+ $linew = $this->GetArrStringWidth($tmparr);
+ unset($tmparr);
+ if ($this->rtl) {
+ $this->endlinex = $startx - $linew;
+ } else {
+ $this->endlinex = $startx + $linew;
+ }
+ $w = $linew;
+ $tmpcellpadding = $this->cell_padding;
+ if ($maxh == 0) {
+ $this->SetCellPadding(0);
+ }
}
+ if ($firstblock AND $this->isRTLTextDir()) {
+ $tmpstr = $this->stringRightTrim($tmpstr);
+ }
+ $this->Cell($w, $h, $tmpstr, 0, 1, $align, $fill, $link, $stretch);
+ unset($tmpstr);
+ if ($firstline) {
+ $this->cell_padding = $tmpcellpadding;
+ return ($this->UniArrSubString($uchars, $i));
+ }
+ $j = $i;
+ --$i;
} else {
- $shy_width = 0;
- $shy_char_left = '';
- $shy_char_right = '';
- }
- $tmpstr = $this->UniArrSubString($uchars, $j, ($sep + $endspace));
- if ($firstline) {
- $startx = $this->x;
- $tmparr = array_slice($chars, $j, (($sep + $endspace) - $j));
- if ($rtlmode) {
- $tmparr = $this->utf8Bidi($tmparr, $tmpstr, $this->tmprtl);
- }
- $linew = $this->GetArrStringWidth($tmparr);
- unset($tmparr);
- if ($this->rtl) {
- $this->endlinex = $startx - $linew - $shy_width;
+ // word wrapping
+ if ($shy) {
+ // add hypen (minus symbol) at the end of the line
+ $shy_width = $tmp_shy_replacement_width;
+ if ($this->rtl) {
+ $shy_char_left = $tmp_shy_replacement_char;
+ $shy_char_right = '';
+ } else {
+ $shy_char_left = '';
+ $shy_char_right = $tmp_shy_replacement_char;
+ }
} else {
- $this->endlinex = $startx + $linew + $shy_width;
+ $shy_width = 0;
+ $shy_char_left = '';
+ $shy_char_right = '';
}
- $w = $linew;
- $tmpcellpadding = $this->cell_padding;
- if ($maxh == 0) {
- $this->SetCellPadding(0);
+ $tmpstr = $this->UniArrSubString($uchars, $j, ($sep + $endspace));
+ if ($firstline) {
+ $startx = $this->x;
+ $tmparr = array_slice($chars, $j, (($sep + $endspace) - $j));
+ if ($rtlmode) {
+ $tmparr = $this->utf8Bidi($tmparr, $tmpstr, $this->tmprtl);
+ }
+ $linew = $this->GetArrStringWidth($tmparr);
+ unset($tmparr);
+ if ($this->rtl) {
+ $this->endlinex = $startx - $linew - $shy_width;
+ } else {
+ $this->endlinex = $startx + $linew + $shy_width;
+ }
+ $w = $linew;
+ $tmpcellpadding = $this->cell_padding;
+ if ($maxh == 0) {
+ $this->SetCellPadding(0);
+ }
}
+ // print the line
+ if ($firstblock AND $this->isRTLTextDir()) {
+ $tmpstr = $this->stringRightTrim($tmpstr);
+ }
+ $this->Cell($w, $h, $shy_char_left.$tmpstr.$shy_char_right, 0, 1, $align, $fill, $link, $stretch);
+ unset($tmpstr);
+ if ($firstline) {
+ // return the remaining text
+ $this->cell_padding = $tmpcellpadding;
+ return ($this->UniArrSubString($uchars, ($sep + $endspace)));
+ }
+ $i = $sep;
+ $sep = -1;
+ $shy = false;
+ $j = ($i+1);
}
- // print the line
- if ($firstblock AND $this->isRTLTextDir()) {
- $tmpstr = $this->stringRightTrim($tmpstr);
- }
- $this->Cell($w, $h, $shy_char_left.$tmpstr.$shy_char_right, 0, 1, $align, $fill, $link, $stretch);
- unset($tmpstr);
- if ($firstline) {
- // return the remaining text
- $this->cell_padding = $tmpcellpadding;
- return ($this->UniArrSubString($uchars, ($sep + $endspace)));
- }
- $i = $sep;
- $sep = -1;
- $shy = false;
- $j = ($i+1);
}
// account for margin changes
if ((($this->y + $this->lasth) > $this->PageBreakTrigger) AND (!$this->InFooter)) {
@@ -6893,7 +6982,7 @@ class TCPDF {
/**
* Returns the remaining width between the current position and margins.
* @return int Return the remaining width
- * @access protected
+ * @protected
*/
protected function getRemainingWidth() {
$this->checkPageRegions(0, $this->x, $this->y);
@@ -6906,11 +6995,11 @@ class TCPDF {
/**
* Extract a slice of the $strarr array and return it as string.
- * @param string $strarr The input array of characters.
- * @param int $start the starting element of $strarr.
- * @param int $end first element that will not be returned.
+ * @param $strarr (string) The input array of characters.
+ * @param $start (int) the starting element of $strarr.
+ * @param $end (int) first element that will not be returned.
* @return Return part of a string
- * @access public
+ * @public
*/
public function UTF8ArrSubString($strarr, $start='', $end='') {
if (strlen($start) == 0) {
@@ -6928,11 +7017,11 @@ class TCPDF {
/**
* Extract a slice of the $uniarr array and return it as string.
- * @param string $uniarr The input array of characters.
- * @param int $start the starting element of $strarr.
- * @param int $end first element that will not be returned.
+ * @param $uniarr (string) The input array of characters.
+ * @param $start (int) the starting element of $strarr.
+ * @param $end (int) first element that will not be returned.
* @return Return part of a string
- * @access public
+ * @public
* @since 4.5.037 (2009-04-07)
*/
public function UniArrSubString($uniarr, $start='', $end='') {
@@ -6951,9 +7040,9 @@ class TCPDF {
/**
* Convert an array of UTF8 values to array of unicode characters
- * @param string $ta The input array of UTF8 values.
+ * @param $ta (string) The input array of UTF8 values.
* @return Return array of unicode characters
- * @access public
+ * @public
* @since 4.5.037 (2009-04-07)
*/
public function UTF8ArrayToUniArray($ta) {
@@ -6962,10 +7051,10 @@ class TCPDF {
/**
* Returns the unicode caracter specified by UTF-8 value
- * @param int $c UTF-8 value
+ * @param $c (int) UTF-8 value
* @return Returns the specified character.
* @author Miguel Perez, Nicola Asuni
- * @access public
+ * @public
* @since 2.3.000 (2008-03-05)
*/
public function unichr($c) {
@@ -6990,8 +7079,8 @@ class TCPDF {
/**
* Return the image type given the file name or array returned by getimagesize() function.
- * @param string $imgfile image file name
- * @param array $iminfo array of image information returned by getimagesize() function.
+ * @param $imgfile (string) image file name
+ * @param $iminfo (array) array of image information returned by getimagesize() function.
* @return string image type
* @since 4.8.017 (2009-11-27)
*/
@@ -7017,12 +7106,12 @@ class TCPDF {
/**
* Set the block dimensions accounting for page breaks and page/column fitting
- * @param float $w width
- * @param float $h height
- * @param float $x X coordinate
- * @param float $y Y coodiante
- * @param boolean $fitonpage if true the block is resized to not exceed page dimensions.
- * @access protected
+ * @param $w (float) width
+ * @param $h (float) height
+ * @param $x (float) X coordinate
+ * @param $y (float) Y coodiante
+ * @param $fitonpage (boolean) if true the block is resized to not exceed page dimensions.
+ * @protected
* @since 5.5.009 (2010-07-05)
*/
protected function fitBlock(&$w, &$h, &$x, &$y, $fitonpage=false) {
@@ -7089,25 +7178,25 @@ class TCPDF {
* The format can be specified explicitly or inferred from the file extension.
* It is possible to put a link on the image.
* Remark: if an image is used several times, only one copy will be embedded in the file.
- * @param string $file Name of the file containing the image or a '@' character followed by the image data string.
- * @param float $x Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
- * @param float $y Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
- * @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
- * @param mixed $link URL or identifier returned by AddLink().
- * @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- * @param mixed $resize If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).
- * @param int $dpi dot-per-inch resolution used on resize
- * @param string $palign Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
- * @param boolean $ismask true if this image is a mask, false otherwise
- * @param mixed $imgmask image object returned by this function or false
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param boolean $fitbox If true scale image dimensions proportionally to fit within the ($w, $h) box.
- * @param boolean $hidden if true do not display the image.
- * @param boolean $fitonpage if true the image is resized to not exceed page dimensions.
+ * @param $file (string) Name of the file containing the image or a '@' character followed by the image data string.
+ * @param $x (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
+ * @param $y (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
+ * @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
+ * @param $resize (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).
+ * @param $dpi (int) dot-per-inch resolution used on resize
+ * @param $palign (string) Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
+ * @param $ismask (boolean) true if this image is a mask, false otherwise
+ * @param $imgmask (mixed) image object returned by this function or false
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $fitbox (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).
+ * @param $hidden (boolean) if true do not display the image.
+ * @param $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
* @return image information
- * @access public
+ * @public
* @since 1.1
*/
public function Image($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false) {
@@ -7123,7 +7212,7 @@ class TCPDF {
// check if we are passing an image as file or string
if ($file{0} === '@') { // image from string
$imgdata = substr($file, 1);
- $file = tempnam(K_PATH_CACHE, 'img_');
+ $file = K_PATH_CACHE.'img_'.md5($imgdata);
$fp = fopen($file, 'w');
fwrite($fp, $imgdata);
fclose($fp);
@@ -7154,9 +7243,9 @@ class TCPDF {
curl_setopt($cs, CURLOPT_TIMEOUT, 30);
$imgdata = curl_exec($cs);
curl_close($cs);
- if($imgdata !== FALSE) {
+ if ($imgdata !== FALSE) {
// copy image to cache
- $file = tempnam(K_PATH_CACHE, 'img_');
+ $file = K_PATH_CACHE.'img_'.md5($imgdata);
$fp = fopen($file, 'w');
fwrite($fp, $imgdata);
fclose($fp);
@@ -7177,7 +7266,14 @@ class TCPDF {
}
}
if ($imsize === FALSE) {
- $this->Error('[Image] Unable to get image: '.$file);
+ if (substr($file, 0, -34) == K_PATH_CACHE.'msk') { // mask file
+ // get measures from specified data
+ $pw = $this->getHTMLUnitToUnits($w, 0, $this->pdfunit, true) * $this->imgscale * $this->k;
+ $ph = $this->getHTMLUnitToUnits($h, 0, $this->pdfunit, true) * $this->imgscale * $this->k;
+ $imsize = array($pw, $ph);
+ } else {
+ $this->Error('[Image] Unable to get image: '.$file);
+ }
}
// get original image width and height in pixels
list($pixw, $pixh) = $imsize;
@@ -7190,12 +7286,63 @@ class TCPDF {
$w = $h * $pixw / $pixh;
} elseif ($h <= 0) {
$h = $w * $pixh / $pixw;
- } elseif ($fitbox AND ($w > 0) AND ($h > 0)) {
+ } elseif (($fitbox !== false) AND ($w > 0) AND ($h > 0)) {
+ if (strlen($fitbox) !== 2) {
+ // set default alignment
+ $fitbox = '--';
+ }
// scale image dimensions proportionally to fit within the ($w, $h) box
if ((($w * $pixh) / ($h * $pixw)) < 1) {
+ // store current height
+ $oldh = $h;
+ // calculate new height
$h = $w * $pixh / $pixw;
+ // height difference
+ $hdiff = ($oldh - $h);
+ // vertical alignment
+ switch (strtoupper($fitbox{1})) {
+ case 'T': {
+ break;
+ }
+ case 'M': {
+ $y += ($hdiff / 2);
+ break;
+ }
+ case 'B': {
+ $y += $hdiff;
+ break;
+ }
+ }
} else {
+ // store current width
+ $oldw = $w;
+ // calculate new width
$w = $h * $pixw / $pixh;
+ // width difference
+ $wdiff = ($oldw - $w);
+ // horizontal alignment
+ switch (strtoupper($fitbox{0})) {
+ case 'L': {
+ if ($this->rtl) {
+ $x -= $wdiff;
+ }
+ break;
+ }
+ case 'C': {
+ if ($this->rtl) {
+ $x -= ($wdiff / 2);
+ } else {
+ $x += ($wdiff / 2);
+ }
+ break;
+ }
+ case 'R': {
+ if (!$this->rtl) {
+ $x += $wdiff;
+ }
+ break;
+ }
+ }
}
}
// fit the image on available space
@@ -7217,10 +7364,32 @@ class TCPDF {
$newimage = false;
// get existing image data
$info = $this->getImageBuffer($file);
- // check if the newer image is larger
- $oldsize = ($info['w'] * $info['h']);
- if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
- $newimage = true;
+ if (substr($file, 0, -34) != K_PATH_CACHE.'msk') {
+ // check if the newer image is larger
+ $oldsize = ($info['w'] * $info['h']);
+ if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
+ $newimage = true;
+ }
+ }
+ } elseif (substr($file, 0, -34) != K_PATH_CACHE.'msk') {
+ // check for cached images with alpha channel
+ $filehash = md5($file);
+ $tempfile_plain = K_PATH_CACHE.'mskp_'.$filehash;
+ $tempfile_alpha = K_PATH_CACHE.'mska_'.$filehash;
+ if (in_array($tempfile_plain, $this->imagekeys)) {
+ // get existing image data
+ $info = $this->getImageBuffer($tempfile_plain);
+ // check if the newer image is larger
+ $oldsize = ($info['w'] * $info['h']);
+ if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
+ $newimage = true;
+ } else {
+ $newimage = false;
+ // embed mask image
+ $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false);
+ // embed image, masked with previously embedded mask
+ return $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask);
+ }
}
}
if ($newimage) {
@@ -7242,7 +7411,7 @@ class TCPDF {
// TCPDF image functions
$info = $this->$mtd($file);
if ($info == 'pngalpha') {
- return $this->ImagePngAlpha($file, $x, $y, $pixw, $pixh, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign);
+ return $this->ImagePngAlpha($file, $x, $y, $pixw, $pixh, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign, $filehash);
}
}
if (!$info) {
@@ -7425,11 +7594,11 @@ class TCPDF {
/**
* Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist)
- * @param boolean $mqr FALSE for off, TRUE for on.
+ * @param $mqr (boolean) FALSE for off, TRUE for on.
* @since 4.6.025 (2009-08-17)
*/
public function set_mqr($mqr) {
- if(!defined('PHP_VERSION_ID')) {
+ if (!defined('PHP_VERSION_ID')) {
$version = PHP_VERSION;
define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4}));
}
@@ -7444,7 +7613,7 @@ class TCPDF {
* @since 4.6.025 (2009-08-17)
*/
public function get_mqr() {
- if(!defined('PHP_VERSION_ID')) {
+ if (!defined('PHP_VERSION_ID')) {
$version = PHP_VERSION;
define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4}));
}
@@ -7457,10 +7626,9 @@ class TCPDF {
/**
* Convert the loaded image to a JPEG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
- * @param string $file Image file name.
- * @param image $image Image object.
+ * @param $image (image) Image object.
* return image JPEG image object.
- * @access protected
+ * @protected
*/
protected function _toJPEG($image) {
$tempname = tempnam(K_PATH_CACHE, 'jpg_');
@@ -7475,10 +7643,9 @@ class TCPDF {
/**
* Convert the loaded image to a PNG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
- * @param string $file Image file name.
- * @param image $image Image object.
+ * @param $image (image) Image object.
* return image PNG image object.
- * @access protected
+ * @protected
* @since 4.9.016 (2010-04-20)
*/
protected function _toPNG($image) {
@@ -7499,10 +7666,10 @@ class TCPDF {
/**
* Set the transparency for the given GD image.
- * @param image $new_image GD image object
- * @param image $image GD image object.
+ * @param $new_image (image) GD image object
+ * @param $image (image) GD image object.
* return GD image object.
- * @access protected
+ * @protected
* @since 4.9.016 (2010-04-20)
*/
protected function _setGDImageTransparency($new_image, $image) {
@@ -7522,9 +7689,9 @@ class TCPDF {
/**
* Extract info from a JPEG file without using the GD library.
- * @param string $file image file to parse
+ * @param $file (string) image file to parse
* @return array structure containing the image data
- * @access protected
+ * @protected
*/
protected function _parsejpeg($file) {
$a = getimagesize($file);
@@ -7548,9 +7715,9 @@ class TCPDF {
/**
* Extract info from a PNG file without using the GD library.
- * @param string $file image file to parse
+ * @param $file (string) image file to parse
* @return array structure containing the image data
- * @access protected
+ * @protected
*/
protected function _parsepng($file) {
$f = fopen($file, 'rb');
@@ -7650,11 +7817,11 @@ class TCPDF {
/**
* Binary-safe and URL-safe file read.
* Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
- * @param resource $handle
- * @param int $length
+ * @param $handle (resource)
+ * @param $length (int)
* @return Returns the read string or FALSE in case of error.
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 4.5.027 (2009-03-16)
*/
protected function rfread($handle, $length) {
@@ -7671,29 +7838,33 @@ class TCPDF {
/**
* Extract info from a PNG image with alpha channel using the GD library.
- * @param string $file Name of the file containing the image.
- * @param float $x Abscissa of the upper-left corner.
- * @param float $y Ordinate of the upper-left corner.
- * @param float $wpx Original width of the image in pixels.
- * @param float $hpx original height of the image in pixels.
- * @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
- * @param mixed $link URL or identifier returned by AddLink().
- * @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- * @param boolean $resize If true resize (reduce) the image to fit $w and $h (requires GD library).
- * @param int $dpi dot-per-inch resolution used on resize
- * @param string $palign Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
+ * @param $file (string) Name of the file containing the image.
+ * @param $x (float) Abscissa of the upper-left corner.
+ * @param $y (float) Ordinate of the upper-left corner.
+ * @param $wpx (float) Original width of the image in pixels.
+ * @param $hpx (float) original height of the image in pixels.
+ * @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
+ * @param $resize (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library).
+ * @param $dpi (int) dot-per-inch resolution used on resize
+ * @param $palign (string) Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
+ * @param $filehash (string) File hash used to build unique file names.
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 4.3.007 (2008-12-04)
* @see Image()
*/
- protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign) {
+ protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='') {
+ if (empty($filehash)) {
+ $filehash = md5($file);
+ }
// create temp image file (without alpha channel)
- $tempfile_plain = tempnam(K_PATH_CACHE, 'mskp_');
+ $tempfile_plain = K_PATH_CACHE.'mskp_'.$filehash;
// create temp alpha file
- $tempfile_alpha = tempnam(K_PATH_CACHE, 'mska_');
+ $tempfile_alpha = K_PATH_CACHE.'mska_'.$filehash;
if (extension_loaded('imagick')) { // ImageMagick
// ImageMagick library
$img = new Imagick();
@@ -7746,8 +7917,8 @@ class TCPDF {
/**
* Correct the gamma value to be used with GD library
- * @param float $v the gamma value to be corrected
- * @access protected
+ * @param $v (float) the gamma value to be corrected
+ * @protected
* @since 4.3.007 (2008-12-04)
*/
protected function getGDgamma($v) {
@@ -7757,9 +7928,9 @@ class TCPDF {
/**
* Performs a line break.
* The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
- * @param float $h The height of the break. By default, the value equals the height of the last printed cell.
- * @param boolean $cell if true add the current left (or right o for RTL) padding to the X coordinate
- * @access public
+ * @param $h (float) The height of the break. By default, the value equals the height of the last printed cell.
+ * @param $cell (boolean) if true add the current left (or right o for RTL) padding to the X coordinate
+ * @public
* @since 1.0
* @see Cell()
*/
@@ -7794,7 +7965,7 @@ class TCPDF {
* Returns the relative X value of current position.
* The value is relative to the left border for LTR languages and to the right border for RTL languages.
* @return float
- * @access public
+ * @public
* @since 1.2
* @see SetX(), GetY(), SetY()
*/
@@ -7810,7 +7981,7 @@ class TCPDF {
/**
* Returns the absolute X value of current position.
* @return float
- * @access public
+ * @public
* @since 1.2
* @see SetX(), GetY(), SetY()
*/
@@ -7821,7 +7992,7 @@ class TCPDF {
/**
* Returns the ordinate of the current position.
* @return float
- * @access public
+ * @public
* @since 1.0
* @see SetY(), GetX(), SetX()
*/
@@ -7832,9 +8003,9 @@ class TCPDF {
/**
* Defines the abscissa of the current position.
* If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
- * @param float $x The value of the abscissa.
- * @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
- * @access public
+ * @param $x (float) The value of the abscissa.
+ * @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
+ * @public
* @since 1.2
* @see GetX(), GetY(), SetY(), SetXY()
*/
@@ -7863,10 +8034,10 @@ class TCPDF {
/**
* Moves the current abscissa back to the left margin and sets the ordinate.
* If the passed value is negative, it is relative to the bottom of the page.
- * @param float $y The value of the ordinate.
- * @param bool $resetx if true (default) reset the X position.
- * @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
- * @access public
+ * @param $y (float) The value of the ordinate.
+ * @param $resetx (bool) if true (default) reset the X position.
+ * @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
+ * @public
* @since 1.0
* @see GetX(), GetY(), SetY(), SetXY()
*/
@@ -7895,10 +8066,10 @@ class TCPDF {
/**
* Defines the abscissa and ordinate of the current position.
* If the passed values are negative, they are relative respectively to the right and bottom of the page.
- * @param float $x The value of the abscissa.
- * @param float $y The value of the ordinate.
- * @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
- * @access public
+ * @param $x (float) The value of the abscissa.
+ * @param $y (float) The value of the ordinate.
+ * @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
+ * @public
* @since 1.2
* @see SetX(), SetY()
*/
@@ -7911,9 +8082,9 @@ class TCPDF {
* Send the document to a given destination: string, local file or browser.
* In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
* The method first calls Close() if necessary to terminate the document.
- * @param string $name The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.
- * @param string $dest Destination where to send the document. It can take one of the following values:- I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
- D: send to the browser and force a file download with the name given by name.
- F: save to a local server file with the name given by name.
- S: return the document as a string (name is ignored).
- FI: equivalent to F + I option
- FD: equivalent to F + D option
- E: return the document as base64 mime multi-part email attachment (RFC 2045)
- * @access public
+ * @param $name (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.
+ * @param $dest (string) Destination where to send the document. It can take one of the following values:- I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
- D: send to the browser and force a file download with the name given by name.
- F: save to a local server file with the name given by name.
- S: return the document as a string (name is ignored).
- FI: equivalent to F + I option
- FD: equivalent to F + D option
- E: return the document as base64 mime multi-part email attachment (RFC 2045)
+ * @public
* @since 1.0
* @see Close()
*/
@@ -8030,10 +8201,14 @@ class TCPDF {
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');
// force download dialog
- header('Content-Type: application/force-download');
- header('Content-Type: application/octet-stream', false);
- header('Content-Type: application/download', false);
- header('Content-Type: application/pdf', false);
+ if (strpos(php_sapi_name(), 'cgi') === false) {
+ header('Content-Type: application/force-download');
+ header('Content-Type: application/octet-stream', false);
+ header('Content-Type: application/download', false);
+ header('Content-Type: application/pdf', false);
+ } else {
+ header('Content-Type: application/pdf');
+ }
// use the Content-Disposition header to supply a recommended filename
header('Content-Disposition: attachment; filename="'.basename($name).'";');
header('Content-Transfer-Encoding: binary');
@@ -8080,10 +8255,14 @@ class TCPDF {
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');
// force download dialog
- header('Content-Type: application/force-download');
- header('Content-Type: application/octet-stream', false);
- header('Content-Type: application/download', false);
- header('Content-Type: application/pdf', false);
+ if (strpos(php_sapi_name(), 'cgi') === false) {
+ header('Content-Type: application/force-download');
+ header('Content-Type: application/octet-stream', false);
+ header('Content-Type: application/download', false);
+ header('Content-Type: application/pdf', false);
+ } else {
+ header('Content-Type: application/pdf');
+ }
// use the Content-Disposition header to supply a recommended filename
header('Content-Disposition: attachment; filename="'.basename($name).'";');
header('Content-Transfer-Encoding: binary');
@@ -8116,9 +8295,9 @@ class TCPDF {
/**
* Unset all class variables except the following critical variables: internal_encoding, state, bufferlen, buffer and diskcache.
- * @param boolean $destroyall if true destroys all class variables, otherwise preserves critical variables.
- * @param boolean $preserve_objcopy if true preserves the objcopy variable
- * @access public
+ * @param $destroyall (boolean) if true destroys all class variables, otherwise preserves critical variables.
+ * @param $preserve_objcopy (boolean) if true preserves the objcopy variable
+ * @public
* @since 4.5.016 (2009-02-24)
*/
public function _destroy($destroyall=false, $preserve_objcopy=false) {
@@ -8147,7 +8326,7 @@ class TCPDF {
/**
* Check for locale-related bug
- * @access protected
+ * @protected
*/
protected function _dochecks() {
//Check for locale-related bug
@@ -8163,7 +8342,7 @@ class TCPDF {
/**
* Return fonts path
* @return string
- * @access protected
+ * @protected
*/
protected function _getfontpath() {
if (!defined('K_PATH_FONTS') AND is_dir(dirname(__FILE__).'/fonts')) {
@@ -8174,7 +8353,7 @@ class TCPDF {
/**
* Output pages.
- * @access protected
+ * @protected
*/
protected function _putpages() {
$nb = $this->numpages;
@@ -8205,7 +8384,7 @@ class TCPDF {
for ($n=1; $n <= $nb; ++$n) {
$temppage = $this->getPageBuffer($n);
if (!empty($this->pagegroups)) {
- if(isset($this->newpagegroup[$n])) {
+ if (isset($this->newpagegroup[$n])) {
$pagegroupnum = 0;
}
++$pagegroupnum;
@@ -8379,8 +8558,8 @@ class TCPDF {
/**
* Output references to page annotations
- * @param int $n page number
- * @access protected
+ * @param $n (int) page number
+ * @protected
* @author Nicola Asuni
* @since 4.7.000 (2008-08-29)
* @deprecated
@@ -8391,9 +8570,9 @@ class TCPDF {
/**
* Get references to page annotations.
- * @param int $n page number
+ * @param $n (int) page number
* @return string
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 5.0.010 (2010-05-17)
*/
@@ -8429,7 +8608,7 @@ class TCPDF {
* Output annotations objects for all pages.
* !!! THIS METHOD IS NOT YET COMPLETED !!!
* See section 12.5 of PDF 32000_2008 reference.
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 4.0.018 (2008-08-06)
*/
@@ -8692,7 +8871,7 @@ class TCPDF {
break;
}
case 'link': {
- if(is_string($pl['txt'])) {
+ if (is_string($pl['txt'])) {
// external URI link
$annots .= ' /A <_datastring($this->unhtmlentities($pl['txt']), $annot_obj_id).'>>';
} else {
@@ -9038,11 +9217,11 @@ class TCPDF {
/**
* Put appearance streams XObject used to define annotation's appearance states
- * @param int $w annotation width
- * @param int $h annotation height
- * @param string $stream appearance stream
+ * @param $w (int) annotation width
+ * @param $h (int) annotation height
+ * @param $stream (string) appearance stream
* @return int object ID
- * @access protected
+ * @protected
* @since 4.8.001 (2009-09-09)
*/
protected function _putAPXObject($w=0, $h=0, $stream='') {
@@ -9079,11 +9258,11 @@ class TCPDF {
/**
* Get ULONG from string (Big Endian 32-bit unsigned integer).
- * @param string $str string from where to extract value
- * @param int $offset point from where to read the data
+ * @param $str (string) string from where to extract value
+ * @param $offset (int) point from where to read the data
* @return int 32 bit value
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getULONG(&$str, &$offset) {
@@ -9094,11 +9273,11 @@ class TCPDF {
/**
* Get USHORT from string (Big Endian 16-bit unsigned integer).
- * @param string $str string from where to extract value
- * @param int $offset point from where to read the data
+ * @param $str (string) string from where to extract value
+ * @param $offset (int) point from where to read the data
* @return int 16 bit value
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getUSHORT(&$str, &$offset) {
@@ -9109,11 +9288,11 @@ class TCPDF {
/**
* Get SHORT from string (Big Endian 16-bit signed integer).
- * @param string $str string from where to extract value
- * @param int $offset point from where to read the data
+ * @param $str (string) string from where to extract value
+ * @param $offset (int) point from where to read the data
* @return int 16 bit value
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getSHORT(&$str, &$offset) {
@@ -9124,11 +9303,11 @@ class TCPDF {
/**
* Get BYTE from string (8-bit unsigned integer).
- * @param string $str string from where to extract value
- * @param int $offset point from where to read the data
+ * @param $str (string) string from where to extract value
+ * @param $offset (int) point from where to read the data
* @return int 8 bit value
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getBYTE(&$str, &$offset) {
@@ -9139,11 +9318,11 @@ class TCPDF {
/**
* Returns a subset of the TrueType font data without the unused glyphs.
- * @param string $font TrueType font data
- * @param array $subsetchars array of used characters (the glyphs to keep)
+ * @param $font (string) TrueType font data.
+ * @param $subsetchars (array) Array of used characters (the glyphs to keep).
* @return string a subset of TrueType font data without the unused glyphs
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getTrueTypeFontSubset($font, $subsetchars) {
@@ -9392,7 +9571,7 @@ class TCPDF {
}
}
// array of table names to preserve (loca and glyf tables will be added later)
- //$table_names = array ('cmap', 'head', 'hhea', 'hmtx', 'maxp', 'name', 'OS/2', 'post', 'cvt ', 'fpgm', 'prep');
+ // additional maps includes: 'cmap', 'head', 'name', 'OS/2', 'post';
// the cmap table is not needed and shall not be present, since the mapping from character codes to glyph descriptions is provided separately
$table_names = array ('head', 'hhea', 'hmtx', 'maxp', 'cvt ', 'fpgm', 'prep'); // minimum required table names
// get the tables to preserve
@@ -9470,11 +9649,11 @@ class TCPDF {
/**
* Returs the checksum of a TTF table.
- * @param string $table table to check
- * @param int $length lenght of table in bytes
+ * @param $table (string) table to check
+ * @param $length (int) lenght of table in bytes
* @return int checksum
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 5.2.000 (2010-06-02)
*/
protected function _getTTFtableChecksum($table, $length) {
@@ -9492,11 +9671,11 @@ class TCPDF {
/**
* Outputs font widths
- * @param array $font font data
- * @param int $cidoffset offset for CID values
+ * @param $font (array) font data
+ * @param $cidoffset (int) offset for CID values
* @return PDF command string for font widths
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 4.4.000 (2008-12-07)
*/
protected function _putfontwidths($font, $cidoffset=0) {
@@ -9596,7 +9775,7 @@ class TCPDF {
/**
* Output fonts.
* @author Nicola Asuni
- * @access protected
+ * @protected
*/
protected function _putfonts() {
$nf = $this->n;
@@ -9724,7 +9903,7 @@ class TCPDF {
$this->_newobj();
$s = '< $fdv) {
- if(is_float($fdv)) {
+ if (is_float($fdv)) {
$fdv = sprintf('%.3F', $fdv);
}
$s .= ' /'.$fdk.' '.$fdv.'';
@@ -9749,8 +9928,8 @@ class TCPDF {
/**
* Adds unicode fonts.
* Based on PDF Reference 1.3 (section 5)
- * @param array $font font data
- * @access protected
+ * @param $font (array) font data
+ * @protected
* @author Nicola Asuni
* @since 1.52.0.TC005 (2005-01-05)
*/
@@ -10085,7 +10264,7 @@ class TCPDF {
$out = '<< /Type /FontDescriptor';
$out .= ' /FontName /'.$fontname;
foreach ($font['desc'] as $key => $value) {
- if(is_float($value)) {
+ if (is_float($value)) {
$value = sprintf('%.3F', $value);
}
$out .= ' /'.$key.' '.$value;
@@ -10136,8 +10315,8 @@ class TCPDF {
/**
* Output CID-0 fonts.
* A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
- * @param array $font font data
- * @access protected
+ * @param $font (array) font data
+ * @protected
* @author Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira
* @since 3.2.000 (2008-06-23)
*/
@@ -10196,7 +10375,7 @@ class TCPDF {
$s = '< $v) {
if ($k != 'Style') {
- if(is_float($v)) {
+ if (is_float($v)) {
$v = sprintf('%.3F', $v);
}
$s .= ' /'.$k.' '.$v.'';
@@ -10209,7 +10388,7 @@ class TCPDF {
/**
* Output images.
- * @access protected
+ * @protected
*/
protected function _putimages() {
$filter = ($this->compress) ? '/Filter /FlateDecode ' : '';
@@ -10267,7 +10446,7 @@ class TCPDF {
* Output Form XObjects Templates.
* @author Nicola Asuni
* @since 5.8.017 (2010-08-24)
- * @access protected
+ * @protected
* @see startTemplate(), endTemplate(), printTemplate()
*/
protected function _putxobjects() {
@@ -10319,7 +10498,7 @@ class TCPDF {
/**
* Output Spot Colors Resources.
- * @access protected
+ * @protected
* @since 4.0.024 (2008-09-12)
*/
protected function _putspotcolors() {
@@ -10339,7 +10518,7 @@ class TCPDF {
/**
* Return XObjects Dictionary.
* @return string XObjects dictionary
- * @access protected
+ * @protected
* @since 5.8.014 (2010-08-23)
*/
protected function _getxobjectdict() {
@@ -10352,7 +10531,7 @@ class TCPDF {
/**
* Output Resources Dictionary.
- * @access protected
+ * @protected
*/
protected function _putresourcedict() {
$out = $this->_getobj(2)."\n";
@@ -10367,7 +10546,9 @@ class TCPDF {
$out .= $this->_getxobjectdict();
$out .= ' >>';
// visibility
- $out .= ' /Properties <n_ocg_print.' 0 R /OC2 '.$this->n_ocg_view.' 0 R>>';
+ if ($this->pdflayers) {
+ $out .= ' /Properties <n_ocg_print.' 0 R /OC2 '.$this->n_ocg_view.' 0 R>>';
+ }
// transparency
$out .= ' /ExtGState <<';
foreach ($this->extgstates as $k => $extgstate) {
@@ -10410,7 +10591,7 @@ class TCPDF {
/**
* Output Resources.
- * @access protected
+ * @protected
*/
protected function _putresources() {
$this->_putextgstates();
@@ -10432,11 +10613,16 @@ class TCPDF {
* Adds some Metadata information (Document Information Dictionary)
* (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
* @return int object id
- * @access protected
+ * @protected
*/
protected function _putinfo() {
$oid = $this->_newobj();
$out = '<<';
+ // store current isunicode value
+ $prev_isunicode = $this->isunicode;
+ if ($this->docinfounicode) {
+ $this->isunicode = true;
+ }
if (!$this->empty_string($this->title)) {
// The document's title.
$out .= ' /Title '.$this->_textstring($this->title, $oid);
@@ -10457,6 +10643,8 @@ class TCPDF {
// If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted.
$out .= ' /Creator '.$this->_textstring($this->creator, $oid);
}
+ // restore previous isunicode value
+ $this->isunicode = $prev_isunicode;
// default producer
$out .= ' /Producer '.$this->_textstring("\x54\x43\x50\x44\x46\x20".$this->tcpdf_version."\x20\x28\x68\x74\x74\x70\x3a\x2f\x2f\x77\x77\x77\x2e\x74\x63\x70\x64\x66\x2e\x6f\x72\x67\x29", $oid);
// The date and time the document was created, in human-readable form
@@ -10474,7 +10662,7 @@ class TCPDF {
/**
* Output Catalog.
* @return int object id
- * @access protected
+ * @protected
*/
protected function _putcatalog() {
$oid = $this->_newobj();
@@ -10508,10 +10696,12 @@ class TCPDF {
$out .= ' /PageMode /UseOutlines';
}
$out .= ' '.$this->_putviewerpreferences();
- $p = $this->n_ocg_print.' 0 R';
- $v = $this->n_ocg_view.' 0 R';
- $as = '<< /Event /Print /OCGs ['.$p.' '.$v.'] /Category [/Print] >> << /Event /View /OCGs ['.$p.' '.$v.'] /Category [/View] >>';
- $out .= ' /OCProperties << /OCGs ['.$p.' '.$v.'] /D << /ON ['.$p.'] /OFF ['.$v.'] /AS ['.$as.'] >> >>';
+ if ($this->pdflayers) {
+ $p = $this->n_ocg_print.' 0 R';
+ $v = $this->n_ocg_view.' 0 R';
+ $as = '<< /Event /Print /OCGs ['.$p.' '.$v.'] /Category [/Print] >> << /Event /View /OCGs ['.$p.' '.$v.'] /Category [/View] >>';
+ $out .= ' /OCProperties << /OCGs ['.$p.' '.$v.'] /D << /ON ['.$p.'] /OFF ['.$v.'] /AS ['.$as.'] >> >>';
+ }
// AcroForm
if (!empty($this->form_obj_id) OR ($this->sign AND isset($this->signature_data['cert_type']))) {
$out .= ' /AcroForm <<';
@@ -10570,7 +10760,7 @@ class TCPDF {
* @return string for viewer preferences
* @author Nicola asuni
* @since 3.1.000 (2008-06-09)
- * @access protected
+ * @protected
*/
protected function _putviewerpreferences() {
$out = '/ViewerPreferences <<';
@@ -10641,7 +10831,7 @@ class TCPDF {
/**
* Output PDF header.
- * @access protected
+ * @protected
*/
protected function _putheader() {
$this->_out('%PDF-'.$this->PDFVersion);
@@ -10649,7 +10839,7 @@ class TCPDF {
/**
* Output end of document (EOF).
- * @access protected
+ * @protected
*/
protected function _enddoc() {
$this->state = 1;
@@ -10686,6 +10876,9 @@ class TCPDF {
$this->_out('0 '.($this->n + 1));
$this->_out('0000000000 65535 f ');
for ($i=1; $i <= $this->n; ++$i) {
+ if (!isset($this->offsets[$i]) AND ($i > 1)) {
+ $this->offsets[$i] = $this->offsets[($i - 1)];
+ }
$this->_out(sprintf('%010d 00000 n ', $this->offsets[$i]));
}
// TRAILER
@@ -10718,9 +10911,9 @@ class TCPDF {
/**
* Initialize a new page.
- * @param string $orientation page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
- * @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- * @access protected
+ * @param $orientation (string) page orientation. Possible values are (case insensitive):- P or PORTRAIT (default)
- L or LANDSCAPE
+ * @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
+ * @protected
* @see getPageSizeFromFormat(), setPageFormat()
*/
protected function _beginpage($orientation='', $format='') {
@@ -10765,7 +10958,7 @@ class TCPDF {
/**
* Mark end of page.
- * @access protected
+ * @protected
*/
protected function _endpage() {
$this->setVisibility('all');
@@ -10775,7 +10968,7 @@ class TCPDF {
/**
* Begin a new object and return the object number.
* @return int object number
- * @access protected
+ * @protected
*/
protected function _newobj() {
$this->_out($this->_getobj());
@@ -10784,9 +10977,9 @@ class TCPDF {
/**
* Return the starting object string for the selected object ID.
- * @param int $objid Object ID (leave empty to get a new ID).
+ * @param $objid (int) Object ID (leave empty to get a new ID).
* @return string the starting object string
- * @access protected
+ * @protected
* @since 5.8.009 (2010-08-20)
*/
protected function _getobj($objid='') {
@@ -10800,10 +10993,10 @@ class TCPDF {
/**
* Underline text.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param string $txt text to underline
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $txt (string) text to underline
+ * @protected
*/
protected function _dounderline($x, $y, $txt) {
$w = $this->GetStringWidth($txt);
@@ -10812,10 +11005,10 @@ class TCPDF {
/**
* Underline for rectangular text area.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param int $w width to underline
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $w (int) width to underline
+ * @protected
* @since 4.8.008 (2009-09-29)
*/
protected function _dounderlinew($x, $y, $w) {
@@ -10825,10 +11018,10 @@ class TCPDF {
/**
* Line through text.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param string $txt text to linethrough
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $txt (string) text to linethrough
+ * @protected
*/
protected function _dolinethrough($x, $y, $txt) {
$w = $this->GetStringWidth($txt);
@@ -10837,10 +11030,10 @@ class TCPDF {
/**
* Line through for rectangular text area.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param string $txt text to linethrough
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $w (int) line lenght (width)
+ * @protected
* @since 4.9.008 (2009-09-29)
*/
protected function _dolinethroughw($x, $y, $w) {
@@ -10850,10 +11043,10 @@ class TCPDF {
/**
* Overline text.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param string $txt text to overline
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $txt (string) text to overline
+ * @protected
* @since 4.9.015 (2010-04-19)
*/
protected function _dooverline($x, $y, $txt) {
@@ -10863,10 +11056,10 @@ class TCPDF {
/**
* Overline for rectangular text area.
- * @param int $x X coordinate
- * @param int $y Y coordinate
- * @param int $w width to overline
- * @access protected
+ * @param $x (int) X coordinate
+ * @param $y (int) Y coordinate
+ * @param $w (int) width to overline
+ * @protected
* @since 4.9.015 (2010-04-19)
*/
protected function _dooverlinew($x, $y, $w) {
@@ -10877,9 +11070,9 @@ class TCPDF {
/**
* Read a 4-byte (32 bit) integer from file.
- * @param string $f file name.
+ * @param $f (string) file name.
* @return 4-byte integer
- * @access protected
+ * @protected
*/
protected function _freadint($f) {
$a = unpack('Ni', fread($f, 4));
@@ -10888,9 +11081,9 @@ class TCPDF {
/**
* Add "\" before "\", "(" and ")"
- * @param string $s string to escape.
+ * @param $s (string) string to escape.
* @return string escaped string.
- * @access protected
+ * @protected
*/
protected function _escape($s) {
// the chr(13) substitution fixes the Bugs item #1421290.
@@ -10899,10 +11092,10 @@ class TCPDF {
/**
* Format a data string for meta information
- * @param string $s data string to escape.
- * @param int $n object ID
+ * @param $s (string) data string to escape.
+ * @param $n (int) object ID
* @return string escaped string.
- * @access protected
+ * @protected
*/
protected function _datastring($s, $n=0) {
if ($n == 0) {
@@ -10914,9 +11107,9 @@ class TCPDF {
/**
* Returns a formatted date for meta information
- * @param int $n object ID
+ * @param $n (int) object ID
* @return string escaped date string.
- * @access protected
+ * @protected
* @since 4.6.028 (2009-08-25)
*/
protected function _datestring($n=0) {
@@ -10926,10 +11119,10 @@ class TCPDF {
/**
* Format a text string for meta information
- * @param string $s string to escape.
- * @param int $n object ID
+ * @param $s (string) string to escape.
+ * @param $n (int) object ID
* @return string escaped string.
- * @access protected
+ * @protected
*/
protected function _textstring($s, $n=0) {
if ($this->isunicode) {
@@ -10942,9 +11135,9 @@ class TCPDF {
/**
* THIS METHOD IS DEPRECATED
* Format a text string
- * @param string $s string to escape.
+ * @param $s (string) string to escape.
* @return string escaped string.
- * @access protected
+ * @protected
* @deprecated
*/
protected function _escapetext($s) {
@@ -10961,9 +11154,9 @@ class TCPDF {
/**
* get raw output stream.
- * @param string $s string to output.
- * @param int $n object reference for encryption mode
- * @access protected
+ * @param $s (string) string to output.
+ * @param $n (int) object reference for encryption mode
+ * @protected
* @author Nicola Asuni
* @since 5.5.000 (2010-06-22)
*/
@@ -10977,9 +11170,9 @@ class TCPDF {
/**
* Format output stream (DEPRECATED).
- * @param string $s string to output.
- * @param int $n object reference for encryption mode
- * @access protected
+ * @param $s (string) string to output.
+ * @param $n (int) object reference for encryption mode
+ * @protected
* @deprecated
*/
protected function _getstream($s, $n=0) {
@@ -10988,9 +11181,9 @@ class TCPDF {
/**
* Output a stream (DEPRECATED).
- * @param string $s string to output.
- * @param int $n object reference for encryption mode
- * @access protected
+ * @param $s (string) string to output.
+ * @param $n (int) object reference for encryption mode
+ * @protected
* @deprecated
*/
protected function _putstream($s, $n=0) {
@@ -10999,8 +11192,8 @@ class TCPDF {
/**
* Output a string to the document.
- * @param string $s string to output.
- * @access protected
+ * @param $s (string) string to output.
+ * @protected
*/
protected function _out($s) {
if ($this->state == 2) {
@@ -11051,9 +11244,9 @@ class TCPDF {
* UTF8-tail = %x80-BF
* ---------------------------------------------------------------------
*
- * @param string $str string to process.
+ * @param $str (string) string to process.
* @return array containing codepoints (UTF-8 characters values)
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 1.53.0.TC005 (2005-01-05)
*/
@@ -11168,13 +11361,13 @@ class TCPDF {
/**
* Converts UTF-8 strings to UTF16-BE.
- * @param string $str string to process.
- * @param boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
+ * @param $str (string) string to process.
+ * @param $setbom (boolean) if true set the Byte Order Mark (BOM = 0xFEFF)
* @return string
- * @access protected
* @author Nicola Asuni
* @since 1.53.0.TC005 (2005-01-05)
- * @uses UTF8StringToArray(), arrUTF8ToUTF16BE()
+ * @see UTF8StringToArray(), arrUTF8ToUTF16BE()
+ * @protected
*/
protected function UTF8ToUTF16BE($str, $setbom=true) {
if (!$this->isunicode) {
@@ -11186,10 +11379,10 @@ class TCPDF {
/**
* Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
- * @param string $str string to process.
+ * @param $str (string) string to process.
* @return string
* @author Andrew Whitehead, Nicola Asuni
- * @access protected
+ * @protected
* @since 3.2.000 (2008-06-23)
*/
protected function UTF8ToLatin1($str) {
@@ -11215,10 +11408,10 @@ class TCPDF {
/**
* Converts UTF-8 characters array to array of Latin1 characters
- * @param array $unicode array containing UTF-8 unicode values
+ * @param $unicode (array) array containing UTF-8 unicode values
* @return array
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 4.8.023 (2010-01-15)
*/
protected function UTF8ArrToLatin1($unicode) {
@@ -11271,10 +11464,10 @@ class TCPDF {
* W1 = 110110yyyyyyyyyy
* W2 = 110111xxxxxxxxxx
*
- * @param array $unicode array containing UTF-8 unicode values
- * @param boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
+ * @param $unicode (array) array containing UTF-8 unicode values
+ * @param $setbom (boolean) if true set the Byte Order Mark (BOM = 0xFEFF)
* @return string
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 2.1.000 (2008-01-08)
* @see UTF8ToUTF16BE()
@@ -11308,8 +11501,8 @@ class TCPDF {
/**
* Set header font.
- * @param array $font font
- * @access public
+ * @param $font (array) font
+ * @public
* @since 1.1
*/
public function setHeaderFont($font) {
@@ -11319,7 +11512,7 @@ class TCPDF {
/**
* Get header font.
* @return array()
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getHeaderFont() {
@@ -11328,8 +11521,8 @@ class TCPDF {
/**
* Set footer font.
- * @param array $font font
- * @access public
+ * @param $font (array) font
+ * @public
* @since 1.1
*/
public function setFooterFont($font) {
@@ -11339,7 +11532,7 @@ class TCPDF {
/**
* Get Footer font.
* @return array()
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getFooterFont() {
@@ -11348,8 +11541,8 @@ class TCPDF {
/**
* Set language array.
- * @param array $language
- * @access public
+ * @param $language (array)
+ * @public
* @since 1.1
*/
public function setLanguageArray($language) {
@@ -11363,7 +11556,7 @@ class TCPDF {
/**
* Returns the PDF data.
- * @access public
+ * @public
*/
public function getPDFData() {
if ($this->state < 3) {
@@ -11374,15 +11567,15 @@ class TCPDF {
/**
* Output anchor link.
- * @param string $url link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
- * @param string $name link name
- * @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
- * @param boolean $firstline if true prints only the first line and return the remaining string.
- * @param array $color array of RGB text color
- * @param string $style font style (U, D, B, I)
- * @param boolean $firstblock if true the string is the starting of a line.
+ * @param $url (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
+ * @param $name (string) link name
+ * @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
+ * @param $firstline (boolean) if true prints only the first line and return the remaining string.
+ * @param $color (array) array of RGB text color
+ * @param $style (string) font style (U, D, B, I)
+ * @param $firstblock (boolean) if true the string is the starting of a line.
* @return the number of cells used or the remaining text if $firstline = true;
- * @access public
+ * @public
*/
public function addHtmlLink($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) {
if (!$this->empty_string($url) AND ($url{0} == '#')) {
@@ -11424,9 +11617,9 @@ class TCPDF {
/**
* Returns an array (RGB or CMYK) from an html color name or a six-digit (i.e. #3FE5AA) or three-digit (i.e. #7FF) hexadecimal color representation.
- * @param string $hcolor html color
+ * @param $hcolor (string) html color
* @return array RGB or CMYK color, or false in case of error.
- * @access public
+ * @public
*/
public function convertHTMLColorToDec($hcolor='#FFFFFF') {
$returncolor = false;
@@ -11518,9 +11711,9 @@ class TCPDF {
/**
* Converts pixels to User's Units.
- * @param int $px pixels
+ * @param $px (int) pixels
* @return float value in user's unit
- * @access public
+ * @public
* @see setImageScale(), getImageScale()
*/
public function pixelsToUnits($px) {
@@ -11530,9 +11723,9 @@ class TCPDF {
/**
* Reverse function for htmlentities.
* Convert entities in UTF-8.
- * @param string $text_to_convert Text to convert.
+ * @param $text_to_convert (string) Text to convert.
* @return string converted text string
- * @access public
+ * @public
*/
public function unhtmlentities($text_to_convert) {
return html_entity_decode($text_to_convert, ENT_QUOTES, $this->encoding);
@@ -11542,16 +11735,21 @@ class TCPDF {
/**
* Returns a string containing random data to be used as a seed for encryption methods.
- * @param string $seed starting seed value
+ * @param $seed (string) starting seed value
* @return string containing random data
* @author Nicola Asuni
* @since 5.9.006 (2010-10-19)
- * @access protected
+ * @protected
*/
protected function getRandomSeed($seed='') {
$seed .= microtime();
- if (function_exists('openssl_random_pseudo_bytes')) {
+ if (function_exists('openssl_random_pseudo_bytes') AND (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN')) {
+ // this is not used on windows systems because it is very slow for a know bug
$seed .= openssl_random_pseudo_bytes(512);
+ } else {
+ for ($i = 0; $i < 23; ++$i) {
+ $seed .= uniqid('', true);
+ }
}
$seed .= uniqid('', true);
$seed .= rand();
@@ -11585,9 +11783,9 @@ class TCPDF {
/**
* Compute encryption key depending on object number where the encrypted data is stored.
* This is used for all strings and streams without crypt filter specifier.
- * @param int $n object number
+ * @param $n (int) object number
* @return int object key
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 2.0.000 (2008-01-02)
*/
@@ -11604,10 +11802,10 @@ class TCPDF {
/**
* Encrypt the input string.
- * @param int $n object number
- * @param string $s data string to encrypt
+ * @param $n (int) object number
+ * @param $s (string) data string to encrypt
* @return encrypted string
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 5.0.005 (2010-05-11)
*/
@@ -11635,7 +11833,7 @@ class TCPDF {
/**
* Put encryption on PDF document.
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 2.0.000 (2008-01-02)
*/
@@ -11755,10 +11953,10 @@ class TCPDF {
/**
* Returns the input text encrypted using RC4 algorithm and the specified key.
* RC4 is the standard encryption algorithm used in PDF format
- * @param string $key encryption key
- * @param String $text input text to be encrypted
+ * @param $key (string) encryption key
+ * @param $text (String) input text to be encrypted
* @return String encrypted text
- * @access protected
+ * @protected
* @since 2.0.000 (2008-01-02)
* @author Klemen Vodopivec, Nicola Asuni
*/
@@ -11801,10 +11999,10 @@ class TCPDF {
/**
* Returns the input text exrypted using AES algorithm and the specified key.
* This method requires mcrypt.
- * @param string $key encryption key
- * @param String $text input text to be encrypted
+ * @param $key (string) encryption key
+ * @param $text (String) input text to be encrypted
* @return String encrypted text
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 5.0.005 (2010-05-11)
*/
@@ -11820,9 +12018,9 @@ class TCPDF {
/**
* Encrypts a string using MD5 and returns it's value as a binary string.
- * @param string $str input string
+ * @param $str (string) input string
* @return String MD5 encrypted binary string
- * @access protected
+ * @protected
* @since 2.0.000 (2008-01-02)
* @author Klemen Vodopivec
*/
@@ -11833,7 +12031,7 @@ class TCPDF {
/**
* Compute U value (used for encryption)
* @return string U value
- * @access protected
+ * @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
@@ -11866,7 +12064,7 @@ class TCPDF {
/**
* Compute UE value (used for encryption)
* @return string UE value
- * @access protected
+ * @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
@@ -11879,7 +12077,7 @@ class TCPDF {
/**
* Compute O value (used for encryption)
* @return string O value
- * @access protected
+ * @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
@@ -11917,7 +12115,7 @@ class TCPDF {
/**
* Compute OE value (used for encryption)
* @return string OE value
- * @access protected
+ * @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
@@ -11929,8 +12127,9 @@ class TCPDF {
/**
* Convert password for AES-256 encryption mode
+ * @param $password (string) password
* @return string password
- * @access protected
+ * @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
@@ -11945,7 +12144,7 @@ class TCPDF {
/**
* Compute encryption key
- * @access protected
+ * @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
@@ -12058,9 +12257,9 @@ class TCPDF {
/**
* Return the premission code used on encryption (P value).
- * @param Array $permissions the set of permissions (specify the ones you want to block).
- * @param int $mode encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
- * @access protected
+ * @param $permissions (Array) the set of permissions (specify the ones you want to block).
+ * @param $mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
+ * @protected
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
*/
@@ -12099,12 +12298,12 @@ class TCPDF {
* Remark: the protection against modification is for people who have the full Acrobat product.
* If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access.
* Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
- * @param Array $permissions the set of permissions (specify the ones you want to block):- print : Print the document;
- modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';
- copy : Copy or otherwise extract text and graphics from the document;
- annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);
- fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;
- extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);
- assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;
- print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.
- owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.
- * @param String $user_pass user password. Empty by default.
- * @param String $owner_pass owner password. If not specified, a random value is used.
- * @param int $mode encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
- * @param String $pubkeys array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../tcpdf.crt', 'p' => array('print')))
- * @access public
+ * @param $permissions (Array) the set of permissions (specify the ones you want to block):- print : Print the document;
- modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';
- copy : Copy or otherwise extract text and graphics from the document;
- annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);
- fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;
- extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);
- assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;
- print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.
- owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.
+ * @param $user_pass (String) user password. Empty by default.
+ * @param $owner_pass (String) owner password. If not specified, a random value is used.
+ * @param $mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
+ * @param $pubkeys (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../tcpdf.crt', 'p' => array('print')))
+ * @public
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
@@ -12197,9 +12396,9 @@ class TCPDF {
/**
* Convert hexadecimal string to string
- * @param string $bs byte-string to convert
+ * @param $bs (string) byte-string to convert
* @return String
- * @access protected
+ * @protected
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
*/
@@ -12219,9 +12418,9 @@ class TCPDF {
/**
* Convert string to hexadecimal string (byte string)
- * @param string $s string to convert
+ * @param $s (string) string to convert
* @return byte string
- * @access protected
+ * @protected
* @since 5.0.010 (2010-05-17)
* @author Nicola Asuni
*/
@@ -12236,9 +12435,9 @@ class TCPDF {
/**
* Convert encryption P value to a string of bytes, low-order byte first.
- * @param string $protection 32bit encryption permission value (P value)
+ * @param $protection (string) 32bit encryption permission value (P value)
* @return String
- * @access protected
+ * @protected
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
*/
@@ -12259,7 +12458,7 @@ class TCPDF {
* Starts a 2D tranformation saving current graphic state.
* This function must be called before scaling, mirroring, translation, rotation and skewing.
* Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
- * @access public
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12279,7 +12478,7 @@ class TCPDF {
* Stops a 2D tranformation restoring previous graphic state.
* This function must be called after scaling, mirroring, translation, rotation and skewing.
* Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
- * @access public
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12298,10 +12497,10 @@ class TCPDF {
}
/**
* Horizontal Scaling.
- * @param float $s_x scaling factor for width as percent. 0 is not allowed.
- * @param int $x abscissa of the scaling center. Default is current x position
- * @param int $y ordinate of the scaling center. Default is current y position
- * @access public
+ * @param $s_x (float) scaling factor for width as percent. 0 is not allowed.
+ * @param $x (int) abscissa of the scaling center. Default is current x position
+ * @param $y (int) ordinate of the scaling center. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12311,10 +12510,10 @@ class TCPDF {
/**
* Vertical Scaling.
- * @param float $s_y scaling factor for height as percent. 0 is not allowed.
- * @param int $x abscissa of the scaling center. Default is current x position
- * @param int $y ordinate of the scaling center. Default is current y position
- * @access public
+ * @param $s_y (float) scaling factor for height as percent. 0 is not allowed.
+ * @param $x (int) abscissa of the scaling center. Default is current x position
+ * @param $y (int) ordinate of the scaling center. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12324,10 +12523,10 @@ class TCPDF {
/**
* Vertical and horizontal proportional Scaling.
- * @param float $s scaling factor for width and height as percent. 0 is not allowed.
- * @param int $x abscissa of the scaling center. Default is current x position
- * @param int $y ordinate of the scaling center. Default is current y position
- * @access public
+ * @param $s (float) scaling factor for width and height as percent. 0 is not allowed.
+ * @param $x (int) abscissa of the scaling center. Default is current x position
+ * @param $y (int) ordinate of the scaling center. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12337,11 +12536,11 @@ class TCPDF {
/**
* Vertical and horizontal non-proportional Scaling.
- * @param float $s_x scaling factor for width as percent. 0 is not allowed.
- * @param float $s_y scaling factor for height as percent. 0 is not allowed.
- * @param int $x abscissa of the scaling center. Default is current x position
- * @param int $y ordinate of the scaling center. Default is current y position
- * @access public
+ * @param $s_x (float) scaling factor for width as percent. 0 is not allowed.
+ * @param $s_y (float) scaling factor for height as percent. 0 is not allowed.
+ * @param $x (int) abscissa of the scaling center. Default is current x position
+ * @param $y (int) ordinate of the scaling center. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12373,8 +12572,8 @@ class TCPDF {
/**
* Horizontal Mirroring.
- * @param int $x abscissa of the point. Default is current x position
- * @access public
+ * @param $x (int) abscissa of the point. Default is current x position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12384,8 +12583,8 @@ class TCPDF {
/**
* Verical Mirroring.
- * @param int $y ordinate of the point. Default is current y position
- * @access public
+ * @param $y (int) ordinate of the point. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12395,9 +12594,9 @@ class TCPDF {
/**
* Point reflection mirroring.
- * @param int $x abscissa of the point. Default is current x position
- * @param int $y ordinate of the point. Default is current y position
- * @access public
+ * @param $x (int) abscissa of the point. Default is current x position
+ * @param $y (int) ordinate of the point. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12407,10 +12606,10 @@ class TCPDF {
/**
* Reflection against a straight line through point (x, y) with the gradient angle (angle).
- * @param float $angle gradient angle of the straight line. Default is 0 (horizontal line).
- * @param int $x abscissa of the point. Default is current x position
- * @param int $y ordinate of the point. Default is current y position
- * @access public
+ * @param $angle (float) gradient angle of the straight line. Default is 0 (horizontal line).
+ * @param $x (int) abscissa of the point. Default is current x position
+ * @param $y (int) ordinate of the point. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12421,8 +12620,8 @@ class TCPDF {
/**
* Translate graphic object horizontally.
- * @param int $t_x movement to the right (or left for RTL)
- * @access public
+ * @param $t_x (int) movement to the right (or left for RTL)
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12432,8 +12631,8 @@ class TCPDF {
/**
* Translate graphic object vertically.
- * @param int $t_y movement to the bottom
- * @access public
+ * @param $t_y (int) movement to the bottom
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12443,9 +12642,9 @@ class TCPDF {
/**
* Translate graphic object horizontally and vertically.
- * @param int $t_x movement to the right
- * @param int $t_y movement to the bottom
- * @access public
+ * @param $t_x (int) movement to the right
+ * @param $t_y (int) movement to the bottom
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12464,10 +12663,10 @@ class TCPDF {
/**
* Rotate object.
- * @param float $angle angle in degrees for counter-clockwise rotation
- * @param int $x abscissa of the rotation center. Default is current x position
- * @param int $y ordinate of the rotation center. Default is current y position
- * @access public
+ * @param $angle (float) angle in degrees for counter-clockwise rotation
+ * @param $x (int) abscissa of the rotation center. Default is current x position
+ * @param $y (int) ordinate of the rotation center. Default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12494,10 +12693,10 @@ class TCPDF {
/**
* Skew horizontally.
- * @param float $angle_x angle in degrees between -90 (skew to the left) and 90 (skew to the right)
- * @param int $x abscissa of the skewing center. default is current x position
- * @param int $y ordinate of the skewing center. default is current y position
- * @access public
+ * @param $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
+ * @param $x (int) abscissa of the skewing center. default is current x position
+ * @param $y (int) ordinate of the skewing center. default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12507,10 +12706,10 @@ class TCPDF {
/**
* Skew vertically.
- * @param float $angle_y angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
- * @param int $x abscissa of the skewing center. default is current x position
- * @param int $y ordinate of the skewing center. default is current y position
- * @access public
+ * @param $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
+ * @param $x (int) abscissa of the skewing center. default is current x position
+ * @param $y (int) ordinate of the skewing center. default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12520,11 +12719,11 @@ class TCPDF {
/**
* Skew.
- * @param float $angle_x angle in degrees between -90 (skew to the left) and 90 (skew to the right)
- * @param float $angle_y angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
- * @param int $x abscissa of the skewing center. default is current x position
- * @param int $y ordinate of the skewing center. default is current y position
- * @access public
+ * @param $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
+ * @param $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
+ * @param $x (int) abscissa of the skewing center. default is current x position
+ * @param $y (int) ordinate of the skewing center. default is current y position
+ * @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12554,8 +12753,8 @@ class TCPDF {
/**
* Apply graphic transformations.
- * @param array $tm transformation matrix
- * @access protected
+ * @param $tm (array) transformation matrix
+ * @protected
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
@@ -12583,8 +12782,8 @@ class TCPDF {
/**
* Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
- * @param float $width The width.
- * @access public
+ * @param $width (float) The width.
+ * @public
* @since 1.0
* @see Line(), Rect(), Cell(), MultiCell()
*/
@@ -12600,7 +12799,7 @@ class TCPDF {
/**
* Returns the current the line width.
* @return int Line width
- * @access public
+ * @public
* @since 2.1.000 (2008-01-07)
* @see Line(), SetLineWidth()
*/
@@ -12610,7 +12809,7 @@ class TCPDF {
/**
* Set line style.
- * @param array $style Line style. Array with keys among the following:
+ * @param $style (array) Line style. Array with keys among the following:
*
* - width (float): Width of the line in user units.
* - cap (string): Type of cap to put on the line. Possible values are:
@@ -12626,9 +12825,9 @@ class TCPDF {
* the point at which the pattern starts.
* - color (array): Draw color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K).
*
- * @param boolean $ret if true do not send the command.
+ * @param $ret (boolean) if true do not send the command.
* @return string the PDF command
- * @access public
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function SetLineStyle($style, $ret=false) {
@@ -12689,9 +12888,9 @@ class TCPDF {
/**
* Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
- * @param float $x Abscissa of point.
- * @param float $y Ordinate of point.
- * @access protected
+ * @param $x (float) Abscissa of point.
+ * @param $y (float) Ordinate of point.
+ * @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outPoint($x, $y) {
@@ -12701,9 +12900,9 @@ class TCPDF {
/**
* Append a straight line segment from the current point to the point (x, y).
* The new current point shall be (x, y).
- * @param float $x Abscissa of end point.
- * @param float $y Ordinate of end point.
- * @access protected
+ * @param $x (float) Abscissa of end point.
+ * @param $y (float) Ordinate of end point.
+ * @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outLine($x, $y) {
@@ -12712,12 +12911,12 @@ class TCPDF {
/**
* Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
- * @param float $x Abscissa of upper-left corner (or upper-right corner for RTL language).
- * @param float $y Ordinate of upper-left corner (or upper-right corner for RTL language).
- * @param float $w Width.
- * @param float $h Height.
- * @param string $op options
- * @access protected
+ * @param $x (float) Abscissa of upper-left corner.
+ * @param $y (float) Ordinate of upper-left corner.
+ * @param $w (float) Width.
+ * @param $h (float) Height.
+ * @param $op (string) options
+ * @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outRect($x, $y, $w, $h, $op) {
@@ -12727,13 +12926,13 @@ class TCPDF {
/**
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points.
* The new current point shall be (x3, y3).
- * @param float $x1 Abscissa of control point 1.
- * @param float $y1 Ordinate of control point 1.
- * @param float $x2 Abscissa of control point 2.
- * @param float $y2 Ordinate of control point 2.
- * @param float $x3 Abscissa of end point.
- * @param float $y3 Ordinate of end point.
- * @access protected
+ * @param $x1 (float) Abscissa of control point 1.
+ * @param $y1 (float) Ordinate of control point 1.
+ * @param $x2 (float) Abscissa of control point 2.
+ * @param $y2 (float) Ordinate of control point 2.
+ * @param $x3 (float) Abscissa of end point.
+ * @param $y3 (float) Ordinate of end point.
+ * @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outCurve($x1, $y1, $x2, $y2, $x3, $y3) {
@@ -12743,11 +12942,11 @@ class TCPDF {
/**
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points.
* The new current point shall be (x3, y3).
- * @param float $x2 Abscissa of control point 2.
- * @param float $y2 Ordinate of control point 2.
- * @param float $x3 Abscissa of end point.
- * @param float $y3 Ordinate of end point.
- * @access protected
+ * @param $x2 (float) Abscissa of control point 2.
+ * @param $y2 (float) Ordinate of control point 2.
+ * @param $x3 (float) Abscissa of end point.
+ * @param $y3 (float) Ordinate of end point.
+ * @protected
* @since 4.9.019 (2010-04-26)
*/
protected function _outCurveV($x2, $y2, $x3, $y3) {
@@ -12757,13 +12956,11 @@ class TCPDF {
/**
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points.
* The new current point shall be (x3, y3).
- * @param float $x1 Abscissa of control point 1.
- * @param float $y1 Ordinate of control point 1.
- * @param float $x2 Abscissa of control point 2.
- * @param float $y2 Ordinate of control point 2.
- * @param float $x3 Abscissa of end point.
- * @param float $y3 Ordinate of end point.
- * @access protected
+ * @param $x1 (float) Abscissa of control point 1.
+ * @param $y1 (float) Ordinate of control point 1.
+ * @param $x3 (float) Abscissa of end point.
+ * @param $y3 (float) Ordinate of end point.
+ * @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outCurveY($x1, $y1, $x3, $y3) {
@@ -12772,12 +12969,12 @@ class TCPDF {
/**
* Draws a line between two points.
- * @param float $x1 Abscissa of first point.
- * @param float $y1 Ordinate of first point.
- * @param float $x2 Abscissa of second point.
- * @param float $y2 Ordinate of second point.
- * @param array $style Line style. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @access public
+ * @param $x1 (float) Abscissa of first point.
+ * @param $y1 (float) Ordinate of first point.
+ * @param $x2 (float) Abscissa of second point.
+ * @param $y2 (float) Ordinate of second point.
+ * @param $style (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @public
* @since 1.0
* @see SetLineWidth(), SetDrawColor(), SetLineStyle()
*/
@@ -12792,20 +12989,20 @@ class TCPDF {
/**
* Draws a rectangle.
- * @param float $x Abscissa of upper-left corner (or upper-right corner for RTL language).
- * @param float $y Ordinate of upper-left corner (or upper-right corner for RTL language).
- * @param float $w Width.
- * @param float $h Height.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $border_style Border style of rectangle. Array with keys among the following:
+ * @param $x (float) Abscissa of upper-left corner.
+ * @param $y (float) Ordinate of upper-left corner.
+ * @param $w (float) Width.
+ * @param $h (float) Height.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $border_style (array) Border style of rectangle. Array with keys among the following:
*
- * - all: Line style of all borders. Array like for {@link SetLineStyle SetLineStyle}.
- * - L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for {@link SetLineStyle SetLineStyle}.
+ * - all: Line style of all borders. Array like for SetLineStyle().
+ * - L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for SetLineStyle().
*
* If a key is not present or is null, not draws the border. Default value: default line style (empty array).
- * @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @access public
+ * @param $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @public
* @since 1.0
* @see SetLineStyle()
*/
@@ -12849,18 +13046,18 @@ class TCPDF {
* Draws a Bezier curve.
* The Bezier curve is a tangent to the line between the control points at
* either end of the curve.
- * @param float $x0 Abscissa of start point.
- * @param float $y0 Ordinate of start point.
- * @param float $x1 Abscissa of control point 1.
- * @param float $y1 Ordinate of control point 1.
- * @param float $x2 Abscissa of control point 2.
- * @param float $y2 Ordinate of control point 2.
- * @param float $x3 Abscissa of end point.
- * @param float $y3 Ordinate of end point.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of curve. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @access public
+ * @param $x0 (float) Abscissa of start point.
+ * @param $y0 (float) Ordinate of start point.
+ * @param $x1 (float) Abscissa of control point 1.
+ * @param $y1 (float) Ordinate of control point 1.
+ * @param $x2 (float) Abscissa of control point 2.
+ * @param $y2 (float) Ordinate of control point 2.
+ * @param $x3 (float) Abscissa of end point.
+ * @param $y3 (float) Ordinate of end point.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @public
* @see SetLineStyle()
* @since 2.1.000 (2008-01-08)
*/
@@ -12881,13 +13078,13 @@ class TCPDF {
* Draws a poly-Bezier curve.
* Each Bezier curve segment is a tangent to the line between the control points at
* either end of the curve.
- * @param float $x0 Abscissa of start point.
- * @param float $y0 Ordinate of start point.
- * @param float $segments An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of curve. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @access public
+ * @param $x0 (float) Abscissa of start point.
+ * @param $y0 (float) Ordinate of start point.
+ * @param $segments (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @public
* @see SetLineStyle()
* @since 3.0008 (2008-05-12)
*/
@@ -12913,19 +13110,19 @@ class TCPDF {
/**
* Draws an ellipse.
* An ellipse is formed from n Bezier curves.
- * @param float $x0 Abscissa of center point.
- * @param float $y0 Ordinate of center point.
- * @param float $rx Horizontal radius.
- * @param float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
- * @param float $angle: Angle oriented (anti-clockwise). Default value: 0.
- * @param float $astart: Angle start of draw line. Default value: 0.
- * @param float $afinish: Angle finish of draw line. Default value: 360.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of ellipse. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @param integer $nc Number of curves used to draw a 90 degrees portion of ellipse.
+ * @param $x0 (float) Abscissa of center point.
+ * @param $y0 (float) Ordinate of center point.
+ * @param $rx (float) Horizontal radius.
+ * @param $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
+ * @param $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
+ * @param $astart: (float) Angle start of draw line. Default value: 0.
+ * @param $afinish: (float) Angle finish of draw line. Default value: 360.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @param $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function Ellipse($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) {
@@ -12942,30 +13139,31 @@ class TCPDF {
if ($line_style) {
$this->SetLineStyle($line_style);
}
- $this->_outellipticalarc($x0, $y0, $rx, $ry, $angle, $astart, $afinish, false, $nc);
+ $this->_outellipticalarc($x0, $y0, $rx, $ry, $angle, $astart, $afinish, false, $nc, true, true, false);
$this->_out($op);
}
/**
* Append an elliptical arc to the current path.
* An ellipse is formed from n Bezier curves.
- * @param float $xc Abscissa of center point.
- * @param float $yc Ordinate of center point.
- * @param float $rx Horizontal radius.
- * @param float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
- * @param float $xang: Angle between the X-axis and the major axis of the ellipse. Default value: 0.
- * @param float $angs: Angle start of draw line. Default value: 0.
- * @param float $angf: Angle finish of draw line. Default value: 360.
- * @param boolean $pie if true do not mark the border point (used to draw pie sectors).
- * @param integer $nc Number of curves used to draw a 90 degrees portion of ellipse.
- * @param boolean $startpoint if true output a starting point
- * @param boolean $ccw if true draws in counter-clockwise
+ * @param $xc (float) Abscissa of center point.
+ * @param $yc (float) Ordinate of center point.
+ * @param $rx (float) Horizontal radius.
+ * @param $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
+ * @param $xang: (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0.
+ * @param $angs: (float) Angle start of draw line. Default value: 0.
+ * @param $angf: (float) Angle finish of draw line. Default value: 360.
+ * @param $pie (boolean) if true do not mark the border point (used to draw pie sectors).
+ * @param $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
+ * @param $startpoint (boolean) if true output a starting point.
+ * @param $ccw (boolean) if true draws in counter-clockwise.
+ * @param $svg (boolean) if true the angles are in svg mode (already calculated).
* @return array bounding box coordinates (x min, y min, x max, y max)
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 4.9.019 (2010-04-26)
*/
- protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true) {
+ protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false) {
$k = $this->k;
if ($nc < 2) {
$nc = 2;
@@ -12981,8 +13179,13 @@ class TCPDF {
$xang = deg2rad((float) $xang);
$angs = deg2rad((float) $angs);
$angf = deg2rad((float) $angf);
- $as = atan2((sin($angs) / $ry), (cos($angs) / $rx));
- $af = atan2((sin($angf) / $ry), (cos($angf) / $rx));
+ if ($svg) {
+ $as = $angs;
+ $af = $angf;
+ } else {
+ $as = atan2((sin($angs) / $ry), (cos($angs) / $rx));
+ $af = atan2((sin($angf) / $ry), (cos($angf) / $rx));
+ }
if ($as < 0) {
$as += (2 * M_PI);
}
@@ -13004,8 +13207,8 @@ class TCPDF {
$nc *= (2 * abs($total_angle) / M_PI);
$nc = round($nc) + 1;
// angle of each arc
- $arcang = $total_angle / $nc;
- // center point in PDF coordiantes
+ $arcang = ($total_angle / $nc);
+ // center point in PDF coordinates
$x0 = $xc;
$y0 = ($this->h - $yc);
// starting angle
@@ -13032,8 +13235,9 @@ class TCPDF {
for ($i = 1; $i <= $nc; ++$i) {
// starting angle
$ang = $as + ($i * $arcang);
- $cos_xang = cos($xang);
- $sin_xang = sin($xang);
+ if ($i == $nc) {
+ $ang = $af;
+ }
$cos_ang = cos($ang);
$sin_ang = sin($ang);
// second arc point
@@ -13075,16 +13279,16 @@ class TCPDF {
/**
* Draws a circle.
* A circle is formed from n Bezier curves.
- * @param float $x0 Abscissa of center point.
- * @param float $y0 Ordinate of center point.
- * @param float $r Radius.
- * @param float $angstr: Angle start of draw line. Default value: 0.
- * @param float $angend: Angle finish of draw line. Default value: 360.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of circle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- * @param integer $nc Number of curves used to draw a 90 degrees portion of circle.
- * @access public
+ * @param $x0 (float) Abscissa of center point.
+ * @param $y0 (float) Ordinate of center point.
+ * @param $r (float) Radius.
+ * @param $angstr: (float) Angle start of draw line. Default value: 0.
+ * @param $angend: (float) Angle finish of draw line. Default value: 360.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
+ * @param $nc (integer) Number of curves used to draw a 90 degrees portion of circle.
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function Circle($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) {
@@ -13093,18 +13297,17 @@ class TCPDF {
/**
* Draws a polygonal line
- * @param array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of polygon. Array with keys among the following:
+ * @param $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of polygon. Array with keys among the following:
*
- * - all: Line style of all lines. Array like for {@link SetLineStyle SetLineStyle}.
- * - 0 to ($np - 1): Line style of each line. Array like for {@link SetLineStyle SetLineStyle}.
+ * - all: Line style of all lines. Array like for SetLineStyle().
+ * - 0 to ($np - 1): Line style of each line. Array like for SetLineStyle().
*
* If a key is not present or is null, not draws the line. Default value is default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @param boolean $closed if true the polygon is closes, otherwise will remain open
- * @access public
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @since 4.8.003 (2009-09-15)
+ * @public
*/
public function PolyLine($p, $style='', $line_style=array(), $fill_color=array()) {
$this->Polygon($p, $style, $line_style, $fill_color, false);
@@ -13112,17 +13315,17 @@ class TCPDF {
/**
* Draws a polygon.
- * @param array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of polygon. Array with keys among the following:
+ * @param $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of polygon. Array with keys among the following:
*
- * - all: Line style of all lines. Array like for {@link SetLineStyle SetLineStyle}.
- * - 0 to ($np - 1): Line style of each line. Array like for {@link SetLineStyle SetLineStyle}.
+ * - all: Line style of all lines. Array like for SetLineStyle().
+ * - 0 to ($np - 1): Line style of each line. Array like for SetLineStyle().
*
* If a key is not present or is null, not draws the line. Default value is default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @param boolean $closed if true the polygon is closes, otherwise will remain open
- * @access public
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @param $closed (boolean) if true the polygon is closes, otherwise will remain open
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function Polygon($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) {
@@ -13196,21 +13399,21 @@ class TCPDF {
/**
* Draws a regular polygon.
- * @param float $x0 Abscissa of center point.
- * @param float $y0 Ordinate of center point.
- * @param float $r: Radius of inscribed circle.
- * @param integer $ns Number of sides.
- * @param float $angle Angle oriented (anti-clockwise). Default value: 0.
- * @param boolean $draw_circle Draw inscribed circle or not. Default value: false.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of polygon sides. Array with keys among the following:
+ * @param $x0 (float) Abscissa of center point.
+ * @param $y0 (float) Ordinate of center point.
+ * @param $r: (float) Radius of inscribed circle.
+ * @param $ns (integer) Number of sides.
+ * @param $angle (float) Angle oriented (anti-clockwise). Default value: 0.
+ * @param $draw_circle (boolean) Draw inscribed circle or not. Default value: false.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of polygon sides. Array with keys among the following:
*
- * - all: Line style of all sides. Array like for {@link SetLineStyle SetLineStyle}.
- * - 0 to ($ns - 1): Line style of each side. Array like for {@link SetLineStyle SetLineStyle}.
+ * - all: Line style of all sides. Array like for SetLineStyle().
+ * - 0 to ($ns - 1): Line style of each side. Array like for SetLineStyle().
*
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
- * @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- * @param string $circle_style Style of rendering of inscribed circle (if draws). Possible values are:
+ * @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
+ * @param $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
*
* - D or empty string: Draw (default).
* - F: Fill.
@@ -13218,9 +13421,9 @@ class TCPDF {
* - CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).
* - CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).
*
- * @param array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
- * @access public
+ * @param $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function RegularPolygon($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) {
@@ -13242,23 +13445,23 @@ class TCPDF {
/**
* Draws a star polygon
- * @param float $x0 Abscissa of center point.
- * @param float $y0 Ordinate of center point.
- * @param float $r Radius of inscribed circle.
- * @param integer $nv Number of vertices.
- * @param integer $ng Number of gap (if ($ng % $nv = 1) then is a regular polygon).
- * @param float $angle: Angle oriented (anti-clockwise). Default value: 0.
- * @param boolean $draw_circle: Draw inscribed circle or not. Default value is false.
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $line_style Line style of polygon sides. Array with keys among the following:
+ * @param $x0 (float) Abscissa of center point.
+ * @param $y0 (float) Ordinate of center point.
+ * @param $r (float) Radius of inscribed circle.
+ * @param $nv (integer) Number of vertices.
+ * @param $ng (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon).
+ * @param $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
+ * @param $draw_circle: (boolean) Draw inscribed circle or not. Default value is false.
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $line_style (array) Line style of polygon sides. Array with keys among the following:
*
* - all: Line style of all sides. Array like for
- * {@link SetLineStyle SetLineStyle}.
- * - 0 to (n - 1): Line style of each side. Array like for {@link SetLineStyle SetLineStyle}.
+ * SetLineStyle().
+ * - 0 to (n - 1): Line style of each side. Array like for SetLineStyle().
*
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
- * @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- * @param string $circle_style Style of rendering of inscribed circle (if draws). Possible values are:
+ * @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
+ * @param $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
*
* - D or empty string: Draw (default).
* - F: Fill.
@@ -13266,9 +13469,9 @@ class TCPDF {
* - CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).
* - CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).
*
- * @param array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
- * @access public
+ * @param $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function StarPolygon($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) {
@@ -13301,16 +13504,16 @@ class TCPDF {
/**
* Draws a rounded rectangle.
- * @param float $x Abscissa of upper-left corner.
- * @param float $y Ordinate of upper-left corner.
- * @param float $w Width.
- * @param float $h Height.
- * @param float $r the radius of the circle used to round off the corners of the rectangle.
- * @param string $round_corner Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @access public
+ * @param $x (float) Abscissa of upper-left corner.
+ * @param $y (float) Ordinate of upper-left corner.
+ * @param $w (float) Width.
+ * @param $h (float) Height.
+ * @param $r (float) the radius of the circle used to round off the corners of the rectangle.
+ * @param $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @public
* @since 2.1.000 (2008-01-08)
*/
public function RoundedRect($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) {
@@ -13319,17 +13522,17 @@ class TCPDF {
/**
* Draws a rounded rectangle.
- * @param float $x Abscissa of upper-left corner.
- * @param float $y Ordinate of upper-left corner.
- * @param float $w Width.
- * @param float $h Height.
- * @param float $rx the x-axis radius of the ellipse used to round off the corners of the rectangle.
- * @param float $ry the y-axis radius of the ellipse used to round off the corners of the rectangle.
- * @param string $round_corner Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
- * @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
- * @access public
+ * @param $x (float) Abscissa of upper-left corner.
+ * @param $y (float) Ordinate of upper-left corner.
+ * @param $w (float) Width.
+ * @param $h (float) Height.
+ * @param $rx (float) the x-axis radius of the ellipse used to round off the corners of the rectangle.
+ * @param $ry (float) the y-axis radius of the ellipse used to round off the corners of the rectangle.
+ * @param $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
+ * @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
+ * @public
* @since 4.9.019 (2010-04-22)
*/
public function RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) {
@@ -13389,13 +13592,13 @@ class TCPDF {
/**
* Draws a grahic arrow.
- * @param float $x0 Abscissa of first point.
- * @param float $y0 Ordinate of first point.
- * @param float $x0 Abscissa of second point.
- * @param float $y1 Ordinate of second point.
- * @param int $head_style (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
- * @param float $arm_size length of arrowhead arms
- * @param int $arm_angle angle between an arm and the shaft
+ * @param $x0 (float) Abscissa of first point.
+ * @param $y0 (float) Ordinate of first point.
+ * @param $x1 (float) Abscissa of second point.
+ * @param $y1 (float) Ordinate of second point.
+ * @param $head_style (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
+ * @param $arm_size (float) length of arrowhead arms
+ * @param $arm_angle (int) angle between an arm and the shaft
* @author Piotr Galecki, Nicola Asuni, Andy Meier
* @since 4.6.018 (2009-07-10)
*/
@@ -13456,11 +13659,11 @@ class TCPDF {
/**
* Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
- * @param string $str string to manipulate.
- * @param bool $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
- * @param bool $forcertl if true forces RTL text direction
+ * @param $str (string) string to manipulate.
+ * @param $setbom (bool) if true set the Byte Order Mark (BOM = 0xFEFF)
+ * @param $forcertl (bool) if true forces RTL text direction
* @return string
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 2.1.000 (2008-01-08)
*/
@@ -13470,12 +13673,12 @@ class TCPDF {
/**
* Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
- * @param array $arr array of unicode values.
- * @param string $str string to manipulate (or empty value).
- * @param bool $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
- * @param bool $forcertl if true forces RTL text direction
+ * @param $arr (array) array of unicode values.
+ * @param $str (string) string to manipulate (or empty value).
+ * @param $setbom (bool) if true set the Byte Order Mark (BOM = 0xFEFF)
+ * @param $forcertl (bool) if true forces RTL text direction
* @return string
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 4.9.000 (2010-03-27)
*/
@@ -13485,12 +13688,12 @@ class TCPDF {
/**
* Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
- * @param array $ta array of characters composing the string.
- * @param string $str string to process
- * @param bool $forcertl if 'R' forces RTL, if 'L' forces LTR
+ * @param $ta (array) array of characters composing the string.
+ * @param $str (string) string to process
+ * @param $forcertl (bool) if 'R' forces RTL, if 'L' forces LTR
* @return array of unicode chars
* @author Nicola Asuni
- * @access protected
+ * @protected
* @since 2.4.000 (2008-03-06)
*/
protected function utf8Bidi($ta, $str='', $forcertl=false) {
@@ -14058,11 +14261,11 @@ class TCPDF {
/**
* Adds a bookmark.
- * @param string $txt bookmark description.
- * @param int $level bookmark level (minimum value is 0).
- * @param float $y Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
- * @param int $page target page number (leave empty for current page).
- * @access public
+ * @param $txt (string) bookmark description.
+ * @param $level (int) bookmark level (minimum value is 0).
+ * @param $y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
+ * @param $page (int) target page number (leave empty for current page).
+ * @public
* @author Olivier Plathey, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14093,7 +14296,7 @@ class TCPDF {
/**
* Create a bookmark PDF string.
- * @access protected
+ * @protected
* @author Olivier Plathey, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14176,8 +14379,8 @@ class TCPDF {
/**
* Adds a javascript
- * @param string $script Javascript code
- * @access public
+ * @param $script (string) Javascript code
+ * @public
* @author Johannes Güntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14187,10 +14390,10 @@ class TCPDF {
/**
* Adds a javascript object and return object ID
- * @param string $script Javascript code
- * @param boolean $onload if true executes this object when opening the document
+ * @param $script (string) Javascript code
+ * @param $onload (boolean) if true executes this object when opening the document
* @return int internal object ID
- * @access public
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -14202,7 +14405,7 @@ class TCPDF {
/**
* Create a javascript PDF string.
- * @access protected
+ * @protected
* @author Johannes Güntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14255,8 +14458,8 @@ class TCPDF {
/**
* Convert color to javascript color.
- * @param string $color color name or #RRGGBB
- * @access protected
+ * @param $color (string) color name or "#RRGGBB"
+ * @protected
* @author Denis Van Nuffelen, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14273,14 +14476,14 @@ class TCPDF {
/**
* Adds a javascript form field.
- * @param string $type field type
- * @param string $name field name
- * @param int $x horizontal position
- * @param int $y vertical position
- * @param int $w width
- * @param int $h height
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @access protected
+ * @param $type (string) field type
+ * @param $name (string) field name
+ * @param $x (int) horizontal position
+ * @param $y (int) vertical position
+ * @param $w (int) width
+ * @param $h (int) height
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @protected
* @author Denis Van Nuffelen, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
@@ -14289,7 +14492,7 @@ class TCPDF {
$x = $x - $w;
}
// the followind avoid fields duplication after saving the document
- $this->javascript .= "if(getField('tcpdfdocsaved').value != 'saved') {";
+ $this->javascript .= "if (getField('tcpdfdocsaved').value != 'saved') {";
$k = $this->k;
$this->javascript .= sprintf("f".$name."=this.addField('%s','%s',%u,[%.2F,%.2F,%.2F,%.2F]);", $name, $type, $this->PageNo()-1, $x*$k, ($this->h-$y)*$k+1, ($x+$w)*$k, ($this->h-$y-$h)*$k+1)."\n";
$this->javascript .= 'f'.$name.'.textSize='.$this->FontSizePt.";\n";
@@ -14313,9 +14516,9 @@ class TCPDF {
/**
* Convert JavaScript form fields properties array to Annotation Properties array.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @return array of annotation properties
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
@@ -14678,8 +14881,8 @@ class TCPDF {
/**
* Set default properties for form fields.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @access public
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
@@ -14690,7 +14893,7 @@ class TCPDF {
/**
* Return the default properties for form fields.
* @return array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @access public
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
@@ -14700,15 +14903,15 @@ class TCPDF {
/**
* Creates a text field
- * @param string $name field name
- * @param float $w Width of the rectangle
- * @param float $h Height of the rectangle
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (float) Width of the rectangle
+ * @param $h (float) Height of the rectangle
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -14788,16 +14991,16 @@ class TCPDF {
/**
* Creates a RadioButton field
- * @param string $name field name
- * @param int $w width
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param string $onvalue value to be returned if selected.
- * @param boolean $checked define the initial state.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (int) width
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $onvalue (string) value to be returned if selected.
+ * @param $checked (boolean) define the initial state.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -14880,16 +15083,16 @@ class TCPDF {
/**
* Creates a List-box field
- * @param string $name field name
- * @param int $w width
- * @param int $h height
- * @param array $values array containing the list of values.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (int) width
+ * @param $h (int) height
+ * @param $values (array) array containing the list of values.
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -14938,16 +15141,16 @@ class TCPDF {
/**
* Creates a Combo-box field
- * @param string $name field name
- * @param int $w width
- * @param int $h height
- * @param array $values array containing the list of values.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (int) width
+ * @param $h (int) height
+ * @param $values (array) array containing the list of values.
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -14997,16 +15200,16 @@ class TCPDF {
/**
* Creates a CheckBox field
- * @param string $name field name
- * @param int $w width
- * @param boolean $checked define the initial state.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param string $onvalue value to be returned if selected.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (int) width
+ * @param $checked (boolean) define the initial state.
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $onvalue (string) value to be returned if selected.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -15066,17 +15269,17 @@ class TCPDF {
/**
* Creates a button field
- * @param string $name field name
- * @param int $w width
- * @param int $h height
- * @param string $caption caption.
- * @param mixed $action action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
- * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- * @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
- * @param float $x Abscissa of the upper-left corner of the rectangle
- * @param float $y Ordinate of the upper-left corner of the rectangle
- * @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
- * @access public
+ * @param $name (string) field name
+ * @param $w (int) width
+ * @param $h (int) height
+ * @param $caption (string) caption.
+ * @param $action (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
+ * @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
+ * @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
+ * @param $x (float) Abscissa of the upper-left corner of the rectangle
+ * @param $y (float) Ordinate of the upper-left corner of the rectangle
+ * @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
+ * @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
@@ -15228,7 +15431,7 @@ class TCPDF {
/**
* Add certification signature (DocMDP or UR3)
* You can set only one signature type
- * @access protected
+ * @protected
* @author Nicola Asuni
* @since 4.6.008 (2009-05-07)
*/
@@ -15305,15 +15508,15 @@ class TCPDF {
* WARNING: This is experimental and currently do not work.
* Check the PDF Reference 8.7.1 Transform Methods,
* Table 8.105 Entries in the UR transform parameters dictionary
- * @param boolean $enable if true enable user's rights on PDF reader
- * @param string $document Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.
- * @param string $annots Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.
- * @param string $form Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate
- * @param string $signature Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.
- * @param string $ef Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files
+ * @param $enable (boolean) if true enable user's rights on PDF reader
+ * @param $document (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.
+ * @param $annots (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.
+ * @param $form (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate
+ * @param $signature (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.
+ * @param $ef (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files
Names specifying additional embedded-files-related usage rights for the document.
- * @param string $formex Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.
- * @access public
+ * @param $formex (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.
+ * @public
* @author Nicola Asuni
* @since 2.9.000 (2008-03-26)
*/
@@ -15343,13 +15546,13 @@ class TCPDF {
* To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
* To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
* To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
- * @param mixed $signing_cert signing certificate (string or filename prefixed with 'file://')
- * @param mixed $private_key private key (string or filename prefixed with 'file://')
- * @param string $private_key_password password
- * @param string $extracerts specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.
- * @param int $cert_type The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
- * @param array $info array of option information: Name, Location, Reason, ContactInfo.
- * @access public
+ * @param $signing_cert (mixed) signing certificate (string or filename prefixed with 'file://')
+ * @param $private_key (mixed) private key (string or filename prefixed with 'file://')
+ * @param $private_key_password (string) password
+ * @param $extracerts (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.
+ * @param $cert_type (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
+ * @param $info (array) array of option information: Name, Location, Reason, ContactInfo.
+ * @public
* @author Nicola Asuni
* @since 4.6.005 (2009-04-24)
*/
@@ -15380,12 +15583,12 @@ class TCPDF {
/**
* Set the digital signature appearance (a cliccable rectangle area to get signature properties)
- * @param float $x Abscissa of the upper-left corner.
- * @param float $y Ordinate of the upper-left corner.
- * @param float $w Width of the signature area.
- * @param float $h Height of the signature area.
- * @param int $page option page number (if < 0 the current page is used).
- * @access public
+ * @param $x (float) Abscissa of the upper-left corner.
+ * @param $y (float) Ordinate of the upper-left corner.
+ * @param $w (float) Width of the signature area.
+ * @param $h (float) Height of the signature area.
+ * @param $page (int) option page number (if < 0 the current page is used).
+ * @public
* @author Nicola Asuni
* @since 5.3.011 (2010-06-17)
*/
@@ -15405,8 +15608,8 @@ class TCPDF {
/**
* Create a new page group.
* NOTE: call this function before calling AddPage()
- * @param int $page starting group page (leave empty for next page).
- * @access public
+ * @param $page (int) starting group page (leave empty for next page).
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function startPageGroup($page='') {
@@ -15417,24 +15620,23 @@ class TCPDF {
}
/**
- * Defines an alias for the total number of pages.
- * It will be substituted as the document is closed.
- * @param string $alias The alias.
- * @access public
+ * Defines a string alias for the total number of pages. It will be substituted as the document is closed.
+ * @param $numalias (string) The alias.
* @since 1.4
* @see getAliasNbPages(), PageNo(), Footer()
+ * @public
*/
- public function AliasNbPages($alias='{nb}') {
- $this->AliasNbPages = $alias;
+ public function AliasNbPages($numalias="{nb}") {
+ $this->AliasNbPages = $numalias;
}
/**
* Returns the string alias used for the total number of pages.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* @return string
- * @access public
* @since 4.0.018 (2008-08-08)
* @see AliasNbPages(), PageNo(), Footer()
+ * @public
*/
public function getAliasNbPages() {
if ($this->isUnicodeFont()) {
@@ -15444,25 +15646,23 @@ class TCPDF {
}
/**
- * Defines an alias for the page number.
- * It will be substituted as the document is closed.
- * @param string $alias The alias.
- * @access public
+ * Defines a string alias for the page number. It will be substituted as the document is closed.
+ * @param $numalias (string) The alias.
* @since 4.5.000 (2009-01-02)
* @see getAliasNbPages(), PageNo(), Footer()
+ * @public
*/
- public function AliasNumPage($alias='{pnb}') {
- //Define an alias for total number of pages
- $this->AliasNumPage = $alias;
+ public function AliasNumPage($numalias="{pnb}") {
+ $this->AliasNumPage = $numalias;
}
/**
* Returns the string alias used for the page number.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* @return string
- * @access public
* @since 4.5.000 (2009-01-02)
* @see AliasNbPages(), PageNo(), Footer()
+ * @public
*/
public function getAliasNumPage() {
if ($this->isUnicodeFont()) {
@@ -15474,7 +15674,7 @@ class TCPDF {
/**
* Return the current page in the group.
* @return current page in the group
- * @access public
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function getGroupPageNo() {
@@ -15483,7 +15683,7 @@ class TCPDF {
/**
* Returns the current group page number formatted as a string.
- * @access public
+ * @public
* @since 4.3.003 (2008-11-18)
* @see PaneNo(), formatPageNumber()
*/
@@ -15496,7 +15696,7 @@ class TCPDF {
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* (will be replaced by the total number of pages in this group).
* @return alias of the current page group
- * @access public
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function getPageGroupAlias() {
@@ -15511,7 +15711,7 @@ class TCPDF {
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* (will be replaced by the total number of pages in this group).
* @return alias of the current page group
- * @access public
+ * @public
* @since 4.5.000 (2009-01-02)
*/
public function getPageNumGroupAlias() {
@@ -15524,8 +15724,8 @@ class TCPDF {
/**
* Format the page numbers.
* This method can be overriden for custom formats.
- * @param int $num page number
- * @access protected
+ * @param $num (int) page number
+ * @protected
* @since 4.2.005 (2008-11-06)
*/
protected function formatPageNumber($num) {
@@ -15535,8 +15735,8 @@ class TCPDF {
/**
* Format the page numbers on the Table Of Content.
* This method can be overriden for custom formats.
- * @param int $num page number
- * @access protected
+ * @param $num (int) page number
+ * @protected
* @since 4.5.001 (2009-01-04)
* @see addTOC(), addHTMLTOC()
*/
@@ -15546,7 +15746,7 @@ class TCPDF {
/**
* Returns the current page number formatted as a string.
- * @access public
+ * @public
* @since 4.2.005 (2008-11-06)
* @see PaneNo(), formatPageNumber()
*/
@@ -15556,22 +15756,24 @@ class TCPDF {
/**
* Put visibility settings.
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected function _putocg() {
- $this->n_ocg_print = $this->_newobj();
- $this->_out('<< /Type /OCG /Name '.$this->_textstring('print', $this->n_ocg_print).' /Usage << /Print <> /View <> >> >>'."\n".'endobj');
- $this->n_ocg_view = $this->_newobj();
- $this->_out('<< /Type /OCG /Name '.$this->_textstring('view', $this->n_ocg_view).' /Usage << /Print <> /View <> >> >>'."\n".'endobj');
+ if ($this->pdflayers) {
+ $this->n_ocg_print = $this->_newobj();
+ $this->_out('<< /Type /OCG /Name '.$this->_textstring('print', $this->n_ocg_print).' /Usage << /Print <> /View <> >> >>'."\n".'endobj');
+ $this->n_ocg_view = $this->_newobj();
+ $this->_out('<< /Type /OCG /Name '.$this->_textstring('view', $this->n_ocg_view).' /Usage << /Print <> /View <> >> >>'."\n".'endobj');
+ }
}
/**
* Set the visibility of the successive elements.
* This can be useful, for instance, to put a background
* image or color that will show on screen but won't print.
- * @param string $v visibility mode. Legal values are: all, print, screen.
- * @access public
+ * @param $v (string) visibility mode. Legal values are: all, print, screen.
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function setVisibility($v) {
@@ -15584,11 +15786,13 @@ class TCPDF {
case 'print': {
$this->_out('/OC /OC1 BDC');
$this->openMarkedContent = true;
+ $this->pdflayers = true;
break;
}
case 'screen': {
$this->_out('/OC /OC2 BDC');
$this->openMarkedContent = true;
+ $this->pdflayers = true;
break;
}
case 'all': {
@@ -15605,9 +15809,9 @@ class TCPDF {
/**
* Add transparency parameters to the current extgstate
- * @param array $params parameters
+ * @param $parms (array) parameters
* @return the number of extgstates
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected function addExtGState($parms) {
@@ -15625,8 +15829,8 @@ class TCPDF {
/**
* Add an extgstate
- * @param array $gs extgstate
- * @access protected
+ * @param $gs (array) extgstate
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected function setExtGState($gs) {
@@ -15635,8 +15839,7 @@ class TCPDF {
/**
* Put extgstates for object transparency
- * @param array $gs extgstate
- * @access protected
+ * @protected
* @since 3.0.000 (2008-03-27)
*/
protected function _putextgstates() {
@@ -15658,9 +15861,9 @@ class TCPDF {
/**
* Set alpha for stroking (CA) and non-stroking (ca) operations.
- * @param float $alpha real value from 0 (transparent) to 1 (opaque)
- * @param string $bm blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity
- * @access public
+ * @param $alpha (float) real value from 0 (transparent) to 1 (opaque)
+ * @param $bm (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function setAlpha($alpha, $bm='Normal') {
@@ -15670,8 +15873,8 @@ class TCPDF {
/**
* Set the default JPEG compression quality (1-100)
- * @param int $quality JPEG quality, integer between 1 and 100
- * @access public
+ * @param $quality (int) JPEG quality, integer between 1 and 100
+ * @public
* @since 3.0.000 (2008-03-27)
*/
public function setJPEGQuality($quality) {
@@ -15683,8 +15886,8 @@ class TCPDF {
/**
* Set the default number of columns in a row for HTML tables.
- * @param int $cols number of columns
- * @access public
+ * @param $cols (int) number of columns
+ * @public
* @since 3.0.014 (2008-06-04)
*/
public function setDefaultTableColumns($cols=4) {
@@ -15693,8 +15896,8 @@ class TCPDF {
/**
* Set the height of the cell (line height) respect the font height.
- * @param int $h cell proportion respect font height (typical value = 1.25).
- * @access public
+ * @param $h (int) cell proportion respect font height (typical value = 1.25).
+ * @public
* @since 3.0.014 (2008-06-04)
*/
public function setCellHeightRatio($h) {
@@ -15703,7 +15906,7 @@ class TCPDF {
/**
* return the height of cell repect font height.
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getCellHeightRatio() {
@@ -15712,8 +15915,8 @@ class TCPDF {
/**
* Set the PDF version (check PDF reference for valid values).
- * Default value is 1.t
- * @access public
+ * @param $version (string) PDF document version.
+ * @public
* @since 3.1.000 (2008-06-09)
*/
public function setPDFVersion($version='1.7') {
@@ -15724,9 +15927,9 @@ class TCPDF {
* Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
* (see Section 8.1 of PDF reference, "Viewer Preferences").
* - HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.
- HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.
- HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.
- FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.
- CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.
- DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.
- NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:
- UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- UseOC Optional content group panel visible
This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone. - ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are:
- None, which indicates that the print dialog should reflect no page scaling
- AppDefault (default), which indicates that applications should use the current print scaling
- Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:
- Simplex - Print single-sided
- DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet
- DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet
Default value: none - PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.
- PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application
- NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1
- * @param array $preferences array of options.
+ * @param $preferences (array) array of options.
* @author Nicola Asuni
- * @access public
+ * @public
* @since 3.1.000 (2008-06-09)
*/
public function setViewerPreferences($preferences) {
@@ -15735,16 +15938,16 @@ class TCPDF {
/**
* Paints color transition registration bars
- * @param float $x abscissa of the top left corner of the rectangle.
- * @param float $y ordinate of the top left corner of the rectangle.
- * @param float $w width of the rectangle.
- * @param float $h height of the rectangle.
- * @param boolean $transition if true prints tcolor transitions to white.
- * @param boolean $vertical if true prints bar vertically.
- * @param string $colors colors to print, one letter per color separated by comma (for example 'A,W,R,G,B,C,M,Y,K'): A=black, W=white, R=red, G=green, B=blue, C=cyan, M=magenta, Y=yellow, K=black.
+ * @param $x (float) abscissa of the top left corner of the rectangle.
+ * @param $y (float) ordinate of the top left corner of the rectangle.
+ * @param $w (float) width of the rectangle.
+ * @param $h (float) height of the rectangle.
+ * @param $transition (boolean) if true prints tcolor transitions to white.
+ * @param $vertical (boolean) if true prints bar vertically.
+ * @param $colors (string) colors to print, one letter per color separated by comma (for example 'A,W,R,G,B,C,M,Y,K'): A=black, W=white, R=red, G=green, B=blue, C=cyan, M=magenta, Y=yellow, K=black.
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
- * @access public
+ * @public
*/
public function colorRegistrationBar($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A,R,G,B,C,M,Y,K') {
$bars = explode(',', $colors);
@@ -15834,15 +16037,15 @@ class TCPDF {
/**
* Paints crop mark
- * @param float $x abscissa of the crop mark center.
- * @param float $y ordinate of the crop mark center.
- * @param float $w width of the crop mark.
- * @param float $h height of the crop mark.
- * @param string $type type of crop mark, one sybol per type separated by comma: A = top left, B = top right, C = bottom left, D = bottom right.
- * @param array $color crop mark color (default black).
+ * @param $x (float) abscissa of the crop mark center.
+ * @param $y (float) ordinate of the crop mark center.
+ * @param $w (float) width of the crop mark.
+ * @param $h (float) height of the crop mark.
+ * @param $type (string) type of crop mark, one sybol per type separated by comma: A = top left, B = top right, C = bottom left, D = bottom right.
+ * @param $color (array) crop mark color (default black).
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
- * @access public
+ * @public
*/
public function cropMark($x, $y, $w, $h, $type='A,B,C,D', $color=array(0,0,0)) {
$this->SetLineStyle(array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $color));
@@ -15904,15 +16107,15 @@ class TCPDF {
/**
* Paints a registration mark
- * @param float $x abscissa of the registration mark center.
- * @param float $y ordinate of the registration mark center.
- * @param float $r radius of the crop mark.
- * @param boolean $double if true print two concentric crop marks.
- * @param array $cola crop mark color (default black).
- * @param array $colb second crop mark color.
+ * @param $x (float) abscissa of the registration mark center.
+ * @param $y (float) ordinate of the registration mark center.
+ * @param $r (float) radius of the crop mark.
+ * @param $double (boolean) if true print two concentric crop marks.
+ * @param $cola (array) crop mark color (default black).
+ * @param $colb (array) second crop mark color.
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
- * @access public
+ * @public
*/
public function registrationMark($x, $y, $r, $double=false, $cola=array(0,0,0), $colb=array(255,255,255)) {
$line_style = array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $cola);
@@ -15934,16 +16137,16 @@ class TCPDF {
/**
* Paints a linear colour gradient.
- * @param float $x abscissa of the top left corner of the rectangle.
- * @param float $y ordinate of the top left corner of the rectangle.
- * @param float $w width of the rectangle.
- * @param float $h height of the rectangle.
- * @param array $col1 first color (Grayscale, RGB or CMYK components).
- * @param array $col2 second color (Grayscale, RGB or CMYK components).
- * @param array $coords array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
+ * @param $x (float) abscissa of the top left corner of the rectangle.
+ * @param $y (float) ordinate of the top left corner of the rectangle.
+ * @param $w (float) width of the rectangle.
+ * @param $h (float) height of the rectangle.
+ * @param $col1 (array) first color (Grayscale, RGB or CMYK components).
+ * @param $col2 (array) second color (Grayscale, RGB or CMYK components).
+ * @param $coords (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function LinearGradient($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0,0,1,0)) {
$this->Clip($x, $y, $w, $h);
@@ -15952,16 +16155,16 @@ class TCPDF {
/**
* Paints a radial colour gradient.
- * @param float $x abscissa of the top left corner of the rectangle.
- * @param float $y ordinate of the top left corner of the rectangle.
- * @param float $w width of the rectangle.
- * @param float $h height of the rectangle.
- * @param array $col1 first color (Grayscale, RGB or CMYK components).
- * @param array $col2 second color (Grayscale, RGB or CMYK components).
- * @param array $coords array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.
+ * @param $x (float) abscissa of the top left corner of the rectangle.
+ * @param $y (float) ordinate of the top left corner of the rectangle.
+ * @param $w (float) width of the rectangle.
+ * @param $h (float) height of the rectangle.
+ * @param $col1 (array) first color (Grayscale, RGB or CMYK components).
+ * @param $col2 (array) second color (Grayscale, RGB or CMYK components).
+ * @param $coords (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function RadialGradient($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0.5,0.5,0.5,0.5,1)) {
$this->Clip($x, $y, $w, $h);
@@ -15970,21 +16173,21 @@ class TCPDF {
/**
* Paints a coons patch mesh.
- * @param float $x abscissa of the top left corner of the rectangle.
- * @param float $y ordinate of the top left corner of the rectangle.
- * @param float $w width of the rectangle.
- * @param float $h height of the rectangle.
- * @param array $col1 first color (lower left corner) (RGB components).
- * @param array $col2 second color (lower right corner) (RGB components).
- * @param array $col3 third color (upper right corner) (RGB components).
- * @param array $col4 fourth color (upper left corner) (RGB components).
- * @param array $coords - for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).
- for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches
- * @param array $coords_min minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
- * @param array $coords_max maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
- * @param boolean $antialias A flag indicating whether to filter the shading function to prevent aliasing artifacts.
+ * @param $x (float) abscissa of the top left corner of the rectangle.
+ * @param $y (float) ordinate of the top left corner of the rectangle.
+ * @param $w (float) width of the rectangle.
+ * @param $h (float) height of the rectangle.
+ * @param $col1 (array) first color (lower left corner) (RGB components).
+ * @param $col2 (array) second color (lower right corner) (RGB components).
+ * @param $col3 (array) third color (upper right corner) (RGB components).
+ * @param $col4 (array) fourth color (upper left corner) (RGB components).
+ * @param $coords (array) - for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).
- for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches
+ * @param $coords_min (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
+ * @param $coords_max (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
+ * @param $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function CoonsPatchMesh($x, $y, $w, $h, $col1=array(), $col2=array(), $col3=array(), $col4=array(), $coords=array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33), $coords_min=0, $coords_max=1, $antialias=false) {
$this->Clip($x, $y, $w, $h);
@@ -16063,13 +16266,13 @@ class TCPDF {
/**
* Set a rectangular clipping area.
- * @param float $x abscissa of the top left corner of the rectangle (or top right corner for RTL mode).
- * @param float $y ordinate of the top left corner of the rectangle.
- * @param float $w width of the rectangle.
- * @param float $h height of the rectangle.
+ * @param $x (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode).
+ * @param $y (float) ordinate of the top left corner of the rectangle.
+ * @param $w (float) width of the rectangle.
+ * @param $h (float) height of the rectangle.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access protected
+ * @protected
*/
protected function Clip($x, $y, $w, $h) {
if ($this->rtl) {
@@ -16086,14 +16289,14 @@ class TCPDF {
/**
* Output gradient.
- * @param int $type type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
- * @param array $coords array of coordinates.
- * @param array $stops array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
- * @param array $background An array of colour components appropriate to the colour space, specifying a single background colour value.
- * @param boolean $antialias A flag indicating whether to filter the shading function to prevent aliasing artifacts.
+ * @param $type (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
+ * @param $coords (array) array of coordinates.
+ * @param $stops (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
+ * @param $background (array) An array of colour components appropriate to the colour space, specifying a single background colour value.
+ * @param $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function Gradient($type, $coords, $stops, $background=array(), $antialias=false) {
$n = count($this->gradients) + 1;
@@ -16191,7 +16394,7 @@ class TCPDF {
* Output gradient shaders.
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access protected
+ * @protected
*/
function _putshaders() {
$idt = count($this->gradients); //index for transparency gradients
@@ -16370,17 +16573,17 @@ class TCPDF {
/**
* Draw the sector of a circle.
* It can be used for instance to render pie charts.
- * @param float $xc abscissa of the center.
- * @param float $yc ordinate of the center.
- * @param float $r radius.
- * @param float $a start angle (in degrees).
- * @param float $b end angle (in degrees).
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param float $cw: indicates whether to go clockwise (default: true).
- * @param float $o: origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
+ * @param $xc (float) abscissa of the center.
+ * @param $yc (float) ordinate of the center.
+ * @param $r (float) radius.
+ * @param $a (float) start angle (in degrees).
+ * @param $b (float) end angle (in degrees).
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $cw: (float) indicates whether to go clockwise (default: true).
+ * @param $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) {
$this->PieSectorXY($xc, $yc, $r, $r, $a, $b, $style, $cw, $o);
@@ -16389,19 +16592,19 @@ class TCPDF {
/**
* Draw the sector of an ellipse.
* It can be used for instance to render pie charts.
- * @param float $xc abscissa of the center.
- * @param float $yc ordinate of the center.
- * @param float $rx the x-axis radius.
- * @param float $ry the y-axis radius.
- * @param float $a start angle (in degrees).
- * @param float $b end angle (in degrees).
- * @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
- * @param float $cw: indicates whether to go clockwise.
- * @param float $o: origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).
- * @param integer $nc Number of curves used to draw a 90 degrees portion of arc.
+ * @param $xc (float) abscissa of the center.
+ * @param $yc (float) ordinate of the center.
+ * @param $rx (float) the x-axis radius.
+ * @param $ry (float) the y-axis radius.
+ * @param $a (float) start angle (in degrees).
+ * @param $b (float) end angle (in degrees).
+ * @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
+ * @param $cw: (float) indicates whether to go clockwise.
+ * @param $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).
+ * @param $nc (integer) Number of curves used to draw a 90 degrees portion of arc.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) {
if ($this->rtl) {
@@ -16428,21 +16631,21 @@ class TCPDF {
* NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
* Only vector drawing is supported, not text or bitmap.
* Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
- * @param string $file Name of the file containing the image or a '@' character followed by the EPS/AI data string.
- * @param float $x Abscissa of the upper-left corner.
- * @param float $y Ordinate of the upper-left corner.
- * @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- * @param mixed $link URL or identifier returned by AddLink().
- * @param boolean useBoundingBox specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
- * @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- * @param string $palign Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
- * @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
- * @param boolean $fitonpage if true the image is resized to not exceed page dimensions.
- * @param boolean $fixoutvals if true remove values outside the bounding box.
+ * @param $file (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string.
+ * @param $x (float) Abscissa of the upper-left corner.
+ * @param $y (float) Ordinate of the upper-left corner.
+ * @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+ * @param $link (mixed) URL or identifier returned by AddLink().
+ * @param $useBoundingBox (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
+ * @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
+ * @param $palign (string) Allows to center or align the image on the current line. Possible values are:- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
+ * @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
+ * @param $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
+ * @param $fixoutvals (boolean) if true remove values outside the bounding box.
* @author Valentin Schmidt, Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function ImageEps($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false) {
if ($this->rasterize_vector_images AND ($w > 0) AND ($h > 0)) {
@@ -16757,8 +16960,8 @@ class TCPDF {
/**
* Set document barcode.
- * @param string $bc barcode
- * @access public
+ * @param $bc (string) barcode
+ * @public
*/
public function setBarcode($bc='') {
$this->barcode = $bc;
@@ -16767,7 +16970,7 @@ class TCPDF {
/**
* Get current barcode.
* @return string
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getBarcode() {
@@ -16776,14 +16979,14 @@ class TCPDF {
/**
* Print a Linear Barcode.
- * @param string $code code to print
- * @param string $type type of barcode (see barcodes.php for supported formats).
- * @param int $x x position in user units (empty string = current x position)
- * @param int $y y position in user units (empty string = current y position)
- * @param int $w width in user units (empty string = remaining page width)
- * @param int $h height in user units (empty string = remaining page height)
- * @param float $xres width of the smallest bar in user units (empty string = default value = 0.4mm)
- * @param array $style array of options:
+ * @param $code (string) code to print
+ * @param $type (string) type of barcode (see barcodes.php for supported formats).
+ * @param $x (int) x position in user units (empty string = current x position)
+ * @param $y (int) y position in user units (empty string = current y position)
+ * @param $w (int) width in user units (empty string = remaining page width)
+ * @param $h (int) height in user units (empty string = remaining page height)
+ * @param $xres (float) width of the smallest bar in user units (empty string = default value = 0.4mm)
+ * @param $style (array) array of options:
* - boolean $style['border'] if true prints a border
* - int $style['padding'] padding to leave around the barcode in user units (set to 'auto' for automatic padding)
* - int $style['hpadding'] horizontal padding in user units (set to 'auto' for automatic padding)
@@ -16799,10 +17002,10 @@ class TCPDF {
* - string $style['stretch'] if true stretch the barcode to best fit the available width, otherwise uses $xres resolution for a single bar.
* - string $style['fitwidth'] if true reduce the width to fit the barcode width + padding. When this option is enabled the 'stretch' option is automatically disabled.
* - string $style['cellfitalign'] this option works only when 'fitwidth' is true and 'position' is unset or empty. Set the horizontal position of the containing barcode cell inside the specified rectangle: L = left; C = center; R = right.
- * @param string $align Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
+ * @param $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
- * @access public
+ * @public
*/
public function write1DBarcode($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='') {
if ($this->empty_string(trim($code))) {
@@ -17097,17 +17300,17 @@ class TCPDF {
/**
* This function is DEPRECATED, please use the new write1DBarcode() function.
- * @param int $x x position in user units
- * @param int $y y position in user units
- * @param int $w width in user units
- * @param int $h height position in user units
- * @param string $type type of barcode
- * @param string $style barcode style
- * @param string $font font for text
- * @param int $xres x resolution
- * @param string $code code to print
+ * @param $x (int) x position in user units
+ * @param $y (int) y position in user units
+ * @param $w (int) width in user units
+ * @param $h (int) height position in user units
+ * @param $type (string) type of barcode
+ * @param $style (string) barcode style
+ * @param $font (string) font for text
+ * @param $xres (int) x resolution
+ * @param $code (string) code to print
* @deprecated deprecated since version 3.1.000 (2008-06-10)
- * @access public
+ * @public
* @see write1DBarcode()
*/
public function writeBarcode($x, $y, $w, $h, $type, $style, $font, $xres, $code) {
@@ -17152,13 +17355,13 @@ class TCPDF {
/**
* Print 2D Barcode.
- * @param string $code code to print
- * @param string $type type of barcode (see 2dbarcodes.php for supported formats).
- * @param int $x x position in user units
- * @param int $y y position in user units
- * @param int $w width in user units
- * @param int $h height in user units
- * @param array $style array of options:
+ * @param $code (string) code to print
+ * @param $type (string) type of barcode (see 2dbarcodes.php for supported formats).
+ * @param $x (int) x position in user units
+ * @param $y (int) y position in user units
+ * @param $w (int) width in user units
+ * @param $h (int) height in user units
+ * @param $style (array) array of options:
* - boolean $style['border'] if true prints a border around the barcode
* - int $style['padding'] padding to leave around the barcode in barcode units (set to 'auto' for automatic padding)
* - int $style['hpadding'] horizontal padding in barcode units (set to 'auto' for automatic padding)
@@ -17169,11 +17372,11 @@ class TCPDF {
* - mixed $style['bgcolor'] color array for background or false for transparent
* - string $style['position'] barcode position on the page: L = left margin; C = center; R = right margin; S = stretch
- $style['module_width'] width of a single module in points
* - $style['module_height'] height of a single module in points
- * @param string $align Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- * @param boolean $distort if true distort the barcode to fit width and height, otherwise preserve aspect ratio
+ * @param $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
+ * @param $distort (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio
* @author Nicola Asuni
* @since 4.5.037 (2009-04-07)
- * @access public
+ * @public
*/
public function write2DBarcode($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false) {
if ($this->empty_string(trim($code))) {
@@ -17395,7 +17598,7 @@ class TCPDF {
- $ret['padding_bottom'] = cell bottom padding
*
* @return array containing all margins measures
- * @access public
+ * @public
* @since 3.2.000 (2008-06-23)
*/
public function getMargins() {
@@ -17422,7 +17625,7 @@ class TCPDF {
- $ret['right'] = right margin
*
* @return array containing all margins measures
- * @access public
+ * @public
* @since 4.0.012 (2008-07-24)
*/
public function getOriginalMargins() {
@@ -17436,7 +17639,7 @@ class TCPDF {
/**
* Returns the current font size.
* @return current font size
- * @access public
+ * @public
* @since 3.2.000 (2008-06-23)
*/
public function getFontSize() {
@@ -17446,7 +17649,7 @@ class TCPDF {
/**
* Returns the current font size in points unit.
* @return current font size in points unit
- * @access public
+ * @public
* @since 3.2.000 (2008-06-23)
*/
public function getFontSizePt() {
@@ -17456,7 +17659,7 @@ class TCPDF {
/**
* Returns the current font family name.
* @return string current font family name
- * @access public
+ * @public
* @since 4.3.008 (2008-12-05)
*/
public function getFontFamily() {
@@ -17466,7 +17669,7 @@ class TCPDF {
/**
* Returns the current font style.
* @return string current font style
- * @access public
+ * @public
* @since 4.3.008 (2008-12-05)
*/
public function getFontStyle() {
@@ -17475,13 +17678,13 @@ class TCPDF {
/**
* Cleanup HTML code (requires HTML Tidy library).
- * @param string $html htmlcode to fix
- * @param string $default_css CSS commands to add
- * @param array $tagvs parameters for setHtmlVSpace method
- * @param array $tidy_options options for tidy_parse_string function
+ * @param $html (string) htmlcode to fix
+ * @param $default_css (string) CSS commands to add
+ * @param $tagvs (array) parameters for setHtmlVSpace method
+ * @param $tidy_options (array) options for tidy_parse_string function
* @return string XHTML code cleaned up
* @author Nicola Asuni
- * @access public
+ * @public
* @since 5.9.017 (2010-11-16)
* @see setHtmlVSpace()
*/
@@ -17519,7 +17722,11 @@ class TCPDF {
$css = str_replace('/**/', '', $css);
preg_match('/';
// get the body part
@@ -17540,11 +17747,11 @@ class TCPDF {
/**
* Extracts the CSS properties from a CSS string.
- * @param string $cssdata string containing CSS definitions.
+ * @param $cssdata (string) string containing CSS definitions.
* @return An array where the keys are the CSS selectors and the values are the CSS properties.
* @author Nicola Asuni
* @since 5.1.000 (2010-05-25)
- * @access protected
+ * @protected
*/
protected function extractCSSproperties($cssdata) {
if (empty($cssdata)) {
@@ -17631,11 +17838,11 @@ class TCPDF {
/**
* Returns true if the CSS selector is valid for the selected HTML tag
- * @param array $dom array of HTML tags and properties
- * @param int $key key of the current HTML tag
- * @param string $selector CSS selector string
+ * @param $dom (array) array of HTML tags and properties
+ * @param $key (int) key of the current HTML tag
+ * @param $selector (string) CSS selector string
* @return true if the selector is valid, false otherwise
- * @access protected
+ * @protected
* @since 5.1.000 (2010-05-25)
*/
protected function isValidCSSSelectorForTag($dom, $key, $selector) {
@@ -17791,11 +17998,11 @@ class TCPDF {
/**
* Returns the styles that apply for the selected HTML tag.
- * @param array $dom array of HTML tags and properties
- * @param int $key key of the current HTML tag
- * @param array $css array of CSS properties
+ * @param $dom (array) array of HTML tags and properties
+ * @param $key (int) key of the current HTML tag
+ * @param $css (array) array of CSS properties
* @return string containing CSS properties
- * @access protected
+ * @protected
* @since 5.1.000 (2010-05-25)
*/
protected function getTagStyleFromCSS($dom, $key, $css) {
@@ -17821,9 +18028,9 @@ class TCPDF {
/**
* Returns the border width from CSS property
- * @param string $width border width
+ * @param $width (string) border width
* @return int with in user units
- * @access protected
+ * @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderWidth($width) {
@@ -17841,9 +18048,9 @@ class TCPDF {
/**
* Returns the border dash style from CSS property
- * @param string $style border style to convert
+ * @param $style (string) border style to convert
* @return int sash style (return -1 in case of none or hidden border)
- * @access protected
+ * @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderDashStyle($style) {
@@ -17877,9 +18084,9 @@ class TCPDF {
/**
* Returns the border style array from CSS border properties
- * @param string $cssborder border properties
+ * @param $cssborder (string) border properties
* @return array containing border properties
- * @access protected
+ * @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderStyle($cssborder) {
@@ -17927,10 +18134,10 @@ class TCPDF {
/**
* Get the internal Cell padding from CSS attribute.
- * @param string $csspadding padding properties
- * @param float $width width of the containing element
+ * @param $csspadding (string) padding properties
+ * @param $width (float) width of the containing element
* @return array of cell paddings
- * @access public
+ * @public
* @since 5.9.000 (2010-10-04)
*/
public function getCSSPadding($csspadding, $width=0) {
@@ -17981,10 +18188,10 @@ class TCPDF {
/**
* Get the internal Cell margin from CSS attribute.
- * @param string $cssmargin margin properties
- * @param float $width width of the containing element
+ * @param $cssmargin (string) margin properties
+ * @param $width (float) width of the containing element
* @return array of cell margins
- * @access public
+ * @public
* @since 5.9.000 (2010-10-04)
*/
public function getCSSMargin($cssmargin, $width=0) {
@@ -18035,10 +18242,10 @@ class TCPDF {
/**
* Get the border-spacing from CSS attribute.
- * @param string $cssbspace border-spacing CSS properties
- * @param float $width width of the containing element
+ * @param $cssbspace (string) border-spacing CSS properties
+ * @param $width (float) width of the containing element
* @return array of border spacings
- * @access public
+ * @public
* @since 5.9.010 (2010-10-27)
*/
public function getCSSBorderMargin($cssbspace, $width=0) {
@@ -18069,10 +18276,10 @@ class TCPDF {
/**
* Returns the letter-spacing value from CSS value
- * @param string $spacing letter-spacing value
- * @param float $parent font spacing (tracking/kerning) value of the parent element
+ * @param $spacing (string) letter-spacing value
+ * @param $parent (float) font spacing (tracking/kerning) value of the parent element
* @return float quantity to increases or decreases the space between characters in a text.
- * @access protected
+ * @protected
* @since 5.9.000 (2010-10-02)
*/
protected function getCSSFontSpacing($spacing, $parent=0) {
@@ -18100,10 +18307,10 @@ class TCPDF {
/**
* Returns the percentage of font stretching from CSS value
- * @param string $stretch stretch mode
- * @param float $parent stretch value of the parent element
+ * @param $stretch (string) stretch mode
+ * @param $parent (float) stretch value of the parent element
* @return float font stretching percentage
- * @access protected
+ * @protected
* @since 5.9.000 (2010-10-02)
*/
protected function getCSSFontStretching($stretch, $parent=100) {
@@ -18171,9 +18378,9 @@ class TCPDF {
/**
* Returns the HTML DOM array.
- * @param string $html html code
+ * @param $html (string) html code
* @return array
- * @access protected
+ * @protected
* @since 3.2.000 (2008-06-20)
*/
protected function getHtmlDomArray($html) {
@@ -18295,6 +18502,7 @@ class TCPDF {
$html = preg_replace('/<\/(td|th)>/', '', $html);
$html = preg_replace('/<\/table>([\s]*)/', '