Documentation TYPO3 par Ameos

FPDF Class Reference

Inheritance diagram for FPDF:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GetStringWidth ($s)
 Error ($msg)
 _out ($s)
 _newobj ()
 _escape ($s)
 _textstring ($s)
 _putstream ($s)
 _begindoc ()
 _putpages ()
 _putfonts ()
 _putimages ()
 _putresources ()
 _putinfo ()
 _putcatalog ()
 _puttrailer ()
 _enddoc ()
 _beginpage ($orientation)
 _endpage ()
 _dounderline ($x, $y, $txt)
 _parsejpg ($file)
 _freadint ($f)
 _parsepng ($file)
 SetAutoPageBreak ($auto, $margin=0)
 SetDisplayMode ($zoom= 'default', $layout= 'continuous')
 SetCompression ($compress)
 SetMargins ($left, $top, $right=-1)
 FPDF ($orientation= 'P', $unit= 'mm', $format= 'A4')
 SetLeftMargin ($margin)
 SetTopMargin ($margin)
 SetRightMargin ($margin)
 SetTitle ($title)
 SetSubject ($subject)
 SetAuthor ($author)
 SetKeywords ($keywords)
 SetCreator ($creator)
 AliasNbPages ($alias= '{nb}')
 SetFont ($family, $style= '', $size=0)
 Header ()
 Footer ()
 Open ()
 AddPage ($orientation= '')
 Close ()
 PageNo ()
 SetDrawColor ($r, $g=-1, $b=-1)
 SetFillColor ($r, $g=-1, $b=-1)
 SetTextColor ($r, $g=-1, $b=-1)
 SetLineWidth ($width)
 Line ($x1, $y1, $x2, $y2)
 Rect ($x, $y, $w, $h, $style= '')
 AddFont ($family, $style= '', $file= '')
 SetFontSize ($size)
 AddLink ()
 SetLink ($link, $y=0, $page=-1)
 Link ($x, $y, $w, $h, $link)
 Text ($x, $y, $txt)
 AcceptPageBreak ()
 Cell ($w, $h=0, $txt= '', $border=0, $ln=0, $align= '', $fill=0, $link= '')
 MultiCell ($w, $h, $txt, $border=0, $align= 'J', $fill=0)
 Write ($h, $txt, $link= '')
 Image ($file, $x, $y, $w, $h=0, $type= '', $link= '')
 Ln ($h= '')
 GetX ()
 SetX ($x)
 GetY ()
 SetY ($y)
 SetXY ($x, $y)
 Output ($file= '', $download=FALSE)

Public Attributes

 $page
 $n
 $offsets
 $buffer
 $pages
 $state
 $compress
 $DefOrientation
 $CurOrientation
 $OrientationChanges
 $fwPt
 $fhPt
 $fw
 $fh
 $wPt
 $hPt
 $k
 $w
 $h
 $lMargin
 $tMargin
 $rMargin
 $bMargin
 $cMargin
 $x
 $y
 $lasth
 $LineWidth
 $CoreFonts
 $fonts
 $FontFiles
 $diffs
 $images
 $PageLinks
 $links
 $FontFamily
 $FontStyle
 $CurrentFont
 $FontSizePt
 $FontSize
 $DrawColor
 $FillColor
 $TextColor
 $ColorFlag
 $ws
 $underline
 $AutoPageBreak
 $PageBreakTrigger
 $InFooter
 $ZoomMode
 $LayoutMode
 $title
 $subject
 $author
 $keywords
 $creator
 $AliasNbPages

Detailed Description

The FPDF class

Definition at line 23 of file fpdf.php.


Constructor & Destructor Documentation

FPDF::FPDF orientation = 'P',
unit = 'mm',
format = 'A4'
 

The FPDF constructor

Parameters:
string The page orientation (p, portrait, l or landscape)
string The unit for sizes (pt, mm, cm or in)
mixed The page format (A3, A4, A5, letter, legal or an array with page sizes)
public

Definition at line 975 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF().


Member Function Documentation

FPDF::_begindoc  ) 
 

Starts document

private

Definition at line 219 of file fpdf.php.

FPDF::_beginpage orientation  ) 
 

Starts a new page

Parameters:
string The page orientation
private

Definition at line 613 of file fpdf.php.

FPDF::_dounderline x,
y,
txt
 

Underlines text

Parameters:
double The x position
double The y position
string The text
Returns:
string The underlined text
private

Definition at line 674 of file fpdf.php.

FPDF::_enddoc  ) 
 

Terminates document

private

Definition at line 566 of file fpdf.php.

FPDF::_endpage  ) 
 

Ends page contents

private

Definition at line 657 of file fpdf.php.

FPDF::_escape s  ) 
 

Adds a "\" before "\", "(" and ")" characters

Parameters:
string The string to slash
Returns:
integer The slashed string
private

Definition at line 174 of file fpdf.php.

FPDF::_freadint f  ) 
 

Reads a 4-byte integer from a file

Parameters:
string The file name and path
Returns:
integer The 4-byte integer
private

See also:
_parsepng()

Definition at line 738 of file fpdf.php.

FPDF::_newobj  ) 
 

Starts a new object

private

Definition at line 157 of file fpdf.php.

FPDF::_out s  ) 
 

Adds a line to the document

Parameters:
string The string to add
private

Definition at line 142 of file fpdf.php.

FPDF::_parsejpg file  ) 
 

Extracts info from a JPEG file

Parameters:
string The file name and path
Returns:
array The images informations
private

Definition at line 693 of file fpdf.php.

FPDF::_parsepng file  ) 
 

Extracts info from a PNG file

Parameters:
string The file name and path
Returns:
array The images informations
private

See also:
_freadint()

Definition at line 760 of file fpdf.php.

FPDF::_putcatalog  ) 
 

Puts catalog informations

private

Reimplemented in PMA_PDF.

Definition at line 525 of file fpdf.php.

FPDF::_putfonts  ) 
 

Puts font faces

private

Definition at line 309 of file fpdf.php.

FPDF::_putimages  ) 
 

Puts images

private

Definition at line 412 of file fpdf.php.

FPDF::_putinfo  ) 
 

Puts document informations

private

Definition at line 496 of file fpdf.php.

FPDF::_putpages  ) 
 

Puts pages

private

Reimplemented in PMA_PDF.

Definition at line 231 of file fpdf.php.

FPDF::_putresources  ) 
 

Puts resources

private

Reimplemented in PMA_PDF.

Definition at line 466 of file fpdf.php.

FPDF::_putstream s  ) 
 

Outputs a stream

Parameters:
string The stream to ouput
private

See also:
_out()

Definition at line 206 of file fpdf.php.

FPDF::_puttrailer  ) 
 

Puts trailer

private

Definition at line 553 of file fpdf.php.

FPDF::_textstring s  ) 
 

Formats a text stringrs

Parameters:
string The string to format
Returns:
integer The formatted string
private

See also:
_escape()

Definition at line 191 of file fpdf.php.

FPDF::AcceptPageBreak  ) 
 

Gets whether automatic page break is on or not

Returns:
boolean Whether automatic page break is on or not
public

Definition at line 1910 of file fpdf.php.

FPDF::AddFont family,
style = '',
file = ''
 

Adds a TrueType or Type1 font

Parameters:
string The font name
string The font style (B, I, BI)
string The font file definition
public

Definition at line 1741 of file fpdf.php.

FPDF::AddLink  ) 
 

Creates a new internal link

Returns:
integer The link id
public

Definition at line 1830 of file fpdf.php.

FPDF::AddPage orientation = ''  ) 
 

Starts a new page

Parameters:
string The page orientation (p, portrait, l or landscape)
public

Definition at line 1497 of file fpdf.php.

FPDF::AliasNbPages  ) 
 

Defines an alias for the total number of pages

Parameters:
string The alias string
public

Definition at line 1357 of file fpdf.php.

FPDF::Cell w,
h = 0,
txt = '',
border = 0,
ln = 0,
align = '',
fill = 0,
link = ''
 

Output a cell

Parameters:
double The cell width
double The cell height
string The text to output
mixed Wether to add borders or not (see the manual)
integer Where to put the cursor once the output is done
string Align mode
integer Whether to fill the cell with a color or not
mixed The link id or an url
public

Definition at line 1930 of file fpdf.php.

Referenced by PMA_PDF::Footer(), PMA_PDF::Header(), and PMA_PDF::PMA_PDF_cellScale().

FPDF::Close  ) 
 

Terminates and closes the document

public

Definition at line 1571 of file fpdf.php.

FPDF::Error msg  ) 
 

Displays an error message then exists

Parameters:
string The error message
public

Reimplemented in PMA_PDF.

Definition at line 122 of file fpdf.php.

FPDF::Footer  ) 
 

Sends the footer of the page

This method has to be implemented in your own inherited class

public

Reimplemented in PMA_PDF.

Definition at line 1473 of file fpdf.php.

FPDF::GetStringWidth s  ) 
 

Gets the width of a string in the current font

Parameters:
string The string to check
Returns:
double The string width
public

Definition at line 99 of file fpdf.php.

References $w.

FPDF::GetX  ) 
 

Gets x position

Returns:
double The x position
public

Definition at line 2338 of file fpdf.php.

FPDF::GetY  ) 
 

Gets y position

Returns:
double The y position
public

Definition at line 2368 of file fpdf.php.

Referenced by PMA_PDF::Bookmark().

FPDF::Header  ) 
 

Sends the header of the page

This method has to be implemented in your own inherited class

public

Reimplemented in PMA_PDF.

Definition at line 1460 of file fpdf.php.

FPDF::Image file,
x,
y,
w,
h = 0,
type = '',
link = ''
 

Puts an image on the page

Parameters:
string The image file (JPEG or PNG format)
double The top left x position
double The top left y position
double The image width
double The image height
string The image type (JPG, JPEG or PNG)
mixed The link id or an url
public

Definition at line 2264 of file fpdf.php.

FPDF::Line x1,
y1,
x2,
y2
 

Draws a line

Parameters:
double The horizontal position of the starting point
double The vertical position of the starting point
double The horizontal position of the ending point
double The vertical position of the ending point
public

Definition at line 1701 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF_lineScale().

FPDF::Link x,
y,
w,
h,
link
 

Put a link inside a rectangular area of the page

Parameters:
double The top left x position
double The top left y position
double The rectangle width
double The rectangle height
mixed The link id or an url
public

Definition at line 1870 of file fpdf.php.

FPDF::Ln h = ''  ) 
 

Appends a line feed

Parameters:
double The line height
public

Definition at line 2318 of file fpdf.php.

Referenced by PMA_PDF::Header().

FPDF::MultiCell w,
h,
txt,
border = 0,
align = 'J',
fill = 0
 

Output text with automatic or explicit line breaks

Parameters:
double The cell width
double The cell height
string The text to output
mixed Wether to add borders or not (see the manual)
string Align mode
integer Whether to fill the cell with a color or not
public

Definition at line 2037 of file fpdf.php.

FPDF::Open  ) 
 

Begin the document

public

Definition at line 1484 of file fpdf.php.

FPDF::Output file = '',
download = FALSE
 

Outputs PDF to file or browser

Parameters:
string The file name
boolean Whether to display the document inside the browser (with Acrobat plugin), to enforce download as file or to save it on the server
string The browser id string

public

Definition at line 2419 of file fpdf.php.

FPDF::PageNo  ) 
 

Gets the current page number

Returns:
integer The current page number
public

Definition at line 1596 of file fpdf.php.

Referenced by PMA_PDF::Footer().

FPDF::Rect x,
y,
w,
h,
style = ''
 

Draws a rectangle

Parameters:
double The horizontal position of the top left corner
double The vertical position of the top left corner
double The horizontal position of the bottom right corner
double The vertical position of the bottom right corner
string The rectangle style
public

Definition at line 1718 of file fpdf.php.

FPDF::SetAuthor author  ) 
 

Sets the author of the document (among the document properties)

Parameters:
string The author of the document
public

Definition at line 1318 of file fpdf.php.

FPDF::SetAutoPageBreak auto,
margin = 0
 

Sets auto page break mode and triggering margin

Parameters:
string The auto page break mode
double Maximum size till the bottom of the page to start adding page break
public

Definition at line 885 of file fpdf.php.

FPDF::SetCompression compress  ) 
 

Sets page compression

Parameters:
boolean whether to compress file or not
public

Definition at line 935 of file fpdf.php.

FPDF::SetCreator creator  ) 
 

Sets the creator of the document (among the document properties)

Parameters:
string The creator of the document
public

Definition at line 1344 of file fpdf.php.

FPDF::SetDisplayMode zoom = 'default',
layout = 'continuous'
 

Sets display mode in viewer

Parameters:
mixed The zoom mode (fullpage, fullwidth, real, default, zoom or an zoom factor -real-)
string The layout mode (single, continuous, two or default)
public

Definition at line 902 of file fpdf.php.

FPDF::SetDrawColor r,
g = -1,
b = -1
 

Sets color for all stroking operations

Parameters:
integer The red level (0 to 255)
integer The green level (0 to 255)
integer The blue level (0 to 255)
public

Definition at line 1611 of file fpdf.php.

FPDF::SetFillColor r,
g = -1,
b = -1
 

Sets color for all filling operations

Parameters:
integer The red level (0 to 255)
integer The green level (0 to 255)
integer The blue level (0 to 255)
public

Definition at line 1635 of file fpdf.php.

FPDF::SetFont family,
style = '',
size = 0
 

Selects a font

Parameters:
string The font name
string The font style (B, I, BI)
double The font size (in points)
double The character width

public

Definition at line 1374 of file fpdf.php.

Referenced by PMA_PDF::Footer(), and PMA_PDF::Header().

FPDF::SetFontSize size  ) 
 

Sets font size

Parameters:
double The font size (in points)
public

Definition at line 1810 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF_setFontSizeScale().

FPDF::SetKeywords keywords  ) 
 

Sets keywords of the document (among the document properties)

Parameters:
string The keyword list for the document
public

Definition at line 1331 of file fpdf.php.

FPDF::SetLeftMargin margin  ) 
 

Sets left margin of the page

Parameters:
double The left margin
public

Definition at line 1250 of file fpdf.php.

FPDF::SetLineWidth width  ) 
 

Sets the line width

Parameters:
double The line width
public

Definition at line 1680 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF_setLineWidthScale().

FPDF::SetLink link,
y = 0,
page = -1
 

Sets destination of internal link

Parameters:
integer The link id
double The y position on the page
integer The page number
public

Definition at line 1847 of file fpdf.php.

FPDF::SetMargins left,
top,
right = -1
 

Sets page margins

Parameters:
double The left margin
double The top margin
double The right margin
public

Definition at line 954 of file fpdf.php.

FPDF::SetRightMargin margin  ) 
 

Sets right margin of the page

Parameters:
double The right margin
public

Definition at line 1279 of file fpdf.php.

FPDF::SetSubject subject  ) 
 

Sets the subject of the document (among the document properties)

Parameters:
string The subject of the document
public

Definition at line 1305 of file fpdf.php.

FPDF::SetTextColor r,
g = -1,
b = -1
 

Sets color for text

Parameters:
integer The red level (0 to 255)
integer The green level (0 to 255)
integer The blue level (0 to 255)
public

Definition at line 1661 of file fpdf.php.

FPDF::SetTitle title  ) 
 

Sets the title of the document (among the document properties)

Parameters:
string The title of the document
public

Definition at line 1292 of file fpdf.php.

FPDF::SetTopMargin margin  ) 
 

Sets top margin of the page

Parameters:
double The top margin
public

Definition at line 1266 of file fpdf.php.

FPDF::SetX x  ) 
 

Sets x position

Parameters:
double The x position
public

Definition at line 2351 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF_setXScale().

FPDF::SetXY x,
y
 

Sets x and y positions

Parameters:
double The x position
double The y position
public

Definition at line 2400 of file fpdf.php.

Referenced by PMA_PDF::PMA_PDF_setXyScale().

FPDF::SetY y  ) 
 

Sets y position and resets x

Parameters:
double The y position
public

Definition at line 2381 of file fpdf.php.

Referenced by PMA_PDF::Footer().

FPDF::Text x,
y,
txt
 

Outputs a string

Parameters:
double The x position
double The y position
string The string
public

Definition at line 1889 of file fpdf.php.

FPDF::Write h,
txt,
link = ''
 

Output text in flowing mode

Parameters:
double The line height
string The text to output
mixed The link id or an url
public

Definition at line 2167 of file fpdf.php.


Member Data Documentation

FPDF::$page
 

Defines private properties

Definition at line 28 of file fpdf.php.


The documentation for this class was generated from the following file:


Généré par Les spécialistes TYPO3 avec  doxygen 1.4.6