diff --git a/oss/vtiger/trunk/include/tcpdf/tcpdf.php b/oss/vtiger/trunk/include/tcpdf/tcpdf.php index b1066b9b..b074e174 100644 --- a/oss/vtiger/trunk/include/tcpdf/tcpdf.php +++ b/oss/vtiger/trunk/include/tcpdf/tcpdf.php @@ -2,12 +2,12 @@ //============================================================+ // File name : tcpdf.php // Begin : 2002-08-03 -// Last Update : 2008-11-25 +// Last Update : 2010-02-04 // Author : Nicola Asuni - info@tecnick.com - http://www.tcpdf.org -// Version : 4.3.005 +// Version : 4.8.032 // License : GNU LGPL (http://www.gnu.org/copyleft/lesser.html) // ---------------------------------------------------------------------------- -// Copyright (C) 2002-2008 Nicola Asuni - Tecnick.com S.r.l. +// Copyright (C) 2002-2010 Nicola Asuni - Tecnick.com S.r.l. // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by @@ -36,26 +36,29 @@ // Main features: // * no external libraries are required for the basic functions; // * supports all ISO page formats; -// * supports UTF-8 Unicode and Right-To-Left languages; -// * supports document encryption; -// * includes methods to publish some XHTML code; -// * includes graphic (geometric) and transformation methods; -// * includes bookmarks; -// * includes Javascript and forms support; -// * includes a method to print various barcode formats; -// * supports TrueTypeUnicode, TrueType, Type1 and CID-0 fonts; // * supports custom page formats, margins and units of measure; -// * includes methods for page header and footer management; +// * supports UTF-8 Unicode and Right-To-Left languages; +// * supports TrueTypeUnicode, OpenTypeUnicode, TrueType, OpenType, Type1 and CID-0 fonts; +// * supports document encryption; +// * includes methods to publish some XHTML code, including forms; +// * includes graphic (geometric) and transformation methods; +// * includes Javascript and Forms support; +// * includes a method to print various barcode formats: CODE 39, ANSI MH10.8M-1983, USD-3, 3 of 9, CODE 93, USS-93, Standard 2 of 5, Interleaved 2 of 5, CODE 128 A/B/C, 2 and 5 Digits UPC-Based Extention, EAN 8, EAN 13, UPC-A, UPC-E, MSI, POSTNET, PLANET, RMS4CC (Royal Mail 4-state Customer Code), CBC (Customer Bar Code), KIX (Klant index - Customer index), Intelligent Mail Barcode, Onecode, USPS-B-3200, CODABAR, CODE 11, PHARMACODE, PHARMACODE TWO-TRACKS; +// * includes methods to set Bookmarks and print a Table of Content; +// * includes methods to move and delete pages; +// * includes methods for automatic page header and footer management; // * supports automatic page break; // * supports automatic page numbering and page groups; // * supports automatic line break and text justification; -// * supports JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; +// * supports JPEG and PNG images natively, all images supported by GD (GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM) and all images supported via ImagMagick (http://www.imagemagick.org/www/formats.html) // * supports stroke and clipping mode for text; // * supports clipping masks; -// * supports Grayscale, RGB, CMYK, Spot colors and transparency; -// * supports links and annotations; +// * supports Grayscale, RGB, CMYK, Spot Colors and Transparencies; +// * supports several annotations, including links, text and file attachments; // * supports page compression (requires zlib extension); -// * supports PDF user's rights. +// * supports text hyphenation. +// * supports transactions to UNDO commands. +// * supports signature certifications. // // ----------------------------------------------------------- // THANKS TO: @@ -67,7 +70,7 @@ // dullus for text Justification. // Bob Vincent (pillarsdotnet@users.sourceforge.net) for
  • value attribute. // Patrick Benny for text stretch suggestion on Cell(). -// Johannes Güntert for JavaScript support. +// Johannes G�ntert for JavaScript support. // Denis Van Nuffelen for Dynamic Form. // Jacek Czekaj for multibyte justification // Anthony Ferrara for the reintroduction of legacy image methods. @@ -78,11 +81,12 @@ // Mohamad Ali Golkar, Saleh AlMatrafe, Charles Abbott for Arabic and Persian support. // Moritz Wagner and Andreas Wurmser for graphic functions. // Andrew Whitehead for core fonts support. -// Esteban Joël Marín for OpenType font conversion. +// Esteban Jo�l Mar�n for OpenType font conversion. // Teus Hagen for several suggestions and fixes. // Yukihiro Nakadaira for CID-0 CJK fonts fixes. // Kosmas Papachristos for some CSS improvements. // Marcel Partap for some fixes. +// Won Kyu Park for several suggestions, fixes and patches. // Anyone that has reported a bug or sent a suggestion. //============================================================+ @@ -91,37 +95,40 @@ * 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:

    * * 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 2004-2008 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com + * @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.gnu.org/copyleft/lesser.html LGPL - * @version 4.3.005 + * @version 4.8.032 */ /** @@ -141,24 +148,18 @@ require_once(dirname(__FILE__).'/unicode_data.php'); */ require_once(dirname(__FILE__).'/htmlcolors.php'); -/** - * barcode class - */ -require_once(dirname(__FILE__).'/barcodes.php'); - - if (!class_exists('TCPDF', false)) { /** * define default PDF document producer */ - define('PDF_PRODUCER','TCPDF 4.3.005 (http://www.tcpdf.org)'); + define('PDF_PRODUCER', 'TCPDF 4.8.032 (http://www.tcpdf.org)'); /** * 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 4.3.005 + * @version 4.8.032 * @author Nicola Asuni - info@tecnick.com * @link http://www.tcpdf.org * @license http://www.gnu.org/copyleft/lesser.html LGPL @@ -216,7 +217,7 @@ if (!class_exists('TCPDF', false)) { protected $CurOrientation; /** - * @var array that stores page dimensions. + * @var array that stores page dimensions and graphic status. * @access protected */ protected $pagedim = array(); @@ -291,7 +292,8 @@ if (!class_exists('TCPDF', false)) { * @var cell internal padding * @access protected */ - protected $cMargin; + //protected + public $cMargin; /** * @var cell internal padding (previous value) @@ -439,12 +441,6 @@ if (!class_exists('TCPDF', false)) { */ protected $ColorFlag; - /** - * @var word spacing - * @access protected - */ - protected $ws; - /** * @var automatic page breaking * @access protected @@ -479,38 +475,44 @@ if (!class_exists('TCPDF', false)) { * @var title * @access protected */ - protected $title; + protected $title = ''; /** * @var subject * @access protected */ - protected $subject; + protected $subject = ''; /** * @var author * @access protected */ - protected $author; + protected $author = ''; /** * @var keywords * @access protected */ - protected $keywords; + protected $keywords = ''; /** * @var creator * @access protected */ - protected $creator; + protected $creator = ''; /** * @var alias for total number of pages * @access protected */ - protected $AliasNbPages; - + protected $AliasNbPages = '{nb}'; + + /** + * @var alias for page number + * @access protected + */ + protected $AliasNumPage = '{pnb}'; + /** * @var right-bottom corner X coordinate of inserted image * @since 2002-07-31 @@ -528,7 +530,7 @@ if (!class_exists('TCPDF', false)) { protected $img_rb_y; /** - * @var image scale factor + * @var adjusting factor to convert pixels to user units. * @since 2004-06-14 * @author Nicola Asuni * @access protected @@ -649,13 +651,13 @@ if (!class_exists('TCPDF', false)) { // variables for html parser /** - * @var HTML PARSER: store current link. + * @var HTML PARSER: array to store current link and rendering styles. * @access protected */ - protected $HREF; + protected $HREF = array(); /** - * @var store available fonts list. + * @var store a list of available fonts on filesystem. * @access protected */ protected $fontlist = array(); @@ -885,11 +887,11 @@ if (!class_exists('TCPDF', false)) { protected $dpi = 72; /** - * Indicates whether a new page group was requested + * Array of page numbers were a new page group was started * @access protected * @since 3.0.000 (2008-03-27) */ - protected $newpagegroup; + protected $newpagegroup = array(); /** * Contains the number of pages of the groups @@ -939,7 +941,7 @@ if (!class_exists('TCPDF', false)) { * @since 3.0.000 (2008-03-27) */ protected $jpeg_quality; - + /** * Default cell height ratio. * @access protected @@ -976,6 +978,14 @@ if (!class_exists('TCPDF', false)) { */ protected $intmrk = array(); + /** + * Array used to store content positions inside the pages buffer. + * keys are the page numbers + * @access protected + * @since 4.6.021 (2009-07-20) + */ + protected $cntmrk = array(); + /** * Array used to store footer positions of each page. * @access protected @@ -985,7 +995,7 @@ if (!class_exists('TCPDF', false)) { /** - * Array used to store footer lenght of each page. + * Array used to store footer length of each page. * @access protected * @since 4.0.014 (2008-07-29) */ @@ -1059,7 +1069,7 @@ if (!class_exists('TCPDF', false)) { * @access protected * @since 4.0.028 (2008-09-26) */ - protected $lisymbol = '-'; + protected $lisymbol = ''; /** * String used to mark the beginning and end of EPS image blocks @@ -1074,7 +1084,14 @@ if (!class_exists('TCPDF', false)) { * @since 4.2.000 (2008-10-29) */ protected $transfmatrix = array(); - + + /** + * Current key for transformation matrix + * @access protected + * @since 4.8.005 (2009-09-17) + */ + protected $transfmatrix_key = 0; + /** * Booklet mode for double-sided pages * @access protected @@ -1087,7 +1104,7 @@ if (!class_exists('TCPDF', false)) { * @access protected * @since 4.2.000 (2008-10-29) */ - protected $feps = 0.001; + protected $feps = 0.005; /** * Array used for custom vertical spaces for HTML tags @@ -1110,6 +1127,364 @@ if (!class_exists('TCPDF', false)) { * @since 4.2.010 (2008-11-14) */ protected $opencell = true; + + /** + * @var array of files to embedd + * @access protected + * @since 4.4.000 (2008-12-07) + */ + protected $embeddedfiles = array(); + + /** + * @var boolean true when inside html pre tag + * @access protected + * @since 4.4.001 (2008-12-08) + */ + protected $premode = false; + + /** + * Array used to store positions of graphics transformation blocks inside the page buffer. + * keys are the page numbers + * @access protected + * @since 4.4.002 (2008-12-09) + */ + protected $transfmrk = array(); + + /** + * Default color for html links + * @access protected + * @since 4.4.003 (2008-12-09) + */ + protected $htmlLinkColorArray = array(0, 0, 255); + + /** + * Default font style to add to html links + * @access protected + * @since 4.4.003 (2008-12-09) + */ + protected $htmlLinkFontStyle = 'U'; + + /** + * Counts the number of pages. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $numpages = 0; + + /** + * Array containing page lengths in bytes. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $pagelen = array(); + + /** + * Counts the number of pages. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $numimages = 0; + + /** + * Store the image keys. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $imagekeys = array(); + + /** + * Length of the buffer in bytes. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $bufferlen = 0; + + /** + * If true enables disk caching. + * @access protected + * @since 4.5.000 (2008-12-31) + */ + protected $diskcache = false; + + /** + * Counts the number of fonts. + * @access protected + * @since 4.5.000 (2009-01-02) + */ + protected $numfonts = 0; + + /** + * Store the font keys. + * @access protected + * @since 4.5.000 (2009-01-02) + */ + protected $fontkeys = array(); + + /** + * Store the font object IDs. + * @access 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 + * @since 4.5.000 (2009-01-02) + */ + protected $pageopen = array(); + + /** + * Default monospaced font + * @access 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 + * @since 4.5.029 (2009-03-19) + */ + protected $objcopy; + + /** + * Array used to store the lengths of cache files + * @access 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 + * @since 4.5.030 (2009-03-20) + */ + protected $thead = ''; + + /** + * Margins used for table header. + * @access protected + * @since 4.5.030 (2009-03-20) + */ + protected $theadMargins = array(); + + /** + * Cache array for UTF8StringToArray() method. + * @access protected + * @since 4.5.037 (2009-04-07) + */ + protected $cache_UTF8StringToArray = array(); + + /** + * Maximum size of cache array used for UTF8StringToArray() method. + * @access protected + * @since 4.5.037 (2009-04-07) + */ + protected $cache_maxsize_UTF8StringToArray = 8; + + /** + * Current size of cache array used for UTF8StringToArray() method. + * @access protected + * @since 4.5.037 (2009-04-07) + */ + protected $cache_size_UTF8StringToArray = 0; + + /** + * If true enables document signing + * @access protected + * @since 4.6.005 (2009-04-24) + */ + protected $sign = false; + + /** + * Signature data + * @access protected + * @since 4.6.005 (2009-04-24) + */ + protected $signature_data = array(); + + /** + * Signature max length + * @access protected + * @since 4.6.005 (2009-04-24) + */ + protected $signature_max_length = 11742; + + /** + * Regular expression used to find blank characters used for word-wrapping. + * @access protected + * @since 4.6.006 (2009-04-28) + */ + protected $re_spaces = '/[\s]/'; + + /** + * Signature object ID + * @access protected + * @since 4.6.022 (2009-06-23) + */ + protected $sig_obj_id = 0; + + /** + * ByteRange placemark used during signature process. + * @access protected + * @since 4.6.028 (2009-08-25) + */ + protected $byterange_string = '/ByteRange[0 ********** ********** **********]'; + + /** + * Placemark used during signature process. + * @access protected + * @since 4.6.028 (2009-08-25) + */ + protected $sig_annot_ref = '***SIGANNREF*** 0 R'; + + /** + * ID of page objects + * @access protected + * @since 4.7.000 (2009-08-29) + */ + protected $page_obj_id = array(); + + /** + * Start ID for embedded file objects + * @access protected + * @since 4.7.000 (2009-08-29) + */ + protected $embedded_start_obj_id = 100000; + + /** + * Start ID for annotation objects + * @access protected + * @since 4.7.000 (2009-08-29) + */ + protected $annots_start_obj_id = 200000; + + /** + * Max ID of annotation object + * @access protected + * @since 4.7.000 (2009-08-29) + */ + protected $annot_obj_id = 200000; + + /** + * Current ID of annotation object + * @access protected + * @since 4.8.003 (2009-09-15) + */ + protected $curr_annot_obj_id = 200000; + + /** + * List of form annotations IDs + * @access 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 + * @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 + * @since 4.8.000 (2009-09-07) + */ + protected $js_objects = array(); + + /** + * Start ID for javascript objects + * @access protected + * @since 4.8.000 (2009-09-07) + */ + protected $js_start_obj_id = 300000; + + /** + * Current ID of javascript object + * @access protected + * @since 4.8.000 (2009-09-07) + */ + protected $js_obj_id = 300000; + + /** + * Current form action (used during XHTML rendering) + * @access protected + * @since 4.8.000 (2009-09-07) + */ + protected $form_action = ''; + + /** + * Current form encryption type (used during XHTML rendering) + * @access protected + * @since 4.8.000 (2009-09-07) + */ + protected $form_enctype = 'application/x-www-form-urlencoded'; + + /** + * Current method to submit forms. + * @access protected + * @since 4.8.000 (2009-09-07) + */ + protected $form_mode = 'post'; + + /** + * Start ID for appearance streams XObjects + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected $apxo_start_obj_id = 400000; + + /** + * Current ID of appearance streams XObjects + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected $apxo_obj_id = 400000; + + /** + * List of fonts used on form fields (fontname => fontkey). + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected $annotation_fonts = array(); + + /** + * List of radio buttons parent objects. + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected $radiobutton_groups = array(); + + /** + * List of radio group objects IDs + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected $radio_groups = array(); + + /** + * Text indentation value (used for text-indent CSS attribute) + * @access protected + * @since 4.8.006 (2009-09-23) + */ + protected $textindent = 0; + + /** + * Store page number when startTransaction() is called. + * @access protected + * @since 4.8.006 (2009-09-23) + */ + protected $start_transaction_page = 0; + + /** + * True when we are in thead + * @access protected + * @since 4.8.027 (2010-01-25) + */ + protected $inthead = false; //------------------------------------------------------------ // METHODS @@ -1124,22 +1499,27 @@ if (!class_exists('TCPDF', false)) { * @param string $unit User measure unit. Possible values are:
    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 following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit). * @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 */ - public function __construct($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8') { + public function __construct($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false) { /* Set internal character encoding to ASCII */ if (function_exists('mb_internal_encoding') AND mb_internal_encoding()) { $this->internal_encoding = mb_internal_encoding(); mb_internal_encoding('ASCII'); } + // set disk caching + $this->diskcache = $diskcache ? true : false; // set language direction - $this->rtl = $this->l['a_meta_dir']=='rtl' ? true : false; + $this->rtl = false; $this->tmprtl = false; //Some checks $this->_dochecks(); //Initialization of properties $this->isunicode = $unicode; $this->page = 0; + $this->transfmrk[0] = array(); $this->pagedim = array(); $this->n = 2; $this->buffer = ''; @@ -1162,7 +1542,6 @@ if (!class_exists('TCPDF', false)) { $this->FillColor = '0 g'; $this->TextColor = '0 g'; $this->ColorFlag = false; - $this->ws = 0; // encryption values $this->encrypted = false; $this->last_rc4_key = ''; @@ -1190,12 +1569,12 @@ if (!class_exists('TCPDF', false)) { $this->setPageFormat($format, $orientation); //Page margins (1 cm) $margin = 28.35 / $this->k; - $this->SetMargins($margin,$margin); - //Interior cell margin (1 mm) + $this->SetMargins($margin, $margin); + //Interior cell margin $this->cMargin = $margin / 10; //Line width (0.2 mm) $this->LineWidth = 0.57 / $this->k; - $this->linestyleWidth = sprintf('%.2f w', ($this->LineWidth * $this->k)); + $this->linestyleWidth = sprintf('%.2F w', ($this->LineWidth * $this->k)); $this->linestyleCap = '0 J'; $this->linestyleJoin = '0 j'; $this->linestyleDash = '[] 0 d'; @@ -1208,25 +1587,46 @@ if (!class_exists('TCPDF', false)) { //Set default PDF version number $this->PDFVersion = '1.7'; $this->encoding = $encoding; - $this->HREF = ''; + $this->HREF = array(); $this->getFontsList(); $this->fgcolor = array('R' => 0, 'G' => 0, 'B' => 0); $this->bgcolor = array('R' => 255, 'G' => 255, 'B' => 255); $this->extgstates = array(); // user's rights + $this->sign = false; $this->ur = false; $this->ur_document = '/FullSave'; $this->ur_annots = '/Create/Delete/Modify/Copy/Import/Export'; $this->ur_form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate'; - $this->ur_signature = '/Modify'; + $this->ur_signature = '/Modify'; // set default JPEG quality $this->jpeg_quality = 75; // initialize some settings - $this->utf8Bidi(array('')); + $this->utf8Bidi(array(''), ''); + // set default font + $this->SetFont($this->FontFamily, $this->FontStyle, $this->FontSizePt); + // check if PCRE Unicode support is enabled + if ($this->isunicode AND (@preg_match('/\pL/u', 'a') == 1)) { + // PCRE unicode support is turned ON + // \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 because Chinese characters are packed next to each other without spaces in between. + //$this->re_spaces = '/[\s\p{Z}\p{Lo}]/u'; + $this->re_spaces = '/[\s\p{Z}]/u'; + } else { + // PCRE unicode support is turned OFF + $this->re_spaces = '/[\s]/'; + } + $this->annot_obj_id = $this->annots_start_obj_id; + $this->curr_annot_obj_id = $this->annots_start_obj_id; + $this->apxo_obj_id = $this->apxo_start_obj_id; + $this->js_obj_id = $this->js_start_obj_id; + $this->default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128)); } /** * Default destructor. + * @access public * @since 1.53.0.TC016 */ public function __destruct() { @@ -1234,17 +1634,21 @@ if (!class_exists('TCPDF', false)) { if (isset($this->internal_encoding) AND !empty($this->internal_encoding)) { mb_internal_encoding($this->internal_encoding); } + // unset all class variables + $this->_destroy(true); } /** * Set the units of measure for the document. * @param string $unit User measure unit. Possible values are:
    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 * @since 3.0.015 (2008-06-06) */ public function setPageUnit($unit) { //Set scale factor switch (strtolower($unit)) { // points + case 'px': case 'pt': { $this->k = 1; break; @@ -1279,6 +1683,7 @@ if (!class_exists('TCPDF', false)) { * Set the page format * @param mixed $format The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit). * @param string $orientation page orientation. Possible values are (case insensitive): + * @access public * @since 3.0.015 (2008-06-06) */ public function setPageFormat($format, $orientation='P') { @@ -1351,6 +1756,7 @@ if (!class_exists('TCPDF', false)) { * @param string $orientation page orientation. Possible values are (case insensitive): * @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 * @since 3.0.015 (2008-06-06) */ public function setPageOrientation($orientation, $autopagebreak='', $bottommargin='') { @@ -1368,14 +1774,14 @@ if (!class_exists('TCPDF', false)) { } $this->w = $this->wPt / $this->k; $this->h = $this->hPt / $this->k; - if (empty($autopagebreak)) { + if ($this->empty_string($autopagebreak)) { if (isset($this->AutoPageBreak)) { $autopagebreak = $this->AutoPageBreak; } else { $autopagebreak = true; } } - if (empty($bottommargin)) { + if ($this->empty_string($bottommargin)) { if (isset($this->bMargin)) { $bottommargin = $this->bMargin; } else { @@ -1387,20 +1793,42 @@ if (!class_exists('TCPDF', false)) { // store page dimensions $this->pagedim[$this->page] = array('w' => $this->wPt, 'h' => $this->hPt, 'wk' => $this->w, 'hk' => $this->h, 'tm' => $this->tMargin, 'bm' => $bottommargin, 'lm' => $this->lMargin, 'rm' => $this->rMargin, 'pb' => $autopagebreak, 'or' => $this->CurOrientation, 'olm' => $this->original_lMargin, 'orm' => $this->original_rMargin); } - + + /** + * Set regular expression to detect withespaces or word separators. + * @param string $re regular expression (leave empty for default). + * @access public + * @since 4.6.016 (2009-06-15) + */ + public function setSpacesRE($re='/[\s]/') { + // if PCRE unicode support is turned ON: + // \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 because Chinese characters are packed next to each other without spaces in between. + $this->re_spaces = $re; + } + /** * Enable or disable Right-To-Left language mode * @param Boolean $enable if true enable Right-To-Left language mode. - * @since 2.0.000 (2008-01-03) + * @param Boolean $resetx if true reset the X position on direction change. + * @access public + * @since 2.0.000 (2008-01-03) */ - public function setRTL($enable) { - $this->rtl = $enable ? true : false; + public function setRTL($enable, $resetx=true) { + $enable = $enable ? true : false; + $resetx = ($resetx AND ($enable != $this->rtl)); + $this->rtl = $enable; $this->tmprtl = false; + if ($resetx) { + $this->Ln(0); + } } /** * Return the RTL status * @return boolean + * @access public * @since 4.0.012 (2008-07-24) */ public function getRTL() { @@ -1410,22 +1838,52 @@ if (!class_exists('TCPDF', false)) { /** * Force temporary RTL language direction * @param mixed $mode can be false, 'L' for LTR or 'R' for RTL + * @access public * @since 2.1.000 (2008-01-09) */ public function setTempRTL($mode) { + $newmode = false; switch ($mode) { - case false: - case 'L': + case 'ltr': + case 'LTR': + case 'L': { + if ($this->rtl) { + $newmode = 'L'; + } + break; + } + case 'rtl': + case 'RTL': case 'R': { - $this->tmprtl = $mode; + if (!$this->rtl) { + $newmode = 'R'; + } + break; + } + case false: + default: { + $newmode = false; + break; } } + $this->tmprtl = $newmode; } + /** + * Return the current temporary RTL status + * @return boolean + * @access public + * @since 4.8.014 (2009-11-04) + */ + public function isRTLTextDir() { + return ($this->rtl OR ($this->tmprtl == 'R')); + } + /** * Set the last cell height. * @param float $h cell height. * @author Nicola Asuni + * @access public * @since 1.53.0.TC034 */ public function setLastH($h) { @@ -1435,6 +1893,7 @@ if (!class_exists('TCPDF', false)) { /** * Get the last cell height. * @return last cell height + * @access public * @since 4.0.017 (2008-08-05) */ public function getLastH() { @@ -1442,9 +1901,10 @@ if (!class_exists('TCPDF', false)) { } /** - * Set the image scale. - * @param float $scale image scale. + * Set the adjusting factor to convert pixels to user units. + * @param float $scale adjusting factor to convert pixels to user units. * @author Nicola Asuni + * @access public * @since 1.5.2 */ public function setImageScale($scale) { @@ -1452,49 +1912,85 @@ if (!class_exists('TCPDF', false)) { } /** - * Returns the image scale. - * @return float image scale. + * 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 * @since 1.5.2 */ public function getImageScale() { return $this->imgscale; } - + + /** + * Returns an array of page dimensions: + * + * @param int $pagenum page number (empty = current page) + * @return array of page dimensions. + * @author Nicola Asuni + * @access public + * @since 4.5.027 (2009-03-16) + */ + public function getPageDimensions($pagenum='') { + if (empty($pagenum)) { + $pagenum = $this->page; + } + return $this->pagedim[$pagenum]; + } + /** * Returns the page width in units. + * @param int $pagenum page number (empty = current page) * @return int page width. * @author Nicola Asuni + * @access public * @since 1.5.2 + * @see getPageDimensions() */ - public function getPageWidth() { - return $this->w; + public function getPageWidth($pagenum='') { + if (empty($pagenum)) { + return $this->w; + } + return $this->pagedim[$pagenum]['w']; } /** * Returns the page height in units. + * @param int $pagenum page number (empty = current page) * @return int page height. * @author Nicola Asuni + * @access public * @since 1.5.2 + * @see getPageDimensions() */ - public function getPageHeight() { - return $this->h; + public function getPageHeight($pagenum='') { + if (empty($pagenum)) { + return $this->h; + } + return $this->pagedim[$pagenum]['h']; } /** * Returns the page break margin. + * @param int $pagenum page number (empty = current page) * @return int page break margin. * @author Nicola Asuni + * @access public * @since 1.5.2 + * @see getPageDimensions() */ - public function getBreakMargin() { - return $this->bMargin; + public function getBreakMargin($pagenum='') { + if (empty($pagenum)) { + return $this->bMargin; + } + return $this->pagedim[$pagenum]['bm']; } /** * Returns the scale factor (number of points in user unit). * @return int scale factor. * @author Nicola Asuni + * @access public * @since 1.5.2 */ public function getScaleFactor() { @@ -1506,6 +2002,7 @@ if (!class_exists('TCPDF', false)) { * @param float $left Left margin. * @param float $top Top margin. * @param float $right Right margin. Default value is the left one. + * @access public * @since 1.0 * @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak() */ @@ -1522,6 +2019,7 @@ if (!class_exists('TCPDF', false)) { /** * 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 * @since 1.4 * @see SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins() */ @@ -1536,6 +2034,7 @@ if (!class_exists('TCPDF', false)) { /** * Defines the top margin. The method can be called before creating the first page. * @param float $margin The margin. + * @access public * @since 1.5 * @see SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins() */ @@ -1550,6 +2049,7 @@ if (!class_exists('TCPDF', false)) { /** * Defines the right margin. The method can be called before creating the first page. * @param float $margin The margin. + * @access public * @since 1.5 * @see SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins() */ @@ -1563,6 +2063,7 @@ if (!class_exists('TCPDF', false)) { /** * Set the internal Cell padding. * @param float $pad internal padding. + * @access public * @since 2.1.000 (2008-01-09) * @see Cell(), SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins() */ @@ -1574,6 +2075,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 1.0 * @see Cell(), MultiCell(), AcceptPageBreak() */ @@ -1589,6 +2091,7 @@ if (!class_exists('TCPDF', false)) { * @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. * @param string $layout The page layout. Possible values are: * @param string $mode A name object specifying how the document should be displayed when opened: + * @access public * @since 1.2 */ public function SetDisplayMode($zoom, $layout='SinglePage', $mode='UseNone') { @@ -1666,6 +2169,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 1.4 */ public function SetCompression($compress) { @@ -1680,6 +2184,7 @@ if (!class_exists('TCPDF', false)) { /** * Defines the title of the document. * @param string $title The title. + * @access public * @since 1.2 * @see SetAuthor(), SetCreator(), SetKeywords(), SetSubject() */ @@ -1691,6 +2196,7 @@ if (!class_exists('TCPDF', false)) { /** * Defines the subject of the document. * @param string $subject The subject. + * @access public * @since 1.2 * @see SetAuthor(), SetCreator(), SetKeywords(), SetTitle() */ @@ -1702,6 +2208,7 @@ if (!class_exists('TCPDF', false)) { /** * Defines the author of the document. * @param string $author The name of the author. + * @access public * @since 1.2 * @see SetCreator(), SetKeywords(), SetSubject(), SetTitle() */ @@ -1713,6 +2220,7 @@ if (!class_exists('TCPDF', false)) { /** * Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. * @param string $keywords The list of keywords. + * @access public * @since 1.2 * @see SetAuthor(), SetCreator(), SetSubject(), SetTitle() */ @@ -1724,6 +2232,7 @@ if (!class_exists('TCPDF', false)) { /** * 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 * @since 1.2 * @see SetAuthor(), SetKeywords(), SetSubject(), SetTitle() */ @@ -1736,16 +2245,21 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 1.0 */ public function Error($msg) { - //Fatal error - die('TCPDF error: '.$msg); + // unset all class variables + $this->_destroy(true); + // exit program and print error + die('TCPDF ERROR: '.$msg); } /** - * This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically. + * 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 * @since 1.0 * @see AddPage(), Close() */ @@ -1755,35 +2269,44 @@ if (!class_exists('TCPDF', false)) { } /** - * 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. + * 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 * @since 1.0 * @see Open(), Output() */ public function Close() { - //Terminate document if ($this->state == 3) { return; } if ($this->page == 0) { $this->AddPage(); } - //Page footer - $this->setFooter(); - //Close page - $this->_endpage(); - //Close document + // close page + $this->endPage(); + // close document $this->_enddoc(); + // unset all class variables (except critical ones) + $this->_destroy(false); } /** * Move pointer at the specified document page and update page dimensions. * @param int $pnum page number * @param boolean $resetmargins if true reset left, right, top margins and Y position. + * @access public * @since 2.1.000 (2008-01-07) * @see getPage(), lastpage(), getNumPages() */ public function setPage($pnum, $resetmargins=false) { - if (($pnum > 0) AND ($pnum <= count($this->pages))) { + if ($pnum == $this->page) { + return; + } + if (($pnum > 0) AND ($pnum <= $this->numpages)) { + $this->state = 2; + // save current graphic settings + //$gvars = $this->getGraphicVars(); $oldpage = $this->page; $this->page = $pnum; $this->wPt = $this->pagedim[$this->page]['w']; @@ -1797,6 +2320,8 @@ if (!class_exists('TCPDF', false)) { $this->AutoPageBreak = $this->pagedim[$this->page]['pb']; $this->CurOrientation = $this->pagedim[$this->page]['or']; $this->SetAutoPageBreak($this->AutoPageBreak, $this->bMargin); + // restore graphic settings + //$this->setGraphicVars($gvars); if ($resetmargins) { $this->lMargin = $this->pagedim[$this->page]['olm']; $this->rMargin = $this->pagedim[$this->page]['orm']; @@ -1817,6 +2342,7 @@ if (!class_exists('TCPDF', false)) { /** * Reset pointer to the last document page. * @param boolean $resetmargins if true reset left, right, top margins and Y position. + * @access public * @since 2.0.000 (2008-01-04) * @see setPage(), getPage(), getNumPages() */ @@ -1827,6 +2353,7 @@ if (!class_exists('TCPDF', false)) { /** * Get current document page number. * @return int page number + * @access public * @since 2.1.000 (2008-01-07) * @see setPage(), lastpage(), getNumPages() */ @@ -1838,17 +2365,17 @@ if (!class_exists('TCPDF', false)) { /** * Get the total number of insered pages. * @return int number of pages + * @access public * @since 2.1.000 (2008-01-07) * @see setPage(), getPage(), lastpage() */ public function getNumPages() { - return count($this->pages); + return $this->numpages; } /** - * Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header. - * The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. - * The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards. + * 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): * @param mixed $format The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit). * @access public @@ -1862,10 +2389,12 @@ if (!class_exists('TCPDF', false)) { if (!isset($this->original_rMargin)) { $this->original_rMargin = $this->rMargin; } + // terminate previous page $this->endPage(); + // start new page $this->startPage($orientation, $format); } - + /** * Terminate the current page * @access protected @@ -1873,19 +2402,20 @@ if (!class_exists('TCPDF', false)) { * @see startPage(), AddPage() */ protected function endPage() { - if (($this->page == 0) OR (count($this->pages) > $this->page)) { + // check if page is already closed + if (($this->page == 0) OR ($this->numpages > $this->page) OR (!$this->pageopen[$this->page])) { return; } - // save current graphic settings - $gvars = $this->getGraphicVars(); + $this->InFooter = true; // print page footer $this->setFooter(); - // restore graphic settings - $this->setGraphicVars($gvars); // close page $this->_endpage(); + // mark page as closed + $this->pageopen[$this->page] = false; + $this->InFooter = false; } - + /** * 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. @@ -1896,7 +2426,7 @@ if (!class_exists('TCPDF', false)) { * @see endPage(), AddPage() */ protected function startPage($orientation='', $format='') { - if (count($this->pages) > $this->page) { + if ($this->numpages > $this->page) { // this page has been already added $this->setPage($this->page + 1); $this->SetY($this->tMargin); @@ -1906,21 +2436,26 @@ if (!class_exists('TCPDF', false)) { if ($this->state == 0) { $this->Open(); } + ++$this->numpages; $this->swapMargins($this->booklet); // save current graphic settings $gvars = $this->getGraphicVars(); // start new page $this->_beginpage($orientation, $format); + // mark page as open + $this->pageopen[$this->page] = true; // restore graphic settings $this->setGraphicVars($gvars); // mark this point - $this->intmrk[$this->page] = strlen($this->pages[$this->page]); + $this->setPageMark(); // print page header $this->setHeader(); // restore graphic settings $this->setGraphicVars($gvars); // mark this point - $this->intmrk[$this->page] = strlen($this->pages[$this->page]); + $this->setPageMark(); + // print table header (if any) + $this->setTableHeader(); } /** @@ -1931,7 +2466,25 @@ if (!class_exists('TCPDF', false)) { * @since 4.0.016 (2008-07-30) */ public function setPageMark() { - $this->intmrk[$this->page] = strlen($this->pages[$this->page]); + $this->intmrk[$this->page] = $this->pagelen[$this->page]; + $this->setContentMark(); + } + + /** + * Set start-writing mark on selected page. + * @param int $page page number (default is the current page) + * @access protected + * @since 4.6.021 (2009-07-20) + */ + protected function setContentMark($page=0) { + if ($page <= 0) { + $page = $this->page; + } + if (isset($this->footerlen[$page])) { + $this->cntmrk[$page] = $this->pagelen[$page] - $this->footerlen[$page]; + } else { + $this->cntmrk[$page] = $this->pagelen[$page]; + } } /** @@ -1940,7 +2493,8 @@ if (!class_exists('TCPDF', false)) { * @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 + */ public function setHeaderData($ln='', $lw=0, $ht='', $hs='') { $this->header_logo = $ln; $this->header_logo_width = $lw; @@ -1952,6 +2506,7 @@ if (!class_exists('TCPDF', false)) { * Returns header data: * * @return array() + * @access public * @since 4.0.012 (2008-07-24) */ public function getHeaderData() { @@ -1967,7 +2522,8 @@ if (!class_exists('TCPDF', false)) { * Set header margin. * (minimum distance between header and top page margin) * @param int $hm distance in user units - */ + * @access public + */ public function setHeaderMargin($hm=10) { $this->header_margin = $hm; } @@ -1976,7 +2532,8 @@ if (!class_exists('TCPDF', false)) { * Returns header margin in user units. * @return float * @since 4.0.012 (2008-07-24) - */ + * @access public + */ public function getHeaderMargin() { return $this->header_margin; } @@ -1985,7 +2542,8 @@ if (!class_exists('TCPDF', false)) { * Set footer margin. * (minimum distance between footer and bottom page margin) * @param int $fm distance in user units - */ + * @access public + */ public function setFooterMargin($fm=10) { $this->footer_margin = $fm; } @@ -1994,13 +2552,15 @@ if (!class_exists('TCPDF', false)) { * Returns footer margin in user units. * @return float * @since 4.0.012 (2008-07-24) - */ + * @access 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 */ public function setPrintHeader($val=true) { $this->print_header = $val; @@ -2009,6 +2569,7 @@ if (!class_exists('TCPDF', false)) { /** * Set a flag to print page footer. * @param boolean $value set to true to print the page footer (default), false otherwise. + * @access public */ public function setPrintFooter($val=true) { $this->print_footer = $val; @@ -2017,6 +2578,7 @@ if (!class_exists('TCPDF', false)) { /** * Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image * @return float + * @access public */ public function getImageRBX() { return $this->img_rb_x; @@ -2025,6 +2587,7 @@ if (!class_exists('TCPDF', false)) { /** * Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image * @return float + * @access public */ public function getImageRBY() { return $this->img_rb_y; @@ -2033,6 +2596,7 @@ if (!class_exists('TCPDF', false)) { /** * 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 function Header() { $ormargins = $this->getOriginalMargins(); @@ -2054,7 +2618,7 @@ if (!class_exists('TCPDF', false)) { $this->SetTextColor(0, 0, 0); // header title $this->SetFont($headerfont[0], 'B', $headerfont[2] + 1); - $this->SetX($header_x); + $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]); @@ -2062,7 +2626,7 @@ if (!class_exists('TCPDF', false)) { $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(1 + max($imgy, $this->GetY())); + $this->SetY((2.835 / $this->getScaleFactor()) + max($imgy, $this->GetY())); if ($this->getRTL()) { $this->SetX($ormargins['right']); } else { @@ -2074,6 +2638,7 @@ if (!class_exists('TCPDF', 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 function Footer() { $cur_y = $this->GetY(); @@ -2085,11 +2650,15 @@ if (!class_exists('TCPDF', false)) { //print document barcode $barcode = $this->getBarcode(); if (!empty($barcode)) { - $this->Ln(); + $this->Ln($line_width); $barcode_width = round(($this->getPageWidth() - $ormargins['left'] - $ormargins['right'])/3); $this->write1DBarcode($barcode, 'C128B', $this->GetX(), $cur_y + $line_width, $barcode_width, (($this->getFooterMargin() / 3) - $line_width), 0.3, '', ''); } - $pagenumtxt = $this->l['w_page'].' '.$this->PageNoFormatted().' / '.$this->getAliasNbPages(); + if (empty($this->pagegroups)) { + $pagenumtxt = $this->l['w_page'].' '.$this->getAliasNumPage().' / '.$this->getAliasNbPages(); + } else { + $pagenumtxt = $this->l['w_page'].' '.$this->getPageNumGroupAlias().' / '.$this->getPageGroupAlias(); + } $this->SetY($cur_y); //Print page number if ($this->getRTL()) { @@ -2108,6 +2677,8 @@ if (!class_exists('TCPDF', false)) { */ protected function setHeader() { if ($this->print_header) { + $temp_thead = $this->thead; + $temp_theadMargins = $this->theadMargins; $lasth = $this->lasth; $this->_out('q'); $this->rMargin = $this->original_rMargin; @@ -2129,6 +2700,8 @@ if (!class_exists('TCPDF', false)) { } $this->_out('Q'); $this->lasth = $lasth; + $this->thead = $temp_thead; + $this->theadMargins = $temp_theadMargins; } } @@ -2139,10 +2712,14 @@ if (!class_exists('TCPDF', false)) { */ protected function setFooter() { //Page footer - $this->InFooter = true; + // save current graphic settings + $gvars = $this->getGraphicVars(); // mark this point - $this->footerpos[$this->page] = strlen($this->pages[$this->page]); + $this->footerpos[$this->page] = $this->pagelen[$this->page]; + $this->_out("\n"); if ($this->print_footer) { + $temp_thead = $this->thead; + $temp_theadMargins = $this->theadMargins; $lasth = $this->lasth; $this->_out('q'); $this->rMargin = $this->original_rMargin; @@ -2155,7 +2732,7 @@ if (!class_exists('TCPDF', false)) { } else { $this->SetXY($this->original_lMargin, $footer_y); } - $this->SetFont($this->footer_font[0], $this->footer_font[1] , $this->footer_font[2]); + $this->SetFont($this->footer_font[0], $this->footer_font[1], $this->footer_font[2]); $this->Footer(); //restore position if ($this->rtl) { @@ -2165,14 +2742,52 @@ if (!class_exists('TCPDF', false)) { } $this->_out('Q'); $this->lasth = $lasth; + $this->thead = $temp_thead; + $this->theadMargins = $temp_theadMargins; + } + // restore graphic settings + $this->setGraphicVars($gvars); + // calculate footer length + $this->footerlen[$this->page] = $this->pagelen[$this->page] - $this->footerpos[$this->page] + 1; + } + + /** + * This method is used to render the table header on new page (if any). + * @access protected + * @since 4.5.030 (2009-03-25) + */ + protected function setTableHeader() { + if (isset($this->theadMargins['top'])) { + // restore the original top-margin + $this->tMargin = $this->theadMargins['top']; + $this->pagedim[$this->page]['tm'] = $this->tMargin; + $this->y = $this->tMargin; + } + if (!$this->empty_string($this->thead) AND (!$this->inthead)) { + // set margins + $prev_lMargin = $this->lMargin; + $prev_rMargin = $this->rMargin; + $this->lMargin = $this->pagedim[$this->page]['olm']; + $this->rMargin = $this->pagedim[$this->page]['orm']; + $this->cMargin = $this->theadMargins['cmargin']; + // print table header + $this->writeHTML($this->thead, false, false, false, false, ''); + // set new top margin to skip the table headers + if (!isset($this->theadMargins['top'])) { + $this->theadMargins['top'] = $this->tMargin; + } + $this->tMargin = $this->y; + $this->pagedim[$this->page]['tm'] = $this->tMargin; + $this->lasth = 0; + $this->lMargin = $prev_lMargin; + $this->rMargin = $prev_rMargin; } - $this->footerlen[$this->page] = strlen($this->pages[$this->page]) - $this->footerpos[$this->page]; - $this->InFooter = false; } /** * Returns the current page number. * @return int page number + * @access public * @since 1.0 * @see AliasNbPages(), getAliasNbPages() */ @@ -2188,6 +2803,7 @@ if (!class_exists('TCPDF', false)) { * @param int $m Magenta color for CMYK. Value between 0 and 255 * @param int $y Yellow color for CMYK. Value between 0 and 255 * @param int $k Key (Black) color for CMYK. Value between 0 and 255 + * @access public * @since 4.0.024 (2008-09-12) * @see SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor() */ @@ -2203,6 +2819,7 @@ if (!class_exists('TCPDF', false)) { * 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 + * @access public * @since 3.1.000 (2008-06-11) * @see SetDrawColor() */ @@ -2225,6 +2842,7 @@ if (!class_exists('TCPDF', false)) { * @param int $col2 Green color for RGB, or Magenta color for CMYK. Value between 0 and 255 * @param int $col3 Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255 * @param int $col4 Key (Black) color for CMYK. Value between 0 and 255 + * @access public * @since 1.3 * @see SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell() */ @@ -2245,13 +2863,13 @@ if (!class_exists('TCPDF', false)) { //Set color for all stroking operations if (($col2 == -1) AND ($col3 == -1) AND ($col4 == -1)) { // Grey scale - $this->DrawColor = sprintf('%.3f G', $col1/255); + $this->DrawColor = sprintf('%.3F G', $col1/255); } elseif ($col4 == -1) { // RGB - $this->DrawColor = sprintf('%.3f %.3f %.3f RG', $col1/255, $col2/255, $col3/255); + $this->DrawColor = sprintf('%.3F %.3F %.3F RG', $col1/255, $col2/255, $col3/255); } else { // CMYK - $this->DrawColor = sprintf('%.3f %.3f %.3f %.3f K', $col1/100, $col2/100, $col3/100, $col4/100); + $this->DrawColor = sprintf('%.3F %.3F %.3F %.3F K', $col1/100, $col2/100, $col3/100, $col4/100); } if ($this->page > 0) { $this->_out($this->DrawColor); @@ -2262,6 +2880,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 4.0.024 (2008-09-12) * @see AddSpotColor(), SetFillSpotColor(), SetTextSpotColor() */ @@ -2269,7 +2888,7 @@ if (!class_exists('TCPDF', false)) { if (!isset($this->spot_colors[$name])) { $this->Error('Undefined spot color: '.$name); } - $this->DrawColor = sprintf('/CS%d CS %.3f SCN', $this->spot_colors[$name]['i'], $tint/100); + $this->DrawColor = sprintf('/CS%d CS %.3F SCN', $this->spot_colors[$name]['i'], $tint/100); if ($this->page > 0) { $this->_out($this->DrawColor); } @@ -2280,6 +2899,7 @@ if (!class_exists('TCPDF', false)) { * 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 + * @access public * @since 3.1.000 (2008-6-11) * @see SetFillColor() */ @@ -2302,6 +2922,7 @@ if (!class_exists('TCPDF', false)) { * @param int $col2 Green color for RGB, or Magenta color for CMYK. Value between 0 and 255 * @param int $col3 Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255 * @param int $col4 Key (Black) color for CMYK. Value between 0 and 255 + * @access public * @since 1.3 * @see SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell() */ @@ -2322,15 +2943,15 @@ if (!class_exists('TCPDF', false)) { //Set color for all filling operations if (($col2 == -1) AND ($col3 == -1) AND ($col4 == -1)) { // Grey scale - $this->FillColor = sprintf('%.3f g', $col1/255); + $this->FillColor = sprintf('%.3F g', $col1/255); $this->bgcolor = array('G' => $col1); } elseif ($col4 == -1) { // RGB - $this->FillColor = sprintf('%.3f %.3f %.3f rg', $col1/255, $col2/255, $col3/255); + $this->FillColor = sprintf('%.3F %.3F %.3F rg', $col1/255, $col2/255, $col3/255); $this->bgcolor = array('R' => $col1, 'G' => $col2, 'B' => $col3); } else { // CMYK - $this->FillColor = sprintf('%.3f %.3f %.3f %.3f k', $col1/100, $col2/100, $col3/100, $col4/100); + $this->FillColor = sprintf('%.3F %.3F %.3F %.3F k', $col1/100, $col2/100, $col3/100, $col4/100); $this->bgcolor = array('C' => $col1, 'M' => $col2, 'Y' => $col3, 'K' => $col4); } $this->ColorFlag = ($this->FillColor != $this->TextColor); @@ -2343,6 +2964,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 4.0.024 (2008-09-12) * @see AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor() */ @@ -2350,7 +2972,7 @@ if (!class_exists('TCPDF', false)) { if (!isset($this->spot_colors[$name])) { $this->Error('Undefined spot color: '.$name); } - $this->FillColor = sprintf('/CS%d cs %.3f scn', $this->spot_colors[$name]['i'], $tint/100); + $this->FillColor = sprintf('/CS%d cs %.3F scn', $this->spot_colors[$name]['i'], $tint/100); $this->ColorFlag = ($this->FillColor != $this->TextColor); if ($this->page > 0) { $this->_out($this->FillColor); @@ -2361,6 +2983,7 @@ if (!class_exists('TCPDF', false)) { * 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 + * @access public * @since 3.1.000 (2008-6-11) * @see SetFillColor() */ @@ -2383,6 +3006,7 @@ if (!class_exists('TCPDF', false)) { * @param int $col2 Green color for RGB, or Magenta color for CMYK. Value between 0 and 255 * @param int $col3 Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255 * @param int $col4 Key (Black) color for CMYK. Value between 0 and 255 + * @access public * @since 1.3 * @see SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell() */ @@ -2403,15 +3027,15 @@ if (!class_exists('TCPDF', false)) { //Set color for text if (($col2 == -1) AND ($col3 == -1) AND ($col4 == -1)) { // Grey scale - $this->TextColor = sprintf('%.3f g', $col1/255); + $this->TextColor = sprintf('%.3F g', $col1/255); $this->fgcolor = array('G' => $col1); } elseif ($col4 == -1) { // RGB - $this->TextColor = sprintf('%.3f %.3f %.3f rg', $col1/255, $col2/255, $col3/255); + $this->TextColor = sprintf('%.3F %.3F %.3F rg', $col1/255, $col2/255, $col3/255); $this->fgcolor = array('R' => $col1, 'G' => $col2, 'B' => $col3); } else { // CMYK - $this->TextColor = sprintf('%.3f %.3f %.3f %.3f k', $col1/100, $col2/100, $col3/100, $col4/100); + $this->TextColor = sprintf('%.3F %.3F %.3F %.3F k', $col1/100, $col2/100, $col3/100, $col4/100); $this->fgcolor = array('C' => $col1, 'M' => $col2, 'Y' => $col3, 'K' => $col4); } $this->ColorFlag = ($this->FillColor != $this->TextColor); @@ -2421,6 +3045,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 4.0.024 (2008-09-12) * @see AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor() */ @@ -2428,7 +3053,7 @@ if (!class_exists('TCPDF', false)) { if (!isset($this->spot_colors[$name])) { $this->Error('Undefined spot color: '.$name); } - $this->TextColor = sprintf('/CS%d cs %.3f scn', $this->spot_colors[$name]['i'], $tint/100); + $this->TextColor = sprintf('/CS%d cs %.3F scn', $this->spot_colors[$name]['i'], $tint/100); $this->ColorFlag = ($this->FillColor != $this->TextColor); if ($this->page > 0) { $this->_out($this->TextColor); @@ -2441,60 +3066,80 @@ if (!class_exists('TCPDF', false)) { * @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): or any combination. The default value is regular. * @param float $fontsize Font size in points. The default value is the current size. - * @return int string length + * @param boolean $getarray 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 * @since 1.2 */ - public function GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0) { - return $this->GetArrStringWidth($this->utf8Bidi($this->UTF8StringToArray($s), $this->tmprtl), $fontname, $fontstyle, $fontsize); + public function GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) { + return $this->GetArrStringWidth($this->utf8Bidi($this->UTF8StringToArray($s), $s, $this->tmprtl), $fontname, $fontstyle, $fontsize, $getarray); } /** - * Returns the string length of an array of chars in user unit. A font must be selected.
    - * @param string $arr The array of chars whose total length is to be computed + * 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): or any combination. The default value is regular. * @param float $fontsize Font size in points. The default value is the current size. - * @return int string length + * @param boolean $getarray 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 * @since 2.4.000 (2008-03-06) */ - public function GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0) { + public function GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) { // store current values - if (!empty($fontname)) { + if (!$this->empty_string($fontname)) { $prev_FontFamily = $this->FontFamily; $prev_FontStyle = $this->FontStyle; $prev_FontSizePt = $this->FontSizePt; $this->SetFont($fontname, $fontstyle, $fontsize); } - $w = 0; + // convert UTF-8 array to Latin1 if required + $sa = $this->UTF8ArrToLatin1($sa); + $w = 0; // total width + $wa = array(); // array of characters widths foreach ($sa as $char) { - $w += $this->GetCharWidth($char); + // character width + $cw = $this->GetCharWidth($char); + $wa[] = $cw; + $w += $cw; } // restore previous values - if (!empty($fontname)) { + if (!$this->empty_string($fontname)) { $this->SetFont($prev_FontFamily, $prev_FontStyle, $prev_FontSizePt); } + if ($getarray) { + return $wa; + } return $w; } /** - * Returns the length of the char in user unit for the current font.
    + * 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 * @return int char width * @author Nicola Asuni + * @access public * @since 2.4.000 (2008-03-06) */ public function GetCharWidth($char) { + if ($char == 173) { + // SHY character will not be printed + return (0); + } $cw = &$this->CurrentFont['cw']; if (isset($cw[$char])) { $w = $cw[$char]; } elseif (isset($this->CurrentFont['dw'])) { + // default width $w = $this->CurrentFont['dw']; - } elseif (isset($this->CurrentFont['desc']['MissingWidth'])) { - $w = $this->CurrentFont['desc']['MissingWidth']; // set default size + } elseif (isset($cw[32])) { + // default width + $dw = $cw[32]; } else { - $w = 500; // default width + $w = 600; } return ($w * $this->FontSize / 1000); } @@ -2503,6 +3148,7 @@ if (!class_exists('TCPDF', false)) { * Returns the numbero of characters in a string. * @param string $s The input string. * @return int number of characters + * @access public * @since 2.0.0001 (2008-01-07) */ public function GetNumChars($s) { @@ -2521,7 +3167,7 @@ if (!class_exists('TCPDF', false)) { $fontsdir = opendir($this->_getfontpath()); while (($file = readdir($fontsdir)) !== false) { if (substr($file, -4) == '.php') { - array_push($this->fontlist, strtolower(basename($file, '.php'))); + array_push($this->fontlist, strtolower(basename($file, '.php'))); } } closedir($fontsdir); @@ -2531,24 +3177,24 @@ if (!class_exists('TCPDF', false)) { * 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. - * Changed to support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. * @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): - * @param string $file The font definition file. By default, the name is built from the family and style, in lower case with no space. + * @param string $fontfile 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. + * @access public * @since 1.5 * @see SetFont() */ - public function AddFont($family, $style='', $file='') { - if (empty($family)) { - if (!empty($this->FontFamily)) { + public function AddFont($family, $style='', $fontfile='') { + if ($this->empty_string($family)) { + if (!$this->empty_string($this->FontFamily)) { $family = $this->FontFamily; } else { $this->Error('Empty font family'); } } $family = strtolower($family); - if ((!$this->isunicode) AND ($family == 'arial')) { + if ((!$this->isunicode) AND ($family == 'Arial')) { $family = 'helvetica'; } if (($family == 'symbol') OR ($family == 'zapfdingbats')) { @@ -2576,62 +3222,119 @@ if (!class_exists('TCPDF', false)) { if (strpos($tempstyle, 'I') !== false) { $style .= 'I'; } + $bistyle = $style; $fontkey = $family.$style; $font_style = $style.($this->underline ? 'U' : '').($this->linethrough ? 'D' : ''); $fontdata = array('fontkey' => $fontkey, 'family' => $family, 'style' => $font_style); // check if the font has been already added - if (isset($this->fonts[$fontkey])) { + if ($this->getFontBuffer($fontkey) !== false) { return $fontdata; } - if ($file == '') { - $file = str_replace(' ', '', $family).strtolower($style).'.php'; - } - if (!file_exists($this->_getfontpath().$file)) { - // try to load the basic file without styles - $file = str_replace(' ', '', $family).'.php'; - } if (isset($type)) { unset($type); } if (isset($cw)) { unset($cw); } - include($this->_getfontpath().$file); - if ((!isset($type)) OR (!isset($cw))) { - $this->Error('Could not include font definition file'); + // get specified font directory (if any) + $fontdir = ''; + if (!$this->empty_string($fontfile)) { + $fontdir = dirname($fontfile); + if ($this->empty_string($fontdir) OR ($fontdir == '.')) { + $fontdir = ''; + } else { + $fontdir .= '/'; + } } - $i = count($this->fonts) + 1; - // register CID font (all styles at once) - if ($type == 'cidfont0') { - $styles = array('' => '', 'B' => ',Bold', 'I' => ',Italic', 'BI' => ',BoldItalic'); - foreach ($styles as $skey => $qual) { - $sname = $name.$qual; - $sfontkey = $family.$skey; - $this->fonts[$sfontkey] = array('i' => $i, 'type' => $type, 'name' => $sname, 'desc' => $desc, 'cidinfo' => $cidinfo, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'dw' => $dw, 'enc' => $enc); - $i = count($this->fonts) + 1; + // search and include font file + if ($this->empty_string($fontfile) OR (!file_exists($fontfile))) { + // build a standard filenames for specified font + $fontfile1 = str_replace(' ', '', $family).strtolower($style).'.php'; + $fontfile2 = str_replace(' ', '', $family).'.php'; + // search files on various directories + if (file_exists($fontdir.$fontfile1)) { + $fontfile = $fontdir.$fontfile1; + } elseif (file_exists($this->_getfontpath().$fontfile1)) { + $fontfile = $this->_getfontpath().$fontfile1; + } elseif (file_exists($fontfile1)) { + $fontfile = $fontfile1; + } elseif (file_exists($fontdir.$fontfile2)) { + $fontfile = $fontdir.$fontfile2; + } elseif (file_exists($this->_getfontpath().$fontfile2)) { + $fontfile = $this->_getfontpath().$fontfile2; + } else { + $fontfile = $fontfile2; } - $file = ''; - } elseif ($type == 'core') { - $def_width = $cw[ord('"')]; - $this->fonts[$fontkey] = array('i' => $i, 'type' => 'core', 'name' => $this->CoreFonts[$fontkey], 'up' => -100, 'ut' => 50, 'cw' => $cw, 'dw' => $def_width); - } elseif (($type == 'TrueType') OR ($type == 'Type1')) { - if (!isset($file)) { - $file = ''; - } - if (!isset($enc)) { - $enc = ''; - } - $this->fonts[$fontkey] = array('i' => $i, 'type' => $type, 'name' => $name, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'file' => $file, 'enc' => $enc, 'desc' => $desc); - } elseif ($type == 'TrueTypeUnicode') { - $this->fonts[$fontkey] = array('i' => $i, 'type' => $type, 'name' => $name, 'desc' => $desc, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'enc' => $enc, 'file' => $file, 'ctg' => $ctg); + } + // include font file + if (file_exists($fontfile)) { + include($fontfile); } else { - $this->Error('Unknow font type'); + $this->Error('Could not include font definition file: '.$family.''); } + // check font parameters + if ((!isset($type)) OR (!isset($cw))) { + $this->Error('The font definition file has a bad format: '.$fontfile.''); + } + // SET default parameters + if (!isset($file) OR $this->empty_string($file)) { + $file = ''; + } + if (!isset($enc) OR $this->empty_string($enc)) { + $enc = ''; + } + if (!isset($cidinfo) OR $this->empty_string($cidinfo)) { + $cidinfo = array('Registry'=>'Adobe','Ordering'=>'Identity','Supplement'=>0); + $cidinfo['uni2cid'] = array(); + } + if (!isset($ctg) OR $this->empty_string($ctg)) { + $ctg = ''; + } + if (!isset($desc) OR $this->empty_string($desc)) { + $desc = array(); + } + if (!isset($up) OR $this->empty_string($up)) { + $up = -100; + } + if (!isset($ut) OR $this->empty_string($ut)) { + $ut = 50; + } + if (!isset($cw) OR $this->empty_string($cw)) { + $cw = array(); + } + if (!isset($dw) OR $this->empty_string($dw)) { + // set default width + if (isset($desc['MissingWidth']) AND ($desc['MissingWidth'] > 0)) { + $dw = $desc['MissingWidth']; + } elseif (isset($cw[32])) { + $dw = $cw[32]; + } else { + $dw = 600; + } + } + ++$this->numfonts; + if ($type == 'cidfont0') { + // register CID font (all styles at once) + $styles = array('' => '', 'B' => ',Bold', 'I' => ',Italic', 'BI' => ',BoldItalic'); + $sname = $name.$styles[$bistyle]; + if ((strpos($bistyle, 'B') !== false) AND (isset($desc['StemV'])) AND ($desc['StemV'] == 70)) { + $desc['StemV'] = 120; + } + } elseif ($type == 'core') { + $name = $this->CoreFonts[$fontkey]; + } elseif (($type == 'TrueType') OR ($type == 'Type1')) { + // ... + } elseif ($type == 'TrueTypeUnicode') { + $enc = 'Identity-H'; + } else { + $this->Error('Unknow font type: '.$type.''); + } + $this->setFontBuffer($fontkey, array('i' => $this->numfonts, 'type' => $type, 'name' => $name, 'desc' => $desc, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'dw' => $dw, 'enc' => $enc, 'cidinfo' => $cidinfo, 'file' => $file, 'ctg' => $ctg)); if (isset($diff) AND (!empty($diff))) { //Search existing encodings $d = 0; $nb = count($this->diffs); - for($i=1; $i <= $nb; $i++) { + for ($i=1; $i <= $nb; ++$i) { if ($this->diffs[$i] == $diff) { $d = $i; break; @@ -2641,13 +3344,13 @@ if (!class_exists('TCPDF', false)) { $d = $nb + 1; $this->diffs[$d] = $diff; } - $this->fonts[$fontkey]['diff'] = $d; + $this->setFontSubBuffer($fontkey, 'diff', $d); } - if (!empty($file)) { - if ((strcasecmp($type,'TrueType') == 0) OR (strcasecmp($type,'TrueTypeUnicode') == 0)) { - $this->FontFiles[$file] = array('length1' => $originalsize); + if (!$this->empty_string($file)) { + if ((strcasecmp($type,'TrueType') == 0) OR (strcasecmp($type, 'TrueTypeUnicode') == 0)) { + $this->FontFiles[$file] = array('length1' => $originalsize, 'fontdir' => $fontdir); } elseif ($type != 'core') { - $this->FontFiles[$file] = array('length1' => $size1, 'length2' => $size2); + $this->FontFiles[$file] = array('length1' => $size1, 'length2' => $size2, 'fontdir' => $fontdir); } } return $fontdata; @@ -2662,31 +3365,28 @@ if (!class_exists('TCPDF', false)) { * @param string $family Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive): 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): 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. + * @access public * @since 1.0 * @see AddFont(), SetFontSize() */ - public function SetFont($family, $style='', $size=0) { - $family = strtolower($family); - if($family =='' && $this->FontFamily != '') { - $family=$this->FontFamily; - } - else - $family='FreeSerif'; + public function SetFont($family, $style='', $size=0, $fontfile='') { //Select a font; size given in points if ($size == 0) { $size = $this->FontSizePt; } // try to add font (if not already added) - $fontdata = $this->AddFont($family, $style); + $fontdata = $this->AddFont($family, $style, $fontfile); $this->FontFamily = $fontdata['family']; $this->FontStyle = $fontdata['style']; - $this->CurrentFont = &$this->fonts[$fontdata['fontkey']]; + $this->CurrentFont = $this->getFontBuffer($fontdata['fontkey']); $this->SetFontSize($size); } /** * Defines the size of the current font. * @param float $size The size (in points) + * @access public * @since 1.0 * @see SetFont() */ @@ -2705,13 +3405,24 @@ if (!class_exists('TCPDF', false)) { $this->FontDescent = 0.2 * $this->FontSize; } if (($this->page > 0) AND (isset($this->CurrentFont['i']))) { - $this->_out(sprintf('BT /F%d %.2f Tf ET', $this->CurrentFont['i'], $this->FontSizePt)); + $this->_out(sprintf('BT /F%d %.2F Tf ET', $this->CurrentFont['i'], $this->FontSizePt)); } } + /** + * Defines the default monospaced font. + * @param string $font Font name. + * @access public + * @since 4.5.025 + */ + public function SetDefaultMonospacedFont($font) { + $this->default_monospaced_font = $font; + } + /** * 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 * @since 1.5 * @see Cell(), Write(), Image(), Link(), SetLink() */ @@ -2727,6 +3438,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 1.5 * @see AddLink() */ @@ -2749,6 +3461,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 1.5 * @see AddLink(), Annotation(), Cell(), Write(), Image() */ @@ -2766,54 +3479,108 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 4.0.018 (2008-08-06) */ - public function Annotation($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) { + public function Annotation($x='', $y='', $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } // recalculate coordinates to account for graphic transformations if (isset($this->transfmatrix)) { - $maxid = count($this->transfmatrix) - 1; - for ($i=$maxid; $i >= 0; $i--) { - $ctm = $this->transfmatrix[$i]; - if (isset($ctm['a'])) { - $x = $x * $this->k; - $y = ($this->h - $y) * $this->k; - $w = $w * $this->k; - $h = $h * $this->k; - // top left - $xt = $x; - $yt = $y; - $x1 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; - $y1 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; - // top right - $xt = $x + $w; - $yt = $y; - $x2 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; - $y2 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; - // bottom left - $xt = $x; - $yt = $y - $h; - $x3 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; - $y3 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; - // bottom right - $xt = $x + $w; - $yt = $y - $h; - $x4 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; - $y4 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; - // new coordinates (rectangle area) - $x = min($x1, $x2, $x3, $x4); - $y = max($y1, $y2, $y3, $y4); - $w = (max($x1, $x2, $x3, $x4) - $x) / $this->k; - $h = ($y - min($y1, $y2, $y3, $y4)) / $this->k; - $x = $x / $this->k; - $y = $this->h - ($y / $this->k); + for ($i=$this->transfmatrix_key; $i > 0; --$i) { + $maxid = count($this->transfmatrix[$i]) - 1; + for ($j=$maxid; $j >= 0; --$j) { + $ctm = $this->transfmatrix[$i][$j]; + if (isset($ctm['a'])) { + $x = $x * $this->k; + $y = ($this->h - $y) * $this->k; + $w = $w * $this->k; + $h = $h * $this->k; + // top left + $xt = $x; + $yt = $y; + $x1 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; + $y1 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; + // top right + $xt = $x + $w; + $yt = $y; + $x2 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; + $y2 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; + // bottom left + $xt = $x; + $yt = $y - $h; + $x3 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; + $y3 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; + // bottom right + $xt = $x + $w; + $yt = $y - $h; + $x4 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e']; + $y4 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f']; + // new coordinates (rectangle area) + $x = min($x1, $x2, $x3, $x4); + $y = max($y1, $y2, $y3, $y4); + $w = (max($x1, $x2, $x3, $x4) - $x) / $this->k; + $h = ($y - min($y1, $y2, $y3, $y4)) / $this->k; + $x = $x / $this->k; + $y = $this->h - ($y / $this->k); + } } } } - $this->PageAnnots[$this->page][] = array('x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'txt' => $text, 'opt' => $opt, 'numspaces' => $spaces); + if ($this->page <= 0) { + $page = 1; + } else { + $page = $this->page; + } + if (!isset($this->PageAnnots[$page])) { + $this->PageAnnots[$page] = array(); + } + $this->PageAnnots[$page][] = array('x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'txt' => $text, 'opt' => $opt, 'numspaces' => $spaces); + if ((($opt['Subtype'] == 'FileAttachment') OR ($opt['Subtype'] == 'Sound')) AND (!$this->empty_string($opt['FS'])) AND file_exists($opt['FS']) AND (!isset($this->embeddedfiles[basename($opt['FS'])]))) { + $this->embeddedfiles[basename($opt['FS'])] = array('file' => $opt['FS'], 'n' => (count($this->embeddedfiles) + $this->embedded_start_obj_id)); + } + // Add widgets annotation's icons + if (isset($opt['mk']['i']) AND file_exists($opt['mk']['i'])) { + $this->Image($opt['mk']['i'], '', '', 10, 10, '', '', '', false, 300, '', false, false, 0, false, true); + } + if (isset($opt['mk']['ri']) AND file_exists($opt['mk']['ri'])) { + $this->Image($opt['mk']['ri'], '', '', 0, 0, '', '', '', false, 300, '', false, false, 0, false, true); + } + if (isset($opt['mk']['ix']) AND file_exists($opt['mk']['ix'])) { + $this->Image($opt['mk']['ix'], '', '', 0, 0, '', '', '', false, 300, '', false, false, 0, false, true); + } + ++$this->annot_obj_id; + } + + /** + * Embedd the attached files. + * @since 4.4.000 (2008-12-07) + * @access protected + * @see Annotation() + */ + protected function _putEmbeddedFiles() { + reset($this->embeddedfiles); + foreach ($this->embeddedfiles as $filename => $filedata) { + $data = file_get_contents($filedata['file']); + $filter = ''; + if ($this->compress) { + $data = gzcompress($data); + $filter = ' /Filter /FlateDecode'; + } + $this->offsets[$filedata['n']] = $this->bufferlen; + $this->_out($filedata['n'].' 0 obj'); + $this->_out('<>'); + $this->_putstream($data); + $this->_out('endobj'); + } } /** - * Prints a character string. + * Prints a character string. * The origin is on the left of the first charcter, on the baseline. * This method allows to place a string precisely on the page. * @param float $x Abscissa of the origin @@ -2821,6 +3588,7 @@ if (!class_exists('TCPDF', false)) { * @param string $txt String to print * @param int $stroke outline size in points (0 = disable) * @param boolean $clip if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation). + * @access public * @since 1.0 * @deprecated deprecated since version 4.3.005 (2008-11-25) * @see Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell() @@ -2829,9 +3597,9 @@ if (!class_exists('TCPDF', false)) { //Output a string if ($this->rtl) { // bidirectional algorithm (some chars may be changed affecting the line length) - $s = $this->utf8Bidi($this->UTF8StringToArray($txt), $this->tmprtl); + $s = $this->utf8Bidi($this->UTF8StringToArray($txt), $txt, $this->tmprtl); $l = $this->GetArrStringWidth($s); - $xr = $this->w - $x - $this->GetArrStringWidth($s); + $xr = $this->w - $x - $l; } else { $xr = $x; } @@ -2843,7 +3611,7 @@ if (!class_exists('TCPDF', false)) { } elseif ($clip) { $opt .= '7 Tr '; } - $s = sprintf('BT %.2f %.2f Td %s(%s) Tj ET 0 Tr', $xr * $this->k, ($this->h-$y) * $this->k, $opt, $this->_escapetext($txt)); + $s = sprintf('BT %.2F %.2F Td %s(%s) Tj ET 0 Tr', $xr * $this->k, ($this->h-$y) * $this->k, $opt, $this->_escapetext($txt)); if ($this->underline AND ($txt!='')) { $s .= ' '.$this->_dounderline($xr, $y, $txt); } @@ -2861,6 +3629,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 1.4 * @see SetAutoPageBreak() */ @@ -2871,39 +3640,35 @@ if (!class_exists('TCPDF', false)) { /** * 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 * @return boolean true in case of page break, false otherwise. * @since 3.2.000 (2008-07-01) * @access protected */ - protected function checkPageBreak($h) { - if ((($this->y + $h) > $this->PageBreakTrigger) AND (!$this->InFooter) AND ($this->AcceptPageBreak())) { - $rs = ''; - //Automatic page break - $x = $this->x; - $ws = $this->ws; - if ($ws > 0) { - $this->ws = 0; - $rs .= '0 Tw'; - } - $this->AddPage($this->CurOrientation); - if ($ws > 0) { - $this->ws = $ws; - $rs .= sprintf('%.3f Tw', $ws * $k); - } - $this->_out($rs); - $this->y = $this->tMargin; - $oldpage = $this->page - 1; - if ($this->rtl) { - if ($this->pagedim[$this->page]['orm'] != $this->pagedim[$oldpage]['orm']) { - $this->x = $x - ($this->pagedim[$this->page]['orm'] - $this->pagedim[$oldpage]['orm']); + protected function checkPageBreak($h=0, $y='', $addpage=true) { + if ($this->empty_string($y)) { + $y = $this->y; + } + if ((($y + $h) > $this->PageBreakTrigger) AND (!$this->InFooter) AND ($this->AcceptPageBreak())) { + if ($addpage) { + //Automatic page break + $x = $this->x; + $this->AddPage($this->CurOrientation); + $this->y = $this->tMargin; + $oldpage = $this->page - 1; + if ($this->rtl) { + if ($this->pagedim[$this->page]['orm'] != $this->pagedim[$oldpage]['orm']) { + $this->x = $x - ($this->pagedim[$this->page]['orm'] - $this->pagedim[$oldpage]['orm']); + } else { + $this->x = $x; + } } else { - $this->x = $x; - } - } else { - if ($this->pagedim[$this->page]['olm'] != $this->pagedim[$oldpage]['olm']) { - $this->x = $x + ($this->pagedim[$this->page]['olm'] - $this->pagedim[$oldpage]['olm']); - } else { - $this->x = $x; + if ($this->pagedim[$this->page]['olm'] != $this->pagedim[$oldpage]['olm']) { + $this->x = $x + ($this->pagedim[$this->page]['olm'] - $this->pagedim[$oldpage]['olm']); + } else { + $this->x = $x; + } } } return true; @@ -2924,17 +3689,44 @@ if (!class_exists('TCPDF', false)) { * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. * @param mixed $link URL or identifier returned by AddLink(). * @param int $stretch stretch carachter mode: + * @param boolean $ignore_min_height if true ignore automatic minimum height value. + * @access public * @since 1.0 * @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak() */ - public function Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0) { + public function Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0, $ignore_min_height=false) { //$min_cell_height = $this->FontAscent + $this->FontDescent; $min_cell_height = $this->FontSize * $this->cell_height_ratio; if ($h < $min_cell_height) { $h = $min_cell_height; } $this->checkPageBreak($h); - $this->_out($this->getCellCode($w, $h, $txt, $border, $ln, $align, $fill, $link, $stretch)); + $this->_out($this->getCellCode($w, $h, $txt, $border, $ln, $align, $fill, $link, $stretch, $ignore_min_height)); + } + + /** + * Removes SHY characters from text. + * @param string $txt input string + * @return string without SHY characters. + * @access public + * @since (4.5.019) 2009-02-28 + */ + public function removeSHY($txt='') { + /* + * Unicode Data + * Name : SOFT HYPHEN, commonly abbreviated as SHY + * 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) + */ + $txt = preg_replace('/([\\xc2]{1}[\\xad]{1})/', '', $txt); + if (!$this->isunicode) { + $txt = preg_replace('/([\\xad]{1})/', '', $txt); + } + return $txt; } /** @@ -2949,24 +3741,30 @@ if (!class_exists('TCPDF', false)) { * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. * @param mixed $link URL or identifier returned by AddLink(). * @param int $stretch stretch carachter mode: + * @param boolean $ignore_min_height if true ignore automatic minimum height value. + * @access protected * @since 1.0 * @see Cell() */ - protected function getCellCode($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0) { + protected function getCellCode($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0, $ignore_min_height=false) { + $txt = $this->removeSHY($txt); $rs = ''; //string to be returned - $min_cell_height = $this->FontSize * $this->cell_height_ratio; - if ($h < $min_cell_height) { - $h = $min_cell_height; + if (!$ignore_min_height) { + $min_cell_height = $this->FontSize * $this->cell_height_ratio; + if ($h < $min_cell_height) { + $h = $min_cell_height; + } } $k = $this->k; - if (empty($w) OR ($w <= 0)) { + if ($this->empty_string($w) OR ($w <= 0)) { if ($this->rtl) { $w = $this->x - $this->lMargin; } else { $w = $this->w - $this->rMargin - $this->x; } } - $s = ''; + $s = ''; + // fill and borders if (($fill == 1) OR ($border == 1)) { if ($fill == 1) { $op = ($border == 1) ? 'B' : 'f'; @@ -2978,10 +3776,10 @@ if (!class_exists('TCPDF', false)) { } else { $xk = ($this->x * $k); } - $s .= sprintf('%.2f %.2f %.2f %.2f re %s ', $xk, (($this->h - $this->y) * $k), ($w * $k), (-$h * $k), $op); + $s .= sprintf('%.2F %.2F %.2F %.2F re %s ', $xk, (($this->h - $this->y) * $k), ($w * $k), (-$h * $k), $op); } if (is_string($border)) { - $lm = $this->LineWidth / 2; + $lm = ($this->LineWidth / 2); $x = $this->x; $y = $this->y; if (strpos($border,'L') !== false) { @@ -2990,7 +3788,7 @@ if (!class_exists('TCPDF', false)) { } else { $xk = $x * $k; } - $s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $xk, (($this->h - $y + $lm) * $k), $xk, (($this->h - ($y + $h + $lm)) * $k)); + $s .= sprintf('%.2F %.2F m %.2F %.2F l S ', $xk, (($this->h - $y + $lm) * $k), $xk, (($this->h - ($y + $h + $lm)) * $k)); } if (strpos($border,'T') !== false) { if ($this->rtl) { @@ -3000,7 +3798,7 @@ if (!class_exists('TCPDF', false)) { $xk = ($x - $lm) * $k; $xwk = ($x + $w + $lm) * $k; } - $s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $xk, (($this->h - $y) * $k), $xwk, (($this->h - $y) * $k)); + $s .= sprintf('%.2F %.2F m %.2F %.2F l S ', $xk, (($this->h - $y) * $k), $xwk, (($this->h - $y) * $k)); } if (strpos($border,'R') !== false) { if ($this->rtl) { @@ -3008,7 +3806,7 @@ if (!class_exists('TCPDF', false)) { } else { $xk = ($x + $w) * $k; } - $s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $xk, (($this->h - $y + $lm) * $k), $xk, (($this->h - ($y + $h + $lm))* $k)); + $s .= sprintf('%.2F %.2F m %.2F %.2F l S ', $xk, (($this->h - $y + $lm) * $k), $xk, (($this->h - ($y + $h + $lm))* $k)); } if (strpos($border,'B') !== false) { if ($this->rtl) { @@ -3018,15 +3816,20 @@ if (!class_exists('TCPDF', false)) { $xk = ($x - $lm) * $k; $xwk = ($x + $w + $lm) * $k; } - $s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $xk, (($this->h - ($y + $h)) * $k), $xwk, (($this->h - ($y + $h)) * $k)); + $s .= sprintf('%.2F %.2F m %.2F %.2F l S ', $xk, (($this->h - ($y + $h)) * $k), $xwk, (($this->h - ($y + $h)) * $k)); } } if ($txt != '') { - // text lenght - $width = $this->GetStringWidth($txt); - // ratio between cell lenght and text lenght - $ratio = ($w - (2 * $this->cMargin)) / $width; - + $txt2 = $this->_escapetext($txt); + // text length + $txwidth = $this->GetStringWidth($txt); + $width = $txwidth; + // ratio between cell length and text length + if ($width <= 0) { + $ratio = 1; + } else { + $ratio = ($w - (2 * $this->cMargin)) / $width; + } // stretch text if required if (($stretch > 0) AND (($ratio < 1) OR (($ratio > 1) AND (($stretch % 2) == 0)))) { if ($stretch > 2) { @@ -3034,90 +3837,91 @@ if (!class_exists('TCPDF', false)) { //Calculate character spacing in points $char_space = (($w - $width - (2 * $this->cMargin)) * $this->k) / max($this->GetNumChars($txt)-1,1); //Set character spacing - $rs .= sprintf('BT %.2f Tc ET ', $char_space); + $rs .= sprintf('BT %.2F Tc ET ', $char_space); } else { // scaling //Calculate horizontal scaling $horiz_scale = $ratio * 100.0; //Set horizontal scaling - $rs .= sprintf('BT %.2f Tz ET ', $horiz_scale); + $rs .= sprintf('BT %.2F Tz ET ', $horiz_scale); } $align = ''; $width = $w - (2 * $this->cMargin); } else { $stretch == 0; } - if ($align == 'L') { - if ($this->rtl) { - $dx = $w - $width - $this->cMargin; - } else { - $dx = $this->cMargin; - } - } elseif ($align == 'R') { - if ($this->rtl) { - $dx = $this->cMargin; - } else { - $dx = $w - $width - $this->cMargin; - } - } elseif ($align == 'C') { - $dx = ($w - $width) / 2; - } elseif ($align == 'J') { - if ($this->rtl) { - $dx = $w - $width - $this->cMargin; - } else { - $dx = $this->cMargin; - } - } else { - $dx = $this->cMargin; - } if ($this->ColorFlag) { $s .= 'q '.$this->TextColor.' '; } - $txt2 = $this->_escapetext($txt); - if ($this->rtl) { - $xdk = ($this->x - $dx - $width) * $k; - } else { - $xdk = ($this->x + $dx) * $k; - } + // count number of spaces + $ns = substr_count($txt, ' '); // Justification - if ($align == 'J') { - // count number of spaces - $ns = substr_count($txt, ' '); + if (($align == 'J') AND ($ns > 0)) { if (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { // get string width without spaces $width = $this->GetStringWidth(str_replace(' ', '', $txt)); // calculate average space width - $spacewidth = ($w - $width - (2 * $this->cMargin)) / ($ns?$ns:1) / $this->FontSize / $this->k; + $spacewidth = -1000 * ($w - $width - (2 * $this->cMargin)) / ($ns?$ns:1) / $this->FontSize; // set word position to be used with TJ operator - $txt2 = str_replace(chr(0).' ', ') '.(-2830 * $spacewidth).' (', $txt2); + $txt2 = str_replace(chr(0).' ', ') '.($spacewidth).' (', $txt2); } else { // get string width - $width = $this->GetStringWidth($txt); + $width = $txwidth; $spacewidth = (($w - $width - (2 * $this->cMargin)) / ($ns?$ns:1)) * $this->k; - $rs .= sprintf('BT %.3f Tw ET ', $spacewidth); + // set word spacing + $rs .= sprintf('BT %.3F Tw ET ', $spacewidth); + } + $width = $w - (2 * $this->cMargin); + } + switch ($align) { + case 'C': { + $dx = ($w - $width) / 2; + break; + } + case 'R': { + if ($this->rtl) { + $dx = $this->cMargin; + } else { + $dx = $w - $width - $this->cMargin; + } + break; + } + case 'L': { + if ($this->rtl) { + $dx = $w - $width - $this->cMargin; + } else { + $dx = $this->cMargin; + } + break; + } + case 'J': + default: { + $dx = $this->cMargin; + break; } } - // calculate approximate position of the font base line - //$basefonty = $this->y + (($h + $this->FontAscent - $this->FontDescent)/2); - $basefonty = $this->y + ($h/2) + ($this->FontSize/3); - // print text - $s .= sprintf('BT %.2f %.2f Td [(%s)] TJ ET', $xdk, (($this->h - $basefonty) * $k), $txt2); if ($this->rtl) { $xdx = $this->x - $dx - $width; } else { $xdx = $this->x + $dx; } + $xdk = $xdx * $k; + // calculate approximate position of the font base line + //$basefonty = $this->y + (($h + $this->FontAscent - $this->FontDescent)/2); + $basefonty = $this->y + ($h/2) + ($this->FontSize/3); + // print text + $s .= sprintf('BT %.2F %.2F Td [(%s)] TJ ET', $xdk, (($this->h - $basefonty) * $k), $txt2); if ($this->underline) { - $s .= ' '.$this->_dounderline($xdx, $basefonty, $txt); + $s .= ' '.$this->_dounderlinew($xdx, $basefonty, $width); } if ($this->linethrough) { - $s .= ' '.$this->_dolinethrough($xdx, $basefonty, $txt); + $s .= ' '.$this->_dolinethroughw($xdx, $basefonty, $width); } if ($this->ColorFlag) { $s .= ' Q'; } if ($link) { - $this->Link($xdx, $this->y + (($h - $this->FontSize)/2), $width, $this->FontSize, $link, substr_count($txt, chr(32))); + $this->Link($xdx, $this->y + (($h - $this->FontSize)/2), $width, $this->FontSize, $link, $ns); } } // output cell @@ -3172,21 +3976,24 @@ if (!class_exists('TCPDF', false)) { * @param string $align Allows to center or align the text. Possible values are: * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. * @param int $ln Indicates where the current position should go after the call. Possible values are: - * @param int $x x position in user units - * @param int $y y position in user units + * @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 stretch carachter mode: - * @param boolean $ishtml se to true if $txt is HTML content (default = false). + * @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. * @return int Return the number of cells or 1 for html mode. + * @access public * @since 1.3 * @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak() */ - public function MultiCell($w, $h, $txt, $border=0, $align='J', $fill=0, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false) { - if (empty($this->lasth) OR $reseth) { + public function MultiCell($w, $h, $txt, $border=0, $align='J', $fill=0, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0) { + if ($this->empty_string($this->lasth) OR $reseth) { //set row height $this->lasth = $this->FontSize * $this->cell_height_ratio; } - if (!empty($y)) { + if (!$this->empty_string($y)) { $this->SetY($y); } else { $y = $this->GetY(); @@ -3196,12 +4003,12 @@ if (!class_exists('TCPDF', false)) { $y = $this->GetY(); // get current page number $startpage = $this->page; - if (!empty($x)) { + if (!$this->empty_string($x)) { $this->SetX($x); } else { $x = $this->GetX(); } - if (empty($w) OR ($w <= 0)) { + if ($this->empty_string($w) OR ($w <= 0)) { if ($this->rtl) { $w = $this->x - $this->lMargin; } else { @@ -3219,51 +4026,55 @@ if (!class_exists('TCPDF', false)) { $this->SetRightMargin($this->w - $this->x - $w); } $starty = $this->y; - // Adjust internal padding - if ($this->cMargin < ($this->LineWidth / 2)) { - $this->cMargin = ($this->LineWidth / 2); + if ($autopadding) { + // Adjust internal padding + if ($this->cMargin < ($this->LineWidth / 2)) { + $this->cMargin = ($this->LineWidth / 2); + } + // Add top space if needed + if (($this->lasth - $this->FontSize) < $this->LineWidth) { + $this->y += $this->LineWidth / 2; + } + // add top padding + $this->y += $this->cMargin; } - // Add top space if needed - if (($this->lasth - $this->FontSize) < $this->LineWidth) { - $this->y += $this->LineWidth / 2; - } - // add top padding - $this->y += $this->cMargin; if ($ishtml) { // ******* Write HTML text $this->writeHTML($txt, true, 0, $reseth, true, $align); $nl = 1; } else { // ******* Write text - $nl = $this->Write($this->lasth, $txt, '', 0, $align, true, $stretch, false); + $nl = $this->Write($this->lasth, $txt, '', 0, $align, true, $stretch, false, true, $maxh); } - // add bottom padding - $this->y += $this->cMargin; - // Add bottom space if needed - if (($this->lasth - $this->FontSize) < $this->LineWidth) { - $this->y += $this->LineWidth / 2; + if ($autopadding) { + // add bottom padding + $this->y += $this->cMargin; + // Add bottom space if needed + if (($this->lasth - $this->FontSize) < $this->LineWidth) { + $this->y += $this->LineWidth / 2; + } } // Get end-of-text Y position - $currentY = $this->GetY(); + $currentY = $this->y; // get latest page number $endpage = $this->page; // check if a new page has been created if ($endpage > $startpage) { // design borders around HTML cells. - for ($page=$startpage; $page <= $endpage; $page++) { + for ($page=$startpage; $page <= $endpage; ++$page) { $this->setPage($page); if ($page == $startpage) { $this->y = $starty; // put cursor at the beginning of cell on the first page $h = $this->getPageHeight() - $starty - $this->getBreakMargin(); - $cborder = $border ? 'LTR' : 0; + $cborder = $this->getBorderMode($border, $position='start'); } elseif ($page == $endpage) { $this->y = $this->tMargin; // put cursor at the beginning of last page $h = $currentY - $this->tMargin; - $cborder = $border ? 'LRB' : 0; + $cborder = $this->getBorderMode($border, $position='end'); } else { $this->y = $this->tMargin; // put cursor at the beginning of the current page $h = $this->getPageHeight() - $this->tMargin - $this->getBreakMargin(); - $cborder = $border ? 'LR' : 0; + $cborder = $this->getBorderMode($border, $position='middle'); } $nx = $x; // account for margin changes @@ -3275,14 +4086,12 @@ if (!class_exists('TCPDF', false)) { } } $this->SetX($nx); - if (!$this->opencell) { - $cborder = $border; - } - $ccode = $this->getCellCode($w, $h, '', $cborder, 1, '', $fill); + $ccode = $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, false); if ($cborder OR $fill) { - $pstart = substr($this->pages[$this->page], 0, $this->intmrk[$this->page]); - $pend = substr($this->pages[$this->page], $this->intmrk[$this->page]); - $this->pages[$this->page] = $pstart.$ccode."\n".$pend; + $pagebuff = $this->getPageBuffer($this->page); + $pstart = substr($pagebuff, 0, $this->intmrk[$this->page]); + $pend = substr($pagebuff, $this->intmrk[$this->page]); + $this->setPageBuffer($this->page, $pstart.$ccode."\n".$pend); $this->intmrk[$this->page] += strlen($ccode."\n"); } } @@ -3292,12 +4101,21 @@ if (!class_exists('TCPDF', false)) { $this->SetY($y); $this->SetX($x); // design a cell around the text - $ccode = $this->getCellCode($w, $h, '', $border, 1, '', $fill); + $ccode = $this->getCellCode($w, $h, '', $border, 1, '', $fill, '', 0, true); if ($border OR $fill) { - $pstart = substr($this->pages[$this->page], 0, $this->intmrk[$this->page]); - $pend = substr($this->pages[$this->page], $this->intmrk[$this->page]); - $this->pages[$this->page] = $pstart.$ccode."\n".$pend; - $this->intmrk[$this->page] += strlen($ccode."\n"); + if (end($this->transfmrk[$this->page]) !== false) { + $pagemarkkey = key($this->transfmrk[$this->page]); + $pagemark = &$this->transfmrk[$this->page][$pagemarkkey]; + } elseif ($this->InFooter) { + $pagemark = &$this->footerpos[$this->page]; + } else { + $pagemark = &$this->intmrk[$this->page]; + } + $pagebuff = $this->getPageBuffer($this->page); + $pstart = substr($pagebuff, 0, $pagemark); + $pend = substr($pagebuff, $pagemark); + $this->setPageBuffer($this->page, $pstart.$ccode."\n".$pend); + $pagemark += strlen($ccode."\n"); } } // Get end-of-cell Y position @@ -3317,9 +4135,125 @@ if (!class_exists('TCPDF', false)) { $this->y = $y; $this->SetX($x + $w); } + $this->setContentMark(); return $nl; } - + + /** + * Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages) + * @param mixed $border Indicates if borders must be drawn around the cell block. The value can be either a number:or a string containing some or all of the following characters (in any order): + * @param string multicell position: 'start', 'middle', 'end' + * @return border mode + * @access protected + * @since 4.4.002 (2008-12-09) + */ + protected function getBorderMode($border, $position='start') { + if ((!$this->opencell) AND ($border == 1)) { + return 1; + } + $cborder = ''; + switch ($position) { + case 'start': { + if ($border == 1) { + $cborder = 'LTR'; + } else { + if (!(false === strpos($border, 'L'))) { + $cborder .= 'L'; + } + if (!(false === strpos($border, 'T'))) { + $cborder .= 'T'; + } + if (!(false === strpos($border, 'R'))) { + $cborder .= 'R'; + } + if ((!$this->opencell) AND (!(false === strpos($border, 'B')))) { + $cborder .= 'B'; + } + } + break; + } + case 'middle': { + if ($border == 1) { + $cborder = 'LR'; + } else { + if (!(false === strpos($border, 'L'))) { + $cborder .= 'L'; + } + if ((!$this->opencell) AND (!(false === strpos($border, 'T')))) { + $cborder .= 'T'; + } + if (!(false === strpos($border, 'R'))) { + $cborder .= 'R'; + } + if ((!$this->opencell) AND (!(false === strpos($border, 'B')))) { + $cborder .= 'B'; + } + } + break; + } + case 'end': { + if ($border == 1) { + $cborder = 'LRB'; + } else { + if (!(false === strpos($border, 'L'))) { + $cborder .= 'L'; + } + if ((!$this->opencell) AND (!(false === strpos($border, 'T')))) { + $cborder .= 'T'; + } + if (!(false === strpos($border, 'R'))) { + $cborder .= 'R'; + } + if (!(false === strpos($border, 'B'))) { + $cborder .= 'B'; + } + } + break; + } + default: { + $cborder = $border; + break; + } + } + return $cborder; + } + + /** + * This method returns the estimated number of lines required to print the text. + * @param string $txt text to print + * @param float $w width of cell. If 0, they extend up to the right margin of the page. + * @return int Return the estimated number of lines. + * @access public + * @since 4.5.011 + */ + public function getNumLines($txt, $w=0) { + $lines = 0; + if ($this->empty_string($w) OR ($w <= 0)) { + if ($this->rtl) { + $w = $this->x - $this->lMargin; + } else { + $w = $this->w - $this->rMargin - $this->x; + } + } + // max column width + $wmax = $w - (2 * $this->cMargin); + // remove carriage returns + $txt = str_replace("\r", '', $txt); + // remove last newline (if any) + if (substr($txt,-1) == "\n") { + $txt = substr($txt, 0, -1); + } + // divide text in blocks + $txtblocks = explode("\n", $txt); + // for each text block + foreach ($txtblocks as $block) { + // estimate the number of lines + $lines += $this->empty_string($block) ? 1 : (ceil($this->GetStringWidth($block) / $wmax)); + } + // return the number of lines + return $lines; + } + /** * This method prints text from the current position.
    * @param float $h Line height @@ -3331,10 +4265,15 @@ if (!class_exists('TCPDF', false)) { * @param int $stretch stretch carachter mode: * @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. * @return mixed Return the number of cells or the remaining string if $firstline = true. + * @access public * @since 1.5 */ - public function Write($h, $txt, $link='', $fill=0, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false) { + public function Write($h, $txt, $link='', $fill=0, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0) { + if (strlen($txt) == 0) { + $txt = ' '; + } // remove carriage returns $s = str_replace("\r", '', $txt); // check if string contains arabic text @@ -3343,24 +4282,30 @@ if (!class_exists('TCPDF', false)) { } else { $arabic = false; } + // check if string contains RTL text + if ($arabic OR ($this->tmprtl == 'R') OR preg_match(K_RE_PATTERN_RTL, $txt)) { + $rtlmode = true; + } else { + $rtlmode = false; + } // get a char width $chrwidth = $this->GetCharWidth('.'); - // get array of chars + // get array of unicode values $chars = $this->UTF8StringToArray($s); + // get array of chars + $uchars = $this->UTF8ArrayToUniArray($chars); // get the number of characters $nb = count($chars); - // handle single space character - if (($nb == 1) AND preg_match('/[\s]/', $s)) { - if ($this->rtl) { - $this->x -= $this->GetStringWidth($s); - } else { - $this->x += $this->GetStringWidth($s); - } - return; - } + // replacement for SHY character (minus symbol) + $shy_replacement = 45; + $shy_replacement_char = $this->unichr($shy_replacement); + // widht for SHY replacement + $shy_replacement_width = $this->GetCharWidth($shy_replacement); // store current position $prevx = $this->x; $prevy = $this->y; + // max Y + $maxy = $this->y + $maxh - $h - (2 * $this->cMargin); // calculate remaining line width ($w) if ($this->rtl) { $w = $this->x - $this->lMargin; @@ -3369,14 +4314,23 @@ if (!class_exists('TCPDF', false)) { } // max column width $wmax = $w - (2 * $this->cMargin); + if ((!$firstline) AND (($chrwidth > $wmax) OR ($this->GetCharWidth($chars[0]) > $wmax))) { + // a single character do not fit on column + return ''; + } $i = 0; // character position $j = 0; // current starting position $sep = -1; // position of the last blank space - $l = 0; // current string lenght + $shy = false; // true if the last blank is a soft hypen (SHY) + $l = 0; // current string length $nl = 0; //number of lines $linebreak = false; + $pc = 0; // previous character // for each character while ($i < $nb) { + if (($maxh > 0) AND ($this->y >= $maxy) ) { + break; + } //Get the current character $c = $chars[$i]; if ($c == 10) { // 10 = "\n" = new line @@ -3390,9 +4344,15 @@ if (!class_exists('TCPDF', false)) { } else { $talign = $align; } + $tmpstr = $this->UniArrSubString($uchars, $j, $i); if ($firstline) { $startx = $this->x; - $linew = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, $i), $this->tmprtl)); + $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 { @@ -3400,17 +4360,24 @@ if (!class_exists('TCPDF', false)) { } $w = $linew; $tmpcmargin = $this->cMargin; - $this->cMargin = 0; + if ($maxh == 0) { + $this->cMargin = 0; + } } - $this->Cell($w, $h, $this->UTF8ArrSubString($chars, $j, $i), 0, 1, $talign, $fill, $link, $stretch); + if ($firstblock AND $this->isRTLTextDir()) { + $tmpstr = rtrim($tmpstr); + } + $this->Cell($w, $h, $tmpstr, 0, 1, $talign, $fill, $link, $stretch); + unset($tmpstr); if ($firstline) { $this->cMargin = $tmpcmargin; - return ($this->UTF8ArrSubString($chars, $i)); + return ($this->UniArrSubString($uchars, $i)); } - $nl++; + ++$nl; $j = $i + 1; $l = 0; $sep = -1; + $shy = false; // account for margin changes if ((($this->y + $this->lasth) > $this->PageBreakTrigger) AND (!$this->InFooter)) { // AcceptPageBreak() may be overriden on extended classed to include margin changes @@ -3419,19 +4386,37 @@ if (!class_exists('TCPDF', false)) { $w = $this->getRemainingWidth(); $wmax = $w - (2 * $this->cMargin); } else { - if (preg_match('/[\s]/', $this->unichr($c))) { + // 160 is the non-breaking space. + // 173 is SHY (Soft Hypen). + // \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 because Chinese characters are packed next to each other without spaces in between. + if (($c != 160) AND (($c == 173) OR preg_match($this->re_spaces, $this->unichr($c)))) { // update last blank space position $sep = $i; + // check if is a SHY + if ($c == 173) { + $shy = true; + if ($pc == 45) { + $tmp_shy_replacement_width = 0; + $tmp_shy_replacement_char = ''; + } else { + $tmp_shy_replacement_width = $shy_replacement_width; + $tmp_shy_replacement_char = $shy_replacement_char; + } + } else { + $shy = false; + } } // update string length if ((($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) AND ($arabic)) { // with bidirectional algorithm some chars may be changed affecting the line length // *** very slow *** - $l = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, $i-$j+1), $this->tmprtl)); + $l = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, ($i - $j)), '', $this->tmprtl)); } else { $l += $this->GetCharWidth($c); } - if ($l > $wmax) { + if (($l > $wmax) OR ($shy AND (($l + $tmp_shy_replacement_width) > $wmax)) ) { // we have reached the end of column if ($sep == -1) { // check if the line was already started @@ -3441,13 +4426,19 @@ if (!class_exists('TCPDF', false)) { $this->Cell($w, $h, '', 0, 1); $linebreak = true; if ($firstline) { - return ($this->UTF8ArrSubString($chars, $j)); + return ($this->UniArrSubString($uchars, $j)); } } else { // truncate the word because do not fit on column + $tmpstr = $this->UniArrSubString($uchars, $j, $i); if ($firstline) { $startx = $this->x; - $linew = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, $i), $this->tmprtl)); + $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 { @@ -3455,15 +4446,21 @@ if (!class_exists('TCPDF', false)) { } $w = $linew; $tmpcmargin = $this->cMargin; - $this->cMargin = 0; + if ($maxh == 0) { + $this->cMargin = 0; + } } - $this->Cell($w, $h, $this->UTF8ArrSubString($chars, $j, $i), 0, 1, $align, $fill, $link, $stretch); + if ($firstblock AND $this->isRTLTextDir()) { + $tmpstr = rtrim($tmpstr); + } + $this->Cell($w, $h, $tmpstr, 0, 1, $align, $fill, $link, $stretch); + unset($tmpstr); if ($firstline) { $this->cMargin = $tmpcmargin; - return ($this->UTF8ArrSubString($chars, $i)); + return ($this->UniArrSubString($uchars, $i)); } $j = $i; - $i--; + --$i; } } else { // word wrapping @@ -3472,25 +4469,55 @@ if (!class_exists('TCPDF', false)) { } 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; + } + } else { + $shy_width = 0; + $shy_char_left = ''; + $shy_char_right = ''; + } + $tmpstr = $this->UniArrSubString($uchars, $j, ($sep + $endspace)); if ($firstline) { $startx = $this->x; - $linew = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, ($sep + $endspace)), $this->tmprtl)); + $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; + $this->endlinex = $startx - $linew - $shy_width; } else { - $this->endlinex = $startx + $linew; + $this->endlinex = $startx + $linew + $shy_width; } $w = $linew; $tmpcmargin = $this->cMargin; - $this->cMargin = 0; + if ($maxh == 0) { + $this->cMargin = 0; + } } - $this->Cell($w, $h, $this->UTF8ArrSubString($chars, $j, ($sep + $endspace)), 0, 1, $align, $fill, $link, $stretch); + // print the line + if ($firstblock AND $this->isRTLTextDir()) { + $tmpstr = rtrim($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->cMargin = $tmpcmargin; - return ($this->UTF8ArrSubString($chars, ($sep + $endspace))); + return ($this->UniArrSubString($uchars, ($sep + $endspace))); } $i = $sep; $sep = -1; + $shy = false; $j = ($i+1); } // account for margin changes @@ -3503,12 +4530,14 @@ if (!class_exists('TCPDF', false)) { if ($linebreak) { $linebreak = false; } else { - $nl++; + ++$nl; $l = 0; } } } - $i++; + // save last character + $pc = $c; + ++$i; } // end while i < nb // print last substring (if any) if ($l > 0) { @@ -3539,9 +4568,15 @@ if (!class_exists('TCPDF', false)) { break; } } + $tmpstr = $this->UniArrSubString($uchars, $j, $nb); if ($firstline) { $startx = $this->x; - $linew = $this->GetArrStringWidth($this->utf8Bidi(array_slice($chars, $j, $nb), $this->tmprtl)); + $tmparr = array_slice($chars, $j, ($nb - $j)); + if ($rtlmode) { + $tmparr = $this->utf8Bidi($tmparr, $tmpstr, $this->tmprtl); + } + $linew = $this->GetArrStringWidth($tmparr); + unset($tmparr); if ($this->rtl) { $this->endlinex = $startx - $linew; } else { @@ -3549,14 +4584,20 @@ if (!class_exists('TCPDF', false)) { } $w = $linew; $tmpcmargin = $this->cMargin; - $this->cMargin = 0; + if ($maxh == 0) { + $this->cMargin = 0; + } } - $this->Cell($w, $h, $this->UTF8ArrSubString($chars, $j, $nb), 0, $ln, $align, $fill, $link, $stretch); + if ($firstblock AND $this->isRTLTextDir()) { + $tmpstr = rtrim($tmpstr); + } + $this->Cell($w, $h, $tmpstr, 0, $ln, $align, $fill, $link, $stretch); + unset($tmpstr); if ($firstline) { $this->cMargin = $tmpcmargin; - return ($this->UTF8ArrSubString($chars, $nb)); + return ($this->UniArrSubString($uchars, $nb)); } - $nl++; + ++$nl; } if ($firstline) { return ''; @@ -3577,12 +4618,13 @@ if (!class_exists('TCPDF', false)) { } } - /** + /** * 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. * @return Return part of a string + * @access public */ public function UTF8ArrSubString($strarr, $start='', $end='') { if (strlen($start) == 0) { @@ -3592,17 +4634,52 @@ if (!class_exists('TCPDF', false)) { $end = count($strarr); } $string = ''; - for ($i=$start; $i < $end; $i++) { + for ($i=$start; $i < $end; ++$i) { $string .= $this->unichr($strarr[$i]); } return $string; } + + /** + * 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. + * @return Return part of a string + * @access public + * @since 4.5.037 (2009-04-07) + */ + public function UniArrSubString($uniarr, $start='', $end='') { + if (strlen($start) == 0) { + $start = 0; + } + if (strlen($end) == 0) { + $end = count($uniarr); + } + $string = ''; + for ($i=$start; $i < $end; ++$i) { + $string .= $uniarr[$i]; + } + return $string; + } + + /** + * Convert an array of UTF8 values to array of unicode characters + * @param string $ta The input array of UTF8 values. + * @return Return array of unicode characters + * @access public + * @since 4.5.037 (2009-04-07) + */ + public function UTF8ArrayToUniArray($ta) { + return array_map(array($this, 'unichr'), $ta); + } /** * Returns the unicode caracter specified by UTF-8 code * @param int $c UTF-8 code * @return Returns the specified character. * @author Miguel Perez, Nicola Asuni + * @access public * @since 2.3.000 (2008-03-05) */ public function unichr($c) { @@ -3625,6 +4702,24 @@ if (!class_exists('TCPDF', false)) { } } + /** + * Return the image type given the file name and path + * @param string $imgfile image file name + * @return string image type + * @since 4.8.017 (2009-11-27) + */ + public function getImageFileType($imgfile) { + $type = ''; // default type + $fileinfo = pathinfo($imgfile); + if (isset($fileinfo['extension']) AND (!$this->empty_string($fileinfo['extension']))) { + $type = strtolower($fileinfo['extension']); + } + if ($type == 'jpg') { + $type = 'jpeg'; + } + return $type; + } + /** * Puts an image in the page. * The upper-left corner must be given. @@ -3644,65 +4739,99 @@ if (!class_exists('TCPDF', false)) { * @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: - * @param boolean $resize If true resize (reduce) the image to fit $w and $h (requires GD library). + * @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: + * @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 image. The value can be either a number:or a string containing some or all of the following characters (in any order): + * @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. + * @return image information + * @access public * @since 1.1 - * @see AddLink() */ - public function Image($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='') { + 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) { if ($x === '') { $x = $this->x; } if ($y === '') { $y = $this->y; } - // get image size - list($pixw, $pixh) = getimagesize($file); + // get image dimensions + $imsize = @getimagesize($file); + if ($imsize === FALSE) { + // encode spaces on filename + $file = str_replace(' ', '%20', $file); + $imsize = @getimagesize($file); + if ($imsize === FALSE) { + $this->Error('[Image] No such file or directory in '.$file); + } + } + // get original image width and height in pixels + list($pixw, $pixh) = $imsize; // calculate image width and height on document if (($w <= 0) AND ($h <= 0)) { // convert image size to document unit - $w = $pixw / ($this->imgscale * $this->k); - $h = $pixh / ($this->imgscale * $this->k); + $w = $this->pixelsToUnits($pixw); + $h = $this->pixelsToUnits($pixh); } elseif ($w <= 0) { $w = $h * $pixw / $pixh; } elseif ($h <= 0) { $h = $w * $pixh / $pixw; + } elseif ($fitbox AND ($w > 0) AND ($h > 0)) { + // scale image dimensions proportionally to fit within the ($w, $h) box + if ((($w * $pixh) / ($h * $pixw)) < 1) { + $h = $w * $pixh / $pixw; + } else { + $w = $h * $pixw / $pixh; + } } // calculate new minimum dimensions in pixels $neww = round($w * $this->k * $dpi / $this->dpi); $newh = round($h * $this->k * $dpi / $this->dpi); // check if resize is necessary (resize is used only to reduce the image) - if (($neww * $newh) >= ($pixw * $pixh)) { + $newsize = ($neww * $newh); + $pixsize = ($pixw * $pixh); + if (intval($resize) == 2) { + $resize = true; + } elseif ($newsize >= $pixsize) { $resize = false; } // check if image has been already added on document - if (!isset($this->images[$file])) { + $newimage = true; + if (in_array($file, $this->imagekeys)) { + $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 ($newimage) { //First use of image, get info if ($type == '') { - $fileinfo = pathinfo($file); - if (isset($fileinfo['extension']) AND (!empty($fileinfo['extension']))) { - $type = $fileinfo['extension']; - } else { - $this->Error('Image file has no extension and no type was specified: '.$file); - } + $type = $this->getImageFileType($file); } - $type = strtolower($type); - if ($type == 'jpg') { - $type = 'jpeg'; - } - $mqr = get_magic_quotes_runtime(); - set_magic_quotes_runtime(0); + $mqr = $this->get_mqr(); + $this->set_mqr(false); // Specific image handlers $mtd = '_parse'.$type; // GD image handler function $gdfunction = 'imagecreatefrom'.$type; $info = false; - if ((method_exists($this,$mtd)) AND (!($resize AND function_exists($gdfunction)))) { + if ((method_exists($this, $mtd)) AND (!($resize AND function_exists($gdfunction)))) { + // TCPDF image functions $info = $this->$mtd($file); + if ($info == 'pngalpha') { + return $this->ImagePngAlpha($file, $x, $y, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign); + } } if (!$info) { if (function_exists($gdfunction)) { + // GD library $img = $gdfunction($file); if ($resize) { $imgr = imagecreatetruecolor($neww, $newh); @@ -3711,6 +4840,20 @@ if (!class_exists('TCPDF', false)) { } else { $info = $this->_toJPEG($img); } + } elseif (extension_loaded('imagick')) { + // ImageMagick library + $img = new Imagick(); + $img->readImage($file); + if ($resize) { + $img->resizeImage($neww, $newh, 10, 1, false); + } + $img->setCompressionQuality($this->jpeg_quality); + $img->setImageFormat('jpeg'); + $tempname = tempnam(K_PATH_CACHE, 'jpg_'); + $img->writeImage($tempname); + $info = $this->_parsejpeg($tempname); + unlink($tempname); + $img->destroy(); } else { return; } @@ -3719,19 +4862,30 @@ if (!class_exists('TCPDF', false)) { //If false, we cannot process image return; } - set_magic_quotes_runtime($mqr); - $info['i'] = count($this->images) + 1; + $this->set_mqr($mqr); + if ($ismask) { + // force grayscale + $info['cs'] = 'DeviceGray'; + } + $info['i'] = $this->numimages; + if (!in_array($file, $this->imagekeys)) { + ++$info['i']; + } + if ($imgmask !== false) { + $info['masked'] = $imgmask; + } // add image to document - $this->images[$file] = $info; - } else { - $info = $this->images[$file]; + $this->setImageBuffer($file, $info); } // Check whether we need a new page first as this does not fit - if ((($y + $h) > $this->PageBreakTrigger) AND (!$this->InFooter) AND $this->AcceptPageBreak()) { - // Automatic page break - $this->AddPage($this->CurOrientation); - // Reset Y coordinate to the top of next page + $prev_x = $this->x; + if ($this->checkPageBreak($h, $y)) { $y = $this->GetY() + $this->cMargin; + if ($this->rtl) { + $x += ($prev_x - $this->x); + } else { + $x += ($this->x - $prev_x); + } } // set bottomcoordinates $this->img_rb_y = $y + $h; @@ -3765,8 +4919,21 @@ if (!class_exists('TCPDF', false)) { $this->img_rb_x = $ximg + $w; } } + if ($ismask OR $hidden) { + // image is not displayed + return $info['i']; + } $xkimg = $ximg * $this->k; - $this->_out(sprintf('q %.2f 0 0 %.2f %.2f %.2f cm /I%d Do Q', ($w * $this->k), ($h * $this->k), $xkimg, (($this->h - ($y + $h)) * $this->k), $info['i'])); + $this->_out(sprintf('q %.2F 0 0 %.2F %.2F %.2F cm /I%d Do Q', ($w * $this->k), ($h * $this->k), $xkimg, (($this->h - ($y + $h)) * $this->k), $info['i'])); + if (!empty($border)) { + $bx = $x; + $by = $y; + $this->x = $ximg; + $this->y = $y; + $this->Cell($w, $h, '', $border, 0, '', 0, '', 0); + $this->x = $bx; + $this->y = $by; + } if ($link) { $this->Link($ximg, $y, $w, $h, $link, 0); } @@ -3796,8 +4963,40 @@ if (!class_exists('TCPDF', false)) { } } $this->endlinex = $this->img_rb_x; + return $info['i']; } - + + /** + * 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. + * @since 4.6.025 (2009-08-17) + */ + public function set_mqr($mqr) { + if(!defined('PHP_VERSION_ID')) { + $version = PHP_VERSION; + define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4})); + } + if (PHP_VERSION_ID < 50300) { + @set_magic_quotes_runtime($mqr); + } + } + + /** + * Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist) + * @return Returns 0 if magic quotes runtime is off or get_magic_quotes_runtime doesn't exist, 1 otherwise. + * @since 4.6.025 (2009-08-17) + */ + public function get_mqr() { + if(!defined('PHP_VERSION_ID')) { + $version = PHP_VERSION; + define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4})); + } + if (PHP_VERSION_ID < 50300) { + return @get_magic_quotes_runtime(); + } + return 0; + } + /** * Convert the loaded php 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. @@ -3807,7 +5006,7 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _toJPEG($image) { - $tempname = tempnam(K_PATH_CACHE,'jpg'); + $tempname = tempnam(K_PATH_CACHE, 'jpg_'); imagejpeg($image, $tempname, $this->jpeg_quality); imagedestroy($image); $retvars = $this->_parsejpeg($tempname); @@ -3849,27 +5048,28 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _parsepng($file) { - $f = fopen($file,'rb'); - if (empty($f)) { + $f = fopen($file, 'rb'); + if ($f === false) { $this->Error('Can\'t open image file: '.$file); } //Check signature - if (fread($f,8) != chr(137).'PNG'.chr(13).chr(10).chr(26).chr(10)) { + if (fread($f, 8) != chr(137).'PNG'.chr(13).chr(10).chr(26).chr(10)) { $this->Error('Not a PNG file: '.$file); } //Read header chunk - fread($f,4); - if (fread($f,4) != 'IHDR') { + fread($f, 4); + if (fread($f, 4) != 'IHDR') { $this->Error('Incorrect PNG file: '.$file); } $w = $this->_freadint($f); $h = $this->_freadint($f); - $bpc = ord(fread($f,1)); + $bpc = ord(fread($f, 1)); if ($bpc > 8) { //$this->Error('16-bit depth not supported: '.$file); + fclose($f); return false; } - $ct = ord(fread($f,1)); + $ct = ord(fread($f, 1)); if ($ct == 0) { $colspace = 'DeviceGray'; } elseif ($ct == 2) { @@ -3877,22 +5077,26 @@ if (!class_exists('TCPDF', false)) { } elseif ($ct == 3) { $colspace = 'Indexed'; } else { - //$this->Error('Alpha channel not supported: '.$file); - return false; + // alpha channel + fclose($f); + return 'pngalpha'; } - if (ord(fread($f,1)) != 0) { + if (ord(fread($f, 1)) != 0) { //$this->Error('Unknown compression method: '.$file); + fclose($f); return false; } - if (ord(fread($f,1)) != 0) { + if (ord(fread($f, 1)) != 0) { //$this->Error('Unknown filter method: '.$file); + fclose($f); return false; } - if (ord(fread($f,1)) != 0) { + if (ord(fread($f, 1)) != 0) { //$this->Error('Interlacing not supported: '.$file); + fclose($f); return false; } - fread($f,4); + fread($f, 4); $parms = '/DecodeParms <>'; //Scan chunks looking for palette, transparency and image data $pal = ''; @@ -3900,20 +5104,20 @@ if (!class_exists('TCPDF', false)) { $data = ''; do { $n = $this->_freadint($f); - $type = fread($f,4); + $type = fread($f, 4); if ($type == 'PLTE') { //Read palette - $pal = fread($f,$n); - fread($f,4); + $pal = $this->rfread($f, $n); + fread($f, 4); } elseif ($type == 'tRNS') { //Read transparency info - $t = fread($f,$n); + $t = $this->rfread($f, $n); if ($ct == 0) { - $trns = array(ord(substr($t,1,1))); + $trns = array(ord(substr($t, 1, 1))); } elseif ($ct == 2) { - $trns = array(ord(substr($t,1,1)), ord(substr($t,3,1)), ord(substr($t,5,1))); + $trns = array(ord(substr($t, 1, 1)), ord(substr($t, 3, 1)), ord(substr($t, 5, 1))); } else { - $pos = strpos($t,chr(0)); + $pos = strpos($t, chr(0)); if ($pos !== false) { $trns = array($pos); } @@ -3921,28 +5125,117 @@ if (!class_exists('TCPDF', false)) { fread($f, 4); } elseif ($type == 'IDAT') { //Read image data block - $data .= fread($f,$n); + $data .= $this->rfread($f, $n); fread($f, 4); } elseif ($type == 'IEND') { break; } else { - fread($f, $n+4); + $this->rfread($f, $n + 4); } - } - while ($n); + } while ($n); if (($colspace == 'Indexed') AND (empty($pal))) { //$this->Error('Missing palette in '.$file); + fclose($f); return false; } fclose($f); return array('w' => $w, 'h' => $h, 'cs' => $colspace, 'bpc' => $bpc, 'f' => 'FlateDecode', 'parms' => $parms, 'pal' => $pal, 'trns' => $trns, 'data' => $data); } + + /** + * 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 + * @return Returns the read string or FALSE in case of error. + * @author Nicola Asuni + * @access protected + * @since 4.5.027 (2009-03-16) + */ + protected function rfread($handle, $length) { + $data = fread($handle, $length); + if ($data === false) { + return false; + } + $rest = $length - strlen($data); + if ($rest > 0) { + $data .= $this->rfread($handle, $rest); + } + return $data; + } + + /** + * 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 $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: + * @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: + * @author Valentin Schmidt, Nicola Asuni + * @access protected + * @since 4.3.007 (2008-12-04) + * @see Image() + */ + protected function ImagePngAlpha($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='') { + // get image size + list($wpx, $hpx) = getimagesize($file); + // generate images + $img = imagecreatefrompng($file); + $imgalpha = imagecreate($wpx, $hpx); + // generate gray scale pallete + for ($c = 0; $c < 256; ++$c) { + ImageColorAllocate($imgalpha, $c, $c, $c); + } + // extract alpha channel + for ($xpx = 0; $xpx < $wpx; ++$xpx) { + for ($ypx = 0; $ypx < $hpx; ++$ypx) { + $colorindex = imagecolorat($img, $xpx, $ypx); + $col = imagecolorsforindex($img, $colorindex); + imagesetpixel($imgalpha, $xpx, $ypx, $this->getGDgamma((127 - $col['alpha']) * 255 / 127)); + } + } + // create temp alpha file + $tempfile_alpha = tempnam(K_PATH_CACHE, 'mska_'); + imagepng($imgalpha, $tempfile_alpha); + imagedestroy($imgalpha); + // extract image without alpha channel + $imgplain = imagecreatetruecolor($wpx, $hpx); + imagecopy($imgplain, $img, 0, 0, 0, 0, $wpx, $hpx); + // create temp image file + $tempfile_plain = tempnam(K_PATH_CACHE, 'mskp_'); + imagepng($imgplain, $tempfile_plain); + imagedestroy($imgplain); + // embed mask image + $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false); + // embed image, masked with previously embedded mask + $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask); + // remove temp files + unlink($tempfile_alpha); + unlink($tempfile_plain); + } + + /** + * Correct the gamma value to be used with GD library + * @param float $v the gamma value to be corrected + * @access protected + * @since 4.3.007 (2008-12-04) + */ + protected function getGDgamma($v) { + return (pow(($v / 255), 2.2) * 255); + } /** * 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 a cMargin to the x coordinate + * @access public * @since 1.0 * @see Cell() */ @@ -3970,6 +5263,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 1.2 * @see SetX(), GetY(), SetY() */ @@ -3985,6 +5279,7 @@ if (!class_exists('TCPDF', false)) { /** * Returns the absolute X value of current position. * @return float + * @access public * @since 1.2 * @see SetX(), GetY(), SetY() */ @@ -3995,6 +5290,7 @@ if (!class_exists('TCPDF', false)) { /** * Returns the ordinate of the current position. * @return float + * @access public * @since 1.0 * @see SetY(), GetX(), SetX() */ @@ -4007,6 +5303,7 @@ if (!class_exists('TCPDF', false)) { * 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. + * @access public * @since 1.2 * @see GetX(), GetY(), SetY(), SetXY() */ @@ -4038,6 +5335,7 @@ if (!class_exists('TCPDF', false)) { * 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. + * @access public * @since 1.0 * @see GetX(), GetY(), SetY(), SetXY() */ @@ -4068,6 +5366,7 @@ if (!class_exists('TCPDF', false)) { * 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 + * @access public * @since 1.2 * @see SetX(), SetY() */ @@ -4083,12 +5382,14 @@ if (!class_exists('TCPDF', false)) { * 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: + * @access public * @since 1.0 * @see Close() */ public function Output($name='doc.pdf', $dest='I') { //Output PDF to some destination //Finish document if necessary + $this->lastpage(); if ($this->state < 3) { $this->Close(); } @@ -4101,9 +5402,70 @@ if (!class_exists('TCPDF', false)) { $name = preg_replace('/[\s]+/', '_', $name); $name = preg_replace('/[^a-zA-Z0-9_\.-]/', '', $name); } + if ($this->sign) { + // *** apply digital signature to the document *** + // get the document content + $pdfdoc = $this->getBuffer(); + // remove last newline + $pdfdoc = substr($pdfdoc, 0, -1); + // Remove the original buffer + if (isset($this->diskcache) AND $this->diskcache) { + // remove buffer file from cache + unlink($this->buffer); + } + unset($this->buffer); + // remove filler space + $byterange_string_len = strlen($this->byterange_string); + // define the ByteRange + $byte_range = array(); + $byte_range[0] = 0; + $byte_range[1] = strpos($pdfdoc, $this->byterange_string) + $byterange_string_len + 10; + $byte_range[2] = $byte_range[1] + $this->signature_max_length + 2; + $byte_range[3] = strlen($pdfdoc) - $byte_range[2]; + $pdfdoc = substr($pdfdoc, 0, $byte_range[1]).substr($pdfdoc, $byte_range[2]); + // replace the ByteRange + $byterange = sprintf('/ByteRange[0 %u %u %u]', $byte_range[1], $byte_range[2], $byte_range[3]); + $byterange .= str_repeat(' ', ($byterange_string_len - strlen($byterange))); + $pdfdoc = str_replace($this->byterange_string, $byterange, $pdfdoc); + // write the document to a temporary folder + $tempdoc = tempnam(K_PATH_CACHE, 'tmppdf_'); + $f = fopen($tempdoc, 'wb'); + if (!$f) { + $this->Error('Unable to create temporary file: '.$tempdoc); + } + $pdfdoc_length = strlen($pdfdoc); + fwrite($f, $pdfdoc, $pdfdoc_length); + fclose($f); + // get digital signature via openssl library + $tempsign = tempnam(K_PATH_CACHE, 'tmpsig_'); + if (empty($this->signature_data['extracerts'])) { + openssl_pkcs7_sign($tempdoc, $tempsign, $this->signature_data['signcert'], array($this->signature_data['privkey'], $this->signature_data['password']), array(), PKCS7_BINARY | PKCS7_DETACHED); + } else { + openssl_pkcs7_sign($tempdoc, $tempsign, $this->signature_data['signcert'], array($this->signature_data['privkey'], $this->signature_data['password']), array(), PKCS7_BINARY | PKCS7_DETACHED, $this->signature_data['extracerts']); + } + unlink($tempdoc); + // read signature + $signature = file_get_contents($tempsign, false, null, $pdfdoc_length); + unlink($tempsign); + // extract signature + $signature = substr($signature, (strpos($signature, "%%EOF\n\n------") + 13)); + $tmparr = explode("\n\n", $signature); + $signature = $tmparr[1]; + unset($tmparr); + // decode signature + $signature = base64_decode(trim($signature)); + // convert signature to hex + $signature = current(unpack('H*', $signature)); + $signature = str_pad($signature, $this->signature_max_length, '0'); + // Add signature to the document + $pdfdoc = substr($pdfdoc, 0, $byte_range[1]).'<'.$signature.'>'.substr($pdfdoc, ($byte_range[1])); + $this->diskcache = false; + $this->buffer = &$pdfdoc; + $this->bufferlen = strlen($pdfdoc); + } switch($dest) { case 'I': { - //Send to standard output + // Send PDF to the standard output if (ob_get_contents()) { $this->Error('Some data has already been output, can\'t send PDF file'); } @@ -4117,14 +5479,14 @@ if (!class_exists('TCPDF', false)) { header('Pragma: public'); header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); - header('Content-Length: '.strlen($this->buffer)); + header('Content-Length: '.$this->bufferlen); header('Content-Disposition: inline; filename="'.basename($name).'";'); } - echo $this->buffer; + echo $this->getBuffer(); break; } case 'D': { - //Download file + // Download PDF as file if (ob_get_contents()) { $this->Error('Some data has already been output, can\'t send PDF file'); } @@ -4144,23 +5506,27 @@ if (!class_exists('TCPDF', false)) { // use the Content-Disposition header to supply a recommended filename header('Content-Disposition: attachment; filename="'.basename($name).'";'); header('Content-Transfer-Encoding: binary'); - header('Content-Length: '.strlen($this->buffer)); - echo $this->buffer; + header('Content-Length: '.$this->bufferlen); + echo $this->getBuffer(); break; } case 'F': { - //Save to local file - $f = fopen($name, 'wb'); - if (!$f) { - $this->Error('Unable to create output file: '.$name); + // Save PDF to a local file + if ($this->diskcache) { + copy($this->buffer, $name); + } else { + $f = fopen($name, 'wb'); + if (!$f) { + $this->Error('Unable to create output file: '.$name); + } + fwrite($f, $this->getBuffer(), $this->bufferlen); + fclose($f); } - fwrite($f, $this->buffer,strlen($this->buffer)); - fclose($f); break; } case 'S': { - //Return as a string - return $this->buffer; + // Returns PDF as a string + return $this->getBuffer(); } default: { $this->Error('Incorrect output destination: '.$dest); @@ -4168,6 +5534,37 @@ if (!class_exists('TCPDF', false)) { } return ''; } + + /** + * 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 + * @since 4.5.016 (2009-02-24) + */ + public function _destroy($destroyall=false, $preserve_objcopy=false) { + if ($destroyall AND isset($this->diskcache) AND $this->diskcache AND (!$preserve_objcopy) AND (!$this->empty_string($this->buffer))) { + // remove buffer file from cache + unlink($this->buffer); + } + foreach (array_keys(get_object_vars($this)) as $val) { + if ($destroyall OR ( + ($val != 'internal_encoding') + AND ($val != 'state') + AND ($val != 'bufferlen') + AND ($val != 'buffer') + AND ($val != 'diskcache') + AND ($val != 'sign') + AND ($val != 'signature_data') + AND ($val != 'signature_max_length') + AND ($val != 'byterange_string') + )) { + if (!$preserve_objcopy OR ($val != 'objcopy')) { + unset($this->$val); + } + } + } + } /** * Check for locale-related bug @@ -4179,7 +5576,7 @@ if (!class_exists('TCPDF', false)) { $this->Error('Don\'t alter the locale before including class file'); } //Check for decimal separator - if (sprintf('%.1f', 1.0) != '1.0') { + if (sprintf('%.1F', 1.0) != '1.0') { setlocale(LC_NUMERIC, 'C'); } } @@ -4201,32 +5598,7 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _putpages() { - $nb = count($this->pages); - if (!empty($this->pagegroups)) { - // do page number replacement - foreach ($this->pagegroups as $k => $v) { - $vs = $this->formatPageNumber($v); - $vu = $this->UTF8ToUTF16BE($vs, false); - $alias_a = $this->_escape($k); - $alias_au = $this->_escape('{'.$k.'}'); - if ($this->isunicode) { - $alias_b = $this->_escape($this->UTF8ToLatin1($k)); - $alias_bu = $this->_escape($this->UTF8ToLatin1('{'.$k.'}')); - $alias_c = $this->_escape($this->utf8StrRev($k, false, $this->tmprtl)); - $alias_cu = $this->_escape($this->utf8StrRev('{'.$k.'}', false, $this->tmprtl)); - } - for ($n = 1; $n <= $nb; $n++) { - $this->pages[$n] = str_replace($alias_au, $vu, $this->pages[$n]); - if ($this->isunicode) { - $this->pages[$n] = str_replace($alias_bu, $vu, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_cu, $vu, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_b, $vs, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_c, $vs, $this->pages[$n]); - } - $this->pages[$n] = str_replace($alias_a, $vs, $this->pages[$n]); - } - } - } + $nb = $this->numpages; if (!empty($this->AliasNbPages)) { $nbs = $this->formatPageNumber($nb); $nbu = $this->UTF8ToUTF16BE($nbs, false); // replacement for unicode font @@ -4238,394 +5610,797 @@ if (!class_exists('TCPDF', false)) { $alias_c = $this->_escape($this->utf8StrRev($this->AliasNbPages, false, $this->tmprtl)); $alias_cu = $this->_escape($this->utf8StrRev('{'.$this->AliasNbPages.'}', false, $this->tmprtl)); } - //Replace number of pages - for($n = 1; $n <= $nb; $n++) { - $this->pages[$n] = str_replace($alias_au, $nbu, $this->pages[$n]); - if ($this->isunicode) { - $this->pages[$n] = str_replace($alias_bu, $nbu, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_cu, $nbu, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_b, $nbs, $this->pages[$n]); - $this->pages[$n] = str_replace($alias_c, $nbs, $this->pages[$n]); - } - $this->pages[$n] = str_replace($alias_a, $nbs, $this->pages[$n]); + } + if (!empty($this->AliasNumPage)) { + $alias_pa = $this->_escape($this->AliasNumPage); + $alias_pau = $this->_escape('{'.$this->AliasNumPage.'}'); + if ($this->isunicode) { + $alias_pb = $this->_escape($this->UTF8ToLatin1($this->AliasNumPage)); + $alias_pbu = $this->_escape($this->UTF8ToLatin1('{'.$this->AliasNumPage.'}')); + $alias_pc = $this->_escape($this->utf8StrRev($this->AliasNumPage, false, $this->tmprtl)); + $alias_pcu = $this->_escape($this->utf8StrRev('{'.$this->AliasNumPage.'}', false, $this->tmprtl)); } } + $pagegroupnum = 0; $filter = ($this->compress) ? '/Filter /FlateDecode ' : ''; - for($n=1; $n <= $nb; $n++) { - $this->pages[$n] = str_replace($this->epsmarker, '', $this->pages[$n]); + for ($n=1; $n <= $nb; ++$n) { + $temppage = $this->getPageBuffer($n); + if (!empty($this->pagegroups)) { + if(isset($this->newpagegroup[$n])) { + $pagegroupnum = 0; + } + ++$pagegroupnum; + foreach ($this->pagegroups as $k => $v) { + // replace total pages group numbers + $vs = $this->formatPageNumber($v); + $vu = $this->UTF8ToUTF16BE($vs, false); + $alias_ga = $this->_escape($k); + $alias_gau = $this->_escape('{'.$k.'}'); + if ($this->isunicode) { + $alias_gb = $this->_escape($this->UTF8ToLatin1($k)); + $alias_gbu = $this->_escape($this->UTF8ToLatin1('{'.$k.'}')); + $alias_gc = $this->_escape($this->utf8StrRev($k, false, $this->tmprtl)); + $alias_gcu = $this->_escape($this->utf8StrRev('{'.$k.'}', false, $this->tmprtl)); + } + $temppage = str_replace($alias_gau, $vu, $temppage); + if ($this->isunicode) { + $temppage = str_replace($alias_gbu, $vu, $temppage); + $temppage = str_replace($alias_gcu, $vu, $temppage); + $temppage = str_replace($alias_gb, $vs, $temppage); + $temppage = str_replace($alias_gc, $vs, $temppage); + } + $temppage = str_replace($alias_ga, $vs, $temppage); + // replace page group numbers + $pvs = $this->formatPageNumber($pagegroupnum); + $pvu = $this->UTF8ToUTF16BE($pvs, false); + $pk = str_replace('{nb', '{pnb', $k); + $alias_pga = $this->_escape($pk); + $alias_pgau = $this->_escape('{'.$pk.'}'); + if ($this->isunicode) { + $alias_pgb = $this->_escape($this->UTF8ToLatin1($pk)); + $alias_pgbu = $this->_escape($this->UTF8ToLatin1('{'.$pk.'}')); + $alias_pgc = $this->_escape($this->utf8StrRev($pk, false, $this->tmprtl)); + $alias_pgcu = $this->_escape($this->utf8StrRev('{'.$pk.'}', false, $this->tmprtl)); + } + $temppage = str_replace($alias_pgau, $pvu, $temppage); + if ($this->isunicode) { + $temppage = str_replace($alias_pgbu, $pvu, $temppage); + $temppage = str_replace($alias_pgcu, $pvu, $temppage); + $temppage = str_replace($alias_pgb, $pvs, $temppage); + $temppage = str_replace($alias_pgc, $pvs, $temppage); + } + $temppage = str_replace($alias_pga, $pvs, $temppage); + } + } + if (!empty($this->AliasNbPages)) { + // replace total pages number + $temppage = str_replace($alias_au, $nbu, $temppage); + if ($this->isunicode) { + $temppage = str_replace($alias_bu, $nbu, $temppage); + $temppage = str_replace($alias_cu, $nbu, $temppage); + $temppage = str_replace($alias_b, $nbs, $temppage); + $temppage = str_replace($alias_c, $nbs, $temppage); + } + $temppage = str_replace($alias_a, $nbs, $temppage); + } + if (!empty($this->AliasNumPage)) { + // replace page number + $pnbs = $this->formatPageNumber($n); + $pnbu = $this->UTF8ToUTF16BE($pnbs, false); // replacement for unicode font + $temppage = str_replace($alias_pau, $pnbu, $temppage); + if ($this->isunicode) { + $temppage = str_replace($alias_pbu, $pnbu, $temppage); + $temppage = str_replace($alias_pcu, $pnbu, $temppage); + $temppage = str_replace($alias_pb, $pnbs, $temppage); + $temppage = str_replace($alias_pc, $pnbs, $temppage); + } + $temppage = str_replace($alias_pa, $pnbs, $temppage); + } + $temppage = str_replace($this->epsmarker, '', $temppage); //Page - $this->_newobj(); + $this->page_obj_id[$n] = $this->_newobj(); $this->_out('<_out('/Parent 1 0 R'); - $this->_out(sprintf('/MediaBox [0 0 %.2f %.2f]', $this->pagedim[$n]['w'], $this->pagedim[$n]['h'])); + $this->_out(sprintf('/MediaBox [0 0 %.2F %.2F]', $this->pagedim[$n]['w'], $this->pagedim[$n]['h'])); $this->_out('/Resources 2 0 R'); - $this->_putannots($n); + $this->_putannotsrefs($n); $this->_out('/Contents '.($this->n + 1).' 0 R>>'); $this->_out('endobj'); //Page content - $p = ($this->compress) ? gzcompress($this->pages[$n]) : $this->pages[$n]; + $p = ($this->compress) ? gzcompress($temppage) : $temppage; $this->_newobj(); $this->_out('<<'.$filter.'/Length '.strlen($p).'>>'); $this->_putstream($p); $this->_out('endobj'); + if ($this->diskcache) { + // remove temporary files + unlink($this->pages[$n]); + } } //Pages root - $this->offsets[1] = strlen($this->buffer); + $this->offsets[1] = $this->bufferlen; $this->_out('1 0 obj'); $this->_out('<_out('/Kids ['); + foreach($this->page_obj_id as $page_obj) { + $this->_out($page_obj.' 0 R'); } - $this->_out($kids.']'); + $this->_out(']'); $this->_out('/Count '.$nb); - //$this->_out(sprintf('/MediaBox [0 0 %.2f %.2f]',$this->pagedim[0]['w'],$this->pagedim[0]['h'])); $this->_out('>>'); $this->_out('endobj'); } /** - * Output Page Annotations. - * !!! THIS FUNCTION IS NOT YET COMPLETED !!! - * See section 8.4 of PDF reference. + * Output referencees to page annotations * @param int $n page number * @access protected * @author Nicola Asuni + * @since 4.7.000 (2008-08-29) + */ + protected function _putannotsrefs($n) { + if (!(isset($this->PageAnnots[$n]) OR ($this->sign AND isset($this->signature_data['cert_type'])))) { + return; + } + $this->_out('/Annots ['); + if (isset($this->PageAnnots[$n])) { + $num_annots = count($this->PageAnnots[$n]); + for ($i = 0; $i < $num_annots; ++$i) { + ++$this->curr_annot_obj_id; + if (!in_array($this->curr_annot_obj_id, $this->radio_groups)) { + $this->_out($this->curr_annot_obj_id.' 0 R'); + } else { + ++$num_annots; + } + } + } + if (($n==1) AND $this->sign AND isset($this->signature_data['cert_type'])) { + // set reference for signature object + $this->_out($this->sig_annot_ref); + } + $this->_out(']'); + } + + /** + * Output annotations objects for all pages. + * !!! THIS METHOD IS NOT YET COMPLETED !!! + * See section 12.5 of PDF 32000_2008 reference. + * @access protected + * @author Nicola Asuni * @since 4.0.018 (2008-08-06) */ - protected function _putannots($n) { - if (isset($this->PageAnnots[$n])) { - $annots = '/Annots ['; - foreach ($this->PageAnnots[$n] as $key => $pl) { - $pl['opt'] = array_change_key_case($pl['opt'], CASE_LOWER); - $a = $pl['x'] * $this->k; - $b = $this->pagedim[$n]['h'] - ($pl['y'] * $this->k); - $c = $pl['w'] * $this->k; - $d = $pl['h'] * $this->k; - $rect = sprintf('%.2f %.2f %.2f %.2f', $a, $b, $a+$c, $b-$d); - $annots .= "\n"; - $annots .= '<_textstring($pl['txt']); - //$annots .= ' /P '; - $annots .= ' /NM '.$this->_textstring(sprintf('%04u-%04u', $n, $key)); - $annots .= ' /M '.$this->_datastring('D:'.date('YmdHis')); - if (isset($pl['opt']['f'])) { - $val = 0; - if (is_array($pl['opt']['f'])) { - foreach ($pl['opt']['f'] as $f) { - switch (strtolower($f)) { - case 'invisible': { - $val += 1 << 0; - break; - } - case 'hidden': { - $val += 1 << 1; - break; - } - case 'print': { - $val += 1 << 2; - break; - } - case 'nozoom': { - $val += 1 << 3; - break; - } - case 'norotate': { - $val += 1 << 4; - break; - } - case 'noview': { - $val += 1 << 5; - break; - } - case 'readonly': { - $val += 1 << 6; - break; - } - case 'locked': { - $val += 1 << 8; - break; - } - case 'togglenoview': { - $val += 1 << 9; - break; - } - case 'lockedcontents': { - $val += 1 << 10; - break; - } - default: { - break; - } + protected function _putannotsobjs() { + // reset object counter + $this->annot_obj_id = $this->annots_start_obj_id; + for ($n=1; $n <= $this->numpages; ++$n) { + if (isset($this->PageAnnots[$n])) { + // set page annotations + foreach ($this->PageAnnots[$n] as $key => $pl) { + // create annotation object for grouping radiobuttons + if (isset($this->radiobutton_groups[$n][$pl['txt']]) AND is_array($this->radiobutton_groups[$n][$pl['txt']])) { + $annots = '<<'; + $annots .= ' /Type /Annot'; + $annots .= ' /Subtype /Widget'; + $annots .= ' /T '.$this->_datastring($pl['txt']); + $annots .= ' /FT /Btn'; + $annots .= ' /Ff 49152'; + $annots .= ' /Kids ['; + foreach ($this->radiobutton_groups[$n][$pl['txt']] as $data) { + $annots .= ' '.$data['kid'].' 0 R'; + if ($data['def'] !== 'Off') { + $defval = $data['def']; } } - } - $annots .= ' /F '.intval($val); - } - //$annots .= ' /AP '; - //$annots .= ' /AS '; - $annots .= ' /Border ['; - if (isset($pl['opt']['border']) AND (count($pl['opt']['border']) >= 3)) { - $annots .= intval($pl['opt']['border'][0]).' '; - $annots .= intval($pl['opt']['border'][1]).' '; - $annots .= intval($pl['opt']['border'][2]); - if (isset($pl['opt']['border'][3]) AND is_array($pl['opt']['border'][3])) { - $annots .= ' ['; - foreach ($pl['opt']['border'][3] as $dash) { - $annots .= intval($dash).' '; + $annots .= ' ]'; + if (isset($defval)) { + $annots .= ' /V /'.$defval; } - $annots .= ']'; + $annots .= ' >>'; + ++$this->annot_obj_id; + $this->offsets[$this->annot_obj_id] = $this->bufferlen; + $this->_out($this->annot_obj_id.' 0 obj'); + $this->_out($annots); + $this->_out('endobj'); + $this->form_obj_id[] = $this->annot_obj_id; + // store object id to be used on Parent entry of Kids + $this->radiobutton_groups[$n][$pl['txt']] = $this->annot_obj_id; } - } else { - $annots .= '0 0 0'; - } - $annots .= ']'; - if (isset($pl['opt']['bs']) AND (is_array($pl['opt']['bs']))) { - $annots .= ' /BS <k; + $b = $this->pagedim[$n]['h'] - (($pl['y'] + $pl['h']) * $this->k); + $c = $pl['w'] * $this->k; + $d = $pl['h'] * $this->k; + $rect = sprintf('%.2F %.2F %.2F %.2F', $a, $b, $a+$c, $b+$d); + // create new annotation object + $annots = '<_textstring($pl['txt']); + $annots .= ' /P '.$this->page_obj_id[$n].' 0 R'; + $annots .= ' /NM '.$this->_datastring(sprintf('%04u-%04u', $n, $key)); + $annots .= ' /M '.$this->_datestring(); + if (isset($pl['opt']['f'])) { + $val = 0; + if (is_array($pl['opt']['f'])) { + foreach ($pl['opt']['f'] as $f) { + switch (strtolower($f)) { + case 'invisible': { + $val += 1 << 0; + break; + } + case 'hidden': { + $val += 1 << 1; + break; + } + case 'print': { + $val += 1 << 2; + break; + } + case 'nozoom': { + $val += 1 << 3; + break; + } + case 'norotate': { + $val += 1 << 4; + break; + } + case 'noview': { + $val += 1 << 5; + break; + } + case 'readonly': { + $val += 1 << 6; + break; + } + case 'locked': { + $val += 1 << 8; + break; + } + case 'togglenoview': { + $val += 1 << 9; + break; + } + case 'lockedcontents': { + $val += 1 << 10; + break; + } + default: { + break; + } + } + } + } else { + $val = intval($pl['opt']['f']); } - $annots .= ']'; + $annots .= ' /F '.intval($val); } - $annots .= '>> '; - } - if (isset($pl['opt']['be']) AND (is_array($pl['opt']['be']))) { - $annots .= ' /BE <<'; - $bstyles = array('S', 'C'); - if (isset($pl['opt']['be']['s']) AND in_array($pl['opt']['be']['s'], $markups)) { - $annots .= ' /S /'.$pl['opt']['bs']['s']; + if (isset($pl['opt']['as']) AND is_string($pl['opt']['as'])) { + $annots .= ' /AS /'.$pl['opt']['as']; + } + if (isset($pl['opt']['ap'])) { + // appearance stream + $annots .= ' /AP <<'; + if (is_array($pl['opt']['ap'])) { + foreach ($pl['opt']['ap'] as $apmode => $apdef) { + // $apmode can be: n = normal; r = rollover; d = down; + $annots .= ' /'.strtoupper($apmode); + if (is_array($apdef)) { + $annots .= ' <<'; + foreach ($apdef as $apstate => $stream) { + // reference to XObject that define the appearance for this mode-state + $apsobjid = $this->_putAPXObject($c, $d, $stream); + $annots .= ' /'.$apstate.' '.$apsobjid.' 0 R'; + } + $annots .= ' >>'; + } else { + // reference to XObject that define the appearance for this mode + $apsobjid = $this->_putAPXObject($c, $d, $apdef); + $annots .= ' '.$apsobjid.' 0 R'; + } + } + } else { + $annots .= $pl['opt']['ap']; + } + $annots .= ' >>'; + } + if (isset($pl['opt']['bs']) AND (is_array($pl['opt']['bs']))) { + $annots .= ' /BS <<'; + $annots .= ' /Type /Border'; + if (isset($pl['opt']['bs']['w'])) { + $annots .= ' /W '.intval($pl['opt']['bs']['w']); + } + $bstyles = array('S', 'D', 'B', 'I', 'U'); + if (isset($pl['opt']['bs']['s']) AND in_array($pl['opt']['bs']['s'], $bstyles)) { + $annots .= ' /S /'.$pl['opt']['bs']['s']; + } + if (isset($pl['opt']['bs']['d']) AND (is_array($pl['opt']['bs']['d']))) { + $annots .= ' /D ['; + foreach ($pl['opt']['bs']['d'] as $cord) { + $annots .= ' '.intval($cord); + } + $annots .= ']'; + } + $annots .= ' >>'; } else { - $annots .= ' /S /S'; - } - if (isset($pl['opt']['be']['i']) AND ($pl['opt']['be']['i'] >= 0) AND ($pl['opt']['be']['i'] <= 2)) { - $annots .= ' /I '.sprintf(" %.4f", $pl['opt']['be']['i']); - } - $annots .= '>>'; - } - $annots .= ' /C ['; - if (isset($pl['opt']['c']) AND (is_array($pl['opt']['c']))) { - foreach ($pl['opt']['c'] as $col) { - $col = intval($col); - $color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255); - $annots .= sprintf(" %.4f", $color); - } - } - $annots .= ']'; - //$annots .= ' /StructParent '; - //$annots .= ' /OC '; - $markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound'); - if (in_array(strtolower($pl['opt']['subtype']), $markups)) { - // this is a markup type - if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) { - $annots .= ' /T '.$this->_textstring($pl['opt']['t']); - } - //$annots .= ' /Popup '; - if (isset($pl['opt']['ca'])) { - $annots .= ' /CA '.sprintf("%.4f", floatval($pl['opt']['ca'])); - } - if (isset($pl['opt']['rc'])) { - $annots .= ' /RC '.$this->_textstring($pl['opt']['rc']); - } - $annots .= ' /CreationDate '.$this->_datastring('D:'.date('YmdHis')); - //$annots .= ' /IRT '; - if (isset($pl['opt']['subj'])) { - $annots .= ' /Subj '.$this->_textstring($pl['opt']['subj']); - } - //$annots .= ' /RT '; - //$annots .= ' /IT '; - //$annots .= ' /ExData '; - } - switch (strtolower($pl['opt']['subtype'])) { - case 'text': { - if (isset($pl['opt']['open'])) { - $annots .= ' /Open '. (strtolower($pl['opt']['open']) == 'true' ? 'true' : 'false'); - } - $iconsapp = array('Comment', 'Help', 'Insert', 'Key', 'NewParagraph', 'Note', 'Paragraph'); - if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { - $annots .= ' /Name /'.$pl['opt']['name']; - } else { - $annots .= ' /Name /Note'; - } - $statemodels = array('Marked', 'Review'); - if (isset($pl['opt']['statemodel']) AND in_array($pl['opt']['statemodel'], $statemodels)) { - $annots .= ' /StateModel /'.$pl['opt']['statemodel']; - } else { - $pl['opt']['statemodel'] = 'Marked'; - $annots .= ' /StateModel /'.$pl['opt']['statemodel']; - } - if ($pl['opt']['statemodel'] == 'Marked') { - $states = array('Accepted', 'Unmarked'); - } else { - $states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None'); - } - if (isset($pl['opt']['state']) AND in_array($pl['opt']['state'], $states)) { - $annots .= ' /State /'.$pl['opt']['state']; - } else { - if ($pl['opt']['statemodel'] == 'Marked') { - $annots .= ' /State /Unmarked'; - } else { - $annots .= ' /State /None'; + $annots .= ' /Border ['; + if (isset($pl['opt']['border']) AND (count($pl['opt']['border']) >= 3)) { + $annots .= intval($pl['opt']['border'][0]).' '; + $annots .= intval($pl['opt']['border'][1]).' '; + $annots .= intval($pl['opt']['border'][2]); + if (isset($pl['opt']['border'][3]) AND is_array($pl['opt']['border'][3])) { + $annots .= ' ['; + foreach ($pl['opt']['border'][3] as $dash) { + $annots .= intval($dash).' '; + } + $annots .= ']'; } - } - break; - } - case 'link': { - if(is_string($pl['txt'])) { - // external URI link - $annots .= ' /A <_datastring($pl['txt']).'>>'; } else { - // internal link - $l = $this->links[$pl['txt']]; - $annots .= sprintf(' /Dest [%d 0 R /XYZ 0 %.2f null]', (1 + (2 * $l[0])), ($this->pagedim[$l[0]]['h'] - ($l[1] * $this->k))); + $annots .= '0 0 0'; } - $hmodes = array('N', 'I', 'O', 'P'); - if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmodes)) { - $annots .= ' /H /'.$pl['opt']['h']; - } else { - $annots .= ' /H /I'; - } - //$annots .= ' /PA '; - //$annots .= ' /Quadpoints '; - break; + $annots .= ']'; } - case 'freetext': { - $annots .= ' /DA '.$this->_textstring($pl['txt']); - if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) { - $annots .= ' /Q '.intval($pl['opt']['q']); + if (isset($pl['opt']['be']) AND (is_array($pl['opt']['be']))) { + $annots .= ' /BE <<'; + $bstyles = array('S', 'C'); + if (isset($pl['opt']['be']['s']) AND in_array($pl['opt']['be']['s'], $markups)) { + $annots .= ' /S /'.$pl['opt']['bs']['s']; + } else { + $annots .= ' /S /S'; + } + if (isset($pl['opt']['be']['i']) AND ($pl['opt']['be']['i'] >= 0) AND ($pl['opt']['be']['i'] <= 2)) { + $annots .= ' /I '.sprintf(' %.4F', $pl['opt']['be']['i']); + } + $annots .= '>>'; + } + if (isset($pl['opt']['c']) AND (is_array($pl['opt']['c'])) AND !empty($pl['opt']['c'])) { + $annots .= ' /C ['; + foreach ($pl['opt']['c'] as $col) { + $col = intval($col); + $color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255); + $annots .= sprintf(' %.4F', $color); + } + $annots .= ']'; + } + //$annots .= ' /StructParent '; + //$annots .= ' /OC '; + $markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound'); + if (in_array(strtolower($pl['opt']['subtype']), $markups)) { + // this is a markup type + if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) { + $annots .= ' /T '.$this->_textstring($pl['opt']['t']); + } + //$annots .= ' /Popup '; + if (isset($pl['opt']['ca'])) { + $annots .= ' /CA '.sprintf('%.4F', floatval($pl['opt']['ca'])); } if (isset($pl['opt']['rc'])) { $annots .= ' /RC '.$this->_textstring($pl['opt']['rc']); } - if (isset($pl['opt']['ds'])) { - $annots .= ' /DS '.$this->_textstring($pl['opt']['ds']); + $annots .= ' /CreationDate '.$this->_datestring(); + //$annots .= ' /IRT '; + if (isset($pl['opt']['subj'])) { + $annots .= ' /Subj '.$this->_textstring($pl['opt']['subj']); } - if (isset($pl['opt']['cl']) AND is_array($pl['opt']['cl'])) { - $annots .= ' /CL ['; - foreach ($pl['opt']['cl'] as $cl) { - $annots .= sprintf("%.4f ", $cl * $this->k); + //$annots .= ' /RT '; + //$annots .= ' /IT '; + //$annots .= ' /ExData '; + } + $lineendings = array('Square', 'Circle', 'Diamond', 'OpenArrow', 'ClosedArrow', 'None', 'Butt', 'ROpenArrow', 'RClosedArrow', 'Slash'); + switch (strtolower($pl['opt']['subtype'])) { + case 'text': { + if (isset($pl['opt']['open'])) { + $annots .= ' /Open '. (strtolower($pl['opt']['open']) == 'true' ? 'true' : 'false'); } - $annots .= ']'; + $iconsapp = array('Comment', 'Help', 'Insert', 'Key', 'NewParagraph', 'Note', 'Paragraph'); + if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { + $annots .= ' /Name /'.$pl['opt']['name']; + } else { + $annots .= ' /Name /Note'; + } + $statemodels = array('Marked', 'Review'); + if (isset($pl['opt']['statemodel']) AND in_array($pl['opt']['statemodel'], $statemodels)) { + $annots .= ' /StateModel /'.$pl['opt']['statemodel']; + } else { + $pl['opt']['statemodel'] = 'Marked'; + $annots .= ' /StateModel /'.$pl['opt']['statemodel']; + } + if ($pl['opt']['statemodel'] == 'Marked') { + $states = array('Accepted', 'Unmarked'); + } else { + $states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None'); + } + if (isset($pl['opt']['state']) AND in_array($pl['opt']['state'], $states)) { + $annots .= ' /State /'.$pl['opt']['state']; + } else { + if ($pl['opt']['statemodel'] == 'Marked') { + $annots .= ' /State /Unmarked'; + } else { + $annots .= ' /State /None'; + } + } + break; } - $tfit = array('FreeTextCallout', 'FreeTextTypeWriter'); - if (isset($pl['opt']['it']) AND in_array($pl['opt']['it'], $tfit)) { - $annots .= ' /IT '.$pl['opt']['it']; + case 'link': { + if(is_string($pl['txt'])) { + // external URI link + $annots .= ' /A <_datastring($this->unhtmlentities($pl['txt'])).'>>'; + } else { + // internal link + $l = $this->links[$pl['txt']]; + $annots .= sprintf(' /Dest [%d 0 R /XYZ 0 %.2F null]', (1 + (2 * $l[0])), ($this->pagedim[$l[0]]['h'] - ($l[1] * $this->k))); + } + $hmodes = array('N', 'I', 'O', 'P'); + if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmodes)) { + $annots .= ' /H /'.$pl['opt']['h']; + } else { + $annots .= ' /H /I'; + } + //$annots .= ' /PA '; + //$annots .= ' /Quadpoints '; + break; } - if (isset($pl['opt']['rd']) AND is_array($pl['opt']['rd'])) { - $l = $pl['opt']['rd'][0] * $this->k; - $r = $pl['opt']['rd'][1] * $this->k; - $t = $pl['opt']['rd'][2] * $this->k; - $b = $pl['opt']['rd'][3] * $this->k; - $annots .= ' /RD ['.sprintf('%.2f %.2f %.2f %.2f', $l, $r, $t, $b).']'; + case 'freetext': { + if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) { + $annots .= ' /DA ('.$pl['opt']['da'].')'; + } + if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) { + $annots .= ' /Q '.intval($pl['opt']['q']); + } + if (isset($pl['opt']['rc'])) { + $annots .= ' /RC '.$this->_textstring($pl['opt']['rc']); + } + if (isset($pl['opt']['ds'])) { + $annots .= ' /DS '.$this->_textstring($pl['opt']['ds']); + } + if (isset($pl['opt']['cl']) AND is_array($pl['opt']['cl'])) { + $annots .= ' /CL ['; + foreach ($pl['opt']['cl'] as $cl) { + $annots .= sprintf('%.4F ', $cl * $this->k); + } + $annots .= ']'; + } + $tfit = array('FreeText', 'FreeTextCallout', 'FreeTextTypeWriter'); + if (isset($pl['opt']['it']) AND in_array($pl['opt']['it'], $tfit)) { + $annots .= ' /IT '.$pl['opt']['it']; + } + if (isset($pl['opt']['rd']) AND is_array($pl['opt']['rd'])) { + $l = $pl['opt']['rd'][0] * $this->k; + $r = $pl['opt']['rd'][1] * $this->k; + $t = $pl['opt']['rd'][2] * $this->k; + $b = $pl['opt']['rd'][3] * $this->k; + $annots .= ' /RD ['.sprintf('%.2F %.2F %.2F %.2F', $l, $r, $t, $b).']'; + } + if (isset($pl['opt']['le']) AND in_array($pl['opt']['le'], $lineendings)) { + $annots .= ' /LE /'.$pl['opt']['le']; + } + break; } - //$annots .= ' /LE '; - break; - } - // ... to be completed ... - case 'line': { - break; - } - case 'square': { - break; - } - case 'circle': { - break; - } - case 'polygon': { - break; - } - case 'polyline': { - break; - } - case 'highlight': { - break; - } - case 'underline': { - break; - } - case 'squiggly': { - break; - } - case 'strikeout': { - break; - } - case 'stamp': { - break; - } - case 'caret': { - break; - } - case 'ink': { - break; - } - case 'popup': { - break; - } - case 'fileattachment': { - $iconsapp = array('Graph', 'Paperclip', 'PushPin', 'Tag'); - if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { - $annots .= ' /Name /'.$pl['opt']['name']; - } else { - $annots .= ' /Name /PushPin'; + case 'line': { + break; } - break; - } - case 'sound': { - $iconsapp = array('Speaker', 'Mic'); - if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { - $annots .= ' /Name /'.$pl['opt']['name']; - } else { - $annots .= ' /Name /Speaker'; + case 'square': { + break; + } + case 'circle': { + break; + } + case 'polygon': { + break; + } + case 'polyline': { + break; + } + case 'highlight': { + break; + } + case 'underline': { + break; + } + case 'squiggly': { + break; + } + case 'strikeout': { + break; + } + case 'stamp': { + break; + } + case 'caret': { + break; + } + case 'ink': { + break; + } + case 'popup': { + break; + } + case 'fileattachment': { + if (!isset($pl['opt']['fs'])) { + break; + } + $filename = basename($pl['opt']['fs']); + if (isset($this->embeddedfiles[$filename]['n'])) { + $annots .= ' /FS <_datastring($filename).' /EF <embeddedfiles[$filename]['n'].' 0 R>> >>'; + $iconsapp = array('Graph', 'Paperclip', 'PushPin', 'Tag'); + if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { + $annots .= ' /Name /'.$pl['opt']['name']; + } else { + $annots .= ' /Name /PushPin'; + } + } + break; + } + case 'sound': { + if (!isset($pl['opt']['fs'])) { + break; + } + $filename = basename($pl['opt']['fs']); + if (isset($this->embeddedfiles[$filename]['n'])) { + // ... TO BE COMPLETED ... + // /R /C /B /E /CO /CP + $annots .= ' /Sound <_datastring($filename).' /EF <embeddedfiles[$filename]['n'].' 0 R>> >>'; + $iconsapp = array('Speaker', 'Mic'); + if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) { + $annots .= ' /Name /'.$pl['opt']['name']; + } else { + $annots .= ' /Name /Speaker'; + } + } + break; + } + case 'movie': { + break; + } + case 'widget': { + $hmode = array('N', 'I', 'O', 'P', 'T'); + if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmode)) { + $annots .= ' /H /'.$pl['opt']['h']; + } + if (isset($pl['opt']['mk']) AND (is_array($pl['opt']['mk'])) AND !empty($pl['opt']['mk'])) { + $annots .= ' /MK <<'; + if (isset($pl['opt']['mk']['r'])) { + $annots .= ' /R '.$pl['opt']['mk']['r']; + } + if (isset($pl['opt']['mk']['bc']) AND (is_array($pl['opt']['mk']['bc']))) { + $annots .= ' /BC ['; + foreach($pl['opt']['mk']['bc'] AS $col) { + $col = intval($col); + $color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255); + $annots .= ' '.$color; + } + $annots .= ']'; + } + if (isset($pl['opt']['mk']['bg']) AND (is_array($pl['opt']['mk']['bg']))) { + $annots .= ' /BG ['; + foreach($pl['opt']['mk']['bg'] AS $col) { + $col = intval($col); + $color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255); + $annots .= ' '.$color; + } + $annots .= ']'; + } + if (isset($pl['opt']['mk']['ca'])) { + $annots .= ' /CA '.$pl['opt']['mk']['ca'].''; + } + if (isset($pl['opt']['mk']['rc'])) { + $annots .= ' /RC '.$pl['opt']['mk']['ca'].''; + } + if (isset($pl['opt']['mk']['ac'])) { + $annots .= ' /AC '.$pl['opt']['mk']['ca'].''; + } + if (isset($pl['opt']['mk']['i'])) { + $info = $this->getImageBuffer($pl['opt']['mk']['i']); + if ($info !== false) { + $annots .= ' /I '.$info['n'].' 0 R'; + } + } + if (isset($pl['opt']['mk']['ri'])) { + $info = $this->getImageBuffer($pl['opt']['mk']['ri']); + if ($info !== false) { + $annots .= ' /RI '.$info['n'].' 0 R'; + } + } + if (isset($pl['opt']['mk']['ix'])) { + $info = $this->getImageBuffer($pl['opt']['mk']['ix']); + if ($info !== false) { + $annots .= ' /IX '.$info['n'].' 0 R'; + } + } + if (isset($pl['opt']['mk']['if']) AND (is_array($pl['opt']['mk']['if'])) AND !empty($pl['opt']['mk']['if'])) { + $annots .= ' /IF <<'; + $if_sw = array('A', 'B', 'S', 'N'); + if (isset($pl['opt']['mk']['if']['sw']) AND in_array($pl['opt']['mk']['if']['sw'], $if_sw)) { + $annots .= ' /SW /'.$pl['opt']['mk']['if']['sw']; + } + $if_s = array('A', 'P'); + if (isset($pl['opt']['mk']['if']['s']) AND in_array($pl['opt']['mk']['if']['s'], $if_s)) { + $annots .= ' /S /'.$pl['opt']['mk']['if']['s']; + } + if (isset($pl['opt']['mk']['if']['a']) AND (is_array($pl['opt']['mk']['if']['a'])) AND !empty($pl['opt']['mk']['if']['a'])) { + $annots .= ' /A ['.$pl['opt']['mk']['if']['a'][0].' '.$pl['opt']['mk']['if']['a'][1].']'; + } + if (isset($pl['opt']['mk']['if']['fb']) AND ($pl['opt']['mk']['if']['fb'])) { + $annots .= ' /FB true'; + } + $annots .= '>>'; + } + if (isset($pl['opt']['mk']['tp']) AND ($pl['opt']['mk']['tp'] >= 0) AND ($pl['opt']['mk']['tp'] <= 6)) { + $annots .= ' /TP '.$pl['opt']['mk']['tp']; + } else { + $annots .= ' /TP 0'; + } + $annots .= '>>'; + } // end MK + // --- Entries for field dictionaries --- + if (isset($this->radiobutton_groups[$n][$pl['txt']])) { + // set parent + $annots .= ' /Parent '.$this->radiobutton_groups[$n][$pl['txt']].' 0 R'; + } + if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) { + $annots .= ' /T '.$this->_datastring($pl['opt']['t']); + } + if (isset($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) { + $annots .= ' /TU '.$this->_datastring($pl['opt']['tu']); + } + if (isset($pl['opt']['tm']) AND is_string($pl['opt']['tm'])) { + $annots .= ' /TM '.$this->_datastring($pl['opt']['tm']); + } + if (isset($pl['opt']['ff'])) { + if (is_array($pl['opt']['ff'])) { + // array of bit settings + $flag = 0; + foreach($pl['opt']['ff'] as $val) { + $flag += 1 << ($val - 1); + } + } else { + $flag = intval($pl['opt']['ff']); + } + $annots .= ' /Ff '.$flag; + } + if (isset($pl['opt']['maxlen'])) { + $annots .= ' /MaxLen '.intval($pl['opt']['maxlen']); + } + if (isset($pl['opt']['v'])) { + $annots .= ' /V'; + if (is_array($pl['opt']['v'])) { + foreach ($pl['opt']['v'] AS $optval) { + $annots .= ' '.$optval; + } + } else { + $annots .= ' '.$this->_textstring($pl['opt']['v']); + } + } + if (isset($pl['opt']['dv']) AND is_string($pl['opt']['dv'])) { + $annots .= ' /DV'; + if (is_array($pl['opt']['dv'])) { + foreach ($pl['opt']['dv'] AS $optval) { + $annots .= ' '.$optval; + } + } else { + $annots .= ' '.$this->_textstring($pl['opt']['dv']); + } + } + if (isset($pl['opt']['rv']) AND is_string($pl['opt']['rv'])) { + $annots .= ' /RV'; + if (is_array($pl['opt']['rv'])) { + foreach ($pl['opt']['rv'] AS $optval) { + $annots .= ' '.$optval; + } + } else { + $annots .= ' '.$this->_textstring($pl['opt']['rv']); + } + } + if (isset($pl['opt']['a']) AND !empty($pl['opt']['a'])) { + $annots .= ' /A << '.$pl['opt']['a'].' >>'; + } + if (isset($pl['opt']['aa']) AND !empty($pl['opt']['aa'])) { + $annots .= ' /AA << '.$pl['opt']['aa'].' >>'; + } + if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) { + $annots .= ' /DA ('.$pl['opt']['da'].')'; + } + if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) { + $annots .= ' /Q '.intval($pl['opt']['q']); + } + if (isset($pl['opt']['opt']) AND (is_array($pl['opt']['opt'])) AND !empty($pl['opt']['opt'])) { + $annots .= ' /Opt ['; + foreach($pl['opt']['opt'] AS $copt) { + if (is_array($copt)) { + $annots .= ' ['.$this->_textstring($copt[0]).' '.$this->_textstring($copt[1]).']'; + } else { + $annots .= ' '.$this->_textstring($copt); + } + } + $annots .= ']'; + } + if (isset($pl['opt']['ti'])) { + $annots .= ' /TI '.intval($pl['opt']['ti']); + } + if (isset($pl['opt']['i']) AND (is_array($pl['opt']['i'])) AND !empty($pl['opt']['i'])) { + $annots .= ' /I ['; + foreach($pl['opt']['i'] AS $copt) { + $annots .= intval($copt).' '; + } + $annots .= ']'; + } + break; + } + case 'screen': { + break; + } + case 'printermark': { + break; + } + case 'trapnet': { + break; + } + case 'watermark': { + break; + } + case '3d': { + break; + } + default: { + break; } - break; } - case 'movie': { - break; - } - case 'widget': { - break; - } - case 'screen': { - break; - } - case 'printermark': { - break; - } - case 'trapnet': { - break; - } - case 'watermark': { - break; - } - case '3d': { - break; - } - default: { - break; + $annots .= '>>'; + // create new annotation object + ++$this->annot_obj_id; + $this->offsets[$this->annot_obj_id] = $this->bufferlen; + $this->_out($this->annot_obj_id.' 0 obj'); + $this->_out($annots); + $this->_out('endobj'); + if ($formfield AND ! isset($this->radiobutton_groups[$n][$pl['txt']])) { + // store reference of form object + $this->form_obj_id[] = $this->annot_obj_id; } } - - $annots .= '>>'; } - $annots .= "\n]"; - $this->_out($annots); + } // end for each page + } + + /** + * 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 + * @return int object ID + * @access protected + * @since 4.8.001 (2009-09-09) + */ + protected function _putAPXObject($w=0, $h=0, $stream='') { + $stream = trim($stream); + ++$this->apxo_obj_id; + $this->offsets[$this->apxo_obj_id] = $this->bufferlen; + $this->_out($this->apxo_obj_id.' 0 obj'); + $this->_out('<<'); + $this->_out('/Type /XObject'); + $this->_out('/Subtype /Form'); + $this->_out('/FormType 1'); + if ($this->compress) { + $stream = gzcompress($stream); + $this->_out('/Filter /FlateDecode'); } + $rect = sprintf('%.2F %.2F', $w, $h); + $this->_out('/BBox [0 0 '.$rect.']'); + $this->_out('/Matrix [1 0 0 1 0 0]'); + $this->_out('/Resources <>'); + $this->_out('/Length '.strlen($stream)); + $this->_out('>>'); + $this->_putstream($stream); + $this->_out('endobj'); + return $this->apxo_obj_id; } /** * Output fonts. - * _putfonts * @access protected */ protected function _putfonts() { @@ -4636,60 +6411,80 @@ if (!class_exists('TCPDF', false)) { $this->_out('<>'); $this->_out('endobj'); } - $mqr = get_magic_quotes_runtime(); - set_magic_quotes_runtime(0); + $mqr = $this->get_mqr(); + $this->set_mqr(false); foreach ($this->FontFiles as $file => $info) { - //Font file embedding - $this->_newobj(); - $this->FontFiles[$file]['n'] = $this->n; - $font = file_get_contents($this->_getfontpath().strtolower($file)); - $compressed = (substr($file, -2) == '.z'); - if ((!$compressed) AND (isset($info['length2']))) { - $header = (ord($font{0}) == 128); - if ($header) { - //Strip first binary header - $font = substr($font,6); + // search and get font file to embedd + $fontdir = $info['fontdir']; + $file = strtolower($file); + $fontfile = ''; + // search files on various directories + if (file_exists($fontdir.$file)) { + $fontfile = $fontdir.$file; + } elseif (file_exists($this->_getfontpath().$file)) { + $fontfile = $this->_getfontpath().$file; + } elseif (file_exists($file)) { + $fontfile = $file; + } + if (!$this->empty_string($fontfile)) { + $font = file_get_contents($fontfile); + $compressed = (substr($file, -2) == '.z'); + if ((!$compressed) AND (isset($info['length2']))) { + $header = (ord($font{0}) == 128); + if ($header) { + //Strip first binary header + $font = substr($font, 6); + } + if ($header AND (ord($font{$info['length1']}) == 128)) { + //Strip second binary header + $font = substr($font, 0, $info['length1']).substr($font, ($info['length1'] + 6)); + } } - if ($header AND (ord($font{$info['length1']}) == 128)) { - //Strip second binary header - $font = substr($font, 0, $info['length1']).substr($font, ($info['length1'] + 6)); + $this->_newobj(); + $this->FontFiles[$file]['n'] = $this->n; + $this->_out('<_out('/Filter /FlateDecode'); } + $this->_out('/Length1 '.$info['length1']); + if (isset($info['length2'])) { + $this->_out('/Length2 '.$info['length2'].' /Length3 0'); + } + $this->_out('>>'); + $this->_putstream($font); + $this->_out('endobj'); } - $this->_out('<_out('/Filter /FlateDecode'); - } - $this->_out('/Length1 '.$info['length1']); - if (isset($info['length2'])) { - $this->_out('/Length2 '.$info['length2'].' /Length3 0'); - } - $this->_out('>>'); - $this->_putstream($font); - $this->_out('endobj'); } - set_magic_quotes_runtime($mqr); - foreach ($this->fonts as $k => $font) { + $this->set_mqr($mqr); + foreach ($this->fontkeys as $k) { //Font objects - $this->fonts[$k]['n'] = $this->n + 1; + $this->setFontSubBuffer($k, 'n', $this->n + 1); + $font = $this->getFontBuffer($k); $type = $font['type']; $name = $font['name']; if ($type == 'core') { //Standard font - $this->_newobj(); + $obj_id = $this->_newobj(); $this->_out('<_out('/BaseFont /'.$name); $this->_out('/Subtype /Type1'); - if (($name != 'symbol') AND ($name != 'zapfdingbats')) { + $this->_out('/BaseFont /'.$name); + $this->_out('/Name /F'.$font['i']); + if ((strtolower($name) != 'symbol') AND (strtolower($name) != 'zapfdingbats')) { $this->_out('/Encoding /WinAnsiEncoding'); } + if (strtolower($name) == 'helvetica') { + // add default font for annotations + $this->annotation_fonts['helvetica'] = $k; + } $this->_out('>>'); $this->_out('endobj'); } elseif (($type == 'Type1') OR ($type == 'TrueType')) { //Additional Type1 or TrueType font - $this->_newobj(); + $obj_id = $this->_newobj(); $this->_out('<_out('/BaseFont /'.$name); $this->_out('/Subtype /'.$type); + $this->_out('/BaseFont /'.$name); + $this->_out('/Name /F'.$font['i']); $this->_out('/FirstChar 32 /LastChar 255'); $this->_out('/Widths '.($this->n + 1).' 0 R'); $this->_out('/FontDescriptor '.($this->n + 2).' 0 R'); @@ -4702,12 +6497,11 @@ if (!class_exists('TCPDF', false)) { } $this->_out('>>'); $this->_out('endobj'); - //Widths + // Widths $this->_newobj(); $cw = &$font['cw']; $s = '['; - for($i=32; $i <= 255; $i++) { - //$s .= $cw[chr($i)].' '; + for ($i = 32; $i < 256; ++$i) { $s .= $cw[$i].' '; } $this->_out($s.']'); @@ -4715,12 +6509,11 @@ if (!class_exists('TCPDF', false)) { //Descriptor $this->_newobj(); $s = '< $v) { - $s .= ' /'.$k.' '.$v; + foreach ($font['desc'] as $fdk => $fdv) { + $s .= ' /'.$fdk.' '.$fdv.''; } - $file = $font['file']; - if ($file) { - $s .= ' /FontFile'.($type == 'Type1' ? '' : '2').' '.$this->FontFiles[$file]['n'].' 0 R'; + if (!$this->empty_string($font['file'])) { + $s .= ' /FontFile'.($type == 'Type1' ? '' : '2').' '.$this->FontFiles[$font['file']]['n'].' 0 R'; } $this->_out($s.'>>'); $this->_out('endobj'); @@ -4730,31 +6523,225 @@ if (!class_exists('TCPDF', false)) { if (!method_exists($this, $mtd)) { $this->Error('Unsupported font type: '.$type); } - $this->$mtd($font); + $obj_id = $this->$mtd($font); } + // store object ID for current font + $this->font_obj_ids[$k] = $obj_id; } } + /** + * Outputs font widths + * @parameter array $font font data + * @parameter int $cidoffset offset for CID values + * @author Nicola Asuni + * @access protected + * @since 4.4.000 (2008-12-07) + */ + protected function _putfontwidths($font, $cidoffset=0) { + ksort($font['cw']); + $rangeid = 0; + $range = array(); + $prevcid = -2; + $prevwidth = -1; + $interval = false; + // for each character + foreach ($font['cw'] as $cid => $width) { + $cid -= $cidoffset; + if ($width != $font['dw']) { + if ($cid == ($prevcid + 1)) { + // consecutive CID + if ($width == $prevwidth) { + if ($width == $range[$rangeid][0]) { + $range[$rangeid][] = $width; + } else { + array_pop($range[$rangeid]); + // new range + $rangeid = $prevcid; + $range[$rangeid] = array(); + $range[$rangeid][] = $prevwidth; + $range[$rangeid][] = $width; + } + $interval = true; + $range[$rangeid]['interval'] = true; + } else { + if ($interval) { + // new range + $rangeid = $cid; + $range[$rangeid] = array(); + $range[$rangeid][] = $width; + } else { + $range[$rangeid][] = $width; + } + $interval = false; + } + } else { + // new range + $rangeid = $cid; + $range[$rangeid] = array(); + $range[$rangeid][] = $width; + $interval = false; + } + $prevcid = $cid; + $prevwidth = $width; + } + } + // optimize ranges + $prevk = -1; + $nextk = -1; + $prevint = false; + foreach ($range as $k => $ws) { + $cws = count($ws); + if (($k == $nextk) AND (!$prevint) AND ((!isset($ws['interval'])) OR ($cws < 4))) { + if (isset($range[$k]['interval'])) { + unset($range[$k]['interval']); + } + $range[$prevk] = array_merge($range[$prevk], $range[$k]); + unset($range[$k]); + } else { + $prevk = $k; + } + $nextk = $k + $cws; + if (isset($ws['interval'])) { + if ($cws > 3) { + $prevint = true; + } else { + $prevint = false; + } + unset($range[$k]['interval']); + --$nextk; + } else { + $prevint = false; + } + } + // output data + $w = ''; + foreach ($range as $k => $ws) { + if (count(array_count_values($ws)) == 1) { + // interval mode is more compact + $w .= ' '.$k.' '.($k + count($ws) - 1).' '.$ws[0]; + } else { + // range mode + $w .= ' '.$k.' [ '.implode(' ', $ws).' ]'; + } + } + $this->_out('/W ['.$w.' ]'); + } + + /** + * Adds unicode fonts.
    + * Based on PDF Reference 1.3 (section 5) + * @parameter array $font font data + * @return int font object ID + * @access protected + * @author Nicola Asuni + * @since 1.52.0.TC005 (2005-01-05) + */ + protected function _puttruetypeunicode($font) { + // Type0 Font + // A composite font composed of other fonts, organized hierarchically + $obj_id = $this->_newobj(); + $this->_out('<_out('/Subtype /Type0'); + $this->_out('/BaseFont /'.$font['name'].''); + $this->_out('/Name /F'.$font['i']); + $this->_out('/Encoding /'.$font['enc']); + $this->_out('/ToUnicode /Identity-H'); + $this->_out('/DescendantFonts ['.($this->n + 1).' 0 R]'); + $this->_out('>>'); + $this->_out('endobj'); + // CIDFontType2 + // A CIDFont whose glyph descriptions are based on TrueType font technology + $this->_newobj(); + $this->_out('<_out('/Subtype /CIDFontType2'); + $this->_out('/BaseFont /'.$font['name'].''); + // A dictionary containing entries that define the character collection of the CIDFont. + $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry']); + $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering']); + $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement']; + $this->_out('/CIDSystemInfo <<'.$cidinfo.'>>'); + $this->_out('/FontDescriptor '.($this->n + 1).' 0 R'); + $this->_out('/DW '.$font['dw'].''); // default width + $this->_putfontwidths($font, 0); + $this->_out('/CIDToGIDMap '.($this->n + 2).' 0 R'); + $this->_out('>>'); + $this->_out('endobj'); + // Font descriptor + // A font descriptor describing the CIDFont default metrics other than its glyph widths + $this->_newobj(); + $this->_out('<_out('/FontName /'.$font['name']); + foreach ($font['desc'] as $key => $value) { + $this->_out('/'.$key.' '.$value); + } + $fontdir = ''; + if (!$this->empty_string($font['file'])) { + // A stream containing a TrueType font + $this->_out('/FontFile2 '.$this->FontFiles[$font['file']]['n'].' 0 R'); + $fontdir = $this->FontFiles[$font['file']]['fontdir']; + } + $this->_out('>>'); + $this->_out('endobj'); + $this->_newobj(); + if (isset($font['ctg']) AND (!$this->empty_string($font['ctg']))) { + // Embed CIDToGIDMap + // A specification of the mapping from CIDs to glyph indices + // search and get CTG font file to embedd + $ctgfile = strtolower($font['ctg']); + // search and get ctg font file to embedd + $fontfile = ''; + // search files on various directories + if (file_exists($fontdir.$ctgfile)) { + $fontfile = $fontdir.$ctgfile; + } elseif (file_exists($this->_getfontpath().$ctgfile)) { + $fontfile = $this->_getfontpath().$ctgfile; + } elseif (file_exists($ctgfile)) { + $fontfile = $ctgfile; + } + if ($this->empty_string($fontfile)) { + $this->Error('Font file not found: '.$ctgfile); + } + $size = filesize($fontfile); + $this->_out('<_out('/Filter /FlateDecode'); + } + $this->_out('>>'); + $this->_putstream(file_get_contents($fontfile)); + } + $this->_out('endobj'); + return $obj_id; + } + /** * Output CID-0 fonts. + * A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format * @param array $font font data + * @return int font object ID * @access protected * @author Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira * @since 3.2.000 (2008-06-23) */ protected function _putcidfont0($font) { + $cidoffset = 0; + if (!isset($font['cw'][1])) { + $cidoffset = 31; + } if (isset($font['cidinfo']['uni2cid'])) { // convert unicode to cid. $uni2cid = $font['cidinfo']['uni2cid']; $cw = array(); foreach ($font['cw'] as $uni => $width) { if (isset($uni2cid[$uni])) { - $cw[($uni2cid[$uni] + 31)] = $width; - } elseif ($uni <= 255) { + $cw[($uni2cid[$uni] + $cidoffset)] = $width; + } elseif ($uni < 256) { $cw[$uni] = $width; } // else unknown character } - ksort($cw); $font = array_merge($font, array('cw' => $cw)); } $name = $font['name']; @@ -4764,10 +6751,11 @@ if (!class_exists('TCPDF', false)) { } else { $longname = $name; } - $this->_newobj(); + $obj_id = $this->_newobj(); $this->_out('<_out('/BaseFont /'.$longname); $this->_out('/Subtype /Type0'); + $this->_out('/BaseFont /'.$longname); + $this->_out('/Name /F'.$font['i']); if ($enc) { $this->_out('/Encoding /'.$enc); } @@ -4776,44 +6764,27 @@ if (!class_exists('TCPDF', false)) { $this->_out('endobj'); $this->_newobj(); $this->_out('<_out('/BaseFont /'.$name); $this->_out('/Subtype /CIDFontType0'); + $this->_out('/BaseFont /'.$name); $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry']); - $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering']); + $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering']); $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement']; $this->_out('/CIDSystemInfo <<'.$cidinfo.'>>'); $this->_out('/FontDescriptor '.($this->n + 1).' 0 R'); - $codes = array_keys($font['cw']); - $first = current($codes); - $last = end($codes); $this->_out('/DW '.$font['dw']); - $w = '/W ['; - $ranges = array(); - $currange = 0; - for($i = $first; $i <= $last; $i++) { - if (isset($font['cw'][$i]) AND (!$currange)) { - $currange = $i - 31; - } elseif (!isset($font['cw'][$i])) { - $currange = 0; - } - if ($currange) { - $ranges[$currange][] = $font['cw'][$i]; - } - } - foreach ($ranges as $k => $ws) { - $w .= ' '.$k.' [ '.implode(' ', $ws).' ]'; - } - $w .= ' ]'; - $this->_out($w); + $this->_putfontwidths($font, $cidoffset); $this->_out('>>'); $this->_out('endobj'); $this->_newobj(); $s = '< $v) { - $s .= ' /'.$k.' '.$v; + if ($k != 'Style') { + $s .= ' /'.$k.' '.$v.''; + } } $this->_out($s.'>>'); $this->_out('endobj'); + return $obj_id; } /** @@ -4822,19 +6793,19 @@ if (!class_exists('TCPDF', false)) { */ protected function _putimages() { $filter = ($this->compress) ? '/Filter /FlateDecode ' : ''; - reset($this->images); - while (list($file, $info) = each($this->images)) { + foreach ($this->imagekeys as $file) { + $info = $this->getImageBuffer($file); $this->_newobj(); - $this->images[$file]['n'] = $this->n; + $this->setImageSubBuffer($file, 'n', $this->n); $this->_out('<_out('/Subtype /Image'); $this->_out('/Width '.$info['w']); $this->_out('/Height '.$info['h']); - if (isset($info['masked'])) { - $this->_out('/SMask '.($this->n-1).' 0 R'); + if (array_key_exists('masked', $info)) { + $this->_out('/SMask '.($this->n - 1).' 0 R'); } if ($info['cs'] == 'Indexed') { - $this->_out('/ColorSpace [/Indexed /DeviceRGB '.(strlen($info['pal']) / 3 - 1).' '.($this->n + 1).' 0 R]'); + $this->_out('/ColorSpace [/Indexed /DeviceRGB '.((strlen($info['pal']) / 3) - 1).' '.($this->n + 1).' 0 R]'); } else { $this->_out('/ColorSpace /'.$info['cs']); if ($info['cs'] == 'DeviceCMYK') { @@ -4848,16 +6819,16 @@ if (!class_exists('TCPDF', false)) { if (isset($info['parms'])) { $this->_out($info['parms']); } - if (isset($info['trns']) and is_array($info['trns'])) { + if (isset($info['trns']) AND is_array($info['trns'])) { $trns=''; - for($i=0; $i < count($info['trns']); $i++) { + $count_info = count($info['trns']); + for ($i=0; $i < $count_info; ++$i) { $trns .= $info['trns'][$i].' '.$info['trns'][$i].' '; } $this->_out('/Mask ['.$trns.']'); } $this->_out('/Length '.strlen($info['data']).'>>'); $this->_putstream($info['data']); - unset($this->images[$file]['data']); $this->_out('endobj'); //Palette if ($info['cs'] == 'Indexed') { @@ -4882,7 +6853,7 @@ if (!class_exists('TCPDF', false)) { $this->_out('[/Separation /'.str_replace(' ', '#20', $name)); $this->_out('/DeviceCMYK <<'); $this->_out('/Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0] '); - $this->_out(sprintf('/C1 [%.4f %.4f %.4f %.4f] ', $color['c']/100, $color['m']/100, $color['y']/100, $color['k']/100)); + $this->_out(sprintf('/C1 [%.4F %.4F %.4F %.4F] ', $color['c']/100, $color['m']/100, $color['y']/100, $color['k']/100)); $this->_out('/FunctionType 2 /Domain [0 1] /N 1>>]'); $this->_out('endobj'); } @@ -4893,8 +6864,9 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _putxobjectdict() { - foreach ($this->images as $image) { - $this->_out('/I'.$image['i'].' '.$image['n'].' 0 R'); + foreach ($this->imagekeys as $file) { + $info = $this->getImageBuffer($file); + $this->_out('/I'.$info['i'].' '.$info['n'].' 0 R'); } } @@ -4905,7 +6877,8 @@ if (!class_exists('TCPDF', false)) { protected function _putresourcedict() { $this->_out('/ProcSet [/PDF /Text /ImageB /ImageC /ImageI]'); $this->_out('/Font <<'); - foreach ($this->fonts as $font) { + foreach ($this->fontkeys as $fontkey) { + $font = $this->getFontBuffer($fontkey); $this->_out('/F'.$font['i'].' '.$font['n'].' 0 R'); } $this->_out('>>'); @@ -4950,14 +6923,16 @@ if (!class_exists('TCPDF', false)) { $this->_putspotcolors(); $this->_putshaders(); //Resource dictionary - $this->offsets[2] = strlen($this->buffer); + $this->offsets[2] = $this->bufferlen; $this->_out('2 0 obj'); $this->_out('<<'); $this->_putresourcedict(); $this->_out('>>'); $this->_out('endobj'); - $this->_putjavascript(); $this->_putbookmarks(); + $this->_putEmbeddedFiles(); + $this->_putannotsobjs(); + $this->_putjavascript(); // encryption if ($this->encrypted) { $this->_newobj(); @@ -4970,31 +6945,44 @@ if (!class_exists('TCPDF', false)) { } /** - * Adds some Metadata information - * (see Chapter 10.2 of PDF Reference) + * Adds some Metadata information (Document Information Dictionary) + * (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference) * @access protected */ protected function _putinfo() { - if (!empty($this->title)) { + if (!$this->empty_string($this->title)) { + // The document's title. $this->_out('/Title '.$this->_textstring($this->title)); } - if (!empty($this->author)) { + if (!$this->empty_string($this->author)) { + // The name of the person who created the document. $this->_out('/Author '.$this->_textstring($this->author)); } - if (!empty($this->subject)) { + if (!$this->empty_string($this->subject)) { + // The subject of the document. $this->_out('/Subject '.$this->_textstring($this->subject)); } - if (!empty($this->keywords)) { + if (!$this->empty_string($this->keywords)) { + // Keywords associated with the document. $this->_out('/Keywords '.$this->_textstring($this->keywords)); } - if (!empty($this->creator)) { + if (!$this->empty_string($this->creator)) { + // 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. $this->_out('/Creator '.$this->_textstring($this->creator)); } if (defined('PDF_PRODUCER')) { + // If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF. $this->_out('/Producer '.$this->_textstring(PDF_PRODUCER)); + } else { + // default producer + $this->_out('/Producer '.$this->_textstring('TCPDF')); } - $this->_out('/CreationDate '.$this->_datastring('D:'.date('YmdHis'))); - $this->_out('/ModDate '.$this->_datastring('D:'.date('YmdHis'))); + // The date and time the document was created, in human-readable form + $this->_out('/CreationDate '.$this->_datestring()); + // The date and time the document was most recently modified, in human-readable form + $this->_out('/ModDate '.$this->_datestring()); + // A name object indicating whether the document has been modified to include trapping information + //$this->_out('/Trapped /False'); } /** @@ -5004,7 +6992,6 @@ if (!class_exists('TCPDF', false)) { protected function _putcatalog() { $this->_out('/Type /Catalog'); $this->_out('/Pages 1 0 R'); - if ($this->ZoomMode == 'fullpage') { $this->_out('/OpenAction [3 0 R /Fit]'); } elseif ($this->ZoomMode == 'fullwidth') { @@ -5013,19 +7000,21 @@ if (!class_exists('TCPDF', false)) { $this->_out('/OpenAction [3 0 R /XYZ null null 1]'); } elseif (!is_string($this->ZoomMode)) { $this->_out('/OpenAction [3 0 R /XYZ null null '.($this->ZoomMode / 100).']'); - } - if (isset($this->LayoutMode) AND (!empty($this->LayoutMode))) { + } + if (isset($this->LayoutMode) AND (!$this->empty_string($this->LayoutMode))) { $this->_out('/PageLayout /'.$this->LayoutMode.''); } - if (isset($this->PageMode) AND (!empty($this->PageMode))) { + if (isset($this->PageMode) AND (!$this->empty_string($this->PageMode))) { $this->_out('/PageMode /'.$this->PageMode); } if (isset($this->l['a_meta_language'])) { $this->_out('/Lang /'.$this->l['a_meta_language']); } - if (!empty($this->javascript)) { - $this->_out('/Names <n_js).' 0 R>>'); + $this->_out('/Names <<'); + if ((!empty($this->javascript)) OR (!empty($this->js_objects))) { + $this->_out('/JavaScript '.($this->n_js).' 0 R'); } + $this->_out('>>'); if (count($this->outlines) > 0) { $this->_out('/Outlines '.$this->OutlineRoot.' 0 R'); $this->_out('/PageMode /UseOutlines'); @@ -5035,7 +7024,46 @@ if (!class_exists('TCPDF', false)) { $v = $this->n_ocg_view.' 0 R'; $as = '<> <>'; $this->_out('/OCProperties <>>>'); - $this->_putuserrights(); + // AcroForm + if (!empty($this->form_obj_id) OR ($this->sign AND isset($this->signature_data['cert_type']))) { + $this->_out('/AcroForm<<'); + $objrefs = ''; + if ($this->sign AND isset($this->signature_data['cert_type'])) { + $objrefs .= $this->sig_obj_id.' 0 R'; + } + if (!empty($this->form_obj_id)) { + foreach($this->form_obj_id as $objid) { + $objrefs .= ' '.$objid.' 0 R'; + } + } + $this->_out('/Fields ['.$objrefs.']'); + $this->_out('/NeedAppearances '.(empty($this->form_obj_id)?'false':'true')); + if ($this->sign AND isset($this->signature_data['cert_type'])) { + $this->_out('/SigFlags 3'); + } + //$this->_out('/CO '); + if (isset($this->annotation_fonts) AND !empty($this->annotation_fonts)) { + $this->_out('/DR <<'); + $this->_out('/Font <<'); + foreach ($this->annotation_fonts as $font => $fontkey) { + $this->_out('/F'.($fontkey + 1).' '.$this->font_obj_ids[$font].' 0 R'); + } + $this->_out('>>'); + $this->_out('>>'); + } + $this->_out('/DA (/F'.(array_search('helvetica', $this->fontkeys) + 1).' 0 Tf 0 g)'); + $this->_out('/Q '.(($this->rtl)?'2':'0')); + //$this->_out('/XFA '); + $this->_out('>>'); + // signatures + if ($this->sign AND isset($this->signature_data['cert_type'])) { + if ($this->signature_data['cert_type'] > 0) { + $this->_out('/Perms<sig_obj_id + 1).' 0 R>>'); + } else { + $this->_out('/Perms<sig_obj_id + 1).' 0 R>>'); + } + } + } } /** @@ -5087,7 +7115,7 @@ if (!class_exists('TCPDF', false)) { if (isset($this->viewer_preferences['PrintScaling'])) { $this->_out('/PrintScaling /'.$this->viewer_preferences['PrintScaling']); } - if (isset($this->viewer_preferences['Duplex']) AND (!empty($this->viewer_preferences['Duplex']))) { + if (isset($this->viewer_preferences['Duplex']) AND (!$this->empty_string($this->viewer_preferences['Duplex']))) { $this->_out('/Duplex /'.$this->viewer_preferences['Duplex']); } if (isset($this->viewer_preferences['PickTrayByPDFSize'])) { @@ -5109,7 +7137,7 @@ if (!class_exists('TCPDF', false)) { } $this->_out('>>'); } - + /** * Output trailer. * @access protected @@ -5137,28 +7165,93 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _enddoc() { - $this->_putheader(); + $this->state = 1; + $this->_putheader(); $this->_putpages(); $this->_putresources(); - //Info + // Signature + if ($this->sign AND isset($this->signature_data['cert_type'])) { + // widget annotation for signature + $this->sig_obj_id = $this->_newobj(); + // --- replace signature ID on the first page --- + // get the document content + $pdfdoc = $this->getBuffer(); + // Remove the original buffer + if (isset($this->diskcache) AND $this->diskcache) { + // remove buffer file from cache + unlink($this->buffer); + } + unset($this->buffer); + $signature_widget_ref = sprintf('%u 0 R', $this->sig_obj_id); + $signature_widget_ref .= str_repeat(' ', (strlen($this->sig_annot_ref) - strlen($signature_widget_ref))); + $pdfdoc = str_replace($this->sig_annot_ref, $signature_widget_ref, $pdfdoc); + $this->diskcache = false; + $this->buffer = &$pdfdoc; + $this->bufferlen = strlen($pdfdoc); + // --- + $this->_out('<<'); + $this->_out('/Type /Annot /Subtype /Widget /Rect [0 0 0 0]'); + $this->_out('/P 3 0 R'); // link to first page object + $this->_out('/FT /Sig'); + $this->_out('/T '.$this->_textstring('Signature')); + $this->_out('/Ff 0'); + $this->_out('/V '.($this->sig_obj_id + 1).' 0 R'); + $this->_out('>>'); + $this->_out('endobj'); + // signature + $this->_newobj(); + $this->_out('<<'); + $this->_putsignature(); + $this->_out('>>'); + $this->_out('endobj'); + } + // Info $this->_newobj(); $this->_out('<<'); $this->_putinfo(); $this->_out('>>'); $this->_out('endobj'); - //Catalog + // Catalog $this->_newobj(); $this->_out('<<'); $this->_putcatalog(); $this->_out('>>'); $this->_out('endobj'); - //Cross-ref - $o = strlen($this->buffer); + // Cross-ref + $o = $this->bufferlen; $this->_out('xref'); $this->_out('0 '.($this->n + 1)); $this->_out('0000000000 65535 f '); - for($i=1; $i <= $this->n; $i++) { - $this->_out(sprintf('%010d 00000 n ',$this->offsets[$i])); + for ($i=1; $i <= $this->n; ++$i) { + $this->_out(sprintf('%010d 00000 n ', $this->offsets[$i])); + } + // Embedded Files + if (isset($this->embeddedfiles) AND count($this->embeddedfiles) > 0) { + $this->_out($this->embedded_start_obj_id.' '.count($this->embeddedfiles)); + foreach ($this->embeddedfiles as $filename => $filedata) { + $this->_out(sprintf('%010d 00000 n ', $this->offsets[$filedata['n']])); + } + } + // Annotation Objects + if ($this->annot_obj_id > $this->annots_start_obj_id) { + $this->_out(($this->annots_start_obj_id + 1).' '.($this->annot_obj_id - $this->annots_start_obj_id)); + for ($i = ($this->annots_start_obj_id + 1); $i <= $this->annot_obj_id; ++$i) { + $this->_out(sprintf('%010d 00000 n ', $this->offsets[$i])); + } + } + // Javascript Objects + if ($this->js_obj_id > $this->js_start_obj_id) { + $this->_out(($this->js_start_obj_id + 1).' '.($this->js_obj_id - $this->js_start_obj_id)); + for ($i = ($this->js_start_obj_id + 1); $i <= $this->js_obj_id; ++$i) { + $this->_out(sprintf('%010d 00000 n ', $this->offsets[$i])); + } + } + // Appearance streams XObjects + if ($this->apxo_obj_id > $this->apxo_start_obj_id) { + $this->_out(($this->apxo_start_obj_id + 1).' '.($this->apxo_obj_id - $this->apxo_start_obj_id)); + for ($i = ($this->apxo_start_obj_id + 1); $i <= $this->apxo_obj_id; ++$i) { + $this->_out(sprintf('%010d 00000 n ', $this->offsets[$i])); + } } //Trailer $this->_out('trailer'); @@ -5168,7 +7261,18 @@ if (!class_exists('TCPDF', false)) { $this->_out('startxref'); $this->_out($o); $this->_out('%%EOF'); - $this->state = 3; + $this->state = 3; // end-of-doc + if ($this->diskcache) { + // remove temporary files used for images + foreach ($this->imagekeys as $key) { + // remove temporary files + unlink($this->images[$key]); + } + foreach ($this->fontkeys as $key) { + // remove temporary files + unlink($this->fonts[$key]); + } + } } /** @@ -5178,20 +7282,22 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _beginpage($orientation='', $format='') { - $this->page++; - $this->pages[$this->page] = ''; // this mark should be removed before output + ++$this->page; + $this->setPageBuffer($this->page, ''); + // initialize array for graphics tranformation positions inside a page buffer + $this->transfmrk[$this->page] = array(); $this->state = 2; - if (empty($orientation)) { + if ($this->empty_string($orientation)) { if (isset($this->CurOrientation)) { $orientation = $this->CurOrientation; } else { $orientation = 'P'; } } - if (!empty($format)) { - $this->setPageFormat($format, $orientation); - } else { + if ($this->empty_string($format)) { $this->setPageOrientation($orientation); + } else { + $this->setPageFormat($format, $orientation); } if ($this->rtl) { $this->x = $this->w - $this->rMargin; @@ -5199,15 +7305,14 @@ if (!class_exists('TCPDF', false)) { $this->x = $this->lMargin; } $this->y = $this->tMargin; - if ($this->newpagegroup) { + if (isset($this->newpagegroup[$this->page])) { // start a new group $n = sizeof($this->pagegroups) + 1; $alias = '{nb'.$n.'}'; $this->pagegroups[$alias] = 1; $this->currpagegroup = $alias; - $this->newpagegroup = false; } elseif ($this->currpagegroup) { - $this->pagegroups[$this->currpagegroup]++; + ++$this->pagegroups[$this->currpagegroup]; } } @@ -5221,13 +7326,15 @@ if (!class_exists('TCPDF', false)) { } /** - * Begin a new object. + * Begin a new object and return the object number. + * @return int object number * @access protected */ protected function _newobj() { - $this->n++; - $this->offsets[$this->n] = strlen($this->buffer); + ++$this->n; + $this->offsets[$this->n] = $this->bufferlen; $this->_out($this->n.' 0 obj'); + return $this->n; } /** @@ -5238,10 +7345,8 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _dounderline($x, $y, $txt) { - $up = $this->CurrentFont['up']; - $ut = $this->CurrentFont['ut']; $w = $this->GetStringWidth($txt); - return sprintf('%.2f %.2f %.2f %.2f re f', $x * $this->k, ($this->h - ($y - $up / 1000 * $this->FontSize)) * $this->k, $w * $this->k, -$ut / 1000 * $this->FontSizePt); + return $this->_dounderlinew($x, $y, $w); } /** @@ -5252,10 +7357,36 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _dolinethrough($x, $y, $txt) { + $w = $this->GetStringWidth($txt); + return $this->_dolinethroughw($x, $y, $w); + } + + /** + * Underline for rectangular text area. + * @param int $x X coordinate + * @param int $y Y coordinate + * @param int $w width to underline + * @access protected + * @since 4.8.008 (2009-09-29) + */ + protected function _dounderlinew($x, $y, $w) { $up = $this->CurrentFont['up']; $ut = $this->CurrentFont['ut']; - $w = $this->GetStringWidth($txt); - return sprintf('%.2f %.2f %.2f %.2f re f', $x * $this->k, ($this->h - ($y - ($this->FontSize/2) - $up / 1000 * $this->FontSize)) * $this->k, $w * $this->k, -$ut / 1000 * $this->FontSizePt); + return sprintf('%.2F %.2F %.2F %.2F re f', $x * $this->k, ($this->h - ($y - $up / 1000 * $this->FontSize)) * $this->k, $w * $this->k, -$ut / 1000 * $this->FontSizePt); + } + + /** + * Line through for rectangular text area. + * @param int $x X coordinate + * @param int $y Y coordinate + * @param string $txt text to linethrough + * @access protected + * @since 4.8.008 (2009-09-29) + */ + protected function _dolinethroughw($x, $y, $w) { + $up = $this->CurrentFont['up']; + $ut = $this->CurrentFont['ut']; + return sprintf('%.2F %.2F %.2F %.2F re f', $x * $this->k, ($this->h - ($y - ($this->FontSize/2) - $up / 1000 * $this->FontSize)) * $this->k, $w * $this->k, -$ut / 1000 * $this->FontSizePt); } /** @@ -5265,7 +7396,7 @@ if (!class_exists('TCPDF', false)) { * @access protected */ protected function _freadint($f) { - $a = unpack('Ni', fread($f,4)); + $a = unpack('Ni', fread($f, 4)); return $a['i']; } @@ -5281,7 +7412,7 @@ if (!class_exists('TCPDF', false)) { } /** - * Format a date string for meta information + * Format a data string for meta information * @param string $s date string to escape. * @return string escaped string. * @access protected @@ -5292,7 +7423,18 @@ if (!class_exists('TCPDF', false)) { } return '('. $this->_escape($s).')'; } - + + /** + * Returns a formatted date for meta information + * @return string escaped date string. + * @access protected + * @since 4.6.028 (2009-08-25) + */ + protected function _datestring() { + $current_time = substr_replace(date('YmdHisO'), '\'', (0 - 2), 0).'\''; + return $this->_datastring('D:'.$current_time); + } + /** * Format a text string for meta information * @param string $s string to escape. @@ -5346,126 +7488,21 @@ if (!class_exists('TCPDF', false)) { */ protected function _out($s) { if ($this->state == 2) { - if (isset($this->footerlen[$this->page]) AND ($this->footerlen[$this->page] > 0)) { + if ((!$this->InFooter) AND isset($this->footerlen[$this->page]) AND ($this->footerlen[$this->page] > 0)) { // puts data before page footer - $page = substr($this->pages[$this->page], 0, -$this->footerlen[$this->page]); - $footer = substr($this->pages[$this->page], -$this->footerlen[$this->page]); - $this->pages[$this->page] = $page.' '.$s."\n".$footer; + $pagebuff = $this->getPageBuffer($this->page); + $page = substr($pagebuff, 0, -$this->footerlen[$this->page]); + $footer = substr($pagebuff, -$this->footerlen[$this->page]); + $this->setPageBuffer($this->page, $page.$s."\n".$footer); + // update footer position + $this->footerpos[$this->page] += strlen($s."\n"); } else { - $this->pages[$this->page] .= $s."\n"; + $this->setPageBuffer($this->page, $s."\n", true); } } else { - $this->buffer .= $s."\n"; + $this->setBuffer($s."\n"); } } - - /** - * Adds unicode fonts.
    - * Based on PDF Reference 1.3 (section 5) - * @access protected - * @author Nicola Asuni - * @since 1.52.0.TC005 (2005-01-05) - */ - protected function _puttruetypeunicode($font) { - // Type0 Font - // A composite font composed of other fonts, organized hierarchically - $this->_newobj(); - $this->_out('<_out('/Subtype /Type0'); - $this->_out('/BaseFont /'.$font['name'].''); - $this->_out('/Encoding /Identity-H'); //The horizontal identity mapping for 2-byte CIDs; may be used with CIDFonts using any Registry, Ordering, and Supplement values. - $this->_out('/DescendantFonts ['.($this->n + 1).' 0 R]'); - $this->_out('/ToUnicode '.($this->n + 2).' 0 R'); - $this->_out('>>'); - $this->_out('endobj'); - // CIDFontType2 - // A CIDFont whose glyph descriptions are based on TrueType font technology - $this->_newobj(); - $this->_out('<_out('/Subtype /CIDFontType2'); - $this->_out('/BaseFont /'.$font['name'].''); - $this->_out('/CIDSystemInfo '.($this->n + 2).' 0 R'); - $this->_out('/FontDescriptor '.($this->n + 3).' 0 R'); - if (isset($font['desc']['MissingWidth'])) { - $this->_out('/DW '.$font['desc']['MissingWidth'].''); // The default width for glyphs in the CIDFont MissingWidth - } - $w = ''; - foreach ($font['cw'] as $cid => $width) { - $w .= ''.$cid.' ['.$width.'] '; // define a specific width for each individual CID - } - $this->_out('/W ['.$w.']'); // A description of the widths for the glyphs in the CIDFont - $this->_out('/CIDToGIDMap '.($this->n + 4).' 0 R'); - $this->_out('>>'); - $this->_out('endobj'); - // ToUnicode - // is a stream object that contains the definition of the CMap - // (PDF Reference 1.3 chap. 5.9) - $this->_newobj(); - $this->_out('<>'); - $this->_out('stream'); - $this->_out('/CIDInit /ProcSet findresource begin'); - $this->_out('12 dict begin'); - $this->_out('begincmap'); - $this->_out('/CIDSystemInfo'); - $this->_out('<_out('/Ordering (UCS)'); - $this->_out('/Supplement 0'); - $this->_out('>> def'); - $this->_out('/CMapName /Adobe-Identity-UCS def'); - $this->_out('/CMapType 2 def'); - $this->_out('1 begincodespacerange'); - $this->_out('<0000> '); - $this->_out('endcodespacerange'); - $this->_out('1 beginbfrange'); - $this->_out('<0000> <0000>'); - $this->_out('endbfrange'); - $this->_out('endcmap'); - $this->_out('CMapName currentdict /CMap defineresource pop'); - $this->_out('end'); - $this->_out('end'); - $this->_out('endstream'); - $this->_out('endobj'); - // CIDSystemInfo dictionary - // A dictionary containing entries that define the character collection of the CIDFont. - $this->_newobj(); - $this->_out('<_out('/Ordering (UCS)'); // A string that uniquely names a character collection issued by a specific registry - $this->_out('/Supplement 0'); // The supplement number of the character collection. - $this->_out('>>'); - $this->_out('endobj'); - // Font descriptor - // A font descriptor describing the CIDFont default metrics other than its glyph widths - $this->_newobj(); - $this->_out('<_out('/FontName /'.$font['name']); - foreach ($font['desc'] as $key => $value) { - $this->_out('/'.$key.' '.$value); - } - if ($font['file']) { - // A stream containing a TrueType font program - $this->_out('/FontFile2 '.$this->FontFiles[$font['file']]['n'].' 0 R'); - } - $this->_out('>>'); - $this->_out('endobj'); - // Embed CIDToGIDMap - // A specification of the mapping from CIDs to glyph indices - $this->_newobj(); - $ctgfile = $this->_getfontpath().strtolower($font['ctg']); - if (!file_exists($ctgfile)) { - $this->Error('Font file not found: '.$ctgfile); - } - $size = filesize($ctgfile); - $this->_out('<_out('/Filter /FlateDecode'); - } - $this->_out('>>'); - $this->_putstream(file_get_contents($ctgfile)); - $this->_out('endobj'); - } /** * Converts UTF-8 strings to codepoints array.
    @@ -5502,13 +7539,25 @@ if (!class_exists('TCPDF', false)) { * @since 1.53.0.TC005 (2005-01-05) */ protected function UTF8StringToArray($str) { + if (isset($this->cache_UTF8StringToArray['_'.$str])) { + // return cached value + return($this->cache_UTF8StringToArray['_'.$str]); + } + // check cache size + if ($this->cache_size_UTF8StringToArray >= $this->cache_maxsize_UTF8StringToArray) { + // remove first element + array_shift($this->cache_UTF8StringToArray); + } + ++$this->cache_size_UTF8StringToArray; if (!$this->isunicode) { // split string into array of equivalent codes $strarr = array(); $strlen = strlen($str); - for($i=0; $i < $strlen; $i++) { + for ($i=0; $i < $strlen; ++$i) { $strarr[] = ord($str{$i}); } + // insert new value on cache + $this->cache_UTF8StringToArray['_'.$str] = $strarr; return $strarr; } $unicode = array(); // array containing unicode values @@ -5516,7 +7565,7 @@ if (!class_exists('TCPDF', false)) { $numbytes = 1; // number of octetc needed to represent the UTF-8 character $str .= ''; // force $str to be a string $length = strlen($str); - for($i = 0; $i < $length; $i++) { + for ($i = 0; $i < $length; ++$i) { $char = ord($str{$i}); // get one string character at time if (count($bytes) == 0) { // get starting octect if ($char <= 0x7F) { @@ -5542,7 +7591,7 @@ if (!class_exists('TCPDF', false)) { if (count($bytes) == $numbytes) { // compose UTF-8 bytes to a single unicode value $char = $bytes[0]; - for($j = 1; $j < $numbytes; $j++) { + for ($j = 1; $j < $numbytes; ++$j) { $char += ($bytes[$j] << (($numbytes - $j - 1) * 0x06)); } if ((($char >= 0xD800) AND ($char <= 0xDFFF)) OR ($char >= 0x10FFFF)) { @@ -5565,6 +7614,8 @@ if (!class_exists('TCPDF', false)) { $numbytes = 1; } } + // insert new value on cache + $this->cache_UTF8StringToArray['_'.$str] = $unicode; return $unicode; } @@ -5615,6 +7666,35 @@ if (!class_exists('TCPDF', false)) { } return $outstr; } + + /** + * Converts UTF-8 characters array to Latin1
    + * @param array $unicode array containing UTF-8 unicode values + * @return array + * @author Nicola Asuni + * @access protected + * @since 4.8.023 (2010-01-15) + */ + protected function UTF8ArrToLatin1($unicode) { + global $utf8tolatin; + if ((!$this->isunicode) OR ($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { + return $unicode; // string is not in unicode + } + $outarr = array(); // array to be returned + foreach ($unicode as $char) { + if ($char < 256) { + $outarr[] = $char; + } elseif (array_key_exists($char, $utf8tolatin)) { + // map from UTF-8 + $outarr[] = $utf8tolatin[$char]; + } elseif ($char == 0xFFFD) { + // skip + } else { + $outarr[] = 63; // '?' character + } + } + return $outarr; + } /** * Converts array of UTF-8 characters to UTF16-BE string.
    @@ -5682,6 +7762,7 @@ if (!class_exists('TCPDF', false)) { /** * Set header font. * @param array $font font + * @access public * @since 1.1 */ public function setHeaderFont($font) { @@ -5691,6 +7772,7 @@ if (!class_exists('TCPDF', false)) { /** * Get header font. * @return array() + * @access public * @since 4.0.012 (2008-07-24) */ public function getHeaderFont() { @@ -5700,6 +7782,7 @@ if (!class_exists('TCPDF', false)) { /** * Set footer font. * @param array $font font + * @access public * @since 1.1 */ public function setFooterFont($font) { @@ -5709,6 +7792,7 @@ if (!class_exists('TCPDF', false)) { /** * Get Footer font. * @return array() + * @access public * @since 4.0.012 (2008-07-24) */ public function getFooterFont() { @@ -5718,15 +7802,21 @@ if (!class_exists('TCPDF', false)) { /** * Set language array. * @param array $language + * @access public * @since 1.1 */ public function setLanguageArray($language) { $this->l = $language; - $this->rtl = $this->l['a_meta_dir']=='rtl' ? true : false; + if (isset($this->l['a_meta_dir'])) { + $this->rtl = $this->l['a_meta_dir']=='rtl' ? true : false; + } else { + $this->rtl = false; + } } /** * Returns the PDF data. + * @access public */ public function getPDFData() { if ($this->state < 3) { @@ -5741,21 +7831,33 @@ if (!class_exists('TCPDF', false)) { * @param string $name link name * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. * @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) * @return the number of cells used or the remaining text if $firstline = true; * @access public */ - public function addHtmlLink($url, $name, $fill=0, $firstline=false) { - if ($url{0} == '#') { + public function addHtmlLink($url, $name, $fill=0, $firstline=false, $color='', $style=-1) { + if (!$this->empty_string($url) AND ($url{0} == '#')) { // convert url to internal link $page = intval(substr($url, 1)); $url = $this->AddLink(); $this->SetLink($url, 0, $page); } + // store current settings $prevcolor = $this->fgcolor; - $this->SetTextColor(0, 0, 255); $prevstyle = $this->FontStyle; - $this->SetFont('', $this->FontStyle.'U'); + if (empty($color)) { + $this->SetTextColorArray($this->htmlLinkColorArray); + } else { + $this->SetTextColorArray($color); + } + if ($style == -1) { + $this->SetFont('', $this->FontStyle.$this->htmlLinkFontStyle); + } else { + $this->SetFont('', $this->FontStyle.$style); + } $ret = $this->Write($this->lasth, $name, $url, $fill, '', false, 0, $firstline); + // restore settings $this->SetFont('', $prevstyle); $this->SetTextColorArray($prevcolor); return $ret; @@ -5764,18 +7866,22 @@ if (!class_exists('TCPDF', false)) { /** * Returns an associative array (keys: R,G,B) from an html color name or a six-digit or three-digit hexadecimal color representation (i.e. #3FE5AA or #7FF). * @param string $color html color - * @return array - * @access protected + * @return array RGB color or false in case of error. + * @access public */ - protected function convertHTMLColorToDec($color='#000000') { + public function convertHTMLColorToDec($color='#FFFFFF') { global $webcolor; + $returncolor = false; $color = preg_replace('/[\s]*/', '', $color); // remove extra spaces - // set default color to be returned in case of error - $returncolor = array ('R' => 0, 'G' => 0, 'B' => 0); - if (empty($color)) { - return $returncolor; + $color = strtolower($color); + if (($dotpos = strpos($color, '.')) !== false) { + // remove class parent (i.e.: color.red) + $color = substr($color, ($dotpos + 1)); } - if (substr(strtolower($color), 0, 3) == 'rgb') { + if (strlen($color) == 0) { + return false; + } + if (substr($color, 0, 3) == 'rgb') { $codes = substr($color, 4); $codes = str_replace(')', '', $codes); $returncolor = explode(',', $codes, 3); @@ -5783,10 +7889,10 @@ if (!class_exists('TCPDF', false)) { } if (substr($color, 0, 1) != '#') { // decode color name - if (isset($webcolor[strtolower($color)])) { - $color_code = $webcolor[strtolower($color)]; + if (isset($webcolor[$color])) { + $color_code = $webcolor[$color]; } else { - return $returncolor; + return false; } } else { $color_code = substr($color, 1); @@ -5814,13 +7920,14 @@ if (!class_exists('TCPDF', false)) { } /** - * Converts pixels to Units. + * Converts pixels to User's Units. * @param int $px pixels - * @return float millimeters + * @return float value in user's unit * @access public + * @see setImageScale(), getImageScale() */ public function pixelsToUnits($px) { - return $px / $this->k; + return ($px / ($this->imgscale * $this->k)); } /** @@ -5828,24 +7935,28 @@ if (!class_exists('TCPDF', false)) { * Convert entities in UTF-8. * @param $text_to_convert Text to convert. * @return string converted - */ + * @access public + */ public function unhtmlentities($text_to_convert) { return html_entity_decode($text_to_convert, ENT_QUOTES, $this->encoding); } // ENCRYPTION METHODS ---------------------------------- // SINCE 2.0.000 (2008-01-02) + /** * Compute encryption key depending on object number where the encrypted data is stored * @param int $n object number + * @access protected * @since 2.0.000 (2008-01-02) */ protected function _objectkey($n) { - return substr($this->_md5_16($this->encryption_key.pack('VXxx',$n)),0,10); + return substr($this->_md5_16($this->encryption_key.pack('VXxx', $n)), 0, 10); } /** * Put encryption on PDF document. + * @access protected * @since 2.0.000 (2008-01-02) */ protected function _putencryption() { @@ -5863,15 +7974,16 @@ if (!class_exists('TCPDF', false)) { * @param string $key encryption key * @param String $text input text to be encrypted * @return String encrypted text + * @access protected * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ protected function _RC4($key, $text) { if ($this->last_rc4_key != $key) { - $k = str_repeat($key, 256/strlen($key)+1); - $rc4 = range(0,255); + $k = str_repeat($key, ((256 / strlen($key)) + 1)); + $rc4 = range(0, 255); $j = 0; - for ($i=0; $i < 256; $i++) { + for ($i = 0; $i < 256; ++$i) { $t = $rc4[$i]; $j = ($j + $t + ord($k{$i})) % 256; $rc4[$i] = $rc4[$j]; @@ -5886,7 +7998,7 @@ if (!class_exists('TCPDF', false)) { $a = 0; $b = 0; $out = ''; - for ($i=0; $i < $len; $i++) { + for ($i = 0; $i < $len; ++$i) { $a = ($a + 1) % 256; $t = $rc4[$a]; $b = ($b + $t) % 256; @@ -5902,11 +8014,12 @@ if (!class_exists('TCPDF', false)) { * Encrypts a string using MD5 and returns it's value as a binary string. * @param string $str input string * @return String MD5 encrypted binary string + * @access protected * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ protected function _md5_16($str) { - return pack('H*',md5($str)); + return pack('H*', md5($str)); } /** @@ -5914,18 +8027,20 @@ if (!class_exists('TCPDF', false)) { * @param String $user_pass user password * @param String $owner_pass user password * @return String O value + * @access protected * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ protected function _Ovalue($user_pass, $owner_pass) { $tmp = $this->_md5_16($owner_pass); - $owner_RC4_key = substr($tmp,0,5); + $owner_RC4_key = substr($tmp, 0, 5); return $this->_RC4($owner_RC4_key, $user_pass); } /** * Compute U value (used for RC4 encryption) * @return String U value + * @access protected * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ @@ -5938,22 +8053,23 @@ if (!class_exists('TCPDF', false)) { * @param String $user_pass user password * @param String $owner_pass user password * @param String $protection protection type + * @access protected * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ protected function _generateencryptionkey($user_pass, $owner_pass, $protection) { // Pad passwords - $user_pass = substr($user_pass.$this->padding,0,32); - $owner_pass = substr($owner_pass.$this->padding,0,32); + $user_pass = substr($user_pass.$this->padding, 0, 32); + $owner_pass = substr($owner_pass.$this->padding, 0, 32); // Compute O value $this->Ovalue = $this->_Ovalue($user_pass, $owner_pass); // Compute encyption key $tmp = $this->_md5_16($user_pass.$this->Ovalue.chr($protection)."\xFF\xFF\xFF"); - $this->encryption_key = substr($tmp,0,5); + $this->encryption_key = substr($tmp, 0, 5); // Compute U value $this->Uvalue = $this->_Uvalue(); // Compute P value - $this->Pvalue = -(($protection^255)+1); + $this->Pvalue = -(($protection^255) + 1); } /** @@ -5969,6 +8085,7 @@ if (!class_exists('TCPDF', false)) { * @param Array $permissions the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms) * @param String $user_pass user password. Empty by default. * @param String $owner_pass owner password. If not specified, a random value is used. + * @access public * @since 2.0.000 (2008-01-02) * @author Klemen Vodopivec */ @@ -5991,37 +8108,44 @@ if (!class_exists('TCPDF', false)) { // END OF ENCRYPTION FUNCTIONS ------------------------- // START TRANSFORMATIONS SECTION ----------------------- - // authors: Moritz Wagner, Andreas Wurmser, Nicola Asuni /** * 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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ public function StartTransform() { $this->_out('q'); + $this->transfmrk[$this->page][] = $this->pagelen[$this->page]; + ++$this->transfmatrix_key; + $this->transfmatrix[$this->transfmatrix_key] = array(); } /** * 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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ public function StopTransform() { $this->_out('Q'); - if (isset($this->transfmatrix)) { - array_pop($this->transfmatrix); + if (isset($this->transfmatrix[$this->transfmatrix_key])) { + array_pop($this->transfmatrix[$this->transfmatrix_key]); + --$this->transfmatrix_key; } + array_pop($this->transfmrk[$this->page]); } /** * 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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6034,6 +8158,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6046,6 +8171,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6059,6 +8185,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6093,6 +8220,7 @@ if (!class_exists('TCPDF', false)) { /** * Horizontal Mirroring. * @param int $x abscissa of the point. Default is current x position + * @access public * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6103,6 +8231,7 @@ if (!class_exists('TCPDF', false)) { /** * Verical Mirroring. * @param int $y ordinate of the point. Default is current y position + * @access public * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6114,6 +8243,7 @@ if (!class_exists('TCPDF', false)) { * 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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6126,6 +8256,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6137,6 +8268,7 @@ if (!class_exists('TCPDF', false)) { /** * Translate graphic object horizontally. * @param int $t_x movement to the right (or left for RTL) + * @access public * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6147,6 +8279,7 @@ if (!class_exists('TCPDF', false)) { /** * Translate graphic object vertically. * @param int $t_y movement to the bottom + * @access public * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6158,6 +8291,7 @@ if (!class_exists('TCPDF', false)) { * Translate graphic object horizontally and vertically. * @param int $t_x movement to the right * @param int $t_y movement to the bottom + * @access public * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6181,6 +8315,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6213,6 +8348,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6225,6 +8361,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6238,6 +8375,7 @@ if (!class_exists('TCPDF', false)) { * @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 * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ @@ -6270,13 +8408,19 @@ if (!class_exists('TCPDF', false)) { /** * Apply graphic transformations. + * @access protected * @since 2.1.000 (2008-01-07) * @see StartTransform(), StopTransform() */ protected function Transform($tm) { - $this->_out(sprintf('%.3f %.3f %.3f %.3f %.3f %.3f cm', $tm[0], $tm[1], $tm[2], $tm[3], $tm[4], $tm[5])); - // store transformation matrix - $this->transfmatrix[] = array('a' => $tm[0], 'b' => $tm[1], 'c' => $tm[2], 'd' => $tm[3], 'e' => $tm[4], 'f' => $tm[5]); + $this->_out(sprintf('%.3F %.3F %.3F %.3F %.3F %.3F cm', $tm[0], $tm[1], $tm[2], $tm[3], $tm[4], $tm[5])); + // add tranformation matrix + $this->transfmatrix[$this->transfmatrix_key][] = array('a' => $tm[0], 'b' => $tm[1], 'c' => $tm[2], 'd' => $tm[3], 'e' => $tm[4], 'f' => $tm[5]); + // update tranformation mark + if (end($this->transfmrk[$this->page]) !== false) { + $key = key($this->transfmrk[$this->page]); + $this->transfmrk[$this->page][$key] = $this->pagelen[$this->page]; + } } // END TRANSFORMATIONS SECTION ------------------------- @@ -6288,19 +8432,23 @@ if (!class_exists('TCPDF', false)) { /** * 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 * @since 1.0 * @see Line(), Rect(), Cell(), MultiCell() */ public function SetLineWidth($width) { //Set line width $this->LineWidth = $width; - $this->linestyleWidth = sprintf('%.2f w', ($width * $this->k)); - $this->_out($this->linestyleWidth); + $this->linestyleWidth = sprintf('%.2F w', ($width * $this->k)); + if ($this->page > 0) { + $this->_out($this->linestyleWidth); + } } /** * Returns the current the line width. * @return int Line width + * @access public * @since 2.1.000 (2008-01-07) * @see Line(), SetLineWidth() */ @@ -6330,6 +8478,9 @@ if (!class_exists('TCPDF', false)) { * @since 2.1.000 (2008-01-08) */ public function SetLineStyle($style) { + if (!is_array($style)) { + return; + } extract($style); if (isset($width)) { $width_prev = $this->LineWidth; @@ -6353,7 +8504,7 @@ if (!class_exists('TCPDF', false)) { if (isset($dash)) { $dash_string = ''; if ($dash) { - if (ereg('^.+,', $dash)) { + if (preg_match('/^.+,/', $dash) > 0) { $tab = explode(',', $dash); } else { $tab = array($dash); @@ -6363,13 +8514,13 @@ if (!class_exists('TCPDF', false)) { if ($i) { $dash_string .= ' '; } - $dash_string .= sprintf("%.2f", $v); + $dash_string .= sprintf('%.2F', $v); } } if (!isset($phase) OR !$dash) { $phase = 0; } - $this->linestyleDash = sprintf("[%s] %.2f d", $dash_string, $phase); + $this->linestyleDash = sprintf('[%s] %.2F d', $dash_string, $phase); $this->_out($this->linestyleDash); } if (isset($color)) { @@ -6377,7 +8528,7 @@ if (!class_exists('TCPDF', false)) { } } - /* + /** * Set a draw point. * @param float $x Abscissa of point. * @param float $y Ordinate of point. @@ -6388,10 +8539,10 @@ if (!class_exists('TCPDF', false)) { if ($this->rtl) { $x = $this->w - $x; } - $this->_out(sprintf("%.2f %.2f m", $x * $this->k, ($this->h - $y) * $this->k)); + $this->_out(sprintf('%.2F %.2F m', $x * $this->k, ($this->h - $y) * $this->k)); } - /* + /** * Draws a line from last draw point. * @param float $x Abscissa of end point. * @param float $y Ordinate of end point. @@ -6402,7 +8553,7 @@ if (!class_exists('TCPDF', false)) { if ($this->rtl) { $x = $this->w - $x; } - $this->_out(sprintf("%.2f %.2f l", $x * $this->k, ($this->h - $y) * $this->k)); + $this->_out(sprintf('%.2F %.2F l', $x * $this->k, ($this->h - $y) * $this->k)); } /** @@ -6419,10 +8570,10 @@ if (!class_exists('TCPDF', false)) { if ($this->rtl) { $x = $this->w - $x - $w; } - $this->_out(sprintf('%.2f %.2f %.2f %.2f re %s', $x*$this->k, ($this->h-$y)*$this->k, $w*$this->k, -$h*$this->k, $op)); + $this->_out(sprintf('%.2F %.2F %.2F %.2F re %s', $x * $this->k, ($this->h - $y) * $this->k, $w * $this->k, -$h * $this->k, $op)); } - /* + /** * Draws a Bezier curve from last draw point. * The Bezier curve is a tangent to the line between the control points at either end of the curve. * @param float $x1 Abscissa of control point 1. @@ -6440,7 +8591,7 @@ if (!class_exists('TCPDF', false)) { $x2 = $this->w - $x2; $x3 = $this->w - $x3; } - $this->_out(sprintf("%.2f %.2f %.2f %.2f %.2f %.2f c", $x1 * $this->k, ($this->h - $y1) * $this->k, $x2 * $this->k, ($this->h - $y2) * $this->k, $x3 * $this->k, ($this->h - $y3) * $this->k)); + $this->_out(sprintf('%.2F %.2F %.2F %.2F %.2F %.2F c', $x1 * $this->k, ($this->h - $y1) * $this->k, $x2 * $this->k, ($this->h - $y2) * $this->k, $x3 * $this->k, ($this->h - $y3) * $this->k)); } /** @@ -6455,7 +8606,7 @@ if (!class_exists('TCPDF', false)) { * @see SetLineWidth(), SetDrawColor(), SetLineStyle() */ public function Line($x1, $y1, $x2, $y2, $style=array()) { - if ($style) { + if (is_array($style)) { $this->SetLineStyle($style); } $this->_outPoint($x1, $y1); @@ -6516,10 +8667,12 @@ if (!class_exists('TCPDF', false)) { } case 'CNZ': { $op = 'W n'; + $this->_outRect($x, $y, $w, $h, $op); break; } case 'CEO': { $op = 'W* n'; + $this->_outRect($x, $y, $w, $h, $op); break; } default: { @@ -6537,8 +8690,8 @@ if (!class_exists('TCPDF', false)) { if ($border_style) { $border_style2 = array(); foreach ($border_style as $line => $value) { - $lenght = strlen($line); - for ($i = 0; $i < $lenght; $i++) { + $length = strlen($line); + for ($i = 0; $i < $length; ++$i) { $border_style2[$line[$i]] = $value; } } @@ -6770,7 +8923,7 @@ if (!class_exists('TCPDF', false)) { $c0 = -$rx * sin($t1); $d0 = $ry * cos($t1); $this->_outPoint($a0 / $this->k, $this->h - ($b0 / $this->k)); - for ($i = 1; $i <= $nc; $i++) { + for ($i = 1; $i <= $nc; ++$i) { // Draw this bit of the total curve $t1 = ($i * $dt) + $astart; $a1 = $x0 + ($rx * cos($t1)); @@ -6813,7 +8966,33 @@ if (!class_exists('TCPDF', false)) { public function Circle($x0, $y0, $r, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=8) { $this->Ellipse($x0, $y0, $r, 0, 0, $astart, $afinish, $style, $line_style, $fill_color, $nc); } - + + /** + * 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. Possible values are: + *
      + *
    • D or empty string: Draw (default).
      • + *
    • F: Fill.
      • + *
    • DF or FD: Draw and fill.
      • + *
    • 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 $line_style 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}.
      • + *
    + * 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 + * @since 4.8.003 (2009-09-15) + */ + public function PolyLine($p, $style='', $line_style=array(), $fill_color=array()) { + $this->Polygon($p, $style, $line_style, $fill_color, false); + } + /** * Draws a polygon. * @param array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) @@ -6832,11 +9011,24 @@ if (!class_exists('TCPDF', false)) { * * 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 * @since 2.1.000 (2008-01-08) */ - public function Polygon($p, $style='', $line_style=array(), $fill_color=array()) { - $np = count($p) / 2; + public function Polygon($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) { + $nc = count($p); // number of coordinates + $np = $nc / 2; // number of points + if ($closed) { + // close polygon by adding the first 2 points at the end (one line) + for ($i = 0; $i < 4; ++$i) { + $p[$nc + $i] = $p[$i]; + } + // copy style for the last added line + if (isset($line_style[0])) { + $line_style[$np] = $line_style[0]; + } + $nc += 4; + } if (!(false === strpos($style, 'F')) AND isset($fill_color)) { $this->SetFillColorArray($fill_color); } @@ -6868,32 +9060,46 @@ if (!class_exists('TCPDF', false)) { if ($line_style) { if (isset($line_style['all'])) { $this->SetLineStyle($line_style['all']); - } else { // 0 .. (np - 1), op = {B, S} + } else { $draw = false; - if ('B' == $op) { + if ($op == 'B') { + // draw fill $op = 'f'; $this->_outPoint($p[0], $p[1]); - for ($i = 2; $i < ($np * 2); $i = $i + 2) { + for ($i = 2; $i < $nc; $i = $i + 2) { $this->_outLine($p[$i], $p[$i + 1]); } - $this->_outLine($p[0], $p[1]); $this->_out($op); } - $p[($np * 2)] = $p[0]; - $p[(($np * 2) + 1)] = $p[1]; - for ($i = 0; $i < $np; $i++) { - if (isset($line_style[$i]) AND ($line_style[$i] != 0)) { - $this->Line($p[($i * 2)], $p[(($i * 2) + 1)], $p[(($i * 2) + 2)], $p[(($i * 2) + 3)], $line_style[$i]); + // draw outline + $this->_outPoint($p[0], $p[1]); + for ($i = 2; $i < $nc; $i = $i + 2) { + $line_num = ($i / 2) - 1; + if (isset($line_style[$line_num])) { + if ($line_style[$line_num] != 0) { + if (is_array($line_style[$line_num])) { + $this->_out('S'); + $this->SetLineStyle($line_style[$line_num]); + $this->_outPoint($p[$i - 2], $p[$i - 1]); + $this->_outLine($p[$i], $p[$i + 1]); + $this->_out('S'); + $this->_outPoint($p[$i], $p[$i + 1]); + } else { + $this->_outLine($p[$i], $p[$i + 1]); + } + } + } else { + $this->_outLine($p[$i], $p[$i + 1]); } } + $this->_out($op); } } if ($draw) { $this->_outPoint($p[0], $p[1]); - for ($i = 2; $i < ($np * 2); $i = $i + 2) { + for ($i = 2; $i < $nc; $i = $i + 2) { $this->_outLine($p[$i], $p[$i + 1]); } - $this->_outLine($p[0], $p[1]); $this->_out($op); } } @@ -6942,7 +9148,7 @@ if (!class_exists('TCPDF', false)) { $this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color); } $p = array(); - for ($i = 0; $i < $ns; $i++) { + for ($i = 0; $i < $ns; ++$i) { $a = $angle + ($i * 360 / $ns); $a_rad = deg2rad((float) $a); $p[] = $x0 + ($r * sin($a_rad)); @@ -6990,7 +9196,7 @@ if (!class_exists('TCPDF', false)) { * @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()) { - if (2 > $nv) { + if ($nv < 2) { $nv = 2; } if ($draw_circle) { @@ -6998,7 +9204,7 @@ if (!class_exists('TCPDF', false)) { } $p2 = array(); $visited = array(); - for ($i = 0; $i < $nv; $i++) { + for ($i = 0; $i < $nv; ++$i) { $a = $angle + ($i * 360 / $nv); $a_rad = deg2rad((float) $a); $p2[] = $x0 + ($r * sin($a_rad)); @@ -7111,6 +9317,65 @@ if (!class_exists('TCPDF', false)) { } } + /** + * Draws a grahic arrow. + * @parameter float $x0 Abscissa of first point. + * @parameter float $y0 Ordinate of first point. + * @parameter float $x0 Abscissa of second point. + * @parameter float $y1 Ordinate of second point. + * @parameter int $head_style (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead) + * @parameter float $arm_size length of arrowhead arms + * @parameter int $arm_angle angle between an arm and the shaft + * @author Piotr Galecki, Nicola Asuni, Andy Meier + * @since 4.6.018 (2009-07-10) + */ + public function Arrow($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) { + // getting arrow direction angle + // 0 deg angle is when both arms go along X axis. angle grows clockwise. + $dir_angle = rad2deg(atan2(($y0 - $y1), ($x0 - $x1))); + $sx1 = $x1; + $sy1 = $y1; + if ($head_style > 0) { + // calculate the stopping point for the arrow shaft + $sx1 = $x1 + (($arm_size - $this->LineWidth) * cos(deg2rad($dir_angle))); + $sy1 = $y1 + (($arm_size - $this->LineWidth) * sin(deg2rad($dir_angle))); + } + // main arrow line / shaft + $this->Line($x0, $y0, $sx1, $sy1); + // left arrowhead arm tip + $x2L = $x1 + ($arm_size * cos(deg2rad($dir_angle + $arm_angle))); + $y2L = $y1 + ($arm_size * sin(deg2rad($dir_angle + $arm_angle))); + // right arrowhead arm tip + $x2R = $x1 + ($arm_size * cos(deg2rad($dir_angle - $arm_angle))); + $y2R = $y1 + ($arm_size * sin(deg2rad($dir_angle - $arm_angle))); + $mode = 'D'; + $style = array(); + switch ($head_style) { + case 0: { + // draw only arrowhead arms + $mode = 'D'; + $style = array(1, 1, 0); + break; + } + case 1: { + // draw closed arrowhead, but no fill + $mode = 'D'; + break; + } + case 2: { + // closed and filled arrowhead + $mode = 'DF'; + break; + } + case 3: { + // filled arrowhead + $mode = 'F'; + break; + } + } + $this->Polygon(array($x2L, $y2L, $x1, $y1, $x2R, $y2R), $mode, $style, array()); + } + // END GRAPHIC FUNCTIONS SECTION ----------------------- // BIDIRECTIONAL TEXT SECTION -------------------------- @@ -7119,29 +9384,34 @@ if (!class_exists('TCPDF', false)) { * @param string $str string to manipulate. * @param bool $forcertl if 'R' forces RTL, if 'L' forces LTR * @return string + * @access protected * @author Nicola Asuni * @since 2.1.000 (2008-01-08) */ protected function utf8StrRev($str, $setbom=false, $forcertl=false) { - return $this->arrUTF8ToUTF16BE($this->utf8Bidi($this->UTF8StringToArray($str), $forcertl), $setbom); + return $this->arrUTF8ToUTF16BE($this->utf8Bidi($this->UTF8StringToArray($str), $str, $forcertl), $setbom); } /** * 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 * @return string * @author Nicola Asuni + * @access protected * @since 2.4.000 (2008-03-06) */ - protected function utf8Bidi($ta, $forcertl=false) { + protected function utf8Bidi($ta, $str='', $forcertl=false) { global $unicode, $unicode_mirror, $unicode_arlet, $laa_array, $diacritics; // paragraph embedding level $pel = 0; // max level $maxlevel = 0; - // create string from array - $str = $this->UTF8ArrSubString($ta); + if ($this->empty_string($str)) { + // create string from array + $str = $this->UTF8ArrSubString($ta); + } // check if string contains arabic text if (preg_match(K_RE_PATTERN_ARABIC, $str)) { $arabic = true; @@ -7157,13 +9427,13 @@ if (!class_exists('TCPDF', false)) { $numchars = count($ta); if ($forcertl == 'R') { - $pel = 1; + $pel = 1; } elseif ($forcertl == 'L') { - $pel = 0; + $pel = 0; } else { // P2. In each paragraph, find the first character of type L, AL, or R. // P3. If a character is found in P2 and it is of type AL or R, then set the paragraph embedding level to one; otherwise, set it to zero. - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { $type = $unicode[$ta[$i]]; if ($type == 'L') { $pel = 0; @@ -7184,15 +9454,12 @@ if (!class_exists('TCPDF', false)) { $sor = $pel % 2 ? 'R' : 'L'; $eor = $sor; - //$levels = array(array('level' => $cel, 'sor' => $sor, 'eor' => '', 'chars' => array())); - //$current_level = &$levels[count( $levels )-1]; - // Array of characters data $chardata = Array(); // X1. Begin by setting the current embedding level to the paragraph embedding level. Set the directional override status to neutral. Process each character iteratively, applying rules X2 through X9. Only embedding levels from 0 to 61 are valid in this phase. // In the resolution of levels in rules I1 and I2, the maximum embedding level of 62 can be reached. - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($ta[$i] == K_RLE) { // X2. With each RLE, compute the least greater odd embedding level. // a. If this new level would be valid, then this embedding code is valid. Remember (push) the current embedding level and override status. Reset the current level to this new level, and reset the override status to neutral. @@ -7267,7 +9534,11 @@ if (!class_exists('TCPDF', false)) { if ($dos != 'N') { $chardir = $dos; } else { - $chardir = $unicode[$ta[$i]]; + if (isset($unicode[$ta[$i]])) { + $chardir = $unicode[$ta[$i]]; + } else { + $chardir = 'L'; + } } // stores string characters and other information $chardata[] = array('char' => $ta[$i], 'level' => $cel, 'type' => $chardir, 'sor' => $sor, 'eor' => $eor); @@ -7286,7 +9557,7 @@ if (!class_exists('TCPDF', false)) { // W1. Examine each nonspacing mark (NSM) in the level run, and change the type of the NSM to the type of the previous character. If the NSM is at the start of the level run, it will get the type of sor. $prevlevel = -1; // track level changes $levcount = 0; // counts consecutive chars at the same level - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['type'] == 'NSM') { if ($levcount) { $chardata[$i]['type'] = $chardata[$i]['sor']; @@ -7297,7 +9568,7 @@ if (!class_exists('TCPDF', false)) { if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } @@ -7305,7 +9576,7 @@ if (!class_exists('TCPDF', false)) { // W2. Search backward from each instance of a European number until the first strong type (R, L, AL, or sor) is found. If an AL is found, change the type of the European number to Arabic number. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['char'] == 'EN') { for ($j=$levcount; $j >= 0; $j--) { if ($chardata[$j]['type'] == 'AL') { @@ -7318,13 +9589,13 @@ if (!class_exists('TCPDF', false)) { if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } // W3. Change all ALs to R. - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['type'] == 'AL') { $chardata[$i]['type'] = 'R'; } @@ -7333,7 +9604,7 @@ if (!class_exists('TCPDF', false)) { // W4. A single European separator between two European numbers changes to a European number. A single common separator between two numbers of the same type changes to that type. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if (($levcount > 0) AND (($i+1) < $numchars) AND ($chardata[($i+1)]['level'] == $prevlevel)) { if (($chardata[$i]['type'] == 'ES') AND ($chardata[($i-1)]['type'] == 'EN') AND ($chardata[($i+1)]['type'] == 'EN')) { $chardata[$i]['type'] = 'EN'; @@ -7346,7 +9617,7 @@ if (!class_exists('TCPDF', false)) { if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } @@ -7354,7 +9625,7 @@ if (!class_exists('TCPDF', false)) { // W5. A sequence of European terminators adjacent to European numbers changes to all European numbers. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['type'] == 'ET') { if (($levcount > 0) AND ($chardata[($i-1)]['type'] == 'EN')) { $chardata[$i]['type'] = 'EN'; @@ -7367,14 +9638,14 @@ if (!class_exists('TCPDF', false)) { } elseif ($chardata[$j]['type'] != 'ET') { break; } - $j++; + ++$j; } } } if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } @@ -7382,14 +9653,14 @@ if (!class_exists('TCPDF', false)) { // W6. Otherwise, separators and terminators change to Other Neutral. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if (($chardata[$i]['type'] == 'ET') OR ($chardata[$i]['type'] == 'ES') OR ($chardata[$i]['type'] == 'CS')) { $chardata[$i]['type'] = 'ON'; } if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } @@ -7397,7 +9668,7 @@ if (!class_exists('TCPDF', false)) { //W7. Search backward from each instance of a European number until the first strong type (R, L, or sor) is found. If an L is found, then change the type of the European number to L. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['char'] == 'EN') { for ($j=$levcount; $j >= 0; $j--) { if ($chardata[$j]['type'] == 'L') { @@ -7410,7 +9681,7 @@ if (!class_exists('TCPDF', false)) { if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } @@ -7418,7 +9689,7 @@ if (!class_exists('TCPDF', false)) { // N1. A sequence of neutrals takes the direction of the surrounding strong text if the text on both sides has the same direction. European and Arabic numbers act as if they were R in terms of their influence on neutrals. Start-of-level-run (sor) and end-of-level-run (eor) are used at level run boundaries. $prevlevel = -1; $levcount = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if (($levcount > 0) AND (($i+1) < $numchars) AND ($chardata[($i+1)]['level'] == $prevlevel)) { if (($chardata[$i]['type'] == 'N') AND ($chardata[($i-1)]['type'] == 'L') AND ($chardata[($i+1)]['type'] == 'L')) { $chardata[$i]['type'] = 'L'; @@ -7461,14 +9732,14 @@ if (!class_exists('TCPDF', false)) { if ($chardata[$i]['level'] != $prevlevel) { $levcount = 0; } else { - $levcount++; + ++$levcount; } $prevlevel = $chardata[$i]['level']; } // I1. For all characters with an even (left-to-right) embedding direction, those of type R go up one level and those of type AN or EN go up two levels. // I2. For all characters with an odd (right-to-left) embedding direction, those of type L, EN or AN go up one level. - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { $odd = $chardata[$i]['level'] % 2; if ($odd) { if (($chardata[$i]['type'] == 'L') OR ($chardata[$i]['type'] == 'AN') OR ($chardata[$i]['type'] == 'EN')) { @@ -7489,7 +9760,7 @@ if (!class_exists('TCPDF', false)) { // 2. Paragraph separators, // 3. Any sequence of whitespace characters preceding a segment separator or paragraph separator, and // 4. Any sequence of white space characters at the end of the line. - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if (($chardata[$i]['type'] == 'B') OR ($chardata[$i]['type'] == 'S')) { $chardata[$i]['level'] = $pel; } elseif ($chardata[$i]['type'] == 'WS') { @@ -7502,7 +9773,7 @@ if (!class_exists('TCPDF', false)) { } elseif ($chardata[$j]['type'] != 'WS') { break; } - $j++; + ++$j; } } } @@ -7516,16 +9787,16 @@ if (!class_exists('TCPDF', false)) { $laaletter = false; $charAL = array(); $x = 0; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if (($unicode[$chardata[$i]['char']] == 'AL') OR ($chardata[$i]['char'] == 32) OR ($chardata[$i]['char'] == 8204)) { $charAL[$x] = $chardata[$i]; $charAL[$x]['i'] = $i; $chardata[$i]['x'] = $x; - $x++; + ++$x; } } $numAL = $x; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { $thischar = $chardata[$i]; if ($i > 0) { $prevchar = $chardata[($i-1)]; @@ -7629,7 +9900,7 @@ if (!class_exists('TCPDF', false)) { * Putting the combining mark and shadda in the same glyph allows us to avoid the two marks overlapping each other in an illegible manner. */ $cw = &$this->CurrentFont['cw']; - for ($i=0; $i < ($numchars-1); $i++) { + for ($i = 0; $i < ($numchars-1); ++$i) { if (($chardata2[$i]['char'] == 1617) AND (isset($diacritics[($chardata2[$i+1]['char'])]))) { // check if the subtitution font is defined on current font if (isset($cw[($diacritics[($chardata2[$i+1]['char'])])])) { @@ -7657,7 +9928,7 @@ if (!class_exists('TCPDF', false)) { $ordarray = Array(); $revarr = Array(); $onlevel = false; - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { if ($chardata[$i]['level'] >= $j) { $onlevel = true; if (isset($unicode_mirror[$chardata[$i]['char']])) { @@ -7683,7 +9954,7 @@ if (!class_exists('TCPDF', false)) { } $ordarray = array(); - for ($i=0; $i < $numchars; $i++) { + for ($i=0; $i < $numchars; ++$i) { $ordarray[] = $chardata[$i]['char']; } @@ -7692,16 +9963,17 @@ if (!class_exists('TCPDF', false)) { // END OF BIDIRECTIONAL TEXT SECTION ------------------- - /* + /** * Adds a bookmark. * @param string $txt bookmark description. * @param int $level bookmark level (minimum value is 0). * @param float $y Ordinate of the boorkmark position (default = -1 = current position). + * @param int $page target page number (leave empty for current page). * @access public * @author Olivier Plathey, Nicola Asuni * @since 2.1.002 (2008-02-12) */ - public function Bookmark($txt, $level=0, $y=-1) { + public function Bookmark($txt, $level=0, $y=-1, $page='') { if ($level < 0) { $level = 0; } @@ -7717,10 +9989,13 @@ if (!class_exists('TCPDF', false)) { if ($y == -1) { $y = $this->GetY(); } - $this->outlines[] = array('t' => $txt, 'l' => $level, 'y' => $y, 'p' => $this->PageNo()); + if (empty($page)) { + $page = $this->PageNo(); + } + $this->outlines[] = array('t' => $txt, 'l' => $level, 'y' => $y, 'p' => $page); } - /* + /** * Create a bookmark PDF string. * @access protected * @author Olivier Plathey, Nicola Asuni @@ -7731,6 +10006,15 @@ if (!class_exists('TCPDF', false)) { if ($nb == 0) { return; } + // get sorting columns + $outline_p = array(); + $outline_y = array(); + foreach ($this->outlines as $key => $row) { + $outline_p[$key] = $row['p']; + $outline_k[$key] = $key; + } + // sort outlines by page and original position + array_multisort($outline_p, SORT_NUMERIC, SORT_ASC, $outline_k, SORT_NUMERIC, SORT_ASC, $this->outlines); $lru = array(); $level = 0; foreach ($this->outlines as $i => $o) { @@ -7769,59 +10053,106 @@ if (!class_exists('TCPDF', false)) { $this->_out('/First '.($n + $o['first']).' 0 R'); if (isset($o['last'])) $this->_out('/Last '.($n + $o['last']).' 0 R'); - $this->_out(sprintf('/Dest [%d 0 R /XYZ 0 %.2f null]', (1 + (2 * $o['p'])), ($this->pagedim[$o['p']]['h'] - ($o['y'] * $this->k)))); + $this->_out(sprintf('/Dest [%d 0 R /XYZ 0 %.2F null]', (1 + (2 * $o['p'])), ($this->pagedim[$o['p']]['h'] - ($o['y'] * $this->k)))); $this->_out('/Count 0>>'); $this->_out('endobj'); } //Outline root $this->_newobj(); - $this->OutlineRoot=$this->n; + $this->OutlineRoot = $this->n; $this->_out('<_out('/Last '.($n + $lru[0]).' 0 R>>'); $this->_out('endobj'); } + // --- JAVASCRIPT ------------------------------------------------------ - // --- JAVASCRIPT - FORMS ------------------------------ - - /* + /** * Adds a javascript + * @param string $script Javascript code * @access public - * @author Johannes Güntert, Nicola Asuni + * @author Johannes G�ntert, Nicola Asuni * @since 2.1.002 (2008-02-12) */ public function IncludeJS($script) { $this->javascript .= $script; } - - /* + + /** + * 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 + * @return int internal object ID + * @access public + * @author Nicola Asuni + * @since 4.8.000 (2009-09-07) + */ + public function addJavascriptObject($script, $onload=false) { + ++$this->js_obj_id; + $this->js_objects[$this->js_obj_id] = array('js' => $script, 'onload' => $onload); + return $this->js_obj_id; + } + + /** * Create a javascript PDF string. * @access protected - * @author Johannes Güntert, Nicola Asuni + * @author Johannes G�ntert, Nicola Asuni * @since 2.1.002 (2008-02-12) */ protected function _putjavascript() { - if (empty($this->javascript)) { + if (empty($this->javascript) AND empty($this->js_objects)) { return; } - // the following two lines are uded to avoid form fields duplication after saving - $js1 = sprintf("ftcpdfdocsaved=this.addField('%s','%s',%d,[%.2f,%.2f,%.2f,%.2f]);", 'tcpdfdocsaved', 'text', 0, 0, 1, 0, 1); - $js2 = "getField('tcpdfdocsaved').value = 'saved';"; - $this->_newobj(); - $this->n_js = $this->n; + if (strpos($this->javascript, 'this.addField') > 0) { + if (!$this->ur) { + //$this->setUserRights(); + } + // the following two lines are used to avoid form fields duplication after saving + // The addField method only works on Acrobat Writer, unless the document is signed with Adobe private key (UR3) + $jsa = sprintf("ftcpdfdocsaved=this.addField('%s','%s',%d,[%.2F,%.2F,%.2F,%.2F]);", 'tcpdfdocsaved', 'text', 0, 0, 1, 0, 1); + $jsb = "getField('tcpdfdocsaved').value='saved';"; + $this->javascript = $jsa."\n".$this->javascript."\n".$jsb; + } + $this->n_js = $this->_newobj(); $this->_out('<<'); - $this->_out('/Names [(EmbeddedJS) '.($this->n + 1).' 0 R ]'); - $this->_out('>>'); - $this->_out('endobj'); - $this->_newobj(); - $this->_out('<<'); - $this->_out('/S /JavaScript'); - $this->_out('/JS '.$this->_textstring($js1."\n".$this->javascript."\n".$js2)); + $this->_out('/Names ['); + if (!empty($this->javascript)) { + $this->_out('(EmbeddedJS) '.($this->n + 1).' 0 R'); + } + if (!empty($this->js_objects)) { + foreach ($this->js_objects as $key => $val) { + if ($val['onload']) { + $this->_out('(JS'.$key.') '.$key.' 0 R'); + } + } + } + $this->_out(']'); $this->_out('>>'); $this->_out('endobj'); + // default Javascript object + if (!empty($this->javascript)) { + $this->_newobj(); + $this->_out('<<'); + $this->_out('/S /JavaScript'); + $this->_out('/JS '.$this->_textstring($this->javascript)); + $this->_out('>>'); + $this->_out('endobj'); + } + // additional Javascript objects + if (!empty($this->js_objects)) { + foreach ($this->js_objects as $key => $val) { + $this->offsets[$key] = $this->bufferlen; + $this->_out($key.' 0 obj'); + $this->_out('<<'); + $this->_out('/S /JavaScript'); + $this->_out('/JS '.$this->_textstring($val['js'])); + $this->_out('>>'); + $this->_out('endobj'); + } + } } - /* + /** * Convert color to javascript color. * @param string $color color name or #RRGGBB * @access protected @@ -7831,7 +10162,7 @@ if (!class_exists('TCPDF', false)) { protected function _JScolor($color) { static $aColors = array('transparent', 'black', 'white', 'red', 'green', 'blue', 'cyan', 'magenta', 'yellow', 'dkGray', 'gray', 'ltGray'); if (substr($color,0,1) == '#') { - return sprintf("['RGB',%.3f,%.3f,%.3f]", hexdec(substr($color,1,2))/255, hexdec(substr($color,3,2))/255, hexdec(substr($color,5,2))/255); + return sprintf("['RGB',%.3F,%.3F,%.3F]", hexdec(substr($color,1,2))/255, hexdec(substr($color,3,2))/255, hexdec(substr($color,5,2))/255); } if (!in_array($color,$aColors)) { $this->Error('Invalid color: '.$color); @@ -7839,7 +10170,7 @@ if (!class_exists('TCPDF', false)) { return 'color.'.$color; } - /* + /** * Adds a javascript form field. * @param string $type field type * @param string $name field name @@ -7847,7 +10178,7 @@ if (!class_exists('TCPDF', false)) { * @param int $y vertical position * @param int $w width * @param int $h height - * @param array $prop array of properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference. * @access protected * @author Denis Van Nuffelen, Nicola Asuni * @since 2.1.002 (2008-02-12) @@ -7859,7 +10190,7 @@ if (!class_exists('TCPDF', false)) { // the followind avoid fields duplication after saving the document $this->javascript .= "if(getField('tcpdfdocsaved').value != 'saved') {"; $k = $this->k; - $this->javascript .= sprintf("f".$name."=this.addField('%s','%s',%d,[%.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 .= sprintf("f".$name."=this.addField('%s','%s',%d,[%.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"; while (list($key, $val) = each($prop)) { if (strcmp(substr($key, -5), 'Color') == 0) { @@ -7876,175 +10207,990 @@ if (!class_exists('TCPDF', false)) { } $this->javascript .= '}'; } - - /* - * Creates a text field - * @param string $name field name - * @param int $w width - * @param int $h height - * @param string $prop properties. The value property allows to set the initial value. The multiline property allows to define the field as multiline. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    - * @access public - * @author Denis Van Nuffelen, Nicola Asuni - * @since 2.1.002 (2008-02-12) + + // --- FORM FIELDS ----------------------------------------------------- + + /** + * 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. + * @return array of annotation properties + * @access protected + * @author Nicola Asuni + * @since 4.8.000 (2009-09-06) */ - public function TextField($name, $w, $h, $prop=array()) { - $this->_addfield('text', $name, $this->x, $this->y, $w, $h, $prop); + protected function getAnnotOptFromJSProp($prop) { + if (isset($prop['aopt']) AND is_array($prop['aopt'])) { + // the annotation options area lready defined + return $prop['aopt']; + } + $opt = array(); // value to be returned + // alignment: Controls how the text is laid out within the text field. + if (isset($prop['alignment'])) { + switch ($prop['alignment']) { + case 'left': { + $opt['q'] = 0; + break; + } + case 'center': { + $opt['q'] = 1; + break; + } + case 'right': { + $opt['q'] = 2; + break; + } + default: { + $opt['q'] = ($this->rtl)?2:0; + break; + } + } + } + // lineWidth: Specifies the thickness of the border when stroking the perimeter of a field's rectangle. + if (isset($prop['lineWidth'])) { + $linewidth = intval($prop['lineWidth']); + } else { + $linewidth = 1; + } + // borderStyle: The border style for a field. + if (isset($prop['borderStyle'])) { + switch ($prop['borderStyle']) { + case 'border.d': + case 'dashed': { + $opt['border'] = array(0, 0, $linewidth, array(3, 2)); + $opt['bs'] = array('w'=>$linewidth, 's'=>'D', 'd'=>array(3, 2)); + break; + } + case 'border.b': + case 'beveled': { + $opt['border'] = array(0, 0, $linewidth); + $opt['bs'] = array('w'=>$linewidth, 's'=>'B'); + break; + } + case 'border.i': + case 'inset': { + $opt['border'] = array(0, 0, $linewidth); + $opt['bs'] = array('w'=>$linewidth, 's'=>'I'); + break; + } + case 'border.u': + case 'underline': { + $opt['border'] = array(0, 0, $linewidth); + $opt['bs'] = array('w'=>$linewidth, 's'=>'U'); + break; + } + default: + case 'border.s': + case 'solid': { + $opt['border'] = array(0, 0, $linewidth); + $opt['bs'] = array('w'=>$linewidth, 's'=>'S'); + break; + } + } + } + if (isset($prop['border']) AND is_array($prop['border'])) { + $opt['border'] = $prop['border']; + } + if (!isset($opt['mk'])) { + $opt['mk'] = array(); + } + if (!isset($opt['mk']['if'])) { + $opt['mk']['if'] = array(); + } + $opt['mk']['if']['a'] = array(0.5, 0.5); + // buttonAlignX: Controls how space is distributed from the left of the button face with respect to the icon. + if (isset($prop['buttonAlignX'])) { + $opt['mk']['if']['a'][0] = $prop['buttonAlignX']; + } + // buttonAlignY: Controls how unused space is distributed from the bottom of the button face with respect to the icon. + if (isset($prop['buttonAlignY'])) { + $opt['mk']['if']['a'][1] = $prop['buttonAlignY']; + } + // buttonFitBounds: If true, the extent to which the icon may be scaled is set to the bounds of the button field. + if (isset($prop['buttonFitBounds']) AND ($prop['buttonFitBounds'] == 'true')) { + $opt['mk']['if']['fb'] = true; + } + // buttonScaleHow: Controls how the icon is scaled (if necessary) to fit inside the button face. + if (isset($prop['buttonScaleHow'])) { + switch ($prop['buttonScaleHow']) { + case 'scaleHow.proportional': { + $opt['mk']['if']['s'] = 'P'; + break; + } + case 'scaleHow.anamorphic': { + $opt['mk']['if']['s'] = 'A'; + break; + } + } + } + // buttonScaleWhen: Controls when an icon is scaled to fit inside the button face. + if (isset($prop['buttonScaleWhen'])) { + switch ($prop['buttonScaleWhen']) { + case 'scaleWhen.always': { + $opt['mk']['if']['sw'] = 'A'; + break; + } + case 'scaleWhen.never': { + $opt['mk']['if']['sw'] = 'N'; + break; + } + case 'scaleWhen.tooBig': { + $opt['mk']['if']['sw'] = 'B'; + break; + } + case 'scaleWhen.tooSmall': { + $opt['mk']['if']['sw'] = 'S'; + break; + } + } + } + // buttonPosition: Controls how the text and the icon of the button are positioned with respect to each other within the button face. + if (isset($prop['buttonPosition'])) { + switch ($prop['buttonPosition']) { + case 0: + case 'position.textOnly': { + $opt['mk']['tp'] = 0; + break; + } + case 1: + case 'position.iconOnly': { + $opt['mk']['tp'] = 1; + break; + } + case 2: + case 'position.iconTextV': { + $opt['mk']['tp'] = 2; + break; + } + case 3: + case 'position.textIconV': { + $opt['mk']['tp'] = 3; + break; + } + case 4: + case 'position.iconTextH': { + $opt['mk']['tp'] = 4; + break; + } + case 5: + case 'position.textIconH': { + $opt['mk']['tp'] = 5; + break; + } + case 6: + case 'position.overlay': { + $opt['mk']['tp'] = 6; + break; + } + } + } + // fillColor: Specifies the background color for a field. + if (isset($prop['fillColor'])) { + if (is_array($prop['fillColor'])) { + $opt['mk']['bg'] = $prop['fillColor']; + } else { + $opt['mk']['bg'] = $this->convertHTMLColorToDec($prop['fillColor']); + } + } + // strokeColor: Specifies the stroke color for a field that is used to stroke the rectangle of the field with a line as large as the line width. + if (isset($prop['strokeColor'])) { + if (is_array($prop['strokeColor'])) { + $opt['mk']['bc'] = $prop['strokeColor']; + } else { + $opt['mk']['bc'] = $this->convertHTMLColorToDec($prop['strokeColor']); + } + } + // rotation: The rotation of a widget in counterclockwise increments. + if (isset($prop['rotation'])) { + $opt['mk']['r'] = $prop['rotation']; + } + // charLimit: Limits the number of characters that a user can type into a text field. + if (isset($prop['charLimit'])) { + $opt['maxlen'] = intval($prop['charLimit']); + } + if (!isset($ff)) { + $ff = 0; + } + // readonly: The read-only characteristic of a field. If a field is read-only, the user can see the field but cannot change it. + if (isset($prop['readonly']) AND ($prop['readonly'] == 'true')) { + $ff += 1 << 0; + } + // required: Specifies whether a field requires a value. + if (isset($prop['required']) AND ($prop['required'] == 'true')) { + $ff += 1 << 1; + } + // multiline: Controls how text is wrapped within the field. + if (isset($prop['multiline']) AND ($prop['multiline'] == 'true')) { + $ff += 1 << 12; + } + // password: Specifies whether the field should display asterisks when data is entered in the field. + if (isset($prop['password']) AND ($prop['password'] == 'true')) { + $ff += 1 << 13; + } + // NoToggleToOff: If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. + if (isset($prop['NoToggleToOff']) AND ($prop['NoToggleToOff'] == 'true')) { + $ff += 1 << 14; + } + // Radio: If set, the field is a set of radio buttons. + if (isset($prop['Radio']) AND ($prop['Radio'] == 'true')) { + $ff += 1 << 15; + } + // Pushbutton: If set, the field is a pushbutton that does not retain a permanent value. + if (isset($prop['Pushbutton']) AND ($prop['Pushbutton'] == 'true')) { + $ff += 1 << 16; + } + // Combo: If set, the field is a combo box; if clear, the field is a list box. + if (isset($prop['Combo']) AND ($prop['Combo'] == 'true')) { + $ff += 1 << 17; + } + // editable: Controls whether a combo box is editable. + if (isset($prop['editable']) AND ($prop['editable'] == 'true')) { + $ff += 1 << 18; + } + // Sort: If set, the field's option items shall be sorted alphabetically. + if (isset($prop['Sort']) AND ($prop['Sort'] == 'true')) { + $ff += 1 << 19; + } + // fileSelect: If true, sets the file-select flag in the Options tab of the text field (Field is Used for File Selection). + if (isset($prop['fileSelect']) AND ($prop['fileSelect'] == 'true')) { + $ff += 1 << 20; + } + // multipleSelection: If true, indicates that a list box allows a multiple selection of items. + if (isset($prop['multipleSelection']) AND ($prop['multipleSelection'] == 'true')) { + $ff += 1 << 21; + } + // doNotSpellCheck: If true, spell checking is not performed on this editable text field. + if (isset($prop['doNotSpellCheck']) AND ($prop['doNotSpellCheck'] == 'true')) { + $ff += 1 << 22; + } + // doNotScroll: If true, the text field does not scroll and the user, therefore, is limited by the rectangular region designed for the field. + if (isset($prop['doNotScroll']) AND ($prop['doNotScroll'] == 'true')) { + $ff += 1 << 23; + } + // comb: If set to true, the field background is drawn as series of boxes (one for each character in the value of the field) and each character of the content is drawn within those boxes. The number of boxes drawn is determined from the charLimit property. It applies only to text fields. The setter will also raise if any of the following field properties are also set multiline, password, and fileSelect. A side-effect of setting this property is that the doNotScroll property is also set. + if (isset($prop['comb']) AND ($prop['comb'] == 'true')) { + $ff += 1 << 24; + } + // radiosInUnison: If false, even if a group of radio buttons have the same name and export value, they behave in a mutually exclusive fashion, like HTML radio buttons. + if (isset($prop['radiosInUnison']) AND ($prop['radiosInUnison'] == 'true')) { + $ff += 1 << 25; + } + // richText: If true, the field allows rich text formatting. + if (isset($prop['richText']) AND ($prop['richText'] == 'true')) { + $ff += 1 << 25; + } + // commitOnSelChange: Controls whether a field value is committed after a selection change. + if (isset($prop['commitOnSelChange']) AND ($prop['commitOnSelChange'] == 'true')) { + $ff += 1 << 26; + } + $opt['ff'] = $ff; + // defaultValue: The default value of a field - that is, the value that the field is set to when the form is reset. + if (isset($prop['defaultValue'])) { + $opt['dv'] = $prop['defaultValue']; + } + $f = 4; // default value for annotation flags + // readonly: The read-only characteristic of a field. If a field is read-only, the user can see the field but cannot change it. + if (isset($prop['readonly']) AND ($prop['readonly'] == 'true')) { + $f += 1 << 6; + } + // display: Controls whether the field is hidden or visible on screen and in print. + if (isset($prop['display'])) { + if ($prop['display'] == 'display.visible') { + // + } elseif ($prop['display'] == 'display.hidden') { + $f += 1 << 1; + } elseif ($prop['display'] == 'display.noPrint') { + $f -= 1 << 2; + } elseif ($prop['display'] == 'display.noView') { + $f += 1 << 5; + } + } + $opt['f'] = $f; + // currentValueIndices: Reads and writes single or multiple values of a list box or combo box. + if (isset($prop['currentValueIndices']) AND is_array($prop['currentValueIndices'])) { + $opt['i'] = $prop['currentValueIndices']; + } + // value: The value of the field data that the user has entered. + if (isset($prop['value'])) { + if (is_array($prop['value'])) { + $opt['opt'] = array(); + foreach ($prop['value'] AS $key => $optval) { + // exportValues: An array of strings representing the export values for the field. + if (isset($prop['exportValues'][$key])) { + $opt['opt'][$key] = array($prop['exportValues'][$key], $prop['value'][$key]); + } else { + $opt['opt'][$key] = $prop['value'][$key]; + } + } + } else { + $opt['v'] = $prop['value']; + } + } + // richValue: This property specifies the text contents and formatting of a rich text field. + if (isset($prop['richValue'])) { + $opt['rv'] = $prop['richValue']; + } + // submitName: If nonempty, used during form submission instead of name. Only applicable if submitting in HTML format (that is, URL-encoded). + if (isset($prop['submitName'])) { + $opt['tm'] = $prop['submitName']; + } + // name: Fully qualified field name. + if (isset($prop['name'])) { + $opt['t'] = $prop['name']; + } + // userName: The user name (short description string) of the field. + if (isset($prop['userName'])) { + $opt['tu'] = $prop['userName']; + } + // highlight: Defines how a button reacts when a user clicks it. + if (isset($prop['highlight'])) { + switch ($prop['highlight']) { + case 'none': + case 'highlight.n': { + $opt['h'] = 'N'; + break; + } + case 'invert': + case 'highlight.i': { + $opt['h'] = 'i'; + break; + } + case 'push': + case 'highlight.p': { + $opt['h'] = 'P'; + break; + } + case 'outline': + case 'highlight.o': { + $opt['h'] = 'O'; + break; + } + } + } + // Unsupported options: + // - calcOrderIndex: Changes the calculation order of fields in the document. + // - delay: Delays the redrawing of a field's appearance. + // - defaultStyle: This property defines the default style attributes for the form field. + // - style: Allows the user to set the glyph style of a check box or radio button. + // - textColor, textFont, textSize + return $opt; } - /* + /** + * 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 + * @author Nicola Asuni + * @since 4.8.000 (2009-09-06) + */ + public function setFormDefaultProp($prop=array()) { + $this->default_form_prop = $prop; + } + + /** + * 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 + * @author Nicola Asuni + * @since 4.8.000 (2009-09-06) + */ + public function getFormDefaultProp() { + return $this->default_form_prop; + } + + /** + * 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 + * @author Nicola Asuni + * @since 4.8.000 (2009-09-07) + */ + public function TextField($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('text', $name, $x, $y, $w, $h, $prop); + return; + } + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set default appearance stream + $font = $this->FontFamily; + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; + } + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = 'q BT '.$fontstyle.' ET Q'; + // merge options + $opt = array_merge($popt, $opt); + // remove some conflicting options + unset($opt['bs']); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Tx'; + $opt['t'] = $name; + /* + Additional annotation's parameters (check _putannotsobj() method): + //$opt['f'] + //$opt['ap'] + //$opt['as'] + //$opt['bs'] + //$opt['be'] + //$opt['c'] + //$opt['border'] + //$opt['h'] + //$opt['mk'] + //$opt['mk']['r'] + //$opt['mk']['bc'] + //$opt['mk']['bg'] + //$opt['mk']['ca'] + //$opt['mk']['rc'] + //$opt['mk']['ac'] + //$opt['mk']['i'] + //$opt['mk']['ri'] + //$opt['mk']['ix'] + //$opt['mk']['if'] + //$opt['mk']['if']['sw'] + //$opt['mk']['if']['s'] + //$opt['mk']['if']['a'] + //$opt['mk']['if']['fb'] + //$opt['mk']['tp'] + //$opt['tu'] + //$opt['tm'] + //$opt['ff'] + //$opt['v'] + //$opt['dv'] + //$opt['a'] + //$opt['aa'] + //$opt['q'] + */ + $this->Annotation($x, $y, $w, $h, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; + } + } + + /** * Creates a RadioButton field * @param string $name field name * @param int $w width - * @param string $prop properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @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 * @author Nicola Asuni - * @since 2.2.003 (2008-03-03) + * @since 4.8.000 (2009-09-07) */ - public function RadioButton($name, $w, $prop=array()) { - if (!isset($prop['strokeColor'])) { - $prop['strokeColor']='black'; + public function RadioButton($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('radiobutton', $name, $x, $y, $w, $w, $prop); + return; + } + if ($this->empty_string($onvalue)) { + $onvalue = 'On'; + } + if ($checked) { + $defval = $onvalue; + } else { + $defval = 'Off'; + } + // set data for parent group + if (!isset($this->radiobutton_groups[$this->page])) { + $this->radiobutton_groups[$this->page] = array(); + } + if (!isset($this->radiobutton_groups[$this->page][$name])) { + $this->radiobutton_groups[$this->page][$name] = array(); + ++$this->annot_obj_id; + $this->radio_groups[] = $this->annot_obj_id; + } + // save object ID to be added on Kids entry on parent object + $this->radiobutton_groups[$this->page][$name][] = array('kid' => ($this->annot_obj_id + 1), 'def' => $defval); + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + $prop['NoToggleToOff'] = 'true'; + $prop['Radio'] = 'true'; + $prop['borderStyle'] = 'inset'; + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set additional default values + $font = 'zapfdingbats'; + $this->AddFont($font); + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; + } + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = array(); + $popt['ap']['n'][$onvalue] = 'q BT '.$fontstyle.' 0 0 Td (8) Tj ET Q'; + $popt['ap']['n']['Off'] = 'q BT '.$fontstyle.' 0 0 Td (8) Tj ET Q'; + if (!isset($popt['mk'])) { + $popt['mk'] = array(); + } + $popt['mk']['ca'] = '(l)'; + // merge options + $opt = array_merge($popt, $opt); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Btn'; + if ($checked) { + $opt['v'] = array('/'.$onvalue); + $opt['as'] = $onvalue; + } else { + $opt['as'] = 'Off'; + } + $this->Annotation($x, $y, $w, $w, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; } - $this->_addfield('radiobutton', $name, $this->x, $this->y, $w, $w, $prop); } - /* + /** * 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 string $prop properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @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 * @author Nicola Asuni - * @since 2.2.003 (2008-03-03) + * @since 4.8.000 (2009-09-07) */ - public function ListBox($name, $w, $h, $values, $prop=array()) { - if (!isset($prop['strokeColor'])) { - $prop['strokeColor'] = 'ltGray'; + public function ListBox($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; } - $this->_addfield('listbox', $name, $this->x, $this->y, $w, $h, $prop); - $s = ''; - foreach ($values as $value) { - $s .= "'".addslashes($value)."',"; + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('listbox', $name, $x, $y, $w, $h, $prop); + $s = ''; + foreach ($values as $value) { + $s .= "'".addslashes($value)."',"; + } + $this->javascript .= 'f'.$name.'.setItems(['.substr($s, 0, -1)."]);\n"; + return; + } + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set additional default values + $font = $this->FontFamily; + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; + } + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = 'q BT '.$fontstyle.' ET Q'; + // merge options + $opt = array_merge($popt, $opt); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Ch'; + $opt['t'] = $name; + $opt['opt'] = $values; + $this->Annotation($x, $y, $w, $h, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; } - $this->javascript .= 'f'.$name.'.setItems(['.substr($s, 0, -1)."]);\n"; } - /* + /** * 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 string $prop properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @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 - * @author Denis Van Nuffelen, Nicola Asuni - * @since 2.1.002 (2008-02-12) + * @author Nicola Asuni + * @since 4.8.000 (2009-09-07) */ - public function ComboBox($name, $w, $h, $values, $prop=array()) { - $this->_addfield('combobox', $name, $this->x, $this->y, $w, $h, $prop); - $s = ''; - foreach ($values as $value) { - $s .= "'".addslashes($value)."',"; + public function ComboBox($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('combobox', $name, $x, $y, $w, $h, $prop); + $s = ''; + foreach ($values as $value) { + $s .= "'".addslashes($value)."',"; + } + $this->javascript .= 'f'.$name.'.setItems(['.substr($s, 0, -1)."]);\n"; + return; + } + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + $prop['Combo'] = true; + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set additional default options + $font = $this->FontFamily; + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; + } + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = 'q BT '.$fontstyle.' ET Q'; + // merge options + $opt = array_merge($popt, $opt); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Ch'; + $opt['t'] = $name; + $opt['opt'] = $values; + $this->Annotation($x, $y, $w, $h, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; } - $this->javascript .= 'f'.$name.'.setItems(['.substr($s, 0, -1)."]);\n"; } - /* + /** * Creates a CheckBox field * @param string $name field name * @param int $w width - * @param boolean $checked define the initial state (default = false). - * @param string $prop properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @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 - * @author Denis Van Nuffelen, Nicola Asuni - * @since 2.1.002 (2008-02-12) + * @author Nicola Asuni + * @since 4.8.000 (2009-09-07) */ - public function CheckBox($name, $w, $checked=false, $prop=array()) { - $prop['value'] = ($checked ? 'Yes' : 'Off'); - if (!isset($prop['strokeColor'])) { - $prop['strokeColor'] = 'black'; + public function CheckBox($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('checkbox', $name, $x, $y, $w, $w, $prop); + return; + } + if (!isset($prop['value'])) { + $prop['value'] = array('Yes'); + } + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + $prop['borderStyle'] = 'inset'; + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set additional default options + $font = 'zapfdingbats'; + $this->AddFont($font); + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; + } + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = array(); + $popt['ap']['n']['Yes'] = 'q BT '.$fontstyle.' 0 0 Td (8) Tj ET Q'; + $popt['ap']['n']['Off'] = 'q BT '.$fontstyle.' 0 0 Td (8) Tj ET Q'; + // merge options + $opt = array_merge($popt, $opt); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Btn'; + $opt['t'] = $name; + $opt['opt'] = array($onvalue); + if ($checked) { + $opt['v'] = array('/0'); + $opt['as'] = 'Yes'; + } else { + $opt['v'] = array('/Off'); + $opt['as'] = 'Off'; + } + $this->Annotation($x, $y, $w, $w, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; } - $this->_addfield('checkbox', $name, $this->x, $this->y, $w, $w, $prop); } - /* + /** * Creates a button field * @param string $name field name * @param int $w width * @param int $h height * @param string $caption caption. - * @param string $action action triggered by the button (JavaScript code). - * @param string $prop properties. Possible values are (http://www.adobe.com/devnet/acrobat/pdfs/js_developer_guide.pdf):
    • rect: Position and size of field on page.
    • borderStyle: Rectangle border appearance.
    • strokeColor: Color of bounding rectangle.
    • lineWidth: Width of the edge of the surrounding rectangle.
    • rotation: Rotation of field in 90-degree increments.
    • fillColor: Background color of field (gray, transparent, RGB, or CMYK).
    • userName: Short description of field that appears on mouse-over.
    • readonly: Whether the user may change the field contents.
    • doNotScroll: Whether text fields may scroll.
    • display: Whether visible or hidden on screen or in print.
    • textFont: Text font.
    • textColor: Text color.
    • textSize: Text size.
    • richText: Rich text.
    • richValue: Text.
    • comb: Text comb format.
    • multiline: Text multiline.
    • charLimit: Text limit to number of characters.
    • fileSelect: Text file selection format.
    • password: Text password format.
    • alignment: Text layout in text fields.
    • buttonAlignX: X alignment of icon on button face.
    • buttonAlignY: Y alignment of icon on button face.
    • buttonFitBounds: Relative scaling of an icon to fit inside a button face.
    • buttonScaleHow: Relative scaling of an icon to fit inside a button face.
    • buttonScaleWhen: Relative scaling of an icon to fit inside a button face.
    • highlight: Appearance of a button when pushed.
    • style: Glyph style for checkbox and radio buttons.
    • numItems: Number of items in a combo box or list box.
    • editable: Whether the user can type in a combo box.
    • multipleSelection: Whether multiple list box items may be selected.
    + * @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 - * @author Denis Van Nuffelen, Nicola Asuni - * @since 2.1.002 (2008-02-12) - */ - public function Button($name, $w, $h, $caption, $action, $prop=array()) { - if (!isset($prop['strokeColor'])) { - $prop['strokeColor'] = 'black'; - } - if (!isset($prop['borderStyle'])) { - $prop['borderStyle'] = 'beveled'; - } - $this->_addfield('button', $name, $this->x, $this->y, $w, $h, $prop); - $this->javascript .= 'f'.$name.".buttonSetCaption('".addslashes($caption)."');\n"; - $this->javascript .= 'f'.$name.".setAction('MouseUp','".addslashes($action)."');\n"; - $this->javascript .= 'f'.$name.".highlight='push';\n"; - $this->javascript .= 'f'.$name.".print=false;\n"; - } - - // END JAVASCRIPT - FORMS ------------------------------ - - /* - * Enable Write permissions for PDF Reader. - * @access protected * @author Nicola Asuni - * @since 2.9.000 (2008-03-26) + * @since 4.8.000 (2009-09-07) */ - protected function _putuserrights() { - if (!$this->ur) { + public function Button($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false) { + if ($x === '') { + $x = $this->x; + } + if ($y === '') { + $y = $this->y; + } + if ($js) { + $this->_addfield('button', $name, $this->x, $this->y, $w, $h, $prop); + $this->javascript .= 'f'.$name.".buttonSetCaption('".addslashes($caption)."');\n"; + $this->javascript .= 'f'.$name.".setAction('MouseUp','".addslashes($action)."');\n"; + $this->javascript .= 'f'.$name.".highlight='push';\n"; + $this->javascript .= 'f'.$name.".print=false;\n"; return; } - $this->_out('/Perms'); - $this->_out('<<'); - $this->_out('/UR3'); - $this->_out('<<'); - //$this->_out('/SubFilter/adbe.pkcs7.detached/Filter/Adobe.PPKLite/Contents'); - //$this->_out('<0>'); - //$this->_out('/ByteRange[0 3]'); - $this->_out('/M '.$this->_datastring('D:'.date('YmdHis'))); - $this->_out('/Name(TCPDF)'); - $this->_out('/Reference['); - $this->_out('<<'); - $this->_out('/TransformParams'); - $this->_out('<<'); - $this->_out('/Type/TransformParams'); - $this->_out('/V/2.2'); - if (!empty($this->ur_document)) { - $this->_out('/Document['.$this->ur_document.']'); + // get default style + $prop = array_merge($this->getFormDefaultProp(), $prop); + $prop['Pushbutton'] = 'true'; + $prop['highlight'] = 'push'; + $prop['display'] = 'display.noPrint'; + // get annotation data + $popt = $this->getAnnotOptFromJSProp($prop); + // set additional default options + if (!isset($popt['mk'])) { + $popt['mk'] = array(); } - if (!empty($this->ur_annots)) { - $this->_out('/Annots['.$this->ur_annots.']'); + $popt['mk']['ca'] = $this->_textstring($caption); + $popt['mk']['rc'] = $this->_textstring($caption); + $popt['mk']['ac'] = $this->_textstring($caption); + $font = $this->FontFamily; + $fontkey = array_search($font, $this->fontkeys); + if (!in_array($fontkey, $this->annotation_fonts)) { + $this->annotation_fonts[$font] = $fontkey; } - if (!empty($this->ur_form)) { - $this->_out('/Form['.$this->ur_form.']'); + $fontstyle = sprintf('/F%d %.2F Tf %s', ($fontkey + 1), $this->FontSizePt, $this->TextColor); + $popt['da'] = $fontstyle; + $popt['ap'] = array(); + $popt['ap']['n'] = 'q BT '.$fontstyle.' ET Q'; + // merge options + $opt = array_merge($popt, $opt); + // set remaining annotation data + $opt['Subtype'] = 'Widget'; + $opt['ft'] = 'Btn'; + $opt['t'] = $caption; + $opt['v'] = $name; + if (!empty($action)) { + if (is_array($action)) { + // form action options as on section 12.7.5 of PDF32000_2008. + $opt['aa'] = '/D <<'; + $bmode = array('SubmitForm', 'ResetForm', 'ImportData'); + foreach ($action AS $key => $val) { + if (($key == 'S') AND in_array($val, $bmode)) { + $opt['aa'] .= ' /S /'.$val; + } elseif (($key == 'F') AND (!empty($val))) { + $opt['aa'] .= ' /F '.$this->_datastring($val); + } elseif (($key == 'Fields') AND is_array($val) AND !empty($val)) { + $opt['aa'] .= ' /Fields ['; + foreach ($val AS $field) { + $opt['aa'] .= ' '.$this->_textstring($field); + } + $opt['aa'] .= ']'; + } elseif (($key == 'Flags')) { + $ff = 0; + if (is_array($val)) { + foreach ($val AS $flag) { + switch ($flag) { + case 'Include/Exclude': { + $ff += 1 << 0; + break; + } + case 'IncludeNoValueFields': { + $ff += 1 << 1; + break; + } + case 'ExportFormat': { + $ff += 1 << 2; + break; + } + case 'GetMethod': { + $ff += 1 << 3; + break; + } + case 'SubmitCoordinates': { + $ff += 1 << 4; + break; + } + case 'XFDF': { + $ff += 1 << 5; + break; + } + case 'IncludeAppendSaves': { + $ff += 1 << 6; + break; + } + case 'IncludeAnnotations': { + $ff += 1 << 7; + break; + } + case 'SubmitPDF': { + $ff += 1 << 8; + break; + } + case 'CanonicalFormat': { + $ff += 1 << 9; + break; + } + case 'ExclNonUserAnnots': { + $ff += 1 << 10; + break; + } + case 'ExclFKey': { + $ff += 1 << 11; + break; + } + case 'EmbedForm': { + $ff += 1 << 13; + break; + } + } + } + } else { + $ff = intval($val); + } + $opt['aa'] .= ' /Flags '.$ff; + } + } + $opt['aa'] .= ' >>'; + } else { + // Javascript action or raw action command + $js_obj_id = $this->addJavascriptObject($action); + $opt['aa'] = '/D '.$js_obj_id.' 0 R'; + } + } + $this->Annotation($x, $y, $w, $h, $name, $opt, 0); + if ($this->rtl) { + $this->x -= $w; + } else { + $this->x += $w; } - if (!empty($this->ur_signature)) { - $this->_out('/Signature['.$this->ur_signature.']'); - } - $this->_out('>>'); - $this->_out('/TransformMethod/UR3'); - $this->_out('/Type/SigRef'); - $this->_out('>>'); - $this->_out(']'); - $this->_out('/Type/Sig'); - $this->_out('>>'); - $this->_out('>>'); } - /* + // --- END FORMS FIELDS ------------------------------------------------ + + /** + * Add certification signature (DocMDP or UR3) + * You can set only one signature type + * @access protected + * @author Nicola Asuni + * @since 4.6.008 (2009-05-07) + */ + protected function _putsignature() { + if ((!$this->sign) OR (!isset($this->signature_data['cert_type']))) { + return; + } + $this->_out('/Type /Sig'); + $this->_out('/Filter /Adobe.PPKLite'); + $this->_out('/SubFilter /adbe.pkcs7.detached'); + $this->_out($this->byterange_string); + $this->_out('/Contents<>'.str_repeat(' ', $this->signature_max_length)); + $this->_out('/Reference'); + $this->_out('['); + $this->_out('<<'); + $this->_out('/Type /SigRef'); + if ($this->signature_data['cert_type'] > 0) { + $this->_out('/TransformMethod /DocMDP'); + $this->_out('/TransformParams'); + $this->_out('<<'); + $this->_out('/Type /TransformParams'); + $this->_out('/V /1.2'); + $this->_out('/P '.$this->signature_data['cert_type'].''); + } else { + $this->_out('/TransformMethod /UR3'); + $this->_out('/TransformParams'); + $this->_out('<<'); + $this->_out('/Type /TransformParams'); + $this->_out('/V /2.2'); + if (!$this->empty_string($this->ur_document)) { + $this->_out('/Document['.$this->ur_document.']'); + } + if (!$this->empty_string($this->ur_annots)) { + $this->_out('/Annots['.$this->ur_annots.']'); + } + if (!$this->empty_string($this->ur_form)) { + $this->_out('/Form['.$this->ur_form.']'); + } + if (!$this->empty_string($this->ur_signature)) { + $this->_out('/Signature['.$this->ur_signature.']'); + } + } + $this->_out('>>'); + $this->_out('>>'); + $this->_out(']'); + if (isset($this->signature_data['info']['Name']) AND !$this->empty_string($this->signature_data['info']['Name'])) { + $this->_out('/Name '.$this->_textstring($this->signature_data['info']['Name']).''); + } + if (isset($this->signature_data['info']['Location']) AND !$this->empty_string($this->signature_data['info']['Location'])) { + $this->_out('/Location '.$this->_textstring($this->signature_data['info']['Location']).''); + } + if (isset($this->signature_data['info']['Reason']) AND !$this->empty_string($this->signature_data['info']['Reason'])) { + $this->_out('/Reason '.$this->_textstring($this->signature_data['info']['Reason']).''); + } + if (isset($this->signature_data['info']['ContactInfo']) AND !$this->empty_string($this->signature_data['info']['ContactInfo'])) { + $this->_out('/ContactInfo '.$this->_textstring($this->signature_data['info']['ContactInfo']).''); + } + $this->_out('/M '.$this->_datestring()); + } + + /** * Set User's Rights for PDF Reader + * WARNING: This works only using the Adobe private key with the setSignature() method!. * 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 @@ -8067,26 +11213,69 @@ if (!class_exists('TCPDF', false)) { $this->ur_annots = $annots; $this->ur_form = $form; $this->ur_signature = $signature; - } - - /* - * Create a new page group. - * NOTE: call this function before calling AddPage() - * @access public - * @since 3.0.000 (2008-03-27) - */ - public function startPageGroup() { - $this->newpagegroup = true; + if (!$this->sign) { + // This signature only works using the Adobe Private key that is unavailable! + $this->setSignature('', '', '', '', 0, array()); + } } /** - * Defines an alias for the total number of pages. It will be substituted as the document is closed.
    - * @param string $alias The alias. Default value: {nb}. + * Enable document signature (requires the OpenSSL Library). + * The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. + * @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 + * @author Nicola Asuni + * @since 4.6.005 (2009-04-24) + */ + public function setSignature($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array()) { + // to create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt + // to convert pfx certificate to pem: openssl + // OpenSSL> pkcs12 -in -out -nodes + $this->sign = true; + $this->signature_data = array(); + if (strlen($signing_cert) == 0) { + $signing_cert = 'file://'.dirname(__FILE__).'/tcpdf.crt'; + $private_key_password = 'tcpdfdemo'; + } + if (strlen($private_key) == 0) { + $private_key = $signing_cert; + } + $this->signature_data['signcert'] = $signing_cert; + $this->signature_data['privkey'] = $private_key; + $this->signature_data['password'] = $private_key_password; + $this->signature_data['extracerts'] = $extracerts; + $this->signature_data['cert_type'] = $cert_type; + $this->signature_data['info'] = $info; + } + + /** + * 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 + * @since 3.0.000 (2008-03-27) + */ + public function startPageGroup($page='') { + if (empty($page)) { + $page = $this->page + 1; + } + $this->newpagegroup[$page] = true; + } + + /** + * 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 * @since 1.4 * @see getAliasNbPages(), PageNo(), Footer() */ public function AliasNbPages($alias='{nb}') { - //Define an alias for total number of pages $this->AliasNbPages = $alias; } @@ -8094,6 +11283,7 @@ if (!class_exists('TCPDF', false)) { * 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() */ @@ -8103,8 +11293,36 @@ if (!class_exists('TCPDF', false)) { } return $this->AliasNbPages; } + + /** + * Defines an alias for the page number. + * It will be substituted as the document is closed. + * @param string $alias The alias. + * @access public + * @since 4.5.000 (2009-01-02) + * @see getAliasNbPages(), PageNo(), Footer() + */ + public function AliasNumPage($alias='{pnb}') { + //Define an alias for total number of pages + $this->AliasNumPage = $alias; + } - /* + /** + * 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 function getAliasNumPage() { + if (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { + return '{'.$this->AliasNumPage.'}'; + } + return $this->AliasNumPage; + } + + /** * Return the current page in the group. * @return current page in the group * @access public @@ -8113,7 +11331,7 @@ if (!class_exists('TCPDF', false)) { public function getGroupPageNo() { return $this->pagegroups[$this->currpagegroup]; } - + /** * Returns the current group page number formatted as a string. * @access public @@ -8124,7 +11342,7 @@ if (!class_exists('TCPDF', false)) { return $this->formatPageNumber($this->getGroupPageNo()); } - /* + /** * Return the alias of the current page group * 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). @@ -8133,12 +11351,27 @@ if (!class_exists('TCPDF', false)) { * @since 3.0.000 (2008-03-27) */ public function getPageGroupAlias() { - if (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { + if (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { return '{'.$this->currpagegroup.'}'; } return $this->currpagegroup; } + /** + * Return the alias for the page number on the current page group + * 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 + * @since 4.5.000 (2009-01-02) + */ + public function getPageNumGroupAlias() { + if (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0')) { + return '{'.str_replace('{nb', '{pnb', $this->currpagegroup).'}'; + } + return str_replace('{nb', '{pnb', $this->currpagegroup); + } + /** * Format the page numbers. * This method can be overriden for custom formats. @@ -8149,7 +11382,19 @@ if (!class_exists('TCPDF', false)) { protected function formatPageNumber($num) { return number_format((float)$num, 0, '', '.'); } - + + /** + * Format the page numbers on the Table Of Content. + * This method can be overriden for custom formats. + * @param int $num page number + * @access protected + * @since 4.5.001 (2009-01-04) + * @see addTOC() + */ + protected function formatTOCPageNumber($num) { + return number_format((float)$num, 0, '', '.'); + } + /** * Returns the current page number formatted as a string. * @access public @@ -8159,8 +11404,8 @@ if (!class_exists('TCPDF', false)) { public function PageNoFormatted() { return $this->formatPageNumber($this->PageNo()); } - - /* + + /** * Put visibility settings. * @access protected * @since 3.0.000 (2008-03-27) @@ -8172,13 +11417,13 @@ if (!class_exists('TCPDF', false)) { $this->_out('/Usage <> /View <>>>>>'); $this->_out('endobj'); $this->_newobj(); - $this->n_ocg_view=$this->n; + $this->n_ocg_view = $this->n; $this->_out('<_textstring('view')); $this->_out('/Usage <> /View <>>>>>'); $this->_out('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. @@ -8215,7 +11460,7 @@ if (!class_exists('TCPDF', false)) { $this->visibility = $v; } - /* + /** * Add transparency parameters to the current extgstate * @param array $params parameters * @return the number of extgstates @@ -8224,11 +11469,18 @@ if (!class_exists('TCPDF', false)) { */ protected function addExtGState($parms) { $n = count($this->extgstates) + 1; + // check if this ExtGState already exist + for ($i = 1; $i < $n; ++$i) { + if ($this->extgstates[$i]['parms'] == $parms) { + // return reference to existing ExtGState + return $i; + } + } $this->extgstates[$n]['parms'] = $parms; return $n; } - /* + /** * Add an extgstate * @param array $gs extgstate * @access protected @@ -8238,7 +11490,7 @@ if (!class_exists('TCPDF', false)) { $this->_out(sprintf('/GS%d gs', $gs)); } - /* + /** * Put extgstates for object transparency * @param array $gs extgstate * @access protected @@ -8246,7 +11498,7 @@ if (!class_exists('TCPDF', false)) { */ protected function _putextgstates() { $ne = count($this->extgstates); - for ($i = 1; $i <= $ne; $i++) { + for ($i = 1; $i <= $ne; ++$i) { $this->_newobj(); $this->extgstates[$i]['n'] = $this->n; $this->_out('<setExtGState($gs); } - /* + /** * Set the default JPEG compression quality (1-100) * @param int $quality JPEG quality, integer between 1 and 100 * @access public @@ -8283,7 +11535,7 @@ if (!class_exists('TCPDF', false)) { $this->jpeg_quality = intval($quality); } - /* + /** * Set the default number of columns in a row for HTML tables. * @param int $cols number of columns * @access public @@ -8293,8 +11545,8 @@ if (!class_exists('TCPDF', false)) { $this->default_table_columns = intval($cols); } - /* - * Set the height of cell repect font height. + /** + * 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 * @since 3.0.014 (2008-06-04) @@ -8303,7 +11555,7 @@ if (!class_exists('TCPDF', false)) { $this->cell_height_ratio = $h; } - /* + /** * return the height of cell repect font height. * @access public * @since 4.0.012 (2008-07-24) @@ -8312,7 +11564,7 @@ if (!class_exists('TCPDF', false)) { return $this->cell_height_ratio; } - /* + /** * Set the PDF version (check PDF reference for valid values). * Default value is 1.t * @access public @@ -8322,27 +11574,10 @@ if (!class_exists('TCPDF', false)) { $this->PDFVersion = $version; } - /* + /** * 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"). - *