Class Horde_Pdf_Writer

Constructor

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 = new Horde_Pdf_Writer(array('orientation' => 'P',
                                  'unit'   => 'mm',
                                  'format' => 'A4'));

Parameters

Defines the left, top and right margins.

By default, they equal 1 cm. Call this method to change them.

Parameters

See

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

See

Defines the top margin.

The method can be called before creating the first page.

Parameters

Defines the right margin.

The method can be called before creating the first page.

Parameters

Returns the actual page width.

Returns

Returns the actual page height.

Returns

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

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

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

Set the info to a document.

Possible info settings are: - title - subject - author - keywords - creator

Parameters

Defines an alias for the total number of pages.

It will be substituted as the document is closed.

Example:

class My_Pdf extends Horde_Pdf_Writer {
    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 = new My_Pdf();
$pdf->aliasNbPages();

Parameters

See

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 Horde_Pdf_Writer::addPage().

See

Terminates the PDF document.

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

See

Adds a new page to the document.

If a page is already present, the Horde_Pdf_Writer::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 Horde_Pdf_Writer::header() is called to display the header.

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

See

This method is used to render the page header.

It is automatically called by Horde_Pdf_Writer::addPage() and should not be called directly by the application. The implementation in Horde_Pdf_Writer is empty, so you have to subclass it and override the method if you want a specific processing.

Example:

class My_Pdf extends Horde_Pdf_Writer {
    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);
    }
}

See

This method is used to render the page footer.

It is automatically called by Horde_Pdf_Writer::addPage() and Horde_Pdf_Writer::close() and should not be called directly by the application. The implementation in Horde_Pdf_Writer is empty, so you have to subclass it and override the method if you want a specific processing.

Example:

class My_Pdf extends Horde_Pdf_Writer {
   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');
   }
}

See

Returns the current page number.

Returns

See

Sets the fill color.

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

See

Get the fill color

Returns

Sets the text color.

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

See

Get the text color

Returns

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

See

Get the draw color

Returns

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

Parameters

Returns

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

See

P (portrait) or L (landscape)

Returns

Returns

Returns

Returns

Draws a line between two points.

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

See

Outputs a rectangle.

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

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

See

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

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

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

See

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 Horde_Pdf_Writer::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 Horde_Pdf_Writer::setFontSize().

Parameters

See

Defines the size of the current font.

Parameters

See

Defines the style of the current font.

Parameters

See

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 Horde_Pdf_Writer::cell(), {@link()} write, Horde_Pdf_Writer::image() or Horde_Pdf_Writer::link(). The destination is defined with Horde_Pdf_Writer::setLink().

See

Defines the page and position a link points to.

Parameters

See

Puts a link on a rectangular area of the page.

Text or image links are generally put via Horde_Pdf_Writer::cell(), Horde_Pdf_Writer::write() or Horde_Pdf_Writer::image(), but this method can be useful for instance to define a clickable area inside an image.

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

See

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 Horde_Pdf_Writer::cell(), Horde_Pdf_Writer::multiCell() or Horde_Pdf_Writer::write() which are the standard methods to print text.

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

See

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 Horde_Pdf_Writer::setAutoPageBreak(). This method is called automatically and should not be called directly by the application.

Returns

See

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

See

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

See

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

See

Writes text at an angle.

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

Parameters

See

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.

All coordinates can be negative to provide values from the right or bottom edge of the page (since File_Pdf 0.2.0, Horde 3.2).

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

See

Performs a line break.

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

Parameters

See

Get the current page

Returns

Set the current page

Parameters

Returns the abscissa of the current position in user units.

Returns

See

Defines the abscissa of the current position.

If the passed value is negative, it is relative to the right of the page.

Parameters

See

Returns the ordinate of the current position in user units.

Returns

See

Defines the ordinate of the current position.

If the passed value is negative, it is relative to the bottom of the page.

Parameters

See

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

See

Returns the current buffer content and resets the buffer.

Use this method when creating large files to avoid memory problems. This method doesn't work in combination with the save() method, use getOutput() at the end. Calling this method doubles the memory usage during the call.

See

Returns the raw Pdf file.

See

Saves the PDF file on the filesystem.

Parameters