Class: File_PDF

bool 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.

This method is called automatically and should not be called directly by the application.

void addFont( string $family, [optional $style = ''], [optional $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 location of the definition file (and the font file itself when embedding) must be found at the full path name included.

Example: $pdf->addFont('Comic', 'I'); is equivalent to: $pdf->addFont('Comic', 'I', 'comici.php');

Parameters:

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 File_PDF::cell, File_PDF::write, File_PDF::image or File_PDF::link. The destination is defined with File_PDF::setLink.

void addPage( [optional $orientation = ''])

Adds a new page to the document. If a page is already present, the

File_PDF::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 File_PDF::header is called to display the header. The font which was set before calling is automatically restored. There is no need to call File_PDF::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.

Parameters:

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

Defines an alias for the total number of pages. It will be substituted as the document is closed.

Example: class My_File_PDF extends File_PDF { 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->getPageNo() . '/{nb}', 0, 0, 'C'); } } $pdf = &My_File_PDF::factory(); $pdf->aliasNbPages();

Parameters:

void cell( float $width, [optional $height = 0], [optional $text = ''], [optional $border = 0], [optional $ln = 0], [optional $align = ''], [optional $fill = 0], [optional $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.

Parameters:

void circle( float $x, float $y, float $r, [optional $style = ''])

Outputs a circle. It can be drawn (border only), filled (with no border) or both.

Parameters:

void close( )

Terminates the PDF document. It is not necessary to call this method explicitly because File_PDF::output does it automatically.

If the document contains no page, File_PDF::addPage is called to prevent from getting an invalid document.

void &factory( [optional $orientation = 'P'], [optional $unit = 'mm'], [optional $format = 'A4'])

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).

Example: $pdf = &File_PDF::factory('P', 'mm', 'A4');

Parameters:

void footer( )

This method is used to render the page footer. It is automatically

called by File_PDF::addPage and File_PDF::close 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.

Example:

class My_File_PDF extends File_PDF { 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->getPageNo(), 0, 0, 'C'); } }

void getOutput( )

Returns the raw PDF file.

int getPageNo( )

Returns the current page number.

float getStringWidth( string $text, [optional $pt = false])

Returns the length of a text string. A font must be selected.

Parameters:

float getX( )

Returns the abscissa of the current position in user units.

float getY( )

Returns the ordinate of the current position in user units.

void 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.

Example:

class My_File_PDF extends File_PDF { 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->newLine(20); } }

void image( string $file, float $x, float $y, [float $width = 0], [optional $height = 0], [string $type = ''], [mixed $link = ''])

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.

Supported formats are JPEG and PNG.

For JPEG, all flavors are allowed:

• gray scales
• true colors (24 bits)
• CMYK (32 bits)

For PNG, are allowed:

• gray scales on at most 8 bits (256 levels)
• indexed colors
• true colors (24 bits)

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.

Parameters:

void line( float $x1, float $y1, float $x2, float $y2)

Draws a line between two points.

Parameters:

void link( float $x, float $y, float $width, float $height, mixed $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.

Parameters:

void multiCell( float $width, float $height, string $text, [optional $border = 0], [optional $align = 'J'], [optional $fill = 0])

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.

Parameters:

void newLine( [optional $height = ''])

Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.

Parameters:

void 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.

void output( [optional $filename = 'unknown.pdf'], [optional $inline = false])

Function to output the buffered data to the browser.

Parameters:

object PEAR_Error raiseError( mixed $error)

Returns a PEAR_Error object. Wraps around PEAR::raiseError() to avoid having to include PEAR.php unless an error occurs.

Parameters:

void rect( float $x, float $y, float $width, float $height, [optional $style = ''])

Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.

Parameters:

void save( [optional $filename = 'unknown.pdf'])

Function to save the PDF file somewhere local to the server.

Parameters:

void setAutoPageBreak( bool $auto, [optional $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.

Parameters:

void setCompression( bool $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.

Parameters:

void setDisplayMode( mixed $zoom, [optional $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.

Parameters:

void setDrawColor( [string $cs = 'rgb'], float $c1, [optional $c2 = 0], [optional $c3 = 0], [optional $c4 = 0])

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.

Parameters:

void setFillColor( [string $cs = 'rgb'], float $c1, [optional $c2 = 0], [optional $c3 = 0], [optional $c4 = 0])

Sets the fill color. Specifies the color for both filled areas and

text. 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.

Parameters:

void setFont( string $family, [optional $style = ''], [optional $size = null])

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 File_PDF::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 File_PDF::setFontSize.

Parameters:

void setFontSize( float $size)

Defines the size of the current font.

Parameters:

void setInfo( mixed $info, [optional $value = ''])

Set the info to a document. Possible info settings are:

• title
• subject
• author
• keywords
• creator

Parameters:

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.

Parameters:

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.

Parameters:

void setLink( int $link, [optional $y = 0], [optional $page = -1])

Defines the page and position a link points to.

Parameters:

void setMargins( float $left, float $top, [optional $right = null])

Defines the left, top and right margins. By default, they equal

1. cm. Call this method to change them.

Parameters:

void setRightMargin( float $margin)

Defines the right margin. The method can be called before creating the first page.

Parameters:

void setTopMargin( float $margin)

Defines the top margin. The method can be called before creating the first page.

Parameters:

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.

Parameters:

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.

Parameters:

void setY( float $y)

Defines the ordinate of the current position. If the passed value is negative, it is relative to the bottom of the page.

Parameters:

void text( float $x, float $y, string $text)

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 File_PDF::cell, File_PDF::multiCell or File_PDF::Write which are the standard methods to print text.

Parameters:

void write( float $height, string $text, [optional $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');

Parameters:

none writeRotated( int $x, int $y, string $text, float $text_angle, [optional $font_angle = 0])

write Rotated Text.

Write text at an angle.

Parameters: