Source for file tcpdf.php
Documentation is available at tcpdf.php
//============================================================+
// Last Update : 2010-10-21
// Author : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2002-2010 Nicola Asuni - Tecnick.com S.r.l.
// This file is part of TCPDF software library.
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
// Description : This is a PHP class for generating PDF documents without
// requiring external extensions.
// This class was originally derived in 2002 from the Public
// Domain FPDF class by Olivier Plathey (http://www.fpdf.org),
// but now is almost entirely rewritten and contains thousands of
// new lines of code and hundreds new features.
// * no external libraries are required for the basic functions;
// * all standard page formats, custom page formats, custom margins and units of measure;
// * UTF-8 Unicode and Right-To-Left languages;
// * TrueTypeUnicode, OpenTypeUnicode, TrueType, OpenType, Type1 and CID-0 fonts;
// * methods to publish some XHTML + CSS code, Javascript and Forms;
// * images, graphic (geometric figures) and transformation methods;
// * supports JPEG, PNG and SVG 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)
// * 1D and 2D barcodes: 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, QR-Code, PDF417;
// * Grayscale, RGB, CMYK, Spot Colors and Transparencies;
// * automatic page header and footer management;
// * document encryption up to 256 bit and digital signature certifications;
// * transactions to UNDO commands;
// * PDF annotations, including links, text and file attachments;
// * text rendering modes (fill, stroke and clipping);
// * multiple columns mode;
// * no-write page regions;
// * bookmarks and table of content;
// * text stretching and spacing (tracking/kerning);
// * automatic page break, line break and text alignments including justification;
// * automatic page numbering and page groups;
// * move and delete pages;
// * page compression (requires php-zlib extension);
// -----------------------------------------------------------
// Olivier Plathey (http://www.fpdf.org) for original FPDF.
// Efthimios Mavrogeorgiadis (emavro@yahoo.com) for suggestions on RTL language support.
// Klemen Vodopivec (http://www.fpdf.de/downloads/addons/37/) for Encryption algorithm.
// Warren Sherliker (wsherliker@gmail.com) for better image handling.
// dullus for text Justification.
// Bob Vincent (pillarsdotnet@users.sourceforge.net) for <li> value attribute.
// Patrick Benny for text stretch suggestion on Cell().
// 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.
// Sourceforge user 1707880 (hucste) for line-trough mode.
// Larry Stanbery for page groups.
// Martin Hall-May for transparency.
// Aaron C. Spike for Polycurve method.
// 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.
// 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.
// Dominik Dzienia for QR-code support.
// Laurent Minguet for some suggestions.
// Christian Deligant for some suggestions and fixes.
// Anyone that has reported a bug or sent a suggestion.
//============================================================+
* This is a PHP class for generating PDF documents without requiring external extensions.<br>
* 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.<br>
* <h3>TCPDF main features are:</h3>
* <li>no external libraries are required for the basic functions;</li>
* <li>all standard page formats, custom page formats, custom margins and units of measure;</li>
* <li>UTF-8 Unicode and Right-To-Left languages;</li>
* <li>TrueTypeUnicode, OpenTypeUnicode, TrueType, OpenType, Type1 and CID-0 fonts;</li>
* <li>font subsetting;</li>
* <li>methods to publish some XHTML + CSS code, Javascript and Forms;</li>
* <li>images, graphic (geometric figures) and transformation methods;
* <li>supports JPEG, PNG and SVG 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)</li>
* <li>1D and 2D barcodes: 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, QR-Code, PDF417;</li>
* <li>Grayscale, RGB, CMYK, Spot Colors and Transparencies;</li>
* <li>automatic page header and footer management;</li>
* <li>document encryption up to 256 bit and digital signature certifications;</li>
* <li>transactions to UNDO commands;</li>
* <li>PDF annotations, including links, text and file attachments;</li>
* <li>text rendering modes (fill, stroke and clipping);</li>
* <li>multiple columns mode;</li>
* <li>no-write page regions;</li>
* <li>bookmarks and table of content;</li>
* <li>text hyphenation;</li>
* <li>text stretching and spacing (tracking/kerning);</li>
* <li>automatic page break, line break and text alignments including justification;</li>
* <li>automatic page numbering and page groups;</li>
* <li>move and delete pages;</li>
* <li>page compression (requires php-zlib extension);</li>
* <li>XOBject Templates;</li>
* Tools to encode your unicode fonts are on fonts/utils directory.</p>
* @package com.tecnick.tcpdf
* @abstract Class for generating PDF files on-the-fly without requiring external extensions.
* @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
* main configuration file
* (define the K_TCPDF_EXTERNAL_CONFIG constant to skip this file)
require_once(dirname(__FILE__ ). '/config/tcpdf_config.php');
* define default PDF document producer
define('PDF_PRODUCER', 'TCPDF 5.9.009 (http://www.tcpdf.org)');
* This is a PHP class for generating PDF documents without requiring external extensions.<br>
* 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.<br>
* @package com.tecnick.tcpdf
* @author Nicola Asuni - info@tecnick.com
* @link http://www.tcpdf.org
* @license http://www.gnu.org/copyleft/lesser.html LGPL
* @var current page number
* @var current object number
* @var array of object offsets
* @var buffer holding in-memory PDF
* @var array containing pages
* @var current document state
* @var current page orientation (P = Portrait, L = Landscape)
* @var scale factor (number of points in user unit)
* @var width of page format in points
* @var height of page format in points
* @var current width of page in points
* @var current height of page in points
* @var current width of page in user unit
* @var current height of page in user unit
* @var array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left)
* @since 5.9.000 (2010-10-03)
protected $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
* @var array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left)
* @since 5.9.000 (2010-10-04)
protected $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
* @var current horizontal position in user unit for cell positioning
* @var current vertical position in user unit for cell positioning
* @var height of last cell printed
* @var line width in user unit
* @var array of standard font names
* @var array of used fonts
* @var array of font files
* @var array of encoding differences
* @var array of used images
* @var array of Annotations in pages
* @var array of internal links
* @var current font family
* @var current font style
* @var current font ascent (distance between font top and baseline)
* @since 2.8.000 (2007-03-29)
* @var current font descent (distance between font bottom and baseline)
* @since 2.8.000 (2007-03-29)
* @var current font size in points
* @var current font size in user unit
* @var commands for drawing color
* @var commands for filling color
* @var commands for text color
* @var indicates whether fill and text colors are different
* @var automatic page breaking
* @var threshold used to trigger page breaks
* @var flag set when processing footer
* @var layout display mode
* @var alias for total number of pages
* @var alias for page number
* @var right-bottom corner X coordinate of inserted image
* @var right-bottom corner Y coordinate of inserted image
* @var adjusting factor to convert pixels to user units.
* @var boolean set to true when the input text is unicode (require unicode fonts)
* @var object containing unicode data
* @since 5.9.004 (2010-10-18)
* @var Minimum distance between header and top page margin.
* @var Minimum distance between footer and bottom page margin.
* @var original left margin value
* @var original right margin value
* @var Language templates.
* @var Barcode to print on page footer (only if set).
* @var If true prints header
* @var If true prints footer.
* @var Header image logo.
* @var Header image logo width in mm.
* @var String to print as title on document header.
* @var String to print on document header.
* @var Default number of columns for html table.
// variables for html parser
* @var HTML PARSER: array to store current link and rendering styles.
protected $HREF = array();
* @var store a list of available fonts on filesystem.
* @var current foreground color
* @var HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
* @var HTML PARSER: array count list items on nested lists.
* @var HTML PARSER: current list nesting level.
* @var HTML PARSER: indent amount for lists.
* @var HTML PARSER: current list indententation level.
* @var current background color
* @var Store temporary font size in points.
* @var spacer for LI tags.
* @var PHP internal encoding
* @var indicates if the document language is Right-To-Left
* @var used to force RTL or LTR string inversion
// --- Variables used for document encryption:
* Indicates whether document is protected
* @since 2.0.000 (2008-01-02)
* Array containing encryption settings
* @since 5.0.005 (2010-05-11)
* last RC4 key encrypted (cached for optimisation)
* @since 2.0.000 (2008-01-02)
* @since 2.0.000 (2008-01-02)
protected $enc_padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A";
* File ID (used on trailer)
* @since 5.0.005 (2010-05-12)
* @since 2.1.002 (2008-02-12)
* Outline root for bookmark
* @since 2.1.002 (2008-02-12)
// --- javascript and form ---
* @since 2.1.002 (2008-02-12)
* @since 2.1.002 (2008-02-12)
* @since 2.8.000 (2008-03-19)
* Array with additional document-wide usage rights for the document.
* @since 5.8.014 (2010-08-23)
* Dot Per Inch Document Resolution (do not change)
* @since 3.0.000 (2008-03-27)
* Array of page numbers were a new page group was started
* @since 3.0.000 (2008-03-27)
* Contains the number of pages of the groups
* @since 3.0.000 (2008-03-27)
* Contains the alias of the current page group
* @since 3.0.000 (2008-03-27)
* Restrict the rendering of some elements to screen or printout.
* @since 3.0.000 (2008-03-27)
* @since 3.0.000 (2008-03-27)
* @since 3.0.000 (2008-03-27)
* Array of transparency objects and parameters.
* @since 3.0.000 (2008-03-27)
* Set the default JPEG compression quality (1-100)
* @since 3.0.000 (2008-03-27)
* Default cell height ratio.
* @since 3.0.014 (2008-05-23)
* PDF viewer preferences.
* @since 3.1.000 (2008-06-09)
* A name object specifying how the document should be displayed when opened.
* @since 3.1.000 (2008-06-09)
* Array for storing gradient information.
* @since 3.1.000 (2008-06-09)
* Array used to store positions inside the pages buffer.
* keys are the page numbers
* @since 3.2.000 (2008-06-26)
* Array used to store positions inside the pages buffer.
* keys are the page numbers
* @since 5.7.000 (2010-08-03)
* Array used to store page positions to track empty pages.
* keys are the page numbers
* @since 5.8.007 (2010-08-18)
* Array used to store content positions inside the pages buffer.
* keys are the page numbers
* @since 4.6.021 (2009-07-20)
* Array used to store footer positions of each page.
* @since 3.2.000 (2008-07-01)
* Array used to store footer length of each page.
* @since 4.0.014 (2008-07-29)
* True if a newline is created.
* @since 3.2.000 (2008-07-01)
* End position of the latest inserted line
* @since 3.2.000 (2008-07-01)
* PDF string for last line width
* @since 4.0.006 (2008-07-16)
* PDF string for last line width
* @since 4.0.006 (2008-07-16)
* PDF string for last line width
* @since 4.0.006 (2008-07-16)
* PDF string for last line width
* @since 4.0.006 (2008-07-16)
* True if marked-content sequence is open
* @since 4.0.013 (2008-07-28)
* Count the latest inserted vertical spaces on HTML
* @since 4.0.021 (2008-08-24)
* @since 4.0.024 (2008-09-12)
* Symbol used for HTML unordered list items
* @since 4.0.028 (2008-09-26)
* String used to mark the beginning and end of EPS image blocks
* @since 4.1.000 (2008-10-18)
* Array of transformation matrix
* @since 4.2.000 (2008-10-29)
* Current key for transformation matrix
* @since 4.8.005 (2009-09-17)
* Booklet mode for double-sided pages
* @since 4.2.000 (2008-10-29)
* Epsilon value used for float calculations
* @since 4.2.000 (2008-10-29)
* Array used for custom vertical spaces for HTML tags
* @since 4.2.001 (2008-10-30)
* @var HTML PARSER: custom indent amount for lists.
* Negative value means disabled.
* @since 4.2.007 (2008-11-12)
* @var if true keeps the border open for the cell sides that cross the page.
* @since 4.2.010 (2008-11-14)
* @var array of files to embedd
* @since 4.4.000 (2008-12-07)
* @var boolean true when inside html pre tag
* @since 4.4.001 (2008-12-08)
* Array used to store positions of graphics transformation blocks inside the page buffer.
* keys are the page numbers
* @since 4.4.002 (2008-12-09)
* Default color for html links
* @since 4.4.003 (2008-12-09)
* Default font style to add to html links
* @since 4.4.003 (2008-12-09)
* Counts the number of pages.
* @since 4.5.000 (2008-12-31)
* Array containing page lengths in bytes.
* @since 4.5.000 (2008-12-31)
* Counts the number of pages.
* @since 4.5.000 (2008-12-31)
* @since 4.5.000 (2008-12-31)
* Length of the buffer in bytes.
* @since 4.5.000 (2008-12-31)
* If true enables disk caching.
* @since 4.5.000 (2008-12-31)
* Counts the number of fonts.
* @since 4.5.000 (2009-01-02)
* @since 4.5.000 (2009-01-02)
* Store the font object IDs.
* @since 4.8.001 (2009-09-09)
* Store the fage status (true when opened, false when closed).
* @since 4.5.000 (2009-01-02)
* Default monospaced font
* @since 4.5.025 (2009-03-10)
* Used to store a cloned copy of the current class object
* @since 4.5.029 (2009-03-19)
* Array used to store the lengths of cache files
* @since 4.5.029 (2009-03-19)
* Table header content to be repeated on each new page
* @since 4.5.030 (2009-03-20)
* Margins used for table header.
* @since 4.5.030 (2009-03-20)
* Cache array for UTF8StringToArray() method.
* @since 4.5.037 (2009-04-07)
* Maximum size of cache array used for UTF8StringToArray() method.
* @since 4.5.037 (2009-04-07)
* Current size of cache array used for UTF8StringToArray() method.
* @since 4.5.037 (2009-04-07)
* If true enables document signing
* @since 4.6.005 (2009-04-24)
* @since 4.6.005 (2009-04-24)
* @since 4.6.005 (2009-04-24)
* data for signature appearance
* @since 5.3.011 (2010-06-16)
* Regular expression used to find blank characters used for word-wrapping.
* @since 4.6.006 (2009-04-28)
* Array of parts $re_spaces
* @since 5.5.011 (2010-07-09)
protected $re_space = array('p' => '[^\S\xa0]', 'm' => '');
* @since 4.6.022 (2009-06-23)
* ByteRange placemark used during signature process.
* @since 4.6.028 (2009-08-25)
* Placemark used during signature process.
* @since 4.6.028 (2009-08-25)
* @since 4.7.000 (2009-08-29)
* List of form annotations IDs
* @since 4.8.000 (2009-09-07)
* 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.
* @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
* @since 4.8.000 (2009-09-07)
* Current form action (used during XHTML rendering)
* @since 4.8.000 (2009-09-07)
* Current form encryption type (used during XHTML rendering)
* @since 4.8.000 (2009-09-07)
* Current method to submit forms.
* @since 4.8.000 (2009-09-07)
* List of fonts used on form fields (fontname => fontkey).
* @since 4.8.001 (2009-09-09)
* List of radio buttons parent objects.
* @since 4.8.001 (2009-09-09)
* List of radio group objects IDs
* @since 4.8.001 (2009-09-09)
* Text indentation value (used for text-indent CSS attribute)
* @since 4.8.006 (2009-09-23)
* Store page number when startTransaction() is called.
* @since 4.8.006 (2009-09-23)
* Store Y position when startTransaction() is called.
* @since 4.9.001 (2010-03-28)
* True when we are printing the thead section on a new page
* @since 4.8.027 (2010-01-25)
* Array of column measures (width, space, starting Y position)
* @since 4.9.001 (2010-03-28)
* @since 4.9.001 (2010-03-28)
* @since 4.9.001 (2010-03-28)
* Starting page for columns
* @since 4.9.001 (2010-03-28)
* Maximum page and column selected
* @since 5.8.000 (2010-08-11)
protected $maxselcol = array('page' => 0, 'column' => 0);
* Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding
* @since 5.8.000 (2010-08-11)
protected $colxshift = array('x' => 0, 's' => 0, 'p' => 0);
* Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping.
* @since 4.9.008 (2010-04-03)
* Text stroke width in doc units
* @since 4.9.008 (2010-04-03)
* @var current stroke color
* @since 4.9.008 (2010-04-03)
* @var default unit of measure for document
* @since 5.0.000 (2010-04-22)
* @var true when we are on TOC (Table Of Content) page
* @var If true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
* @since 5.0.000 (2010-04-26)
* @var If true enables font subsetting by default
* @since 5.3.002 (2010-06-07)
* @var Array of default graphic settings
* @since 5.5.008 (2010-07-02)
* @since 5.8.014 (2010-08-23)
* @var boolean true when we are inside an XObject
* @since 5.8.017 (2010-08-24)
* @var current XObject ID
* @since 5.8.017 (2010-08-24)
* @var percentage of character stretching
* @since 5.9.000 (2010-09-29)
* @var increases or decreases the space between characters in a text by the specified amount (tracking/kerning).
* @since 5.9.000 (2010-09-29)
* @var array of no-write regions
* ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right)
* @since 5.9.003 (2010-10-14)
* @var array containing HTML color names and values
* @since 5.9.004 (2010-10-18)
* @var directory used for the last SVG image
* @since 5.0.000 (2010-05-05)
* @var Deafult unit of measure for SVG
* @since 5.0.000 (2010-05-02)
* @var array of SVG gradients
* @since 5.0.000 (2010-05-02)
* @var ID of last SVG gradient
* @since 5.0.000 (2010-05-02)
* @var true when in SVG defs group
* @since 5.0.000 (2010-05-02)
* @since 5.0.000 (2010-05-02)
* @var true when in SVG clipPath tag
* @since 5.0.000 (2010-04-26)
* @var array of SVG clipPath commands
* @since 5.0.000 (2010-05-02)
* @var array of SVG clipPath tranformation matrix
* @since 5.8.022 (2010-08-31)
* @var ID of last SVG clipPath
* @since 5.0.000 (2010-05-02)
* @since 5.0.000 (2010-05-02)
* @var svg text properties
* @since 5.8.013 (2010-08-23)
* @var array of hinheritable SVG properties
* @since 5.0.000 (2010-05-02)
protected $svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode');
* @var array of SVG properties
* @since 5.0.000 (2010-05-02)
'alignment-baseline' => 'auto',
'baseline-shift' => 'baseline',
'clip-rule' => 'nonzero',
'color-interpolation' => 'sRGB',
'color-interpolation-filters' => 'linearRGB',
'color-profile' => 'auto',
'color-rendering' => 'auto',
'dominant-baseline' => 'auto',
'enable-background' => 'accumulate',
'fill-rule' => 'nonzero',
'flood-color' => 'black',
'font-family' => 'helvetica',
'font-size-adjust' => 'none',
'font-stretch' => 'normal',
'font-style' => 'normal',
'font-variant' => 'normal',
'font-weight' => 'normal',
'glyph-orientation-horizontal' => '0deg',
'glyph-orientation-vertical' => 'auto',
'image-rendering' => 'auto',
'letter-spacing' => 'normal',
'lighting-color' => 'white',
'marker-start' => 'none',
'pointer-events' => 'visiblePainted',
'shape-rendering' => 'auto',
'stroke-dasharray' => 'none',
'stroke-dashoffset' => 0,
'stroke-linecap' => 'butt',
'stroke-linejoin' => 'miter',
'stroke-miterlimit' => 4,
'text-anchor' => 'start',
'text-decoration' => 'none',
'text-rendering' => 'auto',
'unicode-bidi' => 'normal',
'visibility' => 'visible',
'word-spacing' => 'normal',
'writing-mode' => 'lr-tb',
'transfmatrix' => array(1, 0, 0, 1, 0, 0)
//------------------------------------------------------------
//------------------------------------------------------------
* This is the class constructor.
* It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
* @param string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
* @param string $unit User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
* @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param boolean $unicode TRUE means that the input text is unicode (default = true)
* @param boolean $diskcache if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).
* @param String $encoding charset encoding; default is UTF-8
* @see getPageSizeFromFormat(), setPageFormat()
public function __construct($orientation= 'P', $unit= 'mm', $format= 'A4', $unicode= true, $encoding= 'UTF-8', $diskcache= false) {
/* Set internal character encoding to ASCII */
require (dirname(__FILE__ ). '/htmlcolors.php');
require_once(dirname(__FILE__ ). '/unicode_data.php');
$this->diskcache = $diskcache ? true : false;
// set language direction
// initialization of properties
// standard Unicode fonts
'courierB'=> 'Courier-Bold',
'courierI'=> 'Courier-Oblique',
'courierBI'=> 'Courier-BoldOblique',
'helvetica'=> 'Helvetica',
'helveticaB'=> 'Helvetica-Bold',
'helveticaI'=> 'Helvetica-Oblique',
'helveticaBI'=> 'Helvetica-BoldOblique',
'timesI'=> 'Times-Italic',
'timesBI'=> 'Times-BoldItalic',
'zapfdingbats'=> 'ZapfDingbats'
// set page format and orientation
$margin = 28.35 / $this->k;
$cpadding = $margin / 10;
// full width display mode
// set default PDF version number
$this->fgcolor = array('R' => 0, 'G' => 0, 'B' => 0);
$this->strokecolor = array('R' => 0, 'G' => 0, 'B' => 0);
$this->bgcolor = array('R' => 255, 'G' => 255, 'B' => 255);
$this->ur['enabled'] = 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['ef'] = '/Create/Delete/Modify/Import';
$this->ur['formex'] = '';
// set default JPEG quality
// initialize some settings
// check if PCRE Unicode support is enabled
// 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->setSpacesRE('/[^\S\P{Z}\P{Lo}\xa0]/u');
// PCRE unicode support is turned OFF
$this->default_form_prop = array('lineWidth'=> 1, 'borderStyle'=> 'solid', 'fillColor'=> array(255, 255, 255), 'strokeColor'=> array(128, 128, 128));
// set file ID for trailer
// get default graphic vars
// restore internal encoding
// unset all class variables
* Set the units of measure for the document.
* @param string $unit User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />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.
* @since 3.0.015 (2008-06-06)
$this->k = $this->dpi / 25.4;
$this->k = $this->dpi / 2.54;
$this->Error('Incorrect unit: '. $unit);
* Get page dimensions from format name.
* @param mixed $format The format name. It can be: <ul>
* <li><b>ISO 216 A Series + 2 SIS 014711 extensions</b></li>
* <li>A0 (841x1189 mm ; 33.11x46.81 in)</li>
* <li>A1 (594x841 mm ; 23.39x33.11 in)</li>
* <li>A2 (420x594 mm ; 16.54x23.39 in)</li>
* <li>A3 (297x420 mm ; 11.69x16.54 in)</li>
* <li>A4 (210x297 mm ; 8.27x11.69 in)</li>
* <li>A5 (148x210 mm ; 5.83x8.27 in)</li>
* <li>A6 (105x148 mm ; 4.13x5.83 in)</li>
* <li>A7 (74x105 mm ; 2.91x4.13 in)</li>
* <li>A8 (52x74 mm ; 2.05x2.91 in)</li>
* <li>A9 (37x52 mm ; 1.46x2.05 in)</li>
* <li>A10 (26x37 mm ; 1.02x1.46 in)</li>
* <li>A11 (18x26 mm ; 0.71x1.02 in)</li>
* <li>A12 (13x18 mm ; 0.51x0.71 in)</li>
* <li><b>ISO 216 B Series + 2 SIS 014711 extensions</b></li>
* <li>B0 (1000x1414 mm ; 39.37x55.67 in)</li>
* <li>B1 (707x1000 mm ; 27.83x39.37 in)</li>
* <li>B2 (500x707 mm ; 19.69x27.83 in)</li>
* <li>B3 (353x500 mm ; 13.90x19.69 in)</li>
* <li>B4 (250x353 mm ; 9.84x13.90 in)</li>
* <li>B5 (176x250 mm ; 6.93x9.84 in)</li>
* <li>B6 (125x176 mm ; 4.92x6.93 in)</li>
* <li>B7 (88x125 mm ; 3.46x4.92 in)</li>
* <li>B8 (62x88 mm ; 2.44x3.46 in)</li>
* <li>B9 (44x62 mm ; 1.73x2.44 in)</li>
* <li>B10 (31x44 mm ; 1.22x1.73 in)</li>
* <li>B11 (22x31 mm ; 0.87x1.22 in)</li>
* <li>B12 (15x22 mm ; 0.59x0.87 in)</li>
* <li><b>ISO 216 C Series + 2 SIS 014711 extensions + 2 EXTENSION</b></li>
* <li>C0 (917x1297 mm ; 36.10x51.06 in)</li>
* <li>C1 (648x917 mm ; 25.51x36.10 in)</li>
* <li>C2 (458x648 mm ; 18.03x25.51 in)</li>
* <li>C3 (324x458 mm ; 12.76x18.03 in)</li>
* <li>C4 (229x324 mm ; 9.02x12.76 in)</li>
* <li>C5 (162x229 mm ; 6.38x9.02 in)</li>
* <li>C6 (114x162 mm ; 4.49x6.38 in)</li>
* <li>C7 (81x114 mm ; 3.19x4.49 in)</li>
* <li>C8 (57x81 mm ; 2.24x3.19 in)</li>
* <li>C9 (40x57 mm ; 1.57x2.24 in)</li>
* <li>C10 (28x40 mm ; 1.10x1.57 in)</li>
* <li>C11 (20x28 mm ; 0.79x1.10 in)</li>
* <li>C12 (14x20 mm ; 0.55x0.79 in)</li>
* <li>C76 (81x162 mm ; 3.19x6.38 in)</li>
* <li>DL (110x220 mm ; 4.33x8.66 in)</li>
* <li><b>SIS 014711 E Series</b></li>
* <li>E0 (879x1241 mm ; 34.61x48.86 in)</li>
* <li>E1 (620x879 mm ; 24.41x34.61 in)</li>
* <li>E2 (440x620 mm ; 17.32x24.41 in)</li>
* <li>E3 (310x440 mm ; 12.20x17.32 in)</li>
* <li>E4 (220x310 mm ; 8.66x12.20 in)</li>
* <li>E5 (155x220 mm ; 6.10x8.66 in)</li>
* <li>E6 (110x155 mm ; 4.33x6.10 in)</li>
* <li>E7 (78x110 mm ; 3.07x4.33 in)</li>
* <li>E8 (55x78 mm ; 2.17x3.07 in)</li>
* <li>E9 (39x55 mm ; 1.54x2.17 in)</li>
* <li>E10 (27x39 mm ; 1.06x1.54 in)</li>
* <li>E11 (19x27 mm ; 0.75x1.06 in)</li>
* <li>E12 (13x19 mm ; 0.51x0.75 in)</li>
* <li><b>SIS 014711 G Series</b></li>
* <li>G0 (958x1354 mm ; 37.72x53.31 in)</li>
* <li>G1 (677x958 mm ; 26.65x37.72 in)</li>
* <li>G2 (479x677 mm ; 18.86x26.65 in)</li>
* <li>G3 (338x479 mm ; 13.31x18.86 in)</li>
* <li>G4 (239x338 mm ; 9.41x13.31 in)</li>
* <li>G5 (169x239 mm ; 6.65x9.41 in)</li>
* <li>G6 (119x169 mm ; 4.69x6.65 in)</li>
* <li>G7 (84x119 mm ; 3.31x4.69 in)</li>
* <li>G8 (59x84 mm ; 2.32x3.31 in)</li>
* <li>G9 (42x59 mm ; 1.65x2.32 in)</li>
* <li>G10 (29x42 mm ; 1.14x1.65 in)</li>
* <li>G11 (21x29 mm ; 0.83x1.14 in)</li>
* <li>G12 (14x21 mm ; 0.55x0.83 in)</li>
* <li><b>ISO Press</b></li>
* <li>RA0 (860x1220 mm ; 33.86x48.03 in)</li>
* <li>RA1 (610x860 mm ; 24.02x33.86 in)</li>
* <li>RA2 (430x610 mm ; 16.93x24.02 in)</li>
* <li>RA3 (305x430 mm ; 12.01x16.93 in)</li>
* <li>RA4 (215x305 mm ; 8.46x12.01 in)</li>
* <li>SRA0 (900x1280 mm ; 35.43x50.39 in)</li>
* <li>SRA1 (640x900 mm ; 25.20x35.43 in)</li>
* <li>SRA2 (450x640 mm ; 17.72x25.20 in)</li>
* <li>SRA3 (320x450 mm ; 12.60x17.72 in)</li>
* <li>SRA4 (225x320 mm ; 8.86x12.60 in)</li>
* <li><b>German DIN 476</b></li>
* <li>4A0 (1682x2378 mm ; 66.22x93.62 in)</li>
* <li>2A0 (1189x1682 mm ; 46.81x66.22 in)</li>
* <li><b>Variations on the ISO Standard</b></li>
* <li>A2_EXTRA (445x619 mm ; 17.52x24.37 in)</li>
* <li>A3+ (329x483 mm ; 12.95x19.02 in)</li>
* <li>A3_EXTRA (322x445 mm ; 12.68x17.52 in)</li>
* <li>A3_SUPER (305x508 mm ; 12.01x20.00 in)</li>
* <li>SUPER_A3 (305x487 mm ; 12.01x19.17 in)</li>
* <li>A4_EXTRA (235x322 mm ; 9.25x12.68 in)</li>
* <li>A4_SUPER (229x322 mm ; 9.02x12.68 in)</li>
* <li>SUPER_A4 (227x356 mm ; 8.94x14.02 in)</li>
* <li>A4_LONG (210x348 mm ; 8.27x13.70 in)</li>
* <li>F4 (210x330 mm ; 8.27x12.99 in)</li>
* <li>SO_B5_EXTRA (202x276 mm ; 7.95x10.87 in)</li>
* <li>A5_EXTRA (173x235 mm ; 6.81x9.25 in)</li>
* <li><b>ANSI Series</b></li>
* <li>ANSI_E (864x1118 mm ; 34.00x44.00 in)</li>
* <li>ANSI_D (559x864 mm ; 22.00x34.00 in)</li>
* <li>ANSI_C (432x559 mm ; 17.00x22.00 in)</li>
* <li>ANSI_B (279x432 mm ; 11.00x17.00 in)</li>
* <li>ANSI_A (216x279 mm ; 8.50x11.00 in)</li>
* <li><b>Traditional 'Loose' North American Paper Sizes</b></li>
* <li>LEDGER, USLEDGER (432x279 mm ; 17.00x11.00 in)</li>
* <li>TABLOID, USTABLOID, BIBLE, ORGANIZERK (279x432 mm ; 11.00x17.00 in)</li>
* <li>LETTER, USLETTER, ORGANIZERM (216x279 mm ; 8.50x11.00 in)</li>
* <li>LEGAL, USLEGAL (216x356 mm ; 8.50x14.00 in)</li>
* <li>GLETTER, GOVERNMENTLETTER (203x267 mm ; 8.00x10.50 in)</li>
* <li>JLEGAL, JUNIORLEGAL (203x127 mm ; 8.00x5.00 in)</li>
* <li><b>Other North American Paper Sizes</b></li>
* <li>QUADDEMY (889x1143 mm ; 35.00x45.00 in)</li>
* <li>SUPER_B (330x483 mm ; 13.00x19.00 in)</li>
* <li>QUARTO (229x279 mm ; 9.00x11.00 in)</li>
* <li>FOLIO, GOVERNMENTLEGAL (216x330 mm ; 8.50x13.00 in)</li>
* <li>EXECUTIVE, MONARCH (184x267 mm ; 7.25x10.50 in)</li>
* <li>MEMO, STATEMENT, ORGANIZERL (140x216 mm ; 5.50x8.50 in)</li>
* <li>FOOLSCAP (210x330 mm ; 8.27x13.00 in)</li>
* <li>COMPACT (108x171 mm ; 4.25x6.75 in)</li>
* <li>ORGANIZERJ (70x127 mm ; 2.75x5.00 in)</li>
* <li><b>Canadian standard CAN 2-9.60M</b></li>
* <li>P1 (560x860 mm ; 22.05x33.86 in)</li>
* <li>P2 (430x560 mm ; 16.93x22.05 in)</li>
* <li>P3 (280x430 mm ; 11.02x16.93 in)</li>
* <li>P4 (215x280 mm ; 8.46x11.02 in)</li>
* <li>P5 (140x215 mm ; 5.51x8.46 in)</li>
* <li>P6 (107x140 mm ; 4.21x5.51 in)</li>
* <li><b>North American Architectural Sizes</b></li>
* <li>ARCH_E (914x1219 mm ; 36.00x48.00 in)</li>
* <li>ARCH_E1 (762x1067 mm ; 30.00x42.00 in)</li>
* <li>ARCH_D (610x914 mm ; 24.00x36.00 in)</li>
* <li>ARCH_C, BROADSHEET (457x610 mm ; 18.00x24.00 in)</li>
* <li>ARCH_B (305x457 mm ; 12.00x18.00 in)</li>
* <li>ARCH_A (229x305 mm ; 9.00x12.00 in)</li>
* <li><b>Announcement Envelopes</b></li>
* <li>ANNENV_A2 (111x146 mm ; 4.37x5.75 in)</li>
* <li>ANNENV_A6 (121x165 mm ; 4.75x6.50 in)</li>
* <li>ANNENV_A7 (133x184 mm ; 5.25x7.25 in)</li>
* <li>ANNENV_A8 (140x206 mm ; 5.50x8.12 in)</li>
* <li>ANNENV_A10 (159x244 mm ; 6.25x9.62 in)</li>
* <li>ANNENV_SLIM (98x225 mm ; 3.87x8.87 in)</li>
* <li><b>Commercial Envelopes</b></li>
* <li>COMMENV_N6_1/4 (89x152 mm ; 3.50x6.00 in)</li>
* <li>COMMENV_N6_3/4 (92x165 mm ; 3.62x6.50 in)</li>
* <li>COMMENV_N8 (98x191 mm ; 3.87x7.50 in)</li>
* <li>COMMENV_N9 (98x225 mm ; 3.87x8.87 in)</li>
* <li>COMMENV_N10 (105x241 mm ; 4.12x9.50 in)</li>
* <li>COMMENV_N11 (114x263 mm ; 4.50x10.37 in)</li>
* <li>COMMENV_N12 (121x279 mm ; 4.75x11.00 in)</li>
* <li>COMMENV_N14 (127x292 mm ; 5.00x11.50 in)</li>
* <li><b>Catalogue Envelopes</b></li>
* <li>CATENV_N1 (152x229 mm ; 6.00x9.00 in)</li>
* <li>CATENV_N1_3/4 (165x241 mm ; 6.50x9.50 in)</li>
* <li>CATENV_N2 (165x254 mm ; 6.50x10.00 in)</li>
* <li>CATENV_N3 (178x254 mm ; 7.00x10.00 in)</li>
* <li>CATENV_N6 (191x267 mm ; 7.50x10.50 in)</li>
* <li>CATENV_N7 (203x279 mm ; 8.00x11.00 in)</li>
* <li>CATENV_N8 (210x286 mm ; 8.25x11.25 in)</li>
* <li>CATENV_N9_1/2 (216x267 mm ; 8.50x10.50 in)</li>
* <li>CATENV_N9_3/4 (222x286 mm ; 8.75x11.25 in)</li>
* <li>CATENV_N10_1/2 (229x305 mm ; 9.00x12.00 in)</li>
* <li>CATENV_N12_1/2 (241x318 mm ; 9.50x12.50 in)</li>
* <li>CATENV_N13_1/2 (254x330 mm ; 10.00x13.00 in)</li>
* <li>CATENV_N14_1/4 (286x311 mm ; 11.25x12.25 in)</li>
* <li>CATENV_N14_1/2 (292x368 mm ; 11.50x14.50 in)</li>
* <li><b>Japanese (JIS P 0138-61) Standard B-Series</b></li>
* <li>JIS_B0 (1030x1456 mm ; 40.55x57.32 in)</li>
* <li>JIS_B1 (728x1030 mm ; 28.66x40.55 in)</li>
* <li>JIS_B2 (515x728 mm ; 20.28x28.66 in)</li>
* <li>JIS_B3 (364x515 mm ; 14.33x20.28 in)</li>
* <li>JIS_B4 (257x364 mm ; 10.12x14.33 in)</li>
* <li>JIS_B5 (182x257 mm ; 7.17x10.12 in)</li>
* <li>JIS_B6 (128x182 mm ; 5.04x7.17 in)</li>
* <li>JIS_B7 (91x128 mm ; 3.58x5.04 in)</li>
* <li>JIS_B8 (64x91 mm ; 2.52x3.58 in)</li>
* <li>JIS_B9 (45x64 mm ; 1.77x2.52 in)</li>
* <li>JIS_B10 (32x45 mm ; 1.26x1.77 in)</li>
* <li>JIS_B11 (22x32 mm ; 0.87x1.26 in)</li>
* <li>JIS_B12 (16x22 mm ; 0.63x0.87 in)</li>
* <li><b>PA Series</b></li>
* <li>PA0 (840x1120 mm ; 33.07x44.09 in)</li>
* <li>PA1 (560x840 mm ; 22.05x33.07 in)</li>
* <li>PA2 (420x560 mm ; 16.54x22.05 in)</li>
* <li>PA3 (280x420 mm ; 11.02x16.54 in)</li>
* <li>PA4 (210x280 mm ; 8.27x11.02 in)</li>
* <li>PA5 (140x210 mm ; 5.51x8.27 in)</li>
* <li>PA6 (105x140 mm ; 4.13x5.51 in)</li>
* <li>PA7 (70x105 mm ; 2.76x4.13 in)</li>
* <li>PA8 (52x70 mm ; 2.05x2.76 in)</li>
* <li>PA9 (35x52 mm ; 1.38x2.05 in)</li>
* <li>PA10 (26x35 mm ; 1.02x1.38 in)</li>
* <li><b>Standard Photographic Print Sizes</b></li>
* <li>PASSPORT_PHOTO (35x45 mm ; 1.38x1.77 in)</li>
* <li>E (82x120 mm ; 3.25x4.72 in)</li>
* <li>3R, L (89x127 mm ; 3.50x5.00 in)</li>
* <li>4R, KG (102x152 mm ; 4.02x5.98 in)</li>
* <li>4D (120x152 mm ; 4.72x5.98 in)</li>
* <li>5R, 2L (127x178 mm ; 5.00x7.01 in)</li>
* <li>6R, 8P (152x203 mm ; 5.98x7.99 in)</li>
* <li>8R, 6P (203x254 mm ; 7.99x10.00 in)</li>
* <li>S8R, 6PW (203x305 mm ; 7.99x12.01 in)</li>
* <li>10R, 4P (254x305 mm ; 10.00x12.01 in)</li>
* <li>S10R, 4PW (254x381 mm ; 10.00x15.00 in)</li>
* <li>11R (279x356 mm ; 10.98x14.02 in)</li>
* <li>S11R (279x432 mm ; 10.98x17.01 in)</li>
* <li>12R (305x381 mm ; 12.01x15.00 in)</li>
* <li>S12R (305x456 mm ; 12.01x17.95 in)</li>
* <li><b>Common Newspaper Sizes</b></li>
* <li>NEWSPAPER_BROADSHEET (750x600 mm ; 29.53x23.62 in)</li>
* <li>NEWSPAPER_BERLINER (470x315 mm ; 18.50x12.40 in)</li>
* <li>NEWSPAPER_COMPACT, NEWSPAPER_TABLOID (430x280 mm ; 16.93x11.02 in)</li>
* <li><b>Business Cards</b></li>
* <li>CREDIT_CARD, BUSINESS_CARD, BUSINESS_CARD_ISO7810 (54x86 mm ; 2.13x3.37 in)</li>
* <li>BUSINESS_CARD_ISO216 (52x74 mm ; 2.05x2.91 in)</li>
* <li>BUSINESS_CARD_IT, BUSINESS_CARD_UK, BUSINESS_CARD_FR, BUSINESS_CARD_DE, BUSINESS_CARD_ES (55x85 mm ; 2.17x3.35 in)</li>
* <li>BUSINESS_CARD_US, BUSINESS_CARD_CA (51x89 mm ; 2.01x3.50 in)</li>
* <li>BUSINESS_CARD_JP (55x91 mm ; 2.17x3.58 in)</li>
* <li>BUSINESS_CARD_HK (54x90 mm ; 2.13x3.54 in)</li>
* <li>BUSINESS_CARD_AU, BUSINESS_CARD_DK, BUSINESS_CARD_SE (55x90 mm ; 2.17x3.54 in)</li>
* <li>BUSINESS_CARD_RU, BUSINESS_CARD_CZ, BUSINESS_CARD_FI, BUSINESS_CARD_HU, BUSINESS_CARD_IL (50x90 mm ; 1.97x3.54 in)</li>
* <li><b>Billboards</b></li>
* <li>4SHEET (1016x1524 mm ; 40.00x60.00 in)</li>
* <li>6SHEET (1200x1800 mm ; 47.24x70.87 in)</li>
* <li>12SHEET (3048x1524 mm ; 120.00x60.00 in)</li>
* <li>16SHEET (2032x3048 mm ; 80.00x120.00 in)</li>
* <li>32SHEET (4064x3048 mm ; 160.00x120.00 in)</li>
* <li>48SHEET (6096x3048 mm ; 240.00x120.00 in)</li>
* <li>64SHEET (8128x3048 mm ; 320.00x120.00 in)</li>
* <li>96SHEET (12192x3048 mm ; 480.00x120.00 in)</li>
* <li><b>Old Imperial English (some are still used in USA)</b></li>
* <li>EN_EMPEROR (1219x1829 mm ; 48.00x72.00 in)</li>
* <li>EN_ANTIQUARIAN (787x1346 mm ; 31.00x53.00 in)</li>
* <li>EN_GRAND_EAGLE (730x1067 mm ; 28.75x42.00 in)</li>
* <li>EN_DOUBLE_ELEPHANT (679x1016 mm ; 26.75x40.00 in)</li>
* <li>EN_ATLAS (660x864 mm ; 26.00x34.00 in)</li>
* <li>EN_COLOMBIER (597x876 mm ; 23.50x34.50 in)</li>
* <li>EN_ELEPHANT (584x711 mm ; 23.00x28.00 in)</li>
* <li>EN_DOUBLE_DEMY (572x902 mm ; 22.50x35.50 in)</li>
* <li>EN_IMPERIAL (559x762 mm ; 22.00x30.00 in)</li>
* <li>EN_PRINCESS (546x711 mm ; 21.50x28.00 in)</li>
* <li>EN_CARTRIDGE (533x660 mm ; 21.00x26.00 in)</li>
* <li>EN_DOUBLE_LARGE_POST (533x838 mm ; 21.00x33.00 in)</li>
* <li>EN_ROYAL (508x635 mm ; 20.00x25.00 in)</li>
* <li>EN_SHEET, EN_HALF_POST (495x597 mm ; 19.50x23.50 in)</li>
* <li>EN_SUPER_ROYAL (483x686 mm ; 19.00x27.00 in)</li>
* <li>EN_DOUBLE_POST (483x775 mm ; 19.00x30.50 in)</li>
* <li>EN_MEDIUM (445x584 mm ; 17.50x23.00 in)</li>
* <li>EN_DEMY (445x572 mm ; 17.50x22.50 in)</li>
* <li>EN_LARGE_POST (419x533 mm ; 16.50x21.00 in)</li>
* <li>EN_COPY_DRAUGHT (406x508 mm ; 16.00x20.00 in)</li>
* <li>EN_POST (394x489 mm ; 15.50x19.25 in)</li>
* <li>EN_CROWN (381x508 mm ; 15.00x20.00 in)</li>
* <li>EN_PINCHED_POST (375x470 mm ; 14.75x18.50 in)</li>
* <li>EN_BRIEF (343x406 mm ; 13.50x16.00 in)</li>
* <li>EN_FOOLSCAP (343x432 mm ; 13.50x17.00 in)</li>
* <li>EN_SMALL_FOOLSCAP (337x419 mm ; 13.25x16.50 in)</li>
* <li>EN_POTT (318x381 mm ; 12.50x15.00 in)</li>
* <li><b>Old Imperial Belgian</b></li>
* <li>BE_GRAND_AIGLE (700x1040 mm ; 27.56x40.94 in)</li>
* <li>BE_COLOMBIER (620x850 mm ; 24.41x33.46 in)</li>
* <li>BE_DOUBLE_CARRE (620x920 mm ; 24.41x36.22 in)</li>
* <li>BE_ELEPHANT (616x770 mm ; 24.25x30.31 in)</li>
* <li>BE_PETIT_AIGLE (600x840 mm ; 23.62x33.07 in)</li>
* <li>BE_GRAND_JESUS (550x730 mm ; 21.65x28.74 in)</li>
* <li>BE_JESUS (540x730 mm ; 21.26x28.74 in)</li>
* <li>BE_RAISIN (500x650 mm ; 19.69x25.59 in)</li>
* <li>BE_GRAND_MEDIAN (460x605 mm ; 18.11x23.82 in)</li>
* <li>BE_DOUBLE_POSTE (435x565 mm ; 17.13x22.24 in)</li>
* <li>BE_COQUILLE (430x560 mm ; 16.93x22.05 in)</li>
* <li>BE_PETIT_MEDIAN (415x530 mm ; 16.34x20.87 in)</li>
* <li>BE_RUCHE (360x460 mm ; 14.17x18.11 in)</li>
* <li>BE_PROPATRIA (345x430 mm ; 13.58x16.93 in)</li>
* <li>BE_LYS (317x397 mm ; 12.48x15.63 in)</li>
* <li>BE_POT (307x384 mm ; 12.09x15.12 in)</li>
* <li>BE_ROSETTE (270x347 mm ; 10.63x13.66 in)</li>
* <li><b>Old Imperial French</b></li>
* <li>FR_UNIVERS (1000x1300 mm ; 39.37x51.18 in)</li>
* <li>FR_DOUBLE_COLOMBIER (900x1260 mm ; 35.43x49.61 in)</li>
* <li>FR_GRANDE_MONDE (900x1260 mm ; 35.43x49.61 in)</li>
* <li>FR_DOUBLE_SOLEIL (800x1200 mm ; 31.50x47.24 in)</li>
* <li>FR_DOUBLE_JESUS (760x1120 mm ; 29.92x44.09 in)</li>
* <li>FR_GRAND_AIGLE (750x1060 mm ; 29.53x41.73 in)</li>
* <li>FR_PETIT_AIGLE (700x940 mm ; 27.56x37.01 in)</li>
* <li>FR_DOUBLE_RAISIN (650x1000 mm ; 25.59x39.37 in)</li>
* <li>FR_JOURNAL (650x940 mm ; 25.59x37.01 in)</li>
* <li>FR_COLOMBIER_AFFICHE (630x900 mm ; 24.80x35.43 in)</li>
* <li>FR_DOUBLE_CAVALIER (620x920 mm ; 24.41x36.22 in)</li>
* <li>FR_CLOCHE (600x800 mm ; 23.62x31.50 in)</li>
* <li>FR_SOLEIL (600x800 mm ; 23.62x31.50 in)</li>
* <li>FR_DOUBLE_CARRE (560x900 mm ; 22.05x35.43 in)</li>
* <li>FR_DOUBLE_COQUILLE (560x880 mm ; 22.05x34.65 in)</li>
* <li>FR_JESUS (560x760 mm ; 22.05x29.92 in)</li>
* <li>FR_RAISIN (500x650 mm ; 19.69x25.59 in)</li>
* <li>FR_CAVALIER (460x620 mm ; 18.11x24.41 in)</li>
* <li>FR_DOUBLE_COURONNE (460x720 mm ; 18.11x28.35 in)</li>
* <li>FR_CARRE (450x560 mm ; 17.72x22.05 in)</li>
* <li>FR_COQUILLE (440x560 mm ; 17.32x22.05 in)</li>
* <li>FR_DOUBLE_TELLIERE (440x680 mm ; 17.32x26.77 in)</li>
* <li>FR_DOUBLE_CLOCHE (400x600 mm ; 15.75x23.62 in)</li>
* <li>FR_DOUBLE_POT (400x620 mm ; 15.75x24.41 in)</li>
* <li>FR_ECU (400x520 mm ; 15.75x20.47 in)</li>
* <li>FR_COURONNE (360x460 mm ; 14.17x18.11 in)</li>
* <li>FR_TELLIERE (340x440 mm ; 13.39x17.32 in)</li>
* <li>FR_POT (310x400 mm ; 12.20x15.75 in)</li>
* @return array containing page width and height in points
* @since 5.0.010 (2010-05-17)
// Paper cordinates are calculated in this way: (inches * 72) where (1 inch = 25.4 mm)
// ISO 216 A Series + 2 SIS 014711 extensions
case 'A0' : {$pf = array( 2383.937, 3370.394); break;}
case 'A1' : {$pf = array( 1683.780, 2383.937); break;}
case 'A2' : {$pf = array( 1190.551, 1683.780); break;}
case 'A3' : {$pf = array( 841.890, 1190.551); break;}
case 'A4' : {$pf = array( 595.276, 841.890); break;}
case 'A5' : {$pf = array( 419.528, 595.276); break;}
case 'A6' : {$pf = array( 297.638, 419.528); break;}
case 'A7' : {$pf = array( 209.764, 297.638); break;}
case 'A8' : {$pf = array( 147.402, 209.764); break;}
case 'A9' : {$pf = array( 104.882, 147.402); break;}
case 'A10': {$pf = array( 73.701, 104.882); break;}
case 'A11': {$pf = array( 51.024, 73.701); break;}
case 'A12': {$pf = array( 36.850, 51.024); break;}
// ISO 216 B Series + 2 SIS 014711 extensions
case 'B0' : {$pf = array( 2834.646, 4008.189); break;}
case 'B1' : {$pf = array( 2004.094, 2834.646); break;}
case 'B2' : {$pf = array( 1417.323, 2004.094); break;}
case 'B3' : {$pf = array( 1000.630, 1417.323); break;}
case 'B4' : {$pf = array( 708.661, 1000.630); break;}
case 'B5' : {$pf = array( 498.898, 708.661); break;}
case 'B6' : {$pf = array( 354.331, 498.898); break;}
case 'B7' : {$pf = array( 249.449, 354.331); break;}
case 'B8' : {$pf = array( 175.748, 249.449); break;}
case 'B9' : {$pf = array( 124.724, 175.748); break;}
case 'B10': {$pf = array( 87.874, 124.724); break;}
case 'B11': {$pf = array( 62.362, 87.874); break;}
case 'B12': {$pf = array( 42.520, 62.362); break;}
// ISO 216 C Series + 2 SIS 014711 extensions + 2 EXTENSION
case 'C0' : {$pf = array( 2599.370, 3676.535); break;}
case 'C1' : {$pf = array( 1836.850, 2599.370); break;}
case 'C2' : {$pf = array( 1298.268, 1836.850); break;}
case 'C3' : {$pf = array( 918.425, 1298.268); break;}
case 'C4' : {$pf = array( 649.134, 918.425); break;}
case 'C5' : {$pf = array( 459.213, 649.134); break;}
case 'C6' : {$pf = array( 323.150, 459.213); break;}
case 'C7' : {$pf = array( 229.606, 323.150); break;}
case 'C8' : {$pf = array( 161.575, 229.606); break;}
case 'C9' : {$pf = array( 113.386, 161.575); break;}
case 'C10': {$pf = array( 79.370, 113.386); break;}
case 'C11': {$pf = array( 56.693, 79.370); break;}
case 'C12': {$pf = array( 39.685, 56.693); break;}
case 'C76': {$pf = array( 229.606, 459.213); break;}
case 'DL' : {$pf = array( 311.811, 623.622); break;}
case 'E0' : {$pf = array( 2491.654, 3517.795); break;}
case 'E1' : {$pf = array( 1757.480, 2491.654); break;}
case 'E2' : {$pf = array( 1247.244, 1757.480); break;}
case 'E3' : {$pf = array( 878.740, 1247.244); break;}
case 'E4' : {$pf = array( 623.622, 878.740); break;}
case 'E5' : {$pf = array( 439.370, 623.622); break;}
case 'E6' : {$pf = array( 311.811, 439.370); break;}
case 'E7' : {$pf = array( 221.102, 311.811); break;}
case 'E8' : {$pf = array( 155.906, 221.102); break;}
case 'E9' : {$pf = array( 110.551, 155.906); break;}
case 'E10': {$pf = array( 76.535, 110.551); break;}
case 'E11': {$pf = array( 53.858, 76.535); break;}
case 'E12': {$pf = array( 36.850, 53.858); break;}
case 'G0' : {$pf = array( 2715.591, 3838.110); break;}
case 'G1' : {$pf = array( 1919.055, 2715.591); break;}
case 'G2' : {$pf = array( 1357.795, 1919.055); break;}
case 'G3' : {$pf = array( 958.110, 1357.795); break;}
case 'G4' : {$pf = array( 677.480, 958.110); break;}
case 'G5' : {$pf = array( 479.055, 677.480); break;}
case 'G6' : {$pf = array( 337.323, 479.055); break;}
case 'G7' : {$pf = array( 238.110, 337.323); break;}
case 'G8' : {$pf = array( 167.244, 238.110); break;}
case 'G9' : {$pf = array( 119.055, 167.244); break;}
case 'G10': {$pf = array( 82.205, 119.055); break;}
case 'G11': {$pf = array( 59.528, 82.205); break;}
case 'G12': {$pf = array( 39.685, 59.528); break;}
case 'RA0': {$pf = array( 2437.795, 3458.268); break;}
case 'RA1': {$pf = array( 1729.134, 2437.795); break;}
case 'RA2': {$pf = array( 1218.898, 1729.134); break;}
case 'RA3': {$pf = array( 864.567, 1218.898); break;}
case 'RA4': {$pf = array( 609.449, 864.567); break;}
case 'SRA0': {$pf = array( 2551.181, 3628.346); break;}
case 'SRA1': {$pf = array( 1814.173, 2551.181); break;}
case 'SRA2': {$pf = array( 1275.591, 1814.173); break;}
case 'SRA3': {$pf = array( 907.087, 1275.591); break;}
case 'SRA4': {$pf = array( 637.795, 907.087); break;}
case '4A0': {$pf = array( 4767.874, 6740.787); break;}
case '2A0': {$pf = array( 3370.394, 4767.874); break;}
// Variations on the ISO Standard
case 'A2_EXTRA' : {$pf = array( 1261.417, 1754.646); break;}
case 'A3+' : {$pf = array( 932.598, 1369.134); break;}
case 'A3_EXTRA' : {$pf = array( 912.756, 1261.417); break;}
case 'A3_SUPER' : {$pf = array( 864.567, 1440.000); break;}
case 'SUPER_A3' : {$pf = array( 864.567, 1380.472); break;}
case 'A4_EXTRA' : {$pf = array( 666.142, 912.756); break;}
case 'A4_SUPER' : {$pf = array( 649.134, 912.756); break;}
case 'SUPER_A4' : {$pf = array( 643.465, 1009.134); break;}
case 'A4_LONG' : {$pf = array( 595.276, 986.457); break;}
case 'F4' : {$pf = array( 595.276, 935.433); break;}
case 'SO_B5_EXTRA': {$pf = array( 572.598, 782.362); break;}
case 'A5_EXTRA' : {$pf = array( 490.394, 666.142); break;}
case 'ANSI_E': {$pf = array( 2448.000, 3168.000); break;}
case 'ANSI_D': {$pf = array( 1584.000, 2448.000); break;}
case 'ANSI_C': {$pf = array( 1224.000, 1584.000); break;}
case 'ANSI_B': {$pf = array( 792.000, 1224.000); break;}
case 'ANSI_A': {$pf = array( 612.000, 792.000); break;}
// Traditional 'Loose' North American Paper Sizes
case 'LEDGER' : {$pf = array( 1224.000, 792.000); break;}
case 'TABLOID': {$pf = array( 792.000, 1224.000); break;}
case 'LETTER' : {$pf = array( 612.000, 792.000); break;}
case 'LEGAL' : {$pf = array( 612.000, 1008.000); break;}
case 'GLETTER': {$pf = array( 576.000, 756.000); break;}
case 'JLEGAL' : {$pf = array( 576.000, 360.000); break;}
// Other North American Paper Sizes
case 'QUADDEMY': {$pf = array( 2520.000, 3240.000); break;}
case 'SUPER_B': {$pf = array( 936.000, 1368.000); break;}
case 'QUARTO': {$pf = array( 648.000, 792.000); break;}
case 'FOLIO': {$pf = array( 612.000, 936.000); break;}
case 'EXECUTIVE': {$pf = array( 522.000, 756.000); break;}
case 'MEMO': {$pf = array( 396.000, 612.000); break;}
case 'FOOLSCAP': {$pf = array( 595.440, 936.000); break;}
case 'COMPACT': {$pf = array( 306.000, 486.000); break;}
case 'ORGANIZERJ': {$pf = array( 198.000, 360.000); break;}
// Canadian standard CAN 2-9.60M
case 'P1': {$pf = array( 1587.402, 2437.795); break;}
case 'P2': {$pf = array( 1218.898, 1587.402); break;}
case 'P3': {$pf = array( 793.701, 1218.898); break;}
case 'P4': {$pf = array( 609.449, 793.701); break;}
case 'P5': {$pf = array( 396.850, 609.449); break;}
case 'P6': {$pf = array( 303.307, 396.850); break;}
// North American Architectural Sizes
case 'ARCH_E' : {$pf = array( 2592.000, 3456.000); break;}
case 'ARCH_E1': {$pf = array( 2160.000, 3024.000); break;}
case 'ARCH_D' : {$pf = array( 1728.000, 2592.000); break;}
case 'ARCH_C' : {$pf = array( 1296.000, 1728.000); break;}
case 'ARCH_B' : {$pf = array( 864.000, 1296.000); break;}
case 'ARCH_A' : {$pf = array( 648.000, 864.000); break;}
// --- North American Envelope Sizes ---
// - Announcement Envelopes
case 'ANNENV_A2' : {$pf = array( 314.640, 414.000); break;}
case 'ANNENV_A6' : {$pf = array( 342.000, 468.000); break;}
case 'ANNENV_A7' : {$pf = array( 378.000, 522.000); break;}
case 'ANNENV_A8' : {$pf = array( 396.000, 584.640); break;}
case 'ANNENV_A10' : {$pf = array( 450.000, 692.640); break;}
case 'ANNENV_SLIM': {$pf = array( 278.640, 638.640); break;}
// - Commercial Envelopes
case 'COMMENV_N6_1/4': {$pf = array( 252.000, 432.000); break;}
case 'COMMENV_N6_3/4': {$pf = array( 260.640, 468.000); break;}
case 'COMMENV_N8' : {$pf = array( 278.640, 540.000); break;}
case 'COMMENV_N9' : {$pf = array( 278.640, 638.640); break;}
case 'COMMENV_N10' : {$pf = array( 296.640, 684.000); break;}
case 'COMMENV_N11' : {$pf = array( 324.000, 746.640); break;}
case 'COMMENV_N12' : {$pf = array( 342.000, 792.000); break;}
case 'COMMENV_N14' : {$pf = array( 360.000, 828.000); break;}
case 'CATENV_N1' : {$pf = array( 432.000, 648.000); break;}
case 'CATENV_N1_3/4' : {$pf = array( 468.000, 684.000); break;}
case 'CATENV_N2' : {$pf = array( 468.000, 720.000); break;}
case 'CATENV_N3' : {$pf = array( 504.000, 720.000); break;}
case 'CATENV_N6' : {$pf = array( 540.000, 756.000); break;}
case 'CATENV_N7' : {$pf = array( 576.000, 792.000); break;}
case 'CATENV_N8' : {$pf = array( 594.000, 810.000); break;}
case 'CATENV_N9_1/2' : {$pf = array( 612.000, 756.000); break;}
case 'CATENV_N9_3/4' : {$pf = array( 630.000, 810.000); break;}
case 'CATENV_N10_1/2': {$pf = array( 648.000, 864.000); break;}
case 'CATENV_N12_1/2': {$pf = array( 684.000, 900.000); break;}
case 'CATENV_N13_1/2': {$pf = array( 720.000, 936.000); break;}
case 'CATENV_N14_1/4': {$pf = array( 810.000, 882.000); break;}
case 'CATENV_N14_1/2': {$pf = array( 828.000, 1044.000); break;}
// Japanese (JIS P 0138-61) Standard B-Series
case 'JIS_B0' : {$pf = array( 2919.685, 4127.244); break;}
case 'JIS_B1' : {$pf = array( 2063.622, 2919.685); break;}
case 'JIS_B2' : {$pf = array( 1459.843, 2063.622); break;}
case 'JIS_B3' : {$pf = array( 1031.811, 1459.843); break;}
case 'JIS_B4' : {$pf = array( 728.504, 1031.811); break;}
case 'JIS_B5' : {$pf = array( 515.906, 728.504); break;}
case 'JIS_B6' : {$pf = array( 362.835, 515.906); break;}
case 'JIS_B7' : {$pf = array( 257.953, 362.835); break;}
case 'JIS_B8' : {$pf = array( 181.417, 257.953); break;}
case 'JIS_B9' : {$pf = array( 127.559, 181.417); break;}
case 'JIS_B10': {$pf = array( 90.709, 127.559); break;}
case 'JIS_B11': {$pf = array( 62.362, 90.709); break;}
case 'JIS_B12': {$pf = array( 45.354, 62.362); break;}
case 'PA0' : {$pf = array( 2381.102, 3174.803,); break;}
case 'PA1' : {$pf = array( 1587.402, 2381.102); break;}
case 'PA2' : {$pf = array( 1190.551, 1587.402); break;}
case 'PA3' : {$pf = array( 793.701, 1190.551); break;}
case 'PA4' : {$pf = array( 595.276, 793.701); break;}
case 'PA5' : {$pf = array( 396.850, 595.276); break;}
case 'PA6' : {$pf = array( 297.638, 396.850); break;}
case 'PA7' : {$pf = array( 198.425, 297.638); break;}
case 'PA8' : {$pf = array( 147.402, 198.425); break;}
case 'PA9' : {$pf = array( 99.213, 147.402); break;}
case 'PA10': {$pf = array( 73.701, 99.213); break;}
// Standard Photographic Print Sizes
case 'PASSPORT_PHOTO': {$pf = array( 99.213, 127.559); break;}
case 'E' : {$pf = array( 233.858, 340.157); break;}
case '3R' : {$pf = array( 252.283, 360.000); break;}
case '4R' : {$pf = array( 289.134, 430.866); break;}
case '4D' : {$pf = array( 340.157, 430.866); break;}
case '5R' : {$pf = array( 360.000, 504.567); break;}
case '6R' : {$pf = array( 430.866, 575.433); break;}
case '8R' : {$pf = array( 575.433, 720.000); break;}
case 'S8R' : {$pf = array( 575.433, 864.567); break;}
case '10R' : {$pf = array( 720.000, 864.567); break;}
case 'S10R': {$pf = array( 720.000, 1080.000); break;}
case '11R' : {$pf = array( 790.866, 1009.134); break;}
case 'S11R': {$pf = array( 790.866, 1224.567); break;}
case '12R' : {$pf = array( 864.567, 1080.000); break;}
case 'S12R': {$pf = array( 864.567, 1292.598); break;}
// Common Newspaper Sizes
case 'NEWSPAPER_BROADSHEET': {$pf = array( 2125.984, 1700.787); break;}
case 'NEWSPAPER_BERLINER' : {$pf = array( 1332.283, 892.913); break;}
case 'NEWSPAPER_TABLOID':
case 'NEWSPAPER_COMPACT' : {$pf = array( 1218.898, 793.701); break;}
case 'BUSINESS_CARD_ISO7810': {$pf = array( 153.014, 242.646); break;}
case 'BUSINESS_CARD_ISO216' : {$pf = array( 147.402, 209.764); break;}
case 'BUSINESS_CARD_ES' : {$pf = array( 155.906, 240.945); break;}
case 'BUSINESS_CARD_US' : {$pf = array( 144.567, 252.283); break;}
case 'BUSINESS_CARD_JP' : {$pf = array( 155.906, 257.953); break;}
case 'BUSINESS_CARD_HK' : {$pf = array( 153.071, 255.118); break;}
case 'BUSINESS_CARD_SE' : {$pf = array( 155.906, 255.118); break;}
case 'BUSINESS_CARD_IL' : {$pf = array( 141.732, 255.118); break;}
case '4SHEET' : {$pf = array( 2880.000, 4320.000); break;}
case '6SHEET' : {$pf = array( 3401.575, 5102.362); break;}
case '12SHEET': {$pf = array( 8640.000, 4320.000); break;}
case '16SHEET': {$pf = array( 5760.000, 8640.000); break;}
case '32SHEET': {$pf = array(11520.000, 8640.000); break;}
case '48SHEET': {$pf = array(17280.000, 8640.000); break;}
case '64SHEET': {$pf = array(23040.000, 8640.000); break;}
case '96SHEET': {$pf = array(34560.000, 8640.000); break;}
// - Old Imperial English Sizes
case 'EN_EMPEROR' : {$pf = array( 3456.000, 5184.000); break;}
case 'EN_ANTIQUARIAN' : {$pf = array( 2232.000, 3816.000); break;}
case 'EN_GRAND_EAGLE' : {$pf = array( 2070.000, 3024.000); break;}
case 'EN_DOUBLE_ELEPHANT' : {$pf = array( 1926.000, 2880.000); break;}
case 'EN_ATLAS' : {$pf = array( 1872.000, 2448.000); break;}
case 'EN_COLOMBIER' : {$pf = array( 1692.000, 2484.000); break;}
case 'EN_ELEPHANT' : {$pf = array( 1656.000, 2016.000); break;}
case 'EN_DOUBLE_DEMY' : {$pf = array( 1620.000, 2556.000); break;}
case 'EN_IMPERIAL' : {$pf = array( 1584.000, 2160.000); break;}
case 'EN_PRINCESS' : {$pf = array( 1548.000, 2016.000); break;}
case 'EN_CARTRIDGE' : {$pf = array( 1512.000, 1872.000); break;}
case 'EN_DOUBLE_LARGE_POST': {$pf = array( 1512.000, 2376.000); break;}
case 'EN_ROYAL' : {$pf = array( 1440.000, 1800.000); break;}
case 'EN_HALF_POST' : {$pf = array( 1404.000, 1692.000); break;}
case 'EN_SUPER_ROYAL' : {$pf = array( 1368.000, 1944.000); break;}
case 'EN_DOUBLE_POST' : {$pf = array( 1368.000, 2196.000); break;}
case 'EN_MEDIUM' : {$pf = array( 1260.000, 1656.000); break;}
case 'EN_DEMY' : {$pf = array( 1260.000, 1620.000); break;}
case 'EN_LARGE_POST' : {$pf = array( 1188.000, 1512.000); break;}
case 'EN_COPY_DRAUGHT' : {$pf = array( 1152.000, 1440.000); break;}
case 'EN_POST' : {$pf = array( 1116.000, 1386.000); break;}
case 'EN_CROWN' : {$pf = array( 1080.000, 1440.000); break;}
case 'EN_PINCHED_POST' : {$pf = array( 1062.000, 1332.000); break;}
case 'EN_BRIEF' : {$pf = array( 972.000, 1152.000); break;}
case 'EN_FOOLSCAP' : {$pf = array( 972.000, 1224.000); break;}
case 'EN_SMALL_FOOLSCAP' : {$pf = array( 954.000, 1188.000); break;}
case 'EN_POTT' : {$pf = array( 900.000, 1080.000); break;}
// - Old Imperial Belgian Sizes
case 'BE_GRAND_AIGLE' : {$pf = array( 1984.252, 2948.031); break;}
case 'BE_COLOMBIER' : {$pf = array( 1757.480, 2409.449); break;}
case 'BE_DOUBLE_CARRE': {$pf = array( 1757.480, 2607.874); break;}
case 'BE_ELEPHANT' : {$pf = array( 1746.142, 2182.677); break;}
case 'BE_PETIT_AIGLE' : {$pf = array( 1700.787, 2381.102); break;}
case 'BE_GRAND_JESUS' : {$pf = array( 1559.055, 2069.291); break;}
case 'BE_JESUS' : {$pf = array( 1530.709, 2069.291); break;}
case 'BE_RAISIN' : {$pf = array( 1417.323, 1842.520); break;}
case 'BE_GRAND_MEDIAN': {$pf = array( 1303.937, 1714.961); break;}
case 'BE_DOUBLE_POSTE': {$pf = array( 1233.071, 1601.575); break;}
case 'BE_COQUILLE' : {$pf = array( 1218.898, 1587.402); break;}
case 'BE_PETIT_MEDIAN': {$pf = array( 1176.378, 1502.362); break;}
case 'BE_RUCHE' : {$pf = array( 1020.472, 1303.937); break;}
case 'BE_PROPATRIA' : {$pf = array( 977.953, 1218.898); break;}
case 'BE_LYS' : {$pf = array( 898.583, 1125.354); break;}
case 'BE_POT' : {$pf = array( 870.236, 1088.504); break;}
case 'BE_ROSETTE' : {$pf = array( 765.354, 983.622); break;}
// - Old Imperial French Sizes
case 'FR_UNIVERS' : {$pf = array( 2834.646, 3685.039); break;}
case 'FR_DOUBLE_COLOMBIER' : {$pf = array( 2551.181, 3571.654); break;}
case 'FR_GRANDE_MONDE' : {$pf = array( 2551.181, 3571.654); break;}
case 'FR_DOUBLE_SOLEIL' : {$pf = array( 2267.717, 3401.575); break;}
case 'FR_DOUBLE_JESUS' : {$pf = array( 2154.331, 3174.803); break;}
case 'FR_GRAND_AIGLE' : {$pf = array( 2125.984, 3004.724); break;}
case 'FR_PETIT_AIGLE' : {$pf = array( 1984.252, 2664.567); break;}
case 'FR_DOUBLE_RAISIN' : {$pf = array( 1842.520, 2834.646); break;}
case 'FR_JOURNAL' : {$pf = array( 1842.520, 2664.567); break;}
case 'FR_COLOMBIER_AFFICHE': {$pf = array( 1785.827, 2551.181); break;}
case 'FR_DOUBLE_CAVALIER' : {$pf = array( 1757.480, 2607.874); break;}
case 'FR_CLOCHE' : {$pf = array( 1700.787, 2267.717); break;}
case 'FR_SOLEIL' : {$pf = array( 1700.787, 2267.717); break;}
case 'FR_DOUBLE_CARRE' : {$pf = array( 1587.402, 2551.181); break;}
case 'FR_DOUBLE_COQUILLE' : {$pf = array( 1587.402, 2494.488); break;}
case 'FR_JESUS' : {$pf = array( 1587.402, 2154.331); break;}
case 'FR_RAISIN' : {$pf = array( 1417.323, 1842.520); break;}
case 'FR_CAVALIER' : {$pf = array( 1303.937, 1757.480); break;}
case 'FR_DOUBLE_COURONNE' : {$pf = array( 1303.937, 2040.945); break;}
case 'FR_CARRE' : {$pf = array( 1275.591, 1587.402); break;}
case 'FR_COQUILLE' : {$pf = array( 1247.244, 1587.402); break;}
case 'FR_DOUBLE_TELLIERE' : {$pf = array( 1247.244, 1927.559); break;}
case 'FR_DOUBLE_CLOCHE' : {$pf = array( 1133.858, 1700.787); break;}
case 'FR_DOUBLE_POT' : {$pf = array( 1133.858, 1757.480); break;}
case 'FR_ECU' : {$pf = array( 1133.858, 1474.016); break;}
case 'FR_COURONNE' : {$pf = array( 1020.472, 1303.937); break;}
case 'FR_TELLIERE' : {$pf = array( 963.780, 1247.244); break;}
case 'FR_POT' : {$pf = array( 878.740, 1133.858); break;}
default: {$pf = array( 595.276, 841.890); break;}
* Change the format of the current page
* @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:<ul>
* <li>['format'] = page format name (one of the above);</li>
* <li>['Rotate'] : The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.</li>
* <li>['PZ'] : The page's preferred zoom (magnification) factor.</li>
* <li>['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed:</li>
* <li>['MediaBox']['llx'] : lower-left x coordinate in points</li>
* <li>['MediaBox']['lly'] : lower-left y coordinate in points</li>
* <li>['MediaBox']['urx'] : upper-right x coordinate in points</li>
* <li>['MediaBox']['ury'] : upper-right y coordinate in points</li>
* <li>['CropBox'] : the visible region of default user space:</li>
* <li>['CropBox']['llx'] : lower-left x coordinate in points</li>
* <li>['CropBox']['lly'] : lower-left y coordinate in points</li>
* <li>['CropBox']['urx'] : upper-right x coordinate in points</li>
* <li>['CropBox']['ury'] : upper-right y coordinate in points</li>
* <li>['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment:</li>
* <li>['BleedBox']['llx'] : lower-left x coordinate in points</li>
* <li>['BleedBox']['lly'] : lower-left y coordinate in points</li>
* <li>['BleedBox']['urx'] : upper-right x coordinate in points</li>
* <li>['BleedBox']['ury'] : upper-right y coordinate in points</li>
* <li>['TrimBox'] : the intended dimensions of the finished page after trimming:</li>
* <li>['TrimBox']['llx'] : lower-left x coordinate in points</li>
* <li>['TrimBox']['lly'] : lower-left y coordinate in points</li>
* <li>['TrimBox']['urx'] : upper-right x coordinate in points</li>
* <li>['TrimBox']['ury'] : upper-right y coordinate in points</li>
* <li>['ArtBox'] : the extent of the page's meaningful content:</li>
* <li>['ArtBox']['llx'] : lower-left x coordinate in points</li>
* <li>['ArtBox']['lly'] : lower-left y coordinate in points</li>
* <li>['ArtBox']['urx'] : upper-right x coordinate in points</li>
* <li>['ArtBox']['ury'] : upper-right y coordinate in points</li>
* <li>['BoxColorInfo'] :specify the colours and other visual characteristics that should be used in displaying guidelines on the screen for each of the possible page boundaries other than the MediaBox:</li>
* <li>['BoxColorInfo'][BOXTYPE]['C'] : an array of three numbers in the range 0-255, representing the components in the DeviceRGB colour space.</li>
* <li>['BoxColorInfo'][BOXTYPE]['W'] : the guideline width in default user units</li>
* <li>['BoxColorInfo'][BOXTYPE]['S'] : the guideline style: S = Solid; D = Dashed</li>
* <li>['BoxColorInfo'][BOXTYPE]['D'] : dash array defining a pattern of dashes and gaps to be used in drawing dashed guidelines</li>
* <li>['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation</li>
* <li>['trans']['Dur'] : The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.</li>
* <li>['trans']['S'] : transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li>
* <li>['trans']['D'] : The duration of the transition effect, in seconds.</li>
* <li>['trans']['Dm'] : (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.</li>
* <li>['trans']['M'] : (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.</li>
* <li>['trans']['Di'] : (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.</li>
* <li>['trans']['SS'] : (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.</li>
* <li>['trans']['B'] : (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.</li>
* @param string $orientation page orientation. Possible values are (case insensitive):<ul>
* <li>P or Portrait (default)</li>
* <li>L or Landscape</li>
* <li>'' (empty string) for automatic orientation</li>
* @since 3.0.015 (2008-06-06)
* @see getPageSizeFromFormat()
if (!empty($format) AND isset ($this->pagedim[$this->page])) {
// remove inherited values
// get page measures from format name
// the boundaries of the physical medium on which the page shall be displayed or printed
if (isset ($format['MediaBox'])) {
$this->setPageBoxes($this->page, 'MediaBox', $format['MediaBox']['llx'], $format['MediaBox']['lly'], $format['MediaBox']['urx'], $format['MediaBox']['ury'], false);
$this->fwPt = (($format['MediaBox']['urx'] - $format['MediaBox']['llx']) * $this->k);
$this->fhPt = (($format['MediaBox']['ury'] - $format['MediaBox']['lly']) * $this->k);
if (isset ($format[0]) AND is_numeric($format[0]) AND isset ($format[1]) AND is_numeric($format[1])) {
$pf = array(($format[0] * $this->k), ($format[1] * $this->k));
if (!isset ($format['format'])) {
$format['format'] = 'A4';
// the visible region of default user space
if (isset ($format['CropBox'])) {
$this->setPageBoxes($this->page, 'CropBox', $format['CropBox']['llx'], $format['CropBox']['lly'], $format['CropBox']['urx'], $format['CropBox']['ury'], false);
// the region to which the contents of the page shall be clipped when output in a production environment
if (isset ($format['BleedBox'])) {
$this->setPageBoxes($this->page, 'BleedBox', $format['BleedBox']['llx'], $format['BleedBox']['lly'], $format['BleedBox']['urx'], $format['BleedBox']['ury'], false);
// the intended dimensions of the finished page after trimming
if (isset ($format['TrimBox'])) {
$this->setPageBoxes($this->page, 'TrimBox', $format['TrimBox']['llx'], $format['TrimBox']['lly'], $format['TrimBox']['urx'], $format['TrimBox']['ury'], false);
// the page's meaningful content (including potential white space)
if (isset ($format['ArtBox'])) {
$this->setPageBoxes($this->page, 'ArtBox', $format['ArtBox']['llx'], $format['ArtBox']['lly'], $format['ArtBox']['urx'], $format['ArtBox']['ury'], false);
// specify the colours and other visual characteristics that should be used in displaying guidelines on the screen for the various page boundaries
if (isset ($format['BoxColorInfo'])) {
$this->pagedim[$this->page]['BoxColorInfo'] = $format['BoxColorInfo'];
if (isset ($format['Rotate']) AND (($format['Rotate'] % 90) == 0)) {
// The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
if (isset ($format['PZ'])) {
// The page's preferred zoom (magnification) factor
if (isset ($format['trans'])) {
// The style and duration of the visual transition to use when moving from another page to the given page during a presentation
if (isset ($format['trans']['Dur'])) {
// The page's display duration
$stansition_styles = array('Split', 'Blinds', 'Box', 'Wipe', 'Dissolve', 'Glitter', 'R', 'Fly', 'Push', 'Cover', 'Uncover', 'Fade');
if (isset ($format['trans']['S']) AND in_array($format['trans']['S'], $stansition_styles)) {
// The transition style that shall be used when moving to this page from another during a presentation
$this->pagedim[$this->page]['trans']['S'] = $format['trans']['S'];
$valid_effect = array('Split', 'Blinds');
$valid_vals = array('H', 'V');
if (isset ($format['trans']['Dm']) AND in_array($format['trans']['S'], $valid_effect) AND in_array($format['trans']['Dm'], $valid_vals)) {
$this->pagedim[$this->page]['trans']['Dm'] = $format['trans']['Dm'];
$valid_effect = array('Split', 'Box', 'Fly');
$valid_vals = array('I', 'O');
if (isset ($format['trans']['M']) AND in_array($format['trans']['S'], $valid_effect) AND in_array($format['trans']['M'], $valid_vals)) {
$this->pagedim[$this->page]['trans']['M'] = $format['trans']['M'];
$valid_effect = array('Wipe', 'Glitter', 'Fly', 'Cover', 'Uncover', 'Push');
if (isset ($format['trans']['Di']) AND in_array($format['trans']['S'], $valid_effect)) {
if (((($format['trans']['Di'] == 90) OR ($format['trans']['Di'] == 180)) AND ($format['trans']['S'] == 'Wipe'))
OR (($format['trans']['Di'] == 315) AND ($format['trans']['S'] == 'Glitter'))
OR (($format['trans']['Di'] == 0) OR ($format['trans']['Di'] == 270))) {
if (isset ($format['trans']['SS']) AND ($format['trans']['S'] == 'Fly')) {
if (isset ($format['trans']['B']) AND ($format['trans']['B'] === true) AND ($format['trans']['S'] == 'Fly')) {
if (isset ($format['trans']['D'])) {
// The duration of the transition effect, in seconds
* @param int $page page number
* @param string $type valid values are: <ul><li>'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;</li><li>'CropBox' : the visible region of default user space;</li><li>'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;</li><li>'TrimBox' : the intended dimensions of the finished page after trimming;</li><li>'ArtBox' : the page's meaningful content (including potential white space).</li></ul>
* @param float $llx lower-left x coordinate in user units
* @param float $lly lower-left y coordinate in user units
* @param float $urx upper-right x coordinate in user units
* @param float $ury upper-right y coordinate in user units
* @param boolean $points if true uses user units as unit of measure, otherwise uses PDF points
* @since 5.0.010 (2010-05-17)
public function setPageBoxes($page, $type, $llx, $lly, $urx, $ury, $points= false) {
if (!isset ($this->pagedim[$page])) {
$pageboxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox');
$this->pagedim[$page][$type]['llx'] = ($llx * $k);
$this->pagedim[$page][$type]['lly'] = ($lly * $k);
$this->pagedim[$page][$type]['urx'] = ($urx * $k);
$this->pagedim[$page][$type]['ury'] = ($ury * $k);
* Swap X and Y coordinates of page boxes (change page boxes orientation).
* @param int $page page number
* @since 5.0.010 (2010-05-17)
$pageboxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox');
foreach ($pageboxes as $type) {
// swap X and Y coordinates
if (isset ($this->pagedim[$page][$type])) {
$tmp = $this->pagedim[$page][$type]['llx'];
$this->pagedim[$page][$type]['llx'] = $this->pagedim[$page][$type]['lly'];
$this->pagedim[$page][$type]['lly'] = $tmp;
$tmp = $this->pagedim[$page][$type]['urx'];
$this->pagedim[$page][$type]['urx'] = $this->pagedim[$page][$type]['ury'];
$this->pagedim[$page][$type]['ury'] = $tmp;
* @param string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
* @param boolean $autopagebreak Boolean indicating if auto-page-break mode should be on or off.
* @param float $bottommargin bottom margin of the page.
* @since 3.0.015 (2008-06-06)
// the boundaries of the physical medium on which the page shall be displayed or printed
// the visible region of default user space
// the region to which the contents of the page shall be clipped when output in a production environment
// the intended dimensions of the finished page after trimming
// the page's meaningful content (including potential white space)
// The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
// The page's preferred zoom (magnification) factor
$default_orientation = 'L';
$default_orientation = 'P';
$valid_orientations = array('P', 'L');
if (empty($orientation)) {
$orientation = $default_orientation;
if (in_array($orientation, $valid_orientations) AND ($orientation != $default_orientation)) {
// swap X and Y coordinates (change page orientation)
$this->w = $this->wPt / $this->k;
$this->h = $this->hPt / $this->k;
$bottommargin = 2 * 28.35 / $this->k;
* Set regular expression to detect withespaces or word separators.
* The pattern delimiter must be the forward-slash character '/'.
* Some example patterns are:
* Non-Unicode or missing PCRE unicode support: '/[^\S\xa0]/'
* Unicode and PCRE unicode support: '/[^\S\P{Z}\xa0]/u'
* Unicode and PCRE unicode support in Chinese mode: '/[^\S\P{Z}\P{Lo}\xa0]/u'
* if PCRE unicode support is turned ON (\P is the negate class of \p):
* \p{Z} or \p{Separator}: any kind of Unicode whitespace or invisible separator.
* \p{Lo} or \p{Other_Letter}: a Unicode letter or ideograph that does not have lowercase and uppercase variants.
* \p{Lo} is needed for Chinese characters because are packed next to each other without spaces in between.
* @param string $re regular expression (leave empty for default).
* @since 4.6.016 (2009-06-15)
if (isset ($re_parts[1]) AND !empty($re_parts[1])) {
if (isset ($re_parts[2]) AND !empty($re_parts[2])) {
* Enable or disable Right-To-Left language mode
* @param Boolean $enable if true enable Right-To-Left language mode.
* @param Boolean $resetx if true reset the X position on direction change.
* @since 2.0.000 (2008-01-03)
public function setRTL($enable, $resetx= true) {
$enable = $enable ? true : false;
$resetx = ($resetx AND ($enable != $this->rtl));
* @since 4.0.012 (2008-07-24)
* Force temporary RTL language direction
* @param mixed $mode can be false, 'L' for LTR or 'R' for RTL
* @since 2.1.000 (2008-01-09)
* Return the current temporary RTL status
* @since 4.8.014 (2009-11-04)
return ($this->rtl OR ($this->tmprtl == 'R'));
* Set the last cell height.
* @param float $h cell height.
* Reset the last cell height.
* @since 5.9.000 (2010-10-03)
* Get the last cell height.
* @return last cell height
* @since 4.0.017 (2008-08-05)
* Set the adjusting factor to convert pixels to user units.
* @param float $scale adjusting factor to convert pixels to user units.
* Returns the adjusting factor to convert pixels to user units.
* @return float adjusting factor to convert pixels to user units.
* Returns an array of page dimensions:
* <ul><li>$this->pagedim[$this->page]['w'] = page width in points</li><li>$this->pagedim[$this->page]['h'] = height in points</li><li>$this->pagedim[$this->page]['wk'] = page width in user units</li><li>$this->pagedim[$this->page]['hk'] = page height in user units</li><li>$this->pagedim[$this->page]['tm'] = top margin</li><li>$this->pagedim[$this->page]['bm'] = bottom margin</li><li>$this->pagedim[$this->page]['lm'] = left margin</li><li>$this->pagedim[$this->page]['rm'] = right margin</li><li>$this->pagedim[$this->page]['pb'] = auto page break</li><li>$this->pagedim[$this->page]['or'] = page orientation</li><li>$this->pagedim[$this->page]['olm'] = original left margin</li><li>$this->pagedim[$this->page]['orm'] = original right margin</li><li>$this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.</li><li>$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.</li><li>$this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation<ul><li>$this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.</li><li>$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li><li>$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.</li><li>$this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.</li><li>$this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.</li><li>$this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.</li><li>$this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0. </li><li>$this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.</li></ul></li><li>$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed<ul><li>$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['CropBox'] : the visible region of default user space<ul><li>$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment<ul><li>$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming<ul><li>$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content<ul><li>$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points</li></ul></li></ul>
* @param int $pagenum page number (empty = current page)
* @return array of page dimensions.
* @since 4.5.027 (2009-03-16)
* Returns the page width in units.
* @param int $pagenum page number (empty = current page)
* @return int page width.
* @see getPageDimensions()
return $this->pagedim[$pagenum]['w'];
* Returns the page height in units.
* @param int $pagenum page number (empty = current page)
* @return int page height.
* @see getPageDimensions()
return $this->pagedim[$pagenum]['h'];
* Returns the page break margin.
* @param int $pagenum page number (empty = current page)
* @return int page break margin.
* @see getPageDimensions()
return $this->pagedim[$pagenum]['bm'];
* Returns the scale factor (number of points in user unit).
* @return int scale factor.
* Defines the left, top and right margins.
* @param float $left Left margin.
* @param float $top Top margin.
* @param float $right Right margin. Default value is the left one.
* @param boolean $keepmargins if true overwrites the default page margins
* @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
public function SetMargins($left, $top, $right=- 1, $keepmargins= false) {
//Set left, top and right margins
// overwrite original values
* 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.
* @see SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
if (($this->page > 0) AND ($this->x < $margin)) {
* Defines the top margin. The method can be called before creating the first page.
* @param float $margin The margin.
* @see SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
if (($this->page > 0) AND ($this->y < $margin)) {
* Defines the right margin. The method can be called before creating the first page.
* @param float $margin The margin.
* @see SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()
if (($this->page > 0) AND ($this->x > ($this->w - $margin))) {
$this->x = $this->w - $margin;
* Set the same internal Cell padding for top, right, bottom, left-
* @param float $pad internal padding.
* @since 2.1.000 (2008-01-09)
* @see getCellPaddings(), setCellPaddings()
* Set the internal Cell paddings.
* @param float $left left padding
* @param float $top top padding
* @param float $right right padding
* @param float $bottom bottom padding
* @since 5.9.000 (2010-10-03)
* @see getCellPaddings(), SetCellPadding()
public function setCellPaddings($left= '', $top= '', $right= '', $bottom= '') {
if (($left !== '') AND ($left >= 0)) {
if (($top !== '') AND ($top >= 0)) {
if (($right !== '') AND ($right >= 0)) {
if (($bottom !== '') AND ($bottom >= 0)) {
* Get the internal Cell padding array.
* @return array of padding values
* @since 5.9.000 (2010-10-03)
* @see setCellPaddings(), SetCellPadding()
* Set the internal Cell margins.
* @param float $left left margin
* @param float $top top margin
* @param float $right right margin
* @param float $bottom bottom margin
* @since 5.9.000 (2010-10-03)
public function setCellMargins($left= '', $top= '', $right= '', $bottom= '') {
if (($left !== '') AND ($left >= 0)) {
if (($top !== '') AND ($top >= 0)) {
if (($right !== '') AND ($right >= 0)) {
if (($bottom !== '') AND ($bottom >= 0)) {
* Get the internal Cell margin array.
* @return array of margin values
* @since 5.9.000 (2010-10-03)
* Adjust the internal Cell padding array to take account of the line width.
* @param mixed $brd Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return array of adjustments
* @since 5.9.000 (2010-10-03)
// convert string to array
for ($i = 0; $i < $slen; ++ $i) {
$newbrd[$brd{$i}] = true;
} elseif (($brd === 1) OR ($brd === true) OR (is_numeric($brd) AND (intval($brd) > 0))) {
$brd = array('LRTB' => true);
// store current cell padding
if (isset ($brd['mode'])) {
foreach ($brd as $border => $style) {
if (is_array($style) AND isset ($style['width'])) {
$line_width = $style['width'];
$adj = 0; // line width inside the cell
$adj = ($line_width / 2);
// correct internal cell padding if required to avoid overlap between text and lines
* 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.
* @see Cell(), MultiCell(), AcceptPageBreak()
//Set auto page break mode and triggering margin
* Defines the way the document is to be displayed by the viewer.
* @param mixed $zoom The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul>
* @param string $layout The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul>
* @param string $mode A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul>
public function SetDisplayMode($zoom, $layout= 'SinglePage', $mode= 'UseNone') {
//Set display mode in viewer
if (($zoom == 'fullpage') OR ($zoom == 'fullwidth') OR ($zoom == 'real') OR ($zoom == 'default') OR (!is_string($zoom))) {
$this->Error('Incorrect zoom display mode: '. $zoom);
* 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.
$this->compress = $compress ? true : false;
* Defines the title of the document.
* @param string $title The title.
* @see SetAuthor(), SetCreator(), SetKeywords(), SetSubject()
* Defines the subject of the document.
* @param string $subject The subject.
* @see SetAuthor(), SetCreator(), SetKeywords(), SetTitle()
* Defines the author of the document.
* @param string $author The name of the author.
* @see SetCreator(), SetKeywords(), SetSubject(), SetTitle()
* Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
* @param string $keywords The list of keywords.
* @see SetAuthor(), SetCreator(), SetSubject(), SetTitle()
* 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.
* @see SetAuthor(), SetKeywords(), SetSubject(), SetTitle()
* 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
public function Error($msg) {
// unset all class variables
// exit program and print error
die('<strong>TCPDF ERROR: </strong>'. $msg);
* 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
* @see AddPage(), Close()
* 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.
public function Close() {
// save current graphic settings
$this->y = $this->h - (1 / $this->k);
$this->SetFont('helvetica', '', 1);
$msg = "\x50\x6f\x77\x65\x72\x65\x64\x20\x62\x79\x20\x54\x43\x50\x44\x46\x20\x28\x77\x77\x77\x2e\x74\x63\x70\x64\x66\x2e\x6f\x72\x67\x29";
$lnk = "\x68\x74\x74\x70\x3a\x2f\x2f\x77\x77\x77\x2e\x74\x63\x70\x64\x66\x2e\x6f\x72\x67";
$this->Cell(0, 0, $msg, 0, 0, 'L', 0, $lnk, 0, false, 'D', 'B');
// restore graphic settings
// unset all class variables (except critical ones)
* Move pointer at the specified document page and update page dimensions.
* @param int $pnum page number (1 ... numpages)
* @param boolean $resetmargins if true reset left, right, top margins and Y position.
* @since 2.1.000 (2008-01-07)
* @see getPage(), lastpage(), getNumPages()
public function setPage($pnum, $resetmargins= false) {
if (($pnum == $this->page) AND ($this->state == 2)) {
if (($pnum > 0) AND ($pnum <= $this->numpages)) {
// save current graphic settings
//$gvars = $this->getGraphicVars();
// restore graphic settings
//$this->setGraphicVars($gvars);
// account for booklet mode
$this->Error('Wrong page number on setPage() function: '. $pnum);
* Reset pointer to the last document page.
* @param boolean $resetmargins if true reset left, right, top margins and Y position.
* @since 2.0.000 (2008-01-04)
* @see setPage(), getPage(), getNumPages()
public function lastPage($resetmargins= false) {
* Get current document page number.
* @return int page number
* @since 2.1.000 (2008-01-07)
* @see setPage(), lastpage(), getNumPages()
* Get the total number of insered pages.
* @return int number of pages
* @since 2.1.000 (2008-01-07)
* @see setPage(), getPage(), lastpage()
* Adds a new TOC (Table Of Content) page to the document.
* @param string $orientation page orientation.
* @param boolean $keepmargins if true overwrites the default page margins with the current margins
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), endTOCPage()
public function addTOCPage($orientation= '', $format= '', $keepmargins= false) {
$this->AddPage($orientation, $format, $keepmargins, true);
* Terminate the current TOC (Table Of Content) page
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), addTOCPage()
* 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):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param boolean $keepmargins if true overwrites the default page margins with the current margins
* @param boolean $tocpage if true set the tocpage state to true (the added page will be used to display Table Of Content).
* @see startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
public function AddPage($orientation= '', $format= '', $keepmargins= false, $tocpage= false) {
// we are inside an XObject template
// terminate previous page
$this->startPage($orientation, $format, $tocpage);
* Terminate the current page
* @param boolean $tocpage if true set the tocpage state to false (end the page used to display Table Of Content).
* @since 4.2.010 (2008-11-14)
* @see AddPage(), startPage(), addTOCPage(), endTOCPage()
public function endPage($tocpage= false) {
// check if page is already closed
* Starts a new page to the document. The page must be closed using the endPage() function.
* The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
* @param string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @since 4.2.010 (2008-11-14)
* @see AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
public function startPage($orientation= '', $format= '', $tocpage= false) {
// this page has been already added
// save current graphic settings
// restore graphic settings
// restore graphic settings
// print table header (if any)
// set mark for empty page check
* Set start-writing mark on current page stream used to put borders and fills.
* Borders and fills are always created after content and inserted on the position marked by this method.
* This function must be called after calling Image() function for a background image.
* Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
* @since 4.0.016 (2008-07-30)
* Set start-writing mark on selected page.
* Borders and fills are always created after content and inserted on the position marked by this method.
* @param int $page page number (default is the current page)
* @since 4.6.021 (2009-07-20)
* @param string $ln header image logo
* @param string $lw header image logo width in mm
* @param string $ht string to print as title on document header
* @param string $hs string to print on document header
* <ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul>
* @since 4.0.012 (2008-07-24)
* (minimum distance between header and top page margin)
* @param int $hm distance in user units
* Returns header margin in user units.
* @since 4.0.012 (2008-07-24)
* (minimum distance between footer and bottom page margin)
* @param int $fm distance in user units
* Returns footer margin in user units.
* @since 4.0.012 (2008-07-24)
* Set a flag to print page header.
* @param boolean $val set to true to print the page header (default), false otherwise.
* Set a flag to print page footer.
* @param boolean $value set to true to print the page footer (default), false otherwise.
* Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
* Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
* This method is used to render the page header.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
if (($headerdata['logo']) AND ($headerdata['logo'] != K_BLANK_IMAGE)) {
// set starting margin for text data cell
$header_x = $ormargins['right'] + ($headerdata['logo_width'] * 1.1);
$header_x = $ormargins['left'] + ($headerdata['logo_width'] * 1.1);
$this->SetFont($headerfont[0], 'B', $headerfont[2] + 1);
$this->Cell(0, $cell_height, $headerdata['title'], 0, 1, '', 0, '', 0);
$this->SetFont($headerfont[0], $headerfont[1], $headerfont[2]);
$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->SetX($ormargins['right']);
$this->SetX($ormargins['left']);
$this->Cell(0, 0, '', 'T', 0, 'C');
* This method is used to render the page footer.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
//set style for cell border
$this->SetLineStyle(array('width' => $line_width, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)));
$barcode_width = round(($this->getPageWidth() - $ormargins['left'] - $ormargins['right']) / 3);
'position' => $this->rtl? 'R': 'L',
'align' => $this->rtl? 'R': 'L',
'fgcolor' => array(0,0,0),
$this->SetX($ormargins['right']);
$this->Cell(0, 0, $pagenumtxt, 'T', 0, 'L');
$this->SetX($ormargins['left']);
$this->Cell(0, 0, $pagenumtxt, 'T', 0, 'R');
* This method is used to render the page header.
* @since 4.0.012 (2008-07-24)
$temp_thead = $this->thead;
$this->thead = $temp_thead;
* This method is used to render the page footer.
* @since 4.0.012 (2008-07-24)
// save current graphic settings
$temp_thead = $this->thead;
$this->thead = $temp_thead;
// restore graphic settings
// calculate footer length
* This method is used to render the table header on new page (if any).
* @since 4.5.030 (2009-03-25)
// restore the original top-margin
// set new top margin to skip the table headers
* Returns the current page number.
* @return int page number
* @see AliasNbPages(), getAliasNbPages()
* Defines a new spot color.
* It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
* @param int $c Cyan color for CMYK. Value between 0 and 255
* @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
* @since 4.0.024 (2008-09-12)
* @see SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor()
$this->spot_colors[$name] = array('i' => $i, 'c' => $c, 'm' => $m, 'y' => $y, 'k' => $k);
* Defines the color used for all drawing operations (lines, rectangles and cell borders).
* It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
* @param array $color array of colors
* @param boolean $ret if true do not send the command.
* @return string the PDF command
* @since 3.1.000 (2008-06-11)
$r = isset ($color[0]) ? $color[0] : - 1;
$g = isset ($color[1]) ? $color[1] : - 1;
$b = isset ($color[2]) ? $color[2] : - 1;
$k = isset ($color[3]) ? $color[3] : - 1;
* Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param int $col1 Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
* @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
* @param boolean $ret if true do not send the command.
* @return string the PDF command
* @see SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()
public function SetDrawColor($col1= 0, $col2=- 1, $col3=- 1, $col4=- 1, $ret= false) {
//Set color for all stroking operations
if (($col2 == - 1) AND ($col3 == - 1) AND ($col4 == - 1)) {
$this->DrawColor = sprintf('%.3F %.3F %.3F RG', $col1/ 255, $col2/ 255, $col3/ 255);
$this->strokecolor = array('R' => $col1, 'G' => $col2, 'B' => $col3);
$this->DrawColor = sprintf('%.3F %.3F %.3F %.3F K', $col1/ 100, $col2/ 100, $col3/ 100, $col4/ 100);
$this->strokecolor = array('C' => $col1, 'M' => $col2, 'Y' => $col3, 'K' => $col4);
* 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).
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()
$this->Error('Undefined spot color: '. $name);
* Defines the color used for all filling operations (filled rectangles and cell backgrounds).
* It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
* @param array $color array of colors
* @since 3.1.000 (2008-6-11)
$r = isset ($color[0]) ? $color[0] : - 1;
$g = isset ($color[1]) ? $color[1] : - 1;
$b = isset ($color[2]) ? $color[2] : - 1;
$k = isset ($color[3]) ? $color[3] : - 1;
* Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param int $col1 Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
* @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
* @see SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()
public function SetFillColor($col1= 0, $col2=- 1, $col3=- 1, $col4=- 1) {
//Set color for all filling operations
if (($col2 == - 1) AND ($col3 == - 1) AND ($col4 == - 1)) {
$this->bgcolor = array('G' => $col1);
$this->FillColor = sprintf('%.3F %.3F %.3F rg', $col1/ 255, $col2/ 255, $col3/ 255);
$this->bgcolor = array('R' => $col1, 'G' => $col2, 'B' => $col3);
$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);
* 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).
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()
$this->Error('Undefined spot color: '. $name);
* 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
* @since 3.1.000 (2008-6-11)
$r = isset ($color[0]) ? $color[0] : - 1;
$g = isset ($color[1]) ? $color[1] : - 1;
$b = isset ($color[2]) ? $color[2] : - 1;
$k = isset ($color[3]) ? $color[3] : - 1;
* Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param int $col1 Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
* @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
* @see SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
public function SetTextColor($col1= 0, $col2=- 1, $col3=- 1, $col4=- 1) {
if (($col2 == - 1) AND ($col3 == - 1) AND ($col4 == - 1)) {
$this->fgcolor = array('G' => $col1);
$this->TextColor = sprintf('%.3F %.3F %.3F rg', $col1/ 255, $col2/ 255, $col3/ 255);
$this->fgcolor = array('R' => $col1, 'G' => $col2, 'B' => $col3);
$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);
* 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).
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()
$this->Error('Undefined spot color: '. $name);
* Returns the length of a string in user unit. A font must be selected.<br>
* @param string $s The string whose length is to be computed
* @param string $fontname Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
* @param string $fontstyle Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line-trough</li><li>O: overline</li></ul> or any combination. The default value is regular.
* @param float $fontsize Font size in points. The default value is the current size.
* @param boolean $getarray if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
public function GetStringWidth($s, $fontname= '', $fontstyle= '', $fontsize= 0, $getarray= false) {
* Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>
* @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):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li><li>O: overline</li></ul> or any combination. The default value is regular.
* @param float $fontsize Font size in points. The default value is the current size.
* @param boolean $getarray if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
* @since 2.4.000 (2008-03-06)
public function GetArrStringWidth($sa, $fontname= '', $fontstyle= '', $fontsize= 0, $getarray= false) {
$this->SetFont($fontname, $fontstyle, $fontsize);
// convert UTF-8 array to Latin1 if required
$wa = array(); // array of characters widths
foreach ($sa as $ck => $char) {
// restore previous values
$this->SetFont($prev_FontFamily, $prev_FontStyle, $prev_FontSizePt);
* Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking/kerning).
* @param int $char The char code whose length is to be returned
* @param boolean $notlast set to false for the latest character on string, true otherwise (default)
* @return float char width
* @since 2.4.000 (2008-03-06)
// increase/decrease font spacing
* 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 float char width
* @since 5.9.000 (2010-09-28)
// SHY character will not be printed
} elseif (isset ($cw[32])) {
* Returns the numbero of characters in a string.
* @param string $s The input string.
* @return int number of characters
* @since 2.0.0001 (2008-01-07)
* Fill the list of available fonts ($this->fontlist).
* @since 4.0.013 (2008-07-28)
while (($file = readdir($fontsdir)) !== false) {
if (substr($file, - 4) == '.php') {
* Imports a TrueType, Type1, core, or CID0 font and makes it available.
* It is necessary to generate a font definition file first (read /fonts/utils/README.TXT).
* The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
* @param string $family Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
* @param string $style Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul>
* @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.
* @param mixed $subset if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
* @see SetFont(), setFontSubsetting()
public function AddFont($family, $style= '', $fontfile= '', $subset= 'default') {
if ($subset === 'default') {
$this->Error('Empty font family');
// move embedded styles on $style
if (substr($family, - 1) == 'I') {
$family = substr($family, 0, - 1);
if (substr($family, - 1) == 'B') {
$family = substr($family, 0, - 1);
if ((!$this->isunicode) AND ($family == 'arial')) {
if (($family == 'symbol') OR ($family == 'zapfdingbats')) {
if (strpos($tempstyle, 'U') !== false) {
// line-through (deleted)
if (strpos($tempstyle, 'D') !== false) {
if (strpos($tempstyle, 'O') !== false) {
if (strpos($tempstyle, 'B') !== false) {
if (strpos($tempstyle, 'I') !== false) {
$fontkey = $family. $style;
$fontdata = array('fontkey' => $fontkey, 'family' => $family, 'style' => $font_style);
// check if the font has been already added
// we are inside an XObject template
// get specified font directory (if any)
// search and include font file
// build a standard filenames for specified font
// search files on various directories
if (($fontdir !== false) AND file_exists($fontdir. $fontfile1)) {
$fontfile = $fontdir. $fontfile1;
} elseif (($fontdir !== false) AND file_exists($fontdir. $fontfile2)) {
$fontfile = $fontdir. $fontfile2;
$this->Error('Could not include font definition file: '. $family. '');
if ((!isset ($type)) OR (!isset ($cw))) {
$this->Error('The font definition file has a bad format: '. $fontfile. '');
// SET default parameters
$cidinfo = array('Registry'=> 'Adobe','Ordering'=> 'Identity','Supplement'=> 0);
$cidinfo['uni2cid'] = array();
if (isset ($desc['MissingWidth']) AND ($desc['MissingWidth'] > 0)) {
$dw = $desc['MissingWidth'];
} elseif (isset ($cw[32])) {
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) {
if (isset ($desc['StemV'])) {
if (strpos($bistyle, 'I') !== false) {
if (isset ($desc['ItalicAngle'])) {
$desc['ItalicAngle'] -= 11;
$desc['ItalicAngle'] = - 11;
} elseif ($type == 'core') {
} elseif (($type == 'TrueType') OR ($type == 'Type1')) {
} elseif ($type == 'TrueTypeUnicode') {
$this->Error('Unknow font type: '. $type. '');
// initialize subsetchars to contain default ASCII values (0-255)
$this->setFontBuffer($fontkey, array('fontkey' => $fontkey, '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, 'subset' => $subset, 'subsetchars' => $subsetchars));
// we are inside an XObject template
if (isset ($diff) AND (!empty($diff))) {
//Search existing encodings
for ($i= 1; $i <= $nb; ++ $i) {
if ($this->diffs[$i] == $diff) {
$this->diffs[$d] = $diff;
$this->FontFiles[$file] = array('length1' => $originalsize, 'fontdir' => $fontdir, 'subset' => $subset, 'fontkeys' => array($fontkey));
} elseif ($type != 'core') {
$this->FontFiles[$file] = array('length1' => $size1, 'length2' => $size2, 'fontdir' => $fontdir, 'subset' => $subset, 'fontkeys' => array($fontkey));
// update fontkeys that are sharing this font file
$this->FontFiles[$file]['fontkeys'][] = $fontkey;
* Sets the font used to print character strings.
* The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe).
* The method can be called before the first page is created and the font is retained from page to page.
* If you just wish to change the current font size, it is simpler to call SetFontSize().
* Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br />
* @param string $family Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> 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):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li><li>O: overline</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
* @param float $size Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
* @param string $fontfile The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
* @param mixed $subset if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
* @see AddFont(), SetFontSize()
public function SetFont($family, $style= '', $size= 0, $fontfile= '', $subset= 'default') {
//Select a font; size given in points
// try to add font (if not already added)
$fontdata = $this->AddFont($family, $style, $fontfile, $subset);
* Defines the size of the current font.
* @param float $size The size (in points)
* @param boolean $out if true output the font size command, otherwise only set the font properties.
// font size in user units
// calculate some font metrics
$font_height = ((intval($bbox[3]) - intval($bbox[1])) * $size / 1000);
$font_height = $size * 1.219;
$font_ascent = ($this->CurrentFont['desc']['Ascent'] * $size / 1000);
$font_descent = (- $this->CurrentFont['desc']['Descent'] * $size / 1000);
if (!isset ($font_ascent) AND !isset ($font_descent)) {
$font_ascent = 0.76 * $font_height;
$font_descent = $font_height - $font_ascent;
} elseif (!isset ($font_descent)) {
$font_descent = $font_height - $font_ascent;
} elseif (!isset ($font_ascent)) {
$font_ascent = $font_height - $font_descent;
* Return the font descent value
* @param string $font font name
* @param string $style font style
* @param float $size The size (in points)
* @return int font descent
* @since 4.9.003 (2010-03-30)
$fontdata = $this->AddFont($font, $style);
if (isset ($fontinfo['desc']['Descent']) AND ($fontinfo['desc']['Descent'] <= 0)) {
$descent = (- $fontinfo['desc']['Descent'] * $size / 1000);
$descent = 1.219 * 0.24 * $size;
return ($descent / $this->k);
* Return the font ascent value
* @param string $font font name
* @param string $style font style
* @param float $size The size (in points)
* @return int font ascent
* @since 4.9.003 (2010-03-30)
$fontdata = $this->AddFont($font, $style);
if (isset ($fontinfo['desc']['Ascent']) AND ($fontinfo['desc']['Ascent'] > 0)) {
$ascent = ($fontinfo['desc']['Ascent'] * $size / 1000);
$ascent = 1.219 * 0.76 * $size;
return ($ascent / $this->k);
* Defines the default monospaced font.
* @param string $font Font name.
* Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br />
* The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
* @see Cell(), Write(), Image(), Link(), SetLink()
//Create a new internal link
$this->links[$n] = array(0, 0);
* Defines the page and position a link points to.
* @param int $link The link identifier returned by AddLink()
* @param float $y Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
* @param int $page Number of target page; -1 indicates the current page. This is the default value
public function SetLink($link, $y= 0, $page=- 1) {
$this->links[$link] = array($page, $y);
* Puts a link on a rectangular area of the page.
* Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
* @param float $x Abscissa of the upper-left corner of the rectangle
* @param float $y Ordinate of the upper-left corner of the rectangle
* @param float $w Width of the rectangle
* @param float $h Height of the rectangle
* @param mixed $link URL or identifier returned by AddLink()
* @param int $spaces number of spaces on the text to link
* @see AddLink(), Annotation(), Cell(), Write(), Image()
public function Link($x, $y, $w, $h, $link, $spaces= 0) {
$this->Annotation($x, $y, $w, $h, $link, array('Subtype'=> 'Link'), $spaces);
* Puts a markup annotation on a rectangular area of the page.
* !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
* @param float $x Abscissa of the upper-left corner of the rectangle
* @param float $y Ordinate of the upper-left corner of the rectangle
* @param float $w Width of the rectangle
* @param float $h Height of the rectangle
* @param string $text annotation text or alternate content
* @param array $opt array of options (see section 8.4 of PDF reference 1.7).
* @param int $spaces number of spaces on the text to link
* @since 4.0.018 (2008-08-06)
public function Annotation($x, $y, $w, $h, $text, $opt= array('Subtype'=> 'Text'), $spaces= 0) {
// store parameters for later use on template
$this->xobjects[$this->xobjid]['annotations'][] = array('x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'text' => $text, 'opt' => $opt, 'spaces' => $spaces);
// check page for no-write regions and adapt page margins if necessary
// recalculate coordinates to account for graphic transformations
for ($j= $maxid; $j >= 0; -- $j) {
$y = ($this->h - $y) * $this->k;
$x1 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
$y1 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
$x2 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
$y2 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
$x3 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
$y3 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
$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;
$y = $this->h - ($y / $this->k);
$this->PageAnnots[$page][] = array('n' => $this->n, 'x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'txt' => $text, 'opt' => $opt, 'numspaces' => $spaces);
// 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);
* Embedd the attached files.
* @since 4.4.000 (2008-12-07)
$filter = ' /Filter /FlateDecode';
$out = $this->_getobj($filedata['n']). "\n";
$out .= '<< /Type /EmbeddedFile'. $filter. ' /Length '. strlen($stream). ' >>';
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
* Prints a text cell at the specified position.
* 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 cell origin
* @param float $y Ordinate of the cell origin
* @param string $txt String to print
* @param int $fstroke outline size in user units (false = disable)
* @param boolean $fclip if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).
* @param boolean $ffill if true fills the text
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param mixed $link URL or identifier returned by AddLink().
* @param int $stretch font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param boolean $ignore_min_height if true ignore automatic minimum height value.
* @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li><li>B : cell bottom</li></ul>
* @param string $valign text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>
* @param boolean $rtloff if true uses the page top-left corner as origin of axis for $x and $y initial position.
* @see Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()
public function Text($x, $y, $txt, $fstroke= false, $fclip= false, $ffill= true, $border= 0, $ln= 0, $align= '', $fill= false, $link= '', $stretch= 0, $ignore_min_height= false, $calign= 'T', $valign= 'M', $rtloff= false) {
$this->SetXY($x, $y, $rtloff);
$this->Cell(0, 0, $txt, $border, $ln, $align, $fill, $link, $stretch, $ignore_min_height, $calign, $valign);
// restore previous rendering mode
* Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
* The default implementation returns a value according to the mode selected by SetAutoPageBreak().<br />
* This method is called automatically and should not be called directly by the application.
* @see SetAutoPageBreak()
// avoid page breaking from checkPageBreak()
* @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)
$current_page = $this->page;
$oldpage = $this->page - 1;
if ($current_page != $this->page) {
// account for columns mode
* Removes SHY characters from text.
* <li>Name : SOFT HYPHEN, commonly abbreviated as SHY</li>
* <li>HTML Entity (decimal): &#173;</li>
* <li>HTML Entity (hex): &#xad;</li>
* <li>HTML Entity (named): &shy;</li>
* <li>How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]</li>
* <li>UTF-8 (hex): 0xC2 0xAD (c2ad)</li>
* <li>UTF-8 character: chr(194).chr(173)</li>
* @param string $txt input string
* @return string without SHY characters.
* @since (4.5.019) 2009-02-28
* Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* @param float $w Cell width. If 0, the cell extends up to the right margin.
* @param float $h Cell height. Default value: 0.
* @param string $txt String to print. Default value: empty string.
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param mixed $link URL or identifier returned by AddLink().
* @param int $stretch font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param boolean $ignore_min_height if true ignore automatic minimum height value.
* @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
* @param string $valign text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()
public function Cell($w, $h= 0, $txt= '', $border= 0, $ln= 0, $align= '', $fill= false, $link= '', $stretch= 0, $ignore_min_height= false, $calign= 'T', $valign= 'M') {
if (!$ignore_min_height) {
if ($h < $min_cell_height) {
$this->_out($this->getCellCode($w, $h, $txt, $border, $ln, $align, $fill, $link, $stretch, true, $calign, $valign));
* Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* @param float $w Cell width. If 0, the cell extends up to the right margin.
* @param float $h Cell height. Default value: 0.
* @param string $txt String to print. Default value: empty string.
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param mixed $link URL or identifier returned by AddLink().
* @param int $stretch font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param boolean $ignore_min_height if true ignore automatic minimum height value.
* @param string $calign cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
* @param string $valign text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>M : middle</li><li>B : bottom</li></ul>
* @return string containing cell code
protected function getCellCode($w, $h= 0, $txt= '', $border= 0, $ln= 0, $align= '', $fill= false, $link= '', $stretch= 0, $ignore_min_height= false, $calign= 'T', $valign= 'M') {
$rs = ''; //string to be returned
if (!$ignore_min_height) {
if ($h < $min_cell_height) {
// check page for no-write regions and adapt page margins if necessary
// cell vertical alignment
// text vertical alignment
if ($fill OR ($border == 1)) {
$op = ($border == 1) ? 'B' : 'f';
$s .= sprintf('%.2F %.2F %.2F %.2F re %s ', $xk, (($this->h - $y) * $k), ($w * $k), (- $h * $k), $op);
// ---- Fix for bug #2977340 "Incorrect Thai characters position arrangement" ----
// NOTE: this doesn't work with HTML justification
// Symbols that could overlap on the font top (only works in LTR)
$topchar = array(3611, 3613, 3615, 3650, 3651, 3652); // chars that extends on top
$topsym = array(3633, 3636, 3637, 3638, 3639, 3655, 3656, 3657, 3658, 3659, 3660, 3661, 3662); // symbols with top position
$numchars = count($unicode); // number of chars
$uniblock[$unik] = array();
$uniblock[$unik][] = $unicode[0];
// resolve overlapping conflicts by splitting the string in several parts
for ($i = 1; $i < $numchars; ++ $i) {
// check if symbols overlaps at top
if (in_array($unicode[$i], $topsym) AND (in_array($unicode[($i - 1)], $topsym) OR in_array($unicode[($i - 1)], $topchar))) {
// move symbols to another array
$uniblock[$unik] = array();
$uniblock[$unik][] = $unicode[$i];
$uniblock[$unik] = array();
$unicode[$i] = 0x200b; // Unicode Character 'ZERO WIDTH SPACE' (DEC:8203, U+200B)
$uniblock[$unik][] = $unicode[$i];
// ---- END OF Fix for bug #2977340
// get current text width (considering general font stretching and spacing)
// check for stretch mode
// calculate ratio between cell width and text width
// check if stretching is required
if (($ratio < 1) OR (($ratio > 1) AND (($stretch % 2) == 0))) {
// the text will be stretched to fit cell width
// set new character spacing
// set new horizontal stretching
// recalculate text width (the text fills the entire cell)
// increase/decrease font spacing
// count number of spaces
if (($align == 'J') AND ($ns > 0)) {
// get string width without spaces
// calculate average space width
// word spacing is affected by stretching
// set word position to be used with TJ operator
$unicode_justification = true;
// word spacing (Tw) is affected by stretching
$rs .= sprintf('BT %.3F Tw ET ', $spacewidth);
// replace carriage return characters
$xdx = $x - $dx - $width;
$s .= sprintf('BT %.2F %.2F Td [(%s)] TJ ET', $xdk, (($this->h - $basefonty) * $k), $txt2);
// print overlapping characters as separate string
$xshift = 0; // horizontal shift
$ty = (($this->h - $basefonty + (0.2 * $this->FontSize)) * $k);
foreach ($uniblock as $uk => $uniarr) {
$s .= sprintf(' BT %.2F %.2F Td [(%s)] TJ ET', ($xdk + ($xshift * $k)), $ty, $topchr);
// reset font spacing mode
// reset font stretching mode
// reset stretching and spacing
//Go to the beginning of the next line
// go left or right by case
* Returns the code to draw the cell border
* @param float $x X coordinate.
* @param float $y Y coordinate.
* @param float $w Cell width.
* @param float $h Cell height.
* @param mixed $brd Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param string $mode border position respect the square edge: normal: centered; ext: external; int: internal;
* @return string containing cell border code
* @since 5.7.000 (2010-08-02)
$s = ''; // string to be returned
$brd = array('LRTB' => true);
// calculate coordinates for border
$yeL = (($this->h - ($y + $h)) * $k);
$yeT = (($this->h - $y) * $k);
// convert string to array
for ($i = 0; $i < $slen; ++ $i) {
$newbrd[$brd{$i}] = array('cap' => 'square', 'join' => 'miter');
if (isset ($brd['mode'])) {
foreach ($brd as $border => $style) {
if (is_array($style) AND !empty($style)) {
$s .= sprintf('%.2F %.2F %.2F %.2F re S ', $xT, $yT, ($w * $k), (- $h * $k));
} elseif (strlen($border) == 3) {
if (strpos($border,'B') === false) { // LTR
$s .= sprintf('%.2F %.2F m ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
} elseif (strpos($border,'L') === false) { // TRB
$s .= sprintf('%.2F %.2F m ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
} elseif (strpos($border,'T') === false) { // RBL
$s .= sprintf('%.2F %.2F m ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
} elseif (strpos($border,'R') === false) { // BLT
$s .= sprintf('%.2F %.2F m ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
} elseif (strlen($border) == 2) {
if ((strpos($border,'L') !== false) AND (strpos($border,'T') !== false)) { // LT
$s .= sprintf('%.2F %.2F m ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
} elseif ((strpos($border,'T') !== false) AND (strpos($border,'R') !== false)) { // TR
$s .= sprintf('%.2F %.2F m ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
} elseif ((strpos($border,'R') !== false) AND (strpos($border,'B') !== false)) { // RB
$s .= sprintf('%.2F %.2F m ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
} elseif ((strpos($border,'B') !== false) AND (strpos($border,'L') !== false)) { // BL
$s .= sprintf('%.2F %.2F m ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
} elseif ((strpos($border,'L') !== false) AND (strpos($border,'R') !== false)) { // LR
$s .= sprintf('%.2F %.2F m ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
$s .= sprintf('%.2F %.2F m ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
} elseif ((strpos($border,'T') !== false) AND (strpos($border,'B') !== false)) { // TB
$s .= sprintf('%.2F %.2F m ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
$s .= sprintf('%.2F %.2F m ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
} else { // strlen($border) == 1
if (strpos($border,'L') !== false) { // L
$s .= sprintf('%.2F %.2F m ', $xL, $yL);
$s .= sprintf('%.2F %.2F l ', $xT, $yT);
} elseif (strpos($border,'T') !== false) { // T
$s .= sprintf('%.2F %.2F m ', $xT, $yT);
$s .= sprintf('%.2F %.2F l ', $xR, $yR);
} elseif (strpos($border,'R') !== false) { // R
$s .= sprintf('%.2F %.2F m ', $xR, $yR);
$s .= sprintf('%.2F %.2F l ', $xB, $yB);
} elseif (strpos($border,'B') !== false) { // B
$s .= sprintf('%.2F %.2F m ', $xB, $yB);
$s .= sprintf('%.2F %.2F l ', $xL, $yL);
if (is_array($style) AND !empty($style)) {
// reset border style to previous value
* This method allows printing text with line breaks.
* They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.<br />
* Text can be aligned, centered or justified. The cell block can be framed and the background painted.
* @param float $w Width of cells. If 0, they extend up to the right margin of the page.
* @param float $h Cell minimum height. The cell extends automatically if needed.
* @param string $txt String to print
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul>
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
* @param float $x x position in user units
* @param float $y y position in user units
* @param boolean $reseth if true reset the last cell height (default true).
* @param int $stretch font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param boolean $ishtml set to true if $txt is HTML content (default = false).
* @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
* @param float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
* @param string $valign Vertical alignment of text (requires $maxh = $h > 0). Possible values are:<ul><li>T: TOP</li><li>M: middle</li><li>B: bottom</li></ul>. This feature works only when $ishtml=false.
* @param boolean $fitcell if true attempt to fit all the text within the cell by reducing the font size.
* @return int Return the number of cells or 1 for html mode.
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()
public function MultiCell($w, $h, $txt, $border= 0, $align= 'J', $fill= false, $ln= 1, $x= '', $y= '', $reseth= true, $stretch= 0, $ishtml= false, $autopadding= true, $maxh= 0, $valign= 'T', $fitcell= false) {
// adjust internal padding
// spit cell in more pages/columns
$resth = $h - $newh; // cell to be printed on the next page/column
// get current page number
$startpage = $this->page;
// check page for no-write regions and adapt page margins if necessary
$oy = $y + $mc_margin['T'];
$ox = $this->w - $x - $mc_margin['R'];
$ox = $x + $mc_margin['L'];
$w = $this->x - $this->lMargin - $mc_margin['L'];
$w = $this->w - $this->x - $this->rMargin - $mc_margin['R'];
// store original margin values
$this->y += $mc_padding['T'];
if ($ishtml) { // ******* Write HTML text
$this->writeHTML($txt, true, 0, $reseth, true, $align);
} else { // ******* Write simple text
$text_height = $this->getStringHeight($w, $txt, $reseth, $autopadding, $mc_padding, $border);
// try to reduce font size to fit text on cell (use a quick search algorithm)
$prev_text_height = $text_height;
$maxit = 100; // max number of iterations
$fmid = (($fmax + $fmin) / 2);
$text_height = $this->getStringHeight($w, $txt, $reseth, $autopadding, $mc_padding, $border);
if (($text_height == $maxh) OR (($text_height < $maxh) AND ($fmin >= ($fmax - 0.01)))) {
} elseif ($text_height < $maxh) {
if ($text_height < $maxh) {
// text vertically centered
$this->y += (($maxh - $text_height) / 2);
} elseif ($valign == 'B') {
// text vertically aligned on bottom
$this->y += ($maxh - $text_height);
$nl = $this->Write($this->lasth, $txt, '', 0, $align, true, $stretch, false, true, $maxh, 0, $mc_margin);
$this->y += $mc_padding['B'];
// Get end-of-text Y position
// get latest page number
$skip = ($endpage - $startpage);
// add a page (or trig AcceptPageBreak() for multicolumn mode)
$tmpresth -= ($this->h - $this->y - $this->bMargin);
$border_start = $this->getBorderMode($border, $position= 'start');
$border_middle = $this->getBorderMode($border, $position= 'middle');
// design borders around HTML cells.
for ($page = $startpage; $page <= $endpage; ++ $page) { // for each page
// account for margin changes
if ($page > $startpage) {
if (($this->rtl) AND ($this->pagedim[$page]['orm'] != $this->pagedim[$startpage]['orm'])) {
$this->x -= ($this->pagedim[$page]['orm'] - $this->pagedim[$startpage]['orm']);
} elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
$this->x += ($this->pagedim[$page]['olm'] - $this->pagedim[$startpage]['olm']);
if ($startpage == $endpage) {
for ($column = $startcolumn; $column <= $endcolumn; ++ $column) { // for each column
$this->x -= $mc_margin['R'];
$this->x += $mc_margin['L'];
if ($startcolumn == $endcolumn) { // single column
$h = max($h, ($currentY - $oy));
} elseif ($column == $startcolumn) { // first column
$cborder = $border_start;
} elseif ($column == $endcolumn) { // end column
$h = $currentY - $this->y;
} else { // middle column
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $startpage) { // first page
for ($column = $startcolumn; $column < $this->num_columns; ++ $column) { // for each column
$this->x -= $mc_margin['R'];
$this->x += $mc_margin['L'];
if ($column == $startcolumn) { // first column
$cborder = $border_start;
} else { // middle column
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $endpage) { // last page
for ($column = 0; $column <= $endcolumn; ++ $column) { // for each column
$this->x -= $mc_margin['R'];
$this->x += $mc_margin['L'];
if ($column == $endcolumn) {
$h = $currentY - $this->y;
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
for ($column = 0; $column < $this->num_columns; ++ $column) { // for each column
$this->x -= $mc_margin['R'];
$this->x += $mc_margin['L'];
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
// we are inside an XObject template
$pagemark = &$this->xobjects[$this->xobjid]['transfmrk'][$pagemarkkey];
$pstart = substr($pagebuff, 0, $pagemark);
$pend = substr($pagebuff, $pagemark);
$pstart = substr($pagebuff, 0, $pagemark);
$pend = substr($pagebuff, $pagemark);
// Get end-of-cell Y position
$currentY = $this->GetY();
// restore original margin values
//Go to the beginning of the next line
$this->SetY($currentY + $mc_margin['B']);
$this->SetX($x + $w + $mc_margin['L'] + $mc_margin['R']);
// go left or right by case
$this->SetX($x + $w + $mc_margin['L'] + $mc_margin['R']);
* Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
* @param mixed $brd Indicates if borders must be drawn around the cell block. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param string multicell position: 'start', 'middle', 'end'
* @return border mode array
* @since 4.4.002 (2008-12-09)
if ((!$this->opencell) OR empty($brd)) {
// convert string to array
for ($i = 0; $i < $slen; ++ $i) {
$newbrd[$brd{$i}] = array('cap' => 'square', 'join' => 'miter');
foreach ($brd as $border => $style) {
if (strpos($border, 'B') !== false) {
if (strpos($border, 'B') !== false) {
if (strpos($border, 'T') !== false) {
if (strpos($border, 'T') !== false) {
* This method return the estimated number of lines for print a simple text string using Multicell() method.
* @param string $txt String for calculating his height
* @param float $w Width of cells. If 0, they extend up to the right margin of the page.
* @param boolean $reseth if true reset the last cell height (default false).
* @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width (default true).
* @param float $cellpadding Internal cell padding, if empty uses default cell padding.
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Alexander Escalona Fernández, Nicola Asuni
public function getNumLines($txt, $w= 0, $reseth= false, $autopadding= true, $cellpadding= '', $border= 0) {
// adjust internal padding
$prev_lasth = $this->lasth;
for ($i = 0; $i < $length; ++ $i) {
$charWidth = $charsWidth[$i];
if ((($sum + $charWidth) > $wmax) OR ($chars[$i] == 10)) {
if ($lastSeparator != - 1) {
if ($chars[($length - 1)] == 10) {
$this->lasth = $prev_lasth;
* This method return the estimated needed height for print a simple text string in Multicell() method.
* Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
* // store current object
* $pdf->startTransaction();
* // store starting values
* $start_y = $pdf->GetY();
* $start_page = $pdf->getPage();
* // call your printing functions with your parameters
* // - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
* $pdf->MultiCell($w=0, $h=0, $txt, $border=1, $align='L', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0);
* // - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
* $end_page = $pdf->getPage();
* if ($end_page == $start_page) {
* $height = $end_y - $start_y;
* for ($page=$start_page; $page <= $end_page; ++$page) {
* if ($page == $start_page) {
* $height = $this->h - $start_y - $this->bMargin;
* } elseif ($page == $end_page) {
* $height = $end_y - $this->tMargin;
* $height = $this->h - $this->tMargin - $this->bMargin;
* // restore previous object
* $pdf = $pdf->rollbackTransaction();
* @param float $w Width of cells. If 0, they extend up to the right margin of the page.
* @param string $txt String for calculating his height
* @param boolean $reseth if true reset the last cell height (default false).
* @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width (default true).
* @param float $cellpadding Internal cell padding, if empty uses default cell padding.
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Nicola Asuni, Alexander Escalona Fernández
public function getStringHeight($w, $txt, $reseth= false, $autopadding= true, $cellpadding= '', $border= 0) {
// adjust internal padding
$prev_lasth = $this->lasth;
$lines = $this->getNumLines($txt, $w, $reseth, $autopadding, $cellpadding, $border);
// add top and bottom padding
$this->lasth = $prev_lasth;
* This method prints text from the current position.<br />
* @param float $h Line height
* @param string $txt String to print
* @param mixed $link URL or identifier returned by AddLink()
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param boolean $ln if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
* @param int $stretch font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param boolean $firstline if true prints only the first line and return the remaining string.
* @param boolean $firstblock if true the string is the starting of a line.
* @param float $maxh maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
* @param float $wadj first line width will be reduced by this amount (used in HTML mode).
* @param array $margin margin array of the parent container
* @return mixed Return the number of cells or the remaining string if $firstline = true.
public function Write($h, $txt, $link= '', $fill= false, $align= '', $ln= false, $stretch= 0, $firstline= false, $firstblock= false, $maxh= 0, $wadj= 0, $margin= '') {
// check page for no-write regions and adapt page margins if necessary
// remove carriage returns
// check if string contains arabic text
// check if string contains RTL text
// get array of unicode values
// get the number of characters
// replacement for SHY character (minus symbol)
$shy_replacement_char = $this->unichr($shy_replacement);
// widht for SHY replacement
$shy_replacement_width = $this->GetCharWidth($shy_replacement);
// calculate remaining line width ($w)
if ((!$firstline) AND (($chrwidth > $wmax) OR ($this->GetCharWidth($chars[0]) > $wmax))) {
// a single character do not fit on column
$start_page = $this->page;
$i = 0; // character position
$j = 0; // current starting position
$sep = - 1; // position of the last blank space
$shy = false; // true if the last blank is a soft hypen (SHY)
$l = 0; // current string length
$nl = 0; //number of lines
$pc = 0; // previous character
if (($maxh > 0) AND ($this->y >= $maxy) ) {
//Get the current character
if ($c == 10) { // 10 = "\n" = new line
// Skip newlines at the begining of a page or column
$this->Cell($w, $h, $tmpstr, 0, 1, $talign, $fill, $link, $stretch);
// account for margin changes
$this->x -= $margin['R'];
$this->x += $margin['L'];
// 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.
// update last blank space position
$tmp_shy_replacement_width = 0;
$tmp_shy_replacement_char = '';
$tmp_shy_replacement_width = $shy_replacement_width;
$tmp_shy_replacement_char = $shy_replacement_char;
// with bidirectional algorithm some chars may be changed affecting the line length
if (($l > $wmax) OR (($c == 173) AND (($l + $tmp_shy_replacement_width) > $wmax)) ) {
// we have reached the end of column
// check if the line was already started
if (($this->rtl AND ($this->x <= ($this->w - $this->rMargin - $chrwidth)))
OR ((!$this->rtl) AND ($this->x >= ($this->lMargin + $chrwidth)))) {
// print a void cell and go to next line
$this->Cell($w, $h, '', 0, 1);
// truncate the word because do not fit on column
$this->Cell($w, $h, $tmpstr, 0, 1, $align, $fill, $link, $stretch);
if ($this->rtl AND (!$firstblock) AND ($sep < $i)) {
// add hypen (minus symbol) at the end of the line
$shy_width = $tmp_shy_replacement_width;
$shy_char_left = $tmp_shy_replacement_char;
$shy_char_right = $tmp_shy_replacement_char;
$tmparr = array_slice($chars, $j, (($sep + $endspace) - $j));
$this->endlinex = $startx - $linew - $shy_width;
$this->endlinex = $startx + $linew + $shy_width;
$this->Cell($w, $h, $shy_char_left. $tmpstr. $shy_char_right, 0, 1, $align, $fill, $link, $stretch);
// return the remaining text
// account for margin changes
$this->x -= $margin['R'];
$this->x += $margin['L'];
// print last substring (if any)
$this->Cell($w, $h, $tmpstr, 0, $ln, $align, $fill, $link, $stretch);
* Returns the remaining width between the current position and margins.
* @return int Return the remaining width
return ($this->w - $this->rMargin - $this->x);
* 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
for ($i= $start; $i < $end; ++ $i) {
$string .= $this->unichr($strarr[$i]);
* 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
* @since 4.5.037 (2009-04-07)
for ($i= $start; $i < $end; ++ $i) {
* 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
* @since 4.5.037 (2009-04-07)
return array_map(array($this, 'unichr'), $ta);
* Returns the unicode caracter specified by UTF-8 value
* @param int $c UTF-8 value
* @return Returns the specified character.
* @author Miguel Perez, Nicola Asuni
* @since 2.3.000 (2008-03-05)
return chr(0xC0 | $c >> 6). chr(0x80 | $c & 0x3F);
} elseif ($c <= 0xFFFF) {
return chr(0xE0 | $c >> 12). chr(0x80 | $c >> 6 & 0x3F). chr(0x80 | $c & 0x3F);
} elseif ($c <= 0x10FFFF) {
return chr(0xF0 | $c >> 18). chr(0x80 | $c >> 12 & 0x3F). chr(0x80 | $c >> 6 & 0x3F). chr(0x80 | $c & 0x3F);
* Return the image type given the file name or array returned by getimagesize() function.
* @param string $imgfile image file name
* @param array $iminfo array of image information returned by getimagesize() function.
* @return string image type
* @since 4.8.017 (2009-11-27)
if (isset ($iminfo['mime']) AND !empty($iminfo['mime'])) {
$mime = explode('/', $iminfo['mime']);
if ((count($mime) > 1) AND ($mime[0] == 'image') AND (!empty($mime[1]))) {
if (isset ($fileinfo['extension']) AND (!$this->empty_string($fileinfo['extension']))) {
* Set the block dimensions accounting for page breaks and page/column fitting
* @param float $x X coordinate
* @param float $y Y coodiante
* @param boolean $fitonpage if true the block is resized to not exceed page dimensions.
* @since 5.5.009 (2010-07-05)
protected function fitBlock(&$w, &$h, &$x, &$y, $fitonpage= false) {
// resize the block to be vertically contained on a single page or single column
// resize the block to be horizontally contained on a single page or single column
// Check whether we need a new page or new column first as this does not fit
$x += ($prev_x - $this->x);
$x += ($this->x - $prev_x);
// resize the block to be contained on the remaining available page or column space
if ((!$this->rtl) AND (($x + $w) > ($this->w - $this->rMargin))) {
} elseif (($this->rtl) AND (($x - $w) < ($this->lMargin))) {
* Puts an image in the page.
* The upper-left corner must be given.
* The dimensions can be specified in different ways:<ul>
* <li>explicit width and height (expressed in user unit)</li>
* <li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li>
* <li>no explicit dimension, in which case the image is put at 72 dpi</li></ul>
* Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;
* The format can be specified explicitly or inferred from the file extension.<br />
* It is possible to put a link on the image.<br />
* Remark: if an image is used several times, only one copy will be embedded in the file.<br />
* @param string $file Name of the file containing the image.
* @param float $x Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
* @param float $y Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
* @param mixed $link URL or identifier returned by AddLink().
* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @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:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param boolean $ismask true if this image is a mask, false otherwise
* @param mixed $imgmask image object returned by this function or false
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param boolean $fitbox If true scale image dimensions proportionally to fit within the ($w, $h) box.
* @param boolean $hidden if true do not display the image.
* @param boolean $fitonpage if true the image is resized to not exceed page dimensions.
* @return image information
public function Image($file, $x= '', $y= '', $w= 0, $h= 0, $type= '', $link= '', $align= '', $resize= false, $dpi= 300, $palign= '', $ismask= false, $imgmask= false, $border= 0, $fitbox= false, $hidden= false, $fitonpage= false) {
// check page for no-write regions and adapt page margins if necessary
$cached_file = false; // true when the file is cached
// try to encode spaces on filename
// try to get remote file data using cURL
} elseif (($w > 0) AND ($h > 0)) {
// get measures from specified data
$imsize = array($pw, $ph);
$this->Error('[Image] Unable to get image: '. $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
} 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) {
// fit the image on available space
$this->fitBlock($w, $h, $x, $y, $fitonpage);
// 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)
$newsize = ($neww * $newh);
$pixsize = ($pixw * $pixh);
} elseif ($newsize >= $pixsize) {
// check if image has been already added on document
// get existing image data
// check if the newer image is larger
$oldsize = ($info['w'] * $info['h']);
if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
//First use of image, get info
} elseif ($type == 'jpg') {
// Specific image handlers
// GD image handler function
$gdfunction = 'imagecreatefrom'. $type;
$info = $this->$mtd($file);
if ($info == 'pngalpha') {
return $this->ImagePngAlpha($file, $x, $y, $pixw, $pixh, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign);
$img = $gdfunction($file);
if (($type == 'gif') OR ($type == 'png')) {
if (($type == 'gif') OR ($type == 'png')) {
if (($type == 'gif') OR ($type == 'png')) {
if (preg_match('/<svg([^\>]*)>/si', $svgimg, $regs)) {
if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
$svgtag = preg_replace('/[\s]+width[\s]*=[\s]*"[^"]*"/si', ' width="'. $owu. '"', $svgtag, 1);
if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
$svgtag = preg_replace('/[\s]+height[\s]*=[\s]*"[^"]*"/si', ' height="'. $ohu. '"', $svgtag, 1);
if (!preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $svgtag, $tmp)) {
$vbox = sprintf(' viewBox="0 0 %.3F %.3F" ', $vbw, $vbh);
$svgimg = preg_replace('/<svg([^\>]*)>/si', '<svg'. $svgtag. '>', $svgimg, 1);
$img->readImageBlob($svgimg);
$img->resizeImage($neww, $newh, 10, 1, false);
$img->setImageFormat('jpeg');
$img->writeImage($tempname);
//If false, we cannot process image
$info['cs'] = 'DeviceGray';
if ($imgmask !== false) {
$info['masked'] = $imgmask;
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
if ($ismask OR $hidden) {
// image is not displayed
$xkimg = $ximg * $this->k;
$this->_out(sprintf('q %.2F 0 0 %.2F %.2F %.2F cm /I%u Do Q', ($w * $this->k), ($h * $this->k), $xkimg, (($this->h - ($y + $h)) * $this->k), $info['i']));
$this->Cell($w, $h, '', $border, 0, '', 0, '', 0, true);
$this->Link($ximg, $y, $w, $h, $link, 0);
// set pointer to align the next text/objects
// we are inside an XObject template
* 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)
define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4}));
if (PHP_VERSION_ID < 50300) {
* 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)
define('PHP_VERSION_ID', (($version{0} * 10000) + ($version{2} * 100) + $version{4}));
if (PHP_VERSION_ID < 50300) {
* Convert the loaded image to a JPEG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
* @param string $file Image file name.
* @param image $image Image object.
* return image JPEG image object.
protected function _toJPEG($image) {
// tidy up by removing temporary image
* Convert the loaded image to a PNG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
* @param string $file Image file name.
* @param image $image Image object.
* return image PNG image object.
* @since 4.9.016 (2010-04-20)
protected function _toPNG($image) {
// tidy up by removing temporary image
* Set the transparency for the given GD image.
* @param image $new_image GD image object
* @param image $image GD image object.
* return GD image object.
* @since 4.9.016 (2010-04-20)
// default transparency color
$tcol = array('red' => 255, 'green' => 255, 'blue' => 255);
// get the colors for the transparency index
* Extract info from a JPEG file without using the GD library.
* @param string $file image file to parse
* @return array structure containing the image data
$this->Error('Missing or incorrect image file: '. $file);
$this->Error('Not a JPEG file: '. $file);
if ((!isset ($a['channels'])) OR ($a['channels'] == 3)) {
} elseif ($a['channels'] == 4) {
$colspace = 'DeviceCMYK';
$colspace = 'DeviceGray';
$bpc = isset ($a['bits']) ? $a['bits'] : 8;
return array('w' => $a[0], 'h' => $a[1], 'cs' => $colspace, 'bpc' => $bpc, 'f' => 'DCTDecode', 'data' => $data);
* Extract info from a PNG file without using the GD library.
* @param string $file image file to parse
* @return array structure containing the image data
$this->Error('Can\'t open image file: '. $file);
$this->Error('Not a PNG file: '. $file);
if (fread($f, 4) != 'IHDR') {
$this->Error('Incorrect PNG file: '. $file);
//$this->Error('16-bit depth not supported: '.$file);
$colspace = 'DeviceGray';
//$this->Error('Unknown compression method: '.$file);
//$this->Error('Unknown filter method: '.$file);
//$this->Error('Interlacing not supported: '.$file);
$parms = '/DecodeParms << /Predictor 15 /Colors '. ($ct == 2 ? 3 : 1). ' /BitsPerComponent '. $bpc. ' /Columns '. $w. ' >>';
//Scan chunks looking for palette, transparency and image data
} elseif ($type == 'tRNS') {
} elseif ($type == 'IDAT') {
$data .= $this->rfread($f, $n);
} elseif ($type == 'IEND') {
if (($colspace == 'Indexed') AND (empty($pal))) {
//$this->Error('Missing palette in '.$file);
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
* @return Returns the read string or FALSE in case of error.
* @since 4.5.027 (2009-03-16)
protected function rfread($handle, $length) {
$data = fread($handle, $length);
$rest = $length - strlen($data);
$data .= $this->rfread($handle, $rest);
* Extract info from a PNG image with alpha channel using the GD library.
* @param string $file Name of the file containing the image.
* @param float $x Abscissa of the upper-left corner.
* @param float $y Ordinate of the upper-left corner.
* @param float $wpx Original width of the image in pixels.
* @param float $hpx original height of the image in pixels.
* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
* @param mixed $link URL or identifier returned by AddLink().
* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @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:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @since 4.3.007 (2008-12-04)
protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign) {
// create temp image file (without alpha channel)
// create temp alpha file
$img->separateImageChannel(imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE);
$img->setImageFormat('png');
$img->writeImage($tempfile_alpha);
$imga->separateImageChannel(imagick::CHANNEL_ALL & ~ (imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE));
$imga->setImageFormat('png');
$imga->writeImage($tempfile_plain);
// generate gray scale palette (0 -> 255)
for ($c = 0; $c < 256; ++ $c) {
ImageColorAllocate($imgalpha, $c, $c, $c);
for ($xpx = 0; $xpx < $wpx; ++ $xpx) {
for ($ypx = 0; $ypx < $hpx; ++ $ypx) {
$alpha = ($color >> 24); // shifts off the first 24 bits (where 8x3 are used for each color), and returns the remaining 7 allocated bits (commonly used for alpha)
$alpha = (((127 - $alpha) / 127) * 255); // GD alpha is only 7 bit (0 -> 127)
$alpha = $this->getGDgamma($alpha); // correct gamma
// extract image without alpha channel
imagecopy($imgplain, $img, 0, 0, 0, 0, $wpx, $hpx);
$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);
* Correct the gamma value to be used with GD library
* @param float $v the gamma value to be corrected
* @since 4.3.007 (2008-12-04)
return (pow(($v / 255), 2.2) * 255);
* The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
* @param float $h The height of the break. By default, the value equals the height of the last printed cell.
* @param boolean $cell if true add the current left (or right o for RTL) padding to the X coordinate
public function Ln($h= '', $cell= false) {
// revove vertical space from the top of the column
$this->x = $this->w - $this->rMargin - $cellpadding;
$this->x = $this->lMargin + $cellpadding;
* 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.
* @see SetX(), GetY(), SetY()
return ($this->w - $this->x);
* Returns the absolute X value of current position.
* @see SetX(), GetY(), SetY()
* Returns the ordinate of the current position.
* @see SetY(), GetX(), SetX()
* Defines the abscissa of the current position.
* If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
* @param float $x The value of the abscissa.
* @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
* @see GetX(), GetY(), SetY(), SetXY()
public function SetX($x, $rtloff= false) {
if (!$rtloff AND $this->rtl) {
$this->x = $this->w - $x;
$this->x = $this->w + $x;
if ($this->x > $this->w) {
* Moves the current abscissa back to the left margin and sets the ordinate.
* If the passed value is negative, it is relative to the bottom of the page.
* @param float $y The value of the ordinate.
* @param bool $resetx if true (default) reset the X position.
* @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
* @see GetX(), GetY(), SetY(), SetXY()
public function SetY($y, $resetx= true, $rtloff= false) {
if (!$rtloff AND $this->rtl) {
$this->y = $this->h + $y;
if ($this->y > $this->h) {
* Defines the abscissa and ordinate of the current position.
* If the passed values are negative, they are relative respectively to the right and bottom of the page.
* @param float $x The value of the abscissa.
* @param float $y The value of the ordinate.
* @param boolean $rtloff if true always uses the page top-left corner as origin of axis.
public function SetXY($x, $y, $rtloff= false) {
$this->SetY($y, false, $rtloff);
$this->SetX($x, $rtloff);
* Send the document to a given destination: string, local file or browser.
* In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.<br />
* 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:<ul><li>I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local server file with the name given by name.</li><li>S: return the document as a string. name is ignored.</li><li>FI: equivalent to F + I option</li><li>FD: equivalent to F + D option</li></ul>
public function Output($name= 'doc.pdf', $dest= 'I') {
//Output PDF to some destination
//Finish document if necessary
$dest = $dest ? 'D' : 'F';
// *** apply digital signature to the document ***
// get the document content
$pdfdoc = substr($pdfdoc, 0, - 1);
// Remove the original buffer
// remove buffer file from cache
$byte_range[3] = strlen($pdfdoc) - $byte_range[2];
$pdfdoc = substr($pdfdoc, 0, $byte_range[1]). substr($pdfdoc, $byte_range[2]);
$byterange = sprintf('/ByteRange[0 %u %u %u]', $byte_range[1], $byte_range[2], $byte_range[3]);
// write the document to a temporary folder
$f = fopen($tempdoc, 'wb');
$this->Error('Unable to create temporary file: '. $tempdoc);
$pdfdoc_length = strlen($pdfdoc);
fwrite($f, $pdfdoc, $pdfdoc_length);
// get digital signature via openssl library
$signature = substr($signature, $pdfdoc_length);
$signature = substr($signature, (strpos($signature, "%%EOF\n\n------") + 13));
$tmparr = explode("\n\n", $signature);
// convert signature to hex
// Add signature to the document
$pdfdoc = substr($pdfdoc, 0, $byte_range[1]). '<'. $signature. '>'. substr($pdfdoc, $byte_range[1]);
// Send PDF to the standard output
$this->Error('Some data has already been output, can\'t send PDF file');
header('Content-Type: application/pdf');
$this->Error('Some data has already been output to browser, can\'t send PDF file');
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Content-Disposition: inline; filename="'. basename($name). '";');
$this->Error('Some data has already been output, can\'t send PDF file');
header('Content-Description: File Transfer');
$this->Error('Some data has already been output to browser, can\'t send PDF file');
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Content-Type: application/force-download');
header('Content-Type: application/octet-stream', false);
header('Content-Type: application/download', false);
header('Content-Type: application/pdf', false);
// use the Content-Disposition header to supply a recommended filename
header('Content-Disposition: attachment; filename="'. basename($name). '";');
header('Content-Transfer-Encoding: binary');
// Save PDF to a local file
$this->Error('Unable to create output file: '. $name);
// send headers to browser
header('Content-Type: application/pdf');
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Content-Disposition: inline; filename="'. basename($name). '";');
// send document to the browser
} elseif ($dest == 'FD') {
// send headers to browser
$this->Error('Some data has already been output, can\'t send PDF file');
header('Content-Description: File Transfer');
$this->Error('Some data has already been output to browser, can\'t send PDF file');
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Content-Type: application/force-download');
header('Content-Type: application/octet-stream', false);
header('Content-Type: application/download', false);
header('Content-Type: application/pdf', false);
// use the Content-Disposition header to supply a recommended filename
header('Content-Disposition: attachment; filename="'. basename($name). '";');
header('Content-Transfer-Encoding: binary');
// send document to the browser
// Returns PDF as a string
$this->Error('Incorrect output destination: '. $dest);
* 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
* @since 4.5.016 (2009-02-24)
public function _destroy($destroyall= false, $preserve_objcopy= false) {
// remove buffer file from cache
($val != 'internal_encoding')
AND ($val != 'bufferlen')
AND ($val != 'diskcache')
AND ($val != 'signature_data')
AND ($val != 'signature_max_length')
AND ($val != 'byterange_string')
if ((!$preserve_objcopy OR ($val != 'objcopy')) AND isset ($this->$val)) {
* Check for locale-related bug
//Check for locale-related bug
$this->Error('Don\'t alter the locale before including class file');
//Check for decimal separator
if (sprintf('%.1F', 1.0) != '1.0') {
$nbu = $this->UTF8ToUTF16BE($nbs, false); // replacement for unicode font
$filter = ($this->compress) ? '/Filter /FlateDecode ' : '';
for ($n= 1; $n <= $nb; ++ $n) {
// replace total pages group numbers
$alias_gau = $this->_escape('{'. $k. '}');
// replace page group numbers
$alias_pgau = $this->_escape('{'. $pk. '}');
// replace total pages number
$pnbu = $this->UTF8ToUTF16BE($pnbs, false); // replacement for unicode font
$out .= ' /Parent 1 0 R';
$out .= ' /Resources 2 0 R';
$boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox');
foreach ($boxes as $box) {
if (isset ($this->pagedim[$n]['BoxColorInfo']) AND !empty($this->pagedim[$n]['BoxColorInfo'])) {
$out .= ' /BoxColorInfo <<';
foreach ($boxes as $box) {
if (isset ($this->pagedim[$n]['BoxColorInfo'][$box])) {
if (isset ($this->pagedim[$n]['BoxColorInfo'][$box]['C'])) {
$color = $this->pagedim[$n]['BoxColorInfo'][$box]['C'];
$out .= sprintf(' %.3F %.3F %.3F', $color[0]/ 255, $color[1]/ 255, $color[2]/ 255);
if (isset ($this->pagedim[$n]['BoxColorInfo'][$box]['W'])) {
$out .= ' /W '. ($this->pagedim[$n]['BoxColorInfo'][$box]['W'] * $this->k);
if (isset ($this->pagedim[$n]['BoxColorInfo'][$box]['S'])) {
$out .= ' /S /'. $this->pagedim[$n]['BoxColorInfo'][$box]['S'];
if (isset ($this->pagedim[$n]['BoxColorInfo'][$box]['D'])) {
$dashes = $this->pagedim[$n]['BoxColorInfo'][$box]['D'];
foreach ($dashes as $dash) {
$out .= sprintf(' %.3F', ($dash * $this->k));
$out .= ' /Contents '. ($this->n + 1). ' 0 R';
$out .= ' /Rotate '. $this->pagedim[$n]['Rotate'];
$out .= ' /Group << /Type /Group /S /Transparency /CS /DeviceRGB >>';
if (isset ($this->pagedim[$n]['trans']) AND !empty($this->pagedim[$n]['trans'])) {
if (isset ($this->pagedim[$n]['trans']['Dur'])) {
$out .= ' /Dur '. $this->pagedim[$n]['trans']['Dur'];
if (isset ($this->pagedim[$n]['trans']['S'])) {
$out .= ' /S /'. $this->pagedim[$n]['trans']['S'];
if (isset ($this->pagedim[$n]['trans']['D'])) {
$out .= ' /D '. $this->pagedim[$n]['trans']['D'];
if (isset ($this->pagedim[$n]['trans']['Dm'])) {
$out .= ' /Dm /'. $this->pagedim[$n]['trans']['Dm'];
if (isset ($this->pagedim[$n]['trans']['M'])) {
$out .= ' /M /'. $this->pagedim[$n]['trans']['M'];
if (isset ($this->pagedim[$n]['trans']['Di'])) {
$out .= ' /Di '. $this->pagedim[$n]['trans']['Di'];
if (isset ($this->pagedim[$n]['trans']['SS'])) {
$out .= ' /SS '. $this->pagedim[$n]['trans']['SS'];
if (isset ($this->pagedim[$n]['trans']['B'])) {
$out .= ' /B '. $this->pagedim[$n]['trans']['B'];
$out .= ' /PZ '. $this->pagedim[$n]['PZ'];
$this->_out('<<'. $filter. '/Length '. strlen($p). '>> stream'. "\n". $p. "\n". 'endstream'. "\n". 'endobj');
// remove temporary files
$out .= '<< /Type /Pages /Kids [';
$out .= ' '. $page_obj. ' 0 R';
$out .= ' ] /Count '. $nb. ' >>';
* Output references to page annotations
* @param int $n page number
* @since 4.7.000 (2008-08-29)
* Get references to page annotations.
* @param int $n page number
* @since 5.0.010 (2010-05-17)
$out .= ' '. $val['n']. ' 0 R';
// add radiobutton groups
$out .= ' '. $data['n']. ' 0 R';
// set reference for signature object
* Output annotations objects for all pages.
* !!! THIS METHOD IS NOT YET COMPLETED !!!
* See section 12.5 of PDF 32000_2008 reference.
* @since 4.0.018 (2008-08-06)
for ($n= 1; $n <= $this->numpages; ++ $n) {
// create annotation object for grouping radiobuttons
$annots .= ' /Type /Annot';
$annots .= ' /Subtype /Widget';
$annots .= ' /Rect [0 0 0 0]';
$annots .= ' /T '. $this->_datastring($pl['txt'], $radio_button_obj_id);
$annots .= ' '. $data['kid']. ' 0 R';
if ($data['def'] !== 'Off') {
$annots .= ' /V /'. $defval;
$this->_out($this->_getobj($radio_button_obj_id). "\n". $annots. "\n". 'endobj');
// store object id to be used on Parent entry of Kids
$a = $pl['x'] * $this->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 = '<</Type /Annot';
$annots .= ' /Subtype /'. $pl['opt']['subtype'];
$annots .= ' /Rect ['. $rect. ']';
$ft = array('Btn', 'Tx', 'Ch', 'Sig');
if (isset ($pl['opt']['ft']) AND in_array($pl['opt']['ft'], $ft)) {
$annots .= ' /FT /'. $pl['opt']['ft'];
$annots .= ' /Contents '. $this->_textstring($pl['txt'], $annot_obj_id);
if (isset ($pl['opt']['f'])) {
foreach ($pl['opt']['f'] as $f) {
$val = intval($pl['opt']['f']);
$annots .= ' /F '. intval($val);
if (isset ($pl['opt']['as']) AND is_string($pl['opt']['as'])) {
$annots .= ' /AS /'. $pl['opt']['as'];
if (isset ($pl['opt']['ap'])) {
foreach ($pl['opt']['ap'] as $apmode => $apdef) {
// $apmode can be: n = normal; r = rollover; d = down;
foreach ($apdef as $apstate => $stream) {
// reference to XObject that define the appearance for this mode-state
$annots .= ' /'. $apstate. ' '. $apsobjid. ' 0 R';
// reference to XObject that define the appearance for this mode
$annots .= ' '. $apsobjid. ' 0 R';
$annots .= $pl['opt']['ap'];
if (isset ($pl['opt']['bs']) AND (is_array($pl['opt']['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']))) {
foreach ($pl['opt']['bs']['d'] as $cord) {
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])) {
foreach ($pl['opt']['border'][3] as $dash) {
if (isset ($pl['opt']['be']) AND (is_array($pl['opt']['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']['be']['i']) AND ($pl['opt']['be']['i'] >= 0) AND ($pl['opt']['be']['i'] <= 2)) {
$annots .= ' /I '. sprintf(' %.4F', $pl['opt']['be']['i']);
if (isset ($pl['opt']['c']) AND (is_array($pl['opt']['c'])) AND !empty($pl['opt']['c'])) {
foreach ($pl['opt']['c'] as $col) {
$color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255);
$annots .= sprintf(' %.4F', $color);
//$annots .= ' /StructParent ';
$markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound');
if (isset ($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
$annots .= ' /T '. $this->_textstring($pl['opt']['t'], $annot_obj_id);
if (isset ($pl['opt']['ca'])) {
if (isset ($pl['opt']['rc'])) {
$annots .= ' /RC '. $this->_textstring($pl['opt']['rc'], $annot_obj_id);
$annots .= ' /CreationDate '. $this->_datestring($annot_obj_id);
if (isset ($pl['opt']['subj'])) {
$annots .= ' /Subj '. $this->_textstring($pl['opt']['subj'], $annot_obj_id);
//$annots .= ' /ExData ';
$lineendings = array('Square', 'Circle', 'Diamond', 'OpenArrow', 'ClosedArrow', 'None', 'Butt', 'ROpenArrow', 'RClosedArrow', 'Slash');
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'];
$annots .= ' /Name /Note';
$statemodels = array('Marked', 'Review');
if (isset ($pl['opt']['statemodel']) AND in_array($pl['opt']['statemodel'], $statemodels)) {
$annots .= ' /StateModel /'. $pl['opt']['statemodel'];
$pl['opt']['statemodel'] = 'Marked';
$annots .= ' /StateModel /'. $pl['opt']['statemodel'];
if ($pl['opt']['statemodel'] == 'Marked') {
$states = array('Accepted', 'Unmarked');
$states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None');
if (isset ($pl['opt']['state']) AND in_array($pl['opt']['state'], $states)) {
$annots .= ' /State /'. $pl['opt']['state'];
if ($pl['opt']['statemodel'] == 'Marked') {
$annots .= ' /State /Unmarked';
$annots .= ' /State /None';
$l = $this->links[$pl['txt']];
$annots .= sprintf(' /Dest [%u 0 R /XYZ 0 %.2F null]', $this->page_obj_id[($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'];
//$annots .= ' /Quadpoints ';
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'], $annot_obj_id);
if (isset ($pl['opt']['ds'])) {
$annots .= ' /DS '. $this->_textstring($pl['opt']['ds'], $annot_obj_id);
if (isset ($pl['opt']['cl']) AND is_array($pl['opt']['cl'])) {
foreach ($pl['opt']['cl'] as $cl) {
$annots .= sprintf('%.4F ', $cl * $this->k);
$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'];
if (!isset ($pl['opt']['fs'])) {
$annots .= ' /FS <</Type /Filespec /F '. $this->_datastring($filename, $annot_obj_id). ' /EF <</F '. $this->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'];
$annots .= ' /Name /PushPin';
if (!isset ($pl['opt']['fs'])) {
// ... TO BE COMPLETED ...
$annots .= ' /Sound <</Type /Filespec /F '. $this->_datastring($filename, $annot_obj_id). ' /EF <</F '. $this->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'];
$annots .= ' /Name /Speaker';
$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'])) {
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']))) {
foreach($pl['opt']['mk']['bc'] AS $col) {
$color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255);
$annots .= sprintf(' %.2F', $color);
if (isset ($pl['opt']['mk']['bg']) AND (is_array($pl['opt']['mk']['bg']))) {
foreach($pl['opt']['mk']['bg'] AS $col) {
$color = $col <= 0 ? 0 : ($col >= 255 ? 1 : $col / 255);
$annots .= sprintf(' %.2F', $color);
if (isset ($pl['opt']['mk']['ca'])) {
$annots .= ' /CA '. $pl['opt']['mk']['ca'];
if (isset ($pl['opt']['mk']['rc'])) {
$annots .= ' /RC '. $pl['opt']['mk']['rc'];
if (isset ($pl['opt']['mk']['ac'])) {
$annots .= ' /AC '. $pl['opt']['mk']['ac'];
if (isset ($pl['opt']['mk']['i'])) {
$annots .= ' /I '. $info['n']. ' 0 R';
if (isset ($pl['opt']['mk']['ri'])) {
$annots .= ' /RI '. $info['n']. ' 0 R';
if (isset ($pl['opt']['mk']['ix'])) {
$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'])) {
$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 (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 .= sprintf(' /A [%.2F %.2F]', $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'])) {
if (isset ($pl['opt']['mk']['tp']) AND ($pl['opt']['mk']['tp'] >= 0) AND ($pl['opt']['mk']['tp'] <= 6)) {
$annots .= ' /TP '. intval($pl['opt']['mk']['tp']);
// --- Entries for field dictionaries ---
if (isset ($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
$annots .= ' /T '. $this->_datastring($pl['opt']['t'], $annot_obj_id);
if (isset ($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) {
$annots .= ' /TU '. $this->_datastring($pl['opt']['tu'], $annot_obj_id);
if (isset ($pl['opt']['tm']) AND is_string($pl['opt']['tm'])) {
$annots .= ' /TM '. $this->_datastring($pl['opt']['tm'], $annot_obj_id);
if (isset ($pl['opt']['ff'])) {
foreach($pl['opt']['ff'] as $val) {
$flag += 1 << ($val - 1);
$flag = intval($pl['opt']['ff']);
$annots .= ' /Ff '. $flag;
if (isset ($pl['opt']['maxlen'])) {
$annots .= ' /MaxLen '. intval($pl['opt']['maxlen']);
if (isset ($pl['opt']['v'])) {
foreach ($pl['opt']['v'] AS $optval) {
$optval = sprintf('%.2F', $optval);
$annots .= ' '. $this->_textstring($pl['opt']['v'], $annot_obj_id);
if (isset ($pl['opt']['dv'])) {
foreach ($pl['opt']['dv'] AS $optval) {
$optval = sprintf('%.2F', $optval);
$annots .= ' '. $this->_textstring($pl['opt']['dv'], $annot_obj_id);
if (isset ($pl['opt']['rv'])) {
foreach ($pl['opt']['rv'] AS $optval) {
$optval = sprintf('%.2F', $optval);
$annots .= ' '. $this->_textstring($pl['opt']['rv'], $annot_obj_id);
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'])) {
foreach($pl['opt']['opt'] AS $copt) {
$annots .= ' ['. $this->_textstring($copt[0], $annot_obj_id). ' '. $this->_textstring($copt[1], $annot_obj_id). ']';
$annots .= ' '. $this->_textstring($copt, $annot_obj_id);
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'])) {
foreach($pl['opt']['i'] AS $copt) {
// create new annotation object
$this->_out($this->_getobj($annot_obj_id). "\n". $annots. "\n". 'endobj');
// store reference of form object
* 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
* @since 4.8.001 (2009-09-09)
$this->xobjects['AX'. $this->n] = array('n' => $this->n);
$out .= ' /Type /XObject';
$out .= ' /Subtype /Form';
$out .= ' /Filter /FlateDecode';
$rect = sprintf('%.2F %.2F', $w, $h);
$out .= ' /BBox [0 0 '. $rect. ']';
$out .= ' /Matrix [1 0 0 1 0 0]';
$out .= ' /Resources <<';
$out .= ' /ProcSet [/PDF /Text]';
$out .= ' /F'. $fontid. ' '. $this->font_obj_ids[$fontkey]. ' 0 R';
$out .= ' /Length '. strlen($stream);
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
* Get ULONG from string (Big Endian 32-bit unsigned integer).
* @param string $str string from where to extract value
* @param int $offset point from where to read the data
* @return int 32 bit value
* @since 5.2.000 (2010-06-02)
protected function _getULONG(&$str, &$offset) {
* Get USHORT from string (Big Endian 16-bit unsigned integer).
* @param string $str string from where to extract value
* @param int $offset point from where to read the data
* @return int 16 bit value
* @since 5.2.000 (2010-06-02)
* Get SHORT from string (Big Endian 16-bit signed integer).
* @param string $str string from where to extract value
* @param int $offset point from where to read the data
* @return int 16 bit value
* @since 5.2.000 (2010-06-02)
protected function _getSHORT(&$str, &$offset) {
* Get BYTE from string (8-bit unsigned integer).
* @param string $str string from where to extract value
* @param int $offset point from where to read the data
* @return int 8 bit value
* @since 5.2.000 (2010-06-02)
protected function _getBYTE(&$str, &$offset) {
* Returns a subset of the TrueType font data without the unused glyphs.
* @param string $font TrueType font data
* @param array $subsetchars array of used characters (the glyphs to keep)
* @return string a subset of TrueType font data without the unused glyphs
* @since 5.2.000 (2010-06-02)
$offset = 0; // offset position of the font data
if ($this->_getULONG($font, $offset) != 0x10000) {
// sfnt version must be 0x00010000 for TrueType version 1.0.
// skip searchRange, entrySelector and rangeShift
for ($i = 0; $i < $numTables; ++ $i) {
$tag = substr($font, $offset, 4);
$table[$tag]['checkSum'] = $this->_getULONG($font, $offset);
$table[$tag]['offset'] = $this->_getULONG($font, $offset);
$table[$tag]['length'] = $this->_getULONG($font, $offset);
$offset = $table['head']['offset'] + 12;
if ($this->_getULONG($font, $offset) != 0x5F0F3CF5) {
// magicNumber must be 0x5F0F3CF5
// get offset mode (indexToLocFormat : 0 = short, 1 = long)
$offset = $table['head']['offset'] + 50;
$short_offset = ($this->_getSHORT($font, $offset) == 0);
// get the offsets to the locations of the glyphs in the font, relative to the beginning of the glyphData table
$offset = $table['loca']['offset'];
$n = $table['loca']['length'] / 2; // numGlyphs + 1
for ($i = 0; $i < $n; ++ $i) {
$indexToLoc[$i] = $this->_getUSHORT($font, $offset) * 2;
$n = $table['loca']['length'] / 4; // numGlyphs + 1
for ($i = 0; $i < $n; ++ $i) {
$indexToLoc[$i] = $this->_getULONG($font, $offset);
// get glyphs indexes of chars from cmap table
$subsetglyphs = array(); // glyph IDs on key
$subsetglyphs[0] = true; // character codes that do not correspond to any glyph in the font should be mapped to glyph index 0
$offset = $table['cmap']['offset'] + 2;
$numEncodingTables = $this->_getUSHORT($font, $offset);
$encodingTables = array();
for ($i = 0; $i < $numEncodingTables; ++ $i) {
$encodingTables[$i]['platformID'] = $this->_getUSHORT($font, $offset);
$encodingTables[$i]['encodingID'] = $this->_getUSHORT($font, $offset);
$encodingTables[$i]['offset'] = $this->_getULONG($font, $offset);
foreach ($encodingTables as $enctable) {
if (($enctable['platformID'] == 3) AND ($enctable['encodingID'] == 0)) {
$offset = $table['cmap']['offset'] + $enctable['offset'];
case 0: { // Format 0: Byte encoding table
$offset += 4; // skip length and version/language
for ($k = 0; $k < 256; ++ $k) {
if (isset ($subsetchars[$k])) {
case 2: { // Format 2: High-byte mapping through table
$offset += 4; // skip length and version
case 4: { // Format 4: Segment mapping to delta values
$offset += 2; // skip version/language
$segCount = ($this->_getUSHORT($font, $offset) / 2);
$offset += 6; // skip searchRange, entrySelector, rangeShift
$endCount = array(); // array of end character codes for each segment
for ($k = 0; $k < $segCount; ++ $k) {
$endCount[$k] = $this->_getUSHORT($font, $offset);
$offset += 2; // skip reservedPad
$startCount = array(); // array of start character codes for each segment
for ($k = 0; $k < $segCount; ++ $k) {
$startCount[$k] = $this->_getUSHORT($font, $offset);
$idDelta = array(); // delta for all character codes in segment
for ($k = 0; $k < $segCount; ++ $k) {
$idRangeOffset = array(); // Offsets into glyphIdArray or 0
for ($k = 0; $k < $segCount; ++ $k) {
$idRangeOffset[$k] = $this->_getUSHORT($font, $offset);
$gidlen = ($length / 2) - 8 - (4 * $segCount);
$glyphIdArray = array(); // glyph index array
for ($k = 0; $k < $gidlen; ++ $k) {
$glyphIdArray[$k] = $this->_getUSHORT($font, $offset);
for ($k = 0; $k < $segCount; ++ $k) {
for ($c = $startCount[$k]; $c <= $endCount[$k]; ++ $c) {
if (isset ($subsetchars[$c])) {
if ($idRangeOffset[$k] == 0) {
$gid = (($idRangeOffset[$k] / 2) + ($c - $startCount[$k]) - ($segCount - $k));
$g = $glyphIdArray[$gid];
$g += ($idDelta[$k] - 65536);
case 6: { // Format 6: Trimmed table mapping
$offset += 4; // skip length and version/language
for ($k = 0; $k < $entryCount; ++ $k) {
if (isset ($subsetchars[$c])) {
case 8: { // Format 8: Mixed 16-bit and 32-bit coverage
$offset += 10; // skip length and version
case 10: { // Format 10: Trimmed array
$offset += 10; // skip length and version/language
$startCharCode = $this->_getULONG($font, $offset);
$numChars = $this->_getULONG($font, $offset);
for ($k = 0; $k < $numChars; ++ $k) {
$c = ($k + $startCharCode);
if (isset ($subsetchars[$c])) {
case 12: { // Format 12: Segmented coverage
$offset += 10; // skip length and version/language
for ($k = 0; $k < $nGroups; ++ $k) {
$startCharCode = $this->_getULONG($font, $offset);
$endCharCode = $this->_getULONG($font, $offset);
$startGlyphCode = $this->_getULONG($font, $offset);
for ($c = $startCharCode; $c <= $endCharCode; ++ $c) {
if (isset ($subsetchars[$c])) {
$subsetglyphs[$startGlyphCode] = $c;
// add composite glyps to $subsetglyphs and remove missing glyphs
foreach ($subsetglyphs as $key => $val) {
if (isset ($indexToLoc[$key])) {
$offset = $table['glyf']['offset'] + $indexToLoc[$key];
$numberOfContours = $this->_getSHORT($font, $offset);
if ($numberOfContours < 0) { // composite glyph
$offset += 8; // skip xMin, yMin, xMax, yMax
if (!isset ($subsetglyphs[$glyphIndex]) AND isset ($indexToLoc[$glyphIndex])) {
$subsetglyphs[$glyphIndex] = true;
// skip some bytes by case
} elseif ($flags & 128) {
unset ($subsetglyphs[$key]);
// build new glyf table with only used glyphs
// create new empty indexToLoc table
foreach ($subsetglyphs as $glyphID => $char) {
if (isset ($indexToLoc[$glyphID]) AND isset ($indexToLoc[($glyphID + 1)])) {
$start = $indexToLoc[$glyphID];
$length = ($indexToLoc[($glyphID + 1)] - $start);
$glyf .= substr($font, ($table['glyf']['offset'] + $start), $length);
$newIndexToLoc[$glyphID] = $goffset;
foreach ($newIndexToLoc as $glyphID => $offset) {
$loca .= pack('n', ($offset / 2));
foreach ($newIndexToLoc as $glyphID => $offset) {
$loca .= pack('N', $offset);
// array of table names to preserve (loca and glyf tables will be added later)
//$table_names = array ('cmap', 'head', 'hhea', 'hmtx', 'maxp', 'name', 'OS/2', 'post', 'cvt ', 'fpgm', 'prep');
// the cmap table is not needed and shall not be present, since the mapping from character codes to glyph descriptions is provided separately
$table_names = array ('head', 'hhea', 'hmtx', 'maxp', 'cvt ', 'fpgm', 'prep'); // minimum required table names
// get the tables to preserve
foreach ($table as $tag => $val) {
$table[$tag]['data'] = substr($font, $table[$tag]['offset'], $table[$tag]['length']);
// set the checkSumAdjustment to 0
$table[$tag]['data'] = substr($table[$tag]['data'], 0, 8). "\x0\x0\x0\x0". substr($table[$tag]['data'], 12);
$pad = 4 - ($table[$tag]['length'] % 4);
// the length of a table must be a multiple of four bytes
$table[$tag]['length'] += $pad;
$table[$tag]['offset'] = $offset;
$offset += $table[$tag]['length'];
// check sum is not changed (so keep the following line commented)
//$table[$tag]['checkSum'] = $this->_getTTFtableChecksum($table[$tag]['data'], $table[$tag]['length']);
$table['loca']['data'] = $loca;
$table['loca']['length'] = strlen($loca);
$pad = 4 - ($table['loca']['length'] % 4);
// the length of a table must be a multiple of four bytes
$table['loca']['length'] += $pad;
$table['loca']['data'] .= str_repeat("\x0", $pad);
$table['loca']['offset'] = $offset;
$table['loca']['checkSum'] = $this->_getTTFtableChecksum($table['loca']['data'], $table['loca']['length']);
$offset += $table['loca']['length'];
$table['glyf']['data'] = $glyf;
$table['glyf']['length'] = strlen($glyf);
$pad = 4 - ($table['glyf']['length'] % 4);
// the length of a table must be a multiple of four bytes
$table['glyf']['length'] += $pad;
$table['glyf']['data'] .= str_repeat("\x0", $pad);
$table['glyf']['offset'] = $offset;
$table['glyf']['checkSum'] = $this->_getTTFtableChecksum($table['glyf']['data'], $table['glyf']['length']);
$font .= pack('N', 0x10000); // sfnt version
$numTables = count($table);
$font .= pack('n', $numTables); // numTables
$entrySelector = floor(log($numTables, 2));
$searchRange = pow(2, $entrySelector) * 16;
$rangeShift = ($numTables * 16) - $searchRange;
$font .= pack('n', $searchRange); // searchRange
$font .= pack('n', $entrySelector); // entrySelector
$font .= pack('n', $rangeShift); // rangeShift
$offset = ($numTables * 16);
foreach ($table as $tag => $data) {
$font .= pack('N', $data['checkSum']); // checkSum
$font .= pack('N', ($data['offset'] + $offset)); // offset
$font .= pack('N', $data['length']); // length
foreach ($table as $data) {
// set checkSumAdjustment on head table
$font = substr($font, 0, $table['head']['offset'] + 8). pack('N', $checkSumAdjustment). substr($font, $table['head']['offset'] + 12);
* Returs the checksum of a TTF table.
* @param string $table table to check
* @param int $length lenght of table in bytes
* @since 5.2.000 (2010-06-02)
for ($i = 0; $i < $tlen; ++ $i) {
* @param array $font font data
* @param int $cidoffset offset for CID values
* @return PDF command string for font widths
* @since 4.4.000 (2008-12-07)
foreach ($font['cw'] as $cid => $width) {
if ($font['subset'] AND ($cid > 255) AND (!isset ($font['subsetchars'][$cid]))) {
// ignore the unused characters (font subsetting)
if ($width != $font['dw']) {
if ($cid == ($prevcid + 1)) {
if ($width == $prevwidth) {
if ($width == $range[$rangeid][0]) {
$range[$rangeid][] = $width;
$range[$rangeid] = array();
$range[$rangeid][] = $prevwidth;
$range[$rangeid][] = $width;
$range[$rangeid]['interval'] = true;
$range[$rangeid] = array();
$range[$rangeid][] = $width;
$range[$rangeid][] = $width;
$range[$rangeid] = array();
$range[$rangeid][] = $width;
foreach ($range as $k => $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]);
if (isset ($ws['interval'])) {
unset ($range[$k]['interval']);
foreach ($range as $k => $ws) {
// interval mode is more compact
$w .= ' '. $k. ' '. ($k + count($ws) - 1). ' '. $ws[0];
$w .= ' '. $k. ' [ '. implode(' ', $ws). ' ]';
foreach ($this->diffs as $diff) {
$this->_out('<< /Type /Encoding /BaseEncoding /WinAnsiEncoding /Differences ['. $diff. '] >>'. "\n". 'endobj');
foreach ($this->FontFiles as $file => $info) {
// search and get font file to embedd
$fontdir = $info['fontdir'];
// search files on various directories
if (($fontdir !== false) AND file_exists($fontdir. $file)) {
$fontfile = $fontdir. $file;
$compressed = (substr($file, - 2) == '.z');
if ((!$compressed) AND (isset ($info['length2']))) {
$header = (ord($font{0}) == 128);
//Strip first binary header
if ($header AND (ord($font{$info['length1']}) == 128)) {
//Strip second binary header
$font = substr($font, 0, $info['length1']). substr($font, ($info['length1'] + 6));
} elseif ($info['subset'] AND ((!$compressed) OR ($compressed AND function_exists('gzcompress')))) {
// merge subset characters
$subsetchars = array(); // used chars
foreach ($info['fontkeys'] as $fontkey) {
$subsetchars += $fontinfo['subsetchars'];
$out = '<< /Length '. strlen($stream);
$out .= ' /Filter /FlateDecode';
$out .= ' /Length1 '. $info['length1'];
if (isset ($info['length2'])) {
$out .= ' /Length2 '. $info['length2']. ' /Length3 0';
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
$out .= ' /Subtype /Type1';
$out .= ' /BaseFont /'. $name;
$out .= ' /Name /F'. $font['i'];
$out .= ' /Encoding /WinAnsiEncoding';
// add default font for annotations
} elseif (($type == 'Type1') OR ($type == 'TrueType')) {
// additional Type1 or TrueType font
$out .= ' /Subtype /'. $type;
$out .= ' /BaseFont /'. $name;
$out .= ' /Name /F'. $font['i'];
$out .= ' /FirstChar 32 /LastChar 255';
$out .= ' /Widths '. ($this->n + 1). ' 0 R';
$out .= ' /FontDescriptor '. ($this->n + 2). ' 0 R';
if (isset ($font['diff'])) {
$out .= ' /Encoding '. ($nf + $font['diff']). ' 0 R';
$out .= ' /Encoding /WinAnsiEncoding';
for ($i = 32; $i < 256; ++ $i) {
$s = '<</Type /FontDescriptor /FontName /'. $name;
foreach ($font['desc'] as $fdk => $fdv) {
$s .= ' /'. $fdk. ' '. $fdv. '';
$s .= ' /FontFile'. ($type == 'Type1' ? '' : '2'). ' '. $this->FontFiles[$font['file']]['n']. ' 0 R';
$this->Error('Unsupported font type: '. $type);
* Adds unicode fonts.<br>
* Based on PDF Reference 1.3 (section 5)
* @param array $font font data
* @since 1.52.0.TC005 (2005-01-05)
// change name for font subsetting
$subtag = sprintf('%06u', $font['i']);
$subtag = strtr($subtag, '0123456789', 'ABCDEFGHIJ');
$fontname .= $subtag. '+';
$fontname .= $font['name'];
// A composite font composed of other fonts, organized hierarchically
$out .= '<< /Type /Font';
$out .= ' /Subtype /Type0';
$out .= ' /BaseFont /'. $fontname;
$out .= ' /Name /F'. $font['i'];
$out .= ' /Encoding /'. $font['enc'];
$out .= ' /ToUnicode '. ($this->n + 1). ' 0 R';
$out .= ' /DescendantFonts ['. ($this->n + 2). ' 0 R]';
// ToUnicode map for Identity-H
$stream = "/CIDInit /ProcSet findresource begin\n";
$stream .= "12 dict begin\n";
$stream .= "begincmap\n";
$stream .= "/CIDSystemInfo << /Registry (Adobe) /Ordering (UCS) /Supplement 0 >> def\n";
$stream .= "/CMapName /Adobe-Identity-UCS def\n";
$stream .= "/CMapType 2 def\n";
$stream .= "/WMode 0 def\n";
$stream .= "1 begincodespacerange\n";
$stream .= "<0000> <FFFF>\n";
$stream .= "endcodespacerange\n";
$stream .= "100 beginbfrange\n";
$stream .= "<0000> <00ff> <0000>\n";
$stream .= "<0100> <01ff> <0100>\n";
$stream .= "<0200> <02ff> <0200>\n";
$stream .= "<0300> <03ff> <0300>\n";
$stream .= "<0400> <04ff> <0400>\n";
$stream .= "<0500> <05ff> <0500>\n";
$stream .= "<0600> <06ff> <0600>\n";
$stream .= "<0700> <07ff> <0700>\n";
$stream .= "<0800> <08ff> <0800>\n";
$stream .= "<0900> <09ff> <0900>\n";
$stream .= "<0a00> <0aff> <0a00>\n";
$stream .= "<0b00> <0bff> <0b00>\n";
$stream .= "<0c00> <0cff> <0c00>\n";
$stream .= "<0d00> <0dff> <0d00>\n";
$stream .= "<0e00> <0eff> <0e00>\n";
$stream .= "<0f00> <0fff> <0f00>\n";
$stream .= "<1000> <10ff> <1000>\n";
$stream .= "<1100> <11ff> <1100>\n";
$stream .= "<1200> <12ff> <1200>\n";
$stream .= "<1300> <13ff> <1300>\n";
$stream .= "<1400> <14ff> <1400>\n";
$stream .= "<1500> <15ff> <1500>\n";
$stream .= "<1600> <16ff> <1600>\n";
$stream .= "<1700> <17ff> <1700>\n";
$stream .= "<1800> <18ff> <1800>\n";
$stream .= "<1900> <19ff> <1900>\n";
$stream .= "<1a00> <1aff> <1a00>\n";
$stream .= "<1b00> <1bff> <1b00>\n";
$stream .= "<1c00> <1cff> <1c00>\n";
$stream .= "<1d00> <1dff> <1d00>\n";
$stream .= "<1e00> <1eff> <1e00>\n";
$stream .= "<1f00> <1fff> <1f00>\n";
$stream .= "<2000> <20ff> <2000>\n";
$stream .= "<2100> <21ff> <2100>\n";
$stream .= "<2200> <22ff> <2200>\n";
$stream .= "<2300> <23ff> <2300>\n";
$stream .= "<2400> <24ff> <2400>\n";
$stream .= "<2500> <25ff> <2500>\n";
$stream .= "<2600> <26ff> <2600>\n";
$stream .= "<2700> <27ff> <2700>\n";
$stream .= "<2800> <28ff> <2800>\n";
$stream .= "<2900> <29ff> <2900>\n";
$stream .= "<2a00> <2aff> <2a00>\n";
$stream .= "<2b00> <2bff> <2b00>\n";
$stream .= "<2c00> <2cff> <2c00>\n";
$stream .= "<2d00> <2dff> <2d00>\n";
$stream .= "<2e00> <2eff> <2e00>\n";
$stream .= "<2f00> <2fff> <2f00>\n";
$stream .= "<3000> <30ff> <3000>\n";
$stream .= "<3100> <31ff> <3100>\n";
$stream .= "<3200> <32ff> <3200>\n";
$stream .= "<3300> <33ff> <3300>\n";
$stream .= "<3400> <34ff> <3400>\n";
$stream .= "<3500> <35ff> <3500>\n";
$stream .= "<3600> <36ff> <3600>\n";
$stream .= "<3700> <37ff> <3700>\n";
$stream .= "<3800> <38ff> <3800>\n";
$stream .= "<3900> <39ff> <3900>\n";
$stream .= "<3a00> <3aff> <3a00>\n";
$stream .= "<3b00> <3bff> <3b00>\n";
$stream .= "<3c00> <3cff> <3c00>\n";
$stream .= "<3d00> <3dff> <3d00>\n";
$stream .= "<3e00> <3eff> <3e00>\n";
$stream .= "<3f00> <3fff> <3f00>\n";
$stream .= "<4000> <40ff> <4000>\n";
$stream .= "<4100> <41ff> <4100>\n";
$stream .= "<4200> <42ff> <4200>\n";
$stream .= "<4300> <43ff> <4300>\n";
$stream .= "<4400> <44ff> <4400>\n";
$stream .= "<4500> <45ff> <4500>\n";
$stream .= "<4600> <46ff> <4600>\n";
$stream .= "<4700> <47ff> <4700>\n";
$stream .= "<4800> <48ff> <4800>\n";
$stream .= "<4900> <49ff> <4900>\n";
$stream .= "<4a00> <4aff> <4a00>\n";
$stream .= "<4b00> <4bff> <4b00>\n";
$stream .= "<4c00> <4cff> <4c00>\n";
$stream .= "<4d00> <4dff> <4d00>\n";
$stream .= "<4e00> <4eff> <4e00>\n";
$stream .= "<4f00> <4fff> <4f00>\n";
$stream .= "<5000> <50ff> <5000>\n";
$stream .= "<5100> <51ff> <5100>\n";
$stream .= "<5200> <52ff> <5200>\n";
$stream .= "<5300> <53ff> <5300>\n";
$stream .= "<5400> <54ff> <5400>\n";
$stream .= "<5500> <55ff> <5500>\n";
$stream .= "<5600> <56ff> <5600>\n";
$stream .= "<5700> <57ff> <5700>\n";
$stream .= "<5800> <58ff> <5800>\n";
$stream .= "<5900> <59ff> <5900>\n";
$stream .= "<5a00> <5aff> <5a00>\n";
$stream .= "<5b00> <5bff> <5b00>\n";
$stream .= "<5c00> <5cff> <5c00>\n";
$stream .= "<5d00> <5dff> <5d00>\n";
$stream .= "<5e00> <5eff> <5e00>\n";
$stream .= "<5f00> <5fff> <5f00>\n";
$stream .= "<6000> <60ff> <6000>\n";
$stream .= "<6100> <61ff> <6100>\n";
$stream .= "<6200> <62ff> <6200>\n";
$stream .= "<6300> <63ff> <6300>\n";
$stream .= "endbfrange\n";
$stream .= "100 beginbfrange\n";
$stream .= "<6400> <64ff> <6400>\n";
$stream .= "<6500> <65ff> <6500>\n";
$stream .= "<6600> <66ff> <6600>\n";
$stream .= "<6700> <67ff> <6700>\n";
$stream .= "<6800> <68ff> <6800>\n";
$stream .= "<6900> <69ff> <6900>\n";
$stream .= "<6a00> <6aff> <6a00>\n";
$stream .= "<6b00> <6bff> <6b00>\n";
$stream .= "<6c00> <6cff> <6c00>\n";
$stream .= "<6d00> <6dff> <6d00>\n";
$stream .= "<6e00> <6eff> <6e00>\n";
$stream .= "<6f00> <6fff> <6f00>\n";
$stream .= "<7000> <70ff> <7000>\n";
$stream .= "<7100> <71ff> <7100>\n";
$stream .= "<7200> <72ff> <7200>\n";
$stream .= "<7300> <73ff> <7300>\n";
$stream .= "<7400> <74ff> <7400>\n";
$stream .= "<7500> <75ff> <7500>\n";
$stream .= "<7600> <76ff> <7600>\n";
$stream .= "<7700> <77ff> <7700>\n";
$stream .= "<7800> <78ff> <7800>\n";
$stream .= "<7900> <79ff> <7900>\n";
$stream .= "<7a00> <7aff> <7a00>\n";
$stream .= "<7b00> <7bff> <7b00>\n";
$stream .= "<7c00> <7cff> <7c00>\n";
$stream .= "<7d00> <7dff> <7d00>\n";
$stream .= "<7e00> <7eff> <7e00>\n";
$stream .= "<7f00> <7fff> <7f00>\n";
$stream .= "<8000> <80ff> <8000>\n";
$stream .= "<8100> <81ff> <8100>\n";
$stream .= "<8200> <82ff> <8200>\n";
$stream .= "<8300> <83ff> <8300>\n";
$stream .= "<8400> <84ff> <8400>\n";
$stream .= "<8500> <85ff> <8500>\n";
$stream .= "<8600> <86ff> <8600>\n";
$stream .= "<8700> <87ff> <8700>\n";
$stream .= "<8800> <88ff> <8800>\n";
$stream .= "<8900> <89ff> <8900>\n";
$stream .= "<8a00> <8aff> <8a00>\n";
$stream .= "<8b00> <8bff> <8b00>\n";
$stream .= "<8c00> <8cff> <8c00>\n";
$stream .= "<8d00> <8dff> <8d00>\n";
$stream .= "<8e00> <8eff> <8e00>\n";
$stream .= "<8f00> <8fff> <8f00>\n";
$stream .= "<9000> <90ff> <9000>\n";
$stream .= "<9100> <91ff> <9100>\n";
$stream .= "<9200> <92ff> <9200>\n";
$stream .= "<9300> <93ff> <9300>\n";
$stream .= "<9400> <94ff> <9400>\n";
$stream .= "<9500> <95ff> <9500>\n";
$stream .= "<9600> <96ff> <9600>\n";
$stream .= "<9700> <97ff> <9700>\n";
$stream .= "<9800> <98ff> <9800>\n";
$stream .= "<9900> <99ff> <9900>\n";
$stream .= "<9a00> <9aff> <9a00>\n";
$stream .= "<9b00> <9bff> <9b00>\n";
$stream .= "<9c00> <9cff> <9c00>\n";
$stream .= "<9d00> <9dff> <9d00>\n";
$stream .= "<9e00> <9eff> <9e00>\n";
$stream .= "<9f00> <9fff> <9f00>\n";
$stream .= "<a000> <a0ff> <a000>\n";
$stream .= "<a100> <a1ff> <a100>\n";
$stream .= "<a200> <a2ff> <a200>\n";
$stream .= "<a300> <a3ff> <a300>\n";
$stream .= "<a400> <a4ff> <a400>\n";
$stream .= "<a500> <a5ff> <a500>\n";
$stream .= "<a600> <a6ff> <a600>\n";
$stream .= "<a700> <a7ff> <a700>\n";
$stream .= "<a800> <a8ff> <a800>\n";
$stream .= "<a900> <a9ff> <a900>\n";
$stream .= "<aa00> <aaff> <aa00>\n";
$stream .= "<ab00> <abff> <ab00>\n";
$stream .= "<ac00> <acff> <ac00>\n";
$stream .= "<ad00> <adff> <ad00>\n";
$stream .= "<ae00> <aeff> <ae00>\n";
$stream .= "<af00> <afff> <af00>\n";
$stream .= "<b000> <b0ff> <b000>\n";
$stream .= "<b100> <b1ff> <b100>\n";
$stream .= "<b200> <b2ff> <b200>\n";
$stream .= "<b300> <b3ff> <b300>\n";
$stream .= "<b400> <b4ff> <b400>\n";
$stream .= "<b500> <b5ff> <b500>\n";
$stream .= "<b600> <b6ff> <b600>\n";
$stream .= "<b700> <b7ff> <b700>\n";
$stream .= "<b800> <b8ff> <b800>\n";
$stream .= "<b900> <b9ff> <b900>\n";
$stream .= "<ba00> <baff> <ba00>\n";
$stream .= "<bb00> <bbff> <bb00>\n";
$stream .= "<bc00> <bcff> <bc00>\n";
$stream .= "<bd00> <bdff> <bd00>\n";
$stream .= "<be00> <beff> <be00>\n";
$stream .= "<bf00> <bfff> <bf00>\n";
$stream .= "<c000> <c0ff> <c000>\n";
$stream .= "<c100> <c1ff> <c100>\n";
$stream .= "<c200> <c2ff> <c200>\n";
$stream .= "<c300> <c3ff> <c300>\n";
$stream .= "<c400> <c4ff> <c400>\n";
$stream .= "<c500> <c5ff> <c500>\n";
$stream .= "<c600> <c6ff> <c600>\n";
$stream .= "<c700> <c7ff> <c700>\n";
$stream .= "endbfrange\n";
$stream .= "56 beginbfrange\n";
$stream .= "<c800> <c8ff> <c800>\n";
$stream .= "<c900> <c9ff> <c900>\n";
$stream .= "<ca00> <caff> <ca00>\n";
$stream .= "<cb00> <cbff> <cb00>\n";
$stream .= "<cc00> <ccff> <cc00>\n";
$stream .= "<cd00> <cdff> <cd00>\n";
$stream .= "<ce00> <ceff> <ce00>\n";
$stream .= "<cf00> <cfff> <cf00>\n";
$stream .= "<d000> <d0ff> <d000>\n";
$stream .= "<d100> <d1ff> <d100>\n";
$stream .= "<d200> <d2ff> <d200>\n";
$stream .= "<d300> <d3ff> <d300>\n";
$stream .= "<d400> <d4ff> <d400>\n";
$stream .= "<d500> <d5ff> <d500>\n";
$stream .= "<d600> <d6ff> <d600>\n";
$stream .= "<d700> <d7ff> <d700>\n";
$stream .= "<d800> <d8ff> <d800>\n";
$stream .= "<d900> <d9ff> <d900>\n";
$stream .= "<da00> <daff> <da00>\n";
$stream .= "<db00> <dbff> <db00>\n";
$stream .= "<dc00> <dcff> <dc00>\n";
$stream .= "<dd00> <ddff> <dd00>\n";
$stream .= "<de00> <deff> <de00>\n";
$stream .= "<df00> <dfff> <df00>\n";
$stream .= "<e000> <e0ff> <e000>\n";
$stream .= "<e100> <e1ff> <e100>\n";
$stream .= "<e200> <e2ff> <e200>\n";
$stream .= "<e300> <e3ff> <e300>\n";
$stream .= "<e400> <e4ff> <e400>\n";
$stream .= "<e500> <e5ff> <e500>\n";
$stream .= "<e600> <e6ff> <e600>\n";
$stream .= "<e700> <e7ff> <e700>\n";
$stream .= "<e800> <e8ff> <e800>\n";
$stream .= "<e900> <e9ff> <e900>\n";
$stream .= "<ea00> <eaff> <ea00>\n";
$stream .= "<eb00> <ebff> <eb00>\n";
$stream .= "<ec00> <ecff> <ec00>\n";
$stream .= "<ed00> <edff> <ed00>\n";
$stream .= "<ee00> <eeff> <ee00>\n";
$stream .= "<ef00> <efff> <ef00>\n";
$stream .= "<f000> <f0ff> <f000>\n";
$stream .= "<f100> <f1ff> <f100>\n";
$stream .= "<f200> <f2ff> <f200>\n";
$stream .= "<f300> <f3ff> <f300>\n";
$stream .= "<f400> <f4ff> <f400>\n";
$stream .= "<f500> <f5ff> <f500>\n";
$stream .= "<f600> <f6ff> <f600>\n";
$stream .= "<f700> <f7ff> <f700>\n";
$stream .= "<f800> <f8ff> <f800>\n";
$stream .= "<f900> <f9ff> <f900>\n";
$stream .= "<fa00> <faff> <fa00>\n";
$stream .= "<fb00> <fbff> <fb00>\n";
$stream .= "<fc00> <fcff> <fc00>\n";
$stream .= "<fd00> <fdff> <fd00>\n";
$stream .= "<fe00> <feff> <fe00>\n";
$stream .= "<ff00> <ffff> <ff00>\n";
$stream .= "endbfrange\n";
$stream .= "CMapName currentdict /CMap defineresource pop\n";
$filter = ($this->compress) ? '/Filter /FlateDecode ' : '';
$this->_out('<<'. $filter. '/Length '. strlen($stream). '>> stream'. "\n". $stream. "\n". 'endstream'. "\n". 'endobj');
// A CIDFont whose glyph descriptions are based on TrueType font technology
$out .= ' /Subtype /CIDFontType2';
$out .= ' /BaseFont /'. $fontname;
// A dictionary containing entries that define the character collection of the CIDFont.
$cidinfo = '/Registry '. $this->_datastring($font['cidinfo']['Registry'], $oid);
$cidinfo .= ' /Ordering '. $this->_datastring($font['cidinfo']['Ordering'], $oid);
$cidinfo .= ' /Supplement '. $font['cidinfo']['Supplement'];
$out .= ' /CIDSystemInfo << '. $cidinfo. ' >>';
$out .= ' /FontDescriptor '. ($this->n + 1). ' 0 R';
$out .= ' /DW '. $font['dw']; // default width
if (isset ($font['ctg']) AND (!$this->empty_string($font['ctg']))) {
$out .= "\n". '/CIDToGIDMap '. ($this->n + 2). ' 0 R';
// A font descriptor describing the CIDFont default metrics other than its glyph widths
$out = '<< /Type /FontDescriptor';
$out .= ' /FontName /'. $fontname;
foreach ($font['desc'] as $key => $value) {
$out .= ' /'. $key. ' '. $value;
// A stream containing a TrueType font
$out .= ' /FontFile2 '. $this->FontFiles[$font['file']]['n']. ' 0 R';
$fontdir = $this->FontFiles[$font['file']]['fontdir'];
if (isset ($font['ctg']) AND (!$this->empty_string($font['ctg']))) {
// A specification of the mapping from CIDs to glyph indices
// search and get CTG font file to embedd
// search and get ctg font file to embedd
// search files on various directories
if (($fontdir !== false) AND file_exists($fontdir. $ctgfile)) {
$fontfile = $fontdir. $ctgfile;
$this->Error('Font file not found: '. $ctgfile);
$out = '<< /Length '. strlen($stream). '';
if (substr($fontfile, - 2) == '.z') { // check file extension
// Decompresses data encoded using the public-domain
// zlib/deflate compression method, reproducing the
// original text or binary data
$out .= ' /Filter /FlateDecode';
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
* A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
* @param array $font font data
* @author Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira
* @since 3.2.000 (2008-06-23)
if (!isset ($font['cw'][1])) {
if (isset ($font['cidinfo']['uni2cid'])) {
// convert unicode to cid.
$uni2cid = $font['cidinfo']['uni2cid'];
foreach ($font['cw'] as $uni => $width) {
if (isset ($uni2cid[$uni])) {
$cw[($uni2cid[$uni] + $cidoffset)] = $width;
} // else unknown character
$longname = $name. '-'. $enc;
$out .= ' /Subtype /Type0';
$out .= ' /BaseFont /'. $longname;
$out .= ' /Name /F'. $font['i'];
$out .= ' /Encoding /'. $enc;
$out .= ' /DescendantFonts ['. ($this->n + 1). ' 0 R]';
$out .= ' /Subtype /CIDFontType0';
$out .= ' /BaseFont /'. $name;
$cidinfo = '/Registry '. $this->_datastring($font['cidinfo']['Registry'], $oid);
$cidinfo .= ' /Ordering '. $this->_datastring($font['cidinfo']['Ordering'], $oid);
$cidinfo .= ' /Supplement '. $font['cidinfo']['Supplement'];
$out .= ' /CIDSystemInfo <<'. $cidinfo. '>>';
$out .= ' /FontDescriptor '. ($this->n + 1). ' 0 R';
$out .= ' /DW '. $font['dw'];
$s = '<</Type /FontDescriptor /FontName /'. $name;
foreach ($font['desc'] as $k => $v) {
$filter = ($this->compress) ? '/Filter /FlateDecode ' : '';
$this->xobjects['I'. $info['i']] = array('n' => $oid);
$out = '<</Type /XObject';
$out .= ' /Subtype /Image';
$out .= ' /Width '. $info['w'];
$out .= ' /Height '. $info['h'];
$out .= ' /SMask '. ($this->n - 1). ' 0 R';
if ($info['cs'] == 'Indexed') {
$out .= ' /ColorSpace [/Indexed /DeviceRGB '. ((strlen($info['pal']) / 3) - 1). ' '. ($this->n + 1). ' 0 R]';
$out .= ' /ColorSpace /'. $info['cs'];
if ($info['cs'] == 'DeviceCMYK') {
$out .= ' /Decode [1 0 1 0 1 0 1 0]';
$out .= ' /BitsPerComponent '. $info['bpc'];
$out .= ' /Filter /'. $info['f'];
if (isset ($info['parms'])) {
$out .= ' '. $info['parms'];
if (isset ($info['trns']) AND is_array($info['trns'])) {
$count_info = count($info['trns']);
for ($i= 0; $i < $count_info; ++ $i) {
$trns .= $info['trns'][$i]. ' '. $info['trns'][$i]. ' ';
$out .= ' /Mask ['. $trns. ']';
$out .= ' /Length '. strlen($stream). ' >>';
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
if ($info['cs'] == 'Indexed') {
$this->_out('<<'. $filter. '/Length '. strlen($pal). '>> stream'. "\n". $pal. "\n". 'endstream'. "\n". 'endobj');
* Output Form XObjects Templates.
* @since 5.8.017 (2010-08-24)
* @see startTemplate(), endTemplate(), printTemplate()
foreach ($this->xobjects as $key => $data) {
if (isset ($data['outdata'])) {
$stream = trim($data['outdata']);
$out = $this->_getobj($data['n']). "\n";
$out .= ' /Type /XObject';
$out .= ' /Subtype /Form';
$out .= ' /Filter /FlateDecode';
$out .= sprintf(' /BBox [%.2F %.2F %.2F %.2F]', ($data['x'] * $this->k), (- $data['y'] * $this->k), (($data['w'] + $data['x']) * $this->k), (($data['h'] - $data['y']) * $this->k));
$out .= ' /Matrix [1 0 0 1 0 0]';
$out .= ' /Resources <<';
$out .= ' /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]';
if (!empty($data['fonts'])) {
foreach ($data['fonts'] as $fontkey => $fontid) {
$out .= ' /F'. $fontid. ' '. $this->font_obj_ids[$fontkey]. ' 0 R';
// images or nested xobjects
if (!empty($data['images']) OR !empty($data['xobjects'])) {
foreach ($data['images'] as $imgid) {
$out .= ' /I'. $imgid. ' '. $this->xobjects['I'. $imgid]['n']. ' 0 R';
foreach ($data['xobjects'] as $sub_id => $sub_objid) {
$out .= ' /'. $sub_id. ' '. $sub_objid['n']. ' 0 R';
$out .= ' /Length '. strlen($stream);
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
* Output Spot Colors Resources.
* @since 4.0.024 (2008-09-12)
$out = '[/Separation /'. str_replace(' ', '#20', $name);
$out .= ' /DeviceCMYK <<';
$out .= ' /Range [0 1 0 1 0 1 0 1] /C0 [0 0 0 0]';
$out .= ' '. sprintf('/C1 [%.4F %.4F %.4F %.4F] ', $color['c']/ 100, $color['m']/ 100, $color['y']/ 100, $color['k']/ 100);
$out .= ' /FunctionType 2 /Domain [0 1] /N 1>>]';
* Return XObjects Dictionary.
* @return string XObjects dictionary
* @since 5.8.014 (2010-08-23)
foreach ($this->xobjects as $id => $objid) {
$out .= ' /'. $id. ' '. $objid['n']. ' 0 R';
* Output Resources Dictionary.
$out .= '<< /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]';
$out .= ' /F'. $font['i']. ' '. $font['n']. ' 0 R';
$out .= ' /ExtGState <<';
if (isset ($extgstate['name'])) {
$out .= ' /'. $extgstate['name'];
$out .= ' '. $extgstate['n']. ' 0 R';
$out .= ' /p'. $id. ' '. $grad['pattern']. ' 0 R';
$out .= ' /Sh'. $id. ' '. $grad['id']. ' 0 R';
$out .= ' /ColorSpace <<';
$out .= ' /CS'. $color['i']. ' '. $color['n']. ' 0 R';
* Adds some Metadata information (Document Information Dictionary)
* (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
// The name of the person who created the document.
// The subject of the document.
// Keywords associated with the document.
// 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.
// If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF.
$out .= ' /Producer '. $this->_textstring('TCP'. 'DF', $oid);
// The date and time the document was created, in human-readable form
// The date and time the document was most recently modified, in human-readable form
// A name object indicating whether the document has been modified to include trapping information
$out .= ' /Trapped /False';
$out = '<< /Type /Catalog';
$out .= ' /OpenAction ['. $this->page_obj_id[1]. ' 0 R /Fit]';
} elseif ($this->ZoomMode == 'fullwidth') {
$out .= ' /OpenAction ['. $this->page_obj_id[1]. ' 0 R /FitH null]';
$out .= ' /OpenAction ['. $this->page_obj_id[1]. ' 0 R /XYZ null null 1]';
if (isset ($this->l['a_meta_language'])) {
$out .= ' /Lang '. $this->_textstring($this->l['a_meta_language'], $oid);
$out .= ' /JavaScript '. ($this->n_js). ' 0 R';
$out .= ' /PageMode /UseOutlines';
$as = '<< /Event /Print /OCGs ['. $p. ' '. $v. '] /Category [/Print] >> << /Event /View /OCGs ['. $p. ' '. $v. '] /Category [/View] >>';
$out .= ' /OCProperties << /OCGs ['. $p. ' '. $v. '] /D << /ON ['. $p. '] /OFF ['. $v. '] /AS ['. $as. '] >> >>';
$objrefs .= ' '. $objid. ' 0 R';
$out .= ' /Fields ['. $objrefs. ']';
// It's better to turn off this value and set the appearance stream for each annotation (/AP) to avoid conflicts with signature fields.
$out .= ' /NeedAppearances true';
$out .= ' /F'. $fontid. ' '. $this->font_obj_ids[$fontkey]. ' 0 R';
$out .= ' /DA (/F'. $font['i']. ' 0 Tf 0 g)';
$out .= ' /Q '. (($this->rtl)? '2': '0');
$out .= ' /Perms << /DocMDP '. ($this->sig_obj_id + 1). ' 0 R >>';
$out .= ' /Perms << /UR3 '. ($this->sig_obj_id + 1). ' 0 R >>';
* Output viewer preferences.
* @return string for viewer preferences
* @since 3.1.000 (2008-06-09)
$out = '/ViewerPreferences <<';
$out .= ' /Direction /R2L';
$out .= ' /Direction /L2R';
$out .= ' /HideToolbar true';
$out .= ' /HideMenubar true';
$out .= ' /HideWindowUI true';
$out .= ' /FitWindow true';
$out .= ' /CenterWindow true';
$out .= ' /DisplayDocTitle true';
$out .= ' /PickTrayByPDFSize true';
$out .= ' /PickTrayByPDFSize false';
$PrintPageRangeNum .= ' '. ($v - 1). '';
$out .= ' /PrintPageRange ['. substr($PrintPageRangeNum,1). ']';
* Output end of document (EOF).
// widget annotation for signature
$out .= '<< /Type /Annot';
$out .= ' /Subtype /Widget';
$this->_out('0 '. ($this->n + 1));
$this->_out('0000000000 65535 f ');
for ($i= 1; $i <= $this->n; ++ $i) {
$out .= ' /Size '. ($this->n + 1);
$out .= ' /Root '. $objid_catalog. ' 0 R';
$out .= ' /Info '. $objid_info. ' 0 R';
$out .= ' /Encrypt '. $this->encryptdata['objid']. ' 0 R';
$this->_out('startxref');
$this->state = 3; // end-of-doc
// remove temporary files used for images
// remove temporary files
// remove temporary files
* @param string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param mixed $format The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @see getPageSizeFromFormat(), setPageFormat()
protected function _beginpage($orientation= '', $format= '') {
// initialize array for graphics tranformation positions inside a page buffer
* Begin a new object and return the object number.
* @return int object number
* Return the starting object string for the selected object ID.
* @param int $objid Object ID (leave empty to get a new ID).
* @return string the starting object string
* @since 5.8.009 (2010-08-20)
protected function _getobj($objid= '') {
* @param int $x X coordinate
* @param int $y Y coordinate
* @param string $txt text to underline
* Underline for rectangular text area.
* @param int $x X coordinate
* @param int $y Y coordinate
* @param int $w width to underline
* @since 4.8.008 (2009-09-29)
return sprintf('%.2F %.2F %.2F %.2F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew), $w * $this->k, $linew);
* @param int $x X coordinate
* @param int $y Y coordinate
* @param string $txt text to linethrough
* Line through for rectangular text area.
* @param int $x X coordinate
* @param int $y Y coordinate
* @param string $txt text to linethrough
* @since 4.9.008 (2009-09-29)
return sprintf('%.2F %.2F %.2F %.2F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew + ($this->FontSizePt / 3)), $w * $this->k, $linew);
* @param int $x X coordinate
* @param int $y Y coordinate
* @param string $txt text to overline
* @since 4.9.015 (2010-04-19)
* Overline for rectangular text area.
* @param int $x X coordinate
* @param int $y Y coordinate
* @param int $w width to overline
* @since 4.9.015 (2010-04-19)
return sprintf('%.2F %.2F %.2F %.2F re f', $x * $this->k, (($this->h - $y + $this->FontAscent) * $this->k) - $linew, $w * $this->k, $linew);
* Read a 4-byte (32 bit) integer from file.
* @param string $f file name.
* Add "\" before "\", "(" and ")"
* @param string $s string to escape.
* @return string escaped string.
// the chr(13) substitution fixes the Bugs item #1421290.
return strtr($s, array(')' => '\\)', '(' => '\\(', '\\' => '\\\\', chr(13) => '\r'));
* Format a data string for meta information
* @param string $s data string to escape.
* @param int $n object ID
* @return string escaped string.
return '('. $this->_escape($s). ')';
* Returns a formatted date for meta information
* @param int $n object ID
* @return string escaped date string.
* @since 4.6.028 (2009-08-25)
* Format a text string for meta information
* @param string $s string to escape.
* @param int $n object ID
* @return string escaped string.
//Convert string to UTF-16BE
* THIS METHOD IS DEPRECATED
* @param string $s string to escape.
* @return string escaped string.
//Convert string to UTF-16BE and reverse RTL language
* @param string $s string to output.
* @param int $n object reference for encryption mode
* @since 5.5.000 (2010-06-22)
// default to current object
* Format output stream (DEPRECATED).
* @param string $s string to output.
* @param int $n object reference for encryption mode
return 'stream'. "\n". $this->_getrawstream($s, $n). "\n". 'endstream';
* Output a stream (DEPRECATED).
* @param string $s string to output.
* @param int $n object reference for encryption mode
* Output a string to the document.
* @param string $s string to output.
protected function _out($s) {
// we are inside an XObject template
// puts data before page footer
// update footer position
* Converts UTF-8 strings to codepoints array.<br>
* Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br>
* Based on: http://www.faqs.org/rfcs/rfc3629.html
* Char. number range | UTF-8 octet sequence
* (hexadecimal) | (binary)
* --------------------+-----------------------------------------------
* 0000 0000-0000 007F | 0xxxxxxx
* 0000 0080-0000 07FF | 110xxxxx 10xxxxxx
* 0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
* 0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
* ---------------------------------------------------------------------
* ---------------------------------------------------------------------
* UTF8-octets = *( UTF8-char )
* UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
* UTF8-2 = %xC2-DF UTF8-tail
* UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
* %xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
* UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
* %xF4 %x80-8F 2( UTF8-tail )
* ---------------------------------------------------------------------
* @param string $str string to process.
* @return array containing codepoints (UTF-8 characters values)
* @since 1.53.0.TC005 (2005-01-05)
// build a unique string key
foreach ($chrarray as $chr) {
// store this char for font subsetting
// update font subsetchars
// new cache array for selected string
// split string into array of equivalent codes
for ($i= 0; $i < $strlen; ++ $i) {
$strarr[] = ord($str{$i});
// insert new value on cache
$unichar = - 1; // last unicode char
$unicode = array(); // array containing unicode values
$bytes = array(); // array containing single character byte sequences
$numbytes = 1; // number of octetc needed to represent the UTF-8 character
$str .= ''; // force $str to be a string
for ($i = 0; $i < $length; ++ $i) {
$char = ord($str{$i}); // get one string character at time
if (count($bytes) == 0) { // get starting octect
$unichar = $char; // use the character "as is" because is ASCII
} elseif (($char >> 0x05) == 0x06) { // 2 bytes character (0x06 = 110 BIN)
$bytes[] = ($char - 0xC0) << 0x06;
} elseif (($char >> 0x04) == 0x0E) { // 3 bytes character (0x0E = 1110 BIN)
$bytes[] = ($char - 0xE0) << 0x0C;
} elseif (($char >> 0x03) == 0x1E) { // 4 bytes character (0x1E = 11110 BIN)
$bytes[] = ($char - 0xF0) << 0x12;
// use replacement character for other invalid sequences
} elseif (($char >> 0x06) == 0x02) { // bytes 2, 3 and 4 must start with 0x02 = 10 BIN
if (count($bytes) == $numbytes) {
// compose UTF-8 bytes to a single unicode value
for ($j = 1; $j < $numbytes; ++ $j) {
$char += ($bytes[$j] << (($numbytes - $j - 1) * 0x06));
if ((($char >= 0xD800) AND ($char <= 0xDFFF)) OR ($char >= 0x10FFFF)) {
/* The definition of UTF-8 prohibits encoding character numbers between
U+D800 and U+DFFF, which are reserved for use with the UTF-16
encoding form (as surrogate pairs) and do not directly represent
$unichar = 0xFFFD; // use replacement character
$unichar = $char; // add char to array
// reset data for next char
// use replacement character for other invalid sequences
// insert unicode value into array
// store this char for font subsetting
// update font subsetchars
// insert new value on cache
* Converts UTF-8 strings to UTF16-BE.<br>
* @param string $str string to process.
* @param boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
* @since 1.53.0.TC005 (2005-01-05)
* @uses UTF8StringToArray(), arrUTF8ToUTF16BE()
return $str; // string is not in unicode
* Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.<br>
* @param string $str string to process.
* @author Andrew Whitehead, Nicola Asuni
* @since 3.2.000 (2008-06-23)
return $str; // string is not in unicode
$outstr = ''; // string to be returned
foreach ($unicode as $char) {
$outstr .= chr($this->unicode->uni_utf8tolatin[$char]);
} elseif ($char == 0xFFFD) {
* Converts UTF-8 characters array to array of Latin1 characters<br>
* @param array $unicode array containing UTF-8 unicode values
* @since 4.8.023 (2010-01-15)
$outarr = array(); // array to be returned
foreach ($unicode as $char) {
$outarr[] = $this->unicode->uni_utf8tolatin[$char];
} elseif ($char == 0xFFFD) {
$outarr[] = 63; // '?' character
* Converts array of UTF-8 characters to UTF16-BE string.<br>
* Based on: http://www.faqs.org/rfcs/rfc2781.html
* Encoding of a single character from an ISO 10646 character value to
* UTF-16 proceeds as follows. Let U be the character number, no greater
* 1) If U < 0x10000, encode U as a 16-bit unsigned integer and
* 2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
* U' must be less than or equal to 0xFFFFF. That is, U' can be
* represented in 20 bits.
* 3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
* 0xDC00, respectively. These integers each have 10 bits free to
* encode the character value, for a total of 20 bits.
* 4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
* bits of W1 and the 10 low-order bits of U' to the 10 low-order
* Graphically, steps 2 through 4 look like:
* U' = yyyyyyyyyyxxxxxxxxxx
* @param array $unicode array containing UTF-8 unicode values
* @param boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
* @since 2.1.000 (2008-01-08)
$outstr = ''; // string to be returned
$outstr .= "\xFE\xFF"; // Byte Order Mark (BOM)
foreach ($unicode as $char) {
// skip Unicode Character 'ZERO WIDTH SPACE' (DEC:8203, U+200B)
} elseif ($char == 0xFFFD) {
$outstr .= "\xFF\xFD"; // replacement character
} elseif ($char < 0x10000) {
$outstr .= chr($char >> 0x08);
$outstr .= chr($char & 0xFF);
$w1 = 0xD800 | ($char >> 0x10);
$w2 = 0xDC00 | ($char & 0x3FF);
$outstr .= chr($w1 >> 0x08);
$outstr .= chr($w1 & 0xFF);
$outstr .= chr($w2 >> 0x08);
$outstr .= chr($w2 & 0xFF);
// ====================================================
* @param array $font font
* @since 4.0.012 (2008-07-24)
* @param array $font font
* @since 4.0.012 (2008-07-24)
if (isset ($this->l['a_meta_dir'])) {
$this->rtl = $this->l['a_meta_dir']== 'rtl' ? true : false;
* @param string $url link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
* @param string $name link name
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param boolean $firstline if true prints only the first line and return the remaining string.
* @param array $color array of RGB text color
* @param string $style font style (U, D, B, I)
* @param boolean $firstblock if true the string is the starting of a line.
* @return the number of cells used or the remaining text if $firstline = true;
public function addHtmlLink($url, $name, $fill= false, $firstline= false, $color= '', $style=- 1, $firstblock= false) {
// convert url to internal link
if (isset ($lnkdata[0])) {
if (empty($page) OR ($page <= 0)) {
if (isset ($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
$this->SetLink($url, $lnky, $page);
// store current settings
$ret = $this->Write($this->lasth, $name, $url, $fill, '', false, 0, $firstline, $firstblock, 0);
* 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 RGB color or false in case of error.
$color = preg_replace('/[\s]*/', '', $color); // remove extra spaces
if (($dotpos = strpos($color, '.')) !== false) {
// remove class parent (i.e.: color.red)
$color = substr($color, ($dotpos + 1));
if (substr($color, 0, 3) == 'rgb') {
$returncolor = explode(',', $codes);
if (substr($color, 0, 4) == 'cmyk') {
$returncolor = explode(',', $codes);
if (substr($color, 0, 1) != '#') {
$color_code = substr($color, 1);
switch (strlen($color_code)) {
// three-digit hexadecimal representation
$r = substr($color_code, 0, 1);
$g = substr($color_code, 1, 1);
$b = substr($color_code, 2, 1);
$returncolor['R'] = hexdec($r. $r);
$returncolor['G'] = hexdec($g. $g);
$returncolor['B'] = hexdec($b. $b);
// six-digit hexadecimal representation
* Converts pixels to User's Units.
* @return float value in user's unit
* @see setImageScale(), getImageScale()
* Reverse function for htmlentities.
* Convert entities in UTF-8.
* @param string $text_to_convert Text to convert.
* @return string converted text string
// ENCRYPTION METHODS ----------------------------------
* Returns a string containing random data to be used as a seed for encryption methods.
* @param string $seed starting seed value
* @return string containing random data
* @since 5.9.006 (2010-10-19)
$seed .= openssl_random_pseudo_bytes(512);
if (isset ($_SERVER['REMOTE_ADDR'])) {
$seed .= $_SERVER['REMOTE_ADDR'];
if (isset ($_SERVER['HTTP_USER_AGENT'])) {
$seed .= $_SERVER['HTTP_USER_AGENT'];
if (isset ($_SERVER['HTTP_ACCEPT'])) {
$seed .= $_SERVER['HTTP_ACCEPT'];
if (isset ($_SERVER['HTTP_ACCEPT_ENCODING'])) {
$seed .= $_SERVER['HTTP_ACCEPT_ENCODING'];
if (isset ($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
$seed .= $_SERVER['HTTP_ACCEPT_LANGUAGE'];
if (isset ($_SERVER['HTTP_ACCEPT_CHARSET'])) {
$seed .= $_SERVER['HTTP_ACCEPT_CHARSET'];
* Compute encryption key depending on object number where the encrypted data is stored.
* This is used for all strings and streams without crypt filter specifier.
* @param int $n object number
* @since 2.0.000 (2008-01-02)
$objkey .= "\x73\x41\x6C\x54"; // sAlT
$objkey = substr($objkey, 0, 16);
* Encrypt the input string.
* @param int $n object number
* @param string $s data string to encrypt
* @return encrypted string
* @since 5.0.005 (2010-05-11)
* Put encryption on PDF document.
* @since 2.0.000 (2008-01-02)
$out .= ' /SubFilter /'. $this->encryptdata['SubFilter'];
// V is a code specifying the algorithm to be used in encrypting and decrypting the document
// The length of the encryption key, in bits. The value shall be a multiple of 8, in the range 40 to 256
// The name of the crypt filter that shall be used when decrypting all strings in the document.
// A dictionary whose keys shall be crypt filter names and whose values shall be the corresponding crypt filter dictionaries.
$out .= ' /Type /CryptFilter';
$out .= ' /Recipients [';
$out .= ' /EncryptMetadata false';
$out .= ' /EncryptMetadata true';
// The event to be used to trigger the authorization that is required to access encryption keys used by this filter.
$out .= ' /AuthEvent /'. $this->encryptdata['CF']['AuthEvent'];
$out .= ' /AuthEvent /DocOpen';
// The bit length of the encryption key.
$out .= ' /Length '. $this->encryptdata['CF']['Length'];
// The name of the crypt filter that shall be used by default when decrypting streams.
// The name of the crypt filter that shall be used when decrypting all strings in the document.
// The name of the crypt filter that shall be used when encrypting embedded file streams that do not have their own crypt filter specifier.
// Additional encryption dictionary entries for the standard security handler
$out .= ' /Recipients [';
$out .= ' /EncryptMetadata false';
$out .= ' /EncryptMetadata true';
* Returns the input text encrypted using RC4 algorithm and the specified key.
* RC4 is the standard encryption algorithm used in PDF format
* @param string $key encryption key
* @param String $text input text to be encrypted
* @return String encrypted text
* @since 2.0.000 (2008-01-02)
* @author Klemen Vodopivec, Nicola Asuni
protected function _RC4($key, $text) {
// try to use mcrypt function if exist
for ($i = 0; $i < 256; ++ $i) {
$j = ($j + $t + ord($k{$i})) % 256;
for ($i = 0; $i < $len; ++ $i) {
$k = $rc4[($rc4[$a] + $rc4[$b]) % 256];
$out .= chr(ord($text{$i}) ^ $k);
* Returns the input text exrypted using AES algorithm and the specified key.
* This method requires mcrypt.
* @param string $key encryption key
* @param String $text input text to be encrypted
* @return String encrypted text
* @since 5.0.005 (2010-05-11)
protected function _AES($key, $text) {
// padding (RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0)
$padding = 16 - (strlen($text) % 16);
$text = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $text, MCRYPT_MODE_CBC, $iv);
* 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
* @since 2.0.000 (2008-01-02)
* @author Klemen Vodopivec
* Compute U value (used for encryption)
* @since 2.0.000 (2008-01-02)
} elseif ($this->encryptdata['mode'] < 3) { // RC4-128, AES-128
for ($i = 1; $i <= 19; ++ $i) {
for ($j = 0; $j < $len; ++ $j) {
$enc = $this->_RC4($ek, $enc);
} elseif ($this->encryptdata['mode'] == 3) { // AES-256
* Compute UE value (used for encryption)
* @return string UE value
* @since 5.9.006 (2010-10-19)
* Compute O value (used for encryption)
* @since 2.0.000 (2008-01-02)
if ($this->encryptdata['mode'] < 3) { // RC4-40, RC4-128, AES-128
for ($i = 0; $i < 50; ++ $i) {
for ($i = 1; $i <= 19; ++ $i) {
for ($j = 0; $j < $len; ++ $j) {
$ek .= chr(ord($owner_key{$j}) ^ $i);
$enc = $this->_RC4($ek, $enc);
} elseif ($this->encryptdata['mode'] == 3) { // AES-256
* Compute OE value (used for encryption)
* @return string OE value
* @since 5.9.006 (2010-10-19)
* Convert password for AES-256 encryption mode
* @return string password
* @since 5.9.006 (2010-10-19)
$psw = ''; // password to be returned
foreach ($psw_array as $c) {
* @since 2.0.000 (2008-01-02)
// generate 256 bit random key
// Computing the encryption dictionary's Perms (permissions) value
if (isset ($this->encryptdata['CF']['EncryptMetadata']) AND (!$this->encryptdata['CF']['EncryptMetadata'])) { // byte 8
$perms .= 'adb'; // bytes 9-11
$perms .= 'nick'; // bytes 12-15
} else { // RC4-40, RC4-128, AES-128
// get default permissions (reverse byte order)
// Compute encryption key
for ($i = 0; $i < 50; ++ $i) {
} else { // Public-Key mode
// for each public certificate
if (isset ($pubkey['p'])) {
// get default permissions (reverse byte order)
$envelope = $seed. $pkpermissions;
// write the envelope data to a temporary file
$f = fopen($tempkeyfile, 'wb');
$this->Error('Unable to create temporary key file: '. $tempkeyfile);
$envelope_lenght = strlen($envelope);
fwrite($f, $envelope, $envelope_lenght);
if (!openssl_pkcs7_encrypt($tempkeyfile, $tempencfile, $pubkey['c'], array(), PKCS7_DETACHED | PKCS7_BINARY)) {
$this->Error('Unable to encrypt the file: '. $tempkeyfile);
// read encryption signature
$signature = substr($signature, strpos($signature, 'Content-Disposition'));
$tmparr = explode("\n\n", $signature);
$signature = trim($tmparr[1]);
// convert signature to hex
// store signature on recipients array
// The bytes of each item in the Recipients array of PKCS#7 objects in the order in which they appear in the array
$recipient_bytes .= $signature;
// calculate encryption key
} else { // RC4-40, RC4-128, AES-128
* Return the premission code used on encryption (P value).
* @param Array $permissions the set of permissions (specify the ones you want to block).
* @param int $mode encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
* @since 5.0.005 (2010-05-12)
'owner' => 2, // bit 2 -- inverted logic: cleared by default
'annot-forms' => 32, // bit 6
'fill-forms' => 256, // bit 9
'extract' => 512, // bit 10
'assemble' => 1024,// bit 11
'print-high' => 2048 // bit 12
$protection = 2147422012; // 32 bit: (01111111 11111111 00001111 00111100)
foreach ($permissions as $permission) {
if (!isset ($options[$permission])) {
$this->Error('Incorrect permission: '. $permission);
if (($mode > 0) OR ($options[$permission] <= 32)) {
// set only valid permissions
if ($options[$permission] == 2) {
// the logic for bit 2 is inverted (cleared by default)
$protection += $options[$permission];
$protection -= $options[$permission];
* Set document protection
* Remark: the protection against modification is for people who have the full Acrobat product.
* If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access.
* Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
* @param Array $permissions the set of permissions (specify the ones you want to block):<ul><li>print : Print the document;</li><li>modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';</li><li>copy : Copy or otherwise extract text and graphics from the document;</li><li>annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);</li><li>fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;</li><li>extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);</li><li>assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;</li><li>print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.</li><li>owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.</li></ul>
* @param String $user_pass user password. Empty by default.
* @param String $owner_pass owner password. If not specified, a random value is used.
* @param int $mode encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
* @param String $pubkeys array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../tcpdf.crt', 'p' => array('print')))
* @since 2.0.000 (2008-01-02)
public function SetProtection($permissions= array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass= '', $owner_pass= null, $mode= 0, $pubkeys= null) {
if (($pubkeys !== null) AND (is_array($pubkeys))) {
// public-Key Security requires at least 128 bit
$this->Error('Public-Key Security requires openssl library.');
// Set Public-Key filter (availabe are: Entrust.PPKEF, Adobe.PPKLite, Adobe.PubSec)
// standard mode (password mode)
$this->Error('AES encryption requires mcrypt library (http://www.php.net/manual/en/mcrypt.requirements.php).');
$this->Error('AES encryption requires MCRYPT_RIJNDAEL_128 cypher.');
// the Hash extension requires no external libraries and is enabled by default as of PHP 5.1.2.
$this->Error('AES 256 encryption requires HASH Message Digest Framework (http://www.php.net/manual/en/book.hash.php).');
if ($owner_pass === null) {
* Convert hexadecimal string to string
* @param string $bs byte-string to convert
* @since 5.0.005 (2010-05-12)
$string = ''; // string to be returned
if (($bslenght % 2) != 0) {
for ($i = 0; $i < $bslenght; $i += 2) {
$string .= chr(hexdec($bs{$i}. $bs{($i + 1)}));
* Convert string to hexadecimal string (byte string)
* @param string $s string to convert
* @since 5.0.010 (2010-05-17)
$chars = preg_split('//', $s, - 1, PREG_SPLIT_NO_EMPTY);
* Convert encryption P value to a string of bytes, low-order byte first.
* @param string $protection 32bit encryption permission value (P value)
* @since 5.0.005 (2010-05-12)
$binprot = sprintf('%032b', $protection);
// END OF ENCRYPTION FUNCTIONS -------------------------
// START TRANSFORMATIONS SECTION -----------------------
* 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.
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
// we are inside an XObject template
* 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.
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
// we are inside an XObject template
* @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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function ScaleX($s_x, $x= '', $y= '') {
$this->Scale($s_x, 100, $x, $y);
* @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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function ScaleY($s_y, $x= '', $y= '') {
$this->Scale(100, $s_y, $x, $y);
* Vertical and horizontal proportional Scaling.
* @param float $s scaling factor for width and height as percent. 0 is not allowed.
* @param int $x abscissa of the scaling center. Default is current x position
* @param int $y ordinate of the scaling center. Default is current y position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function ScaleXY($s, $x= '', $y= '') {
$this->Scale($s, $s, $x, $y);
* Vertical and horizontal non-proportional Scaling.
* @param float $s_x scaling factor for width as percent. 0 is not allowed.
* @param float $s_y scaling factor for height as percent. 0 is not allowed.
* @param int $x abscissa of the scaling center. Default is current x position
* @param int $y ordinate of the scaling center. Default is current y position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function Scale($s_x, $s_y, $x= '', $y= '') {
if (($s_x == 0) OR ($s_y == 0)) {
$this->Error('Please do not use values equal to zero for scaling');
$y = ($this->h - $y) * $this->k;
//calculate elements of transformation matrix
$tm[4] = $x * (1 - $s_x);
$tm[5] = $y * (1 - $s_y);
//scale the coordinate system
* @param int $x abscissa of the point. Default is current x position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
$this->Scale(- 100, 100, $x);
* @param int $y ordinate of the point. Default is current y position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
$this->Scale(100, - 100, '', $y);
* 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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function MirrorP($x= '',$y= '') {
$this->Scale(- 100, - 100, $x, $y);
* Reflection against a straight line through point (x, y) with the gradient angle (angle).
* @param float $angle gradient angle of the straight line. Default is 0 (horizontal line).
* @param int $x abscissa of the point. Default is current x position
* @param int $y ordinate of the point. Default is current y position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function MirrorL($angle= 0, $x= '',$y= '') {
$this->Scale(- 100, 100, $x, $y);
$this->Rotate(- 2* ($angle- 90), $x, $y);
* Translate graphic object horizontally.
* @param int $t_x movement to the right (or left for RTL)
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
* Translate graphic object vertically.
* @param int $t_y movement to the bottom
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
* Translate graphic object horizontally and vertically.
* @param int $t_x movement to the right
* @param int $t_y movement to the bottom
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
//calculate elements of transformation matrix
$tm[4] = $t_x * $this->k;
$tm[5] = - $t_y * $this->k;
//translate the coordinate system
* @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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function Rotate($angle, $x= '', $y= '') {
$y = ($this->h - $y) * $this->k;
//calculate elements of transformation matrix
$tm[4] = $x + ($tm[1] * $y) - ($tm[0] * $x);
$tm[5] = $y - ($tm[0] * $y) - ($tm[1] * $x);
//rotate the coordinate system around ($x,$y)
* @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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function SkewX($angle_x, $x= '', $y= '') {
$this->Skew($angle_x, 0, $x, $y);
* @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
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function SkewY($angle_y, $x= '', $y= '') {
$this->Skew(0, $angle_y, $x, $y);
* @param float $angle_x angle in degrees between -90 (skew to the left) and 90 (skew to the right)
* @param float $angle_y angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
* @param int $x abscissa of the skewing center. default is current x position
* @param int $y ordinate of the skewing center. default is current y position
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
public function Skew($angle_x, $angle_y, $x= '', $y= '') {
if (($angle_x <= - 90) OR ($angle_x >= 90) OR ($angle_y <= - 90) OR ($angle_y >= 90)) {
$this->Error('Please use values between -90 and +90 degrees for Skewing.');
$y = ($this->h - $y) * $this->k;
//calculate elements of transformation matrix
//skew the coordinate system
* Apply graphic transformations.
* @param array $tm transformation matrix
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
$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 transformation mark
// we are inside an XObject template
// END TRANSFORMATIONS SECTION -------------------------
// START GRAPHIC FUNCTIONS SECTION ---------------------
// The following section is based on the code provided by David Hernandez Sanz
* 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.
* @see Line(), Rect(), Cell(), MultiCell()
* Returns the current the line width.
* @since 2.1.000 (2008-01-07)
* @see Line(), SetLineWidth()
* @param array $style Line style. Array with keys among the following:
* <li>width (float): Width of the line in user units.</li>
* <li>cap (string): Type of cap to put on the line. Possible values are:
* butt, round, square. The difference between "square" and "butt" is that
* "square" projects a flat end past the end of the line.</li>
* <li>join (string): Type of join. Possible values are: miter, round,
* <li>dash (mixed): Dash pattern. Is 0 (without dash) or string with
* series of length values, which are the lengths of the on and off dashes.
* For example: "2" represents 2 on, 2 off, 2 on, 2 off, ...; "2,1" is 2 on,
* 1 off, 2 on, 1 off, ...</li>
* <li>phase (integer): Modifier on the dash pattern which is used to shift
* the point at which the pattern starts.</li>
* <li>color (array): Draw color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K).</li>
* @param boolean $ret if true do not send the command.
* @return string the PDF command
* @since 2.1.000 (2008-01-08)
$s = ''; // string to be returned
$ca = array('butt' => 0, 'round'=> 1, 'square' => 2);
$ja = array('miter' => 0, 'round' => 1, 'bevel' => 2);
foreach ($tab as $i => $v) {
$dash_string .= sprintf('%.2F', $v);
if (!isset ($phase) OR !$dash) {
* Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
* @param float $x Abscissa of point.
* @param float $y Ordinate of point.
* @since 2.1.000 (2008-01-08)
$this->_out(sprintf('%.2F %.2F m', $x * $this->k, ($this->h - $y) * $this->k));
* Append a straight line segment from the current point to the point (x, y).
* The new current point shall be (x, y).
* @param float $x Abscissa of end point.
* @param float $y Ordinate of end point.
* @since 2.1.000 (2008-01-08)
$this->_out(sprintf('%.2F %.2F l', $x * $this->k, ($this->h - $y) * $this->k));
* Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
* @param float $x Abscissa of upper-left corner (or upper-right corner for RTL language).
* @param float $y Ordinate of upper-left corner (or upper-right corner for RTL language).
* @param float $h Height.
* @param string $op options
* @since 2.1.000 (2008-01-08)
protected function _outRect($x, $y, $w, $h, $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));
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points.
* The new current point shall be (x3, y3).
* @param float $x1 Abscissa of control point 1.
* @param float $y1 Ordinate of control point 1.
* @param float $x2 Abscissa of control point 2.
* @param float $y2 Ordinate of control point 2.
* @param float $x3 Abscissa of end point.
* @param float $y3 Ordinate of end point.
* @since 2.1.000 (2008-01-08)
protected function _outCurve($x1, $y1, $x2, $y2, $x3, $y3) {
$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));
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points.
* The new current point shall be (x3, y3).
* @param float $x2 Abscissa of control point 2.
* @param float $y2 Ordinate of control point 2.
* @param float $x3 Abscissa of end point.
* @param float $y3 Ordinate of end point.
* @since 4.9.019 (2010-04-26)
protected function _outCurveV($x2, $y2, $x3, $y3) {
$this->_out(sprintf('%.2F %.2F %.2F %.2F v', $x2 * $this->k, ($this->h - $y2) * $this->k, $x3 * $this->k, ($this->h - $y3) * $this->k));
* Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points.
* The new current point shall be (x3, y3).
* @param float $x1 Abscissa of control point 1.
* @param float $y1 Ordinate of control point 1.
* @param float $x2 Abscissa of control point 2.
* @param float $y2 Ordinate of control point 2.
* @param float $x3 Abscissa of end point.
* @param float $y3 Ordinate of end point.
* @since 2.1.000 (2008-01-08)
protected function _outCurveY($x1, $y1, $x3, $y3) {
$this->_out(sprintf('%.2F %.2F %.2F %.2F y', $x1 * $this->k, ($this->h - $y1) * $this->k, $x3 * $this->k, ($this->h - $y3) * $this->k));
* Draws a line between two points.
* @param float $x1 Abscissa of first point.
* @param float $y1 Ordinate of first point.
* @param float $x2 Abscissa of second point.
* @param float $y2 Ordinate of second point.
* @param array $style Line style. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @see SetLineWidth(), SetDrawColor(), SetLineStyle()
public function Line($x1, $y1, $x2, $y2, $style= array()) {
* @param float $x Abscissa of upper-left corner (or upper-right corner for RTL language).
* @param float $y Ordinate of upper-left corner (or upper-right corner for RTL language).
* @param float $h Height.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $border_style Border style of rectangle. Array with keys among the following:
* <li>all: Line style of all borders. Array like for {@link SetLineStyle SetLineStyle}.</li>
* <li>L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for {@link SetLineStyle SetLineStyle}.</li>
* If a key is not present or is null, not draws the border. Default value: default line style (empty array).
* @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
public function Rect($x, $y, $w, $h, $style= '', $border_style= array(), $fill_color= array()) {
if (!(false === strpos($style, 'F')) AND !empty($fill_color)) {
if ((!$border_style) OR (isset ($border_style['all']))) {
if (isset ($border_style['all']) AND $border_style['all']) {
$border_style2 = array();
foreach ($border_style as $line => $value) {
for ($i = 0; $i < $length; ++ $i) {
$border_style2[$line[$i]] = $value;
$border_style = $border_style2;
if (isset ($border_style['L']) AND $border_style['L']) {
$this->Line($x, $y, $x, $y + $h, $border_style['L']);
if (isset ($border_style['T']) AND $border_style['T']) {
$this->Line($x, $y, $x + $w, $y, $border_style['T']);
if (isset ($border_style['R']) AND $border_style['R']) {
$this->Line($x + $w, $y, $x + $w, $y + $h, $border_style['R']);
if (isset ($border_style['B']) AND $border_style['B']) {
$this->Line($x, $y + $h, $x + $w, $y + $h, $border_style['B']);
* The Bezier curve is a tangent to the line between the control points at
* either end of the curve.
* @param float $x0 Abscissa of start point.
* @param float $y0 Ordinate of start point.
* @param float $x1 Abscissa of control point 1.
* @param float $y1 Ordinate of control point 1.
* @param float $x2 Abscissa of control point 2.
* @param float $y2 Ordinate of control point 2.
* @param float $x3 Abscissa of end point.
* @param float $y3 Ordinate of end point.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of curve. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @since 2.1.000 (2008-01-08)
public function Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style= '', $line_style= array(), $fill_color= array()) {
if (!(false === strpos($style, 'F')) AND isset ($fill_color)) {
$this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
* Draws a poly-Bezier curve.
* Each Bezier curve segment is a tangent to the line between the control points at
* either end of the curve.
* @param float $x0 Abscissa of start point.
* @param float $y0 Ordinate of start point.
* @param float $segments An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of curve. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @since 3.0008 (2008-05-12)
public function Polycurve($x0, $y0, $segments, $style= '', $line_style= array(), $fill_color= array()) {
if (!(false === strpos($style, 'F')) AND isset ($fill_color)) {
foreach ($segments as $segment) {
list ($x1, $y1, $x2, $y2, $x3, $y3) = $segment;
$this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
* An ellipse is formed from n Bezier curves.
* @param float $x0 Abscissa of center point.
* @param float $y0 Ordinate of center point.
* @param float $rx Horizontal radius.
* @param float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
* @param float $angle: Angle oriented (anti-clockwise). Default value: 0.
* @param float $astart: Angle start of draw line. Default value: 0.
* @param float $afinish: Angle finish of draw line. Default value: 360.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of ellipse. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @param integer $nc Number of curves used to draw a 90 degrees portion of ellipse.
* @since 2.1.000 (2008-01-08)
public function Ellipse($x0, $y0, $rx, $ry= '', $angle= 0, $astart= 0, $afinish= 360, $style= '', $line_style= array(), $fill_color= array(), $nc= 2) {
if (!(false === strpos($style, 'F')) AND isset ($fill_color)) {
* Append an elliptical arc to the current path.
* An ellipse is formed from n Bezier curves.
* @param float $xc Abscissa of center point.
* @param float $yc Ordinate of center point.
* @param float $rx Horizontal radius.
* @param float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
* @param float $xang: Angle between the X-axis and the major axis of the ellipse. Default value: 0.
* @param float $angs: Angle start of draw line. Default value: 0.
* @param float $angf: Angle finish of draw line. Default value: 360.
* @param boolean $pie if true do not mark the border point (used to draw pie sectors).
* @param integer $nc Number of curves used to draw a 90 degrees portion of ellipse.
* @since 4.9.019 (2010-04-26)
protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang= 0, $angs= 0, $angf= 360, $pie= false, $nc= 2) {
// reverse rotation go clockwise
$total_angle = ($af - $as);
$nc *= (2 * abs($total_angle) / M_PI);
$arcang = $total_angle / $nc;
// center point in PDF coordiantes
$alpha = sin($arcang) * ((sqrt(4 + (3 * pow(tan(($arcang) / 2), 2))) - 1) / 3);
$px1 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
$py1 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
// first Bezier control point
$qx1 = ($alpha * ((- $rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
$qy1 = ($alpha * ((- $rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
for ($i = 1; $i <= $nc; ++ $i) {
$ang = $as + ($i * $arcang);
$px2 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
$py2 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
// second Bezier control point
$qx2 = ($alpha * ((- $rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
$qy2 = ($alpha * ((- $rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
$this->_outCurve(($px1 + $qx1), ($this->h - ($py1 + $qy1)), ($px2 - $qx2), ($this->h - ($py2 - $qy2)), $px2, ($this->h - $py2));
* A circle is formed from n Bezier curves.
* @param float $x0 Abscissa of center point.
* @param float $y0 Ordinate of center point.
* @param float $r Radius.
* @param float $angstr: Angle start of draw line. Default value: 0.
* @param float $angend: Angle finish of draw line. Default value: 360.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of circle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param integer $nc Number of curves used to draw a 90 degrees portion of circle.
* @since 2.1.000 (2008-01-08)
public function Circle($x0, $y0, $r, $angstr= 0, $angend= 360, $style= '', $line_style= array(), $fill_color= array(), $nc= 2) {
$this->Ellipse($x0, $y0, $r, $r, 0, $angstr, $angend, $style, $line_style, $fill_color, $nc);
* @param array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of polygon. Array with keys among the following:
* <li>all: Line style of all lines. Array like for {@link SetLineStyle SetLineStyle}.</li>
* <li>0 to ($np - 1): Line style of each line. Array like for {@link SetLineStyle SetLineStyle}.</li>
* 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
* @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);
* @param array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of polygon. Array with keys among the following:
* <li>all: Line style of all lines. Array like for {@link SetLineStyle SetLineStyle}.</li>
* <li>0 to ($np - 1): Line style of each line. Array like for {@link SetLineStyle SetLineStyle}.</li>
* 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
* @since 2.1.000 (2008-01-08)
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
// close polygon by adding the first 2 points at the end (one line)
for ($i = 0; $i < 4; ++ $i) {
// copy style for the last added line
if (isset ($line_style[0])) {
$line_style[$np] = $line_style[0];
if (!(false === strpos($style, 'F')) AND isset ($fill_color)) {
if (isset ($line_style['all'])) {
for ($i = 2; $i < $nc; $i = $i + 2) {
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) {
for ($i = 2; $i < $nc; $i = $i + 2) {
* Draws a regular polygon.
* @param float $x0 Abscissa of center point.
* @param float $y0 Ordinate of center point.
* @param float $r: Radius of inscribed circle.
* @param integer $ns Number of sides.
* @param float $angle Angle oriented (anti-clockwise). Default value: 0.
* @param boolean $draw_circle Draw inscribed circle or not. Default value: false.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of polygon sides. Array with keys among the following:
* <li>all: Line style of all sides. Array like for {@link SetLineStyle SetLineStyle}.</li>
* <li>0 to ($ns - 1): Line style of each side. Array like for {@link SetLineStyle SetLineStyle}.</li>
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
* @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param string $circle_style Style of rendering of inscribed circle (if draws). Possible values are:
* <li>D or empty string: Draw (default).</li>
* <li>DF or FD: Draw and fill.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* @param array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
* @since 2.1.000 (2008-01-08)
public function RegularPolygon($x0, $y0, $r, $ns, $angle= 0, $draw_circle= false, $style= '', $line_style= array(), $fill_color= array(), $circle_style= '', $circle_outLine_style= array(), $circle_fill_color= array()) {
$this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
for ($i = 0; $i < $ns; ++ $i) {
$a = $angle + ($i * 360 / $ns);
$p[] = $x0 + ($r * sin($a_rad));
$p[] = $y0 + ($r * cos($a_rad));
$this->Polygon($p, $style, $line_style, $fill_color);
* @param float $x0 Abscissa of center point.
* @param float $y0 Ordinate of center point.
* @param float $r Radius of inscribed circle.
* @param integer $nv Number of vertices.
* @param integer $ng Number of gap (if ($ng % $nv = 1) then is a regular polygon).
* @param float $angle: Angle oriented (anti-clockwise). Default value: 0.
* @param boolean $draw_circle: Draw inscribed circle or not. Default value is false.
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $line_style Line style of polygon sides. Array with keys among the following:
* <li>all: Line style of all sides. Array like for
* {@link SetLineStyle SetLineStyle}.</li>
* <li>0 to (n - 1): Line style of each side. Array like for {@link SetLineStyle SetLineStyle}.</li>
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
* @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param string $circle_style Style of rendering of inscribed circle (if draws). Possible values are:
* <li>D or empty string: Draw (default).</li>
* <li>DF or FD: Draw and fill.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* @param array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
* @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()) {
$this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
for ($i = 0; $i < $nv; ++ $i) {
$a = $angle + ($i * 360 / $nv);
$p2[] = $x0 + ($r * sin($a_rad));
$p2[] = $y0 + ($r * cos($a_rad));
$p[] = $p2[($i * 2) + 1];
$this->Polygon($p, $style, $line_style, $fill_color);
* Draws a rounded rectangle.
* @param float $x Abscissa of upper-left corner.
* @param float $y Ordinate of upper-left corner.
* @param float $h Height.
* @param float $r the radius of the circle used to round off the corners of the rectangle.
* @param string $round_corner Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @since 2.1.000 (2008-01-08)
public function RoundedRect($x, $y, $w, $h, $r, $round_corner= '1111', $style= '', $border_style= array(), $fill_color= array()) {
$this->RoundedRectXY($x, $y, $w, $h, $r, $r, $round_corner, $style, $border_style, $fill_color);
* Draws a rounded rectangle.
* @param float $x Abscissa of upper-left corner.
* @param float $y Ordinate of upper-left corner.
* @param float $h Height.
* @param float $rx the x-axis radius of the ellipse used to round off the corners of the rectangle.
* @param float $ry the y-axis radius of the ellipse used to round off the corners of the rectangle.
* @param string $round_corner Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
* @param array $fill_color Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array).
* @since 4.9.019 (2010-04-22)
public function RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner= '1111', $style= '', $border_style= array(), $fill_color= array()) {
if (($round_corner == '0000') OR (($rx == $ry) AND ($rx == 0))) {
$this->Rect($x, $y, $w, $h, $style, $border_style, $fill_color);
if (!(false === strpos($style, 'F')) AND isset ($fill_color)) {
$MyArc = 4 / 3 * (sqrt(2) - 1);
$this->_outCurve($xc + ($rx * $MyArc), $yc - $ry, $xc + $rx, $yc - ($ry * $MyArc), $xc + $rx, $yc);
$this->_outCurve($xc + $rx, $yc + ($ry * $MyArc), $xc + ($rx * $MyArc), $yc + $ry, $xc, $yc + $ry);
$this->_outCurve($xc - ($rx * $MyArc), $yc + $ry, $xc - $rx, $yc + ($ry * $MyArc), $xc - $rx, $yc);
$this->_outCurve($xc - $rx, $yc - ($ry * $MyArc), $xc - ($rx * $MyArc), $yc - $ry, $xc, $yc - $ry);
* @param float $x0 Abscissa of first point.
* @param float $y0 Ordinate of first point.
* @param float $x0 Abscissa of second point.
* @param float $y1 Ordinate of second point.
* @param int $head_style (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
* @param float $arm_size length of arrowhead arms
* @param int $arm_angle angle between an arm and the shaft
* @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 = atan2(($y0 - $y1), ($x0 - $x1));
$dir_angle += (2 * M_PI);
// calculate the stopping point for the arrow shaft
$sx1 = $x1 + (($arm_size - $this->LineWidth) * cos($dir_angle));
$sy1 = $y1 + (($arm_size - $this->LineWidth) * sin($dir_angle));
// main arrow line / shaft
$this->Line($x0, $y0, $sx1, $sy1);
// left arrowhead arm tip
$x2L = $x1 + ($arm_size * cos($dir_angle + $arm_angle));
$y2L = $y1 + ($arm_size * sin($dir_angle + $arm_angle));
// right arrowhead arm tip
$x2R = $x1 + ($arm_size * cos($dir_angle - $arm_angle));
$y2R = $y1 + ($arm_size * sin($dir_angle - $arm_angle));
// draw only arrowhead arms
// draw closed arrowhead, but no fill
// closed and filled arrowhead
$this->Polygon(array($x2L, $y2L, $x1, $y1, $x2R, $y2R), $mode, $style, array());
// END GRAPHIC FUNCTIONS SECTION -----------------------
// BIDIRECTIONAL TEXT SECTION --------------------------
* Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
* @param string $str string to manipulate.
* @param bool $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
* @param bool $forcertl if true forces RTL text direction
* @since 2.1.000 (2008-01-08)
protected function utf8StrRev($str, $setbom= false, $forcertl= false) {
* Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
* @param array $arr array of unicode values.
* @param string $str string to manipulate (or empty value).
* @param bool $setbom if true set the Byte Order Mark (BOM = 0xFEFF)
* @param bool $forcertl if true forces RTL text direction
* @since 4.9.000 (2010-03-27)
protected function utf8StrArrRev($arr, $str= '', $setbom= false, $forcertl= false) {
* 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 array of unicode chars
* @since 2.4.000 (2008-03-06)
protected function utf8Bidi($ta, $str= '', $forcertl= false) {
// paragraph embedding level
// create string from array
// check if string contains arabic text
// check if string contains RTL text
if (!($forcertl OR $arabic OR preg_match($this->unicode->uni_RE_PATTERN_RTL, $str))) {
} elseif ($forcertl == 'L') {
// 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) {
$type = $this->unicode->uni_type[$ta[$i]];
} elseif (($type == 'AL') OR ($type == 'R')) {
// Current Embedding Level
// directional override status
$sor = $pel % 2 ? 'R' : 'L';
// Array of characters data
// 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) {
if ($ta[$i] == $this->unicode->uni_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.
// b. If the new level would not be valid, then this code is invalid. Do not change the current level or override status.
$next_level = $cel + ($cel % 2) + 1;
$remember[] = array('num' => $this->unicode->uni_RLE, 'cel' => $cel, 'dos' => $dos);
$eor = $cel % 2 ? 'R' : 'L';
} elseif ($ta[$i] == $this->unicode->uni_LRE) {
// X3. With each LRE, compute the least greater even 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.
// b. If the new level would not be valid, then this code is invalid. Do not change the current level or override status.
$next_level = $cel + 2 - ($cel % 2);
if ( $next_level < 62 ) {
$remember[] = array('num' => $this->unicode->uni_LRE, 'cel' => $cel, 'dos' => $dos);
$eor = $cel % 2 ? 'R' : 'L';
} elseif ($ta[$i] == $this->unicode->uni_RLO) {
// X4. With each RLO, 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 right-to-left.
// b. If the new level would not be valid, then this code is invalid. Do not change the current level or override status.
$next_level = $cel + ($cel % 2) + 1;
$remember[] = array('num' => $this->unicode->uni_RLO, 'cel' => $cel, 'dos' => $dos);
$eor = $cel % 2 ? 'R' : 'L';
} elseif ($ta[$i] == $this->unicode->uni_LRO) {
// X5. With each LRO, compute the least greater even 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 left-to-right.
// b. If the new level would not be valid, then this code is invalid. Do not change the current level or override status.
$next_level = $cel + 2 - ($cel % 2);
if ( $next_level < 62 ) {
$remember[] = array('num' => $this->unicode->uni_LRO, 'cel' => $cel, 'dos' => $dos);
$eor = $cel % 2 ? 'R' : 'L';
} elseif ($ta[$i] == $this->unicode->uni_PDF) {
// X7. With each PDF, determine the matching embedding or override code. If there was a valid matching code, restore (pop) the last remembered (pushed) embedding level and directional override.
$last = count($remember ) - 1;
if (($remember[$last]['num'] == $this->unicode->uni_RLE) OR
($remember[$last]['num'] == $this->unicode->uni_LRE) OR
($remember[$last]['num'] == $this->unicode->uni_RLO) OR
($remember[$last]['num'] == $this->unicode->uni_LRO)) {
$eor = ($cel > $match['cel'] ? $cel : $match['cel']) % 2 ? 'R' : 'L';
} elseif (($ta[$i] != $this->unicode->uni_RLE) AND
($ta[$i] != $this->unicode->uni_LRE) AND
($ta[$i] != $this->unicode->uni_RLO) AND
($ta[$i] != $this->unicode->uni_LRO) AND
($ta[$i] != $this->unicode->uni_PDF)) {
// X6. For all types besides RLE, LRE, RLO, LRO, and PDF:
// a. Set the level of the current character to the current embedding level.
// b. Whenever the directional override status is not neutral, reset the current character type to the directional override status.
if (isset ($this->unicode->uni_type[$ta[$i]])) {
$chardir = $this->unicode->uni_type[$ta[$i]];
// stores string characters and other information
$chardata[] = array('char' => $ta[$i], 'level' => $cel, 'type' => $chardir, 'sor' => $sor, 'eor' => $eor);
// X8. All explicit directional embeddings and overrides are completely terminated at the end of each paragraph. Paragraph separators are not included in the embedding.
// X9. Remove all RLE, LRE, RLO, LRO, PDF, and BN codes.
// X10. The remaining rules are applied to each run of characters at the same level. For each run, determine the start-of-level-run (sor) and end-of-level-run (eor) type, either L or R. This depends on the higher of the two levels on either side of the boundary (at the start or end of the paragraph, the level of the 'other' run is the base embedding level). If the higher level is odd, the type is R; otherwise, it is L.
// 3.3.3 Resolving Weak Types
// Weak types are now resolved one level run at a time. At level run boundaries where the type of the character on the other side of the boundary is required, the type assigned to sor or eor is used.
// Nonspacing marks are now resolved based on the previous characters.
$numchars = count($chardata);
// 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) {
if ($chardata[$i]['type'] == 'NSM') {
$chardata[$i]['type'] = $chardata[$i]['sor'];
$chardata[$i]['type'] = $chardata[($i- 1)]['type'];
if ($chardata[$i]['level'] != $prevlevel) {
$prevlevel = $chardata[$i]['level'];
// 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.
for ($i= 0; $i < $numchars; ++ $i) {
if ($chardata[$i]['char'] == 'EN') {
for ($j= $levcount; $j >= 0; $j-- ) {
if ($chardata[$j]['type'] == 'AL') {
$chardata[$i]['type'] = 'AN';
} elseif (($chardata[$j]['type'] == 'L') OR ($chardata[$j]['type'] == 'R')) {
if ($chardata[$i]['level'] != $prevlevel) {
$prevlevel = $chardata[$i]['level'];
// W3. Change all ALs to R.
for ($i= 0; $i < $numchars; ++ $i) {
if ($chardata[$i]['type'] == 'AL') {
$chardata[$i]['type'] = 'R';
// 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.
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';
} elseif (($chardata[$i]['type'] == 'CS') AND ($chardata[($i- 1)]['type'] == 'EN') AND ($chardata[($i+ 1)]['type'] == 'EN')) {
$chardata[$i]['type'] = 'EN';
} elseif (($chardata[$i]['type'] == 'CS') AND ($chardata[($i- 1)]['type'] == 'AN') AND ($chardata[($i+ 1)]['type'] == 'AN')) {
$chardata[$i]['type'] = 'AN';
if ($chardata[$i]['level'] != $prevlevel) {
$prevlevel = $chardata[$i]['level'];
// W5. A sequence of European terminators adjacent to European numbers changes to all European numbers.
for ($i= 0; $i < $numchars; ++ $i) {
if ($chardata[$i]['type'] == 'ET') {
if (($levcount > 0) AND ($chardata[($i- 1)]['type'] == 'EN')) {
$chardata[$i]['type'] = 'EN';
while (($j < $numchars) AND ($chardata[$j]['level'] == $prevlevel)) {
if ($chardata[$j]['type'] == 'EN') {
$chardata[$i]['type'] = 'EN';
} elseif ($chardata[$j]['type'] != 'ET') {
if ($chardata[$i]['level'] != $prevlevel) {
$prevlevel = $chardata[$i]['level'];
// W6. Otherwise, separators and terminators change to Other Neutral.
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) {
$prevlevel = $chardata[$i]['level'];
//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.
for ($i= 0; $i < $numchars; ++ $i) {
if ($chardata[$i]['char'] == 'EN') {
for ($j= $levcount; $j >= 0; $j-- ) {
if ($chardata[$j]['type'] == 'L') {
$chardata[$i]['type'] = 'L';
} elseif ($chardata[$j]['type'] == 'R') {
if ($chardata[$i]['level'] != $prevlevel) {
$prevlevel = $chardata[$i]['level'];
// 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.
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';
} elseif (($chardata[$i]['type'] == 'N') AND
(($chardata[($i- 1)]['type'] == 'R') OR ($chardata[($i- 1)]['type'] == 'EN') OR ($chardata[($i- 1)]['type'] == 'AN')) AND
(($chardata[($i+ 1)]['type'] == 'R') OR ($chardata[($i+ 1)]['type'] == 'EN') OR ($chardata[($i+ 1)]['type'] == 'AN'))) {
$chardata[$i]['type'] = 'R';
} elseif ($chardata[$i]['type'] == 'N') {
// N2. Any remaining neutrals take the embedding direction
$chardata[$i]['type'] = $chardata[$i]['sor'];
} elseif (($levcount == 0) AND (($i+ 1) < $numchars) AND ($chardata[($i+ 1)]['level'] == $prevlevel)) {
if (($chardata[$i]['type'] == 'N') AND ($chardata[$i]['sor'] == 'L') AND ($chardata[($i+ 1)]['type'] == 'L')) {
$chardata[$i]['type'] = 'L';
} elseif (($chardata[$i]['type'] == 'N') AND
(($chardata[$i]['sor'] == 'R') OR ($chardata[$i]['sor'] == 'EN') OR ($chardata[$i]['sor'] == 'AN')) AND
(($chardata[($i+ 1)]['type'] == 'R') OR ($chardata[($i+ 1)]['type'] == 'EN') OR ($chardata[($i+ 1)]['type'] == 'AN'))) {
$chardata[$i]['type'] = 'R';
} elseif ($chardata[$i]['type'] == 'N') {
// N2. Any remaining neutrals take the embedding direction
$chardata[$i]['type'] = $chardata[$i]['sor'];
} elseif (($levcount > 0) AND ((($i+ 1) == $numchars) OR (($i+ 1) < $numchars) AND ($chardata[($i+ 1)]['level'] != $prevlevel))) {
if (($chardata[$i]['type'] == 'N') AND ($chardata[($i- 1)]['type'] == 'L') AND ($chardata[$i]['eor'] == 'L')) {
$chardata[$i]['type'] = 'L';
} elseif (($chardata[$i]['type'] == 'N') AND
(($chardata[($i- 1)]['type'] == 'R') OR ($chardata[($i- 1)]['type'] == 'EN') OR ($chardata[($i- 1)]['type'] == 'AN')) AND
(($chardata[$i]['eor'] == 'R') OR ($chardata[$i]['eor'] == 'EN') OR ($chardata[$i]['eor'] == 'AN'))) {
$chardata[$i]['type'] = 'R';
} elseif ($chardata[$i]['type'] == 'N') {
// N2. Any remaining neutrals take the embedding direction
$chardata[$i]['type'] = $chardata[$i]['sor'];
} elseif ($chardata[$i]['type'] == 'N') {
// N2. Any remaining neutrals take the embedding direction
$chardata[$i]['type'] = $chardata[$i]['sor'];
if ($chardata[$i]['level'] != $prevlevel) {
$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) {
$odd = $chardata[$i]['level'] % 2;
if (($chardata[$i]['type'] == 'L') OR ($chardata[$i]['type'] == 'AN') OR ($chardata[$i]['type'] == 'EN')) {
$chardata[$i]['level'] += 1;
if ($chardata[$i]['type'] == 'R') {
$chardata[$i]['level'] += 1;
} elseif (($chardata[$i]['type'] == 'AN') OR ($chardata[$i]['type'] == 'EN')) {
$chardata[$i]['level'] += 2;
$maxlevel = max($chardata[$i]['level'],$maxlevel);
// L1. On each line, reset the embedding level of the following characters to the paragraph embedding level:
// 1. Segment separators,
// 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) {
if (($chardata[$i]['type'] == 'B') OR ($chardata[$i]['type'] == 'S')) {
$chardata[$i]['level'] = $pel;
} elseif ($chardata[$i]['type'] == 'WS') {
if ((($chardata[$j]['type'] == 'B') OR ($chardata[$j]['type'] == 'S')) OR
(($j == ($numchars- 1)) AND ($chardata[$j]['type'] == 'WS'))) {
$chardata[$i]['level'] = $pel;
} elseif ($chardata[$j]['type'] != 'WS') {
// Cursively connected scripts, such as Arabic or Syriac, require the selection of positional character shapes that depend on adjacent characters. Shaping is logically applied after the Bidirectional Algorithm is used and is limited to characters within the same directional run.
$endedletter = array(1569,1570,1571,1572,1573,1575,1577,1583,1584,1585,1586,1608,1688);
$alfletter = array(1570,1571,1573,1575);
for ($i= 0; $i < $numchars; ++ $i) {
if (($this->unicode->uni_type[$chardata[$i]['char']] == 'AL') OR ($chardata[$i]['char'] == 32) OR ($chardata[$i]['char'] == 8204)) {
$charAL[$x] = $chardata[$i];
for ($i= 0; $i < $numchars; ++ $i) {
$thischar = $chardata[$i];
$prevchar = $chardata[($i- 1)];
if (($i+ 1) < $numchars) {
$nextchar = $chardata[($i+ 1)];
if ($this->unicode->uni_type[$thischar['char']] == 'AL') {
$prevchar = $charAL[($x- 1)];
$nextchar = $charAL[($x+ 1)];
if (($prevchar !== false) AND ($prevchar['char'] == 1604) AND (in_array($thischar['char'], $alfletter))) {
$arabicarr = $this->unicode->uni_laa_array;
$prevchar = $charAL[($x- 2)];
$arabicarr = $this->unicode->uni_arabicsubst;
if (($prevchar !== false) AND ($nextchar !== false) AND
(($this->unicode->uni_type[$prevchar['char']] == 'AL') OR ($this->unicode->uni_type[$prevchar['char']] == 'NSM')) AND
(($this->unicode->uni_type[$nextchar['char']] == 'AL') OR ($this->unicode->uni_type[$nextchar['char']] == 'NSM')) AND
($prevchar['type'] == $thischar['type']) AND
($nextchar['type'] == $thischar['type']) AND
($nextchar['char'] != 1567)) {
if (in_array($prevchar['char'], $endedletter)) {
if (isset ($arabicarr[$thischar['char']][2])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][2];
if (isset ($arabicarr[$thischar['char']][3])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][3];
} elseif (($nextchar !== false) AND
(($this->unicode->uni_type[$nextchar['char']] == 'AL') OR ($this->unicode->uni_type[$nextchar['char']] == 'NSM')) AND
($nextchar['type'] == $thischar['type']) AND
($nextchar['char'] != 1567)) {
if (isset ($arabicarr[$chardata[$i]['char']][2])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][2];
} elseif ((($prevchar !== false) AND
(($this->unicode->uni_type[$prevchar['char']] == 'AL') OR ($this->unicode->uni_type[$prevchar['char']] == 'NSM')) AND
($prevchar['type'] == $thischar['type'])) OR
(($nextchar !== false) AND ($nextchar['char'] == 1567))) {
if (($i > 1) AND ($thischar['char'] == 1607) AND
($chardata[$i- 1]['char'] == 1604) AND
($chardata[$i- 2]['char'] == 1604)) {
// mark characters to delete with false
$chardata2[$i- 2]['char'] = false;
$chardata2[$i- 1]['char'] = false;
$chardata2[$i]['char'] = 65010;
if (($prevchar !== false) AND in_array($prevchar['char'], $endedletter)) {
if (isset ($arabicarr[$thischar['char']][0])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][0];
if (isset ($arabicarr[$thischar['char']][1])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][1];
} elseif (isset ($arabicarr[$thischar['char']][0])) {
$chardata2[$i]['char'] = $arabicarr[$thischar['char']][0];
// mark characters to delete with false
$chardata2[($charAL[($x- 1)]['i'])]['char'] = false;
} // end if AL (Arabic Letter)
* Combining characters that can occur with Arabic Shadda (0651 HEX, 1617 DEC) are replaced.
* Putting the combining mark and shadda in the same glyph allows us to avoid the two marks overlapping each other in an illegible manner.
for ($i = 0; $i < ($numchars- 1); ++ $i) {
if (($chardata2[$i]['char'] == 1617) AND (isset ($this->unicode->uni_diacritics[($chardata2[$i+ 1]['char'])]))) {
// check if the subtitution font is defined on current font
if (isset ($cw[($this->unicode->uni_diacritics[($chardata2[$i+ 1]['char'])])])) {
$chardata2[$i]['char'] = false;
$chardata2[$i+ 1]['char'] = $this->unicode->uni_diacritics[($chardata2[$i+ 1]['char'])];
// remove marked characters
foreach ($chardata2 as $key => $value) {
if ($value['char'] === false) {
$numchars = count($chardata);
// L2. From the highest level found in the text to the lowest odd level on each line, including intermediate levels not actually present in the text, reverse any contiguous sequence of characters that are at that level or higher.
for ($j= $maxlevel; $j > 0; $j-- ) {
for ($i= 0; $i < $numchars; ++ $i) {
if ($chardata[$i]['level'] >= $j) {
if (isset ($this->unicode->uni_mirror[$chardata[$i]['char']])) {
// L4. A character is depicted by a mirrored glyph if and only if (a) the resolved directionality of that character is R, and (b) the Bidi_Mirrored property value of that character is true.
$chardata[$i]['char'] = $this->unicode->uni_mirror[$chardata[$i]['char']];
$revarr[] = $chardata[$i];
$ordarray[] = $chardata[$i];
for ($i= 0; $i < $numchars; ++ $i) {
$ordarray[] = $chardata[$i]['char'];
// store char values for subsetting
$this->CurrentFont['subsetchars'][$chardata[$i]['char']] = true;
// update font subsetchars
// END OF BIDIRECTIONAL TEXT SECTION -------------------
* @param string $txt bookmark description.
* @param int $level bookmark level (minimum value is 0).
* @param float $y Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
* @param int $page target page number (leave empty for current page).
* @author Olivier Plathey, Nicola Asuni
* @since 2.1.002 (2008-02-12)
public function Bookmark($txt, $level= 0, $y=- 1, $page= '') {
$maxlevel = $lastoutline['l'] + 1;
if ($level > $maxlevel) {
$this->outlines[] = array('t' => $txt, 'l' => $level, 'y' => $y, 'p' => $page);
* Create a bookmark PDF string.
* @author Olivier Plathey, Nicola Asuni
* @since 2.1.002 (2008-02-12)
foreach ($this->outlines as $key => $row) {
$outline_p[$key] = $row['p'];
// sort outlines by page and original position
$parent = $lru[($o['l'] - 1)];
//Set parent and last pointers
$this->outlines[$i]['parent'] = $parent;
//Level increasing: set first pointer
if (($o['l'] <= $level) AND ($i > 0)) {
//Set prev and next pointers
$nltags = '/<br[\s]?\/>|<\/(blockquote|dd|dl|div|dt|h1|h2|h3|h4|h5|h6|hr|li|ol|p|pre|ul|tcpdf|table|tr|td)>/si';
// covert HTML title to string
$out .= ' /Parent '. ($n + $o['parent']). ' 0 R';
$out .= ' /Prev '. ($n + $o['prev']). ' 0 R';
$out .= ' /Next '. ($n + $o['next']). ' 0 R';
if (isset ($o['first'])) {
$out .= ' /First '. ($n + $o['first']). ' 0 R';
$out .= ' /Last '. ($n + $o['last']). ' 0 R';
$out .= ' '. sprintf('/Dest [%u 0 R /XYZ 0 %.2F null]', $this->page_obj_id[($o['p'])], ($this->pagedim[$o['p']]['h'] - ($o['y'] * $this->k)));
$this->_out('<< /Type /Outlines /First '. $n. ' 0 R /Last '. ($n + $lru[0]). ' 0 R >>'. "\n". 'endobj');
// --- JAVASCRIPT ------------------------------------------------------
* @param string $script Javascript code
* @author Johannes Güntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
* 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
* @since 4.8.000 (2009-09-07)
$this->js_objects[$this->n] = array('n' => $this->n, 'js' => $script, 'onload' => $onload);
* Create a javascript PDF string.
* @author Johannes Güntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
if (!$this->ur['enabled']) {
//$this->setUserRights();
// the following two lines are used to avoid form fields duplication after saving
// The addField method only works when releasing user rights (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';";
$out .= ' (EmbeddedJS) '. ($this->n + 1). ' 0 R';
$out .= ' (JS'. $key. ') '. $key. ' 0 R';
// default Javascript object
$out = '<< /S /JavaScript';
// additional Javascript objects
$out = $this->_getobj($key). "\n". ' << /S /JavaScript /JS '. $this->_textstring($val['js'], $key). ' >>'. "\n". 'endobj';
* Convert color to javascript color.
* @param string $color color name or #RRGGBB
* @author Denis Van Nuffelen, Nicola Asuni
* @since 2.1.002 (2008-02-12)
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);
if (!in_array($color,$aColors)) {
$this->Error('Invalid color: '. $color);
* Adds a javascript form field.
* @param string $type field type
* @param string $name field name
* @param int $x horizontal position
* @param int $y vertical position
* @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @author Denis Van Nuffelen, Nicola Asuni
* @since 2.1.002 (2008-02-12)
protected function _addfield($type, $name, $x, $y, $w, $h, $prop) {
// the followind avoid fields duplication after saving the document
$this->javascript .= "if(getField('tcpdfdocsaved').value != 'saved') {";
$this->javascript .= sprintf("f". $name. "=this.addField('%s','%s',%u,[%.2F,%.2F,%.2F,%.2F]);", $name, $type, $this->PageNo()- 1, $x* $k, ($this->h- $y)* $k+ 1, ($x+ $w)* $k, ($this->h- $y- $h)* $k+ 1). "\n";
while (list ($key, $val) = each($prop)) {
$this->javascript .= 'f'. $name. '.'. $key. '='. $val. ";\n";
// --- 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
* @since 4.8.000 (2009-09-06)
if (isset ($prop['aopt']) AND is_array($prop['aopt'])) {
// the annotation options area lready defined
$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']) {
$opt['q'] = ($this->rtl)? 2: 0;
// lineWidth: Specifies the thickness of the border when stroking the perimeter of a field's rectangle.
if (isset ($prop['lineWidth'])) {
$linewidth = intval($prop['lineWidth']);
// borderStyle: The border style for a field.
if (isset ($prop['borderStyle'])) {
switch ($prop['borderStyle']) {
$opt['border'] = array(0, 0, $linewidth, array(3, 2));
$opt['bs'] = array('w'=> $linewidth, 's'=> 'D', 'd'=> array(3, 2));
$opt['border'] = array(0, 0, $linewidth);
$opt['bs'] = array('w'=> $linewidth, 's'=> 'B');
$opt['border'] = array(0, 0, $linewidth);
$opt['bs'] = array('w'=> $linewidth, 's'=> 'I');
$opt['border'] = array(0, 0, $linewidth);
$opt['bs'] = array('w'=> $linewidth, 's'=> 'U');
$opt['border'] = array(0, 0, $linewidth);
$opt['bs'] = array('w'=> $linewidth, 's'=> 'S');
if (isset ($prop['border']) AND is_array($prop['border'])) {
$opt['border'] = $prop['border'];
if (!isset ($opt['mk'])) {
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';
case 'scaleHow.anamorphic': {
$opt['mk']['if']['s'] = 'A';
// 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';
case 'scaleWhen.never': {
$opt['mk']['if']['sw'] = 'N';
case 'scaleWhen.tooBig': {
$opt['mk']['if']['sw'] = 'B';
case 'scaleWhen.tooSmall': {
$opt['mk']['if']['sw'] = 'S';
// 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 'position.textOnly': {
case 'position.iconOnly': {
case 'position.iconTextV': {
case 'position.textIconV': {
case 'position.iconTextH': {
case 'position.textIconH': {
case 'position.overlay': {
// fillColor: Specifies the background color for a field.
if (isset ($prop['fillColor'])) {
$opt['mk']['bg'] = $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'])) {
$opt['mk']['bc'] = $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']);
// 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')) {
// required: Specifies whether a field requires a value.
if (isset ($prop['required']) AND ($prop['required'] == 'true')) {
// multiline: Controls how text is wrapped within the field.
if (isset ($prop['multiline']) AND ($prop['multiline'] == 'true')) {
// password: Specifies whether the field should display asterisks when data is entered in the field.
if (isset ($prop['password']) AND ($prop['password'] == 'true')) {
// 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')) {
// Radio: If set, the field is a set of radio buttons.
if (isset ($prop['Radio']) AND ($prop['Radio'] == 'true')) {
// Pushbutton: If set, the field is a pushbutton that does not retain a permanent value.
if (isset ($prop['Pushbutton']) AND ($prop['Pushbutton'] == 'true')) {
// 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')) {
// editable: Controls whether a combo box is editable.
if (isset ($prop['editable']) AND ($prop['editable'] == 'true')) {
// Sort: If set, the field's option items shall be sorted alphabetically.
if (isset ($prop['Sort']) AND ($prop['Sort'] == 'true')) {
// 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')) {
// multipleSelection: If true, indicates that a list box allows a multiple selection of items.
if (isset ($prop['multipleSelection']) AND ($prop['multipleSelection'] == 'true')) {
// doNotSpellCheck: If true, spell checking is not performed on this editable text field.
if (isset ($prop['doNotSpellCheck']) AND ($prop['doNotSpellCheck'] == 'true')) {
// 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')) {
// 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')) {
// 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')) {
// richText: If true, the field allows rich text formatting.
if (isset ($prop['richText']) AND ($prop['richText'] == 'true')) {
// commitOnSelChange: Controls whether a field value is committed after a selection change.
if (isset ($prop['commitOnSelChange']) AND ($prop['commitOnSelChange'] == 'true')) {
// 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')) {
// 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') {
} elseif ($prop['display'] == 'display.noPrint') {
} elseif ($prop['display'] == 'display.noView') {
// 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'])) {
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]);
$opt['opt'][$key] = $prop['value'][$key];
$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']) {
// - 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
* Set default properties for form fields.
* @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @since 4.8.000 (2009-09-06)
* Return the default properties for form fields.
* @return array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @since 4.8.000 (2009-09-06)
* @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).
* @since 4.8.000 (2009-09-07)
public function TextField($name, $w, $h, $prop= array(), $opt= array(), $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('text', $name, $x, $y, $w, $h, $prop);
// set default appearance stream
$popt['da'] = $fontstyle;
$popt['ap']['n'] = 'q BT '. $fontstyle. ' ET Q';
// remove some conflicting options
// set remaining annotation data
$opt['Subtype'] = 'Widget';
Additional annotation's parameters (check _putannotsobj() method):
$this->Annotation($x, $y, $w, $h, $name, $opt, 0);
* Creates a RadioButton field
* @param string $name field name
* @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).
* @since 4.8.000 (2009-09-07)
public function RadioButton($name, $w, $prop= array(), $opt= array(), $onvalue= 'On', $checked= false, $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('radiobutton', $name, $x, $y, $w, $w, $prop);
// set data for parent group
// save object ID to be added on Kids entry on parent object
$prop['NoToggleToOff'] = 'true';
$prop['borderStyle'] = 'inset';
// set additional default values
$popt['da'] = $fontstyle;
$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']['ca'] = '(l)';
// set remaining annotation data
$opt['Subtype'] = 'Widget';
$opt['v'] = array('/'. $onvalue);
$this->Annotation($x, $y, $w, $w, $name, $opt, 0);
* Creates a List-box field
* @param string $name field name
* @param array $values array containing the list of values.
* @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param float $x Abscissa of the upper-left corner of the rectangle
* @param float $y Ordinate of the upper-left corner of the rectangle
* @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @since 4.8.000 (2009-09-07)
public function ListBox($name, $w, $h, $values, $prop= array(), $opt= array(), $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('listbox', $name, $x, $y, $w, $h, $prop);
foreach ($values as $value) {
// set additional default values
$popt['da'] = $fontstyle;
$popt['ap']['n'] = 'q BT '. $fontstyle. ' ET Q';
// set remaining annotation data
$opt['Subtype'] = 'Widget';
$this->Annotation($x, $y, $w, $h, $name, $opt, 0);
* Creates a Combo-box field
* @param string $name field name
* @param array $values array containing the list of values.
* @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param float $x Abscissa of the upper-left corner of the rectangle
* @param float $y Ordinate of the upper-left corner of the rectangle
* @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @since 4.8.000 (2009-09-07)
public function ComboBox($name, $w, $h, $values, $prop= array(), $opt= array(), $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('combobox', $name, $x, $y, $w, $h, $prop);
foreach ($values as $value) {
// set additional default options
$popt['da'] = $fontstyle;
$popt['ap']['n'] = 'q BT '. $fontstyle. ' ET Q';
// set remaining annotation data
$opt['Subtype'] = 'Widget';
$this->Annotation($x, $y, $w, $h, $name, $opt, 0);
* Creates a CheckBox field
* @param string $name field name
* @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).
* @since 4.8.000 (2009-09-07)
public function CheckBox($name, $w, $checked= false, $prop= array(), $opt= array(), $onvalue= 'Yes', $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('checkbox', $name, $x, $y, $w, $w, $prop);
if (!isset ($prop['value'])) {
$prop['value'] = array('Yes');
$prop['borderStyle'] = 'inset';
// set additional default options
$popt['da'] = $fontstyle;
$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';
// set remaining annotation data
$opt['Subtype'] = 'Widget';
$opt['opt'] = array($onvalue);
$opt['v'] = array('/Off');
$this->Annotation($x, $y, $w, $w, $name, $opt, 0);
* @param string $name field name
* @param string $caption caption.
* @param mixed $action action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
* @param array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param array $opt annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param float $x Abscissa of the upper-left corner of the rectangle
* @param float $y Ordinate of the upper-left corner of the rectangle
* @param boolean $js if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @since 4.8.000 (2009-09-07)
public function Button($name, $w, $h, $caption, $action, $prop= array(), $opt= array(), $x= '', $y= '', $js= false) {
// check page for no-write regions and adapt page margins if necessary
$this->_addfield('button', $name, $this->x, $this->y, $w, $h, $prop);
$this->javascript .= 'f'. $name. ".highlight='push';\n";
$prop['Pushbutton'] = 'true';
$prop['highlight'] = 'push';
$prop['display'] = 'display.noPrint';
$popt['da'] = $fontstyle;
$popt['ap']['n'] = 'q BT '. $fontstyle. ' ET Q';
// set additional default options
if (!isset ($popt['mk'])) {
$ann_obj_id = ($this->n + 1);
if (!empty($action) AND !is_array($action)) {
$ann_obj_id = ($this->n + 2);
$popt['mk']['ca'] = $this->_textstring($caption, $ann_obj_id);
$popt['mk']['rc'] = $this->_textstring($caption, $ann_obj_id);
$popt['mk']['ac'] = $this->_textstring($caption, $ann_obj_id);
// set remaining annotation data
$opt['Subtype'] = 'Widget';
// form action options as on section 12.7.5 of PDF32000_2008.
$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, $ann_obj_id);
} elseif (($key == 'Fields') AND is_array($val) AND !empty($val)) {
$opt['aa'] .= ' /Fields [';
foreach ($val AS $field) {
$opt['aa'] .= ' '. $this->_textstring($field, $ann_obj_id);
} elseif (($key == 'Flags')) {
foreach ($val AS $flag) {
case 'Include/Exclude': {
case 'IncludeNoValueFields': {
case 'SubmitCoordinates': {
case 'IncludeAppendSaves': {
case 'IncludeAnnotations': {
case 'CanonicalFormat': {
case 'ExclNonUserAnnots': {
$opt['aa'] .= ' /Flags '. $ff;
// Javascript action or raw action command
$opt['aa'] = '/D '. $js_obj_id. ' 0 R';
$this->Annotation($x, $y, $w, $h, $name, $opt, 0);
// --- END FORMS FIELDS ------------------------------------------------
* Add certification signature (DocMDP or UR3)
* You can set only one signature type
* @since 4.6.008 (2009-05-07)
$out .= ' /Filter /Adobe.PPKLite';
$out .= ' /SubFilter /adbe.pkcs7.detached';
$out .= ' /Reference ['; // array of signature reference dictionaries
$out .= ' << /Type /SigRef';
$out .= ' /TransformMethod /DocMDP';
$out .= ' /TransformParams <<';
$out .= ' /Type /TransformParams';
$out .= ' /TransformMethod /UR3';
$out .= ' /TransformParams <<';
$out .= ' /Type /TransformParams';
$out .= ' /Document['. $this->ur['document']. ']';
$out .= ' /Form['. $this->ur['form']. ']';
$out .= ' /Signature['. $this->ur['signature']. ']';
$out .= ' /Annots['. $this->ur['annots']. ']';
$out .= ' /EF['. $this->ur['ef']. ']';
$out .= ' /FormEX['. $this->ur['formex']. ']';
$out .= ' >>'; // close TransformParams
// optional digest data (values must be calculated and replaced later)
//$out .= ' /Data ********** 0 R';
//$out .= ' /DigestMethod/MD5';
//$out .= ' /DigestLocation[********** 34]';
//$out .= ' /DigestValue<********************************>';
$out .= ' ]'; // end of reference
* Set User's Rights for PDF Reader
* WARNING: This is experimental and currently do not work.
* Check the PDF Reference 8.7.1 Transform Methods,
* Table 8.105 Entries in the UR transform parameters dictionary
* @param boolean $enable if true enable user's rights on PDF reader
* @param string $document Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.
* @param string $annots Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.
* @param string $form Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate
* @param string $signature Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.
* @param string $ef Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files
Names specifying additional embedded-files-related usage rights for the document.
* @param string $formex Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.
* @since 2.9.000 (2008-03-26)
$annots= '/Create/Delete/Modify/Copy/Import/Export',
$form= '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate',
$ef= '/Create/Delete/Modify/Import',
$this->ur['enabled'] = $enable;
$this->ur['document'] = $document;
$this->ur['annots'] = $annots;
$this->ur['form'] = $form;
$this->ur['signature'] = $signature;
$this->ur['formex'] = $formex;
* Enable document signature (requires the OpenSSL Library).
* The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader.
* To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
* To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
* To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
* @param mixed $signing_cert signing certificate (string or filename prefixed with 'file://')
* @param mixed $private_key private key (string or filename prefixed with 'file://')
* @param string $private_key_password password
* @param string $extracerts specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.
* @param int $cert_type The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
* @param array $info array of option information: Name, Location, Reason, ContactInfo.
* @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 export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
// to convert pfx certificate to pem: openssl
// OpenSSL> pkcs12 -in <cert.pfx> -out <cert.crt> -nodes
++ $this->n; // signature object ($this->sig_obj_id + 1)
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;
* Set the digital signature appearance (a cliccable rectangle area to get signature properties)
* @param float $x Abscissa of the upper-left corner.
* @param float $y Ordinate of the upper-left corner.
* @param float $w Width of the signature area.
* @param float $h Height of the signature area.
* @param int $page option page number (if < 0 the current page is used).
* @since 5.3.011 (2010-06-17)
if (($page < 1) OR ($page > $this->numpages)) {
* Create a new page group.
* NOTE: call this function before calling AddPage()
* @param int $page starting group page (leave empty for next page).
* @since 3.0.000 (2008-03-27)
* Defines an alias for the total number of pages.
* It will be substituted as the document is closed.
* @param string $alias The alias.
* @see getAliasNbPages(), PageNo(), Footer()
* 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.
* @since 4.0.018 (2008-08-08)
* @see AliasNbPages(), PageNo(), Footer()
* Defines an alias for the page number.
* It will be substituted as the document is closed.
* @param string $alias The alias.
* @since 4.5.000 (2009-01-02)
* @see getAliasNbPages(), PageNo(), Footer()
//Define an alias for total number of pages
* 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.
* @since 4.5.000 (2009-01-02)
* @see AliasNbPages(), PageNo(), Footer()
* Return the current page in the group.
* @return current page in the group
* @since 3.0.000 (2008-03-27)
* Returns the current group page number formatted as a string.
* @since 4.3.003 (2008-11-18)
* @see PaneNo(), formatPageNumber()
* 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).
* @return alias of the current page group
* @since 3.0.000 (2008-03-27)
* 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
* @since 4.5.000 (2009-01-02)
* Format the page numbers.
* This method can be overriden for custom formats.
* @param int $num page number
* @since 4.2.005 (2008-11-06)
* Format the page numbers on the Table Of Content.
* This method can be overriden for custom formats.
* @param int $num page number
* @since 4.5.001 (2009-01-04)
* @see addTOC(), addHTMLTOC()
* Returns the current page number formatted as a string.
* @since 4.2.005 (2008-11-06)
* @see PaneNo(), formatPageNumber()
* Put visibility settings.
* @since 3.0.000 (2008-03-27)
$this->_out('<< /Type /OCG /Name '. $this->_textstring('print', $this->n_ocg_print). ' /Usage << /Print <</PrintState /ON>> /View <</ViewState /OFF>> >> >>'. "\n". 'endobj');
$this->_out('<< /Type /OCG /Name '. $this->_textstring('view', $this->n_ocg_view). ' /Usage << /Print <</PrintState /OFF>> /View <</ViewState /ON>> >> >>'. "\n". 'endobj');
* Set the visibility of the successive elements.
* This can be useful, for instance, to put a background
* image or color that will show on screen but won't print.
* @param string $v visibility mode. Legal values are: all, print, screen.
* @since 3.0.000 (2008-03-27)
// close existing open marked-content
$this->_out('/OC /OC1 BDC');
$this->_out('/OC /OC2 BDC');
$this->Error('Incorrect visibility: '. $v);
* Add transparency parameters to the current extgstate
* @param array $params parameters
* @return the number of extgstates
* @since 3.0.000 (2008-03-27)
// check if this ExtGState already exist
for ($i = 1; $i < $n; ++ $i) {
// return reference to existing ExtGState
* @param array $gs extgstate
* @since 3.0.000 (2008-03-27)
* Put extgstates for object transparency
* @param array $gs extgstate
* @since 3.0.000 (2008-03-27)
for ($i = 1; $i <= $ne; ++ $i) {
$out = '<< /Type /ExtGState';
foreach ($this->extgstates[$i]['parms'] as $k => $v) {
* Set alpha for stroking (CA) and non-stroking (ca) operations.
* @param float $alpha real value from 0 (transparent) to 1 (opaque)
* @param string $bm blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity
* @since 3.0.000 (2008-03-27)
public function setAlpha($alpha, $bm= 'Normal') {
$gs = $this->addExtGState(array('ca' => $alpha, 'CA' => $alpha, 'BM' => '/'. $bm, 'AIS' => 'false'));
* Set the default JPEG compression quality (1-100)
* @param int $quality JPEG quality, integer between 1 and 100
* @since 3.0.000 (2008-03-27)
if (($quality < 1) OR ($quality > 100)) {
* Set the default number of columns in a row for HTML tables.
* @param int $cols number of columns
* @since 3.0.014 (2008-06-04)
* Set the height of the cell (line height) respect the font height.
* @param int $h cell proportion respect font height (typical value = 1.25).
* @since 3.0.014 (2008-06-04)
* return the height of cell repect font height.
* @since 4.0.012 (2008-07-24)
* Set the PDF version (check PDF reference for valid values).
* @since 3.1.000 (2008-06-09)
* 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").
* <ul><li>HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.</li><li>HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.</li><li>HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.</li><li>FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.</li><li>CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.</li><li>DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.</li><li>NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>UseOC Optional content group panel visible</li></ul>This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone.</li><li>ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are: <ul><li>None, which indicates that the print dialog should reflect no page scaling</li><li>AppDefault (default), which indicates that applications should use the current print scaling</li></ul></li><li>Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:<ul><li>Simplex - Print single-sided</li><li>DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet</li><li>DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet</li></ul>Default value: none</li><li>PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.</li><li>PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application</li><li>NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1</li></ul>
* @param array $preferences array of options.
* @since 3.1.000 (2008-06-09)
* Paints color transition registration bars
* @param float $x abscissa of the top left corner of the rectangle.
* @param float $y ordinate of the top left corner of the rectangle.
* @param float $w width of the rectangle.
* @param float $h height of the rectangle.
* @param boolean $transition if true prints tcolor transitions to white.
* @param boolean $vertical if true prints bar vertically.
* @param string $colors colors to print, one letter per color separated by comma (for example 'A,W,R,G,B,C,M,Y,K'): A=black, W=white, R=red, G=green, B=blue, C=cyan, M=magenta, Y=yellow, K=black.
* @since 4.9.000 (2010-03-26)
public function colorRegistrationBar($x, $y, $w, $h, $transition= true, $vertical= false, $colors= 'A,R,G,B,C,M,Y,K') {
$numbars = count($bars); // number of bars to print
$coords = array(0, 0, 0, 1);
$wb = $w / $numbars; // bar width
$coords = array(1, 0, 0, 0);
$hb = $h / $numbars; // bar height
foreach ($bars as $col) {
$col_a = array(255,255,255);
$col_a = array(255,255,255);
$col_a = array(255,255,255);
$col_b = array(100,0,0,0);
$col_b = array(0,100,0,0);
$col_b = array(0,0,100,0);
$col_b = array(0,0,0,100);
$this->Rect($xb, $yb, $wb, $hb, 'F', array());
* @param float $x abscissa of the crop mark center.
* @param float $y ordinate of the crop mark center.
* @param float $w width of the crop mark.
* @param float $h height of the crop mark.
* @param string $type type of crop mark, one sybol per type separated by comma: A = top left, B = top right, C = bottom left, D = bottom right.
* @param array $color crop mark color (default black).
* @since 4.9.000 (2010-03-26)
public function cropMark($x, $y, $w, $h, $type= 'A,B,C,D', $color= array(0,0,0)) {
$this->SetLineStyle(array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $color));
$numcrops = count($crops); // number of crop marks to print
$dw = $w / 4; // horizontal space to leave before the intersection point
$dh = $h / 4; // vertical space to leave before the intersection point
foreach ($crops as $crop) {
$this->Line($x1, $y1, $x2, $y2);
$this->Line($x3, $y3, $x4, $y4);
* Paints a registration mark
* @param float $x abscissa of the registration mark center.
* @param float $y ordinate of the registration mark center.
* @param float $r radius of the crop mark.
* @param boolean $double if true print two concentric crop marks.
* @param array $cola crop mark color (default black).
* @param array $colb second crop mark color.
* @since 4.9.000 (2010-03-26)
public function registrationMark($x, $y, $r, $double= false, $cola= array(0,0,0), $colb= array(255,255,255)) {
$line_style = array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $cola);
$this->Circle($x, $y, $r, 0, 360, 'C', $line_style, array(), 8);
$this->PieSector($x, $y, $r2, 270, 360, 'F');
$this->PieSector($x, $y, $r2, 180, 270, 'F');
$this->Circle($x, $y, $r2, 0, 360, 'C', $line_style, array(), 8);
* Paints a linear colour gradient.
* @param float $x abscissa of the top left corner of the rectangle.
* @param float $y ordinate of the top left corner of the rectangle.
* @param float $w width of the rectangle.
* @param float $h height of the rectangle.
* @param array $col1 first color (Grayscale, RGB or CMYK components).
* @param array $col2 second color (Grayscale, RGB or CMYK components).
* @param array $coords array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function LinearGradient($x, $y, $w, $h, $col1= array(), $col2= array(), $coords= array(0,0,1,0)) {
$this->Clip($x, $y, $w, $h);
$this->Gradient(2, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
* Paints a radial colour gradient.
* @param float $x abscissa of the top left corner of the rectangle.
* @param float $y ordinate of the top left corner of the rectangle.
* @param float $w width of the rectangle.
* @param float $h height of the rectangle.
* @param array $col1 first color (Grayscale, RGB or CMYK components).
* @param array $col2 second color (Grayscale, RGB or CMYK components).
* @param array $coords array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function RadialGradient($x, $y, $w, $h, $col1= array(), $col2= array(), $coords= array(0.5,0.5,0.5,0.5,1)) {
$this->Clip($x, $y, $w, $h);
$this->Gradient(3, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
* Paints a coons patch mesh.
* @param float $x abscissa of the top left corner of the rectangle.
* @param float $y ordinate of the top left corner of the rectangle.
* @param float $w width of the rectangle.
* @param float $h height of the rectangle.
* @param array $col1 first color (lower left corner) (RGB components).
* @param array $col2 second color (lower right corner) (RGB components).
* @param array $col3 third color (upper right corner) (RGB components).
* @param array $col4 fourth color (upper left corner) (RGB components).
* @param array $coords <ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul>
* @param array $coords_min minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
* @param array $coords_max maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
* @param boolean $antialias A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function CoonsPatchMesh($x, $y, $w, $h, $col1= array(), $col2= array(), $col3= array(), $col4= array(), $coords= array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33), $coords_min= 0, $coords_max= 1, $antialias= false) {
$this->Clip($x, $y, $w, $h);
$this->gradients[$n]['type'] = 6; //coons patch mesh
$this->gradients[$n]['antialias'] = $antialias;
$this->gradients[$n]['transparency'] = false;
//check the coords array if it is the simple array or the multi patch array
if (!isset ($coords[0]['f'])) {
//simple array -> convert to multi patch array
$col1[1] = $col1[2] = $col1[0];
$col2[1] = $col2[2] = $col2[0];
$col3[1] = $col3[2] = $col3[0];
$col4[1] = $col4[2] = $col4[0];
$patch_array[0]['f'] = 0;
$patch_array[0]['points'] = $coords;
$patch_array[0]['colors'][0]['r'] = $col1[0];
$patch_array[0]['colors'][0]['g'] = $col1[1];
$patch_array[0]['colors'][0]['b'] = $col1[2];
$patch_array[0]['colors'][1]['r'] = $col2[0];
$patch_array[0]['colors'][1]['g'] = $col2[1];
$patch_array[0]['colors'][1]['b'] = $col2[2];
$patch_array[0]['colors'][2]['r'] = $col3[0];
$patch_array[0]['colors'][2]['g'] = $col3[1];
$patch_array[0]['colors'][2]['b'] = $col3[2];
$patch_array[0]['colors'][3]['r'] = $col4[0];
$patch_array[0]['colors'][3]['g'] = $col4[1];
$patch_array[0]['colors'][3]['b'] = $col4[2];
$bpcd = 65535; //16 bits per coordinate
$count_patch = count($patch_array);
for ($i= 0; $i < $count_patch; ++ $i) {
$this->gradients[$n]['stream'] .= chr($patch_array[$i]['f']); //start with the edge flag as 8 bit
$count_points = count($patch_array[$i]['points']);
for ($j= 0; $j < $count_points; ++ $j) {
$patch_array[$i]['points'][$j] = (($patch_array[$i]['points'][$j] - $coords_min) / ($coords_max - $coords_min)) * $bpcd;
if ($patch_array[$i]['points'][$j] < 0) {
$patch_array[$i]['points'][$j] = 0;
if ($patch_array[$i]['points'][$j] > $bpcd) {
$patch_array[$i]['points'][$j] = $bpcd;
$count_cols = count($patch_array[$i]['colors']);
for ($j= 0; $j < $count_cols; ++ $j) {
//each color component as 8 bit
$this->gradients[$n]['stream'] .= chr($patch_array[$i]['colors'][$j]['r']);
$this->gradients[$n]['stream'] .= chr($patch_array[$i]['colors'][$j]['g']);
$this->gradients[$n]['stream'] .= chr($patch_array[$i]['colors'][$j]['b']);
$this->_out('/Sh'. $n. ' sh');
//restore previous Graphic State
* Set a rectangular clipping area.
* @param float $x abscissa of the top left corner of the rectangle (or top right corner for RTL mode).
* @param float $y ordinate of the top left corner of the rectangle.
* @param float $w width of the rectangle.
* @param float $h height of the rectangle.
* @author Andreas Würmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
protected function Clip($x, $y, $w, $h) {
//save current Graphic State
$s .= sprintf(' %.2F %.2F %.2F %.2F re W n', $x* $this->k, ($this->h- $y)* $this->k, $w* $this->k, - $h* $this->k);
//set up transformation matrix for gradient
$s .= sprintf(' %.3F 0 0 %.3F %.3F %.3F cm', $w* $this->k, $h* $this->k, $x* $this->k, ($this->h- ($y+ $h))* $this->k);
* @param int $type type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
* @param array $coords array of coordinates.
* @param array $stops array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
* @param array $background An array of colour components appropriate to the colour space, specifying a single background colour value.
* @param boolean $antialias A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @since 3.1.000 (2008-06-09)
public function Gradient($type, $coords, $stops, $background= array(), $antialias= false) {
$this->gradients[$n]['antialias'] = $antialias;
$this->gradients[$n]['transparency'] = false;
$numcolspace = count($stops[0]['color']);
$this->gradients[$n]['colspace'] = 'DeviceCMYK';
if (!empty($background)) {
$this->gradients[$n]['background'] = sprintf('%.3F %.3F %.3F %.3F', $bcolor[0]/ 100, $bcolor[1]/ 100, $bcolor[2]/ 100, $bcolor[3]/ 100);
$this->gradients[$n]['colspace'] = 'DeviceRGB';
if (!empty($background)) {
$this->gradients[$n]['background'] = sprintf('%.3F %.3F %.3F', $bcolor[0]/ 255, $bcolor[1]/ 255, $bcolor[2]/ 255);
$this->gradients[$n]['colspace'] = 'DeviceGray';
if (!empty($background)) {
$num_stops = count($stops);
$last_stop_id = $num_stops - 1;
foreach ($stops as $key => $stop) {
$this->gradients[$n]['colors'][$key] = array();
// offset represents a location along the gradient vector
if (isset ($stop['offset'])) {
$this->gradients[$n]['colors'][$key]['offset'] = $stop['offset'];
$this->gradients[$n]['colors'][$key]['offset'] = 0;
} elseif ($key == $last_stop_id) {
$this->gradients[$n]['colors'][$key]['offset'] = 1;
$offsetstep = (1 - $this->gradients[$n]['colors'][($key - 1)]['offset']) / ($num_stops - $key);
$this->gradients[$n]['colors'][$key]['offset'] = $this->gradients[$n]['colors'][($key - 1)]['offset'] + $offsetstep;
if (isset ($stop['opacity'])) {
$this->gradients[$n]['colors'][$key]['opacity'] = $stop['opacity'];
if ($stop['opacity'] < 1) {
$this->gradients[$n]['colors'][$key]['opacity'] = 1;
// exponent for the exponential interpolation function
if (isset ($stop['exponent'])) {
$this->gradients[$n]['colors'][$key]['exponent'] = $stop['exponent'];
$this->gradients[$n]['colors'][$key]['exponent'] = 1;
$this->gradients[$n]['colors'][$key]['color'] = sprintf('%.3F %.3F %.3F %.3F', $color[0]/ 100, $color[1]/ 100, $color[2]/ 100, $color[3]/ 100);
$this->gradients[$n]['colors'][$key]['color'] = sprintf('%.3F %.3F %.3F', $color[0]/ 255, $color[1]/ 255, $color[2]/ 255);
// paint luminosity gradient
$this->_out('/TGS'. $n. ' gs');
$this->_out('/Sh'. $n. ' sh');
//restore previous Graphic State
* Output gradient shaders.
* @since 3.1.000 (2008-06-09)
if (($grad['type'] == 2) OR ($grad['type'] == 3)) {
$out .= ' /FunctionType 3';
$out .= ' /Domain [0 1]';
$num_cols = count($grad['colors']);
$lastcols = $num_cols - 1;
for ($i = 1; $i < $num_cols; ++ $i) {
$functions .= ($fc + $i). ' 0 R ';
$bounds .= sprintf('%.3F ', $grad['colors'][$i]['offset']);
$out .= ' /Functions ['. trim($functions). ']';
$out .= ' /Bounds ['. trim($bounds). ']';
$out .= ' /Encode ['. trim($encode). ']';
for ($i = 1; $i < $num_cols; ++ $i) {
$out .= ' /FunctionType 2';
$out .= ' /Domain [0 1]';
$out .= ' /C0 ['. $grad['colors'][($i - 1)]['color']. ']';
$out .= ' /C1 ['. $grad['colors'][$i]['color']. ']';
$out .= ' /N '. $grad['colors'][$i]['exponent'];
// set transparency fuctions
if ($grad['transparency']) {
$out .= ' /FunctionType 3';
$out .= ' /Domain [0 1]';
$num_cols = count($grad['colors']);
for ($i = 1; $i < $num_cols; ++ $i) {
$functions .= ($ft + $i). ' 0 R ';
$out .= ' /Functions ['. trim($functions). ']';
$out .= ' /Bounds ['. trim($bounds). ']';
$out .= ' /Encode ['. trim($encode). ']';
for ($i = 1; $i < $num_cols; ++ $i) {
$out .= ' /FunctionType 2';
$out .= ' /Domain [0 1]';
$out .= ' /C0 ['. $grad['colors'][($i - 1)]['opacity']. ']';
$out .= ' /C1 ['. $grad['colors'][$i]['opacity']. ']';
$out .= ' /N '. $grad['colors'][$i]['exponent'];
$out = '<< /ShadingType '. $grad['type'];
if (isset ($grad['colspace'])) {
$out .= ' /ColorSpace /'. $grad['colspace'];
$out .= ' /ColorSpace /DeviceRGB';
if (isset ($grad['background']) AND !empty($grad['background'])) {
$out .= ' /Background ['. $grad['background']. ']';
if (isset ($grad['antialias']) AND ($grad['antialias'] === true)) {
$out .= ' /AntiAlias true';
if ($grad['type'] == 2) {
$out .= ' '. sprintf('/Coords [%.3F %.3F %.3F %.3F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3]);
$out .= ' /Domain [0 1]';
$out .= ' /Function '. $fc. ' 0 R';
$out .= ' /Extend [true true]';
} elseif ($grad['type'] == 3) {
//at this this time radius of inner circle is 0
$out .= ' '. sprintf('/Coords [%.3F %.3F 0 %.3F %.3F %.3F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3], $grad['coords'][4]);
$out .= ' /Domain [0 1]';
$out .= ' /Function '. $fc. ' 0 R';
$out .= ' /Extend [true true]';
} elseif ($grad['type'] == 6) {
$out .= ' /BitsPerCoordinate 16';
$out .= ' /BitsPerComponent 8';
$out .= ' /Decode[0 1 0 1 0 1 0 1 0 1]';
$out .= ' /BitsPerFlag 8';
$out .= ' /Length '. strlen($stream);
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
if ($grad['transparency']) {
$shading_transparency = preg_replace('/\/ColorSpace \/[^\s]+/si', '/ColorSpace /DeviceGray', $out);
$shading_transparency = preg_replace('/\/Function [0-9]+ /si', '/Function '. $ft. ' ', $shading_transparency);
$out = '<< /Type /Pattern /PatternType 2';
$out .= ' /Shading '. $this->gradients[$id]['id']. ' 0 R';
// set shading and pattern for transparency mask
if ($grad['transparency']) {
$this->_out($shading_transparency);
$out = '<< /Type /Pattern /PatternType 2';
$out .= ' /Shading '. $this->gradients[$idgs]['id']. ' 0 R';
$this->xobjects['LX'. $oid] = array('n' => $oid);
$stream = 'q /a0 gs /Pattern cs /p'. $idgs. ' scn 0 0 '. $this->wPt. ' '. $this->hPt. ' re f Q';
$filter = ' /Filter /FlateDecode';
$out = '<< /Type /XObject /Subtype /Form /FormType 1'. $filter;
$out .= ' /Length '. strlen($stream);
$out .= ' /BBox [0 0 '. $rect. ']';
$out .= ' /Group << /Type /Group /S /Transparency /CS /DeviceGray >>';
$out .= ' /Resources <<';
$out .= ' /ExtGState << /a0 << /ca 1 /CA 1 >> >>';
$out .= ' /Pattern << /p'. $idgs. ' '. $this->gradients[$idgs]['pattern']. ' 0 R >>';
$out .= ' stream'. "\n". $stream. "\n". 'endstream';
$out = '<< /Type /Mask /S /Luminosity /G '. ($this->n - 1). ' 0 R >>'. "\n". 'endobj';
$out = '<< /Type /ExtGState /SMask '. ($this->n - 1). ' 0 R /AIS false >>'. "\n". 'endobj';
$this->extgstates[] = array('n' => $this->n, 'name' => 'TGS'. $id);
* Draw the sector of a circle.
* It can be used for instance to render pie charts.
* @param float $xc abscissa of the center.
* @param float $yc ordinate of the center.
* @param float $r radius.
* @param float $a start angle (in degrees).
* @param float $b end angle (in degrees).
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param float $cw: indicates whether to go clockwise (default: true).
* @param float $o: origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function PieSector($xc, $yc, $r, $a, $b, $style= 'FD', $cw= true, $o= 90) {
$this->PieSectorXY($xc, $yc, $r, $r, $a, $b, $style, $cw, $o);
* Draw the sector of an ellipse.
* It can be used for instance to render pie charts.
* @param float $xc abscissa of the center.
* @param float $yc ordinate of the center.
* @param float $rx the x-axis radius.
* @param float $ry the y-axis radius.
* @param float $a start angle (in degrees).
* @param float $b end angle (in degrees).
* @param string $style Style of rendering. See the getPathPaintOperator() function for more information.
* @param float $cw: indicates whether to go clockwise.
* @param float $o: origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).
* @param integer $nc Number of curves used to draw a 90 degrees portion of arc.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style= 'FD', $cw= false, $o= 0, $nc= 2) {
* Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
* NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
* Only vector drawing is supported, not text or bitmap.
* Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
* @param string $file Name of the file containing the image.
* @param float $x Abscissa of the upper-left corner.
* @param float $y Ordinate of the upper-left corner.
* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param mixed $link URL or identifier returned by AddLink().
* @param boolean useBoundingBox specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param string $palign Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param boolean $fitonpage if true the image is resized to not exceed page dimensions.
* @author Valentin Schmidt, Nicola Asuni
* @since 3.1.000 (2008-06-09)
public function ImageEps($file, $x= '', $y= '', $w= 0, $h= 0, $link= '', $useBoundingBox= true, $align= '', $palign= '', $border= 0, $fitonpage= false) {
// convert EPS to raster image using GD or ImageMagick libraries
return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
// check page for no-write regions and adapt page margins if necessary
$this->Error('EPS file not found: '. $file);
// EPS/AI compatibility check (only checks files created by Adobe Illustrator!)
preg_match("/%%Creator:([^\r\n]+)/", $data, $regs); # find Creator
$version_str = trim($regs[1]); # e.g. "Adobe Illustrator(R) 8.0"
if (strpos($version_str, 'Adobe Illustrator') !== false) {
$versexp = explode(' ', $version_str);
$this->Error('This version of Adobe Illustrator file is not supported: '. $file);
// strip binary bytes in front of PS-header
$start = strpos($data, '%!PS-Adobe');
$data = substr($data, $start);
// find BoundingBox params
preg_match("/%%BoundingBox:([^\r\n]+)/", $data, $regs);
list ($x1, $y1, $x2, $y2) = explode(' ', trim($regs[1]));
$this->Error('No BoundingBox found in EPS file: '. $file);
$start = strpos($data, '%%EndSetup');
$start = strpos($data, '%%EndProlog');
$start = strpos($data, '%%BoundingBox');
$data = substr($data, $start);
$end = strpos($data, '%%PageTrailer');
$end = strpos($data, 'showpage');
$data = substr($data, 0, $end);
// calculate image width and height on document
if (($w <= 0) AND ($h <= 0)) {
$w = ($x2- $x1) / $k * ($h / (($y2 - $y1) / $k));
$h = ($y2 - $y1) / $k * ($w / (($x2 - $x1) / $k));
// fit the image on available space
$this->fitBlock($w, $h, $x, $y, $fitonpage);
// convert EPS to raster image using GD or ImageMagick libraries
return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
$scale_x = $w / (($x2 - $x1) / $k);
$scale_y = $h / (($y2 - $y1) / $k);
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
// save the current graphic state
$this->_out(sprintf('%.3F %.3F %.3F %.3F %.3F %.3F cm', 1, 0, 0, 1, $dx, $dy + ($this->hPt - (2 * $y * $k) - ($y2 - $y1))));
$this->_out(sprintf('%.3F %.3F %.3F %.3F %.3F %.3F cm', $scale_x, 0, 0, $scale_y, $x1 * (1 - $scale_x), $y2 * (1 - $scale_y)));
// handle pc/unix/mac line endings
for ($i= 0; $i < $cnt; ++ $i) {
if (($line == '') OR ($line{0} == '%')) {
if (($cmd == 'Xa') OR ($cmd == 'XA')) {
$this->_out(''. $r. ' '. $g. ' '. $b. ' '. ($cmd== 'Xa'? 'rg': 'RG')); //substr($line, 0, -2).'rg' -> in EPS (AI8): c m y k r g b rg!
case 'x': {// custom fill color
list ($c,$m,$y,$k) = $chunks;
$this->_out(''. $c. ' '. $m. ' '. $y. ' '. $k. ' k');
case 'X': { // custom stroke color
list ($c,$m,$y,$k) = $chunks;
$this->_out(''. $c. ' '. $m. ' '. $y. ' '. $k. ' K');
for ($j= $i+ 1; $j < $max; ++ $j) {
$isU = ($isU OR (($lines[$j] == 'U') OR ($lines[$j] == '*U')));
// restore previous graphic state
$this->Cell($w, $h, '', $border, 0, '', 0, '', 0, true);
$this->Link($ximg, $y, $w, $h, $link, 0);
// set pointer to align the next text/objects
* @param string $bc barcode
* @since 4.0.012 (2008-07-24)
* Print a Linear Barcode.
* @param string $code code to print
* @param string $type type of barcode (see barcodes.php for supported formats).
* @param int $x x position in user units (empty string = current x position)
* @param int $y y position in user units (empty string = current y position)
* @param int $w width in user units (empty string = remaining page width)
* @param int $h height in user units (empty string = remaining page height)
* @param float $xres width of the smallest bar in user units (empty string = default value = 0.4mm)
* @param array $style array of options:<ul>
* <li>boolean $style['border'] if true prints a border</li>
* <li>int $style['padding'] padding to leave around the barcode in user units (set to 'auto' for automatic padding)</li>
* <li>int $style['hpadding'] horizontal padding in user units (set to 'auto' for automatic padding)</li>
* <li>int $style['vpadding'] vertical padding in user units (set to 'auto' for automatic padding)</li>
* <li>array $style['fgcolor'] color array for bars and text</li>
* <li>mixed $style['bgcolor'] color array for background (set to false for transparent)</li>
* <li>boolean $style['text'] if true prints text below the barcode</li>
* <li>string $style['label'] override default label</li>
* <li>string $style['font'] font name for text</li><li>int $style['fontsize'] font size for text</li>
* <li>int $style['stretchtext']: 0 = disabled; 1 = horizontal scaling only if necessary; 2 = forced horizontal scaling; 3 = character spacing only if necessary; 4 = forced character spacing.</li>
* <li>string $style['position'] horizontal position of the containing barcode cell on the page: L = left margin; C = center; R = right margin.</li>
* <li>string $style['align'] horizontal position of the barcode on the containing rectangle: L = left; C = center; R = right.</li>
* <li>string $style['stretch'] if true stretch the barcode to best fit the available width, otherwise uses $xres resolution for a single bar.</li>
* <li>string $style['fitwidth'] if true reduce the width to fit the barcode width + padding. When this option is enabled the 'stretch' option is automatically disabled.</li>
* <li>string $style['cellfitalign'] this option works only when 'fitwidth' is true and 'position' is unset or empty. Set the horizontal position of the containing barcode cell inside the specified rectangle: L = left; C = center; R = right.</li></ul>
* @param string $align Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @since 3.1.000 (2008-06-09)
public function write1DBarcode($code, $type, $x= '', $y= '', $w= '', $h= '', $xres= '', $style= '', $align= '') {
require_once(dirname(__FILE__ ). '/barcodes.php');
// save current graphic settings
// create new barcode object
$arrcode = $barcodeobj->getBarcodeArray();
if ($arrcode === false) {
$this->Error('Error in 1D barcode string');
if (!isset ($style['position'])) {
} elseif ($style['position'] == 'S') {
// keep this for backward compatibility
$style['stretch'] = true;
if (!isset ($style['fitwidth'])) {
if (!isset ($style['stretch'])) {
$style['fitwidth'] = true;
$style['fitwidth'] = false;
if ($style['fitwidth']) {
$style['stretch'] = false;
if (!isset ($style['stretch'])) {
if (($w === '') OR ($w <= 0)) {
$style['stretch'] = false;
$style['stretch'] = true;
if (!isset ($style['fgcolor'])) {
$style['fgcolor'] = array(0,0,0); // default black
if (!isset ($style['bgcolor'])) {
$style['bgcolor'] = false; // default transparent
if (!isset ($style['border'])) {
$style['border'] = false;
if (!isset ($style['text'])) {
if ($style['text'] AND isset ($style['font'])) {
if (isset ($style['fontsize'])) {
$fontsize = $style['fontsize'];
$this->SetFont($style['font'], '', $fontsize);
if (!isset ($style['stretchtext'])) {
$style['stretchtext'] = 4;
// check page for no-write regions and adapt page margins if necessary
if (($w === '') OR ($w <= 0)) {
if (!isset ($style['padding'])) {
} elseif ($style['padding'] === 'auto') {
$padding = 10 * ($w / ($arrcode['maxw'] + 20));
if (!isset ($style['hpadding'])) {
} elseif ($style['hpadding'] === 'auto') {
$hpadding = 10 * ($w / ($arrcode['maxw'] + 20));
$hpadding = floatval($style['hpadding']);
if (!isset ($style['vpadding'])) {
} elseif ($style['vpadding'] === 'auto') {
$vpadding = ($hpadding / 2);
$vpadding = floatval($style['vpadding']);
// calculate xres (single bar width)
$max_xres = ($w - (2 * $hpadding)) / $arrcode['maxw'];
$xres = (0.141 * $this->k); // default bar width = 0.4 mm
// correct xres to fit on $w
if ((isset ($style['padding']) AND ($style['padding'] === 'auto'))
OR (isset ($style['hpadding']) AND ($style['hpadding'] === 'auto'))) {
if (isset ($style['vpadding']) AND ($style['vpadding'] === 'auto')) {
$vpadding = ($hpadding / 2);
if ($style['fitwidth']) {
$w = (($arrcode['maxw'] * $xres) + (2 * $hpadding));
if (isset ($style['cellfitalign'])) {
switch ($style['cellfitalign']) {
$x -= (($wold - $w) / 2);
$x += (($wold - $w) / 2);
if (($h === '') OR ($h <= 0)) {
$h = (($arrcode['maxw'] * $xres) / 3) + (2 * $vpadding) + $text_height;
$barh = $h - $text_height - (2 * $vpadding);
// try to reduce font or padding to fit barcode on available height
$this->SetFont($style['font'], '', $fontsize);
$vpadding = (($h - $text_height) / 4);
$barh = $h - $text_height - (2 * $vpadding);
// fit the barcode on available space
if ($style['position'] == 'L') {
} elseif ($style['position'] == 'C') {
} elseif ($style['position'] == 'R') {
if ($style['position'] == 'L') {
} elseif ($style['position'] == 'C') {
} elseif ($style['position'] == 'R') {
if (!isset ($style['align'])) {
switch ($style['align']) {
$xpos = $xpos_rect + $hpadding;
$xpos = $xpos_rect + ($w - ($arrcode['maxw'] * $xres)) - $hpadding;
$xpos = $xpos_rect + (($w - ($arrcode['maxw'] * $xres)) / 2);
// barcode is always printed in LTR direction
// print background color
$this->Rect($xpos_rect, $y, $w, $h, $style['border'] ? 'DF' : 'F', '', $style['bgcolor']);
} elseif ($style['border']) {
$this->Rect($xpos_rect, $y, $w, $h, 'D');
foreach ($arrcode['bcode'] as $k => $v) {
$ypos = $y + $vpadding + ($v['p'] * $barh / $arrcode['maxh']);
$this->Rect($xpos, $ypos, $bw, ($v['h'] * $barh / $arrcode['maxh']), 'F', array(), $style['fgcolor']);
if (isset ($style['label']) AND !$this->empty_string($style['label'])) {
$label = $style['label'];
$txtwidth = ($arrcode['maxw'] * $xres);
$style['stretchtext'] = 2;
$this->y = $y + $vpadding + $barh;
$this->Cell($txtwidth, '', $label, 0, 0, 'C', 0, '', $style['stretchtext'], false, 'T', 'T');
// restore original direction
// restore previous settings
// set pointer to align the next text/objects
$this->y = $y + round($h / 2);
* This function is DEPRECATED, please use the new write1DBarcode() function.
* @param int $x x position in user units
* @param int $y y position in user units
* @param int $w width in user units
* @param int $h height position in user units
* @param string $type type of barcode
* @param string $style barcode style
* @param string $font font for text
* @param int $xres x resolution
* @param string $code code to print
* @deprecated deprecated since version 3.1.000 (2008-06-10)
public function writeBarcode($x, $y, $w, $h, $type, $style, $font, $xres, $code) {
// convert old settings for the new write1DBarcode() function.
'fgcolor' => array(0,0,0),
$newstyle['border'] = true;
$newstyle['bgcolor'] = false;
$newstyle['position'] = 'C';
$newstyle['position'] = 'L';
$newstyle['position'] = 'R';
$newstyle['text'] = true;
$newstyle['stretchtext'] = 4;
$this->write1DBarcode($code, $type, $x, $y, $w, $h, $xres, $newstyle, '');
* @param string $code code to print
* @param string $type type of barcode (see 2dbarcodes.php for supported formats).
* @param int $x x position in user units
* @param int $y y position in user units
* @param int $w width in user units
* @param int $h height in user units
* @param array $style array of options:<ul>
* <li>boolean $style['border'] if true prints a border around the barcode</li>
* <li>int $style['padding'] padding to leave around the barcode in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['hpadding'] horizontal padding in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['vpadding'] vertical padding in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['module_width'] width of a single module in points</li>
* <li>int $style['module_height'] height of a single module in points</li>
* <li>array $style['fgcolor'] color array for bars and text</li>
* <li>mixed $style['bgcolor'] color array for background or false for transparent</li>
* <li>string $style['position'] barcode position on the page: L = left margin; C = center; R = right margin; S = stretch</li><li>$style['module_width'] width of a single module in points</li>
* <li>$style['module_height'] height of a single module in points</li></ul>
* @param string $align Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param boolean $distort if true distort the barcode to fit width and height, otherwise preserve aspect ratio
* @since 4.5.037 (2009-04-07)
public function write2DBarcode($code, $type, $x= '', $y= '', $w= '', $h= '', $style= '', $align= '', $distort= false) {
require_once(dirname(__FILE__ ). '/2dbarcodes.php');
// save current graphic settings
// create new barcode object
$arrcode = $barcodeobj->getBarcodeArray();
if (($arrcode === false) OR empty($arrcode)) {
$this->Error('Error in 2D barcode string');
if (!isset ($style['position'])) {
if (!isset ($style['fgcolor'])) {
$style['fgcolor'] = array(0,0,0); // default black
if (!isset ($style['bgcolor'])) {
$style['bgcolor'] = false; // default transparent
if (!isset ($style['border'])) {
$style['border'] = false;
if (!isset ($style['padding'])) {
} elseif ($style['padding'] === 'auto') {
if (!isset ($style['hpadding'])) {
$style['hpadding'] = $style['padding'];
} elseif ($style['hpadding'] === 'auto') {
if (!isset ($style['vpadding'])) {
$style['vpadding'] = $style['padding'];
} elseif ($style['vpadding'] === 'auto') {
// cell (module) dimension
if (!isset ($style['module_width'])) {
$style['module_width'] = 1; // width of a single module in points
if (!isset ($style['module_height'])) {
$style['module_height'] = 1; // height of a single module in points
// check page for no-write regions and adapt page margins if necessary
// number of barcode columns and rows
$rows = $arrcode['num_rows'];
$cols = $arrcode['num_cols'];
// module width and height
$mw = $style['module_width'];
$mh = $style['module_height'];
$ratioHW = ($rows * $mh) / ($cols * $mw);
$ratioWH = ($cols * $mw) / ($rows * $mh);
if (($maxw * $ratioHW) > $maxh) {
$maxw = $maxh * $ratioWH;
if (($maxh * $ratioWH) > $maxw) {
$maxh = $maxw * $ratioHW;
$hpad = (2 * $style['hpadding']);
$vpad = (2 * $style['vpadding']);
if ((($w === '') OR ($w <= 0)) AND (($h === '') OR ($h <= 0))) {
$w = ($cols + $hpad) * ($mw / $this->k);
$h = ($rows + $vpad) * ($mh / $this->k);
} elseif (($w === '') OR ($w <= 0)) {
} elseif (($h === '') OR ($h <= 0)) {
// barcode size (excluding padding)
$bw = ($w * $cols) / ($cols + $hpad);
$bh = ($h * $rows) / ($rows + $vpad);
// dimension of single barcode cell unit
if (($cw / $ch) > ($mw / $mh)) {
// correct horizontal distortion
$style['hpadding'] = ($w - $bw) / (2 * $cw);
// correct vertical distortion
$style['vpadding'] = ($h - $bh) / (2 * $ch);
// fit the barcode on available space
if ($style['position'] == 'L') {
} elseif ($style['position'] == 'C') {
} elseif ($style['position'] == 'R') {
if ($style['position'] == 'L') {
} elseif ($style['position'] == 'C') {
} elseif ($style['position'] == 'R') {
$xstart = $xpos + ($style['hpadding'] * $cw);
$ystart = $y + ($style['vpadding'] * $ch);
// barcode is always printed in LTR direction
// print background color
$this->Rect($xpos, $y, $w, $h, $style['border'] ? 'DF' : 'F', '', $style['bgcolor']);
} elseif ($style['border']) {
$this->Rect($xpos, $y, $w, $h, 'D');
for ($r = 0; $r < $rows; ++ $r) {
for ($c = 0; $c < $cols; ++ $c) {
if ($arrcode['bcode'][$r][$c] == 1) {
// draw a single barcode cell
$this->Rect($xr, $ystart, $cw, $ch, 'F', array(), $style['fgcolor']);
// restore original direction
// restore previous settings
// set pointer to align the next text/objects
* Returns an array containing current margins:
<li>$ret['left'] = left margin</li>
<li>$ret['right'] = right margin</li>
<li>$ret['top'] = top margin</li>
<li>$ret['bottom'] = bottom margin</li>
<li>$ret['header'] = header margin</li>
<li>$ret['footer'] = footer margin</li>
<li>$ret['cell'] = cell padding array</li>
<li>$ret['padding_left'] = cell left padding</li>
<li>$ret['padding_top'] = cell top padding</li>
<li>$ret['padding_right'] = cell right padding</li>
<li>$ret['padding_bottom'] = cell bottom padding</li>
* @return array containing all margins measures
* @since 3.2.000 (2008-06-23)
* Returns an array containing original margins:
<li>$ret['left'] = left margin</li>
<li>$ret['right'] = right margin</li>
* @return array containing all margins measures
* @since 4.0.012 (2008-07-24)
* Returns the current font size.
* @return current font size
* @since 3.2.000 (2008-06-23)
* Returns the current font size in points unit.
* @return current font size in points unit
* @since 3.2.000 (2008-06-23)
* Returns the current font family name.
* @return string current font family name
* @since 4.3.008 (2008-12-05)
* Returns the current font style.
* @return string current font style
* @since 4.3.008 (2008-12-05)
* Extracts the CSS properties from a CSS string.
* @param string $cssdata string containing CSS definitions.
* @return An array where the keys are the CSS selectors and the values are the CSS properties.
* @since 5.1.000 (2010-05-25)
// remove newlines and multiple spaces
$cssdata = preg_replace('/[\s]*([;:\{\}]{1})[\s]*/', '\\1', $cssdata);
// replace media type parenthesis
$cssdata = preg_replace('/@media[\s]+([^\{]*)\{/i', '@media \\1§', $cssdata);
$cssdata = trim($cssdata);
// find media blocks (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
if (preg_match_all('/@media[\s]+([^\§]*)§([^§]*)§/i', $cssdata, $matches) > 0) {
foreach ($matches[1] as $key => $type) {
$cssblocks[$type] = $matches[2][$key];
$cssdata = preg_replace('/@media[\s]+([^\§]*)§([^§]*)§/i', '', $cssdata);
// keep 'all' and 'print' media, other media types are discarded
if (isset ($cssblocks['all']) AND !empty($cssblocks['all'])) {
$cssdata .= $cssblocks['all'];
if (isset ($cssblocks['print']) AND !empty($cssblocks['print'])) {
$cssdata .= $cssblocks['print'];
// reset css blocks array
// explode css data string into array
if (substr($cssdata, - 1) == '}') {
// remove last parethesis
$cssdata = substr($cssdata, 0, - 1);
foreach ($matches as $key => $block) {
// index 0 contains the CSS selector, index 1 contains CSS properties
$cssblocks[$key] = explode('{', $block);
if (!isset ($cssblocks[$key][1])) {
// remove empty definitions
// split groups of selectors (comma-separated list of selectors)
foreach ($cssblocks as $key => $block) {
if (strpos($block[0], ',') > 0) {
$selectors = explode(',', $block[0]);
foreach ($selectors as $sel) {
$cssblocks[] = array(0 => trim($sel), 1 => $block[1]);
// covert array to selector => properties
foreach ($cssblocks as $block) {
// calculate selector's specificity
$a = 0; // the declaration is not from is a 'style' attribute
$c += intval(preg_match_all('/[\:]link|visited|hover|active|focus|target|lang|enabled|disabled|checked|indeterminate|root|nth|first|last|only|empty|contains|not/i', $selector, $matches)); // number of pseudo-classes
$d = intval(preg_match_all('/[\>\+\~\s]{1}[a-zA-Z0-9\*]+/', ' '. $selector, $matches)); // number of element names
$specificity = $a. $b. $c. $d;
// add specificity to the beginning of the selector
$cssdata[$specificity. ' '. $selector] = $block[1];
// sort selectors alphabetically to account for specificity
ksort($cssdata, SORT_STRING);
* Returns true if the CSS selector is valid for the selected HTML tag
* @param array $dom array of HTML tags and properties
* @param int $key key of the current HTML tag
* @param string $selector CSS selector string
* @return true if the selector is valid, false otherwise
* @since 5.1.000 (2010-05-25)
$valid = false; // value to be returned
$tag = $dom[$key]['value'];
if (isset ($dom[$key]['attribute']['class']) AND !empty($dom[$key]['attribute']['class'])) {
if (isset ($dom[$key]['attribute']['id']) AND !empty($dom[$key]['attribute']['id'])) {
$selector = preg_replace('/([\>\+\~\s]{1})([\.]{1})([^\>\+\~\s]*)/si', '\\1*.\\3', $selector);
if (preg_match_all('/([\>\+\~\s]{1})([a-zA-Z0-9\*]+)([^\>\+\~\s]*)/si', $selector, $matches, PREG_PATTERN_ORDER | PREG_OFFSET_CAPTURE) > 0) {
$operator = $parentop[0];
if (($lasttag == '*') OR ($lasttag == $tag)) {
// the last element on selector is our tag or 'any tag'
// check if matches class, id, attribute, pseudo-class or pseudo-element
if (substr($attrib, 1) == $id) {
if (preg_match('/\[([a-zA-Z0-9]*)[\s]*([\~\^\$\*\|\=]*)[\s]*["]?([^"\]]*)["]?\]/i', $attrib, $attrmatch) > 0) {
if (isset ($dom[$key]['attribute'][$att])) {
if ($dom[$key]['attribute'][$att] == $val) {
if ($val == substr($dom[$key]['attribute'][$att], 0, strlen($val))) {
if ($val == substr($dom[$key]['attribute'][$att], - strlen($val))) {
if (strpos($dom[$key]['attribute'][$att], $val) !== false) {
if ($dom[$key]['attribute'][$att] == $val) {
} elseif (preg_match('/'. $val. '[\-]{1}/i', $dom[$key]['attribute'][$att]) > 0) {
case ':': { // pseudo-class or pseudo-element
if ($attrib{1} == ':') { // pseudo-element
// pseudo-elements are not supported!
// (::first-line, ::first-letter, ::before, ::after)
// pseudo-classes are not supported!
// (:root, :nth-child(n), :nth-last-child(n), :nth-of-type(n), :nth-last-of-type(n), :first-child, :last-child, :first-of-type, :last-of-type, :only-child, :only-of-type, :empty, :link, :visited, :active, :hover, :focus, :target, :lang(fr), :enabled, :disabled, :checked)
if ($valid AND ($offset > 0)) {
// check remaining selector part
$selector = substr($selector, 0, $offset);
case ' ': { // descendant of an element
while ($dom[$key]['parent'] > 0) {
$key = $dom[$key]['parent'];
case '>': { // child of an element
case '+': { // immediately preceded by an element
for ($i = ($key - 1); $i > $dom[$key]['parent']; -- $i) {
if ($dom[$i]['tag'] AND $dom[$i]['opening']) {
case '~': { // preceded by an element
for ($i = ($key - 1); $i > $dom[$key]['parent']; -- $i) {
if ($dom[$i]['tag'] AND $dom[$i]['opening']) {
* Returns the styles that apply for the selected HTML tag.
* @param array $dom array of HTML tags and properties
* @param int $key key of the current HTML tag
* @param array $css array of CSS properties
* @return string containing CSS properties
* @since 5.1.000 (2010-05-25)
$tagstyle = ''; // style to be returned
// get all styles that apply
foreach($css as $selector => $style) {
// check if this selector apply to current tag
if (isset ($dom[$key]['attribute']['style'])) {
// attach inline style (latest properties have high priority)
$tagstyle .= ';'. $dom[$key]['attribute']['style'];
// remove multiple semicolons
* Returns the border width from CSS property
* @param string $width border width
* @return int with in user units
* @since 5.7.000 (2010-08-02)
} elseif ($width == 'medium') {
} elseif ($width == 'thick') {
* Returns the border dash style from CSS property
* @param string $style border style to convert
* @return int sash style (return -1 in case of none or hidden border)
* @since 5.7.000 (2010-08-02)
* Returns the border style array from CSS border properties
* @param string $cssborder border properties
* @return array containing border properties
* @since 5.7.000 (2010-08-02)
$border = array(); // value to be returned
$border['cap'] = 'square';
$border['join'] = 'miter';
if ($border['dash'] < 0) {
* Get the internal Cell padding from CSS attribute.
* @param string $csspadding padding properties
* @param float $width width of the containing element
* @since 5.9.000 (2010-10-04)
$cell_padding = array(); // value to be returned
switch (count($padding)) {
$cell_padding['T'] = $padding[0];
$cell_padding['R'] = $padding[1];
$cell_padding['B'] = $padding[2];
$cell_padding['L'] = $padding[3];
$cell_padding['T'] = $padding[0];
$cell_padding['R'] = $padding[1];
$cell_padding['B'] = $padding[2];
$cell_padding['L'] = $padding[1];
$cell_padding['T'] = $padding[0];
$cell_padding['R'] = $padding[1];
$cell_padding['B'] = $padding[0];
$cell_padding['L'] = $padding[1];
$cell_padding['T'] = $padding[0];
$cell_padding['R'] = $padding[0];
$cell_padding['B'] = $padding[0];
$cell_padding['L'] = $padding[0];
* Get the internal Cell margin from CSS attribute.
* @param string $cssmargin margin properties
* @param float $width width of the containing element
* @since 5.9.000 (2010-10-04)
$cell_margin = array(); // value to be returned
switch (count($margin)) {
$cell_margin['T'] = $margin[0];
$cell_margin['R'] = $margin[1];
$cell_margin['B'] = $margin[2];
$cell_margin['L'] = $margin[3];
$cell_margin['T'] = $margin[0];
$cell_margin['R'] = $margin[1];
$cell_margin['B'] = $margin[2];
$cell_margin['L'] = $margin[1];
$cell_margin['T'] = $margin[0];
$cell_margin['R'] = $margin[1];
$cell_margin['B'] = $margin[0];
$cell_margin['L'] = $margin[1];
$cell_margin['T'] = $margin[0];
$cell_margin['R'] = $margin[0];
$cell_margin['B'] = $margin[0];
$cell_margin['L'] = $margin[0];
* Returns the letter-spacing value from CSS value
* @param string $spacing letter-spacing value
* @param float $parent font spacing (tracking/kerning) value of the parent element
* @return float quantity to increases or decreases the space between characters in a text.
* @since 5.9.000 (2010-10-02)
$val = 0; // value to be returned
$spacing = trim($spacing);
if ($parent == 'normal') {
* Returns the percentage of font stretching from CSS value
* @param string $stretch stretch mode
* @param float $parent stretch value of the parent element
* @return float font stretching percentage
* @since 5.9.000 (2010-10-02)
$val = 100; // value to be returned
$stretch = trim($stretch);
case 'ultra-condensed': {
case 'extra-condensed': {
if ($parent == 'normal') {
* Returns the HTML DOM array.
* @param string $html html code
* @since 3.2.000 (2008-06-20)
// array of CSS styles ( selector => properties).
// get CSS array defined at previous call
if (preg_match_all('/<cssarray>([^\<]*)<\/cssarray>/isU', $html, $matches) > 0) {
if (isset ($matches[1][0])) {
$html = preg_replace('/<cssarray>(.*?)<\/cssarray>/isU', '', $html);
// extract external CSS files
foreach ($matches[1] as $key => $link) {
if (preg_match('/type[\s]*=[\s]*"text\/css"/', $link, $type)) {
preg_match('/media[\s]*=[\s]*"([^"]*)"/', $link, $type);
// get 'all' and 'print' media, other media types are discarded
// (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
if (empty($type) OR (isset ($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
if (preg_match('/href[\s]*=[\s]*"([^"]*)"/', $link, $type) > 0) {
if (preg_match_all('/<style([^\>]*)>([^\<]*)<\/style>/isU', $html, $matches) > 0) {
foreach ($matches[1] as $key => $media) {
preg_match('/media[\s]*=[\s]*"([^"]*)"/', $media, $type);
// get 'all' and 'print' media, other media types are discarded
// (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
if (empty($type) OR (isset ($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
$cssdata = $matches[2][$key];
// create a special tag to contain the CSS array (used for table content)
// remove head and style blocks
$html = preg_replace('/<head([^\>]*)>(.*?)<\/head>/siU', '', $html);
$html = preg_replace('/<style([^\>]*)>([^\<]*)<\/style>/isU', '', $html);
$blocktags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table','tr','td');
// define self-closing tags
$selfclosingtags = array('area','base','basefont','br','hr','input','img','link','meta');
// remove all unsupported tags (the line below lists all supported tags)
$html = strip_tags($html, '<marker/><a><b><blockquote><body><br><br/><dd><del><div><dl><dt><em><font><form><h1><h2><h3><h4><h5><h6><hr><hr/><i><img><input><label><li><ol><option><p><pre><s><select><small><span><strike><strong><sub><sup><table><tablehead><tcpdf><td><textarea><th><thead><tr><tt><u><ul>');
//replace some blank characters
$html = preg_replace('/<pre/', '<xre', $html); // preserve pre tag
$html = preg_replace('/<(table|tr|td|th|tcpdf|blockquote|dd|div|dl|dt|form|h1|h2|h3|h4|h5|h6|br|hr|li|ol|ul|p)([^\>]*)>[\n\r\t]+/', '<\\1\\2>', $html);
$repTable = array("\t" => ' ', "\0" => ' ', "\x0B" => ' ', "\\" => "\\\\");
$html = strtr($html, $repTable);
while (($offset < strlen($html)) AND ($pos = strpos($html, '</pre>', $offset)) !== false) {
$html_a = substr($html, 0, $offset);
$html_b = substr($html, $offset, ($pos - $offset + 6));
while (preg_match("'<xre([^\>]*)>(.*?)\n(.*?)</pre>'si", $html_b)) {
// preserve newlines on <pre> tag
$html_b = preg_replace("'<xre([^\>]*)>(.*?)\n(.*?)</pre>'si", "<xre\\1>\\2<br />\\3</pre>", $html_b);
// preserve spaces on <pre> tag
$html_b = preg_replace("'<xre([^\>]*)>(.*?)". $this->re_space['p']. "(.*?)</pre>'". $this->re_space['m'], "<xre\\1>\\2 \\3</pre>", $html_b);
$html = $html_a. $html_b. substr($html, $pos + 6);
$offset = strlen($html_a. $html_b);
while (($offset < strlen($html)) AND ($pos = strpos($html, '</textarea>', $offset)) !== false) {
$html_a = substr($html, 0, $offset);
$html_b = substr($html, $offset, ($pos - $offset + 11));
while (preg_match("'<textarea([^\>]*)>(.*?)\n(.*?)</textarea>'si", $html_b)) {
// preserve newlines on <textarea> tag
$html_b = preg_replace("'<textarea([^\>]*)>(.*?)\n(.*?)</textarea>'si", "<textarea\\1>\\2<TBR>\\3</textarea>", $html_b);
$html_b = preg_replace("'<textarea([^\>]*)>(.*?)[\"](.*?)</textarea>'si", "<textarea\\1>\\2''\\3</textarea>", $html_b);
$html = $html_a. $html_b. substr($html, $pos + 11);
$offset = strlen($html_a. $html_b);
$html = preg_replace('/([\s]*)<option/si', '<option', $html);
$html = preg_replace('/<\/option>([\s]*)/si', '</option>', $html);
while (($offset < strlen($html)) AND ($pos = strpos($html, '</option>', $offset)) !== false) {
$html_a = substr($html, 0, $offset);
$html_b = substr($html, $offset, ($pos - $offset + 9));
while (preg_match("'<option([^\>]*)>(.*?)</option>'si", $html_b)) {
$html_b = preg_replace("'<option([\s]+)value=\"([^\"]*)\"([^\>]*)>(.*?)</option>'si", "\\2#!TaB!#\\4#!NwL!#", $html_b);
$html_b = preg_replace("'<option([^\>]*)>(.*?)</option>'si", "\\2#!NwL!#", $html_b);
$html = $html_a. $html_b. substr($html, $pos + 9);
$offset = strlen($html_a. $html_b);
$html = preg_replace("'<select([^\>]*)>'si", "<select\\1 opt=\"", $html);
$html = preg_replace("'#!NwL!#</select>'si", "\" />", $html);
// restore textarea newlines
// remove extra spaces from code
$html = preg_replace('/[\s]+<\/(table|tr|ul|ol|dl)>/', '</\\1>', $html);
$html = preg_replace('/[\s]+<(tr|td|th|li|dt|dd)/', '<\\1', $html);
$html = preg_replace('/<\/(table|tr|td|th|blockquote|dd|dt|dl|div|dt|h1|h2|h3|h4|h5|h6|hr|li|ol|ul|p)>[\s]+</', '</\\1><', $html);
$html = preg_replace('/<\/(td|th)>/', '<marker style="font-size:0"/></\\1>', $html);
$html = preg_replace('/<\/table>([\s]*)<marker style="font-size:0"\/>/', '</table>', $html);
$html = preg_replace('/<img([^\>]*)>/xi', '<img\\1><span><marker style="font-size:0"/></span>', $html);
$html = preg_replace('/<xre/', '<pre', $html); // restore pre tag
$html = preg_replace('/<textarea([^\>]*)>([^\<]*)<\/textarea>/xi', '<textarea\\1 value="\\2" />', $html);
$html = preg_replace('/<li([^\>]*)><\/li>/', '<li\\1> </li>', $html);
$html = preg_replace('/<([^\>\/]*)>[\s]/', '<\\1> ', $html); // preserve some spaces
$html = preg_replace('/[\s]<\/([^\>]*)>/', ' </\\1>', $html); // preserve some spaces
// pattern for generic tag
$tagpattern = '/(<[^>]+>)/';
$a = preg_split($tagpattern, $html, - 1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
// create an array of elements
// set inheritable properties fot the first void element
// possible inheritable properties are: azimuth, border-collapse, border-spacing, caption-side, color, cursor, direction, empty-cells, font, font-family, font-stretch, font-size, font-size-adjust, font-style, font-variant, font-weight, letter-spacing, line-height, list-style, list-style-image, list-style-position, list-style-type, orphans, page, page-break-inside, quotes, speak, speak-header, text-align, text-indent, text-transform, volume, white-space, widows, word-spacing
$dom[$key]['tag'] = false;
$dom[$key]['block'] = false;
$dom[$key]['value'] = '';
$dom[$key]['parent'] = 0;
$dom[$key]['font-stretch'] = 100;
$dom[$key]['letter-spacing'] = 0;
$dom[$key]['bgcolor'] = false;
$dom[$key]['fgcolor'] = $this->fgcolor; // color
$dom[$key]['align'] = '';
$dom[$key]['listtype'] = '';
$dom[$key]['text-indent'] = 0;
$dom[$key]['border'] = array();
$dom[$key]['dir'] = $this->rtl? 'rtl': 'ltr';
$thead = false; // true when we are inside the THEAD tag
while ($elkey < $maxel) {
$dom[$key]['elkey'] = $elkey;
$element = substr($element, 1, - 1);
preg_match('/[\/]?([a-zA-Z0-9]*)/', $element, $tag);
// check if we are inside a table header
if ($tagname == 'thead') {
if ($element{0} == '/') {
$dom[$key]['tag'] = true;
$dom[$key]['value'] = $tagname;
if (in_array($dom[$key]['value'], $blocktags)) {
$dom[$key]['block'] = true;
$dom[$key]['block'] = false;
if ($element{0} == '/') {
$dom[$key]['opening'] = false;
$dom[$key]['parent'] = end($level);
$dom[$key]['fontname'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontname'];
$dom[$key]['fontstyle'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontstyle'];
$dom[$key]['fontsize'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontsize'];
$dom[$key]['font-stretch'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['font-stretch'];
$dom[$key]['letter-spacing'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['letter-spacing'];
$dom[$key]['stroke'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['stroke'];
$dom[$key]['fill'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fill'];
$dom[$key]['clip'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['clip'];
$dom[$key]['line-height'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['line-height'];
$dom[$key]['bgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['bgcolor'];
$dom[$key]['fgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fgcolor'];
$dom[$key]['strokecolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['strokecolor'];
$dom[$key]['align'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['align'];
$dom[$key]['dir'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['dir'];
if (isset ($dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'])) {
$dom[$key]['listtype'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'];
// set the number of columns in table tag
if (($dom[$key]['value'] == 'tr') AND (!isset ($dom[($dom[($dom[$key]['parent'])]['parent'])]['cols']))) {
$dom[($dom[($dom[$key]['parent'])]['parent'])]['cols'] = $dom[($dom[$key]['parent'])]['cols'];
if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
$dom[($dom[$key]['parent'])]['content'] = $csstagarray;
for ($i = ($dom[$key]['parent'] + 1); $i < $key; ++ $i) {
$dom[($dom[$key]['parent'])]['content'] .= $a[$dom[$i]['elkey']];
$parent_table = $dom[$dom[$dom[($dom[$key]['parent'])]['parent']]['parent']];
if (isset ($parent_table['attribute']['cellpadding'])) {
$parent_padding = $this->getHTMLUnitToUnits($parent_table['attribute']['cellpadding'], 1, 'px');
if (isset ($parent_table['attribute']['cellspacing'])) {
$parent_spacing = $this->getHTMLUnitToUnits($parent_table['attribute']['cellspacing'], 1, 'px');
$dom[($dom[$key]['parent'])]['content'] = str_replace('<table', '<table nested="true" pcellpadding="'. $parent_padding. '" pcellspacing="'. $parent_spacing. '"', $dom[($dom[$key]['parent'])]['content']);
// remove thead sections from nested tables
$dom[($dom[$key]['parent'])]['content'] = str_replace('<thead>', '', $dom[($dom[$key]['parent'])]['content']);
$dom[($dom[$key]['parent'])]['content'] = str_replace('</thead>', '', $dom[($dom[$key]['parent'])]['content']);
// store header rows on a new table
if (($dom[$key]['value'] == 'tr') AND ($dom[($dom[$key]['parent'])]['thead'] === true)) {
if ($this->empty_string($dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'])) {
$dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] = $a[$dom[($dom[($dom[$key]['parent'])]['parent'])]['elkey']];
for ($i = $dom[$key]['parent']; $i <= $key; ++ $i) {
$dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] .= $a[$dom[$i]['elkey']];
if (!isset ($dom[($dom[$key]['parent'])]['attribute'])) {
$dom[($dom[$key]['parent'])]['attribute'] = array();
// header elements must be always contained in a single page
$dom[($dom[$key]['parent'])]['attribute']['nobr'] = 'true';
if (($dom[$key]['value'] == 'table') AND (!$this->empty_string($dom[($dom[$key]['parent'])]['thead']))) {
// remove the nobr attributes from the table header
$dom[($dom[$key]['parent'])]['thead'] = str_replace(' nobr="true"', '', $dom[($dom[$key]['parent'])]['thead']);
$dom[($dom[$key]['parent'])]['thead'] .= '</tablehead>';
// *** opening or self-closing html tag
$dom[$key]['opening'] = true;
$dom[$key]['parent'] = end($level);
if ((substr($element, - 1, 1) == '/') OR (in_array($dom[$key]['value'], $selfclosingtags))) {
$dom[$key]['self'] = true;
$dom[$key]['self'] = false;
// copy some values from parent
$parentkey = $dom[$key]['parent'];
$dom[$key]['fontname'] = $dom[$parentkey]['fontname'];
$dom[$key]['fontstyle'] = $dom[$parentkey]['fontstyle'];
$dom[$key]['fontsize'] = $dom[$parentkey]['fontsize'];
$dom[$key]['font-stretch'] = $dom[$parentkey]['font-stretch'];
$dom[$key]['letter-spacing'] = $dom[$parentkey]['letter-spacing'];
$dom[$key]['stroke'] = $dom[$parentkey]['stroke'];
$dom[$key]['fill'] = $dom[$parentkey]['fill'];
$dom[$key]['clip'] = $dom[$parentkey]['clip'];
$dom[$key]['line-height'] = $dom[$parentkey]['line-height'];
$dom[$key]['bgcolor'] = $dom[$parentkey]['bgcolor'];
$dom[$key]['fgcolor'] = $dom[$parentkey]['fgcolor'];
$dom[$key]['strokecolor'] = $dom[$parentkey]['strokecolor'];
$dom[$key]['align'] = $dom[$parentkey]['align'];
$dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
$dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
$dom[$key]['border'] = array();
$dom[$key]['dir'] = $dom[$parentkey]['dir'];
preg_match_all('/([^=\s]*)[\s]*=[\s]*"([^"]*)"/', $element, $attr_array, PREG_PATTERN_ORDER);
$dom[$key]['attribute'] = array(); // reset attribute array
while (list ($id, $name) = each($attr_array[1])) {
$dom[$key]['attribute'][strtolower($name)] = $attr_array[2][$id];
// merge eternal CSS style to current style
// split style attributes
if (isset ($dom[$key]['attribute']['style']) AND !empty($dom[$key]['attribute']['style'])) {
preg_match_all('/([^;:\s]*):([^;]*)/', $dom[$key]['attribute']['style'], $style_array, PREG_PATTERN_ORDER);
$dom[$key]['style'] = array(); // reset style attribute array
while (list ($id, $name) = each($style_array[1])) {
// in case of duplicate attribute the last replace the previous
// --- get some style attributes ---
if (isset ($dom[$key]['style']['direction'])) {
$dom[$key]['dir'] = $dom[$key]['style']['direction'];
if (isset ($dom[$key]['style']['font-family'])) {
$dom[$key]['fontname'] = $this->getFontFamilyName($dom[$key]['style']['font-family']);
if (isset ($dom[$key]['style']['list-style-type'])) {
$dom[$key]['listtype'] = trim(strtolower($dom[$key]['style']['list-style-type']));
if ($dom[$key]['listtype'] == 'inherit') {
$dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
if (isset ($dom[$key]['style']['text-indent'])) {
$dom[$key]['text-indent'] = $this->getHTMLUnitToUnits($dom[$key]['style']['text-indent']);
if ($dom[$key]['text-indent'] == 'inherit') {
$dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
if (isset ($dom[$key]['style']['font-size'])) {
$fsize = trim($dom[$key]['style']['font-size']);
$dom[$key]['fontsize'] = $dom[0]['fontsize'] - 4;
$dom[$key]['fontsize'] = $dom[0]['fontsize'] - 3;
$dom[$key]['fontsize'] = $dom[0]['fontsize'] - 2;
$dom[$key]['fontsize'] = $dom[0]['fontsize'];
$dom[$key]['fontsize'] = $dom[0]['fontsize'] + 2;
$dom[$key]['fontsize'] = $dom[0]['fontsize'] + 4;
$dom[$key]['fontsize'] = $dom[0]['fontsize'] + 6;
$dom[$key]['fontsize'] = $dom[$parentkey]['fontsize'] - 3;
$dom[$key]['fontsize'] = $dom[$parentkey]['fontsize'] + 3;
$dom[$key]['fontsize'] = $this->getHTMLUnitToUnits($fsize, $dom[$parentkey]['fontsize'], 'pt', true);
if (isset ($dom[$key]['style']['font-stretch'])) {
$dom[$key]['font-stretch'] = $this->getCSSFontStretching($dom[$key]['style']['font-stretch'], $dom[$parentkey]['font-stretch']);
if (isset ($dom[$key]['style']['letter-spacing'])) {
$dom[$key]['letter-spacing'] = $this->getCSSFontSpacing($dom[$key]['style']['letter-spacing'], $dom[$parentkey]['letter-spacing']);
if (isset ($dom[$key]['style']['line-height'])) {
$lineheight = trim($dom[$key]['style']['line-height']);
// A normal line height. This is default
$dom[$key]['line-height'] = $dom[0]['line-height'];
$lineheight = $lineheight * 100;
if (isset ($dom[$key]['style']['font-weight']) AND (strtolower($dom[$key]['style']['font-weight']{0}) == 'b')) {
$dom[$key]['fontstyle'] .= 'B';
if (isset ($dom[$key]['style']['font-style']) AND (strtolower($dom[$key]['style']['font-style']{0}) == 'i')) {
$dom[$key]['fontstyle'] .= 'I';
if (isset ($dom[$key]['style']['color']) AND (!$this->empty_string($dom[$key]['style']['color']))) {
} elseif ($dom[$key]['value'] == 'a') {
if (isset ($dom[$key]['style']['background-color']) AND (!$this->empty_string($dom[$key]['style']['background-color']))) {
if (isset ($dom[$key]['style']['text-decoration'])) {
foreach ($decors as $dec) {
$dom[$key]['fontstyle'] .= 'U';
} elseif ($dec{0} == 'l') {
$dom[$key]['fontstyle'] .= 'D';
} elseif ($dec{0} == 'o') {
$dom[$key]['fontstyle'] .= 'O';
} elseif ($dom[$key]['value'] == 'a') {
// check for width attribute
if (isset ($dom[$key]['style']['width'])) {
$dom[$key]['width'] = $dom[$key]['style']['width'];
// check for height attribute
if (isset ($dom[$key]['style']['height'])) {
$dom[$key]['height'] = $dom[$key]['style']['height'];
// check for text alignment
if (isset ($dom[$key]['style']['text-align'])) {
$dom[$key]['align'] = strtoupper($dom[$key]['style']['text-align']{0});
// check for CSS border properties
if (isset ($dom[$key]['style']['border'])) {
if (!empty($borderstyle)) {
$dom[$key]['border']['LTRB'] = $borderstyle;
if (isset ($dom[$key]['style']['border-color'])) {
$brd_colors = preg_split('/[\s]+/', trim($dom[$key]['style']['border-color']));
if (isset ($brd_colors[3])) {
if (isset ($brd_colors[1])) {
if (isset ($brd_colors[0])) {
if (isset ($brd_colors[2])) {
if (isset ($dom[$key]['style']['border-width'])) {
$brd_widths = preg_split('/[\s]+/', trim($dom[$key]['style']['border-width']));
if (isset ($brd_widths[3])) {
if (isset ($brd_widths[1])) {
if (isset ($brd_widths[0])) {
if (isset ($brd_widths[2])) {
if (isset ($dom[$key]['style']['border-style'])) {
$brd_styles = preg_split('/[\s]+/', trim($dom[$key]['style']['border-style']));
if (isset ($brd_styles[3])) {
$dom[$key]['border']['L']['cap'] = 'square';
$dom[$key]['border']['L']['join'] = 'miter';
if ($dom[$key]['border']['L']['dash'] < 0) {
$dom[$key]['border']['L'] = array();
if (isset ($brd_styles[1])) {
$dom[$key]['border']['R']['cap'] = 'square';
$dom[$key]['border']['R']['join'] = 'miter';
if ($dom[$key]['border']['R']['dash'] < 0) {
$dom[$key]['border']['R'] = array();
if (isset ($brd_styles[0])) {
$dom[$key]['border']['T']['cap'] = 'square';
$dom[$key]['border']['T']['join'] = 'miter';
if ($dom[$key]['border']['T']['dash'] < 0) {
$dom[$key]['border']['T'] = array();
if (isset ($brd_styles[2])) {
$dom[$key]['border']['B']['cap'] = 'square';
$dom[$key]['border']['B']['join'] = 'miter';
if ($dom[$key]['border']['B']['dash'] < 0) {
$dom[$key]['border']['B'] = array();
$cellside = array('L' => 'left', 'R' => 'right', 'T' => 'top', 'B' => 'bottom');
foreach ($cellside as $bsk => $bsv) {
if (isset ($dom[$key]['style']['border-'. $bsv])) {
if (!empty($borderstyle)) {
$dom[$key]['border'][$bsk] = $borderstyle;
if (isset ($dom[$key]['style']['border-'. $bsv. '-color'])) {
$dom[$key]['border'][$bsk]['color'] = $this->convertHTMLColorToDec($dom[$key]['style']['border-'. $bsv. '-color']);
if (isset ($dom[$key]['style']['border-'. $bsv. '-width'])) {
$dom[$key]['border'][$bsk]['width'] = $this->getCSSBorderWidth($dom[$key]['style']['border-'. $bsv. '-width']);
if (isset ($dom[$key]['style']['border-'. $bsv. '-style'])) {
$dom[$key]['border'][$bsk]['dash'] = $this->getCSSBorderDashStyle($dom[$key]['style']['border-'. $bsv. '-style']);
if ($dom[$key]['border'][$bsk]['dash'] < 0) {
$dom[$key]['border'][$bsk] = array();
// check for CSS padding properties
if (isset ($dom[$key]['style']['padding'])) {
$dom[$key]['padding'] = $this->getCSSPadding($dom[$key]['style']['padding']);
foreach ($cellside as $psk => $psv) {
if (isset ($dom[$key]['style']['padding-'. $psv])) {
$dom[$key]['padding'][$psk] = $this->getHTMLUnitToUnits($dom[$key]['style']['padding-'. $psv], 0, 'px', false);
// check for CSS margin properties
if (isset ($dom[$key]['style']['margin'])) {
$dom[$key]['margin'] = $this->getCSSMargin($dom[$key]['style']['margin']);
foreach ($cellside as $psk => $psv) {
if (isset ($dom[$key]['style']['margin-'. $psv])) {
if (isset ($dom[$key]['style']['page-break-inside']) AND ($dom[$key]['style']['page-break-inside'] == 'avoid')) {
$dom[$key]['attribute']['nobr'] = 'true';
if (isset ($dom[$key]['style']['page-break-before'])) {
if ($dom[$key]['style']['page-break-before'] == 'always') {
$dom[$key]['attribute']['pagebreak'] = 'true';
} elseif ($dom[$key]['style']['page-break-before'] == 'left') {
$dom[$key]['attribute']['pagebreak'] = 'left';
} elseif ($dom[$key]['style']['page-break-before'] == 'right') {
$dom[$key]['attribute']['pagebreak'] = 'right';
if (isset ($dom[$key]['style']['page-break-after'])) {
if ($dom[$key]['style']['page-break-after'] == 'always') {
$dom[$key]['attribute']['pagebreakafter'] = 'true';
} elseif ($dom[$key]['style']['page-break-after'] == 'left') {
$dom[$key]['attribute']['pagebreakafter'] = 'left';
} elseif ($dom[$key]['style']['page-break-after'] == 'right') {
$dom[$key]['attribute']['pagebreakafter'] = 'right';
if (isset ($dom[$key]['attribute']['border']) AND ($dom[$key]['attribute']['border'] != 0)) {
$borderstyle = $this->getCSSBorderStyle($dom[$key]['attribute']['border']. ' solid black');
if (!empty($borderstyle)) {
$dom[$key]['border']['LTRB'] = $borderstyle;
if ($dom[$key]['value'] == 'font') {
if (isset ($dom[$key]['attribute']['face'])) {
if (isset ($dom[$key]['attribute']['size'])) {
if ($dom[$key]['attribute']['size']{0} == '+') {
$dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] + intval(substr($dom[$key]['attribute']['size'], 1));
} elseif ($dom[$key]['attribute']['size']{0} == '-') {
$dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] - intval(substr($dom[$key]['attribute']['size'], 1));
$dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
$dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
// force natural alignment for lists
if ((($dom[$key]['value'] == 'ul') OR ($dom[$key]['value'] == 'ol') OR ($dom[$key]['value'] == 'dl'))
AND (!isset ($dom[$key]['align']) OR $this->empty_string($dom[$key]['align']) OR ($dom[$key]['align'] != 'J'))) {
$dom[$key]['align'] = 'R';
$dom[$key]['align'] = 'L';
if (($dom[$key]['value'] == 'small') OR ($dom[$key]['value'] == 'sup') OR ($dom[$key]['value'] == 'sub')) {
if (!isset ($dom[$key]['attribute']['size']) AND !isset ($dom[$key]['style']['font-size'])) {
if (($dom[$key]['value'] == 'strong') OR ($dom[$key]['value'] == 'b')) {
$dom[$key]['fontstyle'] .= 'B';
if (($dom[$key]['value'] == 'em') OR ($dom[$key]['value'] == 'i')) {
$dom[$key]['fontstyle'] .= 'I';
if ($dom[$key]['value'] == 'u') {
$dom[$key]['fontstyle'] .= 'U';
if (($dom[$key]['value'] == 'del') OR ($dom[$key]['value'] == 's') OR ($dom[$key]['value'] == 'strike')) {
$dom[$key]['fontstyle'] .= 'D';
if (!isset ($dom[$key]['style']['text-decoration']) AND ($dom[$key]['value'] == 'a')) {
if (($dom[$key]['value'] == 'pre') OR ($dom[$key]['value'] == 'tt')) {
if (($dom[$key]['value']{0} == 'h') AND (intval($dom[$key]['value']{1}) > 0) AND (intval($dom[$key]['value']{1}) < 7)) {
// headings h1, h2, h3, h4, h5, h6
if (!isset ($dom[$key]['attribute']['size']) AND !isset ($dom[$key]['style']['font-size'])) {
$headsize = (4 - intval($dom[$key]['value']{1})) * 2;
$dom[$key]['fontsize'] = $dom[0]['fontsize'] + $headsize;
if (!isset ($dom[$key]['style']['font-weight'])) {
$dom[$key]['fontstyle'] .= 'B';
if (($dom[$key]['value'] == 'table')) {
$dom[$key]['rows'] = 0; // number of rows
$dom[$key]['trids'] = array(); // IDs of TR elements
$dom[$key]['thead'] = ''; // table header rows
if (($dom[$key]['value'] == 'tr')) {
$dom[$key]['thead'] = true;
// rows on thead block are printed as a separate table
$dom[$key]['thead'] = false;
// store the number of rows on table element
++ $dom[($dom[$key]['parent'])]['rows'];
// store the TR elements IDs on table element
array_push($dom[($dom[$key]['parent'])]['trids'], $key);
if (($dom[$key]['value'] == 'th') OR ($dom[$key]['value'] == 'td')) {
if (isset ($dom[$key]['attribute']['colspan'])) {
$colspan = intval($dom[$key]['attribute']['colspan']);
$dom[$key]['attribute']['colspan'] = $colspan;
$dom[($dom[$key]['parent'])]['cols'] += $colspan;
if (isset ($dom[$key]['attribute']['dir'])) {
$dom[$key]['dir'] = $dom[$key]['attribute']['dir'];
// set foreground color attribute
if (isset ($dom[$key]['attribute']['color']) AND (!$this->empty_string($dom[$key]['attribute']['color']))) {
} elseif (!isset ($dom[$key]['style']['color']) AND ($dom[$key]['value'] == 'a')) {
// set background color attribute
if (isset ($dom[$key]['attribute']['bgcolor']) AND (!$this->empty_string($dom[$key]['attribute']['bgcolor']))) {
// set stroke color attribute
if (isset ($dom[$key]['attribute']['strokecolor']) AND (!$this->empty_string($dom[$key]['attribute']['strokecolor']))) {
// check for width attribute
if (isset ($dom[$key]['attribute']['width'])) {
$dom[$key]['width'] = $dom[$key]['attribute']['width'];
// check for height attribute
if (isset ($dom[$key]['attribute']['height'])) {
$dom[$key]['height'] = $dom[$key]['attribute']['height'];
// check for text alignment
if (isset ($dom[$key]['attribute']['align']) AND (!$this->empty_string($dom[$key]['attribute']['align'])) AND ($dom[$key]['value'] !== 'img')) {
$dom[$key]['align'] = strtoupper($dom[$key]['attribute']['align']{0});
// check for text rendering mode (the following attributes do not exist in HTML)
if (isset ($dom[$key]['attribute']['stroke'])) {
$dom[$key]['stroke'] = $this->getHTMLUnitToUnits($dom[$key]['attribute']['stroke'], $dom[$key]['fontsize'], 'pt', true);
if (isset ($dom[$key]['attribute']['fill'])) {
if ($dom[$key]['attribute']['fill'] == 'true') {
$dom[$key]['fill'] = true;
$dom[$key]['fill'] = false;
if (isset ($dom[$key]['attribute']['clip'])) {
if ($dom[$key]['attribute']['clip'] == 'true') {
$dom[$key]['clip'] = true;
$dom[$key]['clip'] = false;
$dom[$key]['tag'] = false;
$dom[$key]['block'] = false;
$dom[$key]['parent'] = end($level);
* Returns the string used to find spaces
* @since 4.8.024 (2010-01-15)
* Prints a cell (rectangular area) with optional borders, background color and html text string.
* The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* @param float $w Cell width. If 0, the cell extends up to the right margin.
* @param float $h Cell minimum height. The cell extends automatically if needed.
* @param float $x upper-left corner X coordinate
* @param float $y upper-left corner Y coordinate
* @param string $html html text to print. Default value: empty string.
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param boolean $fill Indicates if the cell background must be painted (true) or transparent (false).
* @param boolean $reseth if true reset the last cell height (default true).
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
* @see Multicell(), writeHTML()
public function writeHTMLCell($w, $h, $x, $y, $html= '', $border= 0, $ln= 0, $fill= false, $reseth= true, $align= '', $autopadding= true) {
return $this->MultiCell($w, $h, $html, $border, $align, $fill, $ln, $x, $y, $reseth, 0, true, $autopadding, 0);
* Allows to preserve some HTML formatting (limited support).<br />
* IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
* Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
* @param string $html text to display
* @param boolean $ln if true add a new line after text (default = true)
* @param boolean $fill Indicates if the background must be painted (true) or transparent (false).
* @param boolean $reseth if true reset the last cell height (default false).
* @param boolean $cell if true add the current left (or right for RTL) padding to each Write (default false).
* @param string $align Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
public function writeHTML($html, $ln= true, $fill= false, $reseth= false, $cell= false, $align= '') {
$curfontascent = $this->getFontAscent($curfontname, $curfontstyle, $curfontsize);
$curfontdescent = $this->getFontDescent($curfontname, $curfontstyle, $curfontsize);
$startlinepage = $this->page;
$minstartliney = $this->y;
$this_method_vars = array();
$reverse_dir = false; // true when the text direction is reversed
// we are inside an XObject template
// we are inside an XObject template
// we are inside the footer
if ($dom[$key]['tag'] AND isset ($dom[$key]['attribute']['pagebreak'])) {
if (($dom[$key]['attribute']['pagebreak'] == 'true') OR ($dom[$key]['attribute']['pagebreak'] == 'left') OR ($dom[$key]['attribute']['pagebreak'] == 'right')) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
if ((($dom[$key]['attribute']['pagebreak'] == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
OR (($dom[$key]['attribute']['pagebreak'] == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
if ($dom[$key]['tag'] AND $dom[$key]['opening'] AND isset ($dom[$key]['attribute']['nobr']) AND ($dom[$key]['attribute']['nobr'] == 'true')) {
if (isset ($dom[($dom[$key]['parent'])]['attribute']['nobr']) AND ($dom[($dom[$key]['parent'])]['attribute']['nobr'] == 'true')) {
$dom[$key]['attribute']['nobr'] = false;
$this_method_vars['html'] = $html;
$this_method_vars['ln'] = $ln;
$this_method_vars['fill'] = $fill;
$this_method_vars['reseth'] = $reseth;
$this_method_vars['cell'] = $cell;
$this_method_vars['align'] = $align;
$this_method_vars['gvars'] = $gvars;
$this_method_vars['prevPage'] = $prevPage;
$this_method_vars['prev_cell_margin'] = $prev_cell_margin;
$this_method_vars['prev_cell_padding'] = $prev_cell_padding;
$this_method_vars['prevlMargin'] = $prevlMargin;
$this_method_vars['prevrMargin'] = $prevrMargin;
$this_method_vars['curfontname'] = $curfontname;
$this_method_vars['curfontstyle'] = $curfontstyle;
$this_method_vars['curfontsize'] = $curfontsize;
$this_method_vars['curfontascent'] = $curfontascent;
$this_method_vars['curfontdescent'] = $curfontdescent;
$this_method_vars['curfontstretcing'] = $curfontstretcing;
$this_method_vars['curfontkerning'] = $curfontkerning;
$this_method_vars['minstartliney'] = $minstartliney;
$this_method_vars['maxbottomliney'] = $maxbottomliney;
$this_method_vars['yshift'] = $yshift;
$this_method_vars['startlinepage'] = $startlinepage;
$this_method_vars['startlinepos'] = $startlinepos;
$this_method_vars['startlinex'] = $startlinex;
$this_method_vars['startliney'] = $startliney;
$this_method_vars['newline'] = $newline;
$this_method_vars['loop'] = $loop;
$this_method_vars['curpos'] = $curpos;
$this_method_vars['pask'] = $pask;
$this_method_vars['lalign'] = $lalign;
$this_method_vars['plalign'] = $plalign;
$this_method_vars['w'] = $w;
$this_method_vars['prev_cell_height_ratio'] = $prev_cell_height_ratio;
$this_method_vars['prev_listnum'] = $prev_listnum;
$this_method_vars['prev_listordered'] = $prev_listordered;
$this_method_vars['prev_listcount'] = $prev_listcount;
$this_method_vars['prev_lispacer'] = $prev_lispacer;
$this_method_vars['fontaligned'] = $fontaligned;
$this_method_vars['key'] = $key;
$this_method_vars['dom'] = $dom;
if (($dom[$key]['value'] == 'tr') AND isset ($dom[$key]['thead']) AND $dom[$key]['thead']) {
if (isset ($dom[$key]['parent']) AND isset ($dom[$dom[$key]['parent']]['thead']) AND !$this->empty_string($dom[$dom[$key]['parent']]['thead'])) {
// print table header (thead)
// check if we are on a new page or on a new column
// we are on a new page or on a new column and the total object height is less than the available vertical space.
// restore previous object
// restore previous values
foreach ($this_method_vars as $vkey => $vval) {
$tmp_thead = $this->thead;
// add a page (or trig AcceptPageBreak() for multicolumn mode)
// fix for multicolumn mode
$this->thead = $tmp_thead;
// fix table border properties
if (isset ($dom[$dom[$key]['parent']]['attribute']['cellspacing'])) {
$tmp_cellspacing = $this->getHTMLUnitToUnits($dom[$dom[$key]['parent']]['attribute']['cellspacing'], 1, 'px');
$dom[$dom[$key]['parent']]['borderposition']['page'] = $this->page;
$dom[$dom[$key]['parent']]['borderposition']['column'] = $this->current_column;
$dom[$dom[$key]['parent']]['borderposition']['y'] = $this->y + $tmp_cellspacing;
$xoffset = ($this->x - $dom[$dom[$key]['parent']]['borderposition']['x']);
$dom[$dom[$key]['parent']]['borderposition']['x'] += $xoffset;
$dom[$dom[$key]['parent']]['borderposition']['xmax'] += $xoffset;
// print table header (thead)
// move $key index forward to skip THEAD block
while ( ($key < $maxel) AND (!(
($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'tr') AND (!isset ($dom[$key]['thead']) OR !$dom[$key]['thead']))
OR ($dom[$key]['tag'] AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == 'table'))) )) {
if ($dom[$key]['tag'] OR ($key == 0)) {
if ((($dom[$key]['value'] == 'table') OR ($dom[$key]['value'] == 'tr')) AND (isset ($dom[$key]['align']))) {
$dom[$key]['align'] = ($this->rtl) ? 'R' : 'L';
// vertically align image in line
if ((!$this->newline) AND ($dom[$key]['value'] == 'img') AND (isset ($dom[$key]['height'])) AND ($dom[$key]['height'] > 0)) {
// check for automatic line break
if (isset ($dom[$key]['width']) AND ($dom[$key]['width'] > 0)) {
// add automatic line break
// go back to evaluate this line break
// fix for multicolumn mode
if ($this->page > $startlinepage) {
// fix line splitted over two pages
if (isset ($this->footerlen[$startlinepage])) {
// line to be moved one page forward
$linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
$tstart = substr($pagebuff, 0, $startlinepos);
// remove line from previous page
// add line start to current page
$yshift = $minstartliney - $this->y;
$yshift += ($curfontsize / $this->k);
$try = sprintf('1 0 0 1 0 %.3F cm', ($yshift * $this->k));
// shift the annotations and links
foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
$startlinepage = $this->page;
$this->y += ((($curfontsize * $this->cell_height_ratio / $this->k) + $curfontascent - $curfontdescent) / 2) - $imgh;
$minstartliney = min($this->y, $minstartliney);
} elseif (isset ($dom[$key]['fontname']) OR isset ($dom[$key]['fontstyle']) OR isset ($dom[$key]['fontsize']) OR isset ($dom[$key]['line-height'])) {
// account for different font size
$pfontname = $curfontname;
$pfontstyle = $curfontstyle;
$pfontsize = $curfontsize;
$fontname = isset ($dom[$key]['fontname']) ? $dom[$key]['fontname'] : $curfontname;
$fontstyle = isset ($dom[$key]['fontstyle']) ? $dom[$key]['fontstyle'] : $curfontstyle;
$fontsize = isset ($dom[$key]['fontsize']) ? $dom[$key]['fontsize'] : $curfontsize;
$fontascent = $this->getFontAscent($fontname, $fontstyle, $fontsize);
$fontdescent = $this->getFontDescent($fontname, $fontstyle, $fontsize);
if (($fontname != $curfontname) OR ($fontstyle != $curfontstyle) OR ($fontsize != $curfontsize) OR ($this->cell_height_ratio != $dom[$key]['line-height'])) {
if ((!$this->newline) AND ($key < ($maxel - 1))
AND ((is_numeric($fontsize) AND ($fontsize >= 0) AND is_numeric($curfontsize) AND ($curfontsize >= 0) AND ($fontsize != $curfontsize))
if ($this->page > $startlinepage) {
// fix lines splitted over two pages
if (isset ($this->footerlen[$startlinepage])) {
// line to be moved one page forward
$linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
$tstart = substr($pagebuff, 0, $startlinepos);
// remove line start from previous page
// add line start to current page
$yshift = $minstartliney - $this->y;
$try = sprintf('1 0 0 1 0 %.3F cm', ($yshift * $this->k));
// shift the annotations and links
foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
$startlinepage = $this->page;
if (!isset ($dom[$key]['line-height'])) {
if (!$dom[$key]['block']) {
$this->y += (((($curfontsize * $this->cell_height_ratio ) - ($fontsize * $dom[$key]['line-height'])) / $this->k) + $curfontascent - $fontascent - $curfontdescent + $fontdescent) / 2;
if (($dom[$key]['value'] != 'sup') AND ($dom[$key]['value'] != 'sub')) {
$minstartliney = min($this->y, $minstartliney);
$this->SetFont($fontname, $fontstyle, $fontsize);
$curfontname = $fontname;
$curfontstyle = $fontstyle;
$curfontsize = $fontsize;
$curfontascent = $fontascent;
$curfontdescent = $fontdescent;
// set text rendering mode
$textstroke = isset ($dom[$key]['stroke']) ? $dom[$key]['stroke'] : $this->textstrokewidth;
$textfill = isset ($dom[$key]['fill']) ? $dom[$key]['fill'] : (($this->textrendermode % 2) == 0);
$textclip = isset ($dom[$key]['clip']) ? $dom[$key]['clip'] : ($this->textrendermode > 3);
if (isset ($dom[$key]['font-stretch']) AND ($dom[$key]['font-stretch'] !== false)) {
if (isset ($dom[$key]['letter-spacing']) AND ($dom[$key]['letter-spacing'] !== false)) {
if (($plalign == 'J') AND $dom[$key]['block']) {
// get current position on page buffer
$curpos = $this->pagelen[$startlinepage];
if (isset ($dom[$key]['bgcolor']) AND ($dom[$key]['bgcolor'] !== false)) {
if (isset ($dom[$key]['fgcolor']) AND ($dom[$key]['fgcolor'] !== false)) {
if (isset ($dom[$key]['strokecolor']) AND ($dom[$key]['strokecolor'] !== false)) {
if (isset ($dom[$key]['align'])) {
$lalign = $dom[$key]['align'];
if ($this->newline AND (strlen($dom[$key]['value']) > 0) AND ($dom[$key]['value'] != 'td') AND ($dom[$key]['value'] != 'th')) {
// we are at the beginning of a new line
if (isset ($startlinex)) {
$yshift = $minstartliney - $startliney;
if (($yshift > 0) OR ($this->page > $startlinepage)) {
// the last line must be shifted to be aligned as requested
// we are inside an XObject template
if (isset ($opentagpos)) {
$pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
if (isset ($opentagpos) AND isset ($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
$midpos = min($opentagpos, $this->footerpos[$startlinepage]);
} elseif (isset ($opentagpos)) {
$pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
if ((isset ($plalign) AND ((($plalign == 'C') OR ($plalign == 'J') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
// calculate shifting amount
if ($this->lMargin != $prevlMargin) {
$tw += ($prevlMargin - $this->lMargin);
if ($this->rMargin != $prevrMargin) {
$tw += ($prevrMargin - $this->rMargin);
$no = 0; // number of spaces on a line contained on a single block
// remove left space if exist
$pmid = substr($pmid, 0, ($pos1 + 2)). substr($pmid, ($pos1 + 2 + $spacelen));
if (substr($pmid, $pos1, 4) == '[()]') {
$linew -= $one_space_width;
} elseif ($pos1 == strpos($pmid, '[(')) {
// remove right space if exist
$pmid = substr($pmid, 0, ($pos1 - $spacelen)). substr($pmid, $pos1);
$linew -= $one_space_width;
} elseif ($plalign == 'R') {
// right alignment on LTR document
} elseif ($plalign == 'L') {
// left alignment on RTL document
} elseif (($plalign == 'J') AND ($plalign == $lalign)) {
// align text on the left
$ns = 0; // number of spaces
// escape special characters
$pmidtemp = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmidtemp);
$pmidtemp = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmidtemp);
if (preg_match_all('/\[\(([^\)]*)\)\]/x', $pmidtemp, $lnstring, PREG_PATTERN_ORDER)) {
$maxkk = count($lnstring[1]) - 1;
for ($kk= 0; $kk <= $maxkk; ++ $kk) {
// restore special characters
$lnstring[1][$kk] = str_replace('#!#OP#!#', '(', $lnstring[1][$kk]);
$lnstring[1][$kk] = str_replace('#!#CP#!#', ')', $lnstring[1][$kk]);
// store number of spaces on the strings
$lnstring[2][$kk] = substr_count($lnstring[1][$kk], $spacestr);
// count total spaces on line
$ns += $lnstring[2][$kk];
// calculate additional space to add to each existing space
$spacewidth = ($mdiff / ($ns - $no)) * $this->k;
$spacewidthu = - 1000 * ($mdiff + (($ns + $no) * $one_space_width)) / $ns / $this->FontSize;
while (preg_match('/([0-9\.\+\-]*)[\s](Td|cm|m|l|c|re)[\s]/x', $pmid, $strpiece, PREG_OFFSET_CAPTURE, $offset) == 1) {
// check if we are inside a string section '[( ... )]'
$stroffset = strpos($pmid, '[(', $offset);
if (($stroffset !== false) AND ($stroffset <= $strpiece[2][1])) {
// set offset to the end of string section
$offset = strpos($pmid, ')]', $stroffset);
while (($offset !== false) AND ($pmid{($offset - 1)} == '\\')) {
$offset = strpos($pmid, ')]', ($offset + 1));
$this->Error('HTML Justification: malformed PDF code.');
$spacew = ($spacewidth * ($nsmax - $ns));
$spacew = ($spacewidth * $ns);
$offset = $strpiece[2][1] + strlen($strpiece[2][0]);
if ((($epsposbeg > 0) AND ($epsposend > 0) AND ($offset > $epsposbeg) AND ($offset < $epsposend))
OR (($epsposbeg === false) AND ($epsposend > 0) AND ($offset < $epsposend))) {
$trx = sprintf('1 0 0 1 %.3F 0 cm', $spacew);
$pmid_b = substr($pmid, 0, $epsposbeg);
$pmid_m = substr($pmid, $epsposbeg, ($epsposend - $epsposbeg));
$pmid_e = substr($pmid, $epsposend);
$pmid = $pmid_b. "\nq\n". $trx. "\n". $pmid_m. "\nQ\n". $pmid_e;
$prev_epsposbeg = $epsposbeg;
switch ($strpiece[2][0]) {
// get current X position
preg_match('/([0-9\.\+\-]*)[\s]('. $strpiece[1][0]. ')[\s]('. $strpiece[2][0]. ')([\s]*)/x', $pmid, $xmatches);
$currentxpos = $xmatches[1];
if (($strcount <= $maxkk) AND ($strpiece[2][0] == 'Td')) {
$ns = $lnstring[3][$strcount];
$spacew = ($spacewidth * ($nsmax - $ns));
$pmid = preg_replace_callback('/([0-9\.\+\-]*)[\s]('. $strpiece[1][0]. ')[\s]('. $strpiece[2][0]. ')([\s]*)/x',
$newx = sprintf("%.2F",(floatval($matches[1]) + $spacew));
return "".$newx." ".$matches[2]." x*#!#*x".$matches[3].$matches[4];'), $pmid, 1);
preg_match('/([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]('. $strpiece[1][0]. ')[\s](re)([\s]*)/x', $pmid, $xmatches);
$currentxpos = $xmatches[1];
if ($currentxpos < $textpos) {
$x_diff = ($spacewidth * ($nsmax - $lnstring[3][$strcount]));
$w_diff = ($spacewidth * $lnstring[2][$strcount]);
$x_diff = ($spacewidth * ($nsmax - $lnstring[3][($strcount - 1)]));
$w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
if ($currentxpos > $textpos) {
$x_diff = ($spacewidth * $lnstring[3][($strcount - 1)]);
$w_diff = ($spacewidth * $lnstring[2][$strcount]);
$x_diff = ($spacewidth * $lnstring[3][($strcount - 2)]);
$w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
$pmid = preg_replace_callback('/('. $xmatches[1]. ')[\s]('. $xmatches[2]. ')[\s]('. $xmatches[3]. ')[\s]('. $strpiece[1][0]. ')[\s](re)([\s]*)/x',
$newx = sprintf("%.2F",(floatval($matches[1]) + $x_diff));
$neww = sprintf("%.2F",(floatval($matches[3]) + $w_diff));
return "".$newx." ".$matches[2]." ".$neww." ".$matches[4]." x*#!#*x".$matches[5].$matches[6];'), $pmid, 1);
// get current X position
preg_match('/([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]('. $strpiece[1][0]. ')[\s](c)([\s]*)/x', $pmid, $xmatches);
$currentxpos = $xmatches[1];
$pmid = preg_replace_callback('/('. $xmatches[1]. ')[\s]('. $xmatches[2]. ')[\s]('. $xmatches[3]. ')[\s]('. $xmatches[4]. ')[\s]('. $xmatches[5]. ')[\s]('. $strpiece[1][0]. ')[\s](c)([\s]*)/x',
$newx1 = sprintf("%.3F",(floatval($matches[1]) + $spacew));
$newx2 = sprintf("%.3F",(floatval($matches[3]) + $spacew));
$newx3 = sprintf("%.3F",(floatval($matches[5]) + $spacew));
return "".$newx1." ".$matches[2]." ".$newx2." ".$matches[4]." ".$newx3." ".$matches[6]." x*#!#*x".$matches[7].$matches[8];'), $pmid, 1);
// shift the annotations and links
$cxpos = ($currentxpos / $this->k);
// we are inside an XObject template
foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
$this->xobjects[$this->xobjid]['annotations'][$pak]['x'] += ($spacew / $this->k);
$this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
$this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
$this->PageAnnots[$this->page][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
$this->PageAnnots[$this->page][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
// word spacing is affected by stretching
// escape special characters
$pmidtemp = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmidtemp);
$pmidtemp = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmidtemp);
$matches[1] = str_replace("#!#OP#!#", "(", $matches[1]);
$matches[1] = str_replace("#!#CP#!#", ")", $matches[1]);
return "[(".str_replace(chr(0).chr(32), ") ".sprintf("%.3F", $spacew)." (", $matches[1]).")]";'), $pmidtemp);
// we are inside an XObject template
$this->xobjects[$this->xobjid]['outdata'] = $pstart. "\n". $pmid. "\n". $pend;
$this->setPageBuffer($startlinepage, $pstart. "\n". $pmid. "\n". $pend);
$endlinepos = strlen($pstart. "\n". $pmid. "\n");
// non-unicode (single-byte characters)
// word spacing (Tw) is affected by stretching
$rs = sprintf('%.3F Tw', $spacewidth);
// we are inside an XObject template
$this->xobjects[$this->xobjid]['outdata'] = $pstart. "\n". $pmid. "\nBT 0 Tw ET\n". $pend;
$this->setPageBuffer($startlinepage, $pstart. "\n". $pmid. "\nBT 0 Tw ET\n". $pend);
$endlinepos = strlen($pstart. "\n". $pmid. "\nBT 0 Tw ET\n");
if (($t_x != 0) OR ($yshift < 0)) {
$trx = sprintf('1 0 0 1 %.3F %.3F cm', ($t_x * $this->k), ($yshift * $this->k));
$pstart .= "\nq\n". $trx. "\n". $pmid. "\nQ\n";
$endlinepos = strlen($pstart);
// we are inside an XObject template
foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
// shift the annotations and links
if ($dom[$dom[$key]['parent']]['value'] == 'sup') {
} elseif ($dom[$dom[$key]['parent']]['value'] == 'sub') {
$minstartliney = $startliney;
$startlinepage = $this->page;
if (isset ($endlinepos) AND (!$pbrk)) {
$startlinepos = $endlinepos;
// we are inside an XObject template
if (!($dom[$key]['tag'] AND !$dom[$key]['opening'] AND ($dom[$key]['value'] == 'table') AND ($this->emptypagemrk[$this->page] == $this->pagelen[$this->page]))) {
$this->SetFont($fontname, $fontstyle, $fontsize);
if (isset ($opentagpos)) {
if ($dom[$key]['opening']) {
// get text indentation (if any)
if (isset ($dom[$key]['text-indent']) AND $dom[$key]['block']) {
if ($dom[$key]['value'] == 'table') {
$wtmp = $this->w - $this->rMargin - $this->x;
if (isset ($dom[$key]['attribute']['cellspacing'])) {
$cellspacing = $this->getHTMLUnitToUnits($dom[$key]['attribute']['cellspacing'], 1, 'px');
if (isset ($dom[$key]['width'])) {
$table_width -= (2 * $cellspacing);
$this->y += $cellspacing;
$cellspacingx = - $cellspacing;
$cellspacingx = $cellspacing;
// total table width without cellspaces
$table_columns_width = ($table_width - ($cellspacing * ($dom[$key]['cols'] - 1)));
$table_min_column_width = ($table_columns_width / $dom[$key]['cols']);
// array of custom column widths
$table_colwidths = array_fill(0, $dom[$key]['cols'], $table_min_column_width);
if ($dom[$key]['value'] == 'tr') {
if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
$trid = $dom[$key]['parent'];
$table_el = $dom[$trid]['parent'];
if (!isset ($dom[$table_el]['cols'])) {
$dom[$table_el]['cols'] = $dom[$trid]['cols'];
if (isset ($dom[$key]['border']) AND !empty($dom[$key]['border'])) {
$tdborder = $dom[$key]['border'];
$colspan = $dom[$key]['attribute']['colspan'];
if (isset ($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'])) {
$current_cell_padding = $this->getHTMLUnitToUnits($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'], 1, 'px');
$current_cell_padding = 0;
if (isset ($dom[$key]['height'])) {
if (isset ($dom[$key]['content'])) {
$cell_content = $dom[$key]['content'];
$cell_content = ' ';
$tagtype = $dom[$key]['value'];
while (($key < $maxel) AND (!(($dom[$key]['tag']) AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == $tagtype) AND ($dom[$key]['parent'] == $parentid)))) {
// move $key index forward
if (!isset ($dom[$trid]['startpage'])) {
$dom[$trid]['startpage'] = $this->page;
$this->setPage($dom[$trid]['startpage']);
if (!isset ($dom[$trid]['startcolumn'])) {
if (!isset ($dom[$trid]['starty'])) {
$dom[$trid]['starty'] = $this->y;
$this->y = $dom[$trid]['starty'];
if (!isset ($dom[$trid]['startx'])) {
$dom[$trid]['startx'] = $this->x;
$this->x += $cellspacingx;
$this->x += ($cellspacingx / 2);
if (isset ($dom[$parentid]['attribute']['rowspan'])) {
$rowspan = intval($dom[$parentid]['attribute']['rowspan']);
// skip row-spanned cells started on the previous rows
if (isset ($dom[$table_el]['rowspans'])) {
$rskmax = count($dom[$table_el]['rowspans']);
$trwsp = $dom[$table_el]['rowspans'][$rsk];
$rsstartx = $trwsp['startx'];
$rsendx = $trwsp['endx'];
// account for margin changes
if ($trwsp['startpage'] < $this->page) {
if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$trwsp['startpage']]['orm'])) {
} elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$trwsp['startpage']]['olm'])) {
if (($trwsp['rowspan'] > 0)
AND ($rsstartx > ($this->x - $cellspacing - $current_cell_padding - $this->feps))
AND ($rsstartx < ($this->x + $cellspacing + $current_cell_padding + $this->feps))
AND (($trwsp['starty'] < ($this->y - $this->feps)) OR ($trwsp['startpage'] < $this->page) OR ($trwsp['startcolumn'] < $this->current_column))) {
// set the starting X position of the current cell
$this->x = $rsendx + $cellspacingx;
// increment column indicator
$colid += $trwsp['colspan'];
if (($trwsp['rowspan'] == 1)
AND (isset ($dom[$trid]['endy']))
AND (isset ($dom[$trid]['endpage']))
AND (isset ($dom[$trid]['endcolumn']))
AND ($trwsp['endpage'] == $dom[$trid]['endpage'])
AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
// set ending Y position for row
$dom[$table_el]['rowspans'][$rsk]['endy'] = max($dom[$trid]['endy'], $trwsp['endy']);
$dom[$trid]['endy'] = $dom[$table_el]['rowspans'][$rsk]['endy'];
if (isset ($dom[$parentid]['width'])) {
$tmpcw = ($cellw / $colspan);
for ($i = 0; $i < $colspan; ++ $i) {
$table_colwidths[($colid + $i)] = $tmpcw;
for ($i = 0; $i < $colspan; ++ $i) {
$cellw += $table_colwidths[($colid + $i)];
$cellw += (($colspan - 1) * $cellspacing);
// increment column indicator
// add rowspan information to table element
$trsid = array_push($dom[$table_el]['rowspans'], array('trid' => $trid, 'rowspan' => $rowspan, 'mrowspan' => $rowspan, 'colspan' => $colspan, 'startpage' => $this->page, 'startcolumn' => $this->current_column, 'startx' => $this->x, 'starty' => $this->y));
$cellid = array_push($dom[$trid]['cellpos'], array('startx' => $this->x));
$dom[$trid]['cellpos'][($cellid - 1)]['rowspanid'] = ($trsid - 1);
// push background colors
if (isset ($dom[$parentid]['bgcolor']) AND ($dom[$parentid]['bgcolor'] !== false)) {
$dom[$trid]['cellpos'][($cellid - 1)]['bgcolor'] = $dom[$parentid]['bgcolor'];
if (isset ($tdborder) AND !empty($tdborder)) {
$dom[$trid]['cellpos'][($cellid - 1)]['border'] = $tdborder;
$prevLastH = $this->lasth;
// store some info for multicolumn mode
$this->colxshift['p'] = $current_cell_padding;
// ****** write the cell content ******
$this->MultiCell($cellw, $cellh, $cell_content, false, $lalign, false, 2, '', '', true, 0, true);
$this->colxshift = array('x' => 0, 's' => 0, 'p' => 0);
$this->lasth = $prevLastH;
$dom[$trid]['cellpos'][($cellid - 1)]['endx'] = $this->x;
// update the end of row position
if (isset ($dom[$trid]['endy'])) {
if (($this->page == $dom[$trid]['endpage']) AND ($this->current_column == $dom[$trid]['endcolumn'])) {
$dom[$trid]['endy'] = max($this->y, $dom[$trid]['endy']);
} elseif (($this->page > $dom[$trid]['endpage']) OR ($this->current_column > $dom[$trid]['endcolumn'])) {
$dom[$trid]['endy'] = $this->y;
$dom[$trid]['endy'] = $this->y;
if (isset ($dom[$trid]['endpage'])) {
$dom[$trid]['endpage'] = max($this->page, $dom[$trid]['endpage']);
$dom[$trid]['endpage'] = $this->page;
if (isset ($dom[$trid]['endcolumn'])) {
// account for row-spanned cells
$dom[$table_el]['rowspans'][($trsid - 1)]['endx'] = $this->x;
$dom[$table_el]['rowspans'][($trsid - 1)]['endy'] = $this->y;
$dom[$table_el]['rowspans'][($trsid - 1)]['endpage'] = $this->page;
$dom[$table_el]['rowspans'][($trsid - 1)]['endcolumn'] = $this->current_column;
if (isset ($dom[$table_el]['rowspans'])) {
// update endy and endpage on rowspanned cells
foreach ($dom[$table_el]['rowspans'] as $k => $trwsp) {
if ($trwsp['rowspan'] > 0) {
if (isset ($dom[$trid]['endpage'])) {
if (($trwsp['endpage'] == $dom[$trid]['endpage']) AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
$dom[$table_el]['rowspans'][$k]['endy'] = max($dom[$trid]['endy'], $trwsp['endy']);
} elseif (($trwsp['endpage'] < $dom[$trid]['endpage']) OR ($trwsp['endcolumn'] < $dom[$trid]['endcolumn'])) {
$dom[$table_el]['rowspans'][$k]['endy'] = $dom[$trid]['endy'];
$dom[$table_el]['rowspans'][$k]['endpage'] = $dom[$trid]['endpage'];
$dom[$table_el]['rowspans'][$k]['endcolumn'] = $dom[$trid]['endcolumn'];
$dom[$trid]['endy'] = $this->pagedim[$dom[$trid]['endpage']]['hk'] - $this->pagedim[$dom[$trid]['endpage']]['bm'];
$this->x += ($cellspacingx / 2);
// opening tag (or self-closing tag)
if (!isset ($opentagpos)) {
// we are inside an XObject template
$startlinepos += ($this->bordermrk[$this->page] - $old_bordermrk);
$startlinepage = $this->page;
} elseif (strlen($dom[$key]['value']) > 0) {
$this->SetFont($pfontname, $pfontstyle, $pfontsize);
$minstartliney = $this->y;
$this->SetFont($curfontname, $curfontstyle, $curfontsize);
if (is_numeric($pfontsize) AND ($pfontsize > 0) AND is_numeric($curfontsize) AND ($curfontsize > 0) AND ($pfontsize != $curfontsize)) {
$pfontascent = $this->getFontAscent($pfontname, $pfontstyle, $pfontsize);
$pfontdescent = $this->getFontDescent($pfontname, $pfontstyle, $pfontsize);
$this->y += ((($pfontsize - $curfontsize) * $this->cell_height_ratio / $this->k) + $pfontascent - $curfontascent - $pfontdescent + $curfontdescent) / 2;
$minstartliney = min($this->y, $minstartliney);
$lsp = ''; // left spaces
$rsp = ''; // right spaces
$dom[$key]['value'] = $rsp. $this->stringTrim($dom[$key]['value']). $lsp;
$prelen = strlen($dom[$key]['value']);
// right trim except non-breaking space
// left trim except non-breaking space
$postlen = strlen($dom[$key]['value']);
if (($postlen == 0) AND ($prelen > 0)) {
$dom[$key]['trimmed_space'] = true;
// replace empty multiple spaces string with a single space
if (!isset ($dom[$key]['trimmed_space']) OR !$dom[$key]['trimmed_space']) {
if (!empty($this->HREF) AND (isset ($this->HREF['url']))) {
if (isset ($dom[($dom[$key]['parent'])]['fgcolor']) AND ($dom[($dom[$key]['parent'])]['fgcolor'] !== false)) {
$hrefcolor = $dom[($dom[$key]['parent'])]['fgcolor'];
if (isset ($dom[($dom[$key]['parent'])]['fontstyle']) AND ($dom[($dom[$key]['parent'])]['fontstyle'] !== false)) {
$hrefstyle = $dom[($dom[$key]['parent'])]['fontstyle'];
$strrest = $this->addHtmlLink($this->HREF['url'], $dom[$key]['value'], $wfill, true, $hrefcolor, $hrefstyle, true);
$wadj = 0; // space to leave for block continuity
$adjblks = 0; // number of blocks
// check the next text blocks for continuity
while ($write_block AND isset ($dom[$nkey])) {
if ($dom[$nkey]['tag']) {
if ($dom[$nkey]['block']) {
$tmp_fontname = isset ($dom[$nkey]['fontname']) ? $dom[$nkey]['fontname'] : $this->FontFamily;
$tmp_fontstyle = isset ($dom[$nkey]['fontstyle']) ? $dom[$nkey]['fontstyle'] : $this->FontStyle;
$tmp_fontsize = isset ($dom[$nkey]['fontsize']) ? $dom[$nkey]['fontsize'] : $this->FontSizePt;
if (isset ($nextstr[0])) {
$wadj += $this->GetStringWidth($nextstr[0], $tmp_fontname, $tmp_fontstyle, $tmp_fontsize);
if (isset ($nextstr[1])) {
// check for reversed text direction
if (($wadj > 0) AND (($this->rtl AND ($this->tmprtl == 'L')) OR (!$this->rtl AND ($this->tmprtl == 'R')))) {
// LTR text on RTL direction or RTL text on LTR direction
$revshift = ($this->GetStringWidth($dom[$key]['value']) + $wadj) + 0.000001; // add little quantity for rounding problems
// ****** write only until the end of the line and get the rest ******
$strrest = $this->Write($this->lasth, $dom[$key]['value'], '', $wfill, '', false, 0, true, $firstblock, 0, $wadj);
// restore default direction
if ($reverse_dir AND ($wadj == 0)) {
// store the remaining string on the previous $key position
if ($strrest == $dom[$key]['value']) {
// used to avoid infinite loop
$dom[$key]['value'] = $strrest;
if (isset ($dom[$key]['tag']) AND $dom[$key]['tag'] AND (!isset ($dom[$key]['opening']) OR !$dom[$key]['opening']) AND isset ($dom[($dom[$key]['parent'])]['attribute']['nobr']) AND ($dom[($dom[$key]['parent'])]['attribute']['nobr'] == 'true')) {
// check if we are on a new page or on a new column
// we are on a new page or on a new column and the total object height is less than the available vertical space.
// restore previous object
// restore previous values
foreach ($this_method_vars as $vkey => $vval) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
$undo = true; // avoid infinite loop
if (isset ($startlinex)) {
$yshift = $minstartliney - $startliney;
if (($yshift > 0) OR ($this->page > $startlinepage)) {
// the last line must be shifted to be aligned as requested
// we are inside an XObject template
if (isset ($opentagpos)) {
$pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
if (isset ($opentagpos) AND isset ($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
$midpos = min($opentagpos, $this->footerpos[$startlinepage]);
} elseif (isset ($opentagpos)) {
$pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
if ((isset ($plalign) AND ((($plalign == 'C') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
// calculate shifting amount
if ($this->lMargin != $prevlMargin) {
$tw += ($prevlMargin - $this->lMargin);
if ($this->rMargin != $prevrMargin) {
$tw += ($prevrMargin - $this->rMargin);
$no = 0; // number of spaces on a line contained on a single block
// remove left space if exist
$pmid = substr($pmid, 0, ($pos1 + 2)). substr($pmid, ($pos1 + 2 + $spacelen));
if (substr($pmid, $pos1, 4) == '[()]') {
$linew -= $one_space_width;
} elseif ($pos1 == strpos($pmid, '[(')) {
// remove right space if exist
$pmid = substr($pmid, 0, ($pos1 - $spacelen)). substr($pmid, $pos1);
$linew -= $one_space_width;
} elseif ($plalign == 'R') {
// right alignment on LTR document
} elseif ($plalign == 'L') {
// left alignment on RTL document
if (($t_x != 0) OR ($yshift < 0)) {
$trx = sprintf('1 0 0 1 %.3F %.3F cm', ($t_x * $this->k), ($yshift * $this->k));
$pstart .= "\nq\n". $trx. "\n". $pmid. "\nQ\n";
$endlinepos = strlen($pstart);
// we are inside an XObject template
foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
// shift the annotations and links
// restore previous values
} elseif ($this->page > $prevPage) {
// restore previous list state
if ($ln AND (!($cell AND ($dom[$key- 1]['value'] == 'table')))) {
if ($this->y < $maxbottomliney) {
$this->y = $maxbottomliney;
* @param array $dom html dom array
* @param int $key current element id
* @param boolean $cell if true add the default left (or right if RTL) padding to each new line (default false).
$parent = $dom[($dom[$key]['parent'])];
// check for text direction attribute
if (isset ($tag['dir'])) {
$hbz = 0; // distance from y to line bottom
$hb = 0; // vertical space between block tags
// calculate vertical space for block tags
if (isset ($this->tagvspaces[$tag['value']][0]['h']) AND ($this->tagvspaces[$tag['value']][0]['h'] >= 0)) {
$cur_h = $this->tagvspaces[$tag['value']][0]['h'];
} elseif (isset ($tag['fontsize'])) {
if (isset ($this->tagvspaces[$tag['value']][0]['n'])) {
} elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
if (isset ($parent['fontsize'])) {
$dom[$key]['rowspans'] = array();
if (!isset ($dom[$key]['attribute']['nested']) OR ($dom[$key]['attribute']['nested'] != 'true')) {
$this->thead = $dom[$key]['thead'];
// store current margins and page
if (isset ($tag['attribute']['cellpadding'])) {
if (isset ($tag['attribute']['cellspacing'])) {
if ($this->checkPageBreak(((2 * $cp) + (2 * $cs) + $this->lasth), '', false) OR ($this->y < $prev_y)) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
// array of columns positions
$dom[$key]['cellpos'] = array();
if ((isset ($tag['height'])) AND ($tag['height'] != '')) {
if ((isset ($tag['width'])) AND ($tag['width'] != '')) {
$this->Line($x, $y, $x + $hrWidth, $y);
$this->HREF['url'] = $tag['attribute']['href'];
if (isset ($tag['attribute']['src'])) {
// replace relative path with real server path
if (($tag['attribute']['src'][0] == '/') AND ($_SERVER['DOCUMENT_ROOT'] != '/')) {
$findroot = strpos($tag['attribute']['src'], $_SERVER['DOCUMENT_ROOT']);
if (($findroot === false) OR ($findroot > 1)) {
$tag['attribute']['src'] = $_SERVER['DOCUMENT_ROOT']. $tag['attribute']['src'];
$tag['attribute']['src'] = urldecode($tag['attribute']['src']);
$testscrtype = @parse_url($tag['attribute']['src']);
if (!isset ($testscrtype['query']) OR empty($testscrtype['query'])) {
// convert URL to server path
if (!isset ($tag['width'])) {
if (!isset ($tag['height'])) {
//if (!isset($tag['attribute']['align'])) {
// the only alignment supported is "bottom"
// further development is required for other modes.
$tag['attribute']['align'] = 'bottom';
switch($tag['attribute']['align']) {
// eliminate marker spaces
if (isset ($dom[($key - 1)])) {
if (($dom[($key - 1)]['value'] == ' ') OR (isset ($dom[($key - 1)]['trimmed_space']))) {
} elseif ($this->rtl AND $dom[($key - 1)]['value'] == ' ') {
$imglink = $this->HREF['url'];
if ($imglink{0} == '#') {
// convert url to internal link
if (isset ($lnkdata[0])) {
if (empty($page) OR ($page <= 0)) {
if (isset ($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
$this->SetLink($imglink, $lnky, $page);
if (isset ($tag['border']) AND !empty($tag['border'])) {
// currently only support 1 (frame) or a combination of 'LTRB'
$border = $tag['border'];
if (isset ($tag['width'])) {
if (isset ($tag['height'])) {
if (($type == 'eps') OR ($type == 'ai')) {
$this->ImageEps($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, true, $align, '', $border, true);
} elseif ($type == 'svg') {
$this->ImageSVG($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, $align, '', $border, true);
$this->Image($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, '', $imglink, $align, false, 300, '', false, false, $border, false, false, true);
$this->y = (($this->img_rb_y + $prevy - ($tag['fontsize'] / $this->k)) / 2) ;
$this->y = $this->img_rb_y - ($tag['fontsize'] / $this->k);
if ($tag['value'] == 'ol') {
if (isset ($tag['attribute']['start'])) {
if (isset ($parent['attribute']['type']) AND !$this->empty_string($parent['attribute']['type'])) {
$this->lispacer = $parent['attribute']['type'];
} elseif (isset ($parent['listtype']) AND !$this->empty_string($parent['listtype'])) {
if (isset ($tag['attribute']['value'])) {
if (isset ($parent['attribute']['type']) AND !$this->empty_string($parent['attribute']['type'])) {
$this->lispacer = $parent['attribute']['type'];
} elseif (isset ($parent['listtype']) AND !$this->empty_string($parent['listtype'])) {
// Form fields (since 4.8.000 - 2009-09-07)
if (isset ($tag['attribute']['action'])) {
if (isset ($tag['attribute']['enctype'])) {
if (isset ($tag['attribute']['method'])) {
$this->form_mode = $tag['attribute']['method'];
if (isset ($tag['attribute']['name']) AND !$this->empty_string($tag['attribute']['name'])) {
$name = $tag['attribute']['name'];
if (isset ($tag['attribute']['readonly']) AND !$this->empty_string($tag['attribute']['readonly'])) {
$prop['readonly'] = true;
if (isset ($tag['attribute']['value']) AND !$this->empty_string($tag['attribute']['value'])) {
$value = $tag['attribute']['value'];
if (isset ($tag['attribute']['maxlength']) AND !$this->empty_string($tag['attribute']['maxlength'])) {
$opt['maxlen'] = intval($tag['attribute']['value']);
if (isset ($tag['attribute']['size']) AND !$this->empty_string($tag['attribute']['size'])) {
if (isset ($tag['attribute']['checked']) AND (($tag['attribute']['checked'] == 'checked') OR ($tag['attribute']['checked'] == 'true'))) {
switch ($tag['attribute']['type']) {
$this->TextField($name, $w, $h, $prop, $opt, '', '', false);
$prop['password'] = 'true';
$this->TextField($name, $w, $h, $prop, $opt, '', '', false);
$this->CheckBox($name, $w, $checked, $prop, $opt, $value, '', '', false);
$this->RadioButton($name, $w, $prop, $opt, $value, $checked, '', '', false);
$prop = array('lineWidth'=> 1, 'borderStyle'=> 'beveled', 'fillColor'=> array(196, 196, 196), 'strokeColor'=> array(255, 255, 255));
$action['S'] = 'SubmitForm';
$action['Flags'] = array('ExportFormat');
$action['Flags'] = array('GetMethod');
$this->Button($name, $w, $h, $value, $action, $prop, $opt, '', '', false);
$prop = array('lineWidth'=> 1, 'borderStyle'=> 'beveled', 'fillColor'=> array(196, 196, 196), 'strokeColor'=> array(255, 255, 255));
$this->Button($name, $w, $h, $value, array('S'=> 'ResetForm'), $prop, $opt, '', '', false);
$prop['fileSelect'] = 'true';
$this->TextField($name, $w, $h, $prop, $opt, '', '', false);
$prop = array('lineWidth'=> 1, 'borderStyle'=> 'beveled', 'fillColor'=> array(196, 196, 196), 'strokeColor'=> array(255, 255, 255));
$jsaction = 'var f=this.getField(\''. $name. '\'); f.browseForFileToSubmit();';
$this->Button('FB_'. $name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
$opt['f'] = array('invisible', 'hidden');
$this->TextField($name, 0, 0, $prop, $opt, '', '', false);
// THIS TYPE MUST BE FIXED
if (isset ($tag['attribute']['src']) AND !$this->empty_string($tag['attribute']['src'])) {
$img = $tag['attribute']['src'];
//$opt['mk'] = array('i'=>$img, 'tp'=>1, 'if'=>array('sw'=>'A', 's'=>'A', 'fb'=>false));
if (isset ($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
$jsaction = $tag['attribute']['onclick'];
$this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
$prop = array('lineWidth'=> 1, 'borderStyle'=> 'beveled', 'fillColor'=> array(196, 196, 196), 'strokeColor'=> array(255, 255, 255));
if (isset ($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
$jsaction = $tag['attribute']['onclick'];
$this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
if (isset ($tag['attribute']['readonly']) AND !$this->empty_string($tag['attribute']['readonly'])) {
$prop['readonly'] = true;
if (isset ($tag['attribute']['name']) AND !$this->empty_string($tag['attribute']['name'])) {
$name = $tag['attribute']['name'];
if (isset ($tag['attribute']['value']) AND !$this->empty_string($tag['attribute']['value'])) {
$opt['v'] = $tag['attribute']['value'];
if (isset ($tag['attribute']['cols']) AND !$this->empty_string($tag['attribute']['cols'])) {
if (isset ($tag['attribute']['rows']) AND !$this->empty_string($tag['attribute']['rows'])) {
$prop['multiline'] = 'true';
$this->TextField($name, $w, $h, $prop, $opt, '', '', false);
if (isset ($tag['attribute']['size']) AND !$this->empty_string($tag['attribute']['size'])) {
$h *= ($tag['attribute']['size'] + 1);
if (isset ($tag['attribute']['name']) AND !$this->empty_string($tag['attribute']['name'])) {
$name = $tag['attribute']['name'];
if (isset ($tag['attribute']['opt']) AND !$this->empty_string($tag['attribute']['opt'])) {
$options = explode('#!NwL!#', $tag['attribute']['opt']);
foreach ($options as $val) {
if (strpos($val, '#!TaB!#') !== false) {
if (isset ($tag['attribute']['multiple']) AND ($tag['attribute']['multiple']= 'multiple')) {
$prop['multipleSelection'] = 'true';
$this->ListBox($name, $w, $h, $values, $prop, $opt, '', '', false);
$this->ComboBox($name, $w, $h, $values, $prop, $opt, '', '', false);
// Special tag used to call TCPDF methods
if (isset ($tag['attribute']['method'])) {
$tcpdf_method = $tag['attribute']['method'];
if (isset ($tag['attribute']['params']) AND (!empty($tag['attribute']['params']))) {
// define tags that support borders and background colors
$bordertags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table');
if (in_array($tag['value'], $bordertags)) {
if ($dom[$key]['self'] AND isset ($dom[$key]['attribute']['pagebreakafter'])) {
$pba = $dom[$key]['attribute']['pagebreakafter'];
if (($pba == 'true') OR ($pba == 'left') OR ($pba == 'right')) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
* @param array $dom html dom array
* @param int $key current element id
* @param boolean $cell if true add the default left (or right if RTL) padding to each new line (default false).
* @param int $maxbottomliney maximum y value of current line
$parent = $dom[($dom[$key]['parent'])];
$lasttag = ((!isset ($dom[($key + 1)])) OR ((!isset ($dom[($key + 2)])) AND ($dom[($key + 1)]['value'] == 'marker')));
// maximum x position (used to draw borders)
$hbz = 0; // distance from y to line bottom
$hb = 0; // vertical space between block tags
// calculate vertical space for block tags
if (isset ($this->tagvspaces[$tag['value']][1]['h']) AND ($this->tagvspaces[$tag['value']][1]['h'] >= 0)) {
$pre_h = $this->tagvspaces[$tag['value']][1]['h'];
} elseif (isset ($parent['fontsize'])) {
if (isset ($this->tagvspaces[$tag['value']][1]['n'])) {
} elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
if ($this->y < $maxbottomliney) {
$hbz = ($maxbottomliney - $this->y);
$table_el = $dom[($dom[$key]['parent'])]['parent'];
if (!isset ($parent['endy'])) {
$dom[($dom[$key]['parent'])]['endy'] = $this->y;
$parent['endy'] = $this->y;
if (!isset ($parent['endpage'])) {
$dom[($dom[$key]['parent'])]['endpage'] = $this->page;
$parent['endpage'] = $this->page;
if (!isset ($parent['endcolumn'])) {
// update row-spanned cells
if (isset ($dom[$table_el]['rowspans'])) {
foreach ($dom[$table_el]['rowspans'] as $k => $trwsp) {
$dom[$table_el]['rowspans'][$k]['rowspan'] -= 1;
if ($dom[$table_el]['rowspans'][$k]['rowspan'] == 0) {
if (($dom[$table_el]['rowspans'][$k]['endpage'] == $parent['endpage']) AND ($dom[$table_el]['rowspans'][$k]['endcolumn'] == $parent['endcolumn'])) {
$dom[($dom[$key]['parent'])]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $parent['endy']);
} elseif (($dom[$table_el]['rowspans'][$k]['endpage'] > $parent['endpage']) OR ($dom[$table_el]['rowspans'][$k]['endcolumn'] > $parent['endcolumn'])) {
$dom[($dom[$key]['parent'])]['endy'] = $dom[$table_el]['rowspans'][$k]['endy'];
$dom[($dom[$key]['parent'])]['endpage'] = $dom[$table_el]['rowspans'][$k]['endpage'];
$dom[($dom[$key]['parent'])]['endcolumn'] = $dom[$table_el]['rowspans'][$k]['endcolumn'];
// report new endy and endpage to the rowspanned cells
foreach ($dom[$table_el]['rowspans'] as $k => $trwsp) {
if ($dom[$table_el]['rowspans'][$k]['rowspan'] == 0) {
$dom[$table_el]['rowspans'][$k]['endpage'] = max($dom[$table_el]['rowspans'][$k]['endpage'], $dom[($dom[$key]['parent'])]['endpage']);
$dom[($dom[$key]['parent'])]['endpage'] = $dom[$table_el]['rowspans'][$k]['endpage'];
$dom[$table_el]['rowspans'][$k]['endcolumn'] = max($dom[$table_el]['rowspans'][$k]['endcolumn'], $dom[($dom[$key]['parent'])]['endcolumn']);
$dom[($dom[$key]['parent'])]['endcolumn'] = $dom[$table_el]['rowspans'][$k]['endcolumn'];
$dom[$table_el]['rowspans'][$k]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $dom[($dom[$key]['parent'])]['endy']);
$dom[($dom[$key]['parent'])]['endy'] = $dom[$table_el]['rowspans'][$k]['endy'];
// update remaining rowspanned cells
foreach ($dom[$table_el]['rowspans'] as $k => $trwsp) {
if ($dom[$table_el]['rowspans'][$k]['rowspan'] == 0) {
$dom[$table_el]['rowspans'][$k]['endpage'] = $dom[($dom[$key]['parent'])]['endpage'];
$dom[$table_el]['rowspans'][$k]['endcolumn'] = $dom[($dom[$key]['parent'])]['endcolumn'];
$dom[$table_el]['rowspans'][$k]['endy'] = $dom[($dom[$key]['parent'])]['endy'];
$this->setPage($dom[($dom[$key]['parent'])]['endpage']);
$this->selectColumn($dom[($dom[$key]['parent'])]['endcolumn']);
$this->y = $dom[($dom[$key]['parent'])]['endy'];
if (isset ($dom[$table_el]['attribute']['cellspacing'])) {
$cellspacing = $this->getHTMLUnitToUnits($dom[$table_el]['attribute']['cellspacing'], 1, 'px');
$this->y += $cellspacing;
$this->x = $parent['startx'];
// account for booklet mode
if ($this->page > $parent['startpage']) {
if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$parent['startpage']]['orm'])) {
$this->x -= ($this->pagedim[$this->page]['orm'] - $this->pagedim[$parent['startpage']]['orm']);
} elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$parent['startpage']]['olm'])) {
$this->x += ($this->pagedim[$this->page]['olm'] - $this->pagedim[$parent['startpage']]['olm']);
// closing tag used for the thead part
if (isset ($table_el['attribute']['border']) AND ($table_el['attribute']['border'] > 0)) {
$border = array('LTRB' => array('width' => $this->getCSSBorderWidth($table_el['attribute']['border']), 'cap'=> 'square', 'join'=> 'miter', 'dash'=> 0, 'color'=> array(0,0,0)));
$default_border = $border;
if (isset ($table_el['attribute']['cellspacing'])) {
// fix bottom line alignment of last line before page break
foreach ($dom[($dom[$key]['parent'])]['trids'] as $j => $trkey) {
// update row-spanned cells
if (isset ($dom[($dom[$key]['parent'])]['rowspans'])) {
foreach ($dom[($dom[$key]['parent'])]['rowspans'] as $k => $trwsp) {
if ($trwsp['trid'] == $trkey) {
$dom[($dom[$key]['parent'])]['rowspans'][$k]['mrowspan'] -= 1;
if (isset ($prevtrkey) AND ($trwsp['trid'] == $prevtrkey) AND ($trwsp['mrowspan'] >= 0)) {
$dom[($dom[$key]['parent'])]['rowspans'][$k]['trid'] = $trkey;
if (isset ($prevtrkey) AND ($dom[$trkey]['startpage'] > $dom[$prevtrkey]['endpage'])) {
$pgendy = $this->pagedim[$dom[$prevtrkey]['endpage']]['hk'] - $this->pagedim[$dom[$prevtrkey]['endpage']]['bm'];
$dom[$prevtrkey]['endy'] = $pgendy;
// update row-spanned cells
if (isset ($dom[($dom[$key]['parent'])]['rowspans'])) {
foreach ($dom[($dom[$key]['parent'])]['rowspans'] as $k => $trwsp) {
if (($trwsp['trid'] == $trkey) AND ($trwsp['mrowspan'] > 1) AND ($trwsp['endpage'] == $dom[$prevtrkey]['endpage'])) {
$dom[($dom[$key]['parent'])]['rowspans'][$k]['endy'] = $pgendy;
$dom[($dom[$key]['parent'])]['rowspans'][$k]['mrowspan'] = - 1;
$table_el = $dom[($dom[$key]['parent'])];
foreach ($table_el['trids'] as $j => $trkey) {
$xmax = $parent['cellpos'][(count($parent['cellpos']) - 1)]['endx'];
// for each cell on the row
foreach ($parent['cellpos'] as $k => $cellpos) {
if (isset ($cellpos['rowspanid']) AND ($cellpos['rowspanid'] >= 0)) {
$cellpos['startx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['startx'];
$cellpos['endx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['endx'];
$endy = $table_el['rowspans'][($cellpos['rowspanid'])]['endy'];
$startpage = $table_el['rowspans'][($cellpos['rowspanid'])]['startpage'];
$endpage = $table_el['rowspans'][($cellpos['rowspanid'])]['endpage'];
$startcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['startcolumn'];
$endcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['endcolumn'];
$startpage = $parent['startpage'];
$endpage = $parent['endpage'];
$startcolumn = $parent['startcolumn'];
$endcolumn = $parent['endcolumn'];
if (isset ($cellpos['border'])) {
$border = $cellpos['border'];
if (isset ($cellpos['bgcolor']) AND ($cellpos['bgcolor']) !== false) {
$w = abs($cellpos['endx'] - $cellpos['startx']);
$border_start = $this->getBorderMode($border, $position= 'start');
$border_middle = $this->getBorderMode($border, $position= 'middle');
// design borders around HTML cells.
for ($page = $startpage; $page <= $endpage; ++ $page) { // for each page
// account for margin changes
if ($page > $startpage) {
if (($this->rtl) AND ($this->pagedim[$page]['orm'] != $this->pagedim[$startpage]['orm'])) {
$this->x -= ($this->pagedim[$page]['orm'] - $this->pagedim[$startpage]['orm']);
} elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
$this->x += ($this->pagedim[$page]['olm'] - $this->pagedim[$startpage]['olm']);
if ($startpage == $endpage) { // single page
for ($column = $startcolumn; $column <= $endcolumn; ++ $column) { // for each column
if ($startcolumn == $endcolumn) { // single column
$h = $endy - $parent['starty'];
} elseif ($column == $startcolumn) { // first column
$cborder = $border_start;
$deltacol = $this->x + $this->rMargin - $this->w;
} elseif ($column == $endcolumn) { // end column
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
} else { // middle column
$cborder = $border_middle;
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $startpage) { // first page
for ($column = $startcolumn; $column < $this->num_columns; ++ $column) { // for each column
if ($column == $startcolumn) { // first column
$cborder = $border_start;
$deltacol = $this->x + $this->rMargin - $this->w;
} else { // middle column
$cborder = $border_middle;
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $endpage) { // last page
for ($column = 0; $column <= $endcolumn; ++ $column) { // for each column
if ($column == $endcolumn) { // end column
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
} else { // middle column
$cborder = $border_middle;
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
for ($column = 0; $column < $this->num_columns; ++ $column) { // for each column
$cborder = $border_middle;
if (isset ($this->columns[$column]['th']['\''. $page. '\''])) {
$this->y = $this->columns[$column]['th']['\''. $page. '\''];
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
// we are inside an XObject template
$pagemark = &$this->xobjects[$this->xobjid]['transfmrk'][$pagemarkkey];
$pstart = substr($pagebuff, 0, $pagemark);
$pend = substr($pagebuff, $pagemark);
$pstart = substr($pagebuff, 0, $pagemark);
$pend = substr($pagebuff, $pagemark);
// restore default border
$border = $default_border;
} // end for each cell on the row
if (isset ($table_el['attribute']['cellspacing'])) {
$this->y += $cellspacing;
$this->x = $parent['startx'];
if ($endpage > $startpage) {
if (($this->rtl) AND ($this->pagedim[$endpage]['orm'] != $this->pagedim[$startpage]['orm'])) {
$this->x += ($this->pagedim[$endpage]['orm'] - $this->pagedim[$startpage]['orm']);
} elseif ((!$this->rtl) AND ($this->pagedim[$endpage]['olm'] != $this->pagedim[$startpage]['olm'])) {
$this->x += ($this->pagedim[$endpage]['olm'] - $this->pagedim[$startpage]['olm']);
if (!$in_table_head) { // we are not inside a thead section
// remove last blank page
if (!isset ($table_el['attribute']['nested']) OR ($table_el['attribute']['nested'] != 'true')) {
// reset main table header
$this->SetXY($this->GetX(), $this->GetY() + ((0.7 * $parent['fontsize']) / $this->k));
$this->SetXY($this->GetX(), $this->GetY() - ((0.3 * $parent['fontsize'])/ $this->k));
// Form fields (since 4.8.000 - 2009-09-07)
// draw border and background (if any)
if (isset ($dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'])) {
$pba = $dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'];
if (($pba == 'true') OR ($pba == 'left') OR ($pba == 'right')) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
// add a page (or trig AcceptPageBreak() for multicolumn mode)
* Add vertical spaces if needed.
* @param string $hbz Distance between current y and line bottom.
* @param string $hb The height of the break.
* @param boolean $cell if true add the default left (or right if RTL) padding to each new line (default false).
* @param boolean $firsttag set to true when the tag is the first.
* @param boolean $lasttag set to true when the tag is the last.
protected function addHTMLVertSpace($hbz= 0, $hb= 0, $cell= false, $firsttag= false, $lasttag= false) {
$this->Ln(($hbz + $hd), $cell);
* Return the starting coordinates to draw an html border
* @return array containing top-left border coordinates
* @since 5.7.000 (2010-08-03)
return array('page' => $this->page, 'column' => $this->current_column, 'x' => $this->x, 'y' => $this->y, 'xmax' => $xmax);
* Draw an HTML block border and fill
* @param array $tag array of tag properties.
* @param int $xmax end X coordinate for border.
* @since 5.7.000 (2010-08-03)
if (!isset ($tag['borderposition'])) {
$prev_lasth = $this->lasth;
if (isset ($tag['border']) AND !empty($tag['border'])) {
$border = $tag['border'];
// border for table header
if (isset ($tag['bgcolor']) AND ($tag['bgcolor'] !== false)) {
if (!$border AND !$fill) {
if (isset ($tag['attribute']['cellspacing'])) {
if (($tag['value'] != 'table') AND (is_array($border)) AND (!empty($border))) {
// draw the border externally respect the sqare edge.
if ($xmax >= $tag['borderposition']['x']) {
$xmax = $tag['borderposition']['xmax'];
$w = ($tag['borderposition']['x'] - $xmax);
if ($xmax <= $tag['borderposition']['x']) {
$xmax = $tag['borderposition']['xmax'];
$w = ($xmax - $tag['borderposition']['x']);
$startpage = $tag['borderposition']['page'];
$startcolumn = $tag['borderposition']['column'];
$x = $tag['borderposition']['x'];
$y = $tag['borderposition']['y'];
$starty = $tag['borderposition']['y'] - $cellspacing;
$border_start = $this->getBorderMode($border, $position= 'start');
$border_middle = $this->getBorderMode($border, $position= 'middle');
// design borders around HTML cells.
for ($page = $startpage; $page <= $endpage; ++ $page) { // for each page
// account for margin changes
if ($page > $startpage) {
if (($this->rtl) AND ($this->pagedim[$page]['orm'] != $this->pagedim[$startpage]['orm'])) {
$this->x -= ($this->pagedim[$page]['orm'] - $this->pagedim[$startpage]['orm']);
} elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
$this->x += ($this->pagedim[$page]['olm'] - $this->pagedim[$startpage]['olm']);
if ($startpage == $endpage) {
for ($column = $startcolumn; $column <= $endcolumn; ++ $column) { // for each column
if ($startcolumn == $endcolumn) { // single column
$h = ($currentY - $y) + $cellspacing;
} elseif ($column == $startcolumn) { // first column
$cborder = $border_start;
} elseif ($column == $endcolumn) { // end column
$h = $currentY - $this->y;
} else { // middle column
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $startpage) { // first page
for ($column = $startcolumn; $column < $this->num_columns; ++ $column) { // for each column
if ($column == $startcolumn) { // first column
$cborder = $border_start;
} else { // middle column
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
} elseif ($page == $endpage) { // last page
for ($column = 0; $column <= $endcolumn; ++ $column) { // for each column
if ($column == $endcolumn) {
$h = $currentY - $this->y;
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
for ($column = 0; $column < $this->num_columns; ++ $column) { // for each column
$cborder = $border_middle;
$ccode .= $this->getCellCode($w, $h, '', $cborder, 1, '', $fill, '', 0, true). "\n";
// we are inside an XObject template
$pagemark = &$this->xobjects[$this->xobjid]['transfmrk'][$pagemarkkey];
$pstart = substr($pagebuff, 0, $pagemark);
$pend = substr($pagebuff, $pagemark);
if (isset ($old_bgcolor)) {
// restore background color
// restore pointer position
$this->lasth = $prev_lasth;
* Set the default bullet to be used as LI bullet symbol
* @param string $symbol character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek')
* @since 4.0.028 (2008-09-26)
case 'decimal-leading-zero':
* Set the booklet mode for double-sided pages.
* @param boolean $booklet true set the booklet mode on, false otherwise.
* @param float $inner Inner page margin.
* @param float $outer Outer page margin.
* @since 4.2.000 (2008-10-29)
public function SetBooklet($booklet= true, $inner=- 1, $outer=- 1) {
* Swap the left and right margins.
* @param boolean $reverse if true swap left and right margins.
* @since 4.2.000 (2008-10-29)
// swap left and right margins
* Set the vertical spaces for HTML tags.
* The array must have the following structure (example):
* $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1)));
* The first array level contains the tag names,
* the second level contains 0 for opening tags or 1 for closing tags,
* the third level contains the vertical space unit (h) and the number spaces to add (n).
* If the h parameter is not specified, default values are used.
* @param array $tagvs array of tags and relative vertical spaces.
* @since 4.2.001 (2008-10-30)
* Set custom width for list indentation.
* @param float $width width of the indentation. Use negative value to disable it.
* @since 4.2.007 (2008-11-12)
* Set the top/bottom cell sides to be open or closed when the cell cross the page.
* @param boolean $isopen if true keeps the top/bottom border open for the cell sides that cross the page.
* @since 4.2.010 (2008-11-14)
* Set the color and font style for HTML links.
* @param array $color RGB array of colors
* @param string $fontstyle additional font styles to add
* @since 4.4.003 (2008-12-09)
* Convert HTML string containing value and unit of measure to user's units or points.
* @param string $htmlval string containing values and unit
* @param string $refsize reference value in points
* @param string $defaultunit default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
* @param boolean $point if true returns points, otherwise returns value in user's units
* @return float value in user's unit or point if $points=true
* @since 4.4.004 (2008-12-10)
public function getHTMLUnitToUnits($htmlval, $refsize= 1, $defaultunit= 'px', $points= false) {
$supportedunits = array('%', 'em', 'ex', 'px', 'in', 'cm', 'mm', 'pc', 'pt');
if (in_array($defaultunit, $supportedunits)) {
} elseif (preg_match('/([0-9\.\-\+]+)/', $htmlval, $mnum)) {
if (preg_match('/([a-z%]+)/', $htmlval, $munit)) {
if (in_array($munit[1], $supportedunits)) {
$retval = (($value * $refsize) / 100);
$retval = ($value * $refsize);
// height of lower case 'x' (about half the font-size)
$retval = $value * ($refsize / 2);
$retval = ($value * $this->dpi) / $k;
$retval = ($value / 2.54 * $this->dpi) / $k;
$retval = ($value / 25.4 * $this->dpi) / $k;
$retval = ($value * 12) / $k;
* Returns the Roman representation of an integer number
* @param int number to convert
* @return string roman representation of the specified number
* @since 4.4.004 (2008-12-10)
while ($number >= 1000) {
* Output an HTML list bullet or ordered item symbol
* @param int $listdepth list nesting level
* @param string $listtype type of list
* @param float $size current font size
* @since 4.4.004 (2008-12-10)
// special symbol used for avoid justification of rect bullet
} elseif ($listtype == '!') {
// set default list type for unordered list
$deftypes = array('disc', 'circle', 'square');
$listtype = $deftypes[($listdepth - 1) % 3];
} elseif ($listtype == '#') {
// set default list type for ordered list
$this->Circle(($this->x + $r), ($this->y + ($this->lasth / 2)), $r, 0, 360, $fill, array('color'=> $color), $color, 8);
$this->Rect($this->x, ($this->y + (($this->lasth - $l)/ 2)), $l, $l, 'F', array(), $color);
// $this->listcount[$this->listnum];
case 'decimal-leading-zero': {
// Types to be implemented (special handling)
case 'cjk-ideographic': {
$textitem = '.'. $textitem;
$textitem = $textitem. '.';
$this->Write($this->lasth, $textitem, '', false, '', false, 0, false);
* Returns current graphic variables as array.
* @return array of graphic variables
* @since 4.2.010 (2008-11-14)
* @param array $gvars array of graphic variablesto restore
* @param boolean $extended if true restore extended graphic variables
* @since 4.2.010 (2008-11-14)
$this->rMargin = $gvars['rMargin'];
$this->lMargin = $gvars['lMargin'];
$this->bgcolor = $gvars['bgcolor'];
$this->fgcolor = $gvars['fgcolor'];
$this->listnum = $gvars['listnum'];
// restore extended values
$this->lasth = $gvars['lasth'];
$this->tMargin = $gvars['tMargin'];
$this->bMargin = $gvars['bMargin'];
$this->wPt = $gvars['wPt'];
$this->hPt = $gvars['hPt'];
$this->fwPt = $gvars['fwPt'];
$this->fhPt = $gvars['fhPt'];
$this->page = $gvars['page'];
* Returns a temporary filename for caching object on filesystem.
* @param string $prefix prefix to add to filename
* return string filename.
* @since 4.5.000 (2008-12-31)
* Writes data to a temporary file on filesystem.
* @param string $file file name
* @param mixed $data data to write on file
* @param boolean $append if true append data, false replace.
* @since 4.5.000 (2008-12-31)
$f = @fopen($filename, $fmode);
$this->Error('Unable to write cache file: '. $filename);
// update file length (needed for transactions)
* Read data from a temporary file on filesystem.
* @param string $file file name
* @return mixed retrieved data
* @since 4.5.000 (2008-12-31)
* Set buffer content (always append data).
* @param string $data data
* @since 4.5.000 (2009-01-02)
* Replace the buffer content
* @param string $data data
* @since 5.5.000 (2010-06-22)
* @return string buffer content
* @since 4.5.000 (2009-01-02)
* Set page buffer content.
* @param int $page page number
* @param string $data page data
* @param boolean $append if true append data, false replace.
* @since 4.5.000 (2008-12-31)
if (!isset ($this->pages[$page])) {
$this->pages[$page] .= $data;
$this->pages[$page] = $data;
if ($append AND isset ($this->pagelen[$page])) {
* Get page buffer content.
* @param int $page page number
* @return string page buffer content or false in case of error
* @since 4.5.000 (2008-12-31)
} elseif (isset ($this->pages[$page])) {
return $this->pages[$page];
* Set image buffer content.
* @param string $image image key
* @param array $data image data
* @since 4.5.000 (2008-12-31)
if (!isset ($this->images[$image])) {
$this->images[$image] = $data;
* Set image buffer content for a specified sub-key.
* @param string $image image key
* @param string $key image sub-key
* @param array $data image data
* @since 4.5.000 (2008-12-31)
if (!isset ($this->images[$image])) {
$this->images[$image][$key] = $data;
* Get image buffer content.
* @param string $image image key
* @return string image buffer content or false in case of error
* @since 4.5.000 (2008-12-31)
} elseif (isset ($this->images[$image])) {
* Set font buffer content.
* @param string $font font key
* @param array $data font data
* @since 4.5.000 (2009-01-02)
if (!isset ($this->fonts[$font])) {
$this->fonts[$font] = $data;
// store object ID for current font
* Set font buffer content.
* @param string $font font key
* @param string $key font sub-key
* @param array $data font data
* @since 4.5.000 (2009-01-02)
if (!isset ($this->fonts[$font])) {
$this->fonts[$font][$key] = $data;
* Get font buffer content.
* @param string $font font key
* @return string font buffer content or false in case of error
* @since 4.5.000 (2009-01-02)
} elseif (isset ($this->fonts[$font])) {
return $this->fonts[$font];
* Move a page to a previous position.
* @param int $frompage number of the source page
* @param int $topage number of the destination page (must be less than $frompage)
* @return true in case of success, false in case of error.
* @since 4.5.000 (2009-01-02)
public function movePage($frompage, $topage) {
if (($frompage > $this->numpages) OR ($frompage <= $topage)) {
if ($frompage == $this->page) {
// close the page before moving it
// move all page-related states
$tmppage = $this->pages[$frompage];
$tmppagedim = $this->pagedim[$frompage];
$tmppagelen = $this->pagelen[$frompage];
$tmpintmrk = $this->intmrk[$frompage];
$tmpcntmrk = $this->cntmrk[$frompage];
for ($i = $frompage; $i > $topage; -- $i) {
$this->pages[$topage] = $tmppage;
$this->pagedim[$topage] = $tmppagedim;
$this->pagelen[$topage] = $tmppagelen;
$this->intmrk[$topage] = $tmpintmrk;
$this->cntmrk[$topage] = $tmpcntmrk;
if (isset ($tmpfooterpos)) {
} elseif (isset ($this->footerpos[$topage])) {
if (isset ($tmpfooterlen)) {
} elseif (isset ($this->footerlen[$topage])) {
if (isset ($tmptransfmrk)) {
} elseif (isset ($this->transfmrk[$topage])) {
if (isset ($tmpnewpagegroup)) {
foreach ($tmpoutlines as $key => $outline) {
if (($outline['p'] >= $topage) AND ($outline['p'] < $frompage)) {
$this->outlines[$key]['p'] = $outline['p'] + 1;
} elseif ($outline['p'] == $frompage) {
$tmplinks = $this->links;
foreach ($tmplinks as $key => $link) {
if (($link[0] >= $topage) AND ($link[0] < $frompage)) {
$this->links[$key][0] = $link[0] + 1;
} elseif ($link[0] == $frompage) {
$this->links[$key][0] = $topage;
global $jfrompage, $jtopage;
$pagenum = intval($matches[3]) + 1;
if (($pagenum >= $jtopage) AND ($pagenum < $jfrompage)) {
$newpage = ($pagenum + 1);
} elseif ($pagenum == $jfrompage) {
return "this.addField(\'".$matches[1]."\',\'".$matches[2]."\',".$newpage."";'), $tmpjavascript);
* Remove the specified page.
* @param int $page page to remove
* @return true in case of success, false in case of error.
* @since 4.6.004 (2009-04-23)
if (($page < 1) OR ($page > $this->numpages)) {
unset ($this->pages[$page]);
// update remaining pages
for ($i = $page; $i < $this->numpages; ++ $i) {
foreach ($tmpoutlines as $key => $outline) {
if ($outline['p'] > $page) {
$this->outlines[$key]['p'] = $outline['p'] - 1;
} elseif ($outline['p'] == $page) {
$tmplinks = $this->links;
foreach ($tmplinks as $key => $link) {
$this->links[$key][0] = $link[0] - 1;
} elseif ($link[0] == $page) {
unset ($this->links[$key]);
$pagenum = intval($matches[3]) + 1;
if ($pagenum >= $jpage) {
$newpage = ($pagenum - 1);
} elseif ($pagenum == $jpage) {
return "this.addField(\'".$matches[1]."\',\'".$matches[2]."\',".$newpage."";'), $tmpjavascript);
* Clone the specified page to a new page.
* @param int $page number of page to copy (0 = current page)
* @return true in case of success, false in case of error.
* @since 4.9.015 (2010-04-20)
if (($page < 1) OR ($page > $this->numpages)) {
if ($page == $this->page) {
// close the page before cloning it
// copy all page-related states
foreach ($tmpoutlines as $key => $outline) {
if ($outline['p'] == $page) {
$this->outlines[] = array('t' => $outline['t'], 'l' => $outline['l'], 'y' => $outline['y'], 'p' => $this->page);
$tmplinks = $this->links;
foreach ($tmplinks as $key => $link) {
$this->links[] = array($this->page, $link[1]);
* Output a Table of Content Index (TOC).
* Before calling this method you have to open the page using the addTOCPage() method.
* After calling this method you have to call endTOCPage() to close the TOC page.
* You can override this method to achieve different styles.
* @param int $page page number where this TOC should be inserted (leave empty for current page).
* @param string $numbersfont set the font for page numbers (please use monospaced font for better alignment).
* @param string $filler string used to fill the space between text and page number.
* @param string $toc_name name to use for TOC bookmark.
* @since 4.5.000 (2009-01-02)
* @see addTOCPage(), endTOCPage(), addHTMLTOC()
public function addTOC($page= '', $numbersfont= '', $filler= '.', $toc_name= 'TOC') {
$x_start = $this->GetX();
$current_page = $this->page;
foreach ($this->outlines as $key => $outline) {
if ($outline['l'] == 0) {
$this->SetFont($fontfamily, $fontstyle. 'B', $fontsize);
$this->SetFont($fontfamily, $fontstyle, $fontsize - $outline['l']);
// set margins and X position
$current_page = $this->page;
$indent = ($spacer * $outline['l']);
$this->SetLink($link, $outline['y'], $outline['p']);
$this->Write(0, $outline['t'], $link, 0, $aligntext, false, 0, false, false, 0);
$this->SetFont($numbersfont, $fontstyle, $fontsize);
$pagenum = $outline['p'];
// placemark to be replaced with the correct number
$pagenum = '{#'. ($outline['p']). '}';
$pagenum = '{'. $pagenum. '}';
$pagenum = $pagenum. $gap. $rowfill. ' ';
$pagenum = ' '. $rowfill. $gap. $pagenum;
$this->Cell($tw, 0, $pagenum, 0, 1, $alignnum, 0, $link, 0);
$numpages = $page_last - $page_first + 1;
for ($p = $page_first; $p <= $page_last; ++ $p) {
for ($n = 1; $n <= $this->numpages; ++ $n) {
$this->Bookmark($toc_name, 0, 0, $page_first);
for ($i = 0; $i < $numpages; ++ $i) {
* Output a Table Of Content Index (TOC) using HTML templates.
* Before calling this method you have to open the page using the addTOCPage() method.
* After calling this method you have to call endTOCPage() to close the TOC page.
* @param int $page page number where this TOC should be inserted (leave empty for current page).
* @param string $toc_name name to use for TOC bookmark.
* @param array $templates array of html templates. Use: #TOC_DESCRIPTION# for bookmark title, #TOC_PAGE_NUMBER# for page number.
* @param boolean $correct_align if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
* @since 5.0.001 (2010-05-06)
* @see addTOCPage(), endTOCPage(), addTOC()
public function addHTMLTOC($page= '', $toc_name= 'TOC', $templates= array(), $correct_align= true) {
// set new style for link
// get the font type used for numbers in each template
foreach ($templates as $level => $html) {
foreach ($dom as $key => $value) {
if ($value['value'] == '#TOC_PAGE_NUMBER#') {
$this->SetFont($dom[($key - 1)]['fontname']);
foreach ($this->outlines as $key => $outline) {
$row = $templates[$outline['l']];
$pagenum = $outline['p'];
// placemark to be replaced with the correct number
$pagenum = '{#'. ($outline['p']). '}';
if ($templates['F'. $outline['l']]) {
$pagenum = '{'. $pagenum. '}';
// replace templates with current values
$row = str_replace('#TOC_DESCRIPTION#', $outline['t'], $row);
$row = str_replace('#TOC_PAGE_NUMBER#', $pagenum, $row);
$row = '<a href="#'. $outline['p']. ','. $outline['y']. '">'. $row. '</a>';
$this->writeHTML($row, false, false, true, false, '');
// move TOC page and replace numbers
$numpages = $page_last - $page_first + 1;
for ($p = $page_first; $p <= $page_last; ++ $p) {
for ($n = 1; $n <= $this->numpages; ++ $n) {
$alias_au = $this->_escape('{'. $k. '}');
$this->Bookmark($toc_name, 0, 0, $page_first);
for ($i = 0; $i < $numpages; ++ $i) {
* Stores a copy of the current TCPDF object used for undo operation.
* @since 4.5.029 (2009-03-19)
// record current page number and Y position
* Delete the copy of the current TCPDF object used for undo operation.
* @since 4.5.029 (2009-03-19)
* This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
* @param boolean $self if true restores current class object to previous state without the need of reassignment via the returned value.
* @since 4.5.029 (2009-03-19)
// truncate files to previous values
$handle = fopen($file, 'r+');
foreach ($objvars as $key => $value) {
* Creates a copy of a class object
* @param object $object class object to be cloned
* @since 4.5.029 (2009-03-19)
* Determine whether a string is empty.
* @param string $str string to be checked
* @return boolean true if string is empty
* @since 4.5.044 (2009-04-16)
* Find position of last occurrence of a substring in a string
* @param string $haystack The string to search in.
* @param string $needle substring to search.
* @param int $offset May be specified to begin searching an arbitrary number of characters into the string.
* @return Returns the position where the needle exists. Returns FALSE if the needle was not found.
* @since 4.8.038 (2010-03-13)
public function revstrpos($haystack, $needle, $offset = 0) {
$offset = ($offset > 0)? ($length - $offset): abs($offset);
return ($pos === false)? false: ($length - $pos - strlen($needle));
// --- MULTI COLUMNS METHODS -----------------------
* Set multiple columns of the same size
* @param int $numcols number of columns (set to zero to disable columns mode)
* @param int $width column width
* @param int $y column starting Y position (leave empty for current Y position)
* @since 4.9.001 (2010-03-28)
if (($width == 0) OR ($width > $maxwidth)) {
// fill the columns array (with, space, starting Y position)
for ($i = 0; $i < $numcols; ++ $i) {
$this->columns[$i] = array('w' => $width, 's' => $space, 'y' => $y);
* Each column is represented by and array with the following keys: (w = width, s = space between columns, y = column top position).
* @since 4.9.001 (2010-03-28)
* Set position at a given column
* @param int $col column number (from 0 to getNumberOfColumns()-1); empty string = current column.
* @since 4.9.001 (2010-03-28)
// move Y pointer at the top of the column
// Avoid to write table headers more than once
// set X position of the current column by case
$colpos = ($col * ($this->columns[$col]['w'] + $this->columns[$col]['s']));
$this->rMargin = ($this->w - $x + $listindent);
$this->x = $x - $listindent;
$this->lMargin = ($x + $listindent);
$this->x = $x + $listindent;
// print HTML table header (if any)
$this->y += $xshift['s'];
// store end of header position
if (!isset ($this->columns[$col]['th'])) {
$this->columns[$col]['th'] = array();
$this->columns[$col]['th']['\''. $this->page. '\''] = $this->y;
} elseif (isset ($this->columns[$col]['th']['\''. $this->page. '\''])) {
$this->y = $this->columns[$col]['th']['\''. $this->page. '\''];
// account for an html table cell over multiple columns
$this->x -= ($xshift['x'] + $xshift['p']);
$this->x += $xshift['x'] + $xshift['p'];
* Return the current column number
* @return int current column number
* @since 5.5.011 (2010-07-08)
* Return the current number of columns.
* @return int number of columns
* @since 5.8.018 (2010-08-25)
* Serialize an array of parameters to be used with TCPDF tag in HTML code.
* @param array $pararray parameters array
* @return sting containing serialized data
* @since 4.9.006 (2010-04-02)
* Set Text rendering mode.
* @param int $stroke outline size in user units (0 = disable).
* @param boolean $fill if true fills the text (default).
* @param boolean $clip if true activate clipping mode
* @since 4.9.008 (2009-04-02)
// Ref.: PDF 32000-1:2008 - 9.3.6 Text Rendering Mode
// convert text rendering parameters
// Fill, then stroke text and add to path for clipping
// Fill, then stroke text
$textstrokewidth = $stroke;
// Fill text and add to path for clipping
// Stroke text and add to path for clipping
$textstrokewidth = $stroke;
// Add text to path for clipping
// Neither fill nor stroke text (invisible)
* Returns an array of chars containing soft hyphens.
* @param array $word array of chars
* @param array $patterns Array of hypenation patterns.
* @param array $dictionary Array of words to be returned without applying the hyphenation algoritm.
* @param int $leftmin Minimum number of character to leave on the left of the word without applying the hyphens.
* @param int $rightmin Minimum number of character to leave on the right of the word without applying the hyphens.
* @param int $charmin Minimum word lenght to apply the hyphenation algoritm.
* @param int $charmax Maximum lenght of broken piece of word.
* @return array text with soft hyphens
* @since 4.9.012 (2010-04-12)
protected function hyphenateWord($word, $patterns, $dictionary= array(), $leftmin= 1, $rightmin= 2, $charmin= 1, $charmax= 8) {
$hyphenword = array(); // hyphens positions
$numchars = count($word);
if ($numchars <= $charmin) {
// some words will be returned as-is
$pattern = '/^([a-zA-Z0-9_\.\-]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/';
$pattern = '/(([a-zA-Z0-9\-]+\.)?)((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/';
if (isset ($dictionary[$word_string])) {
// suround word with '_' characters
$tmpnumchars = $numchars + 2;
$maxpos = $tmpnumchars - $charmin;
for ($pos = 0; $pos < $maxpos; ++ $pos) {
$imax = min(($tmpnumchars - $pos), $charmax);
for ($i = $charmin; $i <= $imax; ++ $i) {
if (isset ($patterns[$subword])) {
$pattern_length = count($pattern);
for ($j = 0; $j < $pattern_length; ++ $j) {
// check if $pattern[$j] is a number
if (($pattern[$j] >= 48) AND ($pattern[$j] <= 57)) {
$zero = $pos + $j - $digits;
if (!isset ($hyphenword[$zero]) OR ($hyphenword[$zero] != $pattern[$j])) {
$hyphenword[$zero] = $this->unichr($pattern[$j]);
$maxpos = $numchars - $rightmin;
for($i = $leftmin; $i <= $maxpos; ++ $i) {
if(isset ($hyphenword[$i]) AND (($hyphenword[$i] % 2) != 0)) {
// 173 = soft hyphen character
* Returns an array of hyphenation patterns.
* @param string $file TEX file containing hypenation patterns. TEX pattrns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
* @return array of hyphenation patterns
* @since 4.9.012 (2010-04-12)
// TEX patterns are available at:
// http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
// extract the patterns part
preg_match('/\\\\patterns\{([^\}]*)\}/i', $data, $matches);
// create new language array of patterns
foreach($patterns_array as $val) {
* Returns text with soft hyphens.
* @param string $text text to process
* @param mixed $patterns Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
* @param array $dictionary Array of words to be returned without applying the hyphenation algoritm.
* @param int $leftmin Minimum number of character to leave on the left of the word without applying the hyphens.
* @param int $rightmin Minimum number of character to leave on the right of the word without applying the hyphens.
* @param int $charmin Minimum word lenght to apply the hyphenation algoritm.
* @param int $charmax Maximum lenght of broken piece of word.
* @return array text with soft hyphens
* @since 4.9.012 (2010-04-12)
public function hyphenateText($text, $patterns, $dictionary= array(), $leftmin= 1, $rightmin= 2, $charmin= 1, $charmax= 8) {
$word = array(); // last word
$txtarr = array(); // text to be returned
$intag = false; // true if we are inside an HTML tag
// get array of characters
foreach ($unichars as $char) {
if ((!$intag) AND $this->unicode->uni_type[$char] == 'L') {
// other type of character
$txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
// we are inside an HTML tag
} elseif ($intag AND (chr($char) == '>')) {
$txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
// convert char array to string and return
* Enable/disable rasterization of vector images using ImageMagick library.
* @param boolean $mode if true enable rasterization, false otherwise.
* @since 5.0.000 (2010-04-27)
* Get the Path-Painting Operators.
* @param string $style Style of rendering. Possible values are:
* <li>S or D: Stroke the path.</li>
* <li>s or d: Close and stroke the path.</li>
* <li>f or F: Fill the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>f* or F*: Fill the path, using the even-odd rule to determine the region to fill.</li>
* <li>B or FD or DF: Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>B* or F*D or DF*: Fill and then stroke the path, using the even-odd rule to determine the region to fill.</li>
* <li>b or fd or df: Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>b or f*d or df*: Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.</li>
* <li>CNZ: Clipping mode using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>CEO: Clipping mode using the nonzero winding number rule to determine which regions lie inside the clipping path</li>
* <li>n: End the path object without filling or stroking it.</li>
* @param string $default default style
* @param boolean $mode if true enable rasterization, false otherwise.
* @since 5.0.000 (2010-04-30)
* Enable or disable default option for font subsetting.
* @param boolean $enable if true enable font subsetting by default.
* @since 5.3.002 (2010-06-07)
* Return the default option for font subsetting.
* @return boolean default font subsetting state.
* @since 5.3.002 (2010-06-07)
* Left trim the input string
* @param string $str string to trim
* @param string $replace string that replace spaces.
* @return left trimmed string
* @since 5.8.000 (2010-08-11)
* Right trim the input string
* @param string $str string to trim
* @param string $replace string that replace spaces.
* @return right trimmed string
* @since 5.8.000 (2010-08-11)
* @param string $str string to trim
* @param string $replace string that replace spaces.
* @since 5.8.000 (2010-08-11)
* Return true if the current font is unicode type.
* @return true for unicode font, false otherwise.
* @since 5.8.002 (2010-08-14)
* Return normalized font name
* @param string $fontfamily property string containing font family names
* @return string normalized font name
* @since 5.8.004 (2010-08-17)
// remove spaces and symbols
// extract all font names
// find first valid font name
foreach ($fontslist as $font) {
// replace font variations
// replace common family names and core fonts
$pattern[] = '/^serif|^cursive|^fantasy|^timesnewroman/';
$replacement[] = 'times';
$pattern[] = '/^sansserif/';
$replacement[] = 'helvetica';
$pattern[] = '/^monospace/';
$replacement[] = 'courier';
// return current font as default
* Start a new XObject Template.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* Note: X,Y coordinates will be reset to 0,0.
* @param int $w Template width in user units (empty string or zero = page width less margins)
* @param int $h Template height in user units (empty string or zero = page height less margins)
* @return int the XObject Template ID in case of success or false in case of error.
* @since 5.8.017 (2010-08-24)
* @see endTemplate(), printTemplate()
// we are already inside an XObject template
// store current graphic state
if (($w === '') OR ($w <= 0)) {
if (($h === '') OR ($h <= 0)) {
$this->wPt = $this->w * $this->k;
$this->hPt = $this->h * $this->k;
* End the current XObject Template started with startTemplate() and restore the previous graphic state.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* @return int the XObject Template ID in case of success or false in case of error.
* @since 5.8.017 (2010-08-24)
* @see startTemplate(), printTemplate()
// we are not inside a template
// restore previous graphic state
* Print an XObject Template.
* You can print an XObject Template inside the currently opened Template.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* @param string $id The ID of XObject Template to print.
* @param int $x X position in user units (empty string = current x position)
* @param int $y Y position in user units (empty string = current y position)
* @param int $w Width in user units (zero = remaining page width)
* @param int $h Height in user units (zero = remaining page height)
* @param string $align Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param string $palign Allows to center or align the template on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param boolean $fitonpage if true the template is resized to not exceed page dimensions.
* @since 5.8.017 (2010-08-24)
* @see startTemplate(), endTemplate()
public function printTemplate($id, $x= '', $y= '', $w= 0, $h= 0, $align= '', $palign= '', $fitonpage= false) {
$this->Error('The XObject Template \''. $id. '\' doesn\'t exist!');
// close current template
// use the template as resource for the template currently opened
// check page for no-write regions and adapt page margins if necessary
// calculate template width and height on document
if (($w <= 0) AND ($h <= 0)) {
// fit the template on available space
$this->fitBlock($w, $h, $x, $y, $fitonpage);
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
// print XObject Template + Transformation matrix
$tm[5] = ($this->h - $h - $y) * $this->k;
$this->_out('/'. $id. ' Do');
if (!empty($this->xobjects[$id]['annotations'])) {
foreach ($this->xobjects[$id]['annotations'] as $annot) {
// transform original coordinates
$ax = ($coordlt[4] / $this->k);
$ay = ($this->h - $h - ($coordlt[5] / $this->k));
$aw = ($coordrb[4] / $this->k) - $ax;
$ah = ($this->h - $h - ($coordrb[5] / $this->k)) - $ay;
$this->Annotation($ax, $ay, $aw, $ah, $annot['text'], $annot['opt'], $annot['spaces']);
// set pointer to align the next text/objects
* Set the percentage of character stretching.
* @param int $perc percentage of stretching (100 = no stretching)
* @since 5.9.000 (2010-09-29)
* Get the percentage of character stretching.
* @return float stretching value
* @since 5.9.000 (2010-09-29)
* Set the amount to increase or decrease the space between characters in a text.
* @param float $spacing amount to increase or decrease the space between characters in a text (0 = default spacing)
* @since 5.9.000 (2010-09-29)
* Get the amount to increase or decrease the space between characters in a text.
* @return int font spacing (tracking/kerning) value
* @since 5.9.000 (2010-09-29)
* Return an array of no-write page regions
* @return array of no-write page regions
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), addPageRegion()
* Set no-write regions on page.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* You can set multiple regions for the same page.
* @param array $regions array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions.
* @since 5.9.003 (2010-10-13)
* @see addPageRegion(), getPageRegions()
// empty current regions array
foreach ($regions as $data) {
* Add a single no-write region on selected page.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* You can set multiple regions for the same page.
* @param array $region array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right).
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), getPageRegions()
if (!isset ($region['page']) OR empty($region['page'])) {
$region['page'] = $this->page;
if (isset ($region['xt']) AND isset ($region['xb']) AND ($region['xt'] > 0) AND ($region['xb'] > 0)
AND isset ($region['yt']) AND isset ($region['yb']) AND ($region['yt'] >= 0) AND ($region['yt'] < $region['yb'])
AND isset ($region['side']) AND (($region['side'] == 'L') OR ($region['side'] == 'R'))) {
* Remove a single no-write region.
* @param int $key region key
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), getPageRegions()
* Check page for no-write regions and adapt current coordinates and page margins if necessary.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* @param float $h height of the text/image/object to print in user units
* @param float $x current X coordinate in user units
* @param float $y current Y coordinate in user units
* @since 5.9.003 (2010-10-13)
// no page regions defined
// the content will be printed on a new page
// adjust coordinates and page margins
if ($regdata['page'] == $this->page) {
// check region boundaries
if (($y > ($regdata['yt'] - $h)) AND ($y <= $regdata['yb'])) {
// Y is inside the region
$minv = ($regdata['xb'] - $regdata['xt']) / ($regdata['yb'] - $regdata['yt']); // inverse of angular coefficient
$yt = max($y, $regdata['yt']);
$yb = min(($yt + $h), $regdata['yb']);
$xt = (($yt - $regdata['yt']) * $minv) + $regdata['xt'];
$xb = (($yb - $regdata['yt']) * $minv) + $regdata['xt'];
if ($regdata['side'] == 'L') { // left side
$new_margin = max($xt, $xb);
if ($this->lMargin < $new_margin) {
// adjust left page margin
} elseif ($regdata['side'] == 'R') { // right side
$new_margin = min($xt, $xb);
if (($this->w - $this->rMargin) > $new_margin) {
// adjust right page margin
$this->rMargin = ($this->w - $new_margin);
// -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
// -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
* Embedd a Scalable Vector Graphics (SVG) image.
* NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
* @param string $file Name of the SVG file.
* @param float $x Abscissa of the upper-left corner.
* @param float $y Ordinate of the upper-left corner.
* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param mixed $link URL or identifier returned by AddLink().
* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul> If the alignment is an empty string, then the pointer will be restored on the starting SVG position.
* @param string $palign Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param mixed $border Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param boolean $fitonpage if true the image is resized to not exceed page dimensions.
* @since 5.0.000 (2010-05-02)
public function ImageSVG($file, $x= '', $y= '', $w= 0, $h= 0, $link= '', $align= '', $palign= '', $border= 0, $fitonpage= false) {
// convert SVG to raster image using GD or ImageMagick libraries
return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
if ($svgdata === false) {
$this->Error('SVG file not found: '. $file);
// check page for no-write regions and adapt page margins if necessary
$aspect_ratio_align = 'xMidYMid';
$aspect_ratio_ms = 'meet';
// get original image width and height
if (isset ($regs[1]) AND !empty($regs[1])) {
if (preg_match('/[\s]+x[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
if (preg_match('/[\s]+y[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
if (preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.\-]+)[\s]+([0-9\.\-]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $regs[1], $tmp)) {
foreach ($tmp as $key => $val) {
if (preg_match('/[\s]+preserveAspectRatio[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
switch (count($aspect_ratio)) {
$aspect_ratio_align = $aspect_ratio[1];
$aspect_ratio_ms = $aspect_ratio[2];
$aspect_ratio_align = $aspect_ratio[0];
$aspect_ratio_ms = $aspect_ratio[1];
$aspect_ratio_align = $aspect_ratio[0];
$aspect_ratio_ms = 'meet';
// calculate image width and height on document
if (($w <= 0) AND ($h <= 0)) {
// convert image size to document unit
// fit the image on available space
$this->fitBlock($w, $h, $x, $y, $fitonpage);
// convert SVG to raster image using GD or ImageMagick libraries
return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
} elseif ($palign == 'C') {
} elseif ($palign == 'R') {
// store current graphic vars
// store SVG position and scale factors
$svgoffset_x = ($ximg - $ox) * $this->k;
$svgoffset_y = - ($y - $oy) * $this->k;
if (isset ($view_box[2]) AND ($view_box[2] > 0) AND ($view_box[3] > 0)) {
if ($aspect_ratio_align != 'none') {
// store current scaling values
$svgscale_old_x = $svgscale_x;
$svgscale_old_y = $svgscale_y;
if ($aspect_ratio_ms == 'slice') {
// the entire viewport is covered by the viewBox
if ($svgscale_x > $svgscale_y) {
$svgscale_y = $svgscale_x;
} elseif ($svgscale_x < $svgscale_y) {
$svgscale_x = $svgscale_y;
// the entire viewBox is visible within the viewport
if ($svgscale_x < $svgscale_y) {
$svgscale_y = $svgscale_x;
} elseif ($svgscale_x > $svgscale_y) {
$svgscale_x = $svgscale_y;
switch (substr($aspect_ratio_align, 1, 3)) {
$svgoffset_x += (($w * $this->k) - ($ow * $this->k * $svgscale_x));
$svgoffset_x += ((($w * $this->k) - ($ow * $this->k * $svgscale_x)) / 2);
switch (substr($aspect_ratio_align, 5)) {
$svgoffset_y -= (($h * $this->k) - ($oh * $this->k * $svgscale_y));
$svgoffset_y -= ((($h * $this->k) - ($oh * $this->k * $svgscale_y)) / 2);
// store current page break mode
// save the current graphic state
// set initial clipping mask
$this->Rect($x, $y, $w, $h, 'CNZ', array(), array());
$e = $ox * $this->k * (1 - $svgscale_x);
$f = ($this->h - $oy) * $this->k * (1 - $svgscale_y);
$this->_out(sprintf('%.3F %.3F %.3F %.3F %.3F %.3F cm', $svgscale_x, 0, 0, $svgscale_y, $e + $svgoffset_x, $f + $svgoffset_y));
// creates a new XML parser to be used by the other XML functions
// the following function allows to use parser inside object
// disable case-folding for this XML parser
// sets the element handler functions for the XML parser
// sets the character data handler function for the XML parser
// start parsing an XML document
$this->Error($error_message);
// restore previous graphic state
$this->lasth = $gvars['lasth'];
$this->Cell($w, $h, '', $border, 0, '', 0, '', 0, true);
$this->Link($ximg, $y, $w, $h, $link, 0);
// set pointer to align the next text/objects
// restore pointer to starting position
$this->page = $gvars['page'];
$this->tMargin = $gvars['tMargin'];
$this->bMargin = $gvars['bMargin'];
$this->wPt = $gvars['wPt'];
$this->hPt = $gvars['hPt'];
$this->fwPt = $gvars['fwPt'];
$this->fhPt = $gvars['fhPt'];
* Get the tranformation matrix from SVG transform attribute
* @param string transformation
* @return array of transformations
* @since 5.0.000 (2010-05-02)
$tm = array(1, 0, 0, 1, 0, 0);
if (preg_match_all('/(matrix|translate|scale|rotate|skewX|skewY)[\s]*\(([^\)]+)\)/si', $attribute, $transform, PREG_SET_ORDER) > 0) {
foreach ($transform as $key => $data) {
if (preg_match('/([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)/si', $data[2], $regs)) {
if (preg_match('/([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)/si', $data[2], $regs)) {
} elseif (preg_match('/([a-z0-9\-\.]+)/si', $data[2], $regs)) {
if (preg_match('/([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)/si', $data[2], $regs)) {
} elseif (preg_match('/([a-z0-9\-\.]+)/si', $data[2], $regs)) {
if (preg_match('/([0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)[\,\s]+([a-z0-9\-\.]+)/si', $data[2], $regs)) {
$e = ($x * (1 - $a)) - ($y * $c);
$f = ($y * (1 - $d)) - ($x * $b);
} elseif (preg_match('/([0-9\-\.]+)/si', $data[2], $regs)) {
if (preg_match('/([0-9\-\.]+)/si', $data[2], $regs)) {
if (preg_match('/([0-9\-\.]+)/si', $data[2], $regs)) {
* Get the product of two SVG tranformation matrices
* @param array $ta first SVG tranformation matrix
* @param array $tb second SVG tranformation matrix
* @return transformation array
* @since 5.0.000 (2010-05-02)
$tm[0] = ($ta[0] * $tb[0]) + ($ta[2] * $tb[1]);
$tm[1] = ($ta[1] * $tb[0]) + ($ta[3] * $tb[1]);
$tm[2] = ($ta[0] * $tb[2]) + ($ta[2] * $tb[3]);
$tm[3] = ($ta[1] * $tb[2]) + ($ta[3] * $tb[3]);
$tm[4] = ($ta[0] * $tb[4]) + ($ta[2] * $tb[5]) + $ta[4];
$tm[5] = ($ta[1] * $tb[4]) + ($ta[3] * $tb[5]) + $ta[5];
* Convert SVG transformation matrix to PDF.
* @param array $tm original SVG transformation matrix
* @return array transformation matrix
* @since 5.0.000 (2010-05-02)
$y = $this->h * $this->k;
$e = ($x * (1 - $a)) - ($y * $c) + $e;
$f = ($y * (1 - $d)) - ($x * $b) + $f;
return array($a, $b, $c, $d, $e, $f);
* Apply SVG graphic transformation matrix.
* @param array $tm original SVG transformation matrix
* @since 5.0.000 (2010-05-02)
* Apply the requested SVG styles (*** TO BE COMPLETED ***)
* @param array $svgstyle array of SVG styles to apply
* @param array $prevsvgstyle array of previous SVG style
* @param int $x X origin of the bounding box
* @param int $y Y origin of the bounding box
* @param int $w width of the bounding box
* @param int $h height of the bounding box
* @param string $clip_function clip function
* @param array $clip_params array of parameters for clipping function
* @since 5.0.000 (2010-05-02)
protected function setSVGStyles($svgstyle, $prevsvgstyle, $x= 0, $y= 0, $w= 1, $h= 1, $clip_function= '', $clip_params= array()) {
if(!isset ($svgstyle['opacity'])) {
if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['clip-path'], $regs)) {
foreach ($clip_path as $cp) {
if ($svgstyle['opacity'] != 1) {
$this->SetAlpha($svgstyle['opacity']);
if (preg_match('/rect\(([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)\)/si', $svgstyle['clip'], $regs)) {
$cw = $w - $left - $right;
$ch = $h - $top - $bottom;
if ($svgstyle['clip-rule'] == 'evenodd') {
$this->Rect($cx, $cy, $cw, $ch, $clip_rule, array(), array());
if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['fill'], $regs)) {
if (isset ($gradient['xref'])) {
// reference to another gradient definition
$newgradient['coords'] = $gradient['coords'];
$newgradient['mode'] = $gradient['mode'];
$newgradient['gradientUnits'] = $gradient['gradientUnits'];
if (isset ($gradient['gradientTransform'])) {
$newgradient['gradientTransform'] = $gradient['gradientTransform'];
$gradient = $newgradient;
//save current Graphic State
if (!empty($clip_function) AND method_exists($this, $clip_function)) {
list ($x, $y, $w, $h) = $bbox;
if ($gradient['mode'] == 'measure') {
if (isset ($gradient['gradientTransform']) AND !empty($gradient['gradientTransform'])) {
$gtm = $gradient['gradientTransform'];
// apply transformation matrix
$xa = ($gtm[0] * $gradient['coords'][0]) + ($gtm[2] * $gradient['coords'][1]) + $gtm[4];
$ya = ($gtm[1] * $gradient['coords'][0]) + ($gtm[3] * $gradient['coords'][1]) + $gtm[5];
$xb = ($gtm[0] * $gradient['coords'][2]) + ($gtm[2] * $gradient['coords'][3]) + $gtm[4];
$yb = ($gtm[1] * $gradient['coords'][2]) + ($gtm[3] * $gradient['coords'][3]) + $gtm[5];
if (isset ($gradient['coords'][4])) {
$gradient['coords'][4] = sqrt(pow(($gtm[0] * $gradient['coords'][4]), 2) + pow(($gtm[1] * $gradient['coords'][4]), 2));
$gradient['coords'][0] = $xa;
$gradient['coords'][1] = $ya;
$gradient['coords'][2] = $xb;
$gradient['coords'][3] = $yb;
// convert SVG coordinates to user units
if (isset ($gradient['coords'][4])) {
if ($gradient['gradientUnits'] == 'objectBoundingBox') {
// convert to SVG coordinate system
$gradient['coords'][0] += $x;
$gradient['coords'][1] += $y;
$gradient['coords'][2] += $x;
$gradient['coords'][3] += $y;
$gradient['coords'][0] = ($gradient['coords'][0] - $x) / $w;
$gradient['coords'][1] = ($gradient['coords'][1] - $y) / $h;
$gradient['coords'][2] = ($gradient['coords'][2] - $x) / $w;
$gradient['coords'][3] = ($gradient['coords'][3] - $y) / $h;
if (isset ($gradient['coords'][4])) {
$gradient['coords'][4] /= $w;
foreach($gradient['coords'] as $key => $val) {
$gradient['coords'][$key] = 0;
$gradient['coords'][$key] = 1;
if (($gradient['type'] == 2) AND ($gradient['coords'][0] == $gradient['coords'][2]) AND ($gradient['coords'][1] == $gradient['coords'][3])) {
// single color (no shading)
$gradient['coords'][0] = 1;
$gradient['coords'][1] = 0;
$gradient['coords'][2] = 0.999;
$gradient['coords'][3] = 0;
$tmp = $gradient['coords'][1];
$gradient['coords'][1] = $gradient['coords'][3];
$gradient['coords'][3] = $tmp;
// set transformation map for gradient
if (($gradient['type'] == 3) AND ($gradient['mode'] == 'measure')) {
// gradient is always circular
$cy = $this->h - $y - ($gradient['coords'][1] * ($w + $h));
$this->_out(sprintf('%.3F 0 0 %.3F %.3F %.3F cm', $w* $this->k, $w* $this->k, $x* $this->k, $cy* $this->k));
$this->_out(sprintf('%.3F 0 0 %.3F %.3F %.3F cm', $w* $this->k, $h* $this->k, $x* $this->k, ($this->h- ($y+ $h))* $this->k));
if (count($gradient['stops']) > 1) {
$this->Gradient($gradient['type'], $gradient['coords'], $gradient['stops'], array(), false);
} elseif ($svgstyle['fill'] != 'none') {
if ($svgstyle['fill-opacity'] != 1) {
$this->SetAlpha($svgstyle['fill-opacity']);
if ($svgstyle['fill-rule'] == 'evenodd') {
if ($svgstyle['stroke'] != 'none') {
'cap' => $svgstyle['stroke-linecap'],
'join' => $svgstyle['stroke-linejoin']
if (isset ($svgstyle['stroke-dasharray']) AND !empty($svgstyle['stroke-dasharray']) AND ($svgstyle['stroke-dasharray'] != 'none')) {
$stroke_style['dash'] = $svgstyle['stroke-dasharray'];
if (!empty($svgstyle['font'])) {
if (preg_match('/font-family[\s]*:[\s]*([^\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_family = $svgstyle['font-family'];
if (preg_match('/font-size[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_size = trim($regs[1]);
$font_size = $svgstyle['font-size'];
if (preg_match('/font-style[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_style = trim($regs[1]);
$font_style = $svgstyle['font-style'];
if (preg_match('/font-weight[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_weight = trim($regs[1]);
$font_weight = $svgstyle['font-weight'];
if (preg_match('/font-stretch[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_stretch = trim($regs[1]);
$font_stretch = $svgstyle['font-stretch'];
if (preg_match('/letter-spacing[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
$font_spacing = trim($regs[1]);
$font_spacing = $svgstyle['letter-spacing'];
$font_size = $svgstyle['font-size'];
$font_style = $svgstyle['font-style'];
$font_weight = $svgstyle['font-weight'];
$font_stretch = $svgstyle['font-stretch'];
$font_spacing = $svgstyle['letter-spacing'];
$font_spacing = $this->getCSSFontSpacing($font_spacing, $svgstyle['letter-spacing']);
switch ($svgstyle['text-decoration']) {
$this->SetFont($font_family, $font_style, $font_size);
* @param string $d attribute d of the path SVG element
* @param string $style Style of rendering. Possible values are:
* <li>D or empty string: Draw (default).</li>
* <li>F*: Fill using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>DF or FD: Draw and fill.</li>
* <li>DF* or FD*: Draw and fill using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* @return array of container box measures (x, y, w, h)
* @since 5.0.000 (2010-05-02)
protected function SVGPath($d, $style= '') {
preg_match_all('/([a-zA-Z])[\s]*([^a-zA-Z\"]*)/si', $d, $paths, PREG_SET_ORDER);
foreach ($paths as $key => $val) {
// use relative coordinated instead of absolute
foreach ($rawparams as $ck => $cp) {
foreach ($params as $ck => $cp) {
foreach ($params as $ck => $cp) {
case 'H': { // horizontal lineto
foreach ($params as $ck => $cp) {
case 'V': { // vertical lineto
foreach ($params as $ck => $cp) {
foreach ($params as $ck => $cp) {
if ((($ck + 1) % 6) == 0) {
$x1 = $params[($ck - 5)] + $xoffset;
$y1 = $params[($ck - 4)] + $yoffset;
$x2 = $params[($ck - 3)] + $xoffset;
$y2 = $params[($ck - 2)] + $yoffset;
$x = $params[($ck - 1)] + $xoffset;
$y = $params[($ck)] + $yoffset;
$this->_outCurve($x1, $y1, $x2, $y2, $x, $y);
$xmin = min($xmin, $x, $x1, $x2);
$ymin = min($ymin, $y, $y1, $y2);
$xmax = max($xmax, $x, $x1, $x2);
$ymax = max($ymax, $y, $y1, $y2);
case 'S': { // shorthand/smooth curveto
foreach ($params as $ck => $cp) {
if ((($ck + 1) % 4) == 0) {
if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'C') OR (strtoupper($paths[($key - 1)][1]) == 'S'))) {
$x2 = $params[($ck - 3)] + $xoffset;
$y2 = $params[($ck - 2)] + $yoffset;
$x = $params[($ck - 1)] + $xoffset;
$y = $params[($ck)] + $yoffset;
$this->_outCurve($x1, $y1, $x2, $y2, $x, $y);
$xmin = min($xmin, $x, $x1, $x2);
$ymin = min($ymin, $y, $y1, $y2);
$xmax = max($xmax, $x, $x1, $x2);
$ymax = max($ymax, $y, $y1, $y2);
case 'Q': { // quadratic Bézier curveto
foreach ($params as $ck => $cp) {
if ((($ck + 1) % 4) == 0) {
// convert quadratic points to cubic points
$x1 = $params[($ck - 3)] + $xoffset;
$y1 = $params[($ck - 2)] + $yoffset;
$xa = ($x + (2 * $x1)) / 3;
$ya = ($y + (2 * $y1)) / 3;
$x = $params[($ck - 1)] + $xoffset;
$y = $params[($ck)] + $yoffset;
$xb = ($x + (2 * $x1)) / 3;
$yb = ($y + (2 * $y1)) / 3;
$this->_outCurve($xa, $ya, $xb, $yb, $x, $y);
$xmin = min($xmin, $x, $xa, $xb);
$ymin = min($ymin, $y, $ya, $yb);
$xmax = max($xmax, $x, $xa, $xb);
$ymax = max($ymax, $y, $ya, $yb);
case 'T': { // shorthand/smooth quadratic Bézier curveto
foreach ($params as $ck => $cp) {
if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'Q') OR (strtoupper($paths[($key - 1)][1]) == 'T'))) {
// convert quadratic points to cubic points
$xa = ($x + (2 * $x1)) / 3;
$ya = ($y + (2 * $y1)) / 3;
$x = $params[($ck - 1)] + $xoffset;
$y = $params[($ck)] + $yoffset;
$xb = ($x + (2 * $x1)) / 3;
$yb = ($y + (2 * $y1)) / 3;
$this->_outCurve($xa, $ya, $xb, $yb, $x, $y);
$xmin = min($xmin, $x, $x1, $x2);
$ymin = min($ymin, $y, $y1, $y2);
$xmax = max($xmax, $x, $x1, $x2);
$ymax = max($ymax, $y, $y1, $y2);
case 'A': { // elliptical arc
foreach ($params as $ck => $cp) {
if ((($ck + 1) % 7) == 0) {
$rx = abs($params[($ck - 6)]);
$ry = abs($params[($ck - 5)]);
$ang = - $rawparams[($ck - 4)];
$fa = $rawparams[($ck - 3)]; // large-arc-flag
$fs = $rawparams[($ck - 2)]; // sweep-flag
$x = $params[($ck - 1)] + $xoffset;
$y = $params[$ck] + $yoffset;
$xa = ($a * $cos_ang) - ($b * $sin_ang);
$ya = ($a * $sin_ang) + ($b * $cos_ang);
$delta = ($xa2 / $rx2) + ($ya2 / $ry2);
$numerator = (($rx2 * $ry2) - ($rx2 * $ya2) - ($ry2 * $xa2));
$root = sqrt($numerator / (($rx2 * $ya2) + ($ry2 * $xa2)));
$cax = $root * (($rx * $ya) / $ry);
$cay = - $root * (($ry * $xa) / $rx);
// coordinates of ellipse center
$cx = ($cax * $cos_ang) - ($cay * $sin_ang) + (($x0 + $x) / 2);
$cy = ($cax * $sin_ang) + ($cay * $cos_ang) + (($y0 + $y) / 2);
$angs = $this->getVectorsAngle(1, 0, (($xa - $cax) / $rx), (($cay - $ya) / $ry));
$dang = $this->getVectorsAngle((($xa - $cax) / $rx), (($ya - $cay) / $ry), ((- $xa - $cax) / $rx), ((- $ya - $cay) / $ry));
if (($fs == 0) AND ($dang > 0)) {
} elseif (($fs == 1) AND ($dang < 0)) {
if (($fs == 1) AND ($angs > $angf)) {
if ((isset ($paths[($key + 1)][1])) AND (trim($paths[($key + 1)][1]) == 'z')) {
return array($xmin, $ymin, ($xmax - $xmin), ($ymax - $ymin));
* Returns the angle in radiants between two vectors
* @param int $x1 X coordiante of first vector point
* @param int $y1 Y coordiante of first vector point
* @param int $x2 X coordiante of second vector point
* @param int $y2 Y coordiante of second vector point
* @since 5.0.000 (2010-05-04)
$dprod = ($x1 * $x2) + ($y1 * $y2);
$dist1 = sqrt(($x1 * $x1) + ($y1 * $y1));
$dist2 = sqrt(($x2 * $x2) + ($y2 * $y2));
$angle = acos($dprod / ($dist1 * $dist2));
if ((($x1 * $y2) - ($x2 * $y1)) < 0) {
* Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
* @param resource $parser The first parameter, parser, is a reference to the XML parser calling the handler.
* @param string $name The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
* @param array $attribs The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on.
* @param array $ctm tranformation matrix for clipping mode (starting transformation matrix).
* @since 5.0.000 (2010-05-02)
// check if we are in clip mode
if ($this->svgdefsmode AND !in_array($name, array('clipPath', 'linearGradient', 'radialGradient', 'stop'))) {
if (!isset ($attribs['id'])) {
$this->svgdefs[$attribs['id']] = array('name' => $name, 'attribs' => $attribs);
if ($parser == 'clip-path') {
// get styling properties
$svgstyle = $this->svgstyles[0]; // set default style
if (isset ($attribs['style']) AND !$this->empty_string($attribs['style'])) {
// fix style for regular expression
$attribs['style'] = ';'. $attribs['style'];
foreach ($prev_svgstyle as $key => $val) {
// inherit previous value
if (isset ($attribs[$key]) AND !$this->empty_string($attribs[$key])) {
// specific attribute settings
if ($attribs[$key] == 'inherit') {
$svgstyle[$key] = $attribs[$key];
} elseif (isset ($attribs['style']) AND !$this->empty_string($attribs['style'])) {
if (preg_match('/[;\"\s]{1}'. $key. '[\s]*:[\s]*([^;\"]*)/si', $attribs['style'], $attrval) AND isset ($attrval[1])) {
if ($attrval[1] == 'inherit') {
$svgstyle[$key] = $attrval[1];
if (isset ($attribs['transform']) AND !empty($attribs['transform'])) {
$svgstyle['transfmatrix'] = $tm;
if (($svgstyle['visibility'] == 'hidden') OR ($svgstyle['visibility'] == 'collapse') OR ($svgstyle['display'] == 'none')) {
// the current graphics element is invisible (nothing is painted)
if (!isset ($attribs['id'])) {
// group together related graphics elements
if (!isset ($attribs['id'])) {
if (isset ($attribs['gradientUnits'])) {
//$attribs['spreadMethod']
$x1 = (isset ($attribs['x1'])? $attribs['x1']: 0);
$y1 = (isset ($attribs['y1'])? $attribs['y1']: 0);
$x2 = (isset ($attribs['x2'])? $attribs['x2']: 1);
$y2 = (isset ($attribs['y2'])? $attribs['y2']: 0);
if (isset ($attribs['x1']) AND (substr($attribs['x1'], - 1) != '%')) {
if (isset ($attribs['gradientTransform'])) {
if (isset ($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
// gradient is defined on another place
if (!isset ($attribs['id'])) {
if (isset ($attribs['gradientUnits'])) {
//$attribs['spreadMethod']
$cx = (isset ($attribs['cx'])? $attribs['cx']: 0.5);
$cy = (isset ($attribs['cy'])? $attribs['cy']: 0.5);
$fx = (isset ($attribs['fx'])? $attribs['fx']: $cx);
$fy = (isset ($attribs['fy'])? $attribs['fy']: $cy);
$r = (isset ($attribs['r'])? $attribs['r']: 0.5);
if (isset ($attribs['cx']) AND (substr($attribs['cx'], - 1) != '%')) {
if (isset ($attribs['gradientTransform'])) {
if (isset ($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
// gradient is defined on another place
if (substr($attribs['offset'], - 1) == '%') {
$stop_color = isset ($svgstyle['stop-color'])? $this->convertHTMLColorToDec($svgstyle['stop-color']): 'black';
$opacity = isset ($svgstyle['stop-opacity'])? $svgstyle['stop-opacity']: 1;
$this->svggradients[$this->svggradientid]['stops'][] = array('offset' => $offset, 'color' => $stop_color, 'opacity' => $opacity);
$d = trim($attribs['d']);
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, 0, 0, 1, 1, 'SVGPath', array($d, 'CNZ'));
$this->RoundedRectXY($x, $y, $w, $h, $rx, $ry, '1111', 'CNZ', array(), array());
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'RoundedRectXY', array($x, $y, $w, $h, $rx, $ry, '1111', 'CNZ'));
$this->RoundedRectXY($x, $y, $w, $h, $rx, $ry, '1111', $obstyle, array(), array());
$this->Circle($cx, $cy, $r, 0, 360, 'CNZ', array(), array(), 8);
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Circle', array($cx, $cy, $r, 0, 360, 'CNZ'));
$this->Circle($cx, $cy, $r, 0, 360, $obstyle, array(), array(), 8);
$this->Ellipse($cx, $cy, $rx, $ry, 0, 0, 360, 'CNZ', array(), array(), 8);
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Ellipse', array($cx, $cy, $rx, $ry, 0, 0, 360, 'CNZ'));
$this->Ellipse($cx, $cy, $rx, $ry, 0, 0, 360, $obstyle, array(), array(), 8);
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Line', array($x1, $y1, $x2, $y2));
$this->Line($x1, $y1, $x2, $y2);
$points = (isset ($attribs['points'])? $attribs['points']: '0 0');
// note that point may use a complex syntax not covered here
if (count($points) < 4) {
foreach ($points as $key => $val) {
$xmin = min($xmin, $p[$key]);
$xmax = max($xmax, $p[$key]);
$ymin = min($ymin, $p[$key]);
$ymax = max($ymax, $p[$key]);
if ($name == 'polyline') {
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'PolyLine', array($p, 'CNZ'));
$this->PolyLine($p, 'D', array(), array());
$this->Polygon($p, 'CNZ', array(), array(), true);
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Polygon', array($p, 'CNZ'));
$this->Polygon($p, $obstyle, array(), array(), true);
if (!isset ($attribs['xlink:href']) OR empty($attribs['xlink:href'])) {
$img = $attribs['xlink:href'];
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h);
// replace relative path with full server path
$img = $this->svgdir. '/'. $img;
if (($img{0} == '/') AND ($_SERVER['DOCUMENT_ROOT'] != '/')) {
$findroot = strpos($img, $_SERVER['DOCUMENT_ROOT']);
if (($findroot === false) OR ($findroot > 1)) {
// replace relative path with full server path
$img = $_SERVER['DOCUMENT_ROOT']. $img;
if (!isset ($testscrtype['query']) OR empty($testscrtype['query'])) {
// convert URL to server path
$this->Image($img, $x, $y, $w, $h);
// only basic support - advanced features must be implemented
$svgstyle['text-color'] = $svgstyle['fill'];
if (isset ($svgstyle['text-anchor'])) {
$this->svgtextmode['text-anchor'] = $svgstyle['text-anchor'];
if (isset ($svgstyle['direction'])) {
if ($svgstyle['direction'] == 'rtl') {
if (isset ($svgstyle['stroke']) AND ($svgstyle['stroke'] != 'none') AND isset ($svgstyle['stroke-width']) AND ($svgstyle['stroke-width'] > 0)) {
$obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, 1, 1);
if (isset ($attribs['xlink:href'])) {
if (isset ($attribs['xlink:href'])) {
unset ($attribs['xlink:href']);
if (isset ($attribs['id'])) {
* Sets the closing SVG element handler function for the XML parser.
* @param resource $parser The first parameter, parser, is a reference to the XML parser calling the handler.
* @param string $name The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
* @since 5.0.000 (2010-05-02)
// ungroup: remove last style from array
// This implementation must be fixed to following the rule:
// If the 'visibility' property is set to hidden on a 'tspan', 'tref' or 'altGlyph' element, then the text is invisible but still takes up space in text layout calculations.
// check if string is RTL text
} elseif ($this->svgtextmode['text-anchor'] == 'middle') {
$this->x += ($textlen / 2);
$this->x -= ($textlen / 2);
$this->Cell(0, 0, $text, 0, 0, '', false, '', 0, false, 'L', 'T');
// restore previous rendering mode
* Sets the character data handler function for the XML parser.
* @param resource $parser The first parameter, parser, is a reference to the XML parser calling the handler.
* @param string $data The second parameter, data, contains the character data as a string.
* @since 5.0.000 (2010-05-02)
// --- END SVG METHODS -----------------------------
//============================================================+
//============================================================+
|