## Class TCPDF

Description

This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.

TCPDF project (http://tcpdf.sourceforge.net) has been originally derived from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org).
To add your own TTF fonts please read /fonts/README.TXT

- author: Nicola Asuni
- version: 2.2.000
- link: http://tcpdf.sourceforge.net
- name: TCPDF
- license: LGPL

Located in /tcpdf.php (line 111)

Variable Summary
alias $AliasNbPages
author $author
automatic $AutoPageBreak
Bold $b
Barcode $barcode
page $bMargin
buffer $buffer
cell $cMargin
indicates $ColorFlag
compression $compress
array $CoreFonts
creator $creator
current $CurOrientation
current $CurrentFont
Default $default_table_columns
default $DefOrientation
array $diffs
commands $DrawColor
default $encoding
mixed $encrypted
mixed $enc_obj_id
height $fh
height $fhPt
commands $FillColor
current $FontFamily
array $FontFiles
HTML $fontList
array $fonts
current $FontSize
current $FontSizePt
current $FontStyle
Footer $footer_font
Minimum $footer_margin
width $fw
width $fwPt
current $h
Header $header_font
Header $header_logo
Header $header_logo_width
Minimum $header_margin
String $header_string
String $header_title
Header $header_width
current $hPt
HTML $HREF
Italic $i
array $images
image $imgscale
right-bottom $img_rb_x
right-bottom $img_rb_y
flag $InFooter
PHP $internal_encoding
HTML $issetcolor
HTML $issetfont
boolean $isunicode
mixed $javascript
scale $k
keywords $keywords
Language $l
height $lasth
mixed $last_rc4_key
mixed $last_rc4_key_c
layout $LayoutMode
line $LineWidth
array $links
spacer $lispacer
HTML $listcount
HTML $listordered
left $lMargin
current $n
mixed $n_js
array $offsets
array $OrientationChanges
original $original_lMargin
original $original_rMargin
mixed $OutlineRoot
mixed $outlines
mixed $Ovalue
current $page
threshold $PageBreakTrigger
array $PageLinks
array $pages
PDF $PDFVersion
store $prevFillColor
store $prevFontFamily
store $prevFontStyle
store $prevTextColor
If $print_footer
If $print_header
mixed $Pvalue
right $rMargin
indicates $rtl
current $state
subject $subject
HTML $tableborder
HTML $tdalign
HTML $tdbegin
HTML $tdbgcolor
HTML $tdheight
HTML $tdwidth
Store $tempfontsize
commands $TextColor
title $title
top $tMargin
used $tmprtl
Underlined $u
underlining $underline
mixed $Uvalue
current $w
current $wPt
word $ws
current $x
current $y
zoom $ZoomMode
Method Summary
TCPDF __construct ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
void __destruct ()
boolean AcceptPageBreak ()
void AddFont (string $family, [string $style = ''], [string $file = ''])
void addHtmlLink (string $url, string $name, [int $fill = 0])
void AddLink ()
void AddPage ([string $orientation = ''])
void AliasNbPages ([string $alias = '{nb}'])
string arrUTF8ToUTF16BE (array $unicode, [boolean $setbom = true])
void Bookmark ( $txt, [ $level = 0], [ $y = -1])
void Button ( $name, $w, $h, $caption, $action, [ $prop = array()])
void Cell (float $w, [float $h = 0], [string $txt = ''], [mixed $border = 0], [int $ln = 0], [string $align = ''], [int $fill = 0], [mixed $link = ''], [int $stretch = 0])
void CheckBox ( $name, $w, [ $checked = false], [ $prop = array()])
void Circle (float $x0, float $y0, float $r, [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $astart:, float $afinish:)
void Close ()
void closedHTMLTagHandler (string $tag)
void ComboBox ( $name, $w, $h, $values, [ $prop = array()])
array convertColorHexToDec ([string $color = "#000000"])
void Curve (float $x0, float $y0, float $x1, float $y1, float $x2, float $y2, float $x3, float $y3, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
void Ellipse (float $x0, float $y0, float $rx, [float $ry = 0], [ $angle = 0], [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $angle:, float $astart:, float $afinish:)
void Error (string $msg)
void Footer ()
float GetAbsX ()
int getBreakMargin ()
float getImageScale ()
int GetLineWidth ()
int GetNumChars (string $s)
int getNumPages ()
int getPage ()
int getPageHeight ()
int getPageWidth ()
void getPDFData ()
int getScaleFactor ()
int GetStringWidth (string $s)
float GetX ()
float GetY ()
void Header ()
void Image (string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''], [string $align = ''])
void IncludeJS ( $script)
string justify ($rowWidth $rowWidth, $txtWidth $txtWidth, $spaceWidth $spaceWidth, $txt $txt)
void lastPage ()
void Line (float $x1, float $y1, float $x2, float $y2, [array $style = array()])
void Link (float $x, float $y, float $w, float $h, mixed $link)
void Ln ([float $h = ''])
void MirrorH ([int $x = ''])
void MirrorL ([float $angle = 0], [int $x = ''], [int $y = ''])
void MirrorP ([int $x = ''], [int $y = ''])
void MirrorV ([int $y = ''])
int MultiCell (float $w, float $h, string $txt, [mixed $border = 0], [string $align = 'J'], [int $fill = 0], [int $ln = 1])
void Open ()
void openHTMLTagHandler (string $tag, string $attr, [int $fill = 0])
void Output ([string $name = ''], [string $dest = ''])
array outputjpg (string $filename)
int PageNo ()
float pixelsToMillimeters (int $px)
void Polygon (array $p, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
void Rect (float $x, float $y, float $w, float $h, [string $style = ''], [array $border_style = array()], [array $fill_color = array()])
void RegularPolygon (float $x0, float $y0, $r, integer $ns, [float $angle = 0], [boolean $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $r:)
void Rotate (float $angle, [int $x = ''], [int $y = ''])
void RoundedRect (float $x, float $y, float $w, float $h, float $r, [string $round_corner = "1111"], [string $style = ""], [array $border_style = array()], [array $fill_color = array()])
void Scale (float $s_x, float $s_y, [int $x = ''], [int $y = ''])
void ScaleX (float $s_x, [int $x = ''], [int $y = ''])
void ScaleXY (float $s, [int $x = ''], [int $y = ''])
void ScaleY (float $s_y, [int $x = ''], [int $y = ''])
void SetAuthor (string $author)
void SetAutoPageBreak (boolean $auto, [float $margin = 0])
void setBarcode ([string $bc = ""])
void SetCellPadding (float $pad)
void SetCompression (boolean $compress)
void SetCreator (string $creator)
void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])
void SetDrawColor (int $r, [int $g = -1], [int $b = -1])
void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
void SetFont (string $family, [string $style = ''], [float $size = 0])
void SetFontSize (float $size)
void setFooterFont (array $font)
void setFooterMargin ([int $fm = 10])
void setHeaderData ([string $ln = ""], [string $lw = 0], [string $ht = ""], [string $hs = ""])
void setHeaderFont (array $font)
void setHeaderMargin ([int $hm = 10])
void setImageScale (float $scale)
void SetKeywords (string $keywords)
void setLanguageArray (array $language)
void setLastH (float $h)
void SetLeftMargin (float $margin)
void SetLineStyle (array $style)
void SetLineWidth (float $width)
void SetLink (int $link, [float $y = 0], [int $page = -1])
void SetMargins (float $left, float $top, [float $right = -1])
void setPage (int $pnum)
void setPrintFooter ([ $val = true], boolean $value)
void setPrintHeader ([boolean $val = true])
void SetProtection ([Array $permissions = array()], [String $user_pass = ''], [String $owner_pass = null])
void SetRightMargin (float $margin)
void setRTL (Boolean $enable)
void setStyle (string $tag, boolean $enable)
void SetSubject (string $subject)
void setTempRTL (mixed $mode)
void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
void SetTitle (string $title)
void SetTopMargin (float $margin)
void SetX (float $x)
void SetXY (float $x, float $y)
void SetY (float $y)
void Skew (float $angle_x, float $angle_y, [int $x = ''], [int $y = ''])
void SkewX (float $angle_x, [int $x = ''], [int $y = ''])
void SkewY (float $angle_y, [int $x = ''], [int $y = ''])
void StarPolygon (float $x0, float $y0, float $r, integer $nv, integer $ng, [ $angle = 0], [ $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $angle:, boolean $draw_circle:)
void StartTransform ()
void StopTransform ()
void Text (float $x, float $y, string $txt)
void TextField ( $name, $w, $h, [ $prop = array()])
void toJPEG (string $file, image $image)
void Transform ( $tm)
void Translate (int $t_x, int $t_y)
void TranslateX (int $t_x)
void TranslateY (int $t_y)
string unhtmlentities ($text_to_convert $text_to_convert)
array UTF8StringToArray (string $str)
string utf8StrRev (string $str, [ $setbom = false], [bool $forcertl = false])
string UTF8ToUTF16BE (string $str, [boolean $setbom = true])
void Write (float $h, string $txt, [mixed $link = ''], [int $fill = 0])
void writeBarcode (int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)
void writeHTML (string $html, [boolean $ln = true], [int $fill = 0], [boolean $reseth = false], [boolean $cell = false])
void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], [mixed $border = 0], [int $ln = 0], [int $fill = 0], [boolean $reseth = false])
void _addfield ( $type, $name, $x, $y, $w, $h, $prop)
void _begindoc ()
void _beginpage ( $orientation)
void _dochecks ()
void _dounderline (int $x, int $y, string $txt)
void _enddoc ()
void _endpage ()
string _escape (string $s)
string _escapetext (string $s)
4-byte _freadint (string $f)
void _generateencryptionkey (String $user_pass, String $owner_pass, String $protection)
void _getfontpath ()
void _JScolor ( $color)
String _md5_16 (string $str)
void _newobj ()
void _objectkey (int $n)
void _out (string $s)
void _outCurve ( $x1, $y1, $x2, $y2, $x3, $y3)
void _outLine ( $x, $y)
void _outPoint ( $x, $y)
void _outRect (float $x, float $y, float $w, float $h, string $op)
String _Ovalue (String $user_pass, String $owner_pass)
void _parsegif ( $file)
void _parsejpg ( $file)
void _parsepng ( $file)
void _putbookmarks ()
void _putcatalog ()
void _putencryption ()
void _putfonts ()
void _putheader ()
void _putimages ()
void _putinfo ()
void _putjavascript ()
void _putpages ()
void _putresourcedict ()
void _putresources ()
void _putstream (string $s)
void _puttrailer ()
void _puttruetypeunicode ( $font)
void _putxobjectdict ()
String _RC4 (string $key, String $text)
string _textstring (string $s)
string _uristring (string $s)
String _Uvalue ()
Variables
alias $AliasNbPages (line 455)

- var: for total number of pages
- access: protected

author $author (line 437)

- access: protected

automatic $AutoPageBreak (line 395)

- var: page breaking
- access: protected

Bold $b (line 682)

- var: font style status.
- access: private

Barcode $barcode = false (line 547)

- var: to print on page footer (only if set).
- access: private

page $bMargin (line 251)

- var: break margin
- access: protected

buffer $buffer (line 137)

- var: holding in-memory PDF
- access: protected

cell $cMargin (line 257)

- var: internal padding
- access: protected

indicates $ColorFlag (line 383)

- var: whether fill and text colors are different
- access: protected

compression $compress (line 155)

- var: flag
- access: protected

array $CoreFonts (line 287)

- var: of standard font names
- access: protected

creator $creator (line 449)

- access: protected

current $CurOrientation (line 167)

- var: page orientation (P = Portrait, L = Landscape)
- access: protected

current $CurrentFont (line 347)

- var: font info
- access: protected

Default $default_table_columns = 4 (line 595)

- var: number of columns for html table.
- access: private

default $DefOrientation (line 161)

- var: page orientation (P = Portrait, L = Landscape)
- access: protected

array $diffs (line 305)

- var: of encoding differences
- access: protected

commands $DrawColor (line 365)

- var: for drawing color
- access: protected

default $encoding = "UTF-8" (line 707)

- var: encoding
- since: 1.53.0.TC010
- access: private

mixed $encrypted (line 765)

Indicates whether document is protected

- since: 2.0.000 (2008-01-02)
- access: private

mixed $enc_obj_id (line 793)

encryption object id

- since: 2.0.000 (2008-01-02)
- access: private

height $fh (line 203)

- var: of page format in user unit
- access: protected

height $fhPt (line 191)

- var: of page format in points
- access: protected

commands $FillColor (line 371)

- var: for filling color
- access: protected

current $FontFamily (line 329)

- var: font family
- access: protected

array $FontFiles (line 299)

- var: of font files
- access: protected

HTML $fontList (line 610)

- var: PARSER: store font list.
- access: private

array $fonts (line 293)

- var: of used fonts
- access: protected

current $FontSize (line 359)

- var: font size in user unit
- access: protected

current $FontSizePt (line 353)

- var: font size in points
- access: protected

current $FontStyle (line 335)

- var: font style
- access: protected

Footer $footer_font (line 535)

- var: font.
- access: private

Minimum $footer_margin (line 509)

- var: distance between footer and bottom page margin.
- access: private

width $fw (line 197)

- var: of page format in user unit
- access: protected

width $fwPt (line 185)

- var: of page format in points
- access: protected

current $h (line 227)

- var: height of page in user unit
- access: protected

Header $header_font (line 529)

- var: font.
- access: private

Header $header_logo = "" (line 571)

- var: image logo.
- access: private

Header $header_logo_width = 30 (line 577)

- var: image logo width in mm.
- access: private

Minimum $header_margin (line 503)

- var: distance between header and top page margin.
- access: private

String $header_string = "" (line 589)

- var: to print on document header.
- access: private

String $header_title = "" (line 583)

- var: to print as title on document header.
- access: private

Header $header_width = 0 (line 565)

- var: width (0 = full page width).
- access: private

current $hPt (line 215)

- var: height of page in points
- access: protected

HTML $HREF (line 604)

- var: PARSER: store current link.
- access: private

Italic $i (line 694)

- var: font style status.
- access: private

array $images (line 311)

- var: of used images
- access: protected

image $imgscale = 1 (line 479)

- var: scale factor
- author: Nicola Asuni
- since: 2004-06-14
- access: protected

right-bottom $img_rb_x (line 463)

- var: corner X coordinate of inserted image
- author: Nicola Asuni
- since: 2002-07-31
- access: protected

right-bottom $img_rb_y (line 471)

- var: corner Y coordinate of inserted image
- author: Nicola Asuni
- since: 2002-07-31
- access: protected

flag $InFooter (line 407)

- var: set when processing footer
- access: protected

PHP $internal_encoding (line 714)

- var: internal encoding
- since: 1.53.0.TC016
- access: private

HTML $issetcolor (line 622)

- var: PARSER: true when color attribute is set.
- access: private

HTML $issetfont (line 616)

- var: PARSER: true when font attribute is set.
- access: private

boolean $isunicode = false (line 487)

- var: set to true when the input text is unicode (require unicode fonts)
- author: Nicola Asuni
- since: 2005-01-02
- access: protected

mixed $javascript = "" (line 833)

javascript code

- since: 2.1.002 (2008-02-12)
- access: private

scale $k (line 179)

- var: factor (number of points in user unit)
- access: protected

keywords $keywords (line 443)

- access: protected

Language $l (line 541)

- var: templates.
- access: private

height $lasth (line 275)

- var: of last cell printed
- access: protected

mixed $last_rc4_key (line 800)

last RC4 key encrypted (cached for optimisation)

- since: 2.0.000 (2008-01-02)
- access: private

mixed $last_rc4_key_c (line 807)

last RC4 computed key

- since: 2.0.000 (2008-01-02)
- access: private

layout $LayoutMode (line 419)

- var: display mode
- access: protected

line $LineWidth (line 281)

- var: width in user unit
- access: protected

array $links (line 323)

- var: of internal links
- access: protected

spacer $lispacer = "" (line 700)

- var: for LI tags.
- access: private

HTML $listcount = 0 (line 634)

- var: PARSER: count list items.
- access: private

HTML $listordered = false (line 628)

- var: PARSER: true in case of ordered list (OL), false otherwise.
- access: private

left $lMargin (line 233)

- var: margin
- access: protected

current $n (line 125)

- var: object number
- access: protected

mixed $n_js (line 840)

javascript counter

- since: 2.1.002 (2008-02-12)
- access: private

array $offsets (line 131)

- var: of object offsets
- access: protected

array $OrientationChanges (line 173)

- var: indicating page orientation changes
- access: protected

original $original_lMargin (line 516)

- var: left margin value
- since: 1.53.0.TC013
- access: private

original $original_rMargin (line 523)

- var: right margin value
- since: 1.53.0.TC013
- access: private

mixed $OutlineRoot (line 823)

Outline root for bookmark

- since: 2.1.002 (2008-02-12)
- access: private

mixed $outlines = array() (line 816)

Outlines for bookmark

- since: 2.1.002 (2008-02-12)
- access: private

mixed $Ovalue (line 779)

O entry in pdf document

- since: 2.0.000 (2008-01-02)
- access: private

current $page (line 119)

- var: page number
- access: protected

threshold $PageBreakTrigger (line 401)

- var: used to trigger page breaks
- access: protected

array $PageLinks (line 317)

- var: of links in pages
- access: protected

array $pages (line 143)

- var: containing pages
- access: protected

PDF $PDFVersion = "1.5" (line 494)

- var: version
- since: 1.5.3
- access: protected

store $prevFillColor = array(255,255,255) (line 721)

- var: previous fill color as RGB array
- since: 1.53.0.TC017
- access: private

store $prevFontFamily (line 735)

- var: previous font family
- since: 1.53.0.TC017
- access: private

store $prevFontStyle (line 742)

- var: previous font style
- since: 1.53.0.TC017
- access: private

store $prevTextColor = array(0,0,0) (line 728)

- var: previous text color as RGB array
- since: 1.53.0.TC017
- access: private

If $print_footer = true (line 559)

- var: true prints footer.
- access: private

If $print_header = true (line 553)

- var: true prints header
- access: private

mixed $Pvalue (line 786)

P entry in pdf document

- since: 2.0.000 (2008-01-02)
- access: private

right $rMargin (line 245)

- var: margin
- access: protected

indicates $rtl = false (line 749)

- var: if the document language is Right-To-Left
- since: 2.0.000
- access: private

current $state (line 149)

- var: document state
- access: protected

subject $subject (line 431)

- access: protected

HTML $tableborder = 0 (line 640)

- var: PARSER: size of table border.
- access: private

HTML $tdalign = "L" (line 664)

- var: PARSER: table align.
- access: private

HTML $tdbegin = false (line 646)

- var: PARSER: true at the beginning of table.
- access: private

HTML $tdbgcolor = false (line 670)

- var: PARSER: table background color.
- access: private

HTML $tdheight = 0 (line 658)

- var: PARSER: table height.
- access: private

HTML $tdwidth = 0 (line 652)

- var: PARSER: table width.
- access: private

Store $tempfontsize = 10 (line 676)

- var: temporary font size in points.
- access: private

commands $TextColor (line 377)

- var: for text color
- access: protected

title $title (line 425)

- access: protected

top $tMargin (line 239)

- var: margin
- access: protected

used $tmprtl = false (line 756)

- var: to force RTL or LTR string inversion
- since: 2.0.000
- access: private

Underlined $u (line 688)

- var: font style status.
- access: private

underlining $underline (line 341)

- var: flag
- access: protected

mixed $Uvalue (line 772)

U entry in pdf document

- since: 2.0.000 (2008-01-02)
- access: private

current $w (line 221)

- var: width of page in user unit
- access: protected

current $wPt (line 209)

- var: width of page in points
- access: protected

word $ws (line 389)

- var: spacing
- access: protected

current $x (line 263)

- var: horizontal position in user unit for cell positioning
- access: protected

current $y (line 269)

- var: vertical position in user unit for cell positioning
- access: protected

zoom $ZoomMode (line 413)

- var: display mode
- access: protected

Methods
Constructor __construct (line 857)

This is the class constructor.

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

- since: 1.0
- access: public

TCPDF __construct ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])

- string $orientation: page orientation. Possible values are (case insensitive):
  - P or Portrait (default)
  - L or Landscape
- string $unit: User measure unit. Possible values are:
  - pt: point
  - mm: millimeter (default)
  - cm: centimeter
  - in: inch
  A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
- mixed $format: The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).
  - 4A0
  - 2A0
  - A0
  - A1
  - A2
  - A3
  - A4 (default)
  - A5
  - A6
  - A7
  - A8
  - A9
  - A10
  - B0
  - B1
  - B2
  - B3
  - B4
  - B5
  - B6
  - B7
  - B8
  - B9
  - B10
  - C0
  - C1
  - C2
  - C3
  - C4
  - C5
  - C6
  - C7
  - C8
  - C9
  - C10
  - RA0
  - RA1
  - RA2
  - RA3
  - RA4
  - SRA0
  - SRA1
  - SRA2
  - SRA3
  - SRA4
  - LETTER
  - LEGAL
  - EXECUTIVE
  - FOLIO
- boolean $unicode: TRUE means that the input text is unicode (default = true)
- String $encoding: charset encoding; default is UTF-8

Destructor __destruct (line 1057)

Default destructor.

- since: 1.53.0.TC016
- access: public

void __destruct ()
AcceptPageBreak (line 2181)

Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().

This method is called automatically and should not be called directly by the application.
Example:
The method is overriden in an inherited class in order to obtain a 3 column layout:

     class PDF extends TCPDF {
     	var $col=0;

     	public function SetCol($col) {
     		//Move position to a column
     		$this->col=$col;
     		$x=10+$col*65;
     		$this->SetLeftMargin($x);
     		$this->SetX($x);
     	}

     	public function AcceptPageBreak() {
     		if($this->col<2) {
     			//Go to next column
     			$this->SetCol($this->col+1);
     			$this->SetY(10);
     			return false;
     		}
     		else {
     			//Go back to first column and issue page break
     			$this->SetCol(0);
     			return true;
     		}
     	}
     }

     $pdf=new PDF();
     $pdf->Open();
     $pdf->AddPage();
     $pdf->SetFont('Arial','',12);
     for($i=1;$i<=300;$i++) {
         $pdf->Cell(0,5,"Line $i",0,1);
     }
     $pdf->Output();

- see: TCPDF::SetAutoPageBreak()
- since: 1.4
- access: public

boolean AcceptPageBreak ()
AddFont (line 1855)

Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. 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.

Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. Example:

     $pdf->AddFont('Comic','I');
     // is equivalent to:
     $pdf->AddFont('Comic','I','comici.php');

- see: TCPDF::SetFont()
- since: 1.5
- access: public

void AddFont (string $family, [string $style = ''], [string $file = ''])

- string $family: Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
- string $style: Font style. Possible values are (case insensitive):
  - empty string: regular (default)
  - B: bold
  - I: italic
  - BI or IB: bold italic
- string $file: The font definition file. By default, the name is built from the family and style, in lower case with no space.

addHtmlLink (line 4769)

Output anchor link.

- access: public

void addHtmlLink (string $url, string $name, [int $fill = 0])

- string $url: link URL
- string $name: link name
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

AddLink (line 2071)

Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().

- see: TCPDF::Cell(), TCPDF::Write(), TCPDF::Image(), TCPDF::Link(), TCPDF::SetLink()
- since: 1.5
- access: public

void AddLink ()
AddPage (line 1456)

Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header.

The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.

- see: TCPDF(), TCPDF::Header(), TCPDF::Footer(), TCPDF::SetMargins()
- since: 1.0
- access: public

void AddPage ([string $orientation = ''])

- string $orientation: Page orientation. Possible values are (case insensitive):
  - P or Portrait
  - L or Landscape
  The default value is the one passed to the constructor.

AliasNbPages (line 1356)

Defines an alias for the total number of pages. It will be substituted as the document is closed.

Example:

     class PDF extends TCPDF {
     	public function Footer() {
     		//Go to 1.5 cm from bottom
     		$this->SetY(-15);
     		//Select Arial italic 8
     		$this->SetFont('Arial','I',8);
     		//Print current and total page numbers
     		$this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C');
     	}
     }
     $pdf=new PDF();
     $pdf->AliasNbPages();

- see: TCPDF::PageNo(), TCPDF::Footer()
- since: 1.4
- access: public

void AliasNbPages ([string $alias = '{nb}'])

- string $alias: The alias. Default value: {nb}.

arrUTF8ToUTF16BE (line 4041)

Converts array of UTF-8 characters to UTF16-BE string.

Based on: http://www.faqs.org/rfcs/rfc2781.html

       Encoding UTF-16:

       Encoding of a single character from an ISO 10646 character value to
        UTF-16 proceeds as follows. Let U be the character number, no greater
        than 0x10FFFF.

        1) If U < 0x10000, encode U as a 16-bit unsigned integer and
           terminate.

        2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
           U' must be less than or equal to 0xFFFFF. That is, U' can be
           represented in 20 bits.

        3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
           0xDC00, respectively. These integers each have 10 bits free to
           encode the character value, for a total of 20 bits.

        4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
           bits of W1 and the 10 low-order bits of U' to the 10 low-order
           bits of W2. Terminate.

        Graphically, steps 2 through 4 look like:
        U' = yyyyyyyyyyxxxxxxxxxx
        W1 = 110110yyyyyyyyyy
        W2 = 110111xxxxxxxxxx

- author: Nicola Asuni
- see: TCPDF::UTF8ToUTF16BE()
- since: 2.1.000 (2008-01-08)
- access: protected

string arrUTF8ToUTF16BE (array $unicode, [boolean $setbom = true])

- array $unicode: array containing UTF-8 unicode values
- boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)

Bookmark (line 6496)

- access: public

void Bookmark ( $txt, [ $level = 0], [ $y = -1])

- $txt
- $level
- $y

Button (line 6721)

- access: public

void Button ( $name, $w, $h, $caption, $action, [ $prop = array()])

- $name
- $w
- $h
- $caption
- $action
- $prop

Cell (line 2202)

Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

- see: TCPDF::SetFont(), TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::SetLineWidth(), TCPDF::AddLink(), TCPDF::Ln(), TCPDF::MultiCell(), TCPDF::Write(), TCPDF::SetAutoPageBreak()
- since: 1.0
- access: public

void Cell (float $w, [float $h = 0], [string $txt = ''], [mixed $border = 0], [int $ln = 0], [string $align = ''], [int $fill = 0], [mixed $link = ''], [int $stretch = 0])

- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell height. Default value: 0.
- string $txt: String to print. Default value: empty string.
- mixed $border: Indicates if borders must be drawn around the cell. The value can be either 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
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right (or left for RTL languages)
  - 1: to the beginning of the next line
  - 2: below
- string $align: Allows to center or align the text. Possible values are:
  - L or empty string: left align (default value)
  - C: center
  - R: right align
  - J: justify
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- mixed $link: URL or identifier returned by AddLink().
- int $stretch: stretch carachter mode:
  - 0 = disabled
  - 1 = horizontal scaling only if necessary
  - 2 = forced horizontal scaling
  - 3 = character spacing only if necessary
  - 4 = forced character spacing

CheckBox (line 6701)

- access: public

void CheckBox ( $name, $w, [ $checked = false], [ $prop = array()])

- $name
- $w
- $checked
- $prop

Circle (line 5746)

Draws a circle.

A circle is formed from n Bezier curves.

- since: 2.1.000 (2008-01-08)
- access: public

void Circle (float $x0, float $y0, float $r, [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $astart:, float $afinish:)

- float $x0: Abscissa of center point.
- float $y0: Ordinate of center point.
- float $r: Radius.
- float $astart:: Angle start of draw line. Default value: 0.
- float $afinish:: Angle finish of draw line. Default value: 360.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
  - C: Draw close.
- array $line_style: Line style of circle. Array like for SetLineStyle. Default value: default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- integer $nc: Number of curves used in circle. Default value: 8.
- $astart
- $afinish

Close (line 1388)

Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.

- see: TCPDF::Open(), TCPDF::Output()
- since: 1.0
- access: public

void Close ()
closedHTMLTagHandler (line 4627)

Process closing tags.

- access: private

void closedHTMLTagHandler (string $tag)

- string $tag: tag name (in uppercase)

ComboBox (line 6682)

- access: public

void ComboBox ( $name, $w, $h, $values, [ $prop = array()])

- $name
- $w
- $h
- $values
- $prop

convertColorHexToDec (line 4785)

Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA).

- access: private

array convertColorHexToDec ([string $color = "#000000"])

- string $color: hexadecimal html color [#rrggbb]

Curve (line 5599)

Draws a Bezier curve.

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

- see: TCPDF::SetLineStyle()
- since: 2.1.000 (2008-01-08)
- access: public

void Curve (float $x0, float $y0, float $x1, float $y1, float $x2, float $y2, float $x3, float $y3, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])

- float $x0: Abscissa of start point.
- float $y0: Ordinate of start point.
- float $x1: Abscissa of control point 1.
- float $y1: Ordinate of control point 1.
- float $x2: Abscissa of control point 2.
- float $y2: Ordinate of control point 2.
- float $x3: Abscissa of end point.
- float $y3: Ordinate of end point.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $line_style: Line style of curve. Array like for SetLineStyle. Default value: default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).

Ellipse (line 5651)

Draws an ellipse.

An ellipse is formed from n Bezier curves.

- since: 2.1.000 (2008-01-08)
- access: public

void Ellipse (float $x0, float $y0, float $rx, [float $ry = 0], [ $angle = 0], [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $angle:, float $astart:, float $afinish:)

- float $x0: Abscissa of center point.
- float $y0: Ordinate of center point.
- float $rx: Horizontal radius.
- float $ry: Vertical radius (if ry = 0 then is a circle, see Circle). Default value: 0.
- float $angle:: Angle oriented (anti-clockwise). Default value: 0.
- float $astart:: Angle start of draw line. Default value: 0.
- float $afinish:: Angle finish of draw line. Default value: 360.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
  - C: Draw close.
- array $line_style: Line style of ellipse. Array like for SetLineStyle. Default value: default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- integer $nc: Number of curves used in ellipse. Default value: 8.
- $angle
- $astart
- $afinish

Error (line 1367)

This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.

2004-06-11 :: Nicola Asuni : changed bold tag with strong

- since: 1.0
- access: public

void Error (string $msg)

- string $msg: The error message

Footer (line 1652)

This method is used to render the page footer.

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

- access: public

void Footer ()
GetAbsX (line 2862)

Returns the absolute X value of current position.

- see: TCPDF::SetX(), TCPDF::GetY(), TCPDF::SetY()
- since: 1.2
- access: public

float GetAbsX ()
getBreakMargin (line 1145)

Returns the page break margin.

- return: page break margin.
- author: Nicola Asuni
- since: 1.5.2
- access: public

int getBreakMargin ()
getImageScale (line 1115)

Returns the image scale.

- return: image scale.
- author: Nicola Asuni
- since: 1.5.2
- access: public

float getImageScale ()
GetLineWidth (line 5331)

Returns the current the line width.

- return: Line width
- see: TCPDF::Line(), TCPDF::SetLineWidth()
- since: 2.1.000 (2008-01-07)
- access: public

int GetLineWidth ()
GetNumChars (line 1833)

Returns the numbero of characters in a string.

- return: number of characters
- since: 2.0.0001 (2008-01-07)
- access: public

int GetNumChars (string $s)

- string $s: The input string.

getNumPages (line 1444)

Get the total number of insered pages.

- return: number of pages
- see: TCPDF::setPage(), TCPDF::getPage(), lastpage()
- since: 2.1.000 (2008-01-07)
- access: public

int getNumPages ()
getPage (line 1433)

Get current document page number.

- return: page number
- see: TCPDF::setPage(), lastpage(), TCPDF::getNumPages()
- since: 2.1.000 (2008-01-07)
- access: public

int getPage ()
getPageHeight (line 1135)

Returns the page height in units.

- return: page height.
- author: Nicola Asuni
- since: 1.5.2
- access: public

int getPageHeight ()
getPageWidth (line 1125)

Returns the page width in units.

- return: page width.
- author: Nicola Asuni
- since: 1.5.2
- access: public

int getPageWidth ()
getPDFData (line 4181)

Returns the PDF data.

- access: public

void getPDFData ()
getScaleFactor (line 1155)

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

- return: scale factor.
- author: Nicola Asuni
- since: 1.5.2
- access: public

int getScaleFactor ()
GetStringWidth (line 1794)

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

Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]

- since: 1.2
- access: public

int GetStringWidth (string $s)

- string $s: The string whose length is to be computed

GetX (line 2847)

Returns the relative X value of current position.

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

- see: TCPDF::SetX(), TCPDF::GetY(), TCPDF::SetY()
- since: 1.2
- access: public

float GetX ()
GetY (line 2872)

Returns the ordinate of the current position.

- see: TCPDF::SetY(), TCPDF::GetX(), TCPDF::SetX()
- since: 1.0
- access: public

float GetY ()
Header (line 1580)

This method is used to render the page header.

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

- access: public

void Header ()
Image (line 2713)

Puts an image in the page. 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.

For JPEG, all flavors are allowed:

- gray scales
- true colors (24 bits)
- CMYK (32 bits)

For PNG, are allowed:

- gray scales on at most 8 bits (256 levels)
- indexed colors
- true colors (24 bits)

If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).
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.

- see: TCPDF::AddLink()
- since: 1.1
- access: public

void Image (string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''], [string $align = ''])

- string $file: Name of the file containing the image.
- float $x: Abscissa of the upper-left corner.
- float $y: Ordinate of the upper-left corner.
- float $w: Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- float $h: Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- string $type: Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
- mixed $link: URL or identifier returned by AddLink().
- string $align: Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
  - T: top-right for LTR or top-left for RTL
  - M: middle-right for LTR or middle-left for RTL
  - B: bottom-right for LTR or bottom-left for RTL
  - N: next line

IncludeJS (line 6573)

- access: public

void IncludeJS ( $script)

- $script

justify (line 4828)

Justify string by adding space characters.

Justifies string by adding space characters between words. It assumes that words in input string are divided only by single space character.

- return: justified string
- author: Nicola Asuni, dullus
- since: 2007-07-27
- access: private

string justify ($rowWidth $rowWidth, $txtWidth $txtWidth, $spaceWidth $spaceWidth, $txt $txt)

- $rowWidth $rowWidth: float row width in page units (e.g. mm)
- $txtWidth $txtWidth: float text string width in page units (e.g. mm)
- $spaceWidth $spaceWidth: float space character width in page units (e.g. mm)
- $txt $txt: string string to be justified

lastPage (line 1411)

Reset pointer to the last document page.

- see: TCPDF::setPage(), TCPDF::getPage(), TCPDF::getNumPages()
- since: 2.0.000 (2008-01-04)
- access: public

void lastPage ()
Line (line 5480)

Draws a line between two points.

- see: TCPDF::SetLineWidth(), TCPDF::SetDrawColor(), TCPDF::SetLineStyle()
- since: 1.0
- access: public

void Line (float $x1, float $y1, float $x2, float $y2, [array $style = array()])

- float $x1: Abscissa of first point.
- float $y1: Ordinate of first point.
- float $x2: Abscissa of second point.
- float $y2: Ordinate of second point.
- array $style: Line style. Array like for SetLineStyle. Default value: default line style (empty array).

Link (line 2107)

Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.

- see: TCPDF::AddLink(), TCPDF::Cell(), TCPDF::Write(), TCPDF::Image()
- since: 1.5
- access: public

void Link (float $x, float $y, float $w, float $h, mixed $link)

- float $x: Abscissa of the upper-left corner of the rectangle (or upper-right for RTL languages)
- float $y: Ordinate of the upper-left corner of the rectangle (or upper-right for RTL languages)
- float $w: Width of the rectangle
- float $h: Height of the rectangle
- mixed $link: URL or identifier returned by AddLink()

Ln (line 2826)

Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.

- see: TCPDF::Cell()
- since: 1.0
- access: public

void Ln ([float $h = ''])

- float $h: The height of the break. By default, the value equals the height of the last printed cell.

MirrorH (line 5125)

Horizontal Mirroring.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void MirrorH ([int $x = ''])

- int $x: abscissa of the point. Default is current x position

MirrorL (line 5158)

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

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void MirrorL ([float $angle = 0], [int $x = ''], [int $y = ''])

- float $angle: gradient angle of the straight line. Default is 0 (horizontal line).
- int $x: abscissa of the point. Default is current x position
- int $y: ordinate of the point. Default is current y position

MirrorP (line 5146)

Point reflection mirroring.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void MirrorP ([int $x = ''], [int $y = ''])

- int $x: abscissa of the point. Default is current x position
- int $y: ordinate of the point. Default is current y position

MirrorV (line 5135)

Verical Mirroring.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void MirrorV ([int $y = ''])

- int $y: ordinate of the point. Default is current y position

MultiCell (line 2413)

This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.
Text can be aligned, centered or justified. The cell block can be framed and the background painted.

- return: number of cells (number of lines)
- see: TCPDF::SetFont(), TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::SetLineWidth(), TCPDF::Cell(), TCPDF::Write(), TCPDF::SetAutoPageBreak()
- since: 1.3
- access: public

int MultiCell (float $w, float $h, string $txt, [mixed $border = 0], [string $align = 'J'], [int $fill = 0], [int $ln = 1])

- float $w: Width of cells. If 0, they extend up to the right margin of the page.
- float $h: Height of cells.
- string $txt: String to print
- mixed $border: Indicates if borders must be drawn around the cell block. The value can be either 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
- string $align: Allows to center or align the text. Possible values are:
  - L or empty string: left align
  - C: center
  - R: right align
  - J: justification (default value)
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right
  - 1: to the beginning of the next line [DEFAULT]
  - 2: below

Open (line 1378)

This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.

Note: no page is created by this method

- see: TCPDF::AddPage(), TCPDF::Close()
- since: 1.0
- access: public

void Open ()
openHTMLTagHandler (line 4381)

Process opening tags.

- access: private

void openHTMLTagHandler (string $tag, string $attr, [int $fill = 0])

- string $tag: tag name (in uppercase)
- string $attr: tag attribute (in uppercase)
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.

Output (line 2944)

Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.

- see: TCPDF::Close()
- since: 1.0
- access: public

void Output ([string $name = ''], [string $dest = ''])

- string $name: The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.
- string $dest: Destination where to send the document. It can take one of the following values:
  - I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
  - D: send to the browser and force a file download with the name given by name.
  - F: save to a local file with the name given by name.
  - S: return the document as a string. name is ignored.
  If the parameter is not specified but a name is given, destination is F. If no parameter is specified at all, destination is I.
  Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D).

outputjpg (line 3653)

Get a JPEG filename and return a structure for the PDF creator.

- return: structure containing the image data
- access: protected

array outputjpg (string $filename)

- string $filename: JPEG file name.

PageNo (line 1710)

Returns the current page number.

- return: page number
- see: TCPDF::AliasNbPages()
- since: 1.0
- access: public

int PageNo ()
pixelsToMillimeters (line 4799)

Converts pixels to millimeters in 72 dpi.

- return: millimeters
- access: private

float pixelsToMillimeters (int $px)

- int $px: pixels

Polygon (line 5769)

Draws a polygon.

- since: 2.1.000 (2008-01-08)
- access: public

void Polygon (array $p, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])

- array $p: Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $line_style: Line style of polygon. Array with keys among the following:
  - all: Line style of all lines. Array like for SetLineStyle.
  - 0 to ($np - 1): Line style of each line. Array like for SetLineStyle.
  If a key is not present or is null, not draws the line. Default value is default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).

Rect (line 5512)

Draws a rectangle.

- see: TCPDF::SetLineStyle()
- since: 1.0
- access: public

void Rect (float $x, float $y, float $w, float $h, [string $style = ''], [array $border_style = array()], [array $fill_color = array()])

- float $x: Abscissa of upper-left corner (or upper-right corner for RTL language).
- float $y: Ordinate of upper-left corner (or upper-right corner for RTL language).
- float $w: Width.
- float $h: Height.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $border_style: Border style of rectangle. Array with keys among the following:
  - all: Line style of all borders. Array like for SetLineStyle.
  - L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for SetLineStyle.
  If a key is not present or is null, not draws the border. Default value: default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).

RegularPolygon (line 5858)

Draws a regular polygon.

- since: 2.1.000 (2008-01-08)
- access: public

void RegularPolygon (float $x0, float $y0, $r, integer $ns, [float $angle = 0], [boolean $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $r:)

- float $x0: Abscissa of center point.
- float $y0: Ordinate of center point.
- float $r:: Radius of inscribed circle.
- integer $ns: Number of sides.
- float $angle: Angle oriented (anti-clockwise). Default value: 0.
- boolean $draw_circle: Draw inscribed circle or not. Default value: false.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $line_style: Line style of polygon sides. Array with keys among the following:
  - all: Line style of all sides. Array like for SetLineStyle.
  - 0 to ($ns - 1): Line style of each side. Array like for SetLineStyle.
  If a key is not present or is null, not draws the side. Default value is default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- string $circle_style: Style of rendering of inscribed circle (if draws). Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $circle_outLine_style: Line style of inscribed circle (if draws). Array like for SetLineStyle. Default value: default line style (empty array).
- array $circle_fill_color: Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
- $r

Rotate (line 5213)

Rotate object.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void Rotate (float $angle, [int $x = ''], [int $y = ''])

- float $angle: angle in degrees for counter-clockwise rotation
- int $x: abscissa of the rotation center. Default is current x position
- int $y: ordinate of the rotation center. Default is current y position

RoundedRect (line 5956)

Draws a rounded rectangle.

- since: 2.1.000 (2008-01-08)
- access: public

void RoundedRect (float $x, float $y, float $w, float $h, float $r, [string $round_corner = "1111"], [string $style = ""], [array $border_style = array()], [array $fill_color = array()])

- float $x: Abscissa of upper-left corner.
- float $y: Ordinate of upper-left corner.
- float $w: Width.
- float $h: Height.
- float $r: Radius of the rounded corners.
- string $round_corner: Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom left. Default value: all rounded corner ("1111").
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $border_style: Border style of rectangle. Array like for SetLineStyle. Default value: default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).

Scale (line 5092)

Vertical and horizontal non-proportional Scaling.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void Scale (float $s_x, float $s_y, [int $x = ''], [int $y = ''])

- float $s_x: scaling factor for width as percent. 0 is not allowed.
- float $s_y: scaling factor for height as percent. 0 is not allowed.
- int $x: abscissa of the scaling center. Default is current x position
- int $y: ordinate of the scaling center. Default is current y position

ScaleX (line 5055)

Horizontal Scaling.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void ScaleX (float $s_x, [int $x = ''], [int $y = ''])

- float $s_x: scaling factor for width as percent. 0 is not allowed.
- int $x: abscissa of the scaling center. Default is current x position
- int $y: ordinate of the scaling center. Default is current y position

ScaleXY (line 5079)

Vertical and horizontal proportional Scaling.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void ScaleXY (float $s, [int $x = ''], [int $y = ''])

- float $s: scaling factor for width and height as percent. 0 is not allowed.
- int $x: abscissa of the scaling center. Default is current x position
- int $y: ordinate of the scaling center. Default is current y position

ScaleY (line 5067)

Vertical Scaling.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void ScaleY (float $s_y, [int $x = ''], [int $y = ''])

- float $s_y: scaling factor for height as percent. 0 is not allowed.
- int $x: abscissa of the scaling center. Default is current x position
- int $y: ordinate of the scaling center. Default is current y position

SetAuthor (line 1308)

Defines the author of the document.

- see: TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2
- access: public

void SetAuthor (string $author)

- string $author: The name of the author.

SetAutoPageBreak (line 1235)

Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.

- see: TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::AcceptPageBreak()
- since: 1.0
- access: public

void SetAutoPageBreak (boolean $auto, [float $margin = 0])

- boolean $auto: Boolean indicating if mode should be on or off.
- float $margin: Distance from the bottom of the page.

setBarcode (line 4098)

Set document barcode.

- access: public

void setBarcode ([string $bc = ""])

- string $bc: barcode

SetCellPadding (line 1224)

Set the internal Cell padding.

- see: TCPDF::Cell(), TCPDF::SetLeftMargin(), TCPDF::SetTopMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 2.1.000 (2008-01-09)
- access: public

void SetCellPadding (float $pad)

- float $pad: internal padding.

SetCompression (line 1270)

Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.

Note: the Zlib extension is required for this feature. If not present, compression will be turned off.

- since: 1.4
- access: public

void SetCompression (boolean $compress)

- boolean $compress: Boolean indicating if compression must be enabled.

SetCreator (line 1330)

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

- see: TCPDF::SetAuthor(), TCPDF::SetKeywords(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2
- access: public

void SetCreator (string $creator)

- string $creator: The name of the creator.

SetDisplayMode (line 1248)

Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.

- since: 1.2
- access: public

void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])

- mixed $zoom: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
  - fullpage: displays the entire page on screen
  - fullwidth: uses maximum width of window
  - real: uses real size (equivalent to 100% zoom)
  - default: uses viewer default mode
- string $layout: The page layout. Possible values are:
  - single: displays one page at once
  - continuous: displays pages continuously (default)
  - two: displays two pages on two columns
  - default: uses viewer default mode

SetDrawColor (line 1723)

Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

- see: TCPDF::SetFillColor(), TCPDF::SetTextColor(), TCPDF::Line(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3
- access: public

void SetDrawColor (int $r, [int $g = -1], [int $b = -1])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)

SetFillColor (line 1745)

Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

- see: TCPDF::SetDrawColor(), TCPDF::SetTextColor(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3
- access: public

void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevFillColor variable.

SetFont (line 1954)

Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid.

The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:

- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant

Example for the last case (note the trailing slash):

     define('K_PATH_FONTS','/home/www/font/');
     require('tcpdf.php');

     //Times regular 12
     $pdf->SetFont('Times');
     //Arial bold 14
     $pdf->SetFont('Arial','B',14);
     //Removes bold
     $pdf->SetFont('');
     //Times bold, italic and underlined 14
     $pdf->SetFont('Times','BIU');

If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.

- see: TCPDF::AddFont(), TCPDF::SetFontSize(), TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::Write()
- since: 1.0
- access: public

void SetFont (string $family, [string $style = ''], [float $size = 0])

- string $family: Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
  - Courier (fixed-width)
  - Helvetica or Arial (synonymous; sans serif)
  - Times (serif)
  - Symbol (symbolic)
  - ZapfDingbats (symbolic)
  It is also possible to pass an empty string. In that case, the current family is retained.
- string $style: Font style. Possible values are (case insensitive):
  - empty string: regular
  - B: bold
  - I: italic
  - U: underline
  or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats
- float $size: Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12

SetFontSize (line 2053)

Defines the size of the current font.

- see: TCPDF::SetFont()
- since: 1.0
- access: public

void SetFontSize (float $size)

- float $size: The size (in points)

setFooterFont (line 4080)

Set footer font.

- since: 1.1
- access: public

void setFooterFont (array $font)

- array $font: font

setFooterMargin (line 1556)

Set footer margin.

(minimum distance between footer and bottom page margin)

- access: public

void setFooterMargin ([int $fm = 10])

- int $fm: distance in millimeters

setHeaderData (line 1535)

Set header data.

- access: public

void setHeaderData ([string $ln = ""], [string $lw = 0], [string $ht = ""], [string $hs = ""])

- string $ln: header image logo
- string $lw: header image logo width in mm
- string $ht: string to print as title on document header
- string $hs: string to print on document header

setHeaderFont (line 4071)

Set header font.

- since: 1.1
- access: public

void setHeaderFont (array $font)

- array $font: font

setHeaderMargin (line 1547)

Set header margin.

(minimum distance between header and top page margin)

- access: public

void setHeaderMargin ([int $hm = 10])

- int $hm: distance in millimeters

setImageScale (line 1105)

Set the image scale.

- author: Nicola Asuni
- since: 1.5.2
- access: public

void setImageScale (float $scale)

- float $scale: image scale.

SetKeywords (line 1319)

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

- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetSubject(), TCPDF::SetTitle()
- since: 1.2
- access: public

void SetKeywords (string $keywords)

- string $keywords: The list of keywords.

setLanguageArray (line 4089)

Set language array.

- since: 1.1
- access: public

void setLanguageArray (array $language)

- array $language

setLastH (line 1095)

Set the last cell height.

- author: Nicola Asuni
- since: 1.53.0.TC034
- access: public

void setLastH (float $h)

- float $h: cell height.

SetLeftMargin (line 1183)

Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.

- see: TCPDF::SetTopMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.4
- access: public

void SetLeftMargin (float $margin)

- float $margin: The margin.

SetLineStyle (line 5357)

Set line style.

- since: 2.1.000 (2008-01-08)
- access: public

void SetLineStyle (array $style)

- array $style: Line style. Array with keys among the following:
  - width (float): Width of the line in user units.
  - cap (string): Type of cap to put on the line. Possible values are: butt, round, square. The difference between "square" and "butt" is that "square" projects a flat end past the end of the line.
  - join (string): Type of join. Possible values are: miter, round, bevel.
  - dash (mixed): Dash pattern. Is 0 (without dash) or string with series of length values, which are the lengths of the on and off dashes. For example: "2" represents 2 on, 2 off, 2 on, 2 off, ...; "2,1" is 2 on, 1 off, 2 on, 1 off, ...
  - phase (integer): Modifier on the dash pattern which is used to shift the point at which the pattern starts.
  - color (array): Draw color. Format: array(red, green, blue).

SetLineWidth (line 5317)

Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.

- see: TCPDF::Line(), TCPDF::Rect(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.0
- access: public

void SetLineWidth (float $width)

- float $width: The width.

SetLink (line 2086)

Defines the page and position a link points to

- see: TCPDF::AddLink()
- since: 1.5
- access: public

void SetLink (int $link, [float $y = 0], [int $page = -1])

- int $link: The link identifier returned by AddLink()
- float $y: Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
- int $page: Number of target page; -1 indicates the current page. This is the default value

SetMargins (line 1167)

Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.

- see: TCPDF::SetLeftMargin(), TCPDF::SetTopMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak()
- since: 1.0
- access: public

void SetMargins (float $left, float $top, [float $right = -1])

- float $left: Left margin.
- float $top: Top margin.
- float $right: Right margin. Default value is the left one.

setPage (line 1421)

Move pointer to the apecified document page.

- see: TCPDF::getPage(), lastpage(), TCPDF::getNumPages()
- since: 2.1.000 (2008-01-07)
- access: public

void setPage (int $pnum)

- int $pnum: page number

setPrintFooter (line 1572)

Set a flag to print page footer.

- access: public

void setPrintFooter ([ $val = true], boolean $value)

- boolean $value: set to true to print the page footer (default), false otherwise.
- $val

setPrintHeader (line 1564)

Set a flag to print page header.

- access: public

void setPrintHeader ([boolean $val = true])

- boolean $val: set to true to print the page header (default), false otherwise.

SetProtection (line 5005)

Set document protection

The permission array is composed of values taken from the following ones:

- copy: copy text and images to the clipboard
- print: print the document
- modify: modify it (except for annotations and forms)
- annot-forms: add annotations and forms

Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.

- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: public

void SetProtection ([Array $permissions = array()], [String $user_pass = ''], [String $owner_pass = null])

- Array $permissions: the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms)
- String $user_pass: user password. Empty by default.
- String $owner_pass: owner password. If not specified, a random value is used.

SetRightMargin (line 1211)

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

- see: TCPDF::SetLeftMargin(), TCPDF::SetTopMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.5
- access: public

void SetRightMargin (float $margin)

- float $margin: The margin.

setRTL (line 1069)

Enable or disable Right-To-Left language mode

- since: 2.0.000 (2008-01-03)
- access: public

void setRTL (Boolean $enable)

- Boolean $enable: if true enable Right-To-Left language mode.

setStyle (line 4750)

Sets font style.

- access: private

void setStyle (string $tag, boolean $enable)

- string $tag: tag name (in lowercase)
- boolean $enable

SetSubject (line 1297)

Defines the subject of the document.

- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetTitle()
- since: 1.2
- access: public

void SetSubject (string $subject)

- string $subject: The subject.

setTempRTL (line 1079)

Force temporary RTL language direction

- since: 2.1.000 (2008-01-09)
- access: public

void setTempRTL (mixed $mode)

- mixed $mode: can be false, 'L' for LTR or 'R' for RTL

SetTextColor (line 1772)

Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

- see: TCPDF::SetDrawColor(), TCPDF::SetFillColor(), TCPDF::Text(), TCPDF::Cell(), TCPDF::MultiCell()
- since: 1.3
- access: public

void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])

- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevTextColor variable.

SetTitle (line 1286)

Defines the title of the document.

- see: TCPDF::SetAuthor(), TCPDF::SetCreator(), TCPDF::SetKeywords(), TCPDF::SetSubject()
- since: 1.2
- access: public

void SetTitle (string $title)

- string $title: The title.

SetTopMargin (line 1197)

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

- see: TCPDF::SetLeftMargin(), TCPDF::SetRightMargin(), TCPDF::SetAutoPageBreak(), TCPDF::SetMargins()
- since: 1.5
- access: public

void SetTopMargin (float $margin)

- float $margin: The margin.

SetX (line 2884)

Defines the abscissa of the current position.

If the passed value is negative, it is relative to the right of the page (or left if language is RTL).

- see: TCPDF::GetX(), TCPDF::GetY(), TCPDF::SetY(), TCPDF::SetXY()
- since: 1.2
- access: public

void SetX (float $x)

- float $x: The value of the abscissa.

SetXY (line 2930)

Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.

- see: TCPDF::SetX(), TCPDF::SetY()
- since: 1.2
- access: public

void SetXY (float $x, float $y)

- float $x: The value of the abscissa
- float $y: The value of the ordinate

SetY (line 2908)

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

If the passed value is negative, it is relative to the bottom of the page.

- see: TCPDF::GetX(), TCPDF::GetY(), TCPDF::SetY(), TCPDF::SetXY()
- since: 1.0
- access: public

void SetY (float $y)

- float $y: The value of the ordinate.

Skew (line 5270)

Skew.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void Skew (float $angle_x, float $angle_y, [int $x = ''], [int $y = ''])

- float $angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
- float $angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
- int $x: abscissa of the skewing center. default is current x position
- int $y: ordinate of the skewing center. default is current y position

SkewX (line 5245)

Skew horizontally.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void SkewX (float $angle_x, [int $x = ''], [int $y = ''])

- float $angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
- int $x: abscissa of the skewing center. default is current x position
- int $y: ordinate of the skewing center. default is current y position

SkewY (line 5257)

Skew vertically.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void SkewY (float $angle_y, [int $x = ''], [int $y = ''])

- float $angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
- int $x: abscissa of the skewing center. default is current x position
- int $y: ordinate of the skewing center. default is current y position

StarPolygon (line 5909)

Draws a star polygon

- since: 2.1.000 (2008-01-08)
- access: public

void StarPolygon (float $x0, float $y0, float $r, integer $nv, integer $ng, [ $angle = 0], [ $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $angle:, boolean $draw_circle:)

- float $x0: Abscissa of center point.
- float $y0: Ordinate of center point.
- float $r: Radius of inscribed circle.
- integer $nv: Number of vertices.
- integer $ng: Number of gap (if ($ng % $nv = 1) then is a regular polygon).
- float $angle:: Angle oriented (anti-clockwise). Default value: 0.
- boolean $draw_circle:: Draw inscribed circle or not. Default value is false.
- string $style: Style of rendering. Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $line_style: Line style of polygon sides. Array with keys among the following:
  - all: Line style of all sides. Array like for SetLineStyle.
  - 0 to (n - 1): Line style of each side. Array like for SetLineStyle.
  If a key is not present or is null, not draws the side. Default value is default line style (empty array).
- array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- string $circle_style: Style of rendering of inscribed circle (if draws). Possible values are:
  - D or empty string: Draw (default).
  - F: Fill.
  - DF or FD: Draw and fill.
- array $circle_outLine_style: Line style of inscribed circle (if draws). Array like for SetLineStyle. Default value: default line style (empty array).
- array $circle_fill_color: Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
- $angle
- $draw_circle

StartTransform (line 5033)

Starts a 2D tranformation saving current graphic state.

This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void StartTransform ()
StopTransform (line 5044)

Stops a 2D tranformation restoring previous graphic state.

This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void StopTransform ()
Text (line 2119)

Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.

- see: TCPDF::SetFont(), TCPDF::SetTextColor(), TCPDF::Cell(), TCPDF::MultiCell(), TCPDF::Write()
- since: 1.0
- access: public

void Text (float $x, float $y, string $txt)

- float $x: Abscissa of the origin
- float $y: Ordinate of the origin
- string $txt: String to print

TextField (line 6664)

- access: public

void TextField ( $name, $w, $h, [ $prop = array()])

- $name
- $w
- $h
- $prop

toJPEG (line 3632)

Convert the loaded php image to a JPEG and then return a structure for the PDF creator.

- access: protected

void toJPEG (string $file, image $image)

- string $file: Image file name.
- image $image: Image object. return image JPEG image object.

Transform (line 5301)

Apply graphic transformations.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: protected

void Transform ( $tm)

- $tm

Translate (line 5190)

Translate graphic object horizontally and vertically.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void Translate (int $t_x, int $t_y)

- int $t_x: movement to the right
- int $t_y: movement to the bottom

TranslateX (line 5169)

Translate graphic object horizontally.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void TranslateX (int $t_x)

- int $t_x: movement to the right

TranslateY (line 5179)

Translate graphic object vertically.

- see: TCPDF::StartTransform(), TCPDF::StopTransform()
- since: 2.1.000 (2008-01-07)
- access: public

void TranslateY (int $t_y)

- int $t_y: movement to the bottom

unhtmlentities (line 4810)

Reverse function for htmlentities.

Convert entities in UTF-8.

- return: converted
- access: public

string unhtmlentities ($text_to_convert $text_to_convert)

- $text_to_convert $text_to_convert: Text to convert.

UTF8StringToArray (line 3921)

Converts UTF-8 strings to codepoints array.

Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html

     	  Char. number range  |        UTF-8 octet sequence
           (hexadecimal)    |              (binary)
        --------------------+-----------------------------------------------
        0000 0000-0000 007F | 0xxxxxxx
        0000 0080-0000 07FF | 110xxxxx 10xxxxxx
        0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
        0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
        ---------------------------------------------------------------------

       ABFN notation:
       ---------------------------------------------------------------------
       UTF8-octets = *( UTF8-char )
       UTF8-char   = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
       UTF8-1      = %x00-7F
       UTF8-2      = %xC2-DF UTF8-tail

       UTF8-3      = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
                     %xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
       UTF8-4      = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
                     %xF4 %x80-8F 2( UTF8-tail )
       UTF8-tail   = %x80-BF
       ---------------------------------------------------------------------

- return: containing codepoints (UTF-8 characters values)
- author: Nicola Asuni
- since: 1.53.0.TC005 (2005-01-05)
- access: protected

array UTF8StringToArray (string $str)

- string $str: string to process.

utf8StrRev (line 6034)

Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).

- author: Nicola Asuni
- since: 2.1.000 (2008-01-08)
- access: protected

string utf8StrRev (string $str, [ $setbom = false], [bool $forcertl = false])

- string $str: string to manipulate.
- bool $forcertl: if 'R' forces RTL, if 'L' forces LTR
- $setbom

UTF8ToUTF16BE (line 3995)

Converts UTF-8 strings to UTF16-BE.

- author: Nicola Asuni
- since: 1.53.0.TC005 (2005-01-05)
- access: protected
- uses: TCPDF::UTF8StringToArray(), - arrUTF8ToUTF16BE()

string UTF8ToUTF16BE (string $str, [boolean $setbom = true])

- string $str: string to process.
- boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)

Write (line 2581)

This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.

Example:

     //Begin with regular font
     $pdf->SetFont('Arial','',14);
     $pdf->Write(5,'Visit ');
     //Then put a blue underlined link
     $pdf->SetTextColor(0,0,255);
     $pdf->SetFont('','U');
     $pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');

- see: TCPDF::SetFont(), TCPDF::SetTextColor(), TCPDF::AddLink(), TCPDF::MultiCell(), TCPDF::SetAutoPageBreak()
- since: 1.5
- access: public

void Write (float $h, string $txt, [mixed $link = ''], [int $fill = 0])

- float $h: Line height
- string $txt: String to print
- mixed $link: URL or identifier returned by AddLink()
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.

writeBarcode (line 4114)

Print Barcode.

- access: public

void writeBarcode (int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)

- int $x: x position in user units
- int $y: y position in user units
- int $w: width in user units
- int $h: height position in user units
- string $type: type of barcode (I25, C128A, C128B, C128C, C39)
- string $style: barcode style
- string $font: font for text
- int $xres: x resolution
- string $code: code to print

writeHTML (line 4199)

Allows to preserve some HTML formatting.

Supports: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small

- access: public

void writeHTML (string $html, [boolean $ln = true], [int $fill = 0], [boolean $reseth = false], [boolean $cell = false])

- string $html: text to display
- boolean $ln: if true add a new line after text (default = true)
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.
- boolean $reseth: if true reset the last cell height (default false).
- boolean $cell: if true add the default cMargin space to each Write.

writeHTMLCell (line 4275)

Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

- see: TCPDF::Cell()
- access: public

void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], [mixed $border = 0], [int $ln = 0], [int $fill = 0], [boolean $reseth = false])

- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell minimum height. The cell extends automatically if needed.
- float $x: upper-left corner X coordinate
- float $y: upper-left corner Y coordinate
- string $html: html text to print. Default value: empty string.
- mixed $border: Indicates if borders must be drawn around the cell. The value can be either 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
- int $ln: Indicates where the current position should go after the call. Possible values are:
  - 0: to the right (or left for RTL language)
  - 1: to the beginning of the next line
  - 2: below
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- boolean $reseth: if true reset the last cell height (default false).

_addfield (line 6632)

- access: private

void _addfield ( $type, $name, $x, $y, $w, $h, $prop)

- $type
- $name
- $x
- $y
- $w
- $h
- $prop

_begindoc (line 3052)

Start document

- access: protected

void _begindoc ()
_beginpage (line 3490)

_beginpage

- access: protected

void _beginpage ( $orientation)

- $orientation

_dochecks (line 3026)

Check for locale-related bug

- access: protected

void _dochecks ()
_dounderline (line 3555)

Underline text

- access: protected

void _dounderline (int $x, int $y, string $txt)

- int $x: X coordinate
- int $y: Y coordinate
- string $txt: text to underline

_enddoc (line 3451)

_enddoc

- access: protected

void _enddoc ()
_endpage (line 3534)

End of page contents

- access: protected

void _endpage ()
_escape (line 3741)

Add \ before \, ( and )

- return: escaped string.
- access: protected

string _escape (string $s)

- string $s: string to escape.

_escapetext (line 3727)

Format a text string

- return: escaped string.
- access: protected

string _escapetext (string $s)

- string $s: string to escape.

_freadint (line 3686)

Read a 4-byte integer from file

- return: integer
- access: protected

4-byte _freadint (string $f)

- string $f: file name.

_generateencryptionkey (line 4974)

Compute encryption key

- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: protected

void _generateencryptionkey (String $user_pass, String $owner_pass, String $protection)

- String $user_pass: user password
- String $owner_pass: user password
- String $protection: protection type

_getfontpath (line 3041)

Return fonts path

- access: protected

void _getfontpath ()
_JScolor (line 6608)

- access: private

void _JScolor ( $color)

- $color

_md5_16 (line 4938)

Encrypts a string using MD5 and returns it's value as a binary string.

- return: MD5 encrypted binary string
- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: protected

String _md5_16 (string $str)

- string $str: input string

_newobj (line 3542)

Begin a new object

- access: protected

void _newobj ()
_objectkey (line 4873)

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

- since: 2.0.000 (2008-01-02)
- access: protected

void _objectkey (int $n)

- int $n: object number

_out (line 3765)

Output a string to the document.

- access: protected

void _out (string $s)

- string $s: string to output.

_outCurve (line 5460)

- access: protected

void _outCurve ( $x1, $y1, $x2, $y2, $x3, $y3)

- $x1
- $y1
- $x2
- $y2
- $x3
- $y3

_outLine (line 5424)

- access: protected

void _outLine ( $x, $y)

- $x
- $y

_outPoint (line 5410)

- access: protected

void _outPoint ( $x, $y)

- $x
- $y

_outRect (line 5441)

Draws a rectangle.

- since: 2.1.000 (2008-01-08)
- access: protected

void _outRect (float $x, float $y, float $w, float $h, string $op)

- float $x: Abscissa of upper-left corner (or upper-right corner for RTL language).
- float $y: Ordinate of upper-left corner (or upper-right corner for RTL language).
- float $w: Width.
- float $h: Height.
- string $op: options

_Ovalue (line 4950)

Compute O value (used for RC4 encryption)

- return: O value
- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: protected

String _Ovalue (String $user_pass, String $owner_pass)

- String $user_pass: user password
- String $owner_pass: user password

_parsegif (line 3588)

Extract info from a GIF file

- access: protected

void _parsegif ( $file)

- $file

_parsejpg (line 3572)

Extract info from a JPEG file

- access: protected

void _parsejpg ( $file)

- $file

_parsepng (line 3605)

Extract info from a PNG file

- access: protected

void _parsepng ( $file)

- $file

_putbookmarks (line 6509)

- access: private

void _putbookmarks ()
_putcatalog (line 3389)

_putcatalog

- access: protected

void _putcatalog ()
_putencryption (line 4881)

Put encryption on PDF document

- since: 2.0.000 (2008-01-02)
- access: protected

void _putencryption ()
_putfonts (line 3135)

Adds fonts

_putfonts

- access: protected

void _putfonts ()
_putheader (line 3443)

_putheader

- access: protected

void _putheader ()
_putimages (line 3253)

_putimages

- access: protected

void _putimages ()
_putinfo (line 3364)

_putinfo

Adds some meta information

- access: protected

void _putinfo ()
_putjavascript (line 6583)

- access: private

void _putjavascript ()
_putpages (line 3062)

_putpages

- access: protected

void _putpages ()
_putresourcedict (line 3320)

_putresourcedict

- access: protected

void _putresourcedict ()
_putresources (line 3336)

_putresources

- access: protected

void _putresources ()
_putstream (line 3751)

Output a stream.

- access: protected

void _putstream (string $s)

- string $s: string to output.

_puttrailer (line 3429)

_puttrailer

- access: protected

void _puttrailer ()
_puttruetypeunicode (line 3781)

Adds unicode fonts.

Based on PDF Reference 1.3 (section 5)

- author: Nicola Asuni
- since: 1.52.0.TC005 (2005-01-05)
- access: protected

void _puttruetypeunicode ( $font)

- $font

_putxobjectdict (line 3310)

_putxobjectdict

- access: protected

void _putxobjectdict ()
_RC4 (line 4899)

Returns the input text exrypted using RC4 algorithm and the specified key.

RC4 is the standard encryption algorithm used in PDF format

- return: encrypted text
- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: protected

String _RC4 (string $key, String $text)

- string $key: encryption key
- String $text: input text to be encrypted

_textstring (line 3697)

Format a text string for meta information

- return: escaped string.
- access: protected

string _textstring (string $s)

- string $s: string to escape.

_uristring (line 3714)

Format an URI string

- return: escaped string.
- access: protected

string _uristring (string $s)

- string $s: string to escape.

_Uvalue (line 4962)

Compute U value (used for RC4 encryption)

- return: U value
- author: Klemen Vodopivec
- since: 2.0.000 (2008-01-02)
- access: protected

String _Uvalue ()

Documentation generated on Tue, 12 Feb 2008 12:36:39 +0100 by phpDocumentor 1.4.0