FlyPDF - API Documentation
Introduction
laskd adj alk jdlak jdlka jdkla jdkl ajkdl jakld jlka jdlka jdlka jdkla jdlk ajkld jalk djla dla djklajsdklajsdklajsd lkasjd kasdj sakdj aksd jkas djka jdka jdka jdka jdka jdk ajkd jaksd jaks djkasdj kadj kasjdkajdkajdkasjdka djka jdkajd adoaidoa dioaidoa doa idoa idoai lad lakj dlkajd laskj dlaskjd lkasjd lksaj dlkas jdlkajsd aosdia sod asodi asod akljd jkash duqd jqkdh qkjdhusdh akjsdajkshduasd hkajsdhsajkdh uas dkashdjakshdua hkjahd jsadh uas
AcceptPageBreak ()
Name: AcceptPageBreak()
Synopsis: boolean AcceptPageBreak()
Description: 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.
Input: NONE
Returns: Nothing
AddFont()
Name: AddFont()
Synopsis: AddFont ( string family [, string style [, string file ] ] )
Description: DA RIVEDERE 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 in the font directory. If it is not found, the error "Could not include font definition file" is generated.
Input:
  • family - Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
  • style - Font style. Possible values are (case insensitive):
    • empty string: regular
    • B: bold
    • I: italic
    • BI or IB: bold italic
    The default value is regular.
  • file - Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
Returns: Nothing
See Also: SetFont()
AddLink()
Name: AddLink()
Synopsis: int AddLink()
Description: 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().
Input: NONE
Returns: int
See Also:
AddPage()
Name: AddPage()
Synopsis: AddPage ( [ string orientation ] )
Description: 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.
Input:
  • orientation - Page orientation. Possible values are (case insensitive):
    • P or Portrait
    • L or Landscape
    The default value is the one passed to the constructor.
Returns: Nothing
See Also:
AliasNbPages()
Name: AliasNbPages()
Synopsis: AliasNbPages ( [ string alias ] )
Description: Defines an alias for the total number of pages. It will be substituted as the document is closed.
Input:
  • alias - The alias. Default value: {nb}.
Returns: Nothing
See Also:
Cell()
Name: Cell()
Synopsis: Cell ( float w [, float h [, string txt [, mixed border [, int ln [, string align [, int fill [, mixed link ] ] ] ] ] ] ] )
Description: 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.
Input:
  • w - Cell width. If 0, the cell extends up to the right margin.
  • h - Cell height. Default value: 0.
  • txt - String to print. Default value: empty string.
  • border - Indicates if borders must be drawn around the cell. The value can be either a number:
    • 0: no border
    • 1: frame
    or a string containing some or all of the following characters (in any order):
    • L: left
    • T: top
    • R: right
    • B: bottom
    Default value: 0.
  • 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
    • 2: below
    Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
  • align - Allows to center or align the text. Possible values are:
    • L or empty string: left align (default value)
    • C: center
    • R: right align
  • fill - Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
  • link - URL or identifier returned by AddLink().
Returns: Nothing
See Also:
Close()
Name: Close()
Synopsis: Close()
Description: 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.
Input: NONE
Returns: Nothing
See Also:
Error()
Name: Error()
Synopsis: Error(string msg)
Description: 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.
Input:
  • msg - The error message.
Returns: Nothing
Footer()
Name: Footer()
Synopsis: Footer()
Description: 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 FlyPDF is empty, so you have to subclass it and override the method if you want a specific processing.
Input: NONE
Returns: Nothing
See Also:
PDF()
Name: PDF()
Synopsis: PDF([string orientation [, string unit [, mixed format]]])
Description: 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).
Input:
  • orientation - Default page orientation. Possible values are (case insensitive):
    • P or Portrait
    • L or Landscape
  • unit - User measure unit. Possible values are:
    • pt: point
    • mm: millimeter
    • 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.
    Default value is mm.
  • format - The format used for pages. It can be either one of the following values (case insensitive):
    • A3
    • A4
    • A5
    • Letter
    • Legal
    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).
Returns: Nothing
GetStringWidth()
Name: GetStringWidth()
Synopsis: float GetStringWidth ( string s )
Description: Returns the length of a string in user unit. A font must be selected.
Input:
  • s - The string whose length is to be computed.
Returns: float
GetX()
Name: GetX()
Synopsis: float GetX()
Description: Returns the abscissa of the current position.
Input: NONE
Returns: float
See Also:
GetY()
Name: GetY()
Synopsis: float GetY()
Description: Returns the ordinate of the current position.
Input: NONE
Returns: float
See Also:
Header()
Name: Header()
Synopsis: Header()
Description: 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.
Input: NONE
Returns: Nothing
See Also:
Image()
Name: Image()
Synopsis: Image(string file, float x, float y [, float w [, float h [, string type [, mixed link]]]])
Description: 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)
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. Default value is mm. but are not supported:
  • Interlacing
  • Alpha 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.
Input:
  • file - Name of the file containing the image.
  • x - Abscissa of the upper-left corner.
  • y - Ordinate of the upper-left corner.
  • w - Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
  • h - Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
  • type - Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
  • link - URL or identifier returned by AddLink().
Returns: Nothing
See Also:
Line()
Name: Line()
Synopsis: Line(float x1, float y1, float x2, float y2)
Description: Draws a line between two points.
Input:
  • x1 - Abscissa of first point.
  • y1 - Ordinate of first point.
  • x2 - Abscissa of second point.
  • y2 - Ordinate of second point.
Returns: Nothing
See Also:
Link()
Name: Link()
Synopsis: Link(float x, float y, float w, float h, mixed link)
Description: 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.
Input:
  • x - Abscissa of the upper-left corner of the rectangle.
  • y - Ordinate of the upper-left corner of the rectangle.
  • w - Width of the rectangle.
  • h - Height of the rectangle.
  • link - URL or identifier returned by AddLink().
Returns: Nothing
See Also:
Ln()
Name: Ln()
Synopsis: Ln([float h])
Description: Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
Input:
  • h - The height of the break. By default, the value equals the height of the last printed cell.
Returns: Nothing
See Also:
MultiCell()
Name: MultiCell()
Synopsis: MultiCell(float w, float h, string txt [, mixed border [, string align [, int fill]]])
Description: 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.
Input:
  • w - Width of cells. If 0, they extend up to the right margin of the page.
  • h - Height of cells.
  • txt - String to print.
  • border - Indicates if borders must be drawn around the cell block. The value can be either a number:
    • 0 - no border
    • 1 - frame
    or a string containing some or all of the following characters (in any order):
  • align - Sets the text alignment. Possible values are:
    • L - left alignment
    • C - center
    • R - right alignment
    • J - justification (default value)
  • fill - Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
Returns: Nothing
See Also:
Output()
Name: Output()
Synopsis: string Output([string name [, string dest]])
Description: 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.
Input:
  • name - The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.
  • 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).
Returns: Nothing
See Also:
PageNo()
Name: PageNo()
Synopsis: int PageNo()
Description: Returns the current page number.
Input: NONE
Returns: int
See Also:
Rect()
Name: Rect()
Synopsis: Rect(float x, float y, float w, float h [, string style])
Description: Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.
Input:
  • x - Abscissa of the upper-left corner
  • y - Ordinate of the upper-left corner
  • w - Width
  • h - Height
  • style - Style of rendering. Possible values are:
    • D or empty string - draw. This is the default value.
    • F - fill.
    • DF or FD - draw and fill.
Returns: Nothing
See Also:
SetAuthor()
Name: SetAuthor()
Synopsis: SetAuthor(string author)
Description: Defines the author of the document.
Input:
  • author - The name of the author.
Returns: Nothing
See Also:
SetAutoPageBreak(boolean auto [, float margin])
Name: SetAutoPageBreak()
Synopsis: SetAutoPageBreak(boolean auto [, float margin])
Description: 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.
Input:
  • auto - Boolean indicating if mode should be on or off.
  • margin - Distance from the bottom of the page.
Returns: Nothing.
See Also:
SetCompression()
Name: SetCompression()
Synopsis: SetCompression(boolean compress)
Description: 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.

Input:
  • compress - Boolean indicating if compression must be enabled.
Returns: Nothing.
SetCreator()
Name: SetCreator()
Synopsis: SetCreator(string creator)
Description: Defines the creator of the document. This is typically the name of the application that generates the PDF.
Input:
  • creator - The name of the creator.
Returns: Nothing.
See Also:
SetDisplayMode()
Name: SetDisplayMode()
Synopsis: SetDisplayMode(mixed zoom [, string layout])
Description: 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.
Input:
  • zoom - The zoom to use. It can be one of the following string values:
    • 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
    or a number indicating the zooming factor to use.
  • layout - The page layout. Possible values are:
    • single - displays one page at once
    • continuos - displays pages continuously
    • two - displays two pages on two columns
    • default - uses viewer default mode
    Default value is continuous.
Returns: Nothing
SetDrawColor()
Name: SetDrawColor()
Synopsis: SetDrawColor(int r [, int g, int b])
Description: 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.
Input:
  • r - If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255.
  • g - Green component (between 0 and 255).
  • b - Blue component (between 0 and 255).
Returns: Nothing.
See Also:
SetFillColor()
Name: SetFillColor()
Synopsis: SetFillColor(int r [, int g, int b])
Description: 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.
Input:
  • r - If g and b are given, red component; if not, indicates the gray level. Value between 0 and 255.
  • g - Green component (between 0 and 255).
  • b - Blue component (between 0 and 255).
Returns: Nothing.
See Also:
SetFont()
Name: SetFont()
Synopsis: SetFont(string family [, string style [, float size]])
Description: 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.
If you just wish to change the current font size, it is simpler to call SetFontSize().
NOTE: the font metric files must be accessible. They are searched successively in:
  • The directory defined by the FPDF_FONTPATH constant (if this constant is defined)
  • The font directory located in the directory containing fpdf.php (if it exists)
  • The directories accessible through include()
Input:
  • 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.
  • 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.
  • 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.
Returns: Nothing
See Also:
SetFontSize()
Name: SetFontSize()
Synopsis: SetFontSize(float size)
Description: Defines the size of the current font.
Input:
  • size - The size (in points).
Returns: Nothing.
See Also:
SetKeywords()
Name: SetKeywords()
Synopsis: SetKeywords(string keywords)
Description: Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Input:
  • keywords - The list of keywords.
Returns: Nothing.
See Also:
DA QUI
SetLeftMargin()
Name: SetLeftMargin()
Synopsis: SetLeftMargin(float margin)
Description: 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.
Input:
  • margin - The margin.
Returns: Nothing.
See Also: SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
SetLineWidth()
Name: SetLineWidth()
Synopsis: SetLineWidth(float width)
Description: 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.
Input:
  • width - The width.
Returns: Nothing.
See Also: Line(), Rect(), Cell(), MultiCell()
SetLink()
Name: SetLink()
Synopsis: SetLink(int link [, float y [, int page]])
Description: 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.
Input:
  • link - The link identifier returned by AddLink().
  • y - Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page).
  • page - Number of target page; -1 indicates the current page. This is the default value.
Returns: Nothing.
See Also: AddLink()
SetMargins()
Name: SetMargins()
Synopsis: SetMargins(float left, float top [, float right])
Description: Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
Input:
  • left - Left margin.
  • top - Top margin.
  • right - Right margin. Default value is the left one.
Returns: Nothing.
See Also: SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
SetRightMargin()
Name: SetRightMargin()
Synopsis: SetRightMargin(float margin)
Description: Defines the right margin. The method can be called before creating the first page.
Input:
  • margin - The margin.
Returns: Nothing.
See Also: SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()
SetSubject()
Name: SetSubject()
Synopsis: SetSubject(string subject)
Description: Defines the subject of the document.
Input:
  • subject - The subject.
Returns: Nothing.
See Also: SetAuthor(), SetCreator(), SetKeywords(), SetTitle()
SetTextColor()
Name: SetTextColor()
Synopsis: SetTextColor(int r [, int g, int b])
Description: 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.
Input:
  • r - If g and b are given, red component; if not, indicates the gray level. Value between 0 and 255.
  • g - Green component (between 0 and 255).
  • b - Blue component (between 0 and 255).
Returns: Nothing.
See Also: SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
SetTitle()
Name: SetTitle()
Synopsis: SetTitle(string title)
Description: Defines the title of the document.
Input:
  • title - The title.
Returns: Nothing.
See Also: SetAuthor(), SetCreator(), SetKeywords(), SetSubject()
SetTopMargin()
Name: SetTopMargin()
Synopsis: SetTopMargin(float margin)
Description: Defines the top margin. The method can be called before creating the first page.
Input:
  • margin - The margin.
Returns: Nothing.
See Also: SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
SetX()
Name: SetX()
Synopsis: SetX(float x)
Description: Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.
Input:
  • x - The value of the abscissa.
Returns: Nothing.
See Also: GetX(), GetY(), SetY(), SetXY()
SetXY()
Name: SetXY()
Synopsis: SetXY(float x, float y)
Description: 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.
Input:
  • x - The value of the abscissa.
  • y - The value of the ordinate.
Returns: Nothing.
See Also: SetX(), SetY()
SetY()
Name: SetY()
Synopsis: SetY(float y)
Description: 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.
Input:
  • y - The value of the ordinate.
Returns: Nothing.
See Also: GetX(), GetY(), SetX(), SetXY()
Text()
Name: Text()
Synopsis: Text(float x, float y, string txt)
Description: Prints a character string. The origin is on the left of the first character, 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.
Input:
  • x - Abscissa of the origin.
  • y - Ordinate of the origin.
  • y - String to print.
Returns: Nothing.
See Also: SetFont(), SetTextColor(), Cell(), MultiCell(), Write()
Write()
Name: Write()
Synopsis: Write(float h, string txt [, mixed link])
Description: 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.
Input:
  • h - Line height.
  • txt - String to print.
  • link - URL or identifier returned by AddLink().
Returns: Nothing.
See Also: SetFont(), SetTextColor(), AddLink(), MultiCell(), SetAutoPageBreak()