Docs For Class FPDF

Class FPDF

Description

Located in /engine/tcms_kernel/html2pdf/fpdf.php (line 19)

Direct descendents

Class	Description
HTML2FPDF

Variable Summary

mixed $AliasNbPages

mixed $author

mixed $AutoPageBreak

mixed $bMargin

mixed $buffer

mixed $cMargin

mixed $ColorFlag

mixed $compress

mixed $CoreFonts

mixed $creator

mixed $CurOrientation

mixed $CurrentFont

mixed $DefOrientation

mixed $diffs

mixed $DisplayPreferences

mixed $DrawColor

mixed $fh

mixed $fhPt

mixed $FillColor

mixed $flowingBlockAttr

mixed $FontFamily

mixed $FontFiles

mixed $fonts

mixed $FontSize

mixed $FontSizePt

mixed $FontStyle

mixed $fw

mixed $fwPt

mixed $h

mixed $hPt

mixed $images

mixed $InFooter

mixed $k

mixed $keywords

mixed $lasth

mixed $LayoutMode

mixed $LineWidth

mixed $links

mixed $lMargin

mixed $n

mixed $offsets

mixed $OrientationChanges

mixed $OutlineRoot

mixed $outlines

mixed $page

mixed $PageBreakTrigger

mixed $PageLinks

mixed $pages

mixed $rMargin

mixed $state

mixed $subject

mixed $TextColor

mixed $title

mixed $tMargin

mixed $underline

mixed $w

mixed $wPt

mixed $ws

mixed $x

mixed $y

mixed $ZoomMode

Method Summary

FPDF FPDF ([ $orientation = 'P'], [ $unit = 'mm'], [ $format = 'A4'])

void AcceptPageBreak ()

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

void AddLink ()

void AddPage ([ $orientation = ''])

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

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

void Cell ( $w, [ $h = 0], [ $txt = ''], [ $border = 0], [ $ln = 0], [ $align = ''], [ $fill = 0], [ $link = ''], [ $currentx = 0])

void Circle ( $x, $y, $r, [ $style = ''])

void Close ()

void DisplayPreferences ( $preferences)

void DottedRect ([ $x = 100], [ $y = 150], [ $w = 50], [ $h = 50])

void DrawDot ( $x, $y)

void Ellipse ( $x, $y, $rx, $ry, [ $style = 'D'])

void Error ( $msg)

void finishFlowingBlock ([ $outofblock = false])

void Footer ()

void GetStringWidth ( $s)

void GetX ()

void GetY ()

void Header ()

void Image ( $file, $x, $y, [ $w = 0], [ $h = 0], [ $type = ''], [ $link = ''], [ $paint = true])

void Line ( $x1, $y1, $x2, $y2)

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

void Ln ([ $h = ''])

void MultiCell ( $w, $h, $txt, [ $border = 0], [ $align = 'J'], [ $fill = 0], [ $link = ''])

void newFlowingBlock ( $w, $h, [ $b = 0], [ $a = 'J'], [ $f = 0], [ $is_table = false])

void Open ()

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

void PageNo ()

void Rect ( $x, $y, $w, $h, [ $style = ''])

void restoreFont ( $saved)

void saveFont ()

void SetAuthor ( $author)

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

void SetCompression ( $compress)

void SetCreator ( $creator)

void SetDash ([ $black = false], [ $white = false])

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

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

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

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

void SetFontSize ( $size)

void SetKeywords ( $keywords)

void SetLeftMargin ( $margin)

void SetLineWidth ( $width)

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

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

void SetRightMargin ( $margin)

void SetSubject ( $subject)

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

void SetTextOutline (mixed $width, [int $r = 0], [int $g = -1], [int $b = -1])

void SetTitle ( $title)

void SetTopMargin ( $margin)

void SetX ( $x)

void SetXY ( $x, $y)

void SetY ( $y)

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

void WordWrap ( &$text, $maxwidth)

void Write ( $h, $txt, [ $currentx = 0], [ $link = ''])

void WriteFlowingBlock ( $s, [ $outofblock = false])

void _begindoc ()

void _beginpage ( $orientation)

void _dochecks ()

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

void _enddoc ()

void _endpage ()

void _escape ( $s)

void _freadint ( $f)

void _newobj ()

void _out ( $s)

void _parsegif ( $file)

void _parsejpg ( $file)

void _parsepng ( $file)

void _putbookmarks ()

void _putcatalog ()

void _putfonts ()

void _putimages ()

void _putinfo ()

void _putpages ()

void _putresources ()

void _putstream ( $s)

void _puttrailer ()

void _SetTextRendering (int $mode)

void _textstring ( $s)

Variables

mixed $AliasNbPages (line 77)

mixed $author (line 74)

mixed $AutoPageBreak (line 67)

mixed $bMargin (line 44)

mixed $buffer (line 29)

mixed $cMargin (line 45)

mixed $ColorFlag (line 65)

mixed $compress (line 32)

mixed $CoreFonts (line 49)

mixed $creator (line 76)

mixed $CurOrientation (line 34)

mixed $CurrentFont (line 59)

mixed $DefOrientation (line 33)

mixed $diffs (line 52)

mixed $DisplayPreferences = '' (line 22)

mixed $DrawColor (line 62)

mixed $fh (line 38)

mixed $fhPt (line 37)

mixed $FillColor (line 63)

mixed $flowingBlockAttr (line 25)

mixed $FontFamily (line 56)

mixed $FontFiles (line 51)

mixed $fonts (line 50)

mixed $FontSize (line 61)

mixed $FontSizePt (line 60)

mixed $FontStyle (line 57)

mixed $fw (line 38)

mixed $fwPt (line 37)

mixed $h (line 40)

mixed $hPt (line 39)

mixed $images (line 53)

mixed $InFooter (line 69)

mixed $k (line 36)

mixed $keywords (line 75)

mixed $lasth (line 47)

mixed $LayoutMode (line 71)

mixed $LineWidth (line 48)

mixed $links (line 55)

mixed $lMargin (line 41)

mixed $n (line 27)

mixed $offsets (line 28)

mixed $OrientationChanges (line 35)

mixed $OutlineRoot (line 24)

mixed $outlines = array() (line 23)

mixed $page (line 26)

mixed $PageBreakTrigger (line 68)

mixed $PageLinks (line 54)

mixed $pages (line 30)

mixed $rMargin (line 43)

mixed $state (line 31)

mixed $subject (line 73)

mixed $TextColor (line 64)

mixed $title (line 72)

mixed $tMargin (line 42)

mixed $underline (line 58)

mixed $w (line 40)

mixed $wPt (line 39)

mixed $ws (line 66)

mixed $x (line 46)

mixed $y (line 46)

mixed $ZoomMode (line 70)

Methods

Constructor FPDF (line 84)

*****************************************************************************

***************************************************************************** * Public methods * ******************************************************************************

FPDF FPDF ([ $orientation = 'P'], [ $unit = 'mm'], [ $format = 'A4'])

$orientation
$unit
$format

AcceptPageBreak (line 566)

void AcceptPageBreak ()

AddFont (line 430)

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

$family
$style
$file

AddLink (line 535)

void AddLink ()

AddPage (line 294)

void AddPage ([ $orientation = ''])

$orientation

AliasNbPages (line 261)

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

$alias

Bookmark (line 1524)

void Bookmark ( $txt, $level, $y)

$txt
$level
$y

Cell (line 572)

void Cell ( $w, $h, [ $txt = ''], $border, $ln, [ $align = ''], $fill, [ $link = ''], $currentx)

$w
$h
$txt
$border
$ln
$align
$fill
$link
$currentx

Circle (line 1324)

void Circle ( $x, $y, $r, [ $style = ''])

$x
$y
$r
$style

Close (line 279)

void Close ()

DisplayPreferences (line 1530)

void DisplayPreferences ( $preferences)

$preferences

DottedRect (line 1438)

void DottedRect ([ $x = 100], [ $y = 150], [ $w = 50], [ $h = 50])

DrawDot (line 1484)

void DrawDot ( $x, $y)

Ellipse (line 1331)

void Ellipse ( $x, $y, $rx, $ry, [ $style = 'D'])

$x
$y
$rx
$ry
$style

Error (line 267)

void Error ( $msg)

$msg

finishFlowingBlock (line 918)

void finishFlowingBlock ([ $outofblock = false])

$outofblock

Footer (line 361)

void Footer ()

Redefined in descendants as:

HTML2FPDF::Footer()

GetStringWidth (line 397)

void GetStringWidth ( $s)

GetX (line 1602)

void GetX ()

GetY (line 1615)

void GetY ()

Header (line 356)

void Header ()

Redefined in descendants as:

HTML2FPDF::Header()

Image (line 1360)

void Image ( $file, $x, $y, $w, $h, [ $type = ''], [ $link = ''], [ $paint = true])

$file
$x
$y
$w
$h
$type
$link
$paint

Line (line 415)

void Line ( $x1, $y1, $x2, $y2)

Link (line 551)

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

$x
$y
$w
$h
$link

Ln (line 1594)

void Ln ([ $h = ''])

MultiCell (line 667)

void MultiCell ( $w, $h, $txt, $border, [ $align = 'J'], $fill, [ $link = ''])

$w
$h
$txt
$border
$align
$fill
$link

newFlowingBlock (line 901)

void newFlowingBlock ( $w, $h, $b, [ $a = 'J'], $f, [ $is_table = false])

$w
$h
$b
$a
$f
$is_table

Open (line 273)

void Open ()

Output (line 1638)

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

$name
$dest

PageNo (line 366)

void PageNo ()

Rect (line 421)

void Rect ( $x, $y, $w, $h, [ $style = ''])

$x
$y
$w
$h
$style

restoreFont (line 878)

void restoreFont ( $saved)

$saved

saveFont (line 856)

void saveFont ()

SetAuthor (line 243)

void SetAuthor ( $author)

$author

SetAutoPageBreak (line 203)

void SetAutoPageBreak ( $auto, $margin)

$auto
$margin

SetCompression (line 224)

void SetCompression ( $compress)

$compress

SetCreator (line 255)

void SetCreator ( $creator)

$creator

SetDash (line 1517)

void SetDash ([ $black = false], [ $white = false])

$black
$white

SetDisplayMode (line 211)

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

$zoom
$layout

SetDrawColor (line 372)

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

SetFillColor (line 380)

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

SetFont (line 469)

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

$family
$style
$size

SetFontSize (line 525)

void SetFontSize ( $size)

$size

SetKeywords (line 249)

void SetKeywords ( $keywords)

$keywords

SetLeftMargin (line 184)

void SetLeftMargin ( $margin)

$margin

SetLineWidth (line 408)

void SetLineWidth ( $width)

$width

SetLink (line 543)

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

$link
$y
$page

SetMargins (line 175)

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

$left
$top
$right

SetRightMargin (line 197)

void SetRightMargin ( $margin)

$margin

SetSubject (line 237)

void SetSubject ( $subject)

$subject

SetTextColor (line 389)

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

SetTextOutline (line 1304)

Set Text Ouline On/Off

see: FPDF::_SetTextRendering()

void SetTextOutline (mixed $width, int $r, [int $g = -1], [int $b = -1])

mixed $width: If set to false the text rending mode is set to fill, else it's the width of the outline
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)

SetTitle (line 231)

void SetTitle ( $title)

$title

SetTopMargin (line 191)

void SetTopMargin ( $margin)

$margin

SetX (line 1608)

void SetX ( $x)

SetXY (line 1631)

void SetXY ( $x, $y)

SetY (line 1621)

void SetY ( $y)

Text (line 557)

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

$x
$y
$txt

WordWrap (line 1232)

void WordWrap ( &$text, $maxwidth)

&$text
$maxwidth

Write (line 771)

void Write ( $h, $txt, $currentx, [ $link = ''])

$h
$txt
$currentx
$link

WriteFlowingBlock (line 1018)

void WriteFlowingBlock ( $s, [ $outofblock = false])

$s
$outofblock

_begindoc (line 1716)

void _begindoc ()

_beginpage (line 2055)

void _beginpage ( $orientation)

$orientation

_dochecks (line 1706)

*****************************************************************************

***************************************************************************** * Protected methods * ******************************************************************************

void _dochecks ()

_dounderline (line 2108)

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

$x
$y
$txt

_enddoc (line 2021)

void _enddoc ()

_endpage (line 2094)

void _endpage ()

_escape (line 2278)

void _escape ( $s)

_freadint (line 2262)

void _freadint ( $f)

_newobj (line 2100)

void _newobj ()

_out (line 2291)

void _out ( $s)

_parsegif (line 2209)

void _parsegif ( $file)

$file

_parsejpg (line 2117)

void _parsejpg ( $file)

$file

_parsepng (line 2141)

void _parsepng ( $file)

$file

_putbookmarks (line 1535)

void _putbookmarks ()

_putcatalog (line 1983)

void _putcatalog ()

_putfonts (line 1794)

void _putfonts ()

_putimages (line 1896)

void _putimages ()

_putinfo (line 1967)

void _putinfo ()

_putpages (line 1723)

void _putpages ()

_putresources (lin