Index of all elements
[ a ]
[ c ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ w ]
[ x ]
[ y ]
[ z ]
a
- acceptPageBreak
- in file PDF.php, method File_PDF::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 File_PDF:setAutoPageBreak.
- addFont
- in file PDF.php, method File_PDF::addFont()
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.
- addLink
- in file PDF.php, method File_PDF::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.
- addPage
- in file PDF.php, method File_PDF::addPage()
Adds a new page to the document. If a page is already present, the
- aliasNbPages
- in file PDF.php, method File_PDF::aliasNbPages()
Defines an alias for the total number of pages. It will be substituted as the document is closed.
top
c
- cell
- in file PDF.php, method File_PDF::cell()
Prints a cell (rectangular area) with optional borders, background
- circle
- in file PDF.php, method File_PDF::circle()
Outputs a circle. It can be drawn (border only), filled (with no border) or both.
- close
- in file PDF.php, method File_PDF::close()
Terminates the PDF document. It is not necessary to call this method explicitly because File_PDF::output does it automatically.
- courier.php
- procedural page courier.php
top
f
- $fh
- in file PDF.php, variable File_PDF::$fh
- $fhPt
- in file PDF.php, variable File_PDF::$fhPt
- $fw
- in file PDF.php, variable File_PDF::$fw
Current dimensions of page format in user units.
- $fwPt
- in file PDF.php, variable File_PDF::$fwPt
Current dimensions of page format in points.
- factory
- in file PDF.php, method File_PDF::factory()
Attempts to return a conrete PDF instance. It allows to set up the page format, the orientation and the units of measurement used in all the methods (except for the font sizes).
- File_PDF
- in file PDF.php, class File_PDF
File_PDF::
- footer
- in file PDF.php, method File_PDF::footer()
This method is used to render the page footer. It is automatically
top
g
- getOutput
- in file PDF.php, method File_PDF::getOutput()
Returns the raw PDF file.
- getPageNo
- in file PDF.php, method File_PDF::getPageNo()
Returns the current page number.
- getStringWidth
- in file PDF.php, method File_PDF::getStringWidth()
Returns the length of a text string. A font must be selected.
- getX
- in file PDF.php, method File_PDF::getX()
Returns the abscissa of the current position in user units.
- getY
- in file PDF.php, method File_PDF::getY()
Returns the ordinate of the current position in user units.
top
h
- $h
- in file PDF.php, variable File_PDF::$h
- $hPt
- in file PDF.php, variable File_PDF::$hPt
- helvetica.php
- procedural page helvetica.php
- helveticab.php
- procedural page helveticab.php
- helveticabi.php
- procedural page helveticabi.php
- helveticai.php
- procedural page helveticai.php
- header
- in file PDF.php, method File_PDF::header()
This method is used to render the page header. It is automatically called by File_PDF::addPage and should not be called directly by the application. The implementation in File_PDF:: is empty, so you have to subclass it and override the method if you want a specific processing.
top
i
- image
- in file PDF.php, method File_PDF::image()
Prints an image in the page. The upper-left corner and at least one of the dimensions must be specified; the height or the width can be calculated automatically in order to keep the image proportions.
top
l
- line
- in file PDF.php, method File_PDF::line()
Draws a line between two points.
- link
- in file PDF.php, method File_PDF::link()
Puts a link on a rectangular area of the page. Text or image links are generally put via File_PDF::cell, File_PDF::Write or File_PDF::image, but this method can be useful for instance to define a clickable area inside an image.
top
m
- multiCell
- in file PDF.php, method File_PDF::multiCell()
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.
top
n
- newLine
- in file PDF.php, method File_PDF::newLine()
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
top
o
- open
- in file PDF.php, method File_PDF::open()
This method begins the generation of the PDF document; it must be called before any output commands. No page is created by this method, therefore it is necessary to call File_PDF::addPage.
- output
- in file PDF.php, method File_PDF::output()
Function to output the buffered data to the browser.
top
top
r
- raiseError
- in file PDF.php, method File_PDF::raiseError()
Returns a PEAR_Error object. Wraps around PEAR::raiseError() to avoid having to include PEAR.php unless an error occurs.
- rect
- in file PDF.php, method File_PDF::rect()
Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.
top
s
- symbol.php
- procedural page symbol.php
- save
- in file PDF.php, method File_PDF::save()
Function to save the PDF file somewhere local to the server.
- setAutoPageBreak
- in file PDF.php, method File_PDF::setAutoPageBreak()
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.
- setCompression
- in file PDF.php, method File_PDF::setCompression()
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.
- setDisplayMode
- in file PDF.php, method File_PDF::setDisplayMode()
Defines the way the document is to be displayed by the viewer. The zoom
- setDrawColor
- in file PDF.php, method File_PDF::setDrawColor()
Sets the draw color, used when drawing lines. Depending on the colorspace called, the number of color component parameters required can be either 1, 3 or 4. The method can be called before the first page is created and the color is retained from page to page.
- setFillColor
- in file PDF.php, method File_PDF::setFillColor()
Sets the fill color. Specifies the color for both filled areas and
- setFont
- in file PDF.php, method File_PDF::setFont()
Sets the font used to print character strings. It is mandatory to call
- setFontSize
- in file PDF.php, method File_PDF::setFontSize()
Defines the size of the current font.
- setInfo
- in file PDF.php, method File_PDF::setInfo()
Set the info to a document. Possible info settings are:
- setLeftMargin
- in file PDF.php, method File_PDF::setLeftMargin()
Defines the left margin. The method can be called before creating the first page.
- setLineWidth
- in file PDF.php, method File_PDF::setLineWidth()
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.
- setLink
- in file PDF.php, method File_PDF::setLink()
Defines the page and position a link points to.
- setMargins
- in file PDF.php, method File_PDF::setMargins()
Defines the left, top and right margins. By default, they equal - cm. Call this method to change them.
- setRightMargin
- in file PDF.php, method File_PDF::setRightMargin()
Defines the right margin. The method can be called before creating the first page.
- setTopMargin
- in file PDF.php, method File_PDF::setTopMargin()
Defines the top margin. The method can be called before creating the first page.
- setX
- in file PDF.php, method File_PDF::setX()
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.
- setXY
- in file PDF.php, method File_PDF::setXY()
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.
- setY
- in file PDF.php, method File_PDF::setY()
Defines the ordinate of the current position. If the passed value is negative, it is relative to the bottom of the page.
top
top
w
- $w
- in file PDF.php, variable File_PDF::$w
Current dimensions of page in user units
- $wPt
- in file PDF.php, variable File_PDF::$wPt
Current dimensions of page in points.
- write
- in file PDF.php, method File_PDF::write()
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.
- writeRotated
- in file PDF.php, method File_PDF::writeRotated()
write Rotated Text.
top
x
- $x
- in file PDF.php, variable File_PDF::$x
The current horizontal and vertical position for cell positioning.
top
top
top
Documentation generated on Mon, 11 Mar 2019 10:17:12 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|
