classes-TCPDF

03 May 2023

TCPDF

in package

$allowLocalFiles

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

protected bool $allowLocalFiles =
\false

$alpha

Alpha mode array.

protected mixed $alpha = array('CA' => 1, 'ca'
=> 1, 'BM' => '/Normal', 'AIS' => \false)

(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

$annotation_fonts

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

protected mixed $annotation_fonts =
array()

$author

Document author.

protected mixed $author = ''

$AutoPageBreak

Automatic page breaking.

protected mixed $AutoPageBreak

$barcode

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

protected mixed $barcode = \false

$bgcolor

Current background color.

protected mixed $bgcolor

$bMargin

Page break margin.

protected mixed $bMargin

$booklet

Booklet mode for double-sided pages.

protected mixed $booklet = \false

$bordermrk

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

protected mixed $bordermrk = array()

$buffer

Buffer holding in-memory PDF.

protected mixed $buffer

$bufferlen

Length of the buffer in bytes.

protected mixed $bufferlen = 0

$cache_file_length

Array used to store the lengths of cache files.

protected mixed $cache_file_length =
array()

$cell_height_ratio

Default cell height ratio.

protected float $cell_height_ratio =
\K_CELL_HEIGHT_RATIO

$cell_margin

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

protected mixed $cell_margin = array('T' => 0, 'R'
=> 0, 'B' => 0, 'L' => 0)

$cell_padding

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

protected mixed $cell_padding = array('T' => 0, 'R'
=> 0, 'B' => 0, 'L' => 0)

$check_page_regions

Boolean value true when page region check is active.

protected mixed $check_page_regions =
\true

$cleaned_ids

protected static mixed $cleaned_ids = array()

$clMargin

Cell left margin (used by regions).

protected mixed $clMargin

$cntmrk

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

protected mixed $cntmrk = array()

$ColorFlag

Indicates whether fill and text colors are different.

protected mixed $ColorFlag

$column_start_page

Starting page for columns.

protected mixed $column_start_page =
0

$columns

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

protected mixed $columns = array()

$colxshift

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

protected mixed $colxshift = array('x' => 0, 's'
=> array('H' => 0, 'V' => 0), 'p' => array('L' => 0,
'T' => 0, 'R' => 0, 'B' => 0))

$compress

Compression flag.

protected mixed $compress

$CoreFonts

Array of standard font names.

protected mixed $CoreFonts

$creator

Document creator.

protected mixed $creator = ''

$crMargin

Cell right margin (used by regions).

protected mixed $crMargin

$CurOrientation

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

protected mixed $CurOrientation

$current_column

Current column number.

protected mixed $current_column =
0

$CurrentFont

Current font info.

protected mixed $CurrentFont

$currpagegroup

Current page group number.

protected mixed $currpagegroup =
0

$custom_xmp

Custom XMP data.

protected mixed $custom_xmp = ''

$custom_xmp_rdf

Custom XMP RDF data.

protected mixed $custom_xmp_rdf =
''

$customlistindent

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

protected mixed $customlistindent =
-1

$default_form_prop

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.

protected mixed $default_form_prop =
array('lineWidth' => 1,
'borderStyle' => 'solid', 'fillColor' => array(255, 255,
255), 'strokeColor' => array(128, 128, 128))

$default_graphic_vars

Array of default graphic settings.

protected mixed $default_graphic_vars =
array()

$default_monospaced_font

Default monospace font.

protected mixed $default_monospaced_font =
'courier'

$default_table_columns

Default number of columns for html table.

protected mixed $default_table_columns =
4

$dests

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

protected mixed $dests = array()

$diffs

Array of encoding differences.

protected mixed $diffs = array()

$doc_creation_timestamp

Document creation date-time

protected mixed $doc_creation_timestamp

$doc_modification_timestamp

Document modification date-time

protected mixed $doc_modification_timestamp

$docinfounicode

If true set the document information dictionary in Unicode.

protected mixed $docinfounicode =
\true

$dpi

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

protected mixed $dpi = 72

$DrawColor

Commands for drawing color.

protected mixed $DrawColor

$efnames

Embedded Files Names

protected mixed $efnames = array()

$embeddedfiles

Array of files to embedd.

protected mixed $embeddedfiles =
array()

$empty_signature_appearance

Array of empty digital signature appearances.

protected mixed $empty_signature_appearance
= array()

$emptypagemrk

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

protected mixed $emptypagemrk = array()

$encoding

Default encoding.

protected mixed $encoding = 'UTF-8'

$encryptdata

Array containing encryption settings.

protected mixed $encryptdata = array()

$encrypted

IBoolean flag indicating whether document is protected.

protected mixed $encrypted

$endlinex

End position of the latest inserted line.

protected mixed $endlinex = 0

$epsmarker

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

protected mixed $epsmarker = 'x#!#EPS#!#x'

$extgstates

Array of transparency objects and parameters.

protected mixed $extgstates

$feps

Epsilon value used for float calculations.

protected mixed $feps = 0.005

$fgcolor

Current foreground color.

protected mixed $fgcolor

$fhPt

Height of page format in points.

protected mixed $fhPt

$file_id

File ID (used on document trailer).

protected mixed $file_id

$fileContentCache

Cache array for file content

protected array<string|int,
mixed> $fileContentCache =
array()

$FillColor

Commands for filling color.

protected mixed $FillColor

$font_obj_ids

Store the font object IDs.

protected mixed $font_obj_ids = array()

$font_spacing

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

protected mixed $font_spacing = 0

$font_stretching

Percentage of character stretching.

protected mixed $font_stretching =
100

$font_subsetting

Boolean flag: if true enables font subsetting by default.

protected mixed $font_subsetting =
\true

$FontAscent

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

protected mixed $FontAscent

$FontDescent

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

protected mixed $FontDescent

$FontFamily

Current font family.

protected mixed $FontFamily

$FontFiles

Array of font files.

protected mixed $FontFiles = array()

$fontkeys

Store the font keys.

protected mixed $fontkeys = array()

$fontlist

List of available fonts on filesystem.

protected mixed $fontlist = array()

$fonts

Array of used fonts.

protected mixed $fonts = array()

$FontSize

Current font size in user unit.

protected mixed $FontSize

$FontSizePt

Current font size in points.

protected mixed $FontSizePt

$FontStyle

Current font style.

protected mixed $FontStyle

$footer_font

Default font used on page footer.

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

$footer_line_color

Color for footer line (RGB array).

protected array<string|int, int>
$footer_line_color =
array(0, 0,
0)

$footer_margin

Minimum distance between footer and bottom page margin.

protected mixed $footer_margin

$footer_text_color

Color for footer text (RGB array).

protected array<string|int, int>
$footer_text_color =
array(0, 0,
0)

$footerlen

Array used to store footer length of each page.

protected mixed $footerlen = array()

$footerpos

Array used to store footer positions of each page.

protected mixed $footerpos = array()

$force_srgb

If true force sRGB color profile for all document.

protected mixed $force_srgb = \false

$form_action

Current form action (used during XHTML rendering).

protected mixed $form_action = ''

$form_enctype

Current form encryption type (used during XHTML rendering).

protected mixed $form_enctype = 'application/x-www-form-urlencoded'

$form_mode

Current method to submit forms.

protected mixed $form_mode = 'post'

$form_obj_id

List of form annotations IDs.

protected mixed $form_obj_id = array()

$fwPt

Width of page format in points.

protected mixed $fwPt

$gdgammacache

Cache array for computed GD gamma values.

protected mixed $gdgammacache = array()

$gradients

Array for storing gradient information.

protected mixed $gradients = array()

$h

Current height of page in user unit.

protected mixed $h

$header_font

Default font used on page header.

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

$header_line_color

Color for header line (RGB array).

protected array<string|int, int>
$header_line_color =
array(0, 0,
0)

$header_logo

Header image logo.

protected mixed $header_logo = ''

$header_logo_width

Width of header image logo in user units.

protected mixed $header_logo_width =
30

$header_margin

Minimum distance between header and top page margin.

protected mixed $header_margin

$header_string

String to print on page header after title.

protected mixed $header_string =
''

$header_text_color

Color for header text (RGB array).

protected array<string|int, int>
$header_text_color =
array(0, 0,
0)

$header_title

Title to be printed on default page header.

protected mixed $header_title = ''

$header_xobj_autoreset

If true reset the Header Xobject template at each page

protected mixed $header_xobj_autoreset =
\false

$header_xobjid

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

protected mixed $header_xobjid =
\false

$hPt

Current height of page in points.

protected mixed $hPt

$HREF

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

protected mixed $HREF = array()

$htmlLinkColorArray

Default color for html links.

protected mixed $htmlLinkColorArray =
array(0, 0,
255)

$htmlLinkFontStyle

Default font style to add to html links.

protected mixed $htmlLinkFontStyle =
'U'

$htmlvspace

Count the latest inserted vertical spaces on HTML.

protected mixed $htmlvspace = 0

$imagekeys

Store the image keys.

protected mixed $imagekeys = array()

$images

Array of used images.

protected mixed $images = array()

$img_rb_x

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

protected mixed $img_rb_x

$img_rb_y

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

protected mixed $img_rb_y

$imgscale

Adjusting factor to convert pixels to user units.

protected mixed $imgscale = 1

$InFooter

Flag set when processing page footer.

protected mixed $InFooter = \false

$InHeader

Flag set when processing page header.

protected mixed $InHeader = \false

$inthead

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

protected mixed $inthead = \false

$intmrk

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

protected mixed $intmrk = array()

$inxobj

Boolean value true when we are inside an XObject.

protected mixed $inxobj = \false

$isunicode

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

protected mixed $isunicode = \false

$javascript

Javascript code.

protected mixed $javascript = ''

$jpeg_quality

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

protected mixed $jpeg_quality

$js_objects

Javascript objects array.

protected mixed $js_objects = array()

$k

Scale factor (number of points in user unit).

protected mixed $k

$keywords

Document keywords.

protected mixed $keywords = ''

$l

Language templates.

protected mixed $l

$last_enc_key

Last RC4 key encrypted (cached for optimisation).

protected mixed $last_enc_key

$last_enc_key_c

Last RC4 computed key.

protected mixed $last_enc_key_c

$lasth

Height of last cell printed.

protected mixed $lasth

$LayoutMode

Layout display mode.

protected mixed $LayoutMode

$linestyleCap

PDF string for CAP value of the last line.

protected mixed $linestyleCap = '0 J'

$linestyleDash

PDF string for dash value of the last line.

protected mixed $linestyleDash =
'[] 0
d'

$linestyleJoin

PDF string for join value of the last line.

protected mixed $linestyleJoin =
'0
j'

$linestyleWidth

PDF string for width value of the last line.

protected mixed $linestyleWidth =
''

$linethrough

line through state

protected mixed $linethrough

$LineWidth

Line width in user unit.

protected mixed $LineWidth

$links

Array of internal links.

protected mixed $links = array()

$lispacer

Spacer string for LI tags.

protected mixed $lispacer = ''

$listcount

HTML PARSER: array count list items on nested lists.

protected mixed $listcount = array()

$listindent

HTML PARSER: indent amount for lists.

protected mixed $listindent = 0

$listindentlevel

HTML PARSER: current list indententation level.

protected mixed $listindentlevel =
0

$listnum

HTML PARSER: current list nesting level.

protected mixed $listnum = 0

$listordered

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

protected mixed $listordered = array()

$lisymbol

Symbol used for HTML unordered list items.

protected mixed $lisymbol = ''

$lMargin

Left margin.

protected mixed $lMargin

$maxselcol

Maximum page and column selected.

protected mixed $maxselcol = array('page' => 0,
'column' => 0)

$n

Current object number.

protected mixed $n

$n_dests

Object ID for Named Destinations

protected mixed $n_dests

$n_js

Javascript counter.

protected mixed $n_js

$newline

Boolean flag to indicate if a new line is created.

protected mixed $newline = \true

$newpagegroup

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

protected mixed $newpagegroup = array()

$num_columns

Number of colums.

protected mixed $num_columns = 1

$numfonts

Counts the number of fonts.

protected mixed $numfonts = 0

$numimages

Counts the number of pages.

protected mixed $numimages = 0

$numpages

Counts the number of pages.

protected mixed $numpages = 0

$objcopy

Cloned copy of the current class object.

protected mixed $objcopy

$offsets

Array of object offsets.

protected mixed $offsets = array()

$opencell

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

protected mixed $opencell = \true

$openMarkedContent

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

protected mixed $openMarkedContent =
\false

$original_lMargin

Original left margin value.

protected mixed $original_lMargin

$original_rMargin

Original right margin value.

protected mixed $original_rMargin

$OutlineRoot

Outline root for bookmark.

protected mixed $OutlineRoot

$outlines

Outlines for bookmark.

protected mixed $outlines = array()

$overline

Overlining flag.

protected mixed $overline

$overprint

Overprint mode array.

protected array<string,
bool|int> $overprint = array('OP' => \false,
'op' => \false, 'OPM' => 0)

(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

$page

Current page number.

protected mixed $page

$page_boxes

Define the page boundaries boxes to be set on document.

protected mixed $page_boxes = array('MediaBox',
'CropBox', 'BleedBox', 'TrimBox', 'ArtBox')

$page_obj_id

ID of page objects.

protected mixed $page_obj_id = array()

$page_regions

Array of no-write regions.

protected mixed $page_regions = 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)

$PageAnnots

Array of Annotations in pages.

protected mixed $PageAnnots = array()

$PageBreakTrigger

Threshold used to trigger page breaks.

protected mixed $PageBreakTrigger

$pagedim

Page dimensions.

protected mixed $pagedim = array()

$pagegroups

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

protected mixed $pagegroups = array()

$pagelen

Array containing page lengths in bytes.

protected mixed $pagelen = array()

$PageMode

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

protected mixed $PageMode

$pageobjects

Array of object IDs for each page.

protected mixed $pageobjects = array()

$pageopen

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

protected mixed $pageopen = array()

$pages

Array containing pages.

protected mixed $pages = array()

$pdfa_mode

If true set the document to PDF/A mode.

protected mixed $pdfa_mode = \false

$pdfa_version

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

protected mixed $pdfa_version = 1

$pdflayers

Array of PDF layers data.

protected mixed $pdflayers = array()

$pdfunit

Default unit of measure for document.

protected mixed $pdfunit = 'mm'

$PDFVersion

PDF version.

protected mixed $PDFVersion = '1.7'

$premode

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

protected mixed $premode = \false

$print_footer

Boolean flag to print/hide page footer.

protected mixed $print_footer = \true

$print_header

Boolean flag to print/hide page header.

protected mixed $print_header = \true

$radio_groups

List of radio group objects IDs.

protected mixed $radio_groups = array()

$radiobutton_groups

List of radio buttons parent objects.

protected mixed $radiobutton_groups =
array()

$rasterize_vector_images

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

protected mixed $rasterize_vector_images =
\false

$re_space

Array of $re_spaces parts.

protected mixed $re_space = array('p' =>
'[^\\S\\xa0]', 'm' => '')

$re_spaces

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

protected mixed $re_spaces = '/[^\\S\\xa0]/'

$rMargin

Right margin.

protected mixed $rMargin

$rtl

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

protected mixed $rtl = \false

$sig_obj_id

Digital signature object ID.

protected mixed $sig_obj_id = 0

$sign

Boolean flag to enable document digital signature.

protected mixed $sign = \false

$signature_appearance

Data for digital signature appearance.

protected mixed $signature_appearance =
array('page'
=> 1, 'rect' => '0 0 0 0')

$signature_data

Digital signature data.

protected mixed $signature_data =
array()

$signature_max_length

Digital signature max length.

protected mixed $signature_max_length =
11742

$spot_colors

Array of Spot colors.

protected mixed $spot_colors = array()

$start_transaction_page

Store page number when startTransaction() is called.

protected mixed $start_transaction_page =
0

$start_transaction_y

Store Y position when startTransaction() is called.

protected mixed $start_transaction_y =
0

$starting_page_number

Starting page number.

protected mixed $starting_page_number =
1

$state

Current document state.

protected mixed $state

$strokecolor

Current stroke color.

protected mixed $strokecolor

$subject

Document subject.

protected mixed $subject = ''

$svg_tag_depth

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

protected mixed $svg_tag_depth =
0

$svgclipid

ID of last SVG clipPath.

protected mixed $svgclipid = 0

$svgclipmode

Boolean value true when in SVG clipPath tag.

protected mixed $svgclipmode = \false

$svgclippaths

Array of SVG clipPath commands.

protected mixed $svgclippaths = array()

$svgcliptm

Array of SVG clipPath tranformation matrix.

protected mixed $svgcliptm = array()

$svgdefs

Array of SVG defs.

protected mixed $svgdefs = array()

$svgdefsmode

Boolean value true when in SVG defs group.

protected mixed $svgdefsmode = \false

$svgdir

Directory used for the last SVG image.

protected mixed $svgdir = ''

$svggradientid

ID of last SVG gradient.

protected mixed $svggradientid =
0

$svggradients

Array of SVG gradients.

protected mixed $svggradients = array()

$svgstyles

Array of SVG properties.

protected mixed $svgstyles = array(array('alignment-baseline'
=> 'auto', 'baseline-shift' => 'baseline', 'clip' =>
'auto', 'clip-path' => 'none', 'clip-rule' => 'nonzero',
'color' => 'black', 'color-interpolation' => 'sRGB',
'color-interpolation-filters' => 'linearRGB', 'color-profile'
=> 'auto', 'color-rendering' => 'auto', 'cursor' =>
'auto', 'direction' => 'ltr', 'display' => 'inline',
'dominant-baseline' => 'auto', 'enable-background' =>
'accumulate', 'fill' => 'black', 'fill-opacity' => 1,
'fill-rule' => 'nonzero', 'filter' => 'none', 'flood-color'
=> 'black', 'flood-opacity' => 1, 'font' => '',
'font-family' => 'helvetica', 'font-size' => 'medium',
'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', 'kerning' => 'auto',
'letter-spacing' => 'normal', 'lighting-color' => 'white',
'marker' => '', 'marker-end' => 'none', 'marker-mid' =>
'none', 'marker-start' => 'none', 'mask' => 'none', 'opacity'
=> 1, 'overflow' => 'auto', 'pointer-events' =>
'visiblePainted', 'shape-rendering' => 'auto', 'stop-color'
=> 'black', 'stop-opacity' => 1, 'stroke' => 'none',
'stroke-dasharray' => 'none', 'stroke-dashoffset' => 0,
'stroke-linecap' => 'butt', 'stroke-linejoin' => 'miter',
'stroke-miterlimit' => 4, 'stroke-opacity' => 1,
'stroke-width' => 1, 'text-anchor' => 'start',
'text-decoration' => 'none', 'text-rendering' => 'auto',
'unicode-bidi' => 'normal', 'visibility' => 'visible',
'word-spacing' => 'normal', 'writing-mode' => 'lr-tb',
'text-color' => 'black', 'transfmatrix' => array(1, 0, 0, 1,
0, 0)))

$svgtext

SVG text.

protected mixed $svgtext = ''

$svgtextmode

SVG text properties.

protected mixed $svgtextmode = array()

$svgunit

Deafult unit of measure for SVG.

protected mixed $svgunit = 'px'

$tagvspaces

Array used for custom vertical spaces for HTML tags.

protected mixed $tagvspaces = array()

$tcpdflink

If true print TCPDF meta link.

protected mixed $tcpdflink = \true

$tempfontsize

Temporary font size in points.

protected mixed $tempfontsize = 10

$TextColor

Commands for text color.

protected mixed $TextColor

$textindent

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

protected mixed $textindent = 0

$textrendermode

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.

protected mixed $textrendermode =
0

$textstrokewidth

Text stroke width in doc units.

protected mixed $textstrokewidth =
0

$thead

Table header content to be repeated on each new page.

protected mixed $thead = ''

$theadMargins

Margins used for table header.

protected mixed $theadMargins = array()

$title

Document title.

protected mixed $title = ''

$tMargin

Top margin.

protected mixed $tMargin

$tmprtl

Boolean flag used to force RTL or LTR string direction.

protected mixed $tmprtl = \false

$tocpage

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

protected mixed $tocpage = \false

$transfmatrix

Array of transformation matrix.

protected mixed $transfmatrix = array()

$transfmatrix_key

Current key for transformation matrix.

protected mixed $transfmatrix_key =
0

$transfmrk

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

protected mixed $transfmrk = array()

keys are the page numbers

$tsa_data

Timestamping data.

protected mixed $tsa_data = array()

$tsa_timestamp

Boolean flag to enable document timestamping with TSA.

protected mixed $tsa_timestamp =
\false

$txtshadow

Text shadow data array.

protected mixed $txtshadow = array('enabled' =>
\false, 'depth_w' => 0, 'depth_h' => 0, 'color' => \false,
'opacity' => 1, 'blend_mode' => 'Normal')

$underline

Underlining flag.

protected mixed $underline

$ur

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

protected mixed $ur = array()

$viewer_preferences

PDF viewer preferences.

protected mixed $viewer_preferences

$w

Current width of page in user unit.

protected mixed $w

$wPt

Current width of page in points.

protected mixed $wPt

$x

Current horizontal position in user unit for cell positioning.

protected mixed $x

$xobjects

Array of XObjects.

protected mixed $xobjects = array()

$xobjid

Current XObject ID.

protected mixed $xobjid = ''

$y

Current vertical position in user unit for cell positioning.

protected mixed $y

$ZoomMode

Zoom display mode.

protected mixed $ZoomMode

__construct()

This is the class constructor.

public __construct([string $orientation
= 'P'
][,
string $unit
= 'mm'
][,
mixed $format
= 'A4'
][,
bool $unicode
= true
][,
string $encoding
= 'UTF-8'
][,
bool $diskcache
= false
][,
false|int $pdfa
= false
]) : mixed

It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

Parameters

$orientation : string = 'P'

page orientation. Possible values are (case insensitive):

P or Portrait (default)
L or Landscape
'' (empty string) for automatic orientation

$unit : string = 'mm'

User measure unit. Possible values are:

pt: point
mm: millimeter (default)
cm: centimeter
in: inch

A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.

$format : mixed = 'A4'

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

$unicode : bool = true

TRUE means that the input text is unicode (default = true)

$encoding : string = 'UTF-8'

Charset encoding (used only when converting back html entities); default is UTF-8.

$diskcache : bool = false

DEPRECATED FEATURE

$pdfa : false|int = false

If not false, set the document to PDF/A mode and the good version (1 or 3).

Return values

mixed —

__destruct()

Default destructor.

public __destruct()
: mixed

Return values

mixed —

_destroy()

Unset all class variables except the following critical variables.

public _destroy([bool $destroyall
= false
][,
bool $preserve_objcopy
= false
]) : mixed

Parameters

$destroyall : bool = false: if true destroys all class variables, otherwise preserves critical variables.
$preserve_objcopy : bool = false: if true preserves the objcopy variable

Return values

mixed —

_putshaders()

Output gradient shaders.

public _putshaders()
: mixed

Return values

mixed —

AcceptPageBreak()

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

public AcceptPageBreak()
: bool

The default implementation returns a value according to the mode selected by SetAutoPageBreak().
This method is called automatically and should not be called directly by the application.

Return values

bool —

addEmptySignatureAppearance()

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

public addEmptySignatureAppearance(float $x,
float $y,
float $w,
float $h[,
int $page
= -1
][,
string $name
= ''
]) : mixed

Parameters

$x : float: Abscissa of the upper-left corner.
$y : float: Ordinate of the upper-left corner.
$w : float: Width of the signature area.
$h : float: Height of the signature area.
$page : int = -1: option page number (if < 0 the current page is used).
$name : string = '': Name of the signature.

Return values

mixed —

AddFont()

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

public AddFont(string $family[,
string $style
= ''
][,
string $fontfile
= ''
][,
mixed $subset
= 'default'
]) : array<string|int,
mixed>|false

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.

Parameters

$family : string

Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.

$style : string = ''

Font style. Possible values are (case insensitive):

empty string: regular (default)
B: bold
I: italic
BI or IB: bold italic

$fontfile : string = ''

The font definition file. By default, the name is built from the family and style, in lower case with no spaces.

$subset : mixed = 'default'

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.

Return values

array<string|int, mixed>|false —

array containing the font data, or false in case of error.

addHtmlLink()

Output anchor link.

public addHtmlLink(string $url,
string $name[,
bool $fill
= false
][,
bool $firstline
= false
][,
array<string|int,
mixed>|null $color
= null
][,
string $style
= -1
][,
bool $firstblock
= false
]) : int

Parameters

$url : string: link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
$name : string: link name
$fill : bool = false: Indicates if the cell background must be painted (true) or transparent (false).
$firstline : bool = false: if true prints only the first line and return the remaining string.
$color : array<string|int, mixed>|null = null: array of RGB text color
$style : string = -1: font style (U, D, B, I)
$firstblock : bool = false: if true the string is the starting of a line.

Return values

int —

the number of cells used or the remaining text if $firstline = true;

addHTMLTOC()

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

public addHTMLTOC([int|null $page
= null
][,
string $toc_name
= 'TOC'
][,
array<string|int,
mixed> $templates
= array()
][,
bool $correct_align
= true
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ]) :
mixed

This method must be called after all Bookmarks were set. 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.

Parameters

$page : int|null = null: page number where this TOC should be inserted (leave empty for current page).
$toc_name : string = 'TOC': name to use for TOC bookmark.
$templates : array<string|int, mixed> = array(): array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.
$correct_align : bool = true: if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
$style : string = '': Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
$color : array<string|int, mixed> = array(0, 0, 0): RGB color array for title (values from 0 to 255).

Return values

mixed —

addJavascriptObject()

Adds a javascript object and return object ID

public addJavascriptObject(string $script[,
bool $onload
= false
]) : int

Parameters

$script : string: Javascript code
$onload : bool = false: if true executes this object when opening the document

Return values

int —

internal object ID

AddLink()

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

public AddLink()
: mixed

Return values

mixed —

AddPage()

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

public AddPage([string $orientation
= ''
][,
mixed $format
= ''
][,
bool $keepmargins
= false
][,
bool $tocpage
= false
]) : mixed

The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.

Parameters

$orientation : string = ''

page orientation. Possible values are (case insensitive):

P or PORTRAIT (default)
L or LANDSCAPE

$format : mixed = ''

The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().

$keepmargins : bool = false

if true overwrites the default page margins with the current margins

$tocpage : bool = false

if true set the tocpage state to true (the added page will be used to display Table Of Content).

Return values

mixed —

addPageRegion()

Add a single no-write region on selected page.

public addPageRegion(array<string|int,
mixed> $region)
: mixed

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.

Parameters

$region : array<string|int, mixed>: 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).

Return values

mixed —

AddSpotColor()

Defines a new spot color.

public AddSpotColor(string $name,
float $c,
float $m,
float $y,
float $k)
: mixed

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.

Parameters

$name : string: Full name of the spot color.
$c : float: Cyan color for CMYK. Value between 0 and 100.
$m : float: Magenta color for CMYK. Value between 0 and 100.
$y : float: Yellow color for CMYK. Value between 0 and 100.
$k : float: Key (Black) color for CMYK. Value between 0 and 100.

Return values

mixed —

addTOC()

Output a Table of Content Index (TOC).

public addTOC([int|null $page
= null
][,
string $numbersfont
= ''
][,
string $filler
= '.'
][,
string $toc_name
= 'TOC'
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ]) :
mixed

Parameters

$page : int|null = null: page number where this TOC should be inserted (leave empty for current page).
$numbersfont : string = '': set the font for page numbers (please use monospaced font for better alignment).
$filler : string = '.': string used to fill the space between text and page number.
$toc_name : string = 'TOC': name to use for TOC bookmark.
$style : string = '': Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
$color : array<string|int, mixed> = array(0, 0, 0): RGB color array for bookmark title (values from 0 to 255).

Return values

mixed —

addTOCPage()

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

public addTOCPage([string $orientation
= ''
][,
mixed $format
= ''
][,
bool $keepmargins
= false
]) : mixed

Parameters

$orientation : string = '': page orientation.
$format : mixed = '': The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
$keepmargins : bool = false: if true overwrites the default page margins with the current margins

Return values

mixed —

Annotation()

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

public Annotation(float $x,
float $y,
float $w,
float $h,
string $text[,
array<string|int,
mixed> $opt
= array('Subtype'
=> 'Text') ], int $spaces)
: mixed

!!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!

Parameters

$x : float: Abscissa of the upper-left corner of the rectangle
$y : float: Ordinate of the upper-left corner of the rectangle
$w : float: Width of the rectangle
$h : float: Height of the rectangle
$text : string: annotation text or alternate content
$opt : array<string|int, mixed> = array('Subtype' => 'Text'): array of options (see section 8.4 of PDF reference 1.7).
$spaces : int: number of spaces on the text to link

Return values

mixed —

Arrow()

Draws a grahic arrow.

public Arrow(float $x0,
float $y0,
float $x1,
float $y1,
int $head_style[,
float $arm_size
= 5
][,
int $arm_angle
= 15
]) : mixed

Parameters

$x0 : float: Abscissa of first point.
$y0 : float: Ordinate of first point.
$x1 : float: Abscissa of second point.
$y1 : float: Ordinate of second point.
$head_style : int: (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
$arm_size : float = 5: length of arrowhead arms
$arm_angle : int = 15: angle between an arm and the shaft

Return values

mixed —

Bookmark()

Adds a bookmark.

public Bookmark(string $txt,
int $level[,
float $y
= -1
][,
int|string $page
= ''
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ][,
float $x
= -1
][,
mixed $link
= ''
]) : mixed

Parameters

$txt : string: Bookmark description.
$level : int: Bookmark level (minimum value is 0).
$y : float = -1: Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
$page : int|string = '': Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
$style : string = '': Font style: B = Bold, I = Italic, BI = Bold + Italic.
$color : array<string|int, mixed> = array(0, 0, 0): RGB color array (values from 0 to 255).
$x : float = -1: X position in user units of the bookmark on the selected page (default = -1 = current position;).
$link : mixed = '': URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).

Return values

mixed —

Button()

Creates a button field

public Button(string $name,
int $w,
int $h,
string $caption,
mixed $action[,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed

Parameters

$name : string: field name
$w : int: width
$h : int: height
$caption : string: caption.
$action : mixed: action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
$prop : array<string|int, mixed> = array(): javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
$opt : array<string|int, mixed> = array(): annotation parameters. Possible values are described on official PDF32000_2008 reference.
$x : float|null = null: Abscissa of the upper-left corner of the rectangle
$y : float|null = null: Ordinate of the upper-left corner of the rectangle
$js : bool = false: if true put the field using JavaScript (requires Acrobat Writer to be rendered).

Return values

mixed —

Cell()

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.

public Cell(float $w,
float $h[,
string $txt
= ''
], mixed $border,
int $ln[,
string $align
= ''
][,
bool $fill
= false
][,
mixed $link
= ''
], int $stretch[,
bool $ignore_min_height
= false
][,
string $calign
= 'T'
][,
string $valign
= 'M'
]) : mixed

Parameters

$w : float

Cell width. If 0, the cell extends up to the right margin.

$h : float

Cell height. Default value: 0.

$txt : string = ''

String to print. Default value: empty string.

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

$ln : int

Indicates where the current position should go after the call. Possible values are:

0: to the right (or left for RTL languages)
1: to the beginning of the next line
2: below

Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.

$align : string = ''

Allows to center or align the text. Possible values are:

L or empty string: left align (default value)
C: center
R: right align
J: justify

$fill : bool = false

Indicates if the cell background must be painted (true) or transparent (false).

$link : mixed = ''

URL or identifier returned by AddLink().

$stretch : int

font stretch mode:

0 = disabled
1 = horizontal scaling only if text is larger than cell width
2 = forced horizontal scaling to fit cell width
3 = character spacing only if text is larger than cell width
4 = forced character spacing to fit cell width

General font stretching and scaling values will be preserved when possible.

$ignore_min_height : bool = false

if true ignore automatic minimum height value.

$calign : string = 'T'

cell vertical alignment relative to the specified Y value. Possible values are:

T : cell top
C : center
B : cell bottom
A : font top
L : font baseline
D : font bottom

$valign : string = 'M'

text vertical alignment inside the cell. Possible values are:

T : top
C : center
B : bottom

Return values

mixed —

CheckBox()

Creates a CheckBox field

public CheckBox(string $name,
int $w[,
bool $checked
= false
][,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
string $onvalue
= 'Yes'
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed

Parameters

$name : string: field name
$w : int: width
$checked : bool = false: define the initial state.
$prop : array<string|int, mixed> = array(): javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
$opt : array<string|int, mixed> = array(): annotation parameters. Possible values are described on official PDF32000_2008 reference.
$onvalue : string = 'Yes': value to be returned if selected.
$x : float|null = null: Abscissa of the upper-left corner of the rectangle
$y : float|null = null: Ordinate of the upper-left corner of the rectangle
$js : bool = false: if true put the field using JavaScript (requires Acrobat Writer to be rendered).

Return values

mixed —

Circle()

Draws a circle.

public Circle(float $x0,
float $y0,
float $r,
float $angstr[,
float $angend
= 360
][,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
][,
int $nc
= 2
]) : mixed

A circle is formed from n Bezier curves.

Parameters

$x0 : float: Abscissa of center point.
$y0 : float: Ordinate of center point.
$r : float: Radius.
$angstr : float: Angle start of draw line. Default value: 0.
$angend : float = 360: Angle finish of draw line. Default value: 360.
$style : string = '': Style of rendering. See the getPathPaintOperator() function for more information.
$line_style : array<string|int, mixed> = array(): Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).
$fill_color : array<string|int, mixed> = array(): Fill color. Format: array(red, green, blue). Default value: default color (empty array).
$nc : int = 2: Number of curves used to draw a 90 degrees portion of circle.

Return values

mixed —

Close()

Terminates the PDF document.

public Close()
: mixed

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.

Return values

mixed —

colorRegistrationBar()

Paints color transition registration bars

public colorRegistrationBar(float $x,
float $y,
float $w,
float $h[,
bool $transition
= true
][,
bool $vertical
= false
][,
string $colors
= 'A,R,G,B,C,M,Y,K'
]) : mixed

Parameters

$x : float: abscissa of the top left corner of the rectangle.
$y : float: ordinate of the top left corner of the rectangle.
$w : float: width of the rectangle.
$h : float: height of the rectangle.
$transition : bool = true: if true prints tcolor transitions to white.
$vertical : bool = false: if true prints bar vertically.
$colors : string = 'A,R,G,B,C,M,Y,K': colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.

Return values

mixed —

ComboBox()

Creates a Combo-box field

public ComboBox(string $name,
int $w,
int $h,
array<string|int,
mixed> $values[,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed

Parameters

$name : string: field name
$w : int: width
$h : int: height
$values : array<string|int, mixed>: array containing the list of values.
$prop : array<string|int, mixed> = array(): javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
$opt : array<string|int, mixed> = array(): annotation parameters. Possible values are described on official PDF32000_2008 reference.
$x : float|null = null: Abscissa of the upper-left corner of the rectangle
$y : float|null = null: Ordinate of the upper-left corner of the rectangle
$js : bool = false: if true put the field using JavaScript (requires Acrobat Writer to be rendered).

Return values

mixed —

commitTransaction()

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

public commitTransaction()
: mixed

Return values

mixed —

CoonsPatchMesh()

Paints a coons patch mesh.

public CoonsPatchMesh(float $x,
float $y,
float $w,
float $h[,
array<string|int,
mixed> $col1
= array()
][,
array<string|int,
mixed> $col2
= array()
][,
array<string|int,
mixed> $col3
= array()
][,
array<string|int,
mixed> $col4
= array()
][,
array<string|int,
mixed> $coords
= array(0.0, 0.0,
0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0.67, 1.0, 1.0,
0.67, 1.0, 0.33, 1.0, 0.0, 1.0, 0.0, 0.67, 0.0, 0.33)
], array<string|int,
mixed> $coords_min[,
array<string|int,
mixed> $coords_max
= 1
][,
bool $antialias
= false
]) : mixed

Parameters

$x : float

abscissa of the top left corner of the rectangle.

$y : float

ordinate of the top left corner of the rectangle.

$w : float

width of the rectangle.

$h : float

height of the rectangle.

$col1 : array<string|int, mixed> = array()

first color (lower left corner) (RGB components).

$col2 : array<string|int, mixed> = array()

second color (lower right corner) (RGB components).

$col3 : array<string|int, mixed> = array()

third color (upper right corner) (RGB components).

$col4 : array<string|int, mixed> = array()

fourth color (upper left corner) (RGB components).

$coords : array<string|int, mixed> = array(0.0, 0.0, 0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0.67, 1.0, 1.0, 0.67, 1.0, 0.33, 1.0, 0.0, 1.0, 0.0, 0.67, 0.0, 0.33)

for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).
for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches

$coords_min : array<string|int, mixed>

minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0

$coords_max : array<string|int, mixed> = 1

maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1

$antialias : bool = false

A flag indicating whether to filter the shading function to prevent aliasing artifacts.

Return values

mixed —

copyPage()

Clone the specified page to a new page.

public copyPage(int $page)
: bool

Parameters

$page : int: number of page to copy (0 = current page)

Return values

bool —

true in case of success, false in case of error.

cropMark()

Paints crop marks.

public cropMark(float $x,
float $y,
float $w,
float $h[,
string $type
= 'T,R,B,L'
][,
array<string|int,
mixed> $color
= array(100, 100,
100, 100, 'All') ])
: mixed

Parameters

$x : float: abscissa of the crop mark center.
$y : float: ordinate of the crop mark center.
$w : float: width of the crop mark.
$h : float: height of the crop mark.
$type : string = 'T,R,B,L': type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT.
$color : array<string|int, mixed> = array(100, 100, 100, 100, 'All'): crop mark color (default spot registration color).

Return values

mixed —

Curve()

Draws a Bezier curve.

public Curve(float $x0,
float $y0,
float $x1,
float $y1,
float $x2,
float $y2,
float $x3,
float $y3[,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
]) : mixed

The Bezier curve is a tangent to the line between the control points at either end of the curve.

Parameters

$x0 : float: Abscissa of start point.
$y0 : float: Ordinate of start point.
$x1 : float: Abscissa of control point 1.
$y1 : float: Ordinate of control point 1.
$x2 : float: Abscissa of control point 2.
$y2 : float: Ordinate of control point 2.
$x3 : float: Abscissa of end point.
$y3 : float: Ordinate of end point.
$style : string = '': Style of rendering. See the getPathPaintOperator() function for more information.
$line_style : array<string|int, mixed> = array(): Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
$fill_color : array<string|int, mixed> = array(): Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Return values

mixed —

deletePage()

Remove the specified page.

public deletePage(int $page)
: bool

Parameters

$page : int: page to remove

Return values

bool —

true in case of success, false in case of error.

Ellipse()

Draws an ellipse.

public Ellipse(float $x0,
float $y0,
float $rx,
float $ry,
float $angle,
float $astart[,
float $afinish
= 360
][,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
][,
int $nc
= 2
]) : mixed

An ellipse is formed from n Bezier curves.

Parameters

$x0 : float: Abscissa of center point.
$y0 : float: Ordinate of center point.
$rx : float: Horizontal radius.
$ry : float: Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
$angle : float: Angle oriented (anti-clockwise). Default value: 0.
$astart : float: Angle start of draw line. Default value: 0.
$afinish : float = 360: Angle finish of draw line. Default value: 360.
$style : string = '': Style of rendering. See the getPathPaintOperator() function for more information.
$line_style : array<string|int, mixed> = array(): Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).
$fill_color : array<string|int, mixed> = array(): Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
$nc : int = 2: Number of curves used to draw a 90 degrees portion of ellipse.

Return values

mixed —

endLayer()

End the current PDF layer.

public endLayer()
: mixed

Return values

mixed —

endPage()

Terminate the current page

public endPage([bool $tocpage
= false
]) : mixed

Parameters

$tocpage : bool = false: if true set the tocpage state to false (end the page used to display Table Of Content).

Return values

mixed —

endTemplate()

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

public endTemplate()
: string|false

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 values

string|false —

the XObject Template ID in case of success or false in case of error.

endTOCPage()

Terminate the current TOC (Table Of Content) page

public endTOCPage()
: mixed

Return values

mixed —

Error()

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

public Error(string $msg)
: mixed

Parameters

$msg : string: The error message

Return values

mixed —

fixHTMLCode()

Cleanup HTML code (requires HTML Tidy library).

public fixHTMLCode(string $html[,
string $default_css
= ''
][,
array<string|int,
mixed>|null $tagvs
= null
][,
array<string|int,
mixed>|null $tidy_options
= null
]) : string

Parameters

$html : string: htmlcode to fix
$default_css : string = '': CSS commands to add
$tagvs : array<string|int, mixed>|null = null: parameters for setHtmlVSpace method
$tidy_options : array<string|int, mixed>|null = null: options for tidy_parse_string function

Return values

string —

XHTML code cleaned up

Footer()

This method is used to render the page footer.

public Footer()
: mixed

It is automatically called by AddPage() and could be overwritten in your own inherited class.

Return values

mixed —

getAbsFontMeasure()

Convert a relative font measure into absolute value.

public getAbsFontMeasure(int $s)
: float

Parameters

$s : int: Font measure.

Return values

float —

Absolute measure.

GetAbsX()

Returns the absolute X value of current position.

public GetAbsX()
: float

Return values

float —

getAliasNbPages()

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

public getAliasNbPages()
: string

If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in the document.

Return values

string —

getAliasNumPage()

Returns the string alias used for the page number.

public getAliasNumPage()
: string

If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number.

Return values

string —

getAliasRightShift()

Returns the string alias used right align page numbers.

public getAliasRightShift()
: string

If the current font is unicode type, the returned string wil contain an additional open curly brace.

Return values

string —

getAllSpotColors()

Returns the array of spot colors.

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

Return values

array<string|int, mixed> —

Spot colors array.

getAlpha()

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

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

(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Return values

array<string, bool|string> —

GetArrStringWidth()

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

public GetArrStringWidth(array<string|int,
mixed> $sa[,
string $fontname
= ''
][,
string $fontstyle
= ''
], float $fontsize[,
bool $getarray
= false
]) : array<string|int,
float>|float

Parameters

$sa : array<string|int, mixed>

The array of chars whose total length is to be computed

$fontname : string = ''

Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.

$fontstyle : string = ''

Font style. Possible values are (case insensitive):

empty string: regular
B: bold
I: italic
U: underline
D: line through
O: overline

or any combination. The default value is regular.

$fontsize : float

Font size in points. The default value is the current size.

$getarray : bool = false

if true returns an array of characters widths, if false returns the total length.

Return values

array<string|int, float>|float —

total string length or array of characted widths

getAutoPageBreak()

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

public getAutoPageBreak()
: bool

Return values

bool —

auto-page-break mode

getBarcode()

Get current barcode.

public getBarcode()
: string

Return values

string —

getBreakMargin()

Returns the page break margin.

public getBreakMargin([int|null $pagenum
= null
]) : int|float

Parameters

$pagenum : int|null = null: page number (empty = current page)

Return values

int|float —

page break margin.

getCellHeight()

Return the cell height

public getCellHeight(int $fontsize[,
bool $padding
= TRUE
]) : float

Parameters

$fontsize : int: Font size in internal units
$padding : bool = TRUE: If true add cell padding

Return values

float —

getCellHeightRatio()

return the height of cell repect font height.

public getCellHeightRatio()
: float

Return values

float —

getCellMargins()

Get the internal Cell margin array.

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

Return values

array<string|int, mixed> —

of margin values

getCellPaddings()

Get the internal Cell padding array.

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

Return values

array<string|int, mixed> —

of padding values

getCharBBox()

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

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

Parameters

$char : int: Input character code.

Return values

false|array<string|int, mixed> —

array(xMin, yMin, xMax, yMax) or FALSE if not defined.

GetCharWidth()

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

public GetCharWidth(int $char[,
bool $notlast
= true
]) : float

Parameters

$char : int: The char code whose length is to be returned
$notlast : bool = true: If false ignore the font-spacing.

Return values

float —

char width

getColumn()

Return the current column number

public getColumn()
: int

Return values

int —

current column number

getCSSBorderMargin()

Get the border-spacing from CSS attribute.

public getCSSBorderMargin(string $cssbspace,
float $width)
: array<string|int,
mixed>

Parameters

$cssbspace : string: border-spacing CSS properties
$width : float: width of the containing element

Return values

array<string|int, mixed> —

of border spacings

getCSSMargin()

Get the internal Cell margin from CSS attribute.

public getCSSMargin(string $cssmargin,
float $width)
: array<string|int,
mixed>

Parameters

$cssmargin : string: margin properties
$width : float: width of the containing element

Return values

array<string|int, mixed> —

of cell margins

getCSSPadding()

Get the internal Cell padding from CSS attribute.

public getCSSPadding(string $csspadding,
float $width)
: array<string|int,
mixed>

Parameters

$csspadding : string: padding properties
$width : float: width of the containing element

Return values

array<string|int, mixed> —

of cell paddings

getDestination()

Return the Named Destination array.

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

Return values

array<string|int, mixed> —

Named Destination array.

getDocCreationTimestamp()

Returns document creation timestamp in seconds.

public getDocCreationTimestamp()
: int

Return values

int —

Creation timestamp in seconds.

getDocModificationTimestamp()

Returns document modification timestamp in seconds.

public getDocModificationTimestamp()
: int

Return values

int —

Modfication timestamp in seconds.

getFontAscent()

Return the font ascent value.

public getFontAscent(string $font[,
string $style
= ''
], float $size)
: int

Parameters

$font : string: font name
$style : string = '': font style
$size : float: The size (in points)

Return values

int —

font ascent

getFontBBox()

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

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

Return values

array<string|int, mixed> —

getFontDescent()

Return the font descent value

public getFontDescent(string $font[,
string $style
= ''
], float $size)
: int

Parameters

$font : string: font name
$style : string = '': font style
$size : float: The size (in points)

Return values

int —

font descent

getFontFamily()

Returns the current font family name.

public getFontFamily()
: string

Return values

string —

current font family name

getFontFamilyName()

Return normalized font name

public getFontFamilyName(string $fontfamily)
: string

Parameters

$fontfamily : string: property string containing font family names

Return values

string —

normalized font name

getFontSize()

Returns the current font size.

public getFontSize()
: float

Return values

float —

current font size

getFontSizePt()

Returns the current font size in points unit.

public getFontSizePt()
: int

Return values

int —

current font size in points unit

getFontSpacing()

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

public getFontSpacing()
: int

Return values

int —

font spacing (tracking) value

getFontStretching()

Get the percentage of character stretching.

public getFontStretching()
: float

Return values

float —

stretching value

getFontStyle()

Returns the current font style.

public getFontStyle()
: string

Return values

string —

current font style

getFontSubsetting()

Return the default option for font subsetting.

public getFontSubsetting()
: bool

Return values

bool —

default font subsetting state.

getFooterFont()

Get Footer font.

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

Return values

array<int, string|float|null> —

Array describing the basic font parameters: (family, style, size).

getFooterMargin()

Returns footer margin in user units.

public getFooterMargin()
: float

Return values

float —

getFormDefaultProp()

Return the default properties for form fields.

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

Return values

array<string|int, mixed> —

$prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.

getGroupPageNo()

Return the current page in the group.

public getGroupPageNo()
: int

Return values

int —

current page in the group

getGroupPageNoFormatted()

Returns the current group page number formatted as a string.

public getGroupPageNoFormatted()
: mixed

Return values

mixed —

getHeaderData()

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>

public getHeaderData()
: array<string,
mixed>

Return values

array<string, mixed> —

getHeaderFont()

Get header font.

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

Return values

array<int, string|float|null> —

Array describing the basic font parameters: (family, style, size).

getHeaderMargin()

Returns header margin in user units.

public getHeaderMargin()
: float

Return values

float —

getHTMLFontUnits()

Convert HTML string containing font size value to points

public getHTMLFontUnits(string $val[,
float $refsize
= 12
][,
float $parent_size
= 12
][,
string $defaultunit
= 'pt'
]) : float

Parameters

$val : string: String containing font size value and unit.
$refsize : float = 12: Reference font size in points.
$parent_size : float = 12: Parent font size in points.
$defaultunit : string = 'pt': Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).

Return values

float —

value in points

getHTMLUnitToUnits()

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

public getHTMLUnitToUnits(string $htmlval[,
string $refsize
= 1
][,
string $defaultunit
= 'px'
][,
bool $points
= false
]) : float

Parameters

$htmlval : string: String containing values and unit.
$refsize : string = 1: Reference value in points.
$defaultunit : string = 'px': Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
$points : bool = false: If true returns points, otherwise returns value in user's units.

Return values

float —

value in user's unit or point if $points=true

getImageRBX()

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

public getImageRBX()
: float

Return values

float —

getImageRBY()

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

public getImageRBY()
: float

Return values

float —

getImageScale()

Returns the adjusting factor to convert pixels to user units.

public getImageScale()
: float

Return values

float —

adjusting factor to convert pixels to user units.

getLastH()

Get the last cell height.

public getLastH()
: float

Return values

float —

last cell height

GetLineWidth()

Returns the current the line width.

public GetLineWidth()
: int

Return values

int —

Line width

getMargins()

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>

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

Return values

array<string|int, mixed> —

containing all margins measures

getNumberOfColumns()

Return the current number of columns.

public getNumberOfColumns()
: int

Return values

int —

number of columns

GetNumChars()

Returns the numbero of characters in a string.

public GetNumChars(string $s)
: int

Parameters

$s : string: The input string.

Return values

int —

number of characters

getNumLines()

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

public getNumLines(string $txt,
float $w[,
bool $reseth
= false
][,
bool $autopadding
= true
][,
array<string|int,
mixed>|null $cellpadding
= null
], mixed $border)
: float

Parameters

$txt : string

String for calculating his height

$w : float

Width of cells. If 0, they extend up to the right margin of the page.

$reseth : bool = false

if true reset the last cell height (default false).

$autopadding : bool = true

if true, uses internal padding and automatically adjust it to account for line width (default true).

$cellpadding : array<string|int, mixed>|null = null

Internal cell padding, if empty uses default cell padding.

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

Return values

float —

Return the minimal height needed for multicell method for printing the $txt param.

getNumPages()

Get the total number of insered pages.

public getNumPages()
: int

Return values

int —

number of pages

getOriginalMargins()

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

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

Return values

array<string|int, mixed> —

containing all margins measures

getOverprint()

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

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

(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Return values

array<string, bool|int> —

getPage()

Get current document page number.

public getPage()
: int

Return values

int —

page number

getPageDimensions()

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>

public getPageDimensions([int|null $pagenum
= null
]) : array<string|int,
mixed>

Parameters

$pagenum : int|null = null: page number (empty = current page)

Return values

array<string|int, mixed> —

of page dimensions.

getPageGroupAlias()

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

public getPageGroupAlias()
: string

If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in this group.

Return values

string —

alias of the current page group

getPageHeight()

Returns the page height in units.

public getPageHeight([int|null $pagenum
= null
]) : int|float

Parameters

$pagenum : int|null = null: page number (empty = current page)

Return values

int|float —

page height.

getPageNumGroupAlias()

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

public getPageNumGroupAlias()
: string

If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number (relative to the belonging group).

Return values

string —

alias of the current page group

getPageRegions()

Return an array of no-write page regions

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

Return values

array<string|int, mixed> —

of no-write page regions

getPageWidth()

Returns the page width in units.

public getPageWidth([int|null $pagenum
= null
]) : int|float

Parameters

$pagenum : int|null = null: page number (empty = current page)

Return values

int|float —

page width.

getPDFData()

Returns the PDF data.

public getPDFData()
: mixed

Return values

mixed —

getRawCharWidth()

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

public getRawCharWidth(int $char)
: float

Parameters

$char : int: The char code whose length is to be returned

Return values

float —

char width

getRTL()

Return the RTL status

public getRTL()
: bool

Return values

bool —

getScaleFactor()

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

public getScaleFactor()
: int

Return values

int —

scale factor.

getStringHeight()

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

public getStringHeight(float $w,
string $txt[,
bool $reseth
= false
][,
bool $autopadding
= true
][,
array<string|int,
mixed>|null $cellpadding
= null
], mixed $border)
: float

Generally, if you want to know the exact height for a block of content you can use the following alternative technique:

Parameters

$w : float

Width of cells. If 0, they extend up to the right margin of the page.

$txt : string

String for calculating his height

$reseth : bool = false

if true reset the last cell height (default false).

$autopadding : bool = true

if true, uses internal padding and automatically adjust it to account for line width (default true).

$cellpadding : array<string|int, mixed>|null = null

Internal cell padding, if empty uses default cell padding.

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

Return values

float —

Return the minimal height needed for multicell method for printing the $txt param.

GetStringWidth()

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

public GetStringWidth(string $s[,
string $fontname
= ''
][,
string $fontstyle
= ''
], float $fontsize[,
bool $getarray
= false
]) : array<string|int,
float>|float

Parameters

$s : string

The string whose length is to be computed

$fontname : string = ''

Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.

$fontstyle : string = ''

Font style. Possible values are (case insensitive):

empty string: regular
B: bold
I: italic
U: underline
D: line-through
O: overline

or any combination. The default value is regular.

$fontsize : float

Font size in points. The default value is the current size.

$getarray : bool = false

if true returns an array of characters widths, if false returns the total length.

Return values

array<string|int, float>|float —

total string length or array of characted widths

getTextShadow()

Return the text shadow parameters array.

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

Return values

array<string|int, mixed> —

array of parameters.

GetX()

Returns the relative X value of current position.

public GetX()
: float

The value is relative to the left border for LTR languages and to the right border for RTL languages.

Return values

float —

GetY()

Returns the ordinate of the current position.

public GetY()
: float

Return values

float —

Gradient()

Output gradient.

public Gradient(int $type,
array<string|int,
mixed> $coords,
array<string|int,
mixed> $stops[,
array<string|int,
mixed> $background
= array()
][,
bool $antialias
= false
]) : mixed

Parameters

$type : int: type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
$coords : array<string|int, mixed>: array of coordinates.
$stops : array<string|int, mixed>: 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).
$background : array<string|int, mixed> = array(): An array of colour components appropriate to the colour space, specifying a single background colour value.
$antialias : bool = false: A flag indicating whether to filter the shading function to prevent aliasing artifacts.

Return values

mixed —

Header()

This method is used to render the page header.

public Header()
: mixed

It is automatically called by AddPage() and could be overwritten in your own inherited class.

Return values

mixed —

hyphenateText()

Returns text with soft hyphens.

public hyphenateText(string $text,
mixed $patterns[,
array<string|int,
mixed> $dictionary
= array()
][,
int $leftmin
= 1
][,
int $rightmin
= 2
][,
int $charmin
= 1
][,
int $charmax
= 8
]) : string

Parameters

$text : string: text to process
$patterns : mixed: 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/
$dictionary : array<string|int, mixed> = array(): Array of words to be returned without applying the hyphenation algorithm.
$leftmin : int = 1: Minimum number of character to leave on the left of the word without applying the hyphens.
$rightmin : int = 2: Minimum number of character to leave on the right of the word without applying the hyphens.
$charmin : int = 1: Minimum word length to apply the hyphenation algorithm.
$charmax : int = 8: Maximum length of broken piece of word.

Return values

string —

text with soft hyphens

Image()

Puts an image in the page.

public Image(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
string $type
= ''
][,
mixed $link
= ''
][,
string $align
= ''
][,
mixed $resize
= false
][,
int $dpi
= 300
][,
string $palign
= ''
][,
bool $ismask
= false
][,
mixed $imgmask
= false
], mixed $border[,
mixed $fitbox
= false
][,
bool $hidden
= false
][,
bool $fitonpage
= false
][,
bool $alt
= false
][,
array<string|int,
mixed> $altimgs
= array()
]) : mixed|false

The upper-left corner must be given. The dimensions can be specified in different ways:

explicit width and height (expressed in user unit)
one explicit dimension, the other being calculated automatically in order to keep the original proportions
no explicit dimension, in which case the image is put at 72 dpi

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.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.

Parameters

$file : string

Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg').

$x : float|null = null

Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).

$y : float|null = null

Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).

$w : float

Width of the image in the page. If not specified or equal to zero, it is automatically calculated.

$h : float

Height of the image in the page. If not specified or equal to zero, it is automatically calculated.

$type : string = ''

Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.

$link : mixed = ''

URL or identifier returned by AddLink().

$align : string = ''

Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:

T: top-right for LTR or top-left for RTL
M: middle-right for LTR or middle-left for RTL
B: bottom-right for LTR or bottom-left for RTL
N: next line

$resize : mixed = false

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

$dpi : int = 300

dot-per-inch resolution used on resize

$palign : string = ''

Allows to center or align the image on the current line. Possible values are:

L : left align
C : center
R : right align
'' : empty string : left for LTR or right for RTL

$ismask : bool = false

true if this image is a mask, false otherwise

$imgmask : mixed = false

image object returned by this function or false

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

$fitbox : mixed = false

If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).

$hidden : bool = false

If true do not display the image.

$fitonpage : bool = false

If true the image is resized to not exceed page dimensions.

$alt : bool = false

If true the image will be added as alternative and not directly printed (the ID of the image will be returned).

$altimgs : array<string|int, mixed> = array()

Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.

Return values

mixed|false —

image information

ImageEps()

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

public ImageEps(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
mixed $link
= ''
][,
bool $useBoundingBox
= true
][,
string $align
= ''
][,
string $palign
= ''
], mixed $border[,
bool $fitonpage
= false
][,
bool $fixoutvals
= false
]) : mixed

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

Parameters

$file : string

Name of the file containing the image or a '@' character followed by the EPS/AI data string.

$x : float|null = null

Abscissa of the upper-left corner.

$y : float|null = null

Ordinate of the upper-left corner.

$w : float

Width of the image in the page. If not specified or equal to zero, it is automatically calculated.

$h : float

Height of the image in the page. If not specified or equal to zero, it is automatically calculated.

$link : mixed = ''

URL or identifier returned by AddLink().

$useBoundingBox : bool = true

specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.

$align : string = ''

Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:

T: top-right for LTR or top-left for RTL
M: middle-right for LTR or middle-left for RTL
B: bottom-right for LTR or bottom-left for RTL
N: next line

$palign : string = ''

Allows to center or align the image on the current line. Possible values are:

L : left align
C : center
R : right align
'' : empty string : left for LTR or right for RTL

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

$fitonpage : bool = false

if true the image is resized to not exceed page dimensions.

$fixoutvals : bool = false

if true remove values outside the bounding box.

Return values

mixed —

ImageSVG()

Embedd a Scalable Vector Graphics (SVG) image.

public ImageSVG(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
mixed $link
= ''
][,
string $align
= ''
][,
string $palign
= ''
], mixed $border[,
bool $fitonpage
= false
]) : mixed

NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.

Parameters

$file : string

Name of the SVG file or a '@' character followed by the SVG data string.

$x : float|null = null

Abscissa of the upper-left corner.

$y : float|null = null

Ordinate of the upper-left corner.

$w : float

Width of the image in the page. If not specified or equal to zero, it is automatically calculated.

$h : float

Height of the image in the page. If not specified or equal to zero, it is automatically calculated.

$link : mixed = ''

URL or identifier returned by AddLink().

$align : string = ''

Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:

T: top-right for LTR or top-left for RTL
M: middle-right for LTR or middle-left for RTL
B: bottom-right for LTR or bottom-left for RTL
N: next line

If the alignment is an empty string, then the pointer will be restored on the starting SVG position.

$palign : string = ''

Allows to center or align the image on the current line. Possible values are:

L : left align
C : center
R : right align
'' : empty string : left for LTR or right for RTL

$border : mixed

Indicates if borders must be drawn around the cell. The value can be a number:

0: no border (default)
1: frame

or a string containing some or all of the following characters (in any order):

L: left
T: top
R: right
B: bottom

or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))

$fitonpage : bool = false

if true the image is resized to not exceed page dimensions.

Return values

mixed —

IncludeJS()

Adds a javascript

public IncludeJS(string $script)
: mixed

Parameters

$script : string: Javascript code

Return values

mixed —

isCharDefined()

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

public isCharDefined(mixed $char[,
string $font
= ''
][,
string $style
= ''
]) : bool

Parameters

$char : mixed: Character to check (integer value or string)
$font : string = '': Font name (family name).
$style : string = '': Font style.

Return values

bool —

true if the char is defined, false otherwise.

isRTLTextDir()

Return the current temporary RTL status

public isRTLTextDir()
: bool

Return values

bool —

isUnicodeFont()

Return true if the current font is unicode type.

public isUnicodeFont()
: bool

Return values

bool —

true for unicode font, false otherwise.

lastPage()

Reset pointer to the last document page.

public lastPage([bool $resetmargins
= false
]) : mixed

Parameters

$resetmargins : bool = false: if true reset left, right, top margins and Y position.

Return values

mixed —

Line()

Draws a line between two points.

public Line(float $x1,
float $y1,
float $x2,
float $y2[,
array<string|int,
mixed> $style
= array()
]) : mixed

Parameters

$x1 : float: Abscissa of first point.
$y1 : float: Ordinate of first point.
$x2 : float: Abscissa of second point.
$y2 : float: Ordinate of second point.
$style : array<string|int, mixed> = array(): Line style. Array like for SetLineStyle(). Default value: default line style (empty array).

Return values

mixed —

LinearGradient()

Paints a linear colour gradient.

public LinearGradient(float $x,
float $y,
float $w,
float $h[,
array<string|int,
mixed> $col1
= array()
][,
array<string|int,
mixed> $col2
= array()
][,
array<string|int,
mixed> $coords
= array(0, 0, 1,
0) ]) :
mixed

Parameters

$x : float: abscissa of the top left corner of the rectangle.
$y : float: ordinate of the top left corner of the rectangle.
$w : float: width of the rectangle.
$h : float: height of the rectangle.
$col1 : array<string|int, mixed> = array(): first color (Grayscale, RGB or CMYK components).
$col2 : array<string|int, mixed> = array(): second color (Grayscale, RGB or CMYK components).
$coords : array<string|int, mixed> = array(0, 0, 1, 0): 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).

Return values

mixed —

Link()

Puts a link on a rectangular area of the page.

public Link(float $x,
float $y,
float $w,
float $h,
mixed $link,
int $spaces)
: mixed

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.

Parameters

$x : float: Abscissa of the upper-left corner of the rectangle
$y : float: Ordinate of the upper-left corner of the rectangle
$w : float: Width of the rectangle
$h : float: Height of the rectangle
$link : mixed: URL or identifier returned by AddLink()
$spaces : int: number of spaces on the text to link

Return values

mixed —

ListBox()

Creates a List-box field

public ListBox(string $name,
int $w,
int $h

TCPDF

in package

Tags

Table of Contents

Properties

$allowLocalFiles

Tags

$alpha

Tags

$annotation_fonts

Tags

$author

Tags

$AutoPageBreak

Tags

$barcode

Tags

$bgcolor

Tags

$bMargin

Tags

$booklet

Tags

$bordermrk

Tags

$buffer

Tags

$bufferlen

Tags

$cache_file_length

Tags

$cell_height_ratio

Tags

$cell_margin

Tags

$cell_padding

Tags

$check_page_regions

Tags

$cleaned_ids

$clMargin

Tags

$cntmrk

Tags

$ColorFlag

Tags

$column_start_page

Tags

$columns

Tags

$colxshift

Tags

$compress

Tags

$CoreFonts

Tags

$creator

Tags

$crMargin

Tags

$CurOrientation

Tags

$current_column

Tags

$CurrentFont

Tags

$currpagegroup

Tags

$custom_xmp

Tags

$custom_xmp_rdf

Tags

$customlistindent

Tags

$default_form_prop

Tags

$default_graphic_vars

Tags

$default_monospaced_font