Support Joomla!

Packages

Package: com-tecnick-tcpdf

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class TCPDF

Description

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

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

Located in /tcpdf/tcpdf.php (line 113)

Class TCPDF
Variable Summary
Variable author $author
Variable automatic $AutoPageBreak
Variable page $bMargin
Variable buffer $buffer
Variable cell $cMargin
Variable indicates $ColorFlag
Variable compression $compress
Variable array $CoreFonts
Variable creator $creator
Variable current $CurOrientation
Variable current $CurrentFont
Variable default $DefOrientation
Variable array $diffs
Variable commands $DrawColor
Variable height $fh
Variable height $fhPt
Variable commands $FillColor
Variable current $FontFamily
Variable array $FontFiles
Variable array $fonts
Variable current $FontSize
Variable current $FontSizePt
Variable current $FontStyle
Variable width $fw
Variable width $fwPt
Variable current $h
Variable current $hPt
Variable array $images
Variable image $imgscale
Variable right-bottom $img_rb_x
Variable right-bottom $img_rb_y
Variable flag $InFooter
Variable boolean $isunicode
Variable scale $k
Variable keywords $keywords
Variable height $lasth
Variable layout $LayoutMode
Variable line $LineWidth
Variable array $links
Variable left $lMargin
Variable current $n
Variable array $offsets
Variable current $page
Variable threshold $PageBreakTrigger
Variable array $PageLinks
Variable array $pages
Variable right $rMargin
Variable current $state
Variable subject $subject
Variable commands $TextColor
Variable title $title
Variable top $tMargin
Variable underlining $underline
Variable current $w
Variable current $wPt
Variable word $ws
Variable current $x
Variable current $y
Variable zoom $ZoomMode
Method Summary
Constructor TCPDF TCPDF ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
Method boolean AcceptPageBreak ()
Method void AddFont (string $family, [string $style = ''], [string $file = ''])
Method void addHtmlLink (string $url, string $name, [int $fill = 0])
Method void AddLink ()
Method void AddPage ([string $orientation = ''])
Method void AliasNbPages ([string $alias = '{nb}'])
Method string arrUTF8ToUTF16BE (array $unicode, [boolean $setbom = true])
Method void Bookmark ( $txt, [ $level = 0], [ $y = -1])
Method void Button ( $name,  $w,  $h,  $caption,  $action, [ $prop = array()])
Method 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])
Method void CheckBox ( $name,  $w, [ $checked = false], [ $prop = array()])
Method 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:)
Method void Close ()
Method void ComboBox ( $name,  $w,  $h,  $values, [ $prop = array()])
Method 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()])
Method 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:)
Method void Error (string $msg)
Method void Footer ()
Method float GetAbsX ()
Method int GetArrStringWidth ( $sa, string $arr)
Method int GetCharWidth (string $char)
Method float getImageScale ()
Method int GetLineWidth ()
Method int GetNumChars (string $s)
Method int getNumPages ()
Method int getPage ()
Method int getPageHeight ()
Method int getPageWidth ()
Method void getPDFData ()
Method int GetStringWidth (string $s)
Method float GetX ()
Method float GetY ()
Method void Header ()
Method void Image (string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''], [string $align = ''])
Method void IncludeJS ( $script)
Method void lastPage ()
Method void Line (float $x1, float $y1, float $x2, float $y2, [array $style = array()])
Method void Link (float $x, float $y, float $w, float $h, mixed $link)
Method void ListBox ( $name,  $w,  $h,  $values, [ $prop = array()])
Method void Ln ([float $h = ''])
Method void MirrorH ([int $x = ''])
Method void MirrorL ([float $angle = 0], [int $x = ''], [int $y = ''])
Method void MirrorP ([int $x = ''], [int $y = ''])
Method void MirrorV ([int $y = ''])
Method 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])
Method void Open ()
Method void Output ([string $name = ''], [string $dest = ''])
Method array outputjpg (string $filename)
Method int PageNo ()
Method void Polygon (array $p, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
Method void RadioButton ( $name,  $w, [ $prop = array()])
Method void Rect (float $x, float $y, float $w, float $h, [string $style = ''], [array $border_style = array()], [array $fill_color = array()])
Method 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:)
Method void Rotate (float $angle, [int $x = ''], [int $y = ''])
Method 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()])
Method void Scale (float $s_x, float $s_y, [int $x = ''], [int $y = ''])
Method void ScaleX (float $s_x, [int $x = ''], [int $y = ''])
Method void ScaleXY (float $s, [int $x = ''], [int $y = ''])
Method void ScaleY (float $s_y, [int $x = ''], [int $y = ''])
Method void SetAuthor (string $author)
Method void SetAutoPageBreak (boolean $auto, [float $margin = 0])
Method void setBarcode ([string $bc = ""])
Method void SetCellPadding (float $pad)
Method void SetCompression (boolean $compress)
Method void SetCreator (string $creator)
Method void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])
Method void SetDrawColor (int $r, [int $g = -1], [int $b = -1])
Method void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
Method void SetFont (string $family, [string $style = ''], [float $size = 0])
Method void SetFontSize (float $size)
Method void setFooterFont (array $font)
Method void setFooterMargin ([int $fm = 10])
Method void setHeaderData ([string $ln = ""], [string $lw = 0], [string $ht = ""], [string $hs = ""])
Method void setHeaderFont (array $font)
Method void setHeaderMargin ([int $hm = 10])
Method void setImageScale (float $scale)
Method void SetKeywords (string $keywords)
Method void setLanguageArray (array $language)
Method void setLastH (float $h)
Method void SetLeftMargin (float $margin)
Method void SetLineStyle (array $style)
Method void SetLineWidth (float $width)
Method void SetLink (int $link, [float $y = 0], [int $page = -1])
Method void SetMargins (float $left, float $top, [float $right = -1])
Method void setPage (int $pnum)
Method void setPrintFooter ([ $val = true], boolean $value)
Method void setPrintHeader ([boolean $val = true])
Method void SetProtection ([Array $permissions = array()], [String $user_pass = ''], [String $owner_pass = null])
Method void SetRightMargin (float $margin)
Method void setRTL (Boolean $enable)
Method void SetSubject (string $subject)
Method void setTempRTL (mixed $mode)
Method void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
Method void SetTitle (string $title)
Method void SetTopMargin (float $margin)
Method void SetX (float $x)
Method void SetXY (float $x, float $y)
Method void SetY (float $y)
Method void Skew (float $angle_x, float $angle_y, [int $x = ''], [int $y = ''])
Method void SkewX (float $angle_x, [int $x = ''], [int $y = ''])
Method void SkewY (float $angle_y, [int $x = ''], [int $y = ''])
Method 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:)
Method void StartTransform ()
Method void StopTransform ()
Method void Text (float $x, float $y, string $txt)
Method void TextField ( $name,  $w,  $h, [ $prop = array()])
Method void toJPEG (string $file, image $image)
Method void Transform ( $tm)
Method void Translate (int $t_x, int $t_y)
Method void TranslateX (int $t_x)
Method void TranslateY (int $t_y)
Method string unhtmlentities ($text_to_convert $text_to_convert)
Method Returns unichr (int $c)
Method Return UTF8ArrSubString (string $strarr, [int $start = ''], [int $end = ''])
Method string utf8Bidi (array $ta, [bool $forcertl = false])
Method array UTF8StringToArray (string $str)
Method string utf8StrRev (string $str, [ $setbom = false], [bool $forcertl = false])
Method string UTF8ToUTF16BE (string $str, [boolean $setbom = true])
Method int Write (float $h, string $txt, [mixed $link = ''], [int $fill = 0], [string $align = ''], [boolean $ln = false], [int $stretch = 0])
Method void writeBarcode (int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)
Method void writeHTML (string $html, [boolean $ln = true], [int $fill = 0], [boolean $reseth = false], [boolean $cell = false])
Method void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], [mixed $border = 0], [int $ln = 0], [int $fill = 0], [boolean $reseth = true])
Method void _addfield ( $type,  $name,  $x,  $y,  $w,  $h,  $prop)
Method void _begindoc ()
Method void _beginpage ( $orientation)
Method void _dochecks ()
Method void _dounderline (int $x, int $y, string $txt)
Method void _enddoc ()
Method void _endpage ()
Method string _escape (string $s)
Method string _escapetext (string $s)
Method 4-byte _freadint (string $f)
Method void _generateencryptionkey (String $user_pass, String $owner_pass, String $protection)
Method void _getfontpath ()
Method void _JScolor ( $color)
Method string _legacyparsejpg (string $file)
Method string _legacyparsepng (string $file)
Method String _md5_16 (string $str)
Method void _newobj ()
Method void _objectkey (int $n)
Method void _out (string $s)
Method void _outCurve ( $x1,  $y1,  $x2,  $y2,  $x3,  $y3)
Method void _outLine ( $x,  $y)
Method void _outPoint ( $x,  $y)
Method void _outRect (float $x, float $y, float $w, float $h, string $op)
Method String _Ovalue (String $user_pass, String $owner_pass)
Method string _parsegif (string $file)
Method string _parsejpg (string $file)
Method string _parsepng (string $file)
Method void _putbookmarks ()
Method void _putcatalog ()
Method void _putencryption ()
Method void _putfonts ()
Method void _putheader ()
Method void _putimages ()
Method void _putinfo ()
Method void _putjavascript ()
Method void _putpages ()
Method void _putresources ()
Method void _putstream (string $s)
Method void _puttrailer ()
Method void _puttruetypeunicode ( $font)
Method void _putxobjectdict ()
Method String _RC4 (string $key, String $text)
Method string _textstring (string $s)
Method string _uristring (string $s)
Method String _Uvalue ()
Variables
alias $AliasNbPages (line 457)
  • var: for total number of pages
  • access: protected
author $author (line 439)
  • access: protected
automatic $AutoPageBreak (line 397)
  • var: page breaking
  • access: protected
page $bMargin (line 253)
  • var: break margin
  • access: protected
buffer $buffer (line 139)
  • var: holding in-memory PDF
  • access: protected
cell $cMargin (line 259)
  • var: internal padding
  • access: protected
indicates $ColorFlag (line 385)
  • var: whether fill and text colors are different
  • access: protected
compression $compress (line 157)
  • var: flag
  • access: protected
array $CoreFonts (line 289)
  • var: of standard font names
  • access: protected
creator $creator (line 451)
  • access: protected
current $CurOrientation (line 169)
  • var: page orientation (P = Portrait, L = Landscape)
  • access: protected
current $CurrentFont (line 349)
  • var: font info
  • access: protected
default $DefOrientation (line 163)
  • var: page orientation (P = Portrait, L = Landscape)
  • access: protected
array $diffs (line 307)
  • var: of encoding differences
  • access: protected
commands $DrawColor (line 367)
  • var: for drawing color
  • access: protected
height $fh (line 205)
  • var: of page format in user unit
  • access: protected
height $fhPt (line 193)
  • var: of page format in points
  • access: protected
commands $FillColor (line 373)
  • var: for filling color
  • access: protected
current $FontFamily (line 331)
  • var: font family
  • access: protected
array $FontFiles (line 301)
  • var: of font files
  • access: protected
array $fonts (line 295)
  • var: of used fonts
  • access: protected
current $FontSize (line 361)
  • var: font size in user unit
  • access: protected
current $FontSizePt (line 355)
  • var: font size in points
  • access: protected
current $FontStyle (line 337)
  • var: font style
  • access: protected
width $fw (line 199)
  • var: of page format in user unit
  • access: protected
width $fwPt (line 187)
  • var: of page format in points
  • access: protected
current $h (line 229)
  • var: height of page in user unit
  • access: protected
current $hPt (line 217)
  • var: height of page in points
  • access: protected
array $images (line 313)
  • var: of used images
  • access: protected
image $imgscale = 1 (line 481)
  • var: scale factor
  • access: protected
  • author: Nicola Asuni
  • since: 2004-06-14
right-bottom $img_rb_x (line 465)
  • var: corner X coordinate of inserted image
  • access: protected
  • author: Nicola Asuni
  • since: 2002-07-31
right-bottom $img_rb_y (line 473)
  • var: corner Y coordinate of inserted image
  • access: protected
  • author: Nicola Asuni
  • since: 2002-07-31
flag $InFooter (line 409)
  • var: set when processing footer
  • access: protected
boolean $isunicode = false (line 489)
  • var: set to true when the input text is unicode (require unicode fonts)
  • access: protected
  • author: Nicola Asuni
  • since: 2005-01-02
scale $k (line 181)
  • var: factor (number of points in user unit)
  • access: protected
keywords $keywords (line 445)
  • access: protected
height $lasth (line 277)
  • var: of last cell printed
  • access: protected
layout $LayoutMode (line 421)
  • var: display mode
  • access: protected
line $LineWidth (line 283)
  • var: width in user unit
  • access: protected
array $links (line 325)
  • var: of internal links
  • access: protected
left $lMargin (line 235)
  • var: margin
  • access: protected
current $n (line 127)
  • var: object number
  • access: protected
array $offsets (line 133)
  • var: of object offsets
  • access: protected
array $OrientationChanges (line 175)
  • var: indicating page orientation changes
  • access: protected
current $page (line 121)
  • var: page number
  • access: protected
threshold $PageBreakTrigger (line 403)
  • var: used to trigger page breaks
  • access: protected
array $PageLinks (line 319)
  • var: of links in pages
  • access: protected
array $pages (line 145)
  • var: containing pages
  • access: protected
PDF $PDFVersion = "1.5" (line 496)
  • var: version
  • access: protected
  • since: 1.5.3
right $rMargin (line 247)
  • var: margin
  • access: protected
current $state (line 151)
  • var: document state
  • access: protected
subject $subject (line 433)
  • access: protected
commands $TextColor (line 379)
  • var: for text color
  • access: protected
title $title (line 427)
  • access: protected
top $tMargin (line 241)
  • var: margin
  • access: protected
underlining $underline (line 343)
  • var: flag
  • access: protected
current $w (line 223)
  • var: width of page in user unit
  • access: protected
current $wPt (line 211)
  • var: width of page in points
  • access: protected
word $ws (line 391)
  • var: spacing
  • access: protected
current $x (line 265)
  • var: horizontal position in user unit for cell positioning
  • access: protected
current $y (line 271)
  • var: vertical position in user unit for cell positioning
  • access: protected
zoom $ZoomMode (line 415)
  • var: display mode
  • access: protected
Methods
Constructor TCPDF (line 859)

This is the class constructor.

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

  • since: 1.0
TCPDF TCPDF ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
  • string $orientation: page orientation. Possible values are (case insensitive):
    • P or Portrait (default)
    • L or Landscape
  • string $unit: User measure unit. Possible values are:
    • pt: point
    • mm: millimeter (default)
    • cm: centimeter
    • in: inch

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

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

boolean AcceptPageBreak ()
AddFont (line 1878)

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

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

Output anchor link.

  • access: public
void addHtmlLink (string $url, string $name, int $fill)
  • string $url: link URL
  • string $name: link name
  • int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
AddLink (line 2094)

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

void AddLink ()
AddPage (line 1447)

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.

void AddPage ([string $orientation = ''])
  • string $orientation: Page orientation. Possible values are (case insensitive):
    • P or Portrait
    • L or Landscape
    The default value is the one passed to the constructor.
AliasNbPages (line 1347)

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

void AliasNbPages ([string $alias = '{nb}'])
  • string $alias: The alias. Default value: {nb}.
arrUTF8ToUTF16BE (line 4291)

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

string arrUTF8ToUTF16BE (array $unicode, [boolean $setbom = true])
  • array $unicode: array containing UTF-8 unicode values
  • boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)
Bookmark (line 6715)
void Bookmark ( $txt,  $level, [ $y = -1])
  • $txt
  • $level
  • $y
Button (line 6969)
void Button ( $name,  $w,  $h,  $caption,  $action, [ $prop = array()])
  • $name
  • $w
  • $h
  • $caption
  • $action
  • $prop
Cell (line 2228)

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.

void Cell (float $w, float $h, [string $txt = ''], mixed $border, int $ln, [string $align = ''], int $fill, [mixed $link = ''], int $stretch)
  • float $w: Cell width. If 0, the cell extends up to the right margin.
  • float $h: Cell height. Default value: 0.
  • string $txt: String to print. Default value: empty string.
  • mixed $border: Indicates if borders must be drawn around the cell. The value can be either a number:
    • 0: no border (default)
    • 1: frame
    or a string containing some or all of the following characters (in any order):
    • L: left
    • T: top
    • R: right
    • B: bottom
  • int $ln: Indicates where the current position should go after the call. Possible values are:
    • 0: to the right (or left for RTL languages)
    • 1: to the beginning of the next line
    • 2: below
  • string $align: Allows to center or align the text. Possible values are:
    • L or empty string: left align (default value)
    • C: center
    • R: right align
    • J: justify
  • int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
  • mixed $link: URL or identifier returned by AddLink().
  • int $stretch: stretch carachter mode:
    • 0 = disabled
    • 1 = horizontal scaling only if necessary
    • 2 = forced horizontal scaling
    • 3 = character spacing only if necessary
    • 4 = forced character spacing
CheckBox (line 6949)
void CheckBox ( $name,  $w, [ $checked = false], [ $prop = array()])
  • $name
  • $w
  • $checked
  • $prop
Circle (line 5953)

Draws a circle.

A circle is formed from n Bezier curves.

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

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.

void Close ()
ComboBox (line 6930)
void ComboBox ( $name,  $w,  $h,  $values, [ $prop = array()])
  • $name
  • $w
  • $h
  • $values
  • $prop
Curve (line 5806)

Draws a Bezier curve.

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

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

Draws an ellipse.

An ellipse is formed from n Bezier curves.

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

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

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

  • since: 1.0
void Error (string $msg)
  • string $msg: The error message
Footer (line 1654)

This method is used to render the page footer.

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

void Footer ()
GetAbsX (line 2954)

Returns the absolute X value of current position.

float GetAbsX ()
GetArrStringWidth (line 1819)

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

  • return: string length
  • since: 2.4.000 (2008-03-06)
  • author: Nicola Asuni
int GetArrStringWidth ( $sa, string $arr)
  • string $arr: The array of chars whose total length is to be computed
  • $sa
getBreakMargin (line 1136)

Returns the page break margin.

  • return: page break margin.
  • since: 1.5.2
  • author: Nicola Asuni
int getBreakMargin ()
GetCharWidth (line 1834)

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

  • return: char width
  • since: 2.4.000 (2008-03-06)
  • author: Nicola Asuni
int GetCharWidth (string $char)
  • string $char: The char whose length is to be returned
getImageScale (line 1106)

Returns the image scale.

  • return: image scale.
  • since: 1.5.2
  • author: Nicola Asuni
float getImageScale ()
GetLineWidth (line 5538)

Returns the current the line width.

int GetLineWidth ()
GetNumChars (line 1856)

Returns the numbero of characters in a string.

  • return: number of characters
  • since: 2.0.0001 (2008-01-07)
int GetNumChars (string $s)
  • string $s: The input string.
getNumPages (line 1435)

Get the total number of insered pages.

int getNumPages ()
getPage (line 1424)

Get current document page number.

int getPage ()
getPageHeight (line 1126)

Returns the page height in units.

  • return: page height.
  • since: 1.5.2
  • author: Nicola Asuni
int getPageHeight ()
getPageWidth (line 1116)

Returns the page width in units.

  • return: page width.
  • since: 1.5.2
  • author: Nicola Asuni
int getPageWidth ()
getPDFData (line 4431)

Returns the PDF data.

void getPDFData ()
getScaleFactor (line 1146)

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

  • return: scale factor.
  • since: 1.5.2
  • author: Nicola Asuni
int getScaleFactor ()
GetStringWidth (line 1808)

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

  • return: string length
  • since: 1.2
  • author: Nicola Asuni
int GetStringWidth (string $s)
  • string $s: The string whose length is to be computed
GetX (line 2939)

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.

float GetX ()
GetY (line 2964)

Returns the ordinate of the current position.

float GetY ()
Header (line 1572)

This method is used to render the page header.

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

void Header ()
Image (line 2801)

Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:

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

For JPEG, all flavors are allowed:

  • gray scales
  • true colors (24 bits)
  • CMYK (32 bits)
For PNG, are allowed:
  • gray scales on at most 8 bits (256 levels)
  • indexed colors
  • true colors (24 bits)
If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).
The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.

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

Reset pointer to the last document page.

void lastPage ()
Line (line 5687)

Draws a line between two points.

void Line (float $x1, float $y1, float $x2, float $y2, [array $style = array()])
  • float $x1: Abscissa of first point.
  • float $y1: Ordinate of first point.
  • float $x2: Abscissa of second point.
  • float $y2: Ordinate of second point.
  • array $style: Line style. Array like for SetLineStyle. Default value: default line style (empty array).
Link (line 2130)

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.

void Link (float $x, float $y, float $w, float $h, mixed $link)
  • float $x: Abscissa of the upper-left corner of the rectangle (or upper-right for RTL languages)
  • float $y: Ordinate of the upper-left corner of the rectangle (or upper-right for RTL languages)
  • float $w: Width of the rectangle
  • float $h: Height of the rectangle
  • mixed $link: URL or identifier returned by AddLink()
ListBox (line 6907)
void ListBox ( $name,  $w,  $h,  $values, [ $prop = array()])
  • $name
  • $w
  • $h
  • $values
  • $prop
Ln (line 2918)

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

void Ln ([float $h = ''])
  • float $h: The height of the break. By default, the value equals the height of the last printed cell.
MirrorH (line 5332)

Horizontal Mirroring.

void MirrorH ([int $x = ''])
  • int $x: abscissa of the point. Default is current x position
MirrorL (line 5365)

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

void MirrorL (float $angle, [int $x = ''], [int $y = ''])
  • float $angle: gradient angle of the straight line. Default is 0 (horizontal line).
  • int $x: abscissa of the point. Default is current x position
  • int $y: ordinate of the point. Default is current y position
MirrorP (line 5353)

Point reflection mirroring.

void MirrorP ([int $x = ''], [int $y = ''])
  • int $x: abscissa of the point. Default is current x position
  • int $y: ordinate of the point. Default is current y position
MirrorV (line 5342)

Verical Mirroring.

void MirrorV ([int $y = ''])
  • int $y: ordinate of the point. Default is current y position
MultiCell (line 2454)

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.

int MultiCell (float $w, float $h, string $txt, mixed $border, [string $align = 'J'], int $fill, [int $ln = 1], [int $x = ''], [int $y = ''], [boolean $reseth = true], int $stretch)
  • 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
Open (line 1369)

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

void Open ()
Output (line 3036)

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.

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

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

  • return: structure containing the image data
  • access: protected
array outputjpg (string $filename)
  • string $filename: JPEG file name.
PageNo (line 1724)

Returns the current page number.

int PageNo ()
Polygon (line 5976)

Draws a polygon.

  • since: 2.1.000 (2008-01-08)
  • access: public
void Polygon (array $p, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
  • array $p: Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
  • string $style: Style of rendering. Possible values are:
    • D or empty string: Draw (default).
    • F: Fill.
    • DF or FD: Draw and fill.
  • array $line_style: Line style of polygon. Array with keys among the following:
    • all: Line style of all lines. Array like for SetLineStyle.
    • 0 to ($np - 1): Line style of each line. Array like for SetLineStyle.
    If a key is not present or is null, not draws the line. Default value is default line style (empty array).
  • array $fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
RadioButton (line 6889)
void RadioButton ( $name,  $w, [ $prop = array()])
  • $name
  • $w
  • $prop
Rect (line 5719)

Draws a rectangle.

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

Draws a regular polygon.

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

Rotate object.

void Rotate (float $angle, [int $x = ''], [int $y = ''])
  • float $angle: angle in degrees for counter-clockwise rotation
  • int $x: abscissa of the rotation center. Default is current x position
  • int $y: ordinate of the rotation center. Default is current y position
RoundedRect (line 6163)

Draws a rounded rectangle.

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

Vertical and horizontal non-proportional Scaling.

void Scale (float $s_x, float $s_y, [int $x = ''], [int $y = ''])
  • float $s_x: scaling factor for width as percent. 0 is not allowed.
  • float $s_y: scaling factor for height as percent. 0 is not allowed.
  • int $x: abscissa of the scaling center. Default is current x position
  • int $y: ordinate of the scaling center. Default is current y position
ScaleX (line 5262)

Horizontal Scaling.

void ScaleX (float $s_x, [int $x = ''], [int $y = ''])
  • float $s_x: scaling factor for width as percent. 0 is not allowed.
  • int $x: abscissa of the scaling center. Default is current x position
  • int $y: ordinate of the scaling center. Default is current y position
ScaleXY (line 5286)

Vertical and horizontal proportional Scaling.

void ScaleXY (float $s, [int $x = ''], [int $y = ''])
  • float $s: scaling factor for width and height as percent. 0 is not allowed.
  • int $x: abscissa of the scaling center. Default is current x position
  • int $y: ordinate of the scaling center. Default is current y position
ScaleY (line 5274)

Vertical Scaling.

void ScaleY (float $s_y, [int $x = ''], [int $y = ''])
  • float $s_y: scaling factor for height as percent. 0 is not allowed.
  • int $x: abscissa of the scaling center. Default is current x position
  • int $y: ordinate of the scaling center. Default is current y position
SetAuthor (line 1299)

Defines the author of the document.

void SetAuthor (string $author)
  • string $author: The name of the author.
SetAutoPageBreak (line 1226)

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.

void SetAutoPageBreak (boolean $auto, float $margin)
  • boolean $auto: Boolean indicating if mode should be on or off.
  • float $margin: Distance from the bottom of the page.
setBarcode (line 4348)

Set document barcode.

void setBarcode ([string $bc = ""])
  • string $bc: barcode
SetCellPadding (line 1215)

Set the internal Cell padding.

void SetCellPadding (float $pad)
  • float $pad: internal padding.
SetCompression (line 1261)

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

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

  • since: 1.4
void SetCompression (boolean $compress)
  • boolean $compress: Boolean indicating if compression must be enabled.
SetCreator (line 1321)

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

void SetCreator (string $creator)
  • string $creator: The name of the creator.
SetDisplayMode (line 1239)

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

  • since: 1.2
void SetDisplayMode (mixed $zoom, [string $layout = 'continuous'])
  • mixed $zoom: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
    • fullpage: displays the entire page on screen
    • fullwidth: uses maximum width of window
    • real: uses real size (equivalent to 100% zoom)
    • default: uses viewer default mode
  • string $layout: The page layout. Possible values are:
    • single: displays one page at once
    • continuous: displays pages continuously (default)
    • two: displays two pages on two columns
    • default: uses viewer default mode
SetDrawColor (line 1737)

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.

void SetDrawColor (int $r, [int $g = -1], [int $b = -1])
  • int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
  • int $g: Green component (between 0 and 255)
  • int $b: Blue component (between 0 and 255)
SetFillColor (line 1759)

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.

void SetFillColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
  • int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
  • int $g: Green component (between 0 and 255)
  • int $b: Blue component (between 0 and 255)
  • boolean $storeprev: if true stores the RGB array on $prevFillColor variable.
SetFont (line 1977)

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.

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

Defines the size of the current font.

void SetFontSize (float $size)
  • float $size: The size (in points)
setFooterFont (line 4330)

Set footer font.

  • since: 1.1
void setFooterFont (array $font)
  • array $font: font
setFooterMargin (line 1548)

Set footer margin.

(minimum distance between footer and bottom page margin)

void setFooterMargin ([int $fm = 10])
  • int $fm: distance in millimeters
setHeaderData (line 1527)

Set header data.

void setHeaderData ([string $ln = ""], string $lw, [string $ht = ""], [string $hs = ""])
  • string $ln: header image logo
  • string $lw: header image logo width in mm
  • string $ht: string to print as title on document header
  • string $hs: string to print on document header
setHeaderFont (line 4321)

Set header font.

  • since: 1.1
void setHeaderFont (array $font)
  • array $font: font
setHeaderMargin (line 1539)

Set header margin.

(minimum distance between header and top page margin)

void setHeaderMargin ([int $hm = 10])
  • int $hm: distance in millimeters
setImageScale (line 1096)

Set the image scale.

  • since: 1.5.2
  • author: Nicola Asuni
void setImageScale (float $scale)
  • float $scale: image scale.
SetKeywords (line 1310)

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

void SetKeywords (string $keywords)
  • string $keywords: The list of keywords.
setLanguageArray (line 4339)

Set language array.

  • since: 1.1
void setLanguageArray (array $language)
  • array $language
setLastH (line 1086)

Set the last cell height.

  • since: 1.53.0.TC034
  • author: Nicola Asuni
void setLastH (float $h)
  • float $h: cell height.
SetLeftMargin (line 1174)

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.

void SetLeftMargin (float $margin)
  • float $margin: The margin.
SetLineStyle (line 5564)

Set line style.

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

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.

void SetLineWidth (float $width)
  • float $width: The width.
SetLink (line 2109)

Defines the page and position a link points to

void SetLink (int $link, float $y, [int $page = -1])
  • int $link: The link identifier returned by AddLink()
  • float $y: Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
  • int $page: Number of target page; -1 indicates the current page. This is the default value
SetMargins (line 1158)

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

void SetMargins (float $left, float $top, [float $right = -1])
  • float $left: Left margin.
  • float $top: Top margin.
  • float $right: Right margin. Default value is the left one.
setPage (line 1412)

Move pointer to the apecified document page.

void setPage (int $pnum)
  • int $pnum: page number
setPrintFooter (line 1564)

Set a flag to print page footer.

void setPrintFooter ([ $val = true], boolean $value)
  • boolean $value: set to true to print the page footer (default), false otherwise.
  • $val
setPrintHeader (line 1556)

Set a flag to print page header.

void setPrintHeader ([boolean $val = true])
  • boolean $val: set to true to print the page header (default), false otherwise.
SetProtection (line 5212)

Set document protection

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

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

  • author: Klemen Vodopivec
  • since: 2.0.000 (2008-01-02)
void SetProtection ([Array $permissions = array()], [String $user_pass = ''], [String $owner_pass = null])
  • Array $permissions: the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms)
  • String $user_pass: user password. Empty by default.
  • String $owner_pass: owner password. If not specified, a random value is used.
SetRightMargin (line 1202)

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

void SetRightMargin (float $margin)
  • float $margin: The margin.
setRTL (line 1060)

Enable or disable Right-To-Left language mode

  • since: 2.0.000 (2008-01-03)
void setRTL (Boolean $enable)
  • Boolean $enable: if true enable Right-To-Left language mode.
SetSubject (line 1288)

Defines the subject of the document.

void SetSubject (string $subject)
  • string $subject: The subject.
setTempRTL (line 1070)

Force temporary RTL language direction

  • since: 2.1.000 (2008-01-09)
void setTempRTL (mixed $mode)
  • mixed $mode: can be false, 'L' for LTR or 'R' for RTL
SetTextColor (line 1786)

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.

void SetTextColor (int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
  • int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
  • int $g: Green component (between 0 and 255)
  • int $b: Blue component (between 0 and 255)
  • boolean $storeprev: if true stores the RGB array on $prevTextColor variable.
SetTitle (line 1277)

Defines the title of the document.

void SetTitle (string $title)
  • string $title: The title.
SetTopMargin (line 1188)

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

void SetTopMargin (float $margin)
  • float $margin: The margin.
SetX (line 2976)

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

void SetX (float $x)
  • float $x: The value of the abscissa.
SetXY (line 3022)

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.

void SetXY (float $x, float $y)
  • float $x: The value of the abscissa
  • float $y: The value of the ordinate
SetY (line 3000)

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.

void SetY (float $y)
  • float $y: The value of the ordinate.
Skew (line 5477)

Skew.

void Skew (float $angle_x, float $angle_y, [int $x = ''], [int $y = ''])
  • float $angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
  • float $angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
  • int $x: abscissa of the skewing center. default is current x position
  • int $y: ordinate of the skewing center. default is current y position
SkewX (line 5452)

Skew horizontally.

void SkewX (float $angle_x, [int $x = ''], [int $y = ''])
  • float $angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
  • int $x: abscissa of the skewing center. default is current x position
  • int $y: ordinate of the skewing center. default is current y position
SkewY (line 5464)

Skew vertically.

void SkewY (float $angle_y, [int $x = ''], [int $y = ''])
  • float $angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
  • int $x: abscissa of the skewing center. default is current x position
  • int $y: ordinate of the skewing center. default is current y position
StarPolygon (line 6116)

Draws a star polygon

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

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.

void StartTransform ()
StopTransform (line 5251)

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.

void StopTransform ()
Text (line 2142)

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.

void Text (float $x, float $y, string $txt)
  • float $x: Abscissa of the origin
  • float $y: Ordinate of the origin
  • string $txt: String to print
TextField (line 6876)
void TextField ( $name,  $w,  $h, [ $prop = array()])
  • $name
  • $w
  • $h
  • $prop
toJPEG (line 3876)

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

  • access: protected
void toJPEG (string $file, image $image)
  • string $file: Image file name.
  • image $image: Image object. return image JPEG image object.
Transform (line 5508)

Apply graphic transformations.

void Transform ( $tm)
  • $tm
Translate (line 5397)

Translate graphic object horizontally and vertically.

void Translate (int $t_x, int $t_y)
  • int $t_x: movement to the right
  • int $t_y: movement to the bottom
TranslateX (line 5376)

Translate graphic object horizontally.

void TranslateX (int $t_x)
  • int $t_x: movement to the right
TranslateY (line 5386)

Translate graphic object vertically.

void TranslateY (int $t_y)
  • int $t_y: movement to the bottom
unhtmlentities (line 5065)

Reverse function for htmlentities.

Convert entities in UTF-8.

  • return: converted
string unhtmlentities ($text_to_convert $text_to_convert)
  • $text_to_convert $text_to_convert: Text to convert.
unichr (line 2761)

Returns the unicode caracter specified by UTF-8 code

  • return: the specified character.
  • since: 2.3.000 (2008-03-05)
  • author: Miguel Perez, Nicola Asuni
Returns unichr (int $c)
  • int $c: UTF-8 code
UTF8ArrSubString (line 2740)

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

  • return: part of a string
Return UTF8ArrSubString (string $strarr, [int $start = ''], [int $end = ''])
  • string $strarr: The input array of characters.
  • int $start: the starting element of $strarr.
  • int $end: first element that will not be returned.
utf8Bidi (line 6252)

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

  • since: 2.4.000 (2008-03-06)
  • author: Nicola Asuni
string utf8Bidi (array $ta, [bool $forcertl = false])
  • array $ta: array of characters composing the string.
  • bool $forcertl: if 'R' forces RTL, if 'L' forces LTR
UTF8StringToArray (line 4165)

Converts UTF-8 strings to codepoints array.

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

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

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

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

  • return: containing codepoints (UTF-8 characters values)
  • since: 1.53.0.TC005 (2005-01-05)
  • author: Nicola Asuni
  • access: protected
array UTF8StringToArray (string $str)
  • string $str: string to process.
utf8StrRev (line 6240)

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

  • since: 2.1.000 (2008-01-08)
  • author: Nicola Asuni
string utf8StrRev (string $str, [ $setbom = false], [bool $forcertl = false])
  • string $str: string to manipulate.
  • bool $forcertl: if 'R' forces RTL, if 'L' forces LTR
  • $setbom
UTF8ToUTF16BE (line 4245)

Converts UTF-8 strings to UTF16-BE.

string UTF8ToUTF16BE (string $str, [boolean $setbom = true])
  • string $str: string to process.
  • boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)
Write (line 2566)

This method prints text from the current position.

  • return: Rerurn the number of lines.
  • since: 1.5
int Write (float $h, string $txt, [mixed $link = ''], int $fill, [string $align = ''], [boolean $ln = false], int $stretch)
  • 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
writeBarcode (line 4364)

Print Barcode.

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

Allows to preserve some HTML formatting.

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

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

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.

void writeHTMLCell (float $w, float $h, float $x, float $y, [string $html = ''], mixed $border, int $ln, int $fill, [boolean $reseth = true])
  • 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).
_addfield (line 6851)
void _addfield ( $type,  $name,  $x,  $y,  $w,  $h,  $prop)
  • $type
  • $name
  • $x
  • $y
  • $w
  • $h
  • $prop
_begindoc (line 3144)

Start document

  • access: protected
void _begindoc ()
_beginpage (line 3582)

_beginpage

  • access: protected
void _beginpage ( $orientation)
  • $orientation
_dochecks (line 3118)

Check for locale-related bug

  • access: protected
void _dochecks ()
_dounderline (line 3647)

Underline text

  • access: protected
void _dounderline (int $x, int $y, string $txt)
  • int $x: X coordinate
  • int $y: Y coordinate
  • string $txt: text to underline
_enddoc (line 3543)

_enddoc

  • access: protected
void _enddoc ()
_endpage (line 3626)

End of page contents

  • access: protected
void _endpage ()
_escape (line 3985)

Add \ before \, ( and )

  • return: escaped string.
  • access: protected
string _escape (string $s)
  • string $s: string to escape.
_escapetext (line 3971)

Format a text string

  • return: escaped string.
  • access: protected
string _escapetext (string $s)
  • string $s: string to escape.
_freadint (line 3930)

Read a 4-byte integer from file

  • return: integer
  • access: protected
4-byte _freadint (string $f)
  • string $f: file name.
_generateencryptionkey (line 5181)

Compute encryption key

  • author: Klemen Vodopivec
  • since: 2.0.000 (2008-01-02)
void _generateencryptionkey (String $user_pass, String $owner_pass, String $protection)
  • String $user_pass: user password
  • String $owner_pass: user password
  • String $protection: protection type
_getfontpath (line 3133)

Return fonts path

  • access: protected
void _getfontpath ()
_JScolor (line 6827)
void _JScolor ( $color)
  • $color
_legacyparsejpg (line 3742)

Extract info from a JPEG file without using GD

  • access: protected
string _legacyparsejpg (string $file)
  • string $file: image file to parse
_legacyparsepng (line 3776)

Extract info from a PNG file without using GD

  • access: protected
string _legacyparsepng (string $file)
  • string $file: image file to parse
_md5_16 (line 5145)

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

  • return: MD5 encrypted binary string
  • author: Klemen Vodopivec
  • since: 2.0.000 (2008-01-02)
String _md5_16 (string $str)
  • string $str: input string
_newobj (line 3634)

Begin a new object

  • access: protected
void _newobj ()
_objectkey (line 5080)

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

  • since: 2.0.000 (2008-01-02)
void _objectkey (int $n)
  • int $n: object number
_out (line 4009)

Output a string to the document.

  • access: protected
void _out (string $s)
  • string $s: string to output.
_outCurve (line 5667)
void _outCurve ( $x1,  $y1,  $x2,  $y2,  $x3,  $y3)
  • $x1
  • $y1
  • $x2
  • $y2
  • $x3
  • $y3
_outLine (line 5631)
void _outLine ( $x,  $y)
  • $x
  • $y
_outPoint (line 5617)
void _outPoint ( $x,  $y)
  • $x
  • $y
_outRect (line 5648)

Draws a rectangle.

  • since: 2.1.000 (2008-01-08)
  • access: protected
void _outRect (float $x, float $y, float $w, float $h, string $op)
  • float $x: Abscissa of upper-left corner (or upper-right corner for RTL language).
  • float $y: Ordinate of upper-left corner (or upper-right corner for RTL language).
  • float $w: Width.
  • float $h: Height.
  • string $op: options
_Ovalue (line 5157)

Compute O value (used for RC4 encryption)

  • return: O value
  • author: Klemen Vodopivec
  • since: 2.0.000 (2008-01-02)
String _Ovalue (String $user_pass, String $owner_pass)
  • String $user_pass: user password
  • String $owner_pass: user password
_parsegif (line 3689)

Extract info from a GIF file

  • access: protected
string _parsegif (string $file)
  • string $file: image file to parse
_parsejpg (line 3667)

Extract info from a JPEG file

  • access: protected
string _parsejpg (string $file)
  • string $file: image file to parse
_parsepng (line 3712)

Extract info from a PNG file

  • access: protected
string _parsepng (string $file)
  • string $file: image file to parse
_putbookmarks (line 6728)
void _putbookmarks ()
_putcatalog (line 3481)

_putcatalog

  • access: protected
void _putcatalog ()
_putencryption (line 5088)

Put encryption on PDF document

  • since: 2.0.000 (2008-01-02)
void _putencryption ()
_putfonts (line 3227)

Adds fonts

_putfonts

  • access: protected
void _putfonts ()
_putheader (line 3535)

_putheader

  • access: protected
void _putheader ()
_putimages (line 3345)

_putimages

  • access: protected
void _putimages ()
_putinfo (line 3456)

_putinfo

Adds some meta information

  • access: protected
void _putinfo ()
_putjavascript (line 6802)
void _putjavascript ()
_putpages (line 3154)

_putpages

  • access: protected
void _putpages ()
_putresourcedict (line 3412)

_putresourcedict

  • access: protected
void _putresourcedict ()
_putresources (line 3428)

_putresources

  • access: protected
void _putresources ()
_putstream (line 3995)

Output a stream.

  • access: protected
void _putstream (string $s)
  • string $s: string to output.
_puttrailer (line 3521)

_puttrailer

  • access: protected
void _puttrailer ()
_puttruetypeunicode (line 4025)

Adds unicode fonts.

Based on PDF Reference 1.3 (section 5)

  • since: 1.52.0.TC005 (2005-01-05)
  • author: Nicola Asuni
  • access: protected
void _puttruetypeunicode ( $font)
  • $font
_putxobjectdict (line 3402)

_putxobjectdict

  • access: protected
void _putxobjectdict ()
_RC4 (line 5106)

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

RC4 is the standard encryption algorithm used in PDF format

  • return: encrypted text
  • author: Klemen Vodopivec
  • since: 2.0.000 (2008-01-02)
String _RC4 (string $key, String $text)
  • string $key: encryption key
  • String $text: input text to be encrypted
_textstring (line 3941)

Format a text string for meta information

  • return: escaped string.
  • access: protected
string _textstring (string $s)
  • string $s: string to escape.
_uristring (line 3958)

Format an URI string

  • return: escaped string.
  • access: protected
string _uristring (string $s)
  • string $s: string to escape.
_Uvalue (line 5169)

Compute U value (used for RC4 encryption)

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

Documentation generated on Sat, 14 Nov 2009 11:21:38 +0000 by phpDocumentor 1.3.1