Documentation

TCPDF_IMPORT extends TCPDF

in package

• com
• tecnick
• tcpdf

Tags

class

TCPDF_IMPORT !!! THIS CLASS IS UNDER DEVELOPMENT !!! PHP class extension of the TCPDF (http://www.tcpdf.org) library to import existing PDF documents.

brief

PHP class extension of the TCPDF library to import existing PDF documents.

version

1.0.001

author

Nicola Asuni - info@tecnick.com

Table of Contents

Properties

$allowLocalFiles  : bool

Whether to allow local file path in image html tags, when prefixed with file://

$alpha  : mixed

Alpha mode array.

$annotation_fonts  : mixed

List of fonts used on form fields (fontname => fontkey).

$author  : mixed

Document author.

$AutoPageBreak  : mixed

Automatic page breaking.

$barcode  : mixed

Barcode to print on page footer (only if set).

$bgcolor  : mixed

Current background color.

$bMargin  : mixed

Page break margin.

$booklet  : mixed

Booklet mode for double-sided pages.

$bordermrk  : mixed

Array used to store positions inside the pages buffer (keys are the page numbers).

$buffer  : mixed

Buffer holding in-memory PDF.

$bufferlen  : mixed

Length of the buffer in bytes.

$cache_file_length  : mixed

Array used to store the lengths of cache files.

$cell_height_ratio  : float

Default cell height ratio.

$cell_margin  : mixed

Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).

$cell_padding  : mixed

Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).

$check_page_regions  : mixed

Boolean value true when page region check is active.

$cleaned_ids  : array<string|int, mixed>

$clMargin  : mixed

Cell left margin (used by regions).

$cntmrk  : mixed

Array used to store content positions inside the pages buffer (keys are the page numbers).

$ColorFlag  : mixed

Indicates whether fill and text colors are different.

$column_start_page  : mixed

Starting page for columns.

$columns  : mixed

Array of column measures (width, space, starting Y position).

$colxshift  : mixed

Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.

$compress  : mixed

Compression flag.

$CoreFonts  : mixed

Array of standard font names.

$creator  : mixed

Document creator.

$crMargin  : mixed

Cell right margin (used by regions).

$CurOrientation  : mixed

Current page orientation (P = Portrait, L = Landscape).

$current_column  : mixed

Current column number.

$CurrentFont  : mixed

Current font info.

$currpagegroup  : mixed

Current page group number.

$custom_xmp  : mixed

Custom XMP data.

$custom_xmp_rdf  : mixed

Custom XMP RDF data.

$customlistindent  : mixed

HTML PARSER: custom indent amount for lists. Negative value means disabled.

$default_form_prop  : mixed

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.

$default_graphic_vars  : mixed

Array of default graphic settings.

$default_monospaced_font  : mixed

Default monospace font.

$default_table_columns  : mixed

Default number of columns for html table.

$dests  : mixed

A dictionary of names and corresponding destinations (Dests key on document Catalog).

$diffs  : mixed

Array of encoding differences.

$doc_creation_timestamp  : mixed

Document creation date-time

$doc_modification_timestamp  : mixed

Document modification date-time

$docinfounicode  : mixed

If true set the document information dictionary in Unicode.

$dpi  : mixed

DPI (Dot Per Inch) Document Resolution (do not change).

$DrawColor  : mixed

Commands for drawing color.

$efnames  : mixed

Embedded Files Names

$embeddedfiles  : mixed

Array of files to embedd.

$empty_signature_appearance  : mixed

Array of empty digital signature appearances.

$emptypagemrk  : mixed

Array used to store page positions to track empty pages (keys are the page numbers).

$encoding  : mixed

Default encoding.

$encryptdata  : mixed

Array containing encryption settings.

$encrypted  : mixed

IBoolean flag indicating whether document is protected.

$endlinex  : mixed

End position of the latest inserted line.

$epsmarker  : mixed

String used to mark the beginning and end of EPS image blocks.

$extgstates  : mixed

Array of transparency objects and parameters.

$feps  : mixed

Epsilon value used for float calculations.

$fgcolor  : mixed

Current foreground color.

$fhPt  : mixed

Height of page format in points.

$file_id  : mixed

File ID (used on document trailer).

$fileContentCache  : array<string|int, mixed>

Cache array for file content

$FillColor  : mixed

Commands for filling color.

$font_obj_ids  : mixed

Store the font object IDs.

$font_spacing  : mixed

Increases or decreases the space between characters in a text by the specified amount (tracking).

$font_stretching  : mixed

Percentage of character stretching.

$font_subsetting  : mixed

Boolean flag: if true enables font subsetting by default.

$FontAscent  : mixed

Current font ascent (distance between font top and baseline).

$FontDescent  : mixed

Current font descent (distance between font bottom and baseline).

$FontFamily  : mixed

Current font family.

$FontFiles  : mixed

Array of font files.

$fontkeys  : mixed

Store the font keys.

$fontlist  : mixed

List of available fonts on filesystem.

$fonts  : mixed

Array of used fonts.

$FontSize  : mixed

Current font size in user unit.

$FontSizePt  : mixed

Current font size in points.

$FontStyle  : mixed

Current font style.

$footer_font  : array<int, string|float|null>

Default font used on page footer.

$footer_line_color  : array<string|int, int>

Color for footer line (RGB array).

$footer_margin  : float

Minimum distance between footer and bottom page margin.

$footer_text_color  : array<string|int, int>

Color for footer text (RGB array).

$footerlen  : mixed

Array used to store footer length of each page.

$footerpos  : mixed

Array used to store footer positions of each page.

$force_srgb  : mixed

If true force sRGB color profile for all document.

$form_action  : mixed

Current form action (used during XHTML rendering).

$form_enctype  : mixed

Current form encryption type (used during XHTML rendering).

$form_mode  : mixed

Current method to submit forms.

$form_obj_id  : mixed

List of form annotations IDs.

$fwPt  : mixed

Width of page format in points.

$gdgammacache  : mixed

Cache array for computed GD gamma values.

$gradients  : mixed

Array for storing gradient information.

$h  : mixed

Current height of page in user unit.

$hash_key  : mixed

Internal secret used to encrypt data.

$header_font  : array<int, string|float|null>

Default font used on page header.

$header_line_color  : array<string|int, int>

Color for header line (RGB array).

$header_logo  : mixed

Header image logo.

$header_logo_width  : mixed

Width of header image logo in user units.

$header_margin  : float

Minimum distance between header and top page margin.

$header_string  : mixed

String to print on page header after title.

$header_text_color  : array<string|int, int>

Color for header text (RGB array).

$header_title  : mixed

Title to be printed on default page header.

$header_xobj_autoreset  : mixed

If true reset the Header Xobject template at each page

$header_xobjid  : mixed

ID of the stored default header template (-1 = not set).

$hPt  : mixed

Current height of page in points.

$HREF  : mixed

HTML PARSER: array to store current link and rendering styles.

$htmlLinkColorArray  : mixed

Default color for html links.

$htmlLinkFontStyle  : mixed

Default font style to add to html links.

$htmlvspace  : mixed

Count the latest inserted vertical spaces on HTML.

$imagekeys  : mixed

Store the image keys.

$images  : mixed

Array of used images.

$img_rb_x  : mixed

The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.

$img_rb_y  : mixed

The right-bottom corner Y coordinate of last inserted image.

$imgscale  : mixed

Adjusting factor to convert pixels to user units.

$InFooter  : mixed

Flag set when processing page footer.

$InHeader  : mixed

Flag set when processing page header.

$inthead  : mixed

True when we are printing the thead section on a new page.

$intmrk  : mixed

Array used to store positions inside the pages buffer (keys are the page numbers).

$inxobj  : mixed

Boolean value true when we are inside an XObject.

$isunicode  : mixed

Boolean flag set to true when the input text is unicode (require unicode fonts).

$javascript  : mixed

Javascript code.

$jpeg_quality  : mixed

Set the default JPEG compression quality (1-100).

$js_objects  : mixed

Javascript objects array.

$k  : mixed

Scale factor (number of points in user unit).

$keywords  : mixed

Document keywords.

$l  : mixed

Language templates.

$last_enc_key  : mixed

Last RC4 key encrypted (cached for optimisation).

$last_enc_key_c  : mixed

Last RC4 computed key.

$lasth  : mixed

Height of last cell printed.

$LayoutMode  : mixed

Layout display mode.

$linestyleCap  : mixed

PDF string for CAP value of the last line.

$linestyleDash  : mixed

PDF string for dash value of the last line.

$linestyleJoin  : mixed

PDF string for join value of the last line.

$linestyleWidth  : mixed

PDF string for width value of the last line.

$linethrough  : mixed

line through state

$LineWidth  : mixed

Line width in user unit.

$links  : mixed

Array of internal links.

$lispacer  : mixed

Spacer string for LI tags.

$listcount  : mixed

HTML PARSER: array count list items on nested lists.

$listindent  : mixed

HTML PARSER: indent amount for lists.

$listindentlevel  : mixed

HTML PARSER: current list indententation level.

$listnum  : mixed

HTML PARSER: current list nesting level.

$listordered  : mixed

HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.

$lisymbol  : mixed

Symbol used for HTML unordered list items.

$lMargin  : mixed

Left margin.

$maxselcol  : mixed

Maximum page and column selected.

$n  : mixed

Current object number.

$n_dests  : mixed

Object ID for Named Destinations

$n_js  : mixed

Javascript counter.

$newline  : mixed

Boolean flag to indicate if a new line is created.

$newpagegroup  : mixed

Array of page numbers were a new page group was started (the page numbers are the keys of the array).

$num_columns  : mixed

Number of colums.

$numfonts  : mixed

Counts the number of fonts.

$numimages  : mixed

Counts the number of pages.

$numpages  : mixed

Counts the number of pages.

$objcopy  : mixed

Cloned copy of the current class object.

$offsets  : mixed

Array of object offsets.

$opencell  : mixed

Boolean flag to indicate if the border of the cell sides that cross the page should be removed.

$openMarkedContent  : mixed

Boolean flag to indicate if marked-content sequence is open.

$original_lMargin  : mixed

Original left margin value.

$original_rMargin  : mixed

Original right margin value.

$OutlineRoot  : mixed

Outline root for bookmark.

$outlines  : mixed

Outlines for bookmark.

$overline  : mixed

Overlining flag.

$overprint  : array<string, bool|int>

Overprint mode array.

$page  : mixed

Current page number.

$page_boxes  : mixed

Define the page boundaries boxes to be set on document.

$page_obj_id  : mixed

ID of page objects.

$page_regions  : mixed

Array of no-write regions.

$PageAnnots  : mixed

Array of Annotations in pages.

$PageBreakTrigger  : mixed

Threshold used to trigger page breaks.

$pagedim  : mixed

Page dimensions.

$pagegroups  : mixed

Array that contains the number of pages in each page group.

$pagelen  : mixed

Array containing page lengths in bytes.

$PageMode  : mixed

A name object specifying how the document should be displayed when opened.

$pageobjects  : mixed

Array of object IDs for each page.

$pageopen  : mixed

Store the fage status (true when opened, false when closed).

$pages  : mixed

Array containing pages.

$pdfa_mode  : mixed

If true set the document to PDF/A mode.

$pdfa_version  : mixed

version of PDF/A mode (1 - 3).

$pdflayers  : mixed

Array of PDF layers data.

$pdfunit  : mixed

Default unit of measure for document.

$PDFVersion  : mixed

PDF version.

$premode  : mixed

Boolean flag to indicate if we are inside a PRE tag.

$print_footer  : mixed

Boolean flag to print/hide page footer.

$print_header  : mixed

Boolean flag to print/hide page header.

$radio_groups  : mixed

List of radio group objects IDs.

$radiobutton_groups  : mixed

List of radio buttons parent objects.

$rasterize_vector_images  : mixed

Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.

$re_space  : mixed

Array of $re_spaces parts.

$re_spaces  : mixed

Regular expression used to find blank characters (required for word-wrapping).

$rMargin  : mixed

Right margin.

$rtl  : mixed

Boolean flag to indicate if the document language is Right-To-Left.

$sig_obj_id  : mixed

Digital signature object ID.

$sign  : mixed

Boolean flag to enable document digital signature.

$signature_appearance  : mixed

Data for digital signature appearance.

$signature_data  : mixed

Digital signature data.

$signature_max_length  : mixed

Digital signature max length.

$spot_colors  : mixed

Array of Spot colors.

$start_transaction_page  : mixed

Store page number when startTransaction() is called.

$start_transaction_y  : mixed

Store Y position when startTransaction() is called.

$starting_page_number  : mixed

Starting page number.

$state  : mixed

Current document state.

$strokecolor  : mixed

Current stroke color.

$subject  : mixed

Document subject.

$svg_tag_depth  : mixed

Depth of the svg tag, to keep track if the svg tag is a subtag or the root tag.

$svgclipid  : mixed

ID of last SVG clipPath.

$svgclipmode  : mixed

Boolean value true when in SVG clipPath tag.

$svgclippaths  : mixed

Array of SVG clipPath commands.

$svgcliptm  : mixed

Array of SVG clipPath tranformation matrix.

$svgdefs  : mixed

Array of SVG defs.

$svgdefsmode  : mixed

Boolean value true when in SVG defs group.

$svgdir  : mixed

Directory used for the last SVG image.

$svggradientid  : mixed

ID of last SVG gradient.

$svggradients  : mixed

Array of SVG gradients.

$svgstyles  : mixed

Array of SVG properties.

$svgtext  : mixed

SVG text.

$svgtextmode  : mixed

SVG text properties.

$svgunit  : mixed

Deafult unit of measure for SVG.

$tagvspaces  : mixed

Array used for custom vertical spaces for HTML tags.

$tcpdflink  : mixed

If true print TCPDF meta link.

$tempfontsize  : mixed

Temporary font size in points.

$TextColor  : mixed

Commands for text color.

$textindent  : mixed

Text indentation value (used for text-indent CSS attribute).

$textrendermode  : mixed

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.

$textstrokewidth  : mixed

Text stroke width in doc units.

$thead  : mixed

Table header content to be repeated on each new page.

$theadMargins  : mixed

Margins used for table header.

$title  : mixed

Document title.

$tMargin  : mixed

Top margin.

$tmprtl  : mixed

Boolean flag used to force RTL or LTR string direction.

$tocpage  : mixed

Boolean flag true when we are on TOC (Table Of Content) page.

$transfmatrix  : mixed

Array of transformation matrix.

$transfmatrix_key  : mixed

Current key for transformation matrix.

$transfmrk  : mixed

Array used to store positions of graphics transformation blocks inside the page buffer.

$tsa_data  : mixed

Timestamping data.

$tsa_timestamp  : mixed

Boolean flag to enable document timestamping with TSA.

$txtshadow  : mixed

Text shadow data array.

$underline  : mixed

Underlining flag.

$ur  : mixed

Array with additional document-wide usage rights for the document.

$viewer_preferences  : mixed

PDF viewer preferences.

$w  : mixed

Current width of page in user unit.

$wPt  : mixed

Current width of page in points.

$x  : mixed

Current horizontal position in user unit for cell positioning.

$xobjects  : mixed

Array of XObjects.

$xobjid  : mixed

Current XObject ID.

$y  : mixed

Current vertical position in user unit for cell positioning.

$ZoomMode  : mixed

Zoom display mode.

Methods

__construct()  : mixed

This is the class constructor.

__destruct()  : mixed

Default destructor.

_destroy()  : mixed

Unset all class variables except the following critical variables.

_putshaders()  : mixed

Output gradient shaders.

AcceptPageBreak()  : bool

Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.

addEmptySignatureAppearance()  : mixed

Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)

AddFont()  : array<string|int, mixed>|false

Imports a TrueType, Type1, core, or CID0 font and makes it available.

addHtmlLink()  : int

Output anchor link.

addHTMLTOC()  : mixed

Output a Table Of Content Index (TOC) using HTML templates.

addJavascriptObject()  : int

Adds a javascript object and return object ID

AddLink()  : mixed

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().

AddPage()  : mixed

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).

addPageRegion()  : mixed

Add a single no-write region on selected page.

AddSpotColor()  : mixed

Defines a new spot color.

addTOC()  : mixed

Output a Table of Content Index (TOC).

addTOCPage()  : mixed

Adds a new TOC (Table Of Content) page to the document.

Annotation()  : mixed

Puts a markup annotation on a rectangular area of the page.

Arrow()  : mixed

Draws a grahic arrow.

Bookmark()  : mixed

Adds a bookmark.

Button()  : mixed

Creates a button field

Cell()  : mixed

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.

CheckBox()  : mixed

Creates a CheckBox field

Circle()  : mixed

Draws a circle.

Close()  : mixed

Terminates the PDF document.

colorRegistrationBar()  : mixed

Paints color transition registration bars

ComboBox()  : mixed

Creates a Combo-box field

commitTransaction()  : mixed

Delete the copy of the current TCPDF object used for undo operation.

CoonsPatchMesh()  : mixed

Paints a coons patch mesh.

copyPage()  : bool

Clone the specified page to a new page.

cropMark()  : mixed

Paints crop marks.

Curve()  : mixed

Draws a Bezier curve.

deletePage()  : bool

Remove the specified page.

Ellipse()  : mixed

Draws an ellipse.

endLayer()  : mixed

End the current PDF layer.

endPage()  : mixed

Terminate the current page

endTemplate()  : string|false

End the current XObject Template started with startTemplate() and restore the previous graphic state.

endTOCPage()  : mixed

Terminate the current TOC (Table Of Content) page

Error()  : mixed

Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.

fixHTMLCode()  : string

Cleanup HTML code (requires HTML Tidy library).

Footer()  : mixed

This method is used to render the page footer.

getAbsFontMeasure()  : float

Convert a relative font measure into absolute value.

GetAbsX()  : float

Returns the absolute X value of current position.

getAliasNbPages()  : string

Returns the string alias used for the total number of pages.

getAliasNumPage()  : string

Returns the string alias used for the page number.

getAliasRightShift()  : string

Returns the string alias used right align page numbers.

getAllSpotColors()  : array<string|int, mixed>

Returns the array of spot colors.

getAlpha()  : array<string, bool|string>

Get the alpha mode array (CA, ca, BM, AIS).

GetArrStringWidth()  : array<string|int, float>|float

Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>

getAutoPageBreak()  : bool

Return the auto-page-break mode (true or false).

getBarcode()  : string

Get current barcode.

getBreakMargin()  : int|float

Returns the page break margin.

getCellHeight()  : float

Return the cell height

getCellHeightRatio()  : float

return the height of cell repect font height.

getCellMargins()  : array<string|int, mixed>

Get the internal Cell margin array.

getCellPaddings()  : array<string|int, mixed>

Get the internal Cell padding array.

getCharBBox()  : false|array<string|int, mixed>

Returns the glyph bounding box of the specified character in the current font in user units.

GetCharWidth()  : float

Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).

getColumn()  : int

Return the current column number

getCSSBorderMargin()  : array<string|int, mixed>

Get the border-spacing from CSS attribute.

getCSSMargin()  : array<string|int, mixed>

Get the internal Cell margin from CSS attribute.

getCSSPadding()  : array<string|int, mixed>

Get the internal Cell padding from CSS attribute.

getDestination()  : array<string|int, mixed>

Return the Named Destination array.

getDocCreationTimestamp()  : int

Returns document creation timestamp in seconds.

getDocModificationTimestamp()  : int

Returns document modification timestamp in seconds.

getFontAscent()  : int

Return the font ascent value.

getFontBBox()  : array<string|int, mixed>

Returns the bounding box of the current font in user units.

getFontDescent()  : int

Return the font descent value

getFontFamily()  : string

Returns the current font family name.

getFontFamilyName()  : string

Return normalized font name

getFontSize()  : float

Returns the current font size.

getFontSizePt()  : int

Returns the current font size in points unit.

getFontSpacing()  : int

Get the amount to increase or decrease the space between characters in a text.

getFontStretching()  : float

Get the percentage of character stretching.

getFontStyle()  : string

Returns the current font style.

getFontSubsetting()  : bool

Return the default option for font subsetting.

getFooterFont()  : array<int, string|float|null>

Get Footer font.

getFooterMargin()  : float

Returns footer margin in user units.

getFormDefaultProp()  : array<string|int, mixed>

Return the default properties for form fields.

getGroupPageNo()  : int

Return the current page in the group.

getGroupPageNoFormatted()  : mixed

Returns the current group page number formatted as a string.

getHeaderData()  : array<string, mixed>

Returns header data: <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>

getHeaderFont()  : array<int, string|float|null>

Get header font.

getHeaderMargin()  : float

Returns header margin in user units.

getHTMLFontUnits()  : float

Convert HTML string containing font size value to points

getHTMLUnitToUnits()  : float

Convert HTML string containing value and unit of measure to user's units or points.

getImageRBX()  : float

Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image

getImageRBY()  : float

Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image

getImageScale()  : float

Returns the adjusting factor to convert pixels to user units.

getLastH()  : float

Get the last cell height.

GetLineWidth()  : int

Returns the current the line width.

getMargins()  : array<string|int, mixed>

Returns an array containing current margins: <ul> <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> </ul>

getNumberOfColumns()  : int

Return the current number of columns.

GetNumChars()  : int

Returns the numbero of characters in a string.

getNumLines()  : float

This method return the estimated number of lines for print a simple text string using Multicell() method.

getNumPages()  : int

Get the total number of insered pages.

getOriginalMargins()  : array<string|int, mixed>

Returns an array containing original margins: <ul> <li>$ret['left'] = left margin</li> <li>$ret['right'] = right margin</li> </ul>

getOverprint()  : array<string, bool|int>

Get the overprint mode array (OP, op, OPM).

getPage()  : int

Get current document page number.

getPageDimensions()  : array<string|int, mixed>

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>

getPageGroupAlias()  : string

Return the alias for the total number of pages in the current page group.

getPageHeight()  : int|float

Returns the page height in units.

getPageNumGroupAlias()  : string

Return the alias for the page number on the current page group.

getPageRegions()  : array<string|int, mixed>

Return an array of no-write page regions

getPageWidth()  : int|float

Returns the page width in units.

getPDFData()  : mixed

Returns the PDF data.

getRawCharWidth()  : float

Returns the length of the char in user unit for the current font.

getRTL()  : bool

Return the RTL status

getScaleFactor()  : int

Returns the scale factor (number of points in user unit).

getStringHeight()  : float

This method return the estimated height needed for printing a simple text string using the Multicell() method.

GetStringWidth()  : array<string|int, float>|float

Returns the length of a string in user unit. A font must be selected.<br>

getTextShadow()  : array<string|int, mixed>

Return the text shadow parameters array.

GetX()  : float

Returns the relative X value of current position.

GetY()  : float

Returns the ordinate of the current position.

Gradient()  : mixed

Output gradient.

Header()  : mixed

This method is used to render the page header.

hyphenateText()  : string

Returns text with soft hyphens.

Image()  : mixed|false

Puts an image in the page.

ImageEps()  : mixed

Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.

ImageSVG()  : mixed

Embedd a Scalable Vector Graphics (SVG) image.

importPDF()  : void

Import an existing PDF document

IncludeJS()  : mixed

Adds a javascript

isCharDefined()  : bool

Return true in the character is present in the specified font.

isRTLTextDir()  : bool

Return the current temporary RTL status

isUnicodeFont()  : bool

Return true if the current font is unicode type.

lastPage()  : mixed

Reset pointer to the last document page.

Line()  : mixed

Draws a line between two points.

LinearGradient()  : mixed

Paints a linear colour gradient.

Link()  : mixed

Puts a link on a rectangular area of the page.

ListBox()  : mixed

Creates a List-box field

Ln()  : mixed

Performs a line break.

MirrorH()  : mixed

Horizontal Mirroring.

MirrorL()  : mixed

Reflection against a straight line through point (x, y) with the gradient angle (angle).

MirrorP()  : mixed

Point reflection mirroring.

MirrorV()  : mixed

Verical Mirroring.

movePage()  : bool

Move a page to a previous position.

MultiCell()  : int

This method allows printing text with line breaks.

Open()  : mixed

This method begins the generation of the PDF document.

Output()  : string

Send the document to a given destination: string, local file or browser.

PageNo()  : int

Returns the current page number.

PageNoFormatted()  : mixed

Returns the current page number formatted as a string.

PieSector()  : mixed

Draw the sector of a circle.

PieSectorXY()  : mixed

Draw the sector of an ellipse.

pixelsToUnits()  : float

Converts pixels to User's Units.

Polycurve()  : mixed

Draws a poly-Bezier curve.

Polygon()  : mixed

Draws a polygon.

PolyLine()  : mixed

Draws a polygonal line

printTemplate()  : mixed

Print an XObject Template.

RadialGradient()  : mixed

Paints a radial colour gradient.

RadioButton()  : mixed

Creates a RadioButton field.

Rect()  : mixed

Draws a rectangle.

registrationMark()  : mixed

Paints a registration mark

registrationMarkCMYK()  : mixed

Paints a CMYK registration mark

RegularPolygon()  : mixed

Draws a regular polygon.

removePageRegion()  : mixed

Remove a single no-write region.

replaceMissingChars()  : string

Replace missing font characters on selected font with specified substitutions.

resetColumns()  : mixed

Remove columns and reset page margins.

resetHeaderTemplate()  : mixed

Reset the xobject template used by Header() method.

resetLastH()  : mixed

Reset the last cell height.

rollbackTransaction()  : TCPDF

This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().

Rotate()  : mixed

Rotate object.

RoundedRect()  : mixed

Draws a rounded rectangle.

RoundedRectXY()  : mixed

Draws a rounded rectangle.

Scale()  : mixed

Vertical and horizontal non-proportional Scaling.

ScaleX()  : mixed

Horizontal Scaling.

ScaleXY()  : mixed

Vertical and horizontal proportional Scaling.

ScaleY()  : mixed

Vertical Scaling.

selectColumn()  : mixed

Set position at a given column

serializeTCPDFtag()  : string

Serialize data to be used with TCPDF tag in HTML code.

setAbsX()  : mixed

Set the absolute X coordinate of the current pointer.

setAbsXY()  : mixed

Set the absolute X and Y coordinates of the current pointer.

setAbsY()  : mixed

Set the absolute Y coordinate of the current pointer.

setAllowLocalFiles()  : mixed

Whether to allow local file path in image html tags, when prefixed with file://

setAlpha()  : mixed

Set alpha for stroking (CA) and non-stroking (ca) operations.

setAuthor()  : mixed

Defines the author of the document.

setAutoPageBreak()  : mixed

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.

setBarcode()  : mixed

Set document barcode.

setBooklet()  : mixed

Set the booklet mode for double-sided pages.

setBookmark()  : mixed

Adds a bookmark - alias for Bookmark().

setCellHeightRatio()  : mixed

Set the height of the cell (line height) respect the font height.

setCellMargins()  : mixed

Set the internal Cell margins.

setCellPadding()  : mixed

Set the same internal Cell padding for top, right, bottom, left-

setCellPaddings()  : mixed

Set the internal Cell paddings.

setColor()  : string

Defines the color used by the specified type ('draw', 'fill', 'text').

setColorArray()  : string

Set the color array for the specified type ('draw', 'fill', 'text').

setColumnsArray()  : mixed

Set columns array.

setCompression()  : mixed

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.

setCreator()  : mixed

Defines the creator of the document. This is typically the name of the application that generates the PDF.

setDefaultMonospacedFont()  : mixed

Defines the default monospaced font.

setDefaultTableColumns()  : mixed

Set the default number of columns in a row for HTML tables.

setDestination()  : string|false

Add a Named Destination.

setDisplayMode()  : mixed

Defines the way the document is to be displayed by the viewer.

setDocCreationTimestamp()  : mixed

Set the document creation timestamp

setDocInfoUnicode()  : mixed

Turn on/off Unicode mode for document information dictionary (meta tags).

setDocModificationTimestamp()  : mixed

Set the document modification timestamp

setDrawColor()  : string

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.

setDrawColorArray()  : string

Defines the color used for all drawing operations (lines, rectangles and cell borders).

setDrawSpotColor()  : mixed

Defines the spot color used for all drawing operations (lines, rectangles and cell borders).

setEqualColumns()  : mixed

Set multiple columns of the same size

setExtraXMP()  : mixed

Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.

setExtraXMPRDF()  : mixed

Set additional XMP data to be added on the default XMP data just before the end of "rdf:RDF" tag.

setFillColor()  : string

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.

setFillColorArray()  : mixed

Defines the color used for all filling operations (filled rectangles and cell backgrounds).

setFillSpotColor()  : mixed

Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).

setFont()  : mixed

Sets the font used to print character strings.

setFontSize()  : mixed

Defines the size of the current font.

setFontSpacing()  : mixed

Set the amount to increase or decrease the space between characters in a text.

setFontStretching()  : mixed

Set the percentage of character stretching.

setFontSubsetting()  : mixed

Enable or disable default option for font subsetting.

setFooterData()  : mixed

Set footer data.

setFooterFont()  : mixed

Set footer font.

setFooterMargin()  : mixed

Set footer margin.

setFormDefaultProp()  : mixed

Set default properties for form fields.

setHeaderData()  : mixed

Set header data.

setHeaderFont()  : mixed

Set header font.

setHeaderMargin()  : mixed

Set header margin.

setHeaderTemplateAutoreset()  : mixed

Set a flag to automatically reset the xobject template used by Header() method at each page.

setHtmlLinksStyle()  : mixed

Set the color and font style for HTML links.

setHtmlVSpace()  : mixed

Set the vertical spaces for HTML tags.

setImageScale()  : mixed

Set the adjusting factor to convert pixels to user units.

setJPEGQuality()  : mixed

Set the default JPEG compression quality (1-100)

setKeywords()  : mixed

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

setLanguageArray()  : mixed

Set language array.

setLastH()  : mixed

Set the last cell height.

setLeftMargin()  : mixed

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.

setLineStyle()  : string

Set line style.

setLineWidth()  : mixed

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.

setLink()  : mixed

Defines the page and position a link points to.

setListIndentWidth()  : mixed

Set custom width for list indentation.

setLIsymbol()  : mixed

Set the default bullet to be used as LI bullet symbol

setMargins()  : mixed

Defines the left, top and right margins.

setOpenCell()  : mixed

Set the top/bottom cell sides to be open or closed when the cell cross the page.

setOverprint()  : mixed

Set overprint mode for stroking (OP) and non-stroking (op) painting operations.

setPage()  : mixed

Move pointer at the specified document page and update page dimensions.

setPageMark()  : mixed

Set start-writing mark on current page stream used to put borders and fills.

setPageOrientation()  : mixed

Set page orientation.

setPageRegions()  : mixed

Set no-write regions on page.

setPageUnit()  : mixed

Set the units of measure for the document.

setPDFVersion()  : mixed

Set the PDF version (check PDF reference for valid values).

setPrintFooter()  : mixed

Set a flag to print page footer.

setPrintHeader()  : mixed

Set a flag to print page header.

setProtection()  : mixed

Set document protection Remark: the protection against modification is for people who have the full Acrobat product.

setRasterizeVectorImages()  : mixed

Enable/disable rasterization of vector images using ImageMagick library.

setRightMargin()  : mixed

Defines the right margin. The method can be called before creating the first page.

setRTL()  : mixed

Enable or disable Right-To-Left language mode

setSignature()  : mixed

Enable document signature (requires the OpenSSL Library).

setSignatureAppearance()  : mixed

Set the digital signature appearance (a cliccable rectangle area to get signature properties)

setSpacesRE()  : mixed

Set regular expression to detect withespaces or word separators.

setSpotColor()  : string

Set the spot color for the specified type ('draw', 'fill', 'text').

setSRGBmode()  : mixed

Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.

setStartingPageNumber()  : mixed

Set the starting page number.

setSubject()  : mixed

Defines the subject of the document.

setTempRTL()  : mixed

Force temporary RTL language direction

setTextColor()  : string

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.

setTextColorArray()  : mixed

Defines the color used for text. It can be expressed in RGB components or gray scale.

setTextRenderingMode()  : mixed

Set Text rendering mode.

setTextShadow()  : mixed

Set parameters for drop shadow effect for text.

setTextSpotColor()  : mixed

Defines the spot color used for text.

setTimeStamp()  : mixed

Enable document timestamping (requires the OpenSSL Library).

setTitle()  : mixed

Defines the title of the document.

setTopMargin()  : mixed

Defines the top margin. The method can be called before creating the first page.

setUserRights()  : mixed

Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work.

setViewerPreferences()  : mixed

Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.

setVisibility()  : mixed

Set the visibility of the successive elements.

setX()  : mixed

Defines the abscissa of the current position.

setXY()  : mixed

Defines the abscissa and ordinate of the current position.

setY()  : mixed

Moves the current abscissa back to the left margin and sets the ordinate.

Skew()  : mixed

Skew.

SkewX()  : mixed

Skew horizontally.

SkewY()  : mixed

Skew vertically.

StarPolygon()  : mixed

Draws a star polygon

startLayer()  : mixed

Start a new pdf layer.

startPage()  : mixed

Starts a new page to the document. The page must be closed using the endPage() function.

startPageGroup()  : mixed

Create a new page group.

startTemplate()  : string|false

Start a new XObject Template.

startTransaction()  : mixed

Stores a copy of the current TCPDF object used for undo operation.

StartTransform()  : mixed

Starts a 2D tranformation saving current graphic state.

StopTransform()  : mixed

Stops a 2D tranformation restoring previous graphic state.

stringLeftTrim()  : string

Left trim the input string

stringRightTrim()  : string

Right trim the input string

stringTrim()  : string

Trim the input string

Text()  : mixed

Prints a text cell at the specified position.

TextField()  : mixed

Creates a text field

Translate()  : mixed

Translate graphic object horizontally and vertically.

TranslateX()  : mixed

Translate graphic object horizontally.

TranslateY()  : mixed

Translate graphic object vertically.

unhtmlentities()  : string

Reverse function for htmlentities.

Write()  : mixed

This method prints text from the current position.<br />

write1DBarcode()  : mixed

Print a Linear Barcode.

write2DBarcode()  : mixed

Print 2D Barcode.

writeHTML()  : mixed

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.

writeHTMLCell()  : mixed

Prints a cell (rectangular area) with optional borders, background color and html text string.

_addfield()  : mixed

Adds a javascript form field.

_beginpage()  : mixed

Initialize a new page.

_datastring()  : string

Format a data string for meta information

_datestring()  : string

Returns a formatted date for meta information

_dochecks()  : mixed

Check for locale-related bug

_dolinethrough()  : mixed

Line through text.

_dolinethroughw()  : mixed

Line through for rectangular text area.

_dooverline()  : mixed

Overline text.

_dooverlinew()  : mixed

Overline for rectangular text area.

_dounderline()  : mixed

Underline text.

_dounderlinew()  : mixed

Underline for rectangular text area.

_encrypt_data()  : string

Encrypt the input string.

_enddoc()  : mixed

Output end of document (EOF).

_endpage()  : mixed

Mark end of page.

_fixAES256Password()  : string

Convert password for AES-256 encryption mode

_generateencryptionkey()  : mixed

Compute encryption key

_getannotsrefs()  : string

Get references to page annotations.

_getobj()  : string

Return the starting object string for the selected object ID.

_getrawstream()  : mixed

get raw output stream.

_getxobjectdict()  : string

Return XObjects Dictionary.

_newobj()  : int

Begin a new object and return the object number.

_objectkey()  : int

Compute encryption key depending on object number where the encrypted data is stored.

_OEvalue()  : string

Compute OE value (used for encryption)

_out()  : mixed

Output a string to the document.

_outCurve()  : mixed

Append a cubic Bezier 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 Bezier control points.

_outCurveV()  : mixed

Append a cubic Bezier 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 Bezier control points.

_outCurveY()  : mixed

Append a cubic Bezier 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 Bezier control points.

_outellipticalarc()  : array<string|int, mixed>

Append an elliptical arc to the current path.

_outLine()  : mixed

Append a straight line segment from the current point to the point (x, y).

_outPoint()  : mixed

Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.

_outRect()  : mixed

Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.

_outRestoreGraphicsState()  : mixed

Outputs the "restore graphics state" operator 'Q'

_outSaveGraphicsState()  : mixed

Outputs the "save graphics state" operator 'q'

_Ovalue()  : string

Compute O value (used for encryption)

_putannotsobjs()  : mixed

Output annotations objects for all pages.

_putAPXObject()  : int

Put appearance streams XObject used to define annotation's appearance states.

_putbookmarks()  : mixed

Create a bookmark PDF string.

_putcatalog()  : int

Output Catalog.

_putcidfont0()  : mixed

Output CID-0 fonts.

_putdests()  : mixed

Insert Named Destinations.

_putEmbeddedFiles()  : mixed

Embedd the attached files.

_putencryption()  : mixed

Put encryption on PDF document.

_putextgstates()  : mixed

Put extgstates for object transparency

_putfonts()  : mixed

Output fonts.

_putheader()  : mixed

Output PDF File Header (7.5.2).

_putimages()  : mixed

Output images.

_putinfo()  : int

Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)

_putjavascript()  : mixed

Create a javascript PDF string.

_putocg()  : mixed

Put pdf layers.

_putpages()  : mixed

Output pages (and replace page number aliases).

_putresourcedict()  : mixed

Output Resources Dictionary.

_putresources()  : mixed

Output Resources.

_putsignature()  : mixed

Add certification signature (DocMDP or UR3) You can set only one signature type

_putspotcolors()  : mixed

Output Spot Colors Resources.

_puttruetypeunicode()  : mixed

Adds unicode fonts.<br> Based on PDF Reference 1.3 (section 5)

_putviewerpreferences()  : string

Output viewer preferences.

_putXMP()  : int

Put XMP data object and return ID.

_putxobjects()  : mixed

Output Form XObjects Templates.

_textstring()  : string

Format a text string for meta information

_UEvalue()  : string

Compute UE value (used for encryption)

_Uvalue()  : string

Compute U value (used for encryption)

addExtGState()  : int|void

Add transparency parameters to the current extgstate

addHTMLVertSpace()  : mixed

Add vertical spaces if needed.

adjustCellPadding()  : void|array<string|int, mixed>

Adjust the internal Cell padding array to take account of the line width.

allowedTCPDFtag()  : bool

Check if a TCPDF tag is allowed

applyTSA()  : string

NOT YET IMPLEMENTED Request TSA for a timestamp

checkPageBreak()  : bool

Add page if needed.

checkPageRegions()  : array<string|int, float>

Check page for no-write regions and adapt current coordinates and page margins if necessary.

Clip()  : mixed

Set a rectangular clipping area.

closeHTMLTagHandler()  : array<string|int, mixed>

Process closing tags.

convertSVGtMatrix()  : array<string|int, mixed>

Convert SVG transformation matrix to PDF.

drawHTMLTagBorder()  : mixed

Draw an HTML block border and fill

endSVGElementHandler()  : mixed

Sets the closing SVG element handler function for the XML parser.

fileExists()  : bool

Avoid multiple calls to an external server to see if a file exists

fitBlock()  : array<string|int, mixed>

Set the block dimensions accounting for page breaks and page/column fitting

getAllInternalPageNumberAliases()  : array<string|int, mixed>

Return an array containing all internal page aliases.

getBorderStartPosition()  : array<string|int, mixed>

Return the starting coordinates to draw an html border

getBuffer()  : string

Get buffer content.

getCachedFileContents()  : string

Keeps files in memory, so it doesn't need to downloaded everytime in a loop

getCellBorder()  : string

Returns the code to draw the cell border

getCellCode()  : string

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.

getCSSBorderDashStyle()  : int

Returns the border dash style from CSS property

getCSSBorderStyle()  : array<string|int, mixed>

Returns the border style array from CSS border properties

getCSSBorderWidth()  : int

Returns the border width from CSS property

getCSSFontSpacing()  : float

Returns the letter-spacing value from CSS value

getCSSFontStretching()  : float

Returns the percentage of font stretching from CSS value

getFontBuffer()  : string|false

Get font buffer content.

getFontsList()  : mixed

Fill the list of available fonts ($this->fontlist).

getGDgamma()  : mixed

Get the GD-corrected PNG gamma value from alpha color

getGraphicVars()  : array<string|int, mixed>

Returns current graphic variables as array.

getHtmlDomArray()  : array<string|int, mixed>

Returns the HTML DOM array.

getImageBuffer()  : string|false

Get image buffer content.

getInternalPageNumberAliases()  : array<string|int, mixed>

Return an array containing variations for the basic page number alias.

getPageBuffer()  : string

Get page buffer content.

getRemainingWidth()  : float

Returns the remaining width between the current position and margins.

getSignatureAppearanceArray()  : array<string|int, mixed>

Get the array that defines the signature appearance (page and rectangle coordinates).

getSpaceString()  : string

Returns the string used to find spaces

hashTCPDFtag()  : string

Calculates the hash value of the given data.

hyphenateWord()  : array<string|int, mixed>

Returns an array of chars containing soft hyphens.

ImagePngAlpha()  : mixed

Extract info from a PNG image with alpha channel using the Imagick or GD library.

inPageBody()  : bool

Check if we are on the page body (excluding page header and footer).

openHTMLTagHandler()  : array<string|int, mixed>

Process opening tags.

putHtmlListBullet()  : mixed

Output an HTML list bullet or ordered item symbol

removeTagNamespace()  : mixed

Return the tag name without the namespace

replaceBuffer()  : mixed

Replace the buffer content

replaceChar()  : int

Replace a char if is defined on the current font.

replaceRightShiftPageNumAliases()  : string

Replace right shift page number aliases with spaces to correct right alignment.

segSVGContentHandler()  : mixed

Sets the character data handler function for the XML parser.

setBuffer()  : mixed

Set buffer content (always append data).

setContentMark()  : mixed

Set start-writing mark on selected page.

setExtGState()  : mixed

Add an extgstate

setFontBuffer()  : mixed

Set font buffer content.

setFontSubBuffer()  : mixed

Set font buffer content.

setFooter()  : mixed

This method is used to render the page footer.

setGraphicVars()  : mixed

Set graphic variables.

setHeader()  : mixed

This method is used to render the page header.

setImageBuffer()  : int

Set image buffer content.

setImageSubBuffer()  : mixed

Set image buffer content for a specified sub-key.

setPageBoxTypes()  : mixed

Set page boxes to be included on page descriptions.

setPageBuffer()  : mixed

Set page buffer content.

setPageFormat()  : mixed

Change the format of the current page

setSVGStyles()  : string

Apply the requested SVG styles (*** TO BE COMPLETED ***)

setTableHeader()  : mixed

This method is used to render the table header on new page (if any).

sortBookmarks()  : mixed

Sort bookmarks for page and key.

startSVGElementHandler()  : mixed

Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)

SVGPath()  : array<string|int, mixed>

Draws an SVG path

SVGTransform()  : mixed

Apply SVG graphic transformation matrix.

swapMargins()  : mixed

Swap the left and right margins.

Transform()  : mixed

Apply graphic transformations.

unserializeTCPDFtag()  : array<string|int, mixed>

Unserialize data to be used with TCPDF tag in HTML code.