com-tecnick-tcpdf
[ class tree: com-tecnick-tcpdf ] [ index: com-tecnick-tcpdf ] [ all elements ]

Class: TCPDF

Source Location: /tcpdf_php4/tcpdf.php

Class Overview


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


Author(s):

  • Nicola Asuni

Version:

  • 3.0.010_PHP4

Variables

Methods



Class Details

[line 139]
This is a PHP 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




Tags:

author:  Nicola Asuni
version:  3.0.010_PHP4
link:  http://www.tcpdf.org
name:  TCPDF
license:  LGPL


[ Top ]


Class Variables

$AliasNbPages =

[line 497]



Tags:

var:  for total number of pages
access:  protected

Type:   alias


[ Top ]

$author =

[line 479]



Tags:

access:  protected

Type:   author


[ Top ]

$AutoPageBreak =

[line 437]



Tags:

var:  page breaking
access:  protected

Type:   automatic


[ Top ]

$b =

[line 724]



Tags:

var:  font style status.
access:  protected

Type:   Bold


[ Top ]

$barcode =  false

[line 589]



Tags:

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

Type:   Barcode


[ Top ]

$bgcolor =

[line 712]



Tags:

var:  PARSER: array of background colors
access:  protected

Type:   HTML


[ Top ]

$bgtag =

[line 889]

ID of html tags with bgcolor attribute



Tags:

since:  2.9.000 (2008-03-25)
access:  protected

Type:   mixed


[ Top ]

$bMargin =

[line 279]



Tags:

var:  break margin
access:  protected

Type:   page


[ Top ]

$buffer =

[line 165]



Tags:

var:  holding in-memory PDF
access:  protected

Type:   buffer


[ Top ]

$cMargin =

[line 285]



Tags:

var:  internal padding
access:  protected

Type:   cell


[ Top ]

$ColorFlag =

[line 425]



Tags:

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

Type:   indicates


[ Top ]

$compress =

[line 183]



Tags:

var:  flag
access:  protected

Type:   compression


[ Top ]

$CoreFonts =

[line 315]



Tags:

var:  of standard font names
access:  protected

Type:   array


[ Top ]

$creator =

[line 491]



Tags:

access:  protected

Type:   creator


[ Top ]

$CurOrientation =

[line 195]



Tags:

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

Type:   current


[ Top ]

$CurrentFont =

[line 389]



Tags:

var:  font info
access:  protected

Type:   current


[ Top ]

$currpagegroup =

[line 955]

Contains the alias of the current page group



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$d =

[line 743]



Tags:

var:  through font style status.
since:  2.8.000 (2008-03-19)
access:  protected

Type:   Line


[ Top ]

$default_table_columns =  4

[line 637]



Tags:

var:  number of columns for html table.
access:  protected

Type:   Default


[ Top ]

$DefOrientation =

[line 189]



Tags:

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

Type:   default


[ Top ]

$diffs =

[line 333]



Tags:

var:  of encoding differences
access:  protected

Type:   array


[ Top ]

$dpi =  72

[line 934]

Dot Per Inch Document Resolution (do not change)



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$DrawColor =

[line 407]



Tags:

var:  for drawing color
access:  protected

Type:   commands


[ Top ]

$encoding =  "UTF-8"

[line 756]



Tags:

var:  encoding
since:  1.53.0.TC010
access:  protected

Type:   default


[ Top ]

$encrypted =

[line 800]

Indicates whether document is protected



Tags:

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

Type:   mixed


[ Top ]

$enc_obj_id =

[line 828]

encryption object id



Tags:

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

Type:   mixed


[ Top ]

$extgstates =

[line 983]

Array of transparency objects and parameters.



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$fgcolor =

[line 664]



Tags:

var:  PARSER: array of foreground colors
access:  protected

Type:   HTML


[ Top ]

$fh =

[line 231]



Tags:

var:  of page format in user unit
access:  protected

Type:   height


[ Top ]

$fhPt =

[line 219]



Tags:

var:  of page format in points
access:  protected

Type:   height


[ Top ]

$FillColor =

[line 413]



Tags:

var:  for filling color
access:  protected

Type:   commands


[ Top ]

$FontAscent =

[line 370]



Tags:

var:  font ascent (distance between font top and baseline)
since:  2.8.000 (2007-03-29)
access:  protected

Type:   current


[ Top ]

$FontDescent =

[line 377]



Tags:

var:  font descent (distance between font bottom and baseline)
since:  2.8.000 (2007-03-29)
access:  protected

Type:   current


[ Top ]

$FontFamily =

[line 357]



Tags:

var:  font family
access:  protected

Type:   current


[ Top ]

$FontFiles =

[line 327]



Tags:

var:  of font files
access:  protected

Type:   array


[ Top ]

$fontList =

[line 652]



Tags:

var:  PARSER: store font list.
access:  protected

Type:   HTML


[ Top ]

$fonts =

[line 321]



Tags:

var:  of used fonts
access:  protected

Type:   array


[ Top ]

$FontSize =

[line 401]



Tags:

var:  font size in user unit
access:  protected

Type:   current


[ Top ]

$FontSizePt =

[line 395]



Tags:

var:  font size in points
access:  protected

Type:   current


[ Top ]

$FontStyle =

[line 363]



Tags:

var:  font style
access:  protected

Type:   current


[ Top ]

$footer_font =

[line 577]



Tags:

var:  font.
access:  protected

Type:   Footer


[ Top ]

$footer_margin =

[line 551]



Tags:

var:  distance between footer and bottom page margin.
access:  protected

Type:   Minimum


[ Top ]

$fw =

[line 225]



Tags:

var:  of page format in user unit
access:  protected

Type:   width


[ Top ]

$fwPt =

[line 213]



Tags:

var:  of page format in points
access:  protected

Type:   width


[ Top ]

$h =

[line 255]



Tags:

var:  height of page in user unit
access:  protected

Type:   current


[ Top ]

$header_font =

[line 571]



Tags:

var:  font.
access:  protected

Type:   Header


[ Top ]

$header_logo =  ""

[line 613]



Tags:

var:  image logo.
access:  protected

Type:   Header


[ Top ]

$header_logo_width =  30

[line 619]



Tags:

var:  image logo width in mm.
access:  protected

Type:   Header


[ Top ]

$header_margin =

[line 545]



Tags:

var:  distance between header and top page margin.
access:  protected

Type:   Minimum


[ Top ]

$header_string =  ""

[line 631]



Tags:

var:  to print on document header.
access:  protected

Type:   String


[ Top ]

$header_title =  ""

[line 625]



Tags:

var:  to print as title on document header.
access:  protected

Type:   String


[ Top ]

$header_width =  0

[line 607]



Tags:

var:  width (0 = full page width).
access:  protected

Type:   Header


[ Top ]

$hPt =

[line 243]



Tags:

var:  height of page in points
access:  protected

Type:   current


[ Top ]

$HREF =

[line 646]



Tags:

var:  PARSER: store current link.
access:  protected

Type:   HTML


[ Top ]

$i =

[line 736]



Tags:

var:  font style status.
access:  protected

Type:   Italic


[ Top ]

$images =

[line 339]



Tags:

var:  of used images
access:  protected

Type:   array


[ Top ]

$imgscale =  1

[line 521]



Tags:

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

Type:   image


[ Top ]

$img_rb_x =

[line 505]



Tags:

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

Type:   right-bottom


[ Top ]

$img_rb_y =

[line 513]



Tags:

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

Type:   right-bottom


[ Top ]

$InFooter =

[line 449]



Tags:

var:  set when processing footer
access:  protected

Type:   flag


[ Top ]

$internal_encoding =

[line 763]



Tags:

var:  internal encoding
since:  1.53.0.TC016
access:  protected

Type:   PHP


[ Top ]

$issetfont =

[line 658]



Tags:

var:  PARSER: true when font attribute is set.
access:  protected

Type:   HTML


[ Top ]

$isunicode =  false

[line 529]



Tags:

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

Type:   boolean


[ Top ]

$javascript =  ""

[line 868]

javascript code



Tags:

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

Type:   mixed


[ Top ]

$jpeg_quality =

[line 990]

Set the default JPEG compression quality (1-100)



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$k =

[line 207]



Tags:

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

Type:   scale


[ Top ]

$keywords =

[line 485]



Tags:

access:  protected

Type:   keywords


[ Top ]

$l =

[line 583]



Tags:

var:  templates.
access:  protected

Type:   Language


[ Top ]

$lasth =

[line 303]



Tags:

var:  of last cell printed
access:  protected

Type:   height


[ Top ]

$last_rc4_key =

[line 835]

last RC4 key encrypted (cached for optimisation)



Tags:

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

Type:   mixed


[ Top ]

$last_rc4_key_c =

[line 842]

last RC4 computed key



Tags:

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

Type:   mixed


[ Top ]

$LayoutMode =

[line 461]



Tags:

var:  display mode
access:  protected

Type:   layout


[ Top ]

$linethrough =

[line 882]

line trough state



Tags:

since:  2.8.000 (2008-03-19)
access:  protected

Type:   mixed


[ Top ]

$LineWidth =

[line 309]



Tags:

var:  width in user unit
access:  protected

Type:   line


[ Top ]

$links =

[line 351]



Tags:

var:  of internal links
access:  protected

Type:   array


[ Top ]

$lispacer =  ""

[line 749]



Tags:

var:  for LI tags.
access:  protected

Type:   spacer


[ Top ]

$listcount =  0

[line 676]



Tags:

var:  PARSER: count list items.
access:  protected

Type:   HTML


[ Top ]

$listordered =  false

[line 670]



Tags:

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

Type:   HTML


[ Top ]

$lMargin =

[line 261]



Tags:

var:  margin
access:  protected

Type:   left


[ Top ]

$n =

[line 153]



Tags:

var:  object number
access:  protected

Type:   current


[ Top ]

$newpagegroup =

[line 941]

Indicates whether a new page group was requested



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$n_js =

[line 875]

javascript counter



Tags:

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

Type:   mixed


[ Top ]

$n_ocg_print =

[line 969]

Print visibility.



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$n_ocg_view =

[line 976]

View visibility.



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$offsets =

[line 159]



Tags:

var:  of object offsets
access:  protected

Type:   array


[ Top ]

$OrientationChanges =

[line 201]



Tags:

var:  indicating page orientation changes
access:  protected

Type:   array


[ Top ]

$original_lMargin =

[line 558]



Tags:

var:  left margin value
since:  1.53.0.TC013
access:  protected

Type:   original


[ Top ]

$original_rMargin =

[line 565]



Tags:

var:  right margin value
since:  1.53.0.TC013
access:  protected

Type:   original


[ Top ]

$OutlineRoot =

[line 858]

Outline root for bookmark



Tags:

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

Type:   mixed


[ Top ]

$outlines = array()

[line 851]

Outlines for bookmark



Tags:

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

Type:   mixed


[ Top ]

$Ovalue =

[line 814]

O entry in pdf document



Tags:

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

Type:   mixed


[ Top ]

$page =

[line 147]



Tags:

var:  page number
access:  protected

Type:   current


[ Top ]

$PageBreakTrigger =

[line 443]



Tags:

var:  used to trigger page breaks
access:  protected

Type:   threshold


[ Top ]

$pagegroups =

[line 948]

Contains the number of pages of the groups



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$PageLinks =

[line 345]



Tags:

var:  of links in pages
access:  protected

Type:   array


[ Top ]

$pages =

[line 171]



Tags:

var:  containing pages
access:  protected

Type:   array


[ Top ]

$PDFVersion =  "1.5"

[line 536]



Tags:

var:  version
since:  1.5.3
access:  protected

Type:   PDF


[ Top ]

$prevFontFamily =

[line 770]



Tags:

var:  previous font family
since:  1.53.0.TC017
access:  protected

Type:   store


[ Top ]

$prevFontStyle =

[line 777]



Tags:

var:  previous font style
since:  1.53.0.TC017
access:  protected

Type:   store


[ Top ]

$print_footer =  true

[line 601]



Tags:

var:  true prints footer.
access:  protected

Type:   If


[ Top ]

$print_header =  true

[line 595]



Tags:

var:  true prints header
access:  protected

Type:   If


[ Top ]

$Pvalue =

[line 821]

P entry in pdf document



Tags:

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

Type:   mixed


[ Top ]

$rMargin =

[line 273]



Tags:

var:  margin
access:  protected

Type:   right


[ Top ]

$rtl =  false

[line 784]



Tags:

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

Type:   indicates


[ Top ]

$state =

[line 177]



Tags:

var:  document state
access:  protected

Type:   current


[ Top ]

$subject =

[line 473]



Tags:

access:  protected

Type:   subject


[ Top ]

$tableborder =  0

[line 682]



Tags:

var:  PARSER: size of table border.
access:  protected

Type:   HTML


[ Top ]

$tdalign =  "L"

[line 706]



Tags:

var:  PARSER: table align.
access:  protected

Type:   HTML


[ Top ]

$tdbegin =  false

[line 688]



Tags:

var:  PARSER: true at the beginning of table.
access:  protected

Type:   HTML


[ Top ]

$tdheight =  0

[line 700]



Tags:

var:  PARSER: table height.
access:  protected

Type:   HTML


[ Top ]

$tdwidth =  0

[line 694]



Tags:

var:  PARSER: table width.
access:  protected

Type:   HTML


[ Top ]

$tempfontsize =  10

[line 718]



Tags:

var:  temporary font size in points.
access:  protected

Type:   Store


[ Top ]

$TextColor =

[line 419]



Tags:

var:  for text color
access:  protected

Type:   commands


[ Top ]

$title =

[line 467]



Tags:

access:  protected

Type:   title


[ Top ]

$tMargin =

[line 267]



Tags:

var:  margin
access:  protected

Type:   top


[ Top ]

$tmprtl =  false

[line 791]



Tags:

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

Type:   used


[ Top ]

$u =

[line 730]



Tags:

var:  font style status.
access:  protected

Type:   Underlined


[ Top ]

$underline =

[line 383]



Tags:

var:  flag
access:  protected

Type:   underlining


[ Top ]

$ur =

[line 899]

If true enables user's rights on PDF reader



Tags:

since:  2.9.000 (2008-03-26)
access:  protected

Type:   mixed


[ Top ]

$ur_annots =

[line 913]

Names specifying additional annotation-related usage rights for the document.



Tags:

since:  2.9.000 (2008-03-26)
access:  protected

Type:   mixed


[ Top ]

$ur_document =

[line 906]

Names specifying additional document-wide usage rights for the document.



Tags:

since:  2.9.000 (2008-03-26)
access:  protected

Type:   mixed


[ Top ]

$ur_form =

[line 920]

Names specifying additional form-field-related usage rights for the document.



Tags:

since:  2.9.000 (2008-03-26)
access:  protected

Type:   mixed


[ Top ]

$ur_signature =

[line 927]

Names specifying additional signature-related usage rights for the document.



Tags:

since:  2.9.000 (2008-03-26)
access:  protected

Type:   mixed


[ Top ]

$Uvalue =

[line 807]

U entry in pdf document



Tags:

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

Type:   mixed


[ Top ]

$visibility = "all"

[line 962]

Restrict the rendering of some elements to screen or printout.



Tags:

since:  3.0.000 (2008-03-27)
access:  protected

Type:   mixed


[ Top ]

$w =

[line 249]



Tags:

var:  width of page in user unit
access:  protected

Type:   current


[ Top ]

$wPt =

[line 237]



Tags:

var:  width of page in points
access:  protected

Type:   current


[ Top ]

$ws =

[line 431]



Tags:

var:  spacing
access:  protected

Type:   word


[ Top ]

$x =

[line 291]



Tags:

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

Type:   current


[ Top ]

$y =

[line 297]



Tags:

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

Type:   current


[ Top ]

$ZoomMode =

[line 455]



Tags:

var:  display mode
access:  protected

Type:   zoom


[ Top ]



Class Methods


constructor TCPDF [line 1007]

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

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




Tags:

since:  1.0


Parameters:

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

[ Top ]

method AcceptPageBreak [line 2442]

boolean AcceptPageBreak( )

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;

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

 	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('vera','',12);
 for($i=1;$i<=300;$i++) {
     $pdf->Cell(0,5,"Line $i",0,1);
 }
 $pdf->Output();




Tags:

see:  TCPDF::SetAutoPageBreak()
since:  1.4


[ Top ]

method addExtGState [line 7510]

void addExtGState( $parms)



Parameters:

   $parms  

[ Top ]

method AddFont [line 2090]

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

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');




Tags:

see:  TCPDF::SetFont()
since:  1.5


Parameters:

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.

[ Top ]

method addHtmlLink [line 5255]

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

Output anchor link.



Tags:

access:  public


Parameters:

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.

[ Top ]

method AddLink [line 2316]

void 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.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().



Tags:



[ Top ]

method AddPage [line 1615]

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

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.




Tags:



Parameters:

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.

[ Top ]

method AliasNbPages [line 1515]

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

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


Example:

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




Tags:

see:  TCPDF::PageNo(), TCPDF::Footer()
since:  1.4


Parameters:

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

[ Top ]

method arrUTF8ToUTF16BE [line 4548]

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

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




Tags:

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


Parameters:

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

[ Top ]

method Bookmark [line 7082]

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



Parameters:

   $txt  
   $level  
   $y  

[ Top ]

method Button [line 7336]

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



Parameters:

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

[ Top ]

method Cell [line 2463]

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

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.



Tags:



Parameters:

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

[ Top ]

method CheckBox [line 7316]

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



Parameters:

   $name  
   $w  
   $checked  
   $prop  

[ Top ]

method Circle [line 6268]

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

Draws a circle.

A circle is formed from n Bezier curves.




Tags:

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


Parameters:

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  

[ Top ]

method Close [line 1547]

void Close( )

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



Tags:

see:  TCPDF::Open(), TCPDF::Output()
since:  1.0


[ Top ]

method closedHTMLTagHandler [line 5092]

void closedHTMLTagHandler( string $tag)

Process closing tags.



Tags:

access:  protected


Parameters:

string   $tag   tag name (in uppercase)

[ Top ]

method ComboBox [line 7297]

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



Parameters:

   $name  
   $w  
   $h  
   $values  
   $prop  

[ Top ]

method convertHTMLColorToDec [line 5273]

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

Returns an associative array (keys: R,G,B) from an html color name or a six-digit or three-digit hexadecimal color representation (i.e. #3FE5AA or #7FF).



Tags:

access:  protected


Parameters:

string   $color   html color

[ Top ]

method Curve [line 6070]

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

Draws a Bezier curve.

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




Tags:

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


Parameters:

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

[ Top ]

method Ellipse [line 6173]

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

Draws an ellipse.

An ellipse is formed from n Bezier curves.




Tags:

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


Parameters:

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  

[ Top ]

method Error [line 1526]

void Error( string $msg)

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




Tags:

since:  1.0


Parameters:

string   $msg   The error message

[ Top ]

method Footer [line 1839]

void Footer( )

This method is used to render the page footer.

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




[ Top ]

method GetAbsX [line 3414]

float GetAbsX( )

Returns the absolute X value of current position.



Tags:

see:  TCPDF::SetX(), TCPDF::GetY(), TCPDF::SetY()
since:  1.2


[ Top ]

method GetArrStringWidth [line 2031]

int GetArrStringWidth( $sa, string $arr)

Returns the string length of an array of chars in user unit. A font must be selected.




Tags:

return:  string length
author:  Nicola Asuni
since:  2.4.000 (2008-03-06)


Parameters:

string   $arr   The array of chars whose total length is to be computed
   $sa  

[ Top ]

method getBreakMargin [line 1304]

int getBreakMargin( )

Returns the page break margin.



Tags:

return:  page break margin.
author:  Nicola Asuni
since:  1.5.2


[ Top ]

method GetCharWidth [line 2046]

int GetCharWidth( string $char)

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




Tags:

return:  char width
author:  Nicola Asuni
since:  2.4.000 (2008-03-06)


Parameters:

string   $char   The char whose length is to be returned

[ Top ]

method getGroupPageNo [line 7441]

void getGroupPageNo( )



[ Top ]

method getImageScale [line 1274]

float getImageScale( )

Returns the image scale.



Tags:

return:  image scale.
author:  Nicola Asuni
since:  1.5.2


[ Top ]

method GetLineWidth [line 5802]

int GetLineWidth( )

Returns the current the line width.



Tags:

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


[ Top ]

method GetNumChars [line 2068]

int GetNumChars( string $s)

Returns the numbero of characters in a string.



Tags:

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


Parameters:

string   $s   The input string.

[ Top ]

method getNumPages [line 1603]

int getNumPages( )

Get the total number of insered pages.



Tags:

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


[ Top ]

method getPage [line 1592]

int getPage( )

Get current document page number.



Tags:

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


[ Top ]

method getPageGroupAlias [line 7452]

void getPageGroupAlias( )



[ Top ]

method getPageHeight [line 1294]

int getPageHeight( )

Returns the page height in units.



Tags:

return:  page height.
author:  Nicola Asuni
since:  1.5.2


[ Top ]

method getPageWidth [line 1284]

int getPageWidth( )

Returns the page width in units.



Tags:

return:  page width.
author:  Nicola Asuni
since:  1.5.2


[ Top ]

method getPDFData [line 4688]

void getPDFData( )

Returns the PDF data.



[ Top ]

method getRemainingWidth [line 3017]

int getRemainingWidth( )

Returns the remaining width between the current position and margins.



Tags:

return:  Return the remaining width
access:  protected


[ Top ]

method getScaleFactor [line 1314]

int getScaleFactor( )

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



Tags:

return:  scale factor.
author:  Nicola Asuni
since:  1.5.2


[ Top ]

method GetStringWidth [line 2020]

int GetStringWidth( string $s)

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




Tags:

return:  string length
author:  Nicola Asuni
since:  1.2


Parameters:

string   $s   The string whose length is to be computed

[ Top ]

method GetX [line 3399]

float GetX( )

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.




Tags:

see:  TCPDF::SetX(), TCPDF::GetY(), TCPDF::SetY()
since:  1.2


[ Top ]

method GetY [line 3424]

float GetY( )

Returns the ordinate of the current position.



Tags:

see:  TCPDF::SetY(), TCPDF::GetX(), TCPDF::SetX()
since:  1.0


[ Top ]

method Header [line 1755]

void Header( )

This method is used to render the page header.

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




[ Top ]

method Image [line 3098]

void Image( string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''], [string $align = ''], [boolean $resize = false], [int $dpi = 300])

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




Tags:

see:  TCPDF::AddLink()
since:  1.1


Parameters:

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): 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.
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
boolean   $resize   If true resize (reduce) the image to fit $w and $h (requires GD library).
int   $dpi   dot-per-inch resolution used on resize

[ Top ]

method IncludeJS [line 7159]

void IncludeJS( $script)



Parameters:

   $script  

[ Top ]

method lastPage [line 1570]

void lastPage( )

Reset pointer to the last document page.



Tags:

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


[ Top ]

method Line [line 5951]

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

Draws a line between two points.



Tags:

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


Parameters:

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

[ Top ]

method Link [line 2352]

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

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.



Tags:



Parameters:

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

[ Top ]

method ListBox [line 7274]

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



Parameters:

   $name  
   $w  
   $h  
   $values  
   $prop  

[ Top ]

method Ln [line 3378]

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

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



Tags:

see:  TCPDF::Cell()
since:  1.0


Parameters:

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

[ Top ]

method MirrorH [line 5596]

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

Horizontal Mirroring.



Tags:

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


Parameters:

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

[ Top ]

method MirrorL [line 5629]

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

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



Tags:

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


Parameters:

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

[ Top ]

method MirrorP [line 5617]

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

Point reflection mirroring.



Tags:

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


Parameters:

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

[ Top ]

method MirrorV [line 5606]

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

Verical Mirroring.



Tags:

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


Parameters:

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

[ Top ]

method MultiCell [line 2715]

int MultiCell( float $w, float $h, string $txt, [mixed $border = 0], [string $align = 'J'], [int $fill = 0], [int $ln = 1], [int $x = ''], [int $y = ''], [boolean $reseth = true], [int $stretch = 0], [boolean $ishtml = false])

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.



Tags:



Parameters:

float   $w   Width of cells. If 0, they extend up to the right margin of the page.
float   $h   Cell minimum height. The cell extends automatically if needed.
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
int   $x   x position in user units
int   $y   y position in user units
boolean   $reseth   if true reset the last cell height (default true).
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
boolean   $ishtml   se to true if $txt is HTML content (default = false).

[ Top ]

method Open [line 1537]

void Open( )

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




Tags:

see:  TCPDF::AddPage(), TCPDF::Close()
since:  1.0


[ Top ]

method openHTMLTagHandler [line 4812]

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

Process opening tags.



Tags:

access:  protected


Parameters:

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.

[ Top ]

method Output [line 3496]

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

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.



Tags:

see:  TCPDF::Close()
since:  1.0


Parameters:

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

[ Top ]

method PageNo [line 1911]

int PageNo( )

Returns the current page number.



Tags:

return:  page number
see:  TCPDF::AliasNbPages()
since:  1.0


[ Top ]

method pixelsToUnits [line 5318]

float pixelsToUnits( int $px)

Converts pixels to Units.



Tags:

return:  millimeters
access:  public


Parameters:

int   $px   pixels

[ Top ]

method Polycurve [line 6118]

void Polycurve( float $x0, float $y0, float $segments, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])

Draws a poly-Bezier curve.

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




Tags:

see:  TCPDF::SetLineStyle()
since:  3.0008 (2008-05-12)
access:  public


Parameters:

float   $x0   Abscissa of start point.
float   $y0   Ordinate of start point.
float   $segments   An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
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).

[ Top ]

method Polygon [line 6291]

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

Draws a polygon.



Tags:

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


Parameters:

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

[ Top ]

method RadioButton [line 7256]

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



Parameters:

   $name  
   $w  
   $prop  

[ Top ]

method Rect [line 5983]

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

Draws a rectangle.



Tags:

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


Parameters:

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

[ Top ]

method RegularPolygon [line 6380]

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

Draws a regular polygon.



Tags:

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


Parameters:

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  

[ Top ]

method Rotate [line 5684]

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

Rotate object.



Tags:

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


Parameters:

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

[ Top ]

method RoundedRect [line 6478]

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

Draws a rounded rectangle.



Tags:

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


Parameters:

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

[ Top ]

method Scale [line 5563]

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

Vertical and horizontal non-proportional Scaling.



Tags:

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


Parameters:

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

[ Top ]

method ScaleX [line 5526]

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

Horizontal Scaling.



Tags:

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


Parameters:

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

[ Top ]

method ScaleXY [line 5550]

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

Vertical and horizontal proportional Scaling.



Tags:

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


Parameters:

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

[ Top ]

method ScaleY [line 5538]

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

Vertical Scaling.



Tags:

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


Parameters:

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

[ Top ]

method setAlpha [line 7553]

void setAlpha( $alpha, [ $bm = 'Normal'])



Parameters:

   $alpha  
   $bm  

[ Top ]

method SetAuthor [line 1467]

void SetAuthor( string $author)

Defines the author of the document.



Tags:



Parameters:

string   $author   The name of the author.

[ Top ]

method SetAutoPageBreak [line 1394]

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

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.



Tags:



Parameters:

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

[ Top ]

method setBarcode [line 4605]

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

Set document barcode.



Parameters:

string   $bc   barcode

[ Top ]

method SetCellPadding [line 1383]

void SetCellPadding( float $pad)

Set the internal Cell padding.



Tags:



Parameters:

float   $pad   internal padding.

[ Top ]

method SetCompression [line 1429]

void SetCompression( boolean $compress)

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.




Tags:

since:  1.4


Parameters:

boolean   $compress   Boolean indicating if compression must be enabled.

[ Top ]

method SetCreator [line 1489]

void SetCreator( string $creator)

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



Tags:



Parameters:

string   $creator   The name of the creator.

[ Top ]

method SetDisplayMode [line 1407]

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

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.



Tags:

since:  1.2


Parameters:

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

[ Top ]

method SetDrawColor [line 1925]

void SetDrawColor( [int $col1 = 0], [int $col2 = -1], [int $col3 = -1], [int $col4 = -1])

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



Tags:



Parameters:

int   $col1   Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
int   $col2   Green color for RGB, or Magenta color for CMYK. Value between 0 and 255
int   $col3   Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255
int   $col4   Key (Black) color for CMYK. Value between 0 and 255

[ Top ]

method setExtGState [line 7522]

void setExtGState( $gs)



Parameters:

   $gs  

[ Top ]

method SetFillColor [line 1952]

void SetFillColor( [int $col1 = 0], [int $col2 = -1], [int $col3 = -1], [boolean $storeprev = false], [int $col4 = -1])

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



Tags:



Parameters:

int   $col1   Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
int   $col2   Green color for RGB, or Magenta color for CMYK. Value between 0 and 255
int   $col3   Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255
boolean   $storeprev   if true stores the current color on $bgcolor array.
int   $col4   Key (Black) color for CMYK. Value between 0 and 255

[ Top ]

method SetFont [line 2189]

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

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('vera','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.




Tags:

see:  TCPDF::AddFont(), TCPDF::SetFontSize()
since:  1.0


Parameters:

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
  • D: line trough
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

[ Top ]

method SetFontSize [line 2291]

void SetFontSize( float $size)

Defines the size of the current font.



Tags:

see:  TCPDF::SetFont()
since:  1.0


Parameters:

float   $size   The size (in points)

[ Top ]

method setFooterFont [line 4587]

void setFooterFont( array $font)

Set footer font.



Tags:

since:  1.1


Parameters:

array   $font   font

[ Top ]

method setFooterMargin [line 1731]

void setFooterMargin( [int $fm = 10])

Set footer margin.

(minimum distance between footer and bottom page margin)




Parameters:

int   $fm   distance in millimeters

[ Top ]

method setHeaderData [line 1710]

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

Set header data.



Parameters:

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

[ Top ]

method setHeaderFont [line 4578]

void setHeaderFont( array $font)

Set header font.



Tags:

since:  1.1


Parameters:

array   $font   font

[ Top ]

method setHeaderMargin [line 1722]

void setHeaderMargin( [int $hm = 10])

Set header margin.

(minimum distance between header and top page margin)




Parameters:

int   $hm   distance in millimeters

[ Top ]

method setImageScale [line 1264]

void setImageScale( float $scale)

Set the image scale.



Tags:

author:  Nicola Asuni
since:  1.5.2


Parameters:

float   $scale   image scale.

[ Top ]

method setJPEGQuality [line 7564]

void setJPEGQuality( $quality)



Parameters:

   $quality  

[ Top ]

method SetKeywords [line 1478]

void SetKeywords( string $keywords)

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



Tags:



Parameters:

string   $keywords   The list of keywords.

[ Top ]

method setLanguageArray [line 4596]

void setLanguageArray( array $language)

Set language array.



Tags:

since:  1.1


Parameters:

array   $language  

[ Top ]

method setLastH [line 1254]

void setLastH( float $h)

Set the last cell height.



Tags:

author:  Nicola Asuni
since:  1.53.0.TC034


Parameters:

float   $h   cell height.

[ Top ]

method SetLeftMargin [line 1342]

void SetLeftMargin( float $margin)

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.



Tags:



Parameters:

float   $margin   The margin.

[ Top ]

method SetLineStyle [line 5828]

void SetLineStyle( array $style)

Set line style.



Tags:

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


Parameters:

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

[ Top ]

method SetLineWidth [line 5788]

void SetLineWidth( float $width)

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.



Tags:



Parameters:

float   $width   The width.

[ Top ]

method SetLink [line 2331]

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

Defines the page and position a link points to



Tags:

see:  TCPDF::AddLink()
since:  1.5


Parameters:

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

[ Top ]

method SetMargins [line 1326]

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

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



Tags:



Parameters:

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

[ Top ]

method setPage [line 1580]

void setPage( int $pnum)

Move pointer to the apecified document page.



Tags:

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


Parameters:

int   $pnum   page number

[ Top ]

method setPrintFooter [line 1747]

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

Set a flag to print page footer.



Parameters:

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

[ Top ]

method setPrintHeader [line 1739]

void setPrintHeader( [boolean $val = true])

Set a flag to print page header.



Parameters:

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

[ Top ]

method SetProtection [line 5476]

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

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.




Tags:

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


Parameters:

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.

[ Top ]

method SetRightMargin [line 1370]

void SetRightMargin( float $margin)

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



Tags:



Parameters:

float   $margin   The margin.

[ Top ]

method setRTL [line 1228]

void setRTL( Boolean $enable)

Enable or disable Right-To-Left language mode



Tags:

since:  2.0.000 (2008-01-03)


Parameters:

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

[ Top ]

method setStyle [line 5236]

void setStyle( string $tag, boolean $enable)

Sets font style.



Tags:

access:  protected


Parameters:

string   $tag   tag name in lowercase. Supported tags are:
  • b : bold text
  • i : italic
  • u : underlined
  • lt : line-through
boolean   $enable  

[ Top ]

method SetSubject [line 1456]

void SetSubject( string $subject)

Defines the subject of the document.



Tags:



Parameters:

string   $subject   The subject.

[ Top ]

method setTempRTL [line 1238]

void setTempRTL( mixed $mode)

Force temporary RTL language direction



Tags:

since:  2.1.000 (2008-01-09)


Parameters:

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

[ Top ]

method SetTextColor [line 1989]

void SetTextColor( [int $col1 = 0], [int $col2 = -1], [int $col3 = -1], [boolean $storeprev = false], [int $col4 = -1])

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



Tags:



Parameters:

int   $col1   Gray level for single color, or Red color for RGB, or Cyan color for CMYK. Value between 0 and 255
int   $col2   Green color for RGB, or Magenta color for CMYK. Value between 0 and 255
int   $col3   Blue color for RGB, or Yellow color for CMYK. Value between 0 and 255
boolean   $storeprev   if true stores the current color on $fgcolor array.
int   $col4   Key (Black) color for CMYK. Value between 0 and 255

[ Top ]

method SetTitle [line 1445]

void SetTitle( string $title)

Defines the title of the document.



Tags:



Parameters:

string   $title   The title.

[ Top ]

method SetTopMargin [line 1356]

void SetTopMargin( float $margin)

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



Tags:



Parameters:

float   $margin   The margin.

[ Top ]

method setUserRights [line 7412]

void setUserRights( [ $enable = true], [ $document = "/FullSave"], [ $annots = "/Create/Delete/Modify/Copy/Import/Export"], [ $form = "/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate"], [ $signature = "/Modify"])



Parameters:

   $enable  
   $document  
   $annots  
   $form  
   $signature  

[ Top ]

method setVisibility [line 7482]

void setVisibility( $v)



Parameters:

   $v  

[ Top ]

method SetX [line 3436]

void SetX( float $x)

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




Tags:



Parameters:

float   $x   The value of the abscissa.

[ Top ]

method SetXY [line 3482]

void SetXY( float $x, float $y)

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.



Tags:

see:  TCPDF::SetX(), TCPDF::SetY()
since:  1.2


Parameters:

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

[ Top ]

method SetY [line 3460]

void SetY( float $y)

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.




Tags:



Parameters:

float   $y   The value of the ordinate.

[ Top ]

method Skew [line 5741]

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

Skew.



Tags:

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


Parameters:

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

[ Top ]

method SkewX [line 5716]

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

Skew horizontally.



Tags:

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


Parameters:

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

[ Top ]

method SkewY [line 5728]

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

Skew vertically.



Tags:

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


Parameters:

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

[ Top ]

method StarPolygon [line 6431]

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

Draws a star polygon



Tags:

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


Parameters:

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  

[ Top ]

method startPageGroup [line 7431]

void startPageGroup( )



[ Top ]

method StartTransform [line 5504]

void StartTransform( )

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.




Tags:

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


[ Top ]

method StopTransform [line 5515]

void StopTransform( )

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.




Tags:

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


[ Top ]

method Text [line 2366]

void Text( float $x, float $y, string $txt, [int $stroke = 0], [boolean $clip = false])

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.



Tags:



Parameters:

float   $x   Abscissa of the origin
float   $y   Ordinate of the origin
string   $txt   String to print
int   $stroke   outline size in points (0 = disable)
boolean   $clip   if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).

[ Top ]

method TextField [line 7243]

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



Parameters:

   $name  
   $w  
   $h  
   $prop  

[ Top ]

method Transform [line 5772]

void Transform( $tm)

Apply graphic transformations.



Tags:

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


Parameters:

   $tm  

[ Top ]

method Translate [line 5661]

void Translate( int $t_x, int $t_y)

Translate graphic object horizontally and vertically.



Tags:

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


Parameters:

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

[ Top ]

method TranslateX [line 5640]

void TranslateX( int $t_x)

Translate graphic object horizontally.



Tags:

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


Parameters:

int   $t_x   movement to the right

[ Top ]

method TranslateY [line 5650]

void TranslateY( int $t_y)

Translate graphic object vertically.



Tags:

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


Parameters:

int   $t_y   movement to the bottom

[ Top ]

method unhtmlentities [line 5329]

string unhtmlentities( $text_to_convert $text_to_convert)

Reverse function for htmlentities.

Convert entities in UTF-8.




Tags:

return:  converted


Parameters:

$text_to_convert   $text_to_convert   Text to convert.

[ Top ]

method unichr [line 3054]

Returns unichr( int $c)

Returns the unicode caracter specified by UTF-8 code



Tags:

return:  the specified character.
author:  Miguel Perez, Nicola Asuni
since:  2.3.000 (2008-03-05)


Parameters:

int   $c   UTF-8 code

[ Top ]

method UTF8ArrSubString [line 3033]

Return UTF8ArrSubString( string $strarr, [int $start = ''], [int $end = ''])

Extract a slice of the $strarr array and return it as string.



Tags:

return:  part of a string


Parameters:

string   $strarr   The input array of characters.
int   $start   the starting element of $strarr.
int   $end   first element that will not be returned.

[ Top ]

method utf8Bidi [line 6567]

string utf8Bidi( array $ta, [bool $forcertl = false])

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



Tags:

author:  Nicola Asuni
since:  2.4.000 (2008-03-06)


Parameters:

array   $ta   array of characters composing the string.
bool   $forcertl   if 'R' forces RTL, if 'L' forces LTR

[ Top ]

method UTF8StringToArray [line 4422]

array UTF8StringToArray( string $str)

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




Tags:

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


Parameters:

string   $str   string to process.

[ Top ]

method utf8StrRev [line 6555]

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

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



Tags:

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


Parameters:

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

[ Top ]

method UTF8ToUTF16BE [line 4502]

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

Converts UTF-8 strings to UTF16-BE.




Tags:

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


Parameters:

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

[ Top ]

method Write [line 2849]

int Write( float $h, string $txt, [mixed $link = ''], [int $fill = 0], [string $align = ''], [boolean $ln = false], [int $stretch = 0])

This method prints text from the current position.




Tags:

return:  Return the number of cells.
since:  1.5


Parameters:

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.
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
boolean   $ln   if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
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

[ Top ]

method writeBarcode [line 4621]

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

Print Barcode.



Parameters:

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

[ Top ]

method writeHTML [line 4706]

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

Allows to preserve some HTML formatting (limited support).


Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, small, span, strong, sub, sup, table, td, th, tr, u, ul,




Parameters:

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

[ Top ]

method writeHTMLCell [line 4801]

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

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.



Tags:

see:  Multicell(), TCPDF::writeHTML(), TCPDF::Cell()
uses:  TCPDF::MultiCell()


Parameters:

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

[ Top ]

method _addfield [line 7218]

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



Parameters:

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

[ Top ]

method _begindoc [line 3604]

void _begindoc( )

Start document



Tags:

access:  protected


[ Top ]

method _beginpage [line 4084]

void _beginpage( string $orientation)

Initialize a page.



Tags:

access:  protected


Parameters:

string   $orientation   page orientation. Possible values are (case insensitive):
  • P or Portrait (default)
  • L or Landscape

[ Top ]

method _datestring [line 3966]

string _datestring( string $s)

Format a date string for meta information



Tags:

return:  escaped string.
access:  protected


Parameters:

string   $s   date string to escape.

[ Top ]

method _dochecks [line 3578]

void _dochecks( )

Check for locale-related bug



Tags:

access:  protected


[ Top ]

method _dolinethrough [line 4174]

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

Line through text



Tags:

access:  protected


Parameters:

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

[ Top ]

method _dounderline [line 4160]

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

Underline text



Tags:

access:  protected


Parameters:

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

[ Top ]

method _enddoc [line 4044]

void _enddoc( )

End of document.



Tags:

access:  protected


[ Top ]

method _endpage [line 4138]

void _endpage( )

End of page contents



Tags:

access:  protected


[ Top ]

method _escape [line 4242]

string _escape( string $s)

Add \ before \, ( and )



Tags:

return:  escaped string.
access:  protected


Parameters:

string   $s   string to escape.

[ Top ]

method _escapetext [line 4228]

string _escapetext( string $s)

Format a text string



Tags:

return:  escaped string.
access:  protected


Parameters:

string   $s   string to escape.

[ Top ]

method _freadint [line 4187]

4-byte _freadint( string $f)

Read a 4-byte integer from file



Tags:

return:  integer
access:  protected


Parameters:

string   $f   file name.

[ Top ]

method _generateencryptionkey [line 5445]

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

Compute encryption key



Tags:

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


Parameters:

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

[ Top ]

method _getfontpath [line 3593]

void _getfontpath( )

Return fonts path



Tags:

access:  protected


[ Top ]

method _JScolor [line 7194]

void _JScolor( $color)



Parameters:

   $color  

[ Top ]

method _md5_16 [line 5409]

String _md5_16( string $str)

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



Tags:

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


Parameters:

string   $str   input string

[ Top ]

method _newobj [line 4147]

void _newobj( )

Begin a new object



Tags:

access:  protected


[ Top ]

method _objectkey [line 5344]

void _objectkey( int $n)

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



Tags:

since:  2.0.000 (2008-01-02)


Parameters:

int   $n   object number

[ Top ]

method _out [line 4266]

void _out( string $s)

Output a string to the document.



Tags:

access:  protected


Parameters:

string   $s   string to output.

[ Top ]

method _outCurve [line 5931]

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



Parameters:

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

[ Top ]

method _outLine [line 5895]

void _outLine( $x, $y)



Parameters:

   $x  
   $y  

[ Top ]

method _outPoint [line 5881]

void _outPoint( $x, $y)



Parameters:

   $x  
   $y  

[ Top ]

method _outRect [line 5912]

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

Draws a rectangle.



Tags:

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


Parameters:

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

[ Top ]

method _Ovalue [line 5421]

String _Ovalue( String $user_pass, String $owner_pass)

Compute O value (used for RC4 encryption)



Tags:

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


Parameters:

String   $user_pass   user password
String   $owner_pass   user password

[ Top ]

method _parsejpeg [line 3250]

array _parsejpeg( string $file)

Extract info from a JPEG file without using GD library



Tags:

return:  structure containing the image data
access:  protected


Parameters:

string   $file   image file to parse

[ Top ]

method _parsepng [line 3282]

array _parsepng( string $file)

Extract info from a PNG file without using GD



Tags:

return:  structure containing the image data
access:  protected


Parameters:

string   $file   image file to parse

[ Top ]

method _putbookmarks [line 7095]

void _putbookmarks( )



[ Top ]

method _putcatalog [line 3977]

void _putcatalog( )

_putcatalog



Tags:

access:  protected


[ Top ]

method _putencryption [line 5352]

void _putencryption( )

Put encryption on PDF document



Tags:

since:  2.0.000 (2008-01-02)


[ Top ]

method _putextgstates [line 7532]

void _putextgstates( )



[ Top ]

method _putfonts [line 3697]

void _putfonts( )

Adds fonts

_putfonts




Tags:

access:  protected


[ Top ]

method _putheader [line 4036]

void _putheader( )

_putheader



Tags:

access:  protected


[ Top ]

method _putimages [line 3815]

void _putimages( )

_putimages



Tags:

access:  protected


[ Top ]

method _putinfo [line 3937]

void _putinfo( )

Adds some Metadata information

(see Chapter 10.2 of PDF Reference)




Tags:

access:  protected


[ Top ]

method _putjavascript [line 7169]

void _putjavascript( )



[ Top ]

method _putocg [line 7461]

void _putocg( )



[ Top ]

method _putpages [line 3614]

void _putpages( )

Output pages.



Tags:

access:  protected


[ Top ]

method _putresourcedict [line 3882]

void _putresourcedict( )

Put Resources Dictionary.



Tags:

access:  protected


[ Top ]

method _putresources [line 3907]

void _putresources( )

Put Resources.



Tags:

access:  protected


[ Top ]

method _putstream [line 4252]

void _putstream( string $s)

Output a stream.



Tags:

access:  protected


Parameters:

string   $s   string to output.

[ Top ]

method _puttrailer [line 4022]

void _puttrailer( )

_puttrailer



Tags:

access:  protected


[ Top ]

method _puttruetypeunicode [line 4282]

void _puttruetypeunicode( $font)

Adds unicode fonts.


Based on PDF Reference 1.3 (section 5)




Tags:

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


Parameters:

   $font  

[ Top ]

method _putuserrights [line 7358]

void _putuserrights( )



[ Top ]

method _putxobjectdict [line 3872]

void _putxobjectdict( )

_putxobjectdict



Tags:

access:  protected


[ Top ]

method _RC4 [line 5370]

String _RC4( string $key, String $text)

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

RC4 is the standard encryption algorithm used in PDF format




Tags:

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


Parameters:

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

[ Top ]

method _textstring [line 4198]

string _textstring( string $s)

Format a text string for meta information



Tags:

return:  escaped string.
access:  protected


Parameters:

string   $s   string to escape.

[ Top ]

method _toJPEG [line 3234]

void _toJPEG( image $image, string $file)

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

This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.




Tags:

access:  protected


Parameters:

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

[ Top ]

method _uristring [line 4215]

string _uristring( string $s)

Format an URI string



Tags:

return:  escaped string.
access:  protected


Parameters:

string   $s   string to escape.

[ Top ]

method _Uvalue [line 5433]

String _Uvalue( )

Compute U value (used for RC4 encryption)



Tags:

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


[ Top ]


Documentation generated on Wed, 21 May 2008 11:59:06 +0200 by phpDocumentor 1.4.0