Docs For Class FPDF
FPDF
[ class tree: FPDF ]
[ index: FPDF ]
[ all elements ]
Packages:
tcexam
FPDF
Files:
fpdf.php
tce_pdf.php
Classes:
FPDF
TCE_PDF
Class: FPDF
Source Location: /shared/pdf/fpdf.php
Class Overview
FPDF is a PHP class which allows to generate PDF files with straight PHP,
Author(s):
Olivier PLATHEY, Nicola Asuni
Version:
1.53.0.TC004
Variables
$AliasNbPages
$author
$AutoPageBreak
$bMargin
$buffer
$cMargin
$ColorFlag
$compress
$CoreFonts
$creator
$CurOrientation
$CurrentFont
$DefOrientation
$diffs
$DrawColor
$fh
$fhPt
$FillColor
$FontFamily
$FontFiles
$fonts
$FontSize
$FontSizePt
$FontStyle
$fw
$fwPt
$h
$hPt
$images
$imgscale
$img_rb_x
$img_rb_y
$InFooter
$isunicode
$k
$keywords
$lasth
$LayoutMode
$LineWidth
$links
$lMargin
$n
$offsets
$OrientationChanges
$page
$PageBreakTrigger
$PageLinks
$pages
$PDFVersion
$rMargin
$state
$subject
$TextColor
$title
$tMargin
$underline
$w
$wPt
$ws
$x
$y
$ZoomMode
Methods
__construct
AcceptPageBreak
AddFont
AddLink
AddPage
AliasNbPages
Cell
Close
Error
Footer
getBreakMargin
getImageScale
getPageHeight
getPageWidth
getScaleFactor
GetStringWidth
GetX
GetY
Header
Image
Line
Link
Ln
MultiCell
Open
Output
PageNo
Rect
SetAuthor
SetAutoPageBreak
SetCompression
SetCreator
SetDisplayMode
SetDrawColor
SetFillColor
SetFont
SetFontSize
setImageScale
SetKeywords
SetLeftMargin
SetLineWidth
SetLink
SetMargins
SetRightMargin
SetSubject
SetTextColor
SetTitle
SetTopMargin
SetX
SetXY
SetY
Text
UTF8StringToArray
UTF8ToUTF16BE
Write
_begindoc
_beginpage
_dochecks
_dounderline
_enddoc
_endpage
_escape
_escapetext
_freadint
_getfontpath
_newobj
_out
_parsejpg
_parsepng
_putcatalog
_putfonts
_putheader
_putimages
_putinfo
_putpages
_putresourcedict
_putresources
_putstream
_puttrailer
_puttruetypeunicode
_putxobjectdict
_textstring
Child classes:
TCE_PDF
<p>This PHP Class extend the FPDF class by Olivier PLATHEY.
Class Details
[line 40]
FPDF is a PHP class which allows to generate PDF files with straight PHP,that is to say without using the PDFlib library. This version contains some changes: [porting to PHP5, support for UTF-8 Unicode, code style and formatting, php documentation (www.phpdoc.org), ISO page formats, minor improvements, image scale factor] Tools to encode your unicode fonts can be found at: http://www.acko.net/blog/ufpdf
Tags:
license: LGPL
author: Olivier PLATHEY, Nicola Asuni
version: 1.53.0.TC004
name: FPDF
[ Top ]
Class Variables
$AliasNbPages =
[line 383]
Tags:
var: for total number of pages
access: protected
Type:
alias
[ Top ]
$author =
[line 365]
Tags:
access: protected
Type:
author
[ Top ]
$AutoPageBreak =
[line 323]
Tags:
var: page breaking
access: protected
Type:
automatic
[ Top ]
$bMargin =
[line 179]
Tags:
var: break margin
access: protected
Type:
page
[ Top ]
$buffer =
[line 65]
Tags:
var: holding in-memory PDF
access: protected
Type:
buffer
[ Top ]
$cMargin =
[line 185]
Tags:
var: margin
access: protected
Type:
cell
[ Top ]
$ColorFlag =
[line 311]
Tags:
var: whether fill and text colors are different
access: protected
Type:
indicates
[ Top ]
$compress =
[line 83]
Tags:
var: flag
access: protected
Type:
compression
[ Top ]
$CoreFonts =
[line 215]
Tags:
var: of standard font names
access: protected
Type:
array
[ Top ]
$creator =
[line 377]
Tags:
access: protected
Type:
creator
[ Top ]
$CurOrientation =
[line 95]
Tags:
var: orientation
access: protected
Type:
current
[ Top ]
$CurrentFont =
[line 275]
Tags:
var: font info
access: protected
Type:
current
[ Top ]
$DefOrientation =
[line 89]
Tags:
var: orientation
access: protected
Type:
default
[ Top ]
$diffs =
[line 233]
Tags:
var: of encoding differences
access: protected
Type:
array
[ Top ]
$DrawColor =
[line 293]
Tags:
var: for drawing color
access: protected
Type:
commands
[ Top ]
$fh =
[line 131]
Tags:
var: of page format in user unit
access: protected
Type:
height
[ Top ]
$fhPt =
[line 119]
Tags:
var: of page format in points
access: protected
Type:
height
[ Top ]
$FillColor =
[line 299]
Tags:
var: for filling color
access: protected
Type:
commands
[ Top ]
$FontFamily =
[line 257]
Tags:
var: font family
access: protected
Type:
current
[ Top ]
$FontFiles =
[line 227]
Tags:
var: of font files
access: protected
Type:
array
[ Top ]
$fonts =
[line 221]
Tags:
var: of used fonts
access: protected
Type:
array
[ Top ]
$FontSize =
[line 287]
Tags:
var: font size in user unit
access: protected
Type:
current
[ Top ]
$FontSizePt =
[line 281]
Tags:
var: font size in points
access: protected
Type:
current
[ Top ]
$FontStyle =
[line 263]
Tags:
var: font style
access: protected
Type:
current
[ Top ]
$fw =
[line 125]
Tags:
var: of page format in user unit
access: protected
Type:
width
[ Top ]
$fwPt =
[line 113]
Tags:
var: of page format in points
access: protected
Type:
width
[ Top ]
$h =
[line 155]
Tags:
var: height of page in user unit
access: protected
Type:
current
[ Top ]
$hPt =
[line 143]
Tags:
var: height of page in points
access: protected
Type:
current
[ Top ]
$images =
[line 239]
Tags:
var: of used images
access: protected
Type:
array
[ Top ]
$imgscale = 1
[line 407]
Tags:
var: scale factor
access: protected
author: Nicola Asuni
since: 2004-06-14
Type:
image
[ Top ]
$img_rb_x =
[line 391]
Tags:
var: corner X coordinate of inserted image
access: protected
author: Nicola Asuni
since: 2002-07-31
Type:
right-bottom
[ Top ]
$img_rb_y =
[line 399]
Tags:
var: corner Y coordinate of inserted image
access: protected
author: Nicola Asuni
since: 2002-07-31
Type:
right-bottom
[ Top ]
$InFooter =
[line 335]
Tags:
var: set when processing footer
access: protected
Type:
flag
[ Top ]
$isunicode = false
[line 415]
Tags:
var: set to true when the input text is unicode (require unicode fonts)
access: protected
author: Nicola Asuni
since: 2005-01-02
Type:
boolean
[ Top ]
$k =
[line 107]
Tags:
var: factor (number of points in user unit)
access: protected
Type:
scale
[ Top ]
$keywords =
[line 371]
Tags:
access: protected
Type:
keywords
[ Top ]
$lasth =
[line 203]
Tags:
var: of last cell printed
access: protected
Type:
height
[ Top ]
$LayoutMode =
[line 347]
Tags:
var: display mode
access: protected
Type:
layout
[ Top ]
$LineWidth =
[line 209]
Tags:
var: width in user unit
access: protected
Type:
line
[ Top ]
$links =
[line 251]
Tags:
var: of internal links
access: protected
Type:
array
[ Top ]
$lMargin =
[line 161]
Tags:
var: margin
access: protected
Type:
left
[ Top ]
$n =
[line 53]
Tags:
var: object number
access: protected
Type:
current
[ Top ]
$offsets =
[line 59]
Tags:
var: of object offsets
access: protected
Type:
array
[ Top ]
$OrientationChanges =
[line 101]
Tags:
var: indicating orientation changes
access: protected
Type:
array
[ Top ]
$page =
[line 47]
Tags:
var: page number
access: protected
Type:
current
[ Top ]
$PageBreakTrigger =
[line 329]
Tags:
var: used to trigger page breaks
access: protected
Type:
threshold
[ Top ]
$PageLinks =
[line 245]
Tags:
var: of links in pages
access: protected
Type:
array
[ Top ]
$pages =
[line 71]
Tags:
var: containing pages
access: protected
Type:
array
[ Top ]
$PDFVersion = "1.3"
[line 422]
Tags:
var: version
access: protected
since: 1.5.3
Type:
PDF
[ Top ]
$rMargin =
[line 173]
Tags:
var: margin
access: protected
Type:
right
[ Top ]
$state =
[line 77]
Tags:
var: document state
access: protected
Type:
current
[ Top ]
$subject =
[line 359]
Tags:
access: protected
Type:
subject
[ Top ]
$TextColor =
[line 305]
Tags:
var: for text color
access: protected
Type:
commands
[ Top ]
$title =
[line 353]
Tags:
access: protected
Type:
title
[ Top ]
$tMargin =
[line 167]
Tags:
var: margin
access: protected
Type:
top
[ Top ]
$underline =
[line 269]
Tags:
var: flag
access: protected
Type:
underlining
[ Top ]
$w =
[line 149]
Tags:
var: width of page in user unit
access: protected
Type:
current
[ Top ]
$wPt =
[line 137]
Tags:
var: width of page in points
access: protected
Type:
current
[ Top ]
$ws =
[line 317]
Tags:
var: spacing
access: protected
Type:
word
[ Top ]
$x =
[line 191]
Tags:
var: horizontal position in user unit for cell positioning
access: protected
Type:
current
[ Top ]
$y =
[line 197]
Tags:
var: vertical position in user unit for cell positioning
access: protected
Type:
current
[ Top ]
$ZoomMode =
[line 341]
Tags:
var: display mode
access: protected
Type:
zoom
[ Top ]
Class Methods
constructor __construct [line 439]
FPDF __construct(
[string
$orientation = 'P'], [string
$unit = 'mm'], [mixed
$format = 'A4'], [boolean
$unicode = false])
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). Support UTF-8 Unicode [Nicola Asuni, 2005-01-02].
Tags:
access: protected
since: 1.0
Overridden in child classes as:
TCE_PDF::__construct()
This is the class constructor.
Parameters:
string
$orientation
page orientation. Possible values are (case insensitive):P or Portrait (default)L or Landscape
string
$unit
User measure unit. Possible values are:pt: pointmm: millimeter (default)cm: centimeterin: inchA 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).4A02A0A0A1A2A3A4 (default)A5A6A7A8A9A10B0B1B2B3B4B5B6B7B8B9B10C0C1C2C3C4C5C6C7C8C9C10RA0RA1RA2RA3RA4SRA0SRA1SRA2SRA3SRA4LETTERLEGALEXECUTIVEFOLIO
boolean
$unicode
TRUE means that the input text is unicode
[ Top ]
method AcceptPageBreak [line 1510]
boolean AcceptPageBreak(
)
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().This method is called automatically and should not be called directly by the application. Example: The method is overriden in an inherited class in order to obtain a 3 column layout: class PDF extends FPDF {
var $col=0;
public function SetCol($col) {
//Move position to a column
$this->col=$col;
$x=10+$col*65;
$this->SetLeftMargin($x);
$this->SetX($x);
}
public function AcceptPageBreak() {
if($this->colSetCol($this->col+1);
$this->SetY(10);
return false;
}
else {
//Go back to first column and issue page break
$this->SetCol(0);
return true;
}
}
}
$pdf=new PDF();
$pdf->Open();
$pdf->AddPage();
$pdf->SetFont('Arial','',12);
for($i=1;$iCell(0,5,"Line $i",0,1);
}
$pdf->Output();
Tags:
access: public
see: FPDF::SetAutoPageBreak()
since: 1.4
[ Top ]
method AddFont [line 1192]
void AddFont(
string
$family, [string
$style = ''], [string
$file = ''])
Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by FPDF_FONTPATH if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. Example: $pdf->AddFont('Comic','I');
// is equivalent to:
$pdf->AddFont('Comic','I','comici.php');
Tags:
access: public
see: FPDF::SetFont()
since: 1.5
Parameters:
string
$family
Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
string
$style
Font style. Possible values are (case insensitive):empty string: regular (default)B: boldI: italicBI or IB: bold italic
string
$file
The font definition file. By default, the name is built from the family and style, in lower case with no space.
[ Top ]
method AddLink [line 1404]
void AddLink(
)
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document. The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
Tags:
access: public
see: FPDF::Cell(), FPDF::Write(), FPDF::Image(), FPDF::Link(), FPDF::SetLink()
since: 1.5
[ Top ]
method AddPage [line 899]
void AddPage(
[string
$orientation = ''])
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header.The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
Tags:
access: public
see: FPDF(), FPDF::Header(), FPDF::Footer(), FPDF::SetMargins()
since: 1.0
Parameters:
string
$orientation
Page orientation. Possible values are (case insensitive):P or PortraitL or Landscape The default value is the one passed to the constructor.
[ Top ]
method AliasNbPages [line 841]
void AliasNbPages(
[string
$alias = '{nb}'])
Defines an alias for the total number of pages. It will be substituted as the document is closed.Example: class PDF extends FPDF {
public function Footer() {
//Go to 1.5 cm from bottom
$this->SetY(-15);
//Select Arial italic 8
$this->SetFont('Arial','I',8);
//Print current and total page numbers
$this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C');
}
}
$pdf=new PDF();
$pdf->AliasNbPages();
Tags:
access: public
see: FPDF::PageNo(), FPDF::Footer()
since: 1.4
Parameters:
string
$alias
The alias. Default value: {nb}.
[ Top ]
method Cell [line 1530]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''])
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Tags:
access: public
see: FPDF::SetFont(), FPDF::SetDrawColor(), FPDF::SetFillColor(), FPDF::SetTextColor(), FPDF::SetLineWidth(), FPDF::AddLink(), FPDF::Ln(), FPDF::MultiCell(), FPDF::Write(), FPDF::SetAutoPageBreak()
since: 1.0
Parameters:
float
$w
Cell width. If 0, the cell extends up to the right margin.
float
$h
Cell height. Default value: 0.
string
$txt
String to print. Default value: empty string.
mixed
$border
Indicates if borders must be drawn around the cell. The value can be either a number:0: no border (default)1: frameor a string containing some or all of the following characters (in any order):L: leftT: topR: rightB: bottom
int
$ln
Indicates where the current position should go after the call. Possible values are:0: to the right1: to the beginning of the next line2: below
string
$align
Allows to center or align the text. Possible values are:L or empty string: left align (default value)C: centerR: right align
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().
[ Top ]
method Close [line 873]
void Close(
)
Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.
Tags:
access: public
see: FPDF::Open(), FPDF::Output()
since: 1.0
[ Top ]
method Error [line 852]
void Error(
string
$msg)
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.2004-06-11 :: Nicola Asuni : changed bold tag with strong
Tags:
access: public
since: 1.0
Parameters:
string
$msg
The error message
[ Top ]
method Footer [line 1008]
void Footer(
)
This method is used to render the page footer. It is automatically called by AddPage() and Close() and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing.Example: class PDF extends FPDF {
public function Footer() {
//Go to 1.5 cm from bottom
$this->SetY(-15);
//Select Arial italic 8
$this->SetFont('Arial','I',8);
//Print centered page number
$this->Cell(0,10,'Page '.$this->PageNo(),0,0,'C');
}
}
Tags:
access: public
see: FPDF::Header()
since: 1.0
Overridden in child classes as:
TCE_PDF::Footer()
This method is used to render the page footer.
[ Top ]
method getBreakMargin [line 645]
int getBreakMargin(
)
Returns the page break margin.
Tags:
return: page break margin.
access: public
since: 1.5.2
author: Nicola Asuni
[ Top ]
method getImageScale [line 615]
float getImageScale(
)
Returns the image scale.
Tags:
return: image scale.
access: public
since: 1.5.2
author: Nicola Asuni
[ Top ]
method getPageHeight [line 635]
int getPageHeight(
)
Returns the page height in units.
Tags:
return: page height.
access: public
since: 1.5.2
author: Nicola Asuni
[ Top ]
method getPageWidth [line 625]
int getPageWidth(
)
Returns the page width in units.
Tags:
return: page width.
access: public
since: 1.5.2
author: Nicola Asuni
[ Top ]
method getScaleFactor [line 655]
int getScaleFactor(
)
Returns the scale factor (number of points in user unit).
Tags:
return: scale factor.
access: public
since: 1.5.2
author: Nicola Asuni
[ Top ]
method GetStringWidth [line 1092]
int GetStringWidth(
string
$s)
Returns the length of a string in user unit. A font must be selected.Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]
Tags:
access: public
since: 1.2
Parameters:
string
$s
The string whose length is to be computed
[ Top ]
method GetX [line 1953]
float GetX(
)
Returns the abscissa of the current position.
Tags:
access: public
see: FPDF::SetX(), FPDF::GetY(), FPDF::SetY()
since: 1.2
[ Top ]
method GetY [line 1980]
float GetY(
)
Returns the ordinate of the current position.
Tags:
access: public
see: FPDF::SetY(), FPDF::GetX(), FPDF::SetX()
since: 1.0
[ Top ]
method Header [line 986]
void Header(
)
This method is used to render the page header. It is automatically called by AddPage() and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing.Example: class PDF extends FPDF {
public function Header() {
//Select Arial bold 15
$this->SetFont('Arial','B',15);
//Move to the right
$this->Cell(80);
//Framed title
$this->Cell(30,10,'Title',1,0,'C');
//Line break
$this->Ln(20);
}
}
Tags:
access: public
see: FPDF::Footer()
since: 1.0
Overridden in child classes as:
TCE_PDF::Header()
This method is used to render the page header.
[ Top ]
method Image [line 1871]
void Image(
string
$file, float
$x, float
$y, [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''])
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 proportionsno 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 scalestrue colors (24 bits)CMYK (32 bits) For PNG, are allowed:gray scales on at most 8 bits (256 levels)indexed colorstrue colors (24 bits) but are not supported:InterlacingAlpha channel 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.
Tags:
access: public
see: FPDF::AddLink()
since: 1.1
Parameters:
string
$file
Name of the file containing the image.
float
$x
Abscissa of the upper-left corner.
float
$y
Ordinate of the upper-left corner.
float
$w
Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
float
$h
Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
string
$type
Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
mixed
$link
URL or identifier returned by AddLink().
[ Top ]
method Line [line 1148]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2)
Draws a line between two points.
Tags:
access: public
see: FPDF::SetLineWidth(), FPDF::SetDrawColor()
since: 1.0
Parameters:
float
$x1
Abscissa of first point
float
$y1
Ordinate of first point
float
$x2
Abscissa of second point
float
$y2
Ordinate of second point
[ Top ]
method Link [line 1440]
void Link(
float
$x, float
$y, float
$w, float
$h, mixed
$link)
Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
Tags:
access: public
see: FPDF::AddLink(), FPDF::Cell(), FPDF::Write(), FPDF::Image()
since: 1.5
Parameters:
float
$x
Abscissa of the upper-left corner of the rectangle
float
$y
Ordinate of the upper-left corner of the rectangle
float
$w
Width of the rectangle
float
$h
Height of the rectangle
mixed
$link
URL or identifier returned by AddLink()
[ Top ]
method Ln [line 1936]
void Ln(
[float
$h = ''])
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
Tags:
access: public
see: FPDF::Cell()
since: 1.0
Parameters:
float
$h
The height of the break. By default, the value equals the height of the last printed cell.
[ Top ]
method MultiCell [line 1633]
void MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], int
$ln)
This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other. Text can be aligned, centered or justified. The cell block can be framed and the background painted.
Tags:
access: public
see: FPDF::SetFont(), FPDF::SetDrawColor(), FPDF::SetFillColor(), FPDF::SetTextColor(), FPDF::SetLineWidth(), FPDF::Cell(), FPDF::Write(), FPDF::SetAutoPageBreak()
since: 1.3
Parameters:
float
$w
Width of cells. If 0, they extend up to the right margin of the page.
float
$h
Height of cells.
string
$txt
String to print
mixed
$border
Indicates if borders must be drawn around the cell block. The value can be either a number:0: no border (default)1: frameor a string containing some or all of the following characters (in any order):L: leftT: topR: rightB: bottom
int
$ln
Indicates where the current position should go after the call. Possible values are:0: to the right1: to the beginning of the next line2: below
string
$align
Allows to center or align the text. Possible values are:L or empty string: left alignC: centerR: right alignJ: justification (default value)
int
$fill
Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
[ Top ]
method Open [line 863]
void Open(
)
This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.Note: no page is created by this method
Tags:
access: public
see: FPDF::AddPage(), FPDF::Close()
since: 1.0
[ Top ]
method Output [line 2023]
void Output(
[string
$name = ''], [string
$dest = ''])
Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced. The method first calls Close() if necessary to terminate the document.
Tags:
access: public
see: FPDF::Close()
since: 1.0
Parameters:
string
$name
The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.
string
$dest
Destination where to send the document. It can take one of the following values:I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.D: send to the browser and force a file download with the name given by name.F: save to a local file with the name given by name.S: return the document as a string. name is ignored.If the parameter is not specified but a name is given, destination is F. If no parameter is specified at all, destination is I.Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D).
[ Top ]
method PageNo [line 1018]
int PageNo(
)
Returns the current page number.
Tags:
return: page number
access: public
see: FPDF::AliasNbPages()
since: 1.0
[ Top ]
method Rect [line 1163]
void Rect(
float
$x, float
$y, float
$w, float
$h, [string
$style = ''])
Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.
Tags:
access: public
see: FPDF::SetLineWidth(), FPDF::SetDrawColor(), FPDF::SetFillColor()
since: 1.0
Parameters:
float
$x
Abscissa of upper-left corner
float
$y
Ordinate of upper-left corner
float
$w
Width
float
$h
Height
string
$style
Style of rendering. Possible values are:D or empty string: draw (default)F: fillDF or FD: draw and fill
[ Top ]
method SetAuthor [line 793]
void SetAuthor(
string
$author)
Defines the author of the document.
Tags:
access: public
see: FPDF::SetCreator(), FPDF::SetKeywords(), FPDF::SetSubject(), FPDF::SetTitle()
since: 1.2
Parameters:
string
$author
The name of the author.
[ Top ]
method SetAutoPageBreak [line 720]
void SetAutoPageBreak(
boolean
$auto, [float
$margin = 0])
Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
Tags:
access: public
see: FPDF::Cell(), FPDF::MultiCell(), FPDF::AcceptPageBreak()
since: 1.0
Parameters:
boolean
$auto
Boolean indicating if mode should be on or off.
float
$margin
Distance from the bottom of the page.
[ Top ]
method SetCompression [line 755]
void SetCompression(
boolean
$compress)
Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.Note: the Zlib extension is required for this feature. If not present, compression will be turned off.
Tags:
access: public
since: 1.4
Parameters:
boolean
$compress
Boolean indicating if compression must be enabled.
[ Top ]
method SetCreator [line 815]
void SetCreator(
string
$creator)
Defines the creator of the document. This is typically the name of the application that generates the PDF.
Tags:
access: public
see: FPDF::SetAuthor(), FPDF::SetKeywords(), FPDF::SetSubject(), FPDF::SetTitle()
since: 1.2
Parameters:
string
$creator
The name of the creator.
[ Top ]
method SetDisplayMode [line 733]
void SetDisplayMode(
mixed
$zoom, [string
$layout = 'continuous'])
Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.
Tags:
access: public
since: 1.2
Parameters:
mixed
$zoom
The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. fullpage: displays the entire page on screenfullwidth: uses maximum width of windowreal: 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 oncecontinuous: displays pages continuously (default)two: displays two pages on two columnsdefault: uses viewer default mode
[ Top ]
method SetDrawColor [line 1031]
void SetDrawColor(
int
$r, [int
$g = -1], [int
$b = -1])
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
access: public
see: FPDF::SetFillColor(), FPDF::SetTextColor(), FPDF::Line(), FPDF::Rect(), FPDF::Cell(), FPDF::MultiCell()
since: 1.3
Parameters:
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)
[ Top ]
method SetFillColor [line 1052]
void SetFillColor(
int
$r, [int
$g = -1], [int
$b = -1])
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
access: public
see: FPDF::SetDrawColor(), FPDF::SetTextColor(), FPDF::Rect(), FPDF::Cell(), FPDF::MultiCell()
since: 1.3
Parameters:
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)
[ Top ]
method SetFont [line 1291]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0])
Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid.The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:They are in the current directory (the one where the running script lies)They are in one of the directories defined by the include_path parameterThey are in the directory defined by the FPDF_FONTPATH constant Example for the last case (note the trailing slash): define('FPDF_FONTPATH','/home/www/font/');
require('fpdf.php');
//Times regular 12
$pdf->SetFont('Times');
//Arial bold 14
$pdf->SetFont('Arial','B',14);
//Removes bold
$pdf->SetFont('');
//Times bold, italic and underlined 14
$pdf->SetFont('Times','BIU'); If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.
Tags:
access: public
see: FPDF::AddFont(), FPDF::SetFontSize(), FPDF::Cell(), FPDF::MultiCell(), FPDF::Write()
since: 1.0
Parameters:
string
$family
Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):Courier (fixed-width)Helvetica or Arial (synonymous; sans serif)Times (serif)Symbol (symbolic)ZapfDingbats (symbolic)It is also possible to pass an empty string. In that case, the current family is retained.
string
$style
Font style. Possible values are (case insensitive):empty string: regularB: boldI: italicU: underlineor any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats
float
$size
Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
[ Top ]
method SetFontSize [line 1386]
void SetFontSize(
float
$size)
Defines the size of the current font.
Tags:
access: public
see: FPDF::SetFont()
since: 1.0
Parameters:
float
$size
The size (in points)
[ Top ]
method setImageScale [line 605]
void setImageScale(
float
$scale)
Set the image scale.
Tags:
access: public
since: 1.5.2
author: Nicola Asuni
Parameters:
float
$scale
image scale.
[ Top ]
method SetKeywords [line 804]
void SetKeywords(
string
$keywords)
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
access: public
see: FPDF::SetAuthor(), FPDF::SetCreator(), FPDF::SetSubject(), FPDF::SetTitle()
since: 1.2
Parameters:
string
$keywords
The list of keywords.
[ Top ]
method SetLeftMargin [line 683]
void SetLeftMargin(
float
$margin)
Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
Tags:
access: public
see: FPDF::SetTopMargin(), FPDF::SetRightMargin(), FPDF::SetAutoPageBreak(), FPDF::SetMargins()
since: 1.4
Parameters:
float
$margin
The margin.
[ Top ]
method SetLineWidth [line 1131]
void SetLineWidth(
float
$width)
Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
Tags:
access: public
see: FPDF::Line(), FPDF::Rect(), FPDF::Cell(), FPDF::MultiCell()
since: 1.0
Parameters:
float
$width
The width.
[ Top ]
method SetLink [line 1419]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
Defines the page and position a link points to
Tags:
access: public
see: FPDF::AddLink()
since: 1.5
Parameters:
int
$link
The link identifier returned by AddLink()
float
$y
Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
int
$page
Number of target page; -1 indicates the current page. This is the default value
[ Top ]
method SetMargins [line 667]
void SetMargins(
float
$left, float
$top, [float
$right = -1])
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
Tags:
access: public
see: FPDF::SetLeftMargin(), FPDF::SetTopMargin(), FPDF::SetRightMargin(), FPDF::SetAutoPageBreak()
since: 1.0
Parameters:
float
$left
Left margin.
float
$top
Top margin.
float
$right
Right margin. Default value is the left one.
[ Top ]
method SetRightMargin [line 708]
void SetRightMargin(
float
$margin)
Defines the right margin. The method can be called before creating the first page.
Tags:
access: public
see: FPDF::SetLeftMargin(), FPDF::SetTopMargin(), FPDF::SetAutoPageBreak(), FPDF::SetMargins()
since: 1.5
Parameters:
float
$margin
The margin.
[ Top ]
method SetSubject [line 782]
void SetSubject(
string
$subject)
Defines the subject of the document.
Tags:
access: public
see: FPDF::SetAuthor(), FPDF::SetCreator(), FPDF::SetKeywords(), FPDF::SetTitle()
since: 1.2
Parameters:
string
$subject
The subject.
[ Top ]
method SetTextColor [line 1074]
void SetTextColor(
int
$r, [int
$g = -1], [int
$b = -1])
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
access: public
see: FPDF::SetDrawColor(), FPDF::SetFillColor(), FPDF::Text(), FPDF::Cell(), FPDF::MultiCell()
since: 1.3
Parameters:
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)
[ Top ]
method SetTitle [line 771]
void SetTitle(
string
$title)
Defines the title of the document.
Tags:
access: public
see: FPDF::SetAuthor(), FPDF::SetCreator(), FPDF::SetKeywords(), FPDF::SetSubject()
since: 1.2
Parameters:
string
$title
The title.
[ Top ]
method SetTopMargin [line 697]
void SetTopMargin(
float
$margin)
Defines the top margin. The method can be called before creating the first page.
Tags:
access: public
see: FPDF::SetLeftMargin(), FPDF::SetRightMargin(), FPDF::SetAutoPageBreak(), FPDF::SetMargins()
since: 1.5
Parameters:
float
$margin
The margin.
[ Top ]
method SetX [line 1964]
void SetX(
float
$x)
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.
Tags:
access: public
see: FPDF::GetX(), FPDF::GetY(), FPDF::SetY(), FPDF::SetXY()
since: 1.2
Parameters:
float
$x
The value of the abscissa.
[ Top ]
method SetXY [line 2009]
void SetXY(
float
$x, float
$y)
Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.
Tags:
access: public
see: FPDF::SetX(), FPDF::SetY()
since: 1.2
Parameters:
float
$x
The value of the abscissa
float
$y
The value of the ordinate
[ Top ]
method SetY [line 1991]
void SetY(
float
$y)
Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.
Tags:
access: public
see: FPDF::GetX(), FPDF::GetY(), FPDF::SetY(), FPDF::SetXY()
since: 1.0
Parameters:
float
$y
The value of the ordinate.
[ Top ]
method Text [line 1453]
void Text(
float
$x, float
$y, string
$txt)
Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.
Tags:
access: public
see: FPDF::SetFont(), FPDF::SetTextColor(), FPDF::Cell(), FPDF::MultiCell(), FPDF::Write()
since: 1.0
Parameters:
float
$x
Abscissa of the origin
float
$y
Ordinate of the origin
string
$txt
String to print
[ Top ]
method UTF8StringToArray [line 2913]
array UTF8StringToArray(
string
$str)
Converts UTF-8 strings to codepoints array.Invalid byte sequences will be replaced with 0xFFFD (replacement character) Based on: http://www.faqs.org/rfcs/rfc3629.html Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------
ABFN notation:
---------------------------------------------------------------------
UTF8-octets = *( UTF8-char )
UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
UTF8-1 = %x00-7F
UTF8-2 = %xC2-DF UTF8-tail
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
%xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
%xF4 %x80-8F 2( UTF8-tail )
UTF8-tail = %x80-BF
---------------------------------------------------------------------
Tags:
return: containing codepoints (UTF-8 characters values)
usedby: FPDF::UTF8ToUTF16BE()
access: protected
since: 1.53.0.TC005 (2005-01-05)
author: Nicola Asuni
Parameters:
string
$str
string to process.
[ Top ]
method UTF8ToUTF16BE [line 3014]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
Converts UTF-8 strings to UTF16-BE.Based on: http://www.faqs.org/rfcs/rfc2781.html Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to
UTF-16 proceeds as follows. Let U be the character number, no greater
than 0x10FFFF.
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate.
2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits.
3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits.
4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate.
Graphically, steps 2 through 4 look like:
U' = yyyyyyyyyyxxxxxxxxxx
W1 = 110110yyyyyyyyyy
W2 = 110111xxxxxxxxxx
Tags:
access: protected
uses: FPDF::UTF8StringToArray()
since: 1.53.0.TC005 (2005-01-05)
author: Nicola Asuni
Parameters:
string
$str
string to process.
boolean
$setbom
if true set the Byte Order Mark (BOM = 0xFEFF)
[ Top ]
method Write [line 1762]
void Write(
float
$h, string
$txt, [mixed
$link = ''])
This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.Example: //Begin with regular font
$pdf->SetFont('Arial','',14);
$pdf->Write(5,'Visit ');
//Then put a blue underlined link
$pdf->SetTextColor(0,0,255);
$pdf->SetFont('','U');
$pdf->Write(5,'www.fpdf.org','http://www.fpdf.org');
Tags:
access: public
see: FPDF::SetFont(), FPDF::SetTextColor(), FPDF::AddLink(), FPDF::MultiCell(), FPDF::SetAutoPageBreak()
since: 1.5
Parameters:
float
$h
Line height
string
$txt
String to print
mixed
$link
URL or identifier returned by AddLink()
[ Top ]
method _begindoc [line 2131]
void _begindoc(
)
Start document
Tags:
access: protected
[ Top ]
method _beginpage [line 2537]
void _beginpage(
mixed
$orientation)
_beginpage
Tags:
access: protected
[ Top ]
method _dochecks [line 2105]
void _dochecks(
)
Check for locale-related bug
Tags:
access: protected
[ Top ]
method _dounderline [line 2595]
void _dounderline(
mixed
$x, mixed
$y, mixed
$txt)
Underline text
Tags:
access: protected
[ Top ]
method _enddoc [line 2498]
void _enddoc(
)
_enddoc
Tags:
access: protected
[ Top ]
method _endpage [line 2577]
void _endpage(
)
End of page contents
Tags:
access: protected
[ Top ]
method _escape [line 2769]
void _escape(
mixed
$s)
Add \ before \, ( and )
Tags:
access: protected
[ Top ]
method _escapetext [line 2757]
void _escapetext(
mixed
$s)
Format a text string
Tags:
access: protected
[ Top ]
method _freadint [line 2735]
void _freadint(
mixed
$f)
Read a 4-byte integer from file
Tags:
access: protected
[ Top ]
method _getfontpath [line 2120]
void _getfontpath(
)
Return fonts path
Tags:
access: protected
[ Top ]
method _newobj [line 2585]
void _newobj(
)
Begin a new object
Tags:
access: protected
[ Top ]
method _out [line 2787]
void _out(
mixed
$s)
Add a line to the document
Tags:
access: protected
[ Top ]
method _parsejpg [line 2606]
void _parsejpg(
mixed
$file)
Extract info from a JPEG file
Tags:
access: protected
[ Top ]
method _parsepng [line 2638]
void _parsepng(
mixed
$file)
Extract info from a PNG file
Tags:
access: protected
[ Top ]
method _putcatalog [line 2450]
void _putcatalog(
)
_putcatalog
Tags:
access: protected
[ Top ]
method _putfonts [line 2214]
void _putfonts(
)
Adds fonts_putfonts
Tags:
access: protected
[ Top ]
method _putheader [line 2490]
void _putheader(
)
_putheader
Tags:
access: protected
[ Top ]
method _putimages [line 2332]
void _putimages(
)
_putimages
Tags:
access: protected
[ Top ]
method _putinfo [line 2426]
void _putinfo(
)
_putinfo
Tags:
access: protected
[ Top ]
method _putpages [line 2141]
void _putpages(
)
_putpages
Tags:
access: protected
[ Top ]
method _putresourcedict [line 2394]
void _putresourcedict(
)
_putresourcedict
Tags:
access: protected
[ Top ]
method _putresources [line 2410]
void _putresources(
)
_putresources
Tags:
access: protected
[ Top ]
method _putstream [line 2777]
void _putstream(
mixed
$s)
Tags:
access: protected
[ Top ]
method _puttrailer [line 2480]
void _puttrailer(
)
_puttrailer
Tags:
access: protected
[ Top ]
method _puttruetypeunicode [line 2803]
void _puttruetypeunicode(
mixed
$font)
Adds unicode fonts.Based on PDF Reference 1.3 (section 5)
Tags:
access: protected
since: 1.52.0.TC005 (2005-01-05)
author: Nicola Asuni
[ Top ]
method _putxobjectdict [line 2384]
void _putxobjectdict(
)
_putxobjectdict
Tags:
access: protected
[ Top ]
method _textstring [line 2745]
void _textstring(
mixed
$s)
Format a text string
Tags:
access: protected
[ Top ]
Documentation generated on Thu, 6 Jan 2005 00:51:13 +0100 by phpDocumentor 1.3.0RC3
Wyszukiwarka
Podobne podstrony:
classtrees FPDFli FPDFFPDFfpdfelementindex FPDFwięcej podobnych podstron