PHP Class Horde_Pdf_Writer, horde

Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$fh float Current height of page format in user units.
$fhPt float Current height of page format in points.
$fw float Current width of page format in user units.
$fwPt float Current width of page format in points.
$h float Current height of page in user units
$hPt float Current height of page in points.
$w float Current width of page in user units
$wPt float Current width of page in points.
$x float Value is set in user units and is calculated from the top left corner as origin.
$y float Value is set in user units and is calculated from the top left corner as origin.

Protected Properties

Property Type Description
$_alias_nb_pages string Alias for total number of pages.
$_auto_page_break boolean Automatic page breaking.
$_break_margin float Break page margin size, the bottom margin which triggers a page break.
$_buffer string Buffer holding in-memory Pdf.
$_buflen integer Buffer length, including already flushed content.
$_cell_margin float Cell margin size.
$_color_flag boolean Whether text color is different from fill color.
$_compress boolean Flag indicating if PDF file is to be compressed or not.
$_core_fonts array An array of standard font names.
$_current_font array An array containing current font info.
$_current_orientation string The current page orientation.
$_default_orientation string The default page orientation.
$_diffs array An array of encoding differences.
$_draw_color string Commands for drawing color.
$_fill_color string Commands for filling color.
$_flushed boolean Whether the buffer has been flushed already.
$_font_family string Current font family.
$_font_files array An array of font files.
$_font_size float Current font size in user units.
$_font_size_pt float Current font size in points.
$_font_style string Current font style.
$_font_widths array Widths of specific font files
$_fonts array An array of used fonts.
$_images array An array of used images.
$_in_footer boolean Flag set when processing footer.
$_info array An array containing the document info, consisting of: - title - subject - author - keywords - creator
$_last_height float The height of the last cell printed.
$_layout_mode string Layout display mode.
$_left_margin float Left page margin size.
$_line_width float Line width in user units.
$_links array An array of internal links.
$_n integer Current object number.
$_offsets array Array of object offsets.
$_orientation_changes array Array indicating orientation changes.
$_page integer Current page number.
$_page_break_trigger float Threshold used to trigger page breaks.
$_page_links array An array of links in pages.
$_pages array Array containing the pages.
$_right_margin float Right page margin size.
$_scale float Scale factor (number of points in user units).
$_state integer Current document state.
  0 - initial state
  1 - document opened
  2 - page opened
  3 - document closed
$_text_color string Commands for text color.
$_top_margin float Top page margin size.
$_underline boolean Underlining flag.
$_word_spacing integer Word spacing.
$_zoom_mode string Zoom display mode.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor
acceptPageBreak ( ) : boolean 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 {@link setAutoPageBreak()}.
addFont ( string $family, string $style = '', string $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.
addLink ( ) Creates a new internal link and returns its identifier.
addPage ( string $orientation = '' ) Adds a new page to the document.
aliasNbPages ( string $alias = '{nb}' ) Defines an alias for the total number of pages.
cell ( float $width, float $height, string $text = '', mixed $border, integer $ln, string $align = '', integer $fill, string $link = '' ) Prints a cell (rectangular area) with optional borders, background color and character string.
circle ( float $x, float $y, float $r, string $style = '' ) Outputs a circle. It can be drawn (border only), filled (with no border) or both.
close ( ) Terminates the PDF document.
flush ( ) Returns the current buffer content and resets the buffer.
footer ( ) This method is used to render the page footer.
getDefaultOrientation ( ) : string P (portrait) or L (landscape)
getDrawColor ( ) : string Get the draw color
getFillColor ( ) : string Get the fill color
getFormatHeight ( ) : float
getFormatWidth ( ) : float
getOutput ( ) Returns the raw Pdf file.
getPage ( ) : integer Get the current page
getPageHeight ( ) : float Returns the actual page height.
getPageNo ( ) : integer Returns the current page number.
getPageWidth ( ) : float Returns the actual page width.
getScale ( ) : integer
getStringWidth ( string $text, boolean $pt = false ) : float Returns the length of a text string. A font must be selected.
getTextColor ( ) : string Get the text color
getX ( ) : float Returns the abscissa of the current position in user units.
getY ( ) : float Returns the ordinate of the current position in user units.
header ( ) This method is used to render the page header.
image ( string $file, float $x, float $y, float $width, float $height, string $type = '', mixed $link = '' ) Prints an image in the page.
line ( float $x1, float $y1, float $x2, float $y2 ) Draws a line between two points.
link ( float $x, float $y, float $width, float $height, mixed $link ) Puts a link on a rectangular area of the page.
multiCell ( float $width, float $height, string $text, mixed $border, string $align = 'J', integer $fill ) This method allows printing text with line breaks.
newLine ( float $height = '' ) Performs a line break.
open ( ) This method begins the generation of the PDF document; it must be called before any output commands.
rect ( float $x, float $y, float $width, float $height, float $style = '' ) Outputs a rectangle.
save ( string $filename = 'unknown.pdf' ) Saves the PDF file on the filesystem.
setAutoPageBreak ( boolean $auto, float $margin ) Enables or disables the automatic page breaking mode.
setCompression ( boolean $compress ) Activates or deactivates page compression.
setDisplayMode ( mixed $zoom, $layout = 'continuous' ) Defines the way the document is to be displayed by the viewer.
setDrawColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 ) Sets the draw color, used when drawing lines.
setFillColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 ) Sets the fill color.
setFont ( string $family, string $style = '', integer $size = null, boolean $force = false ) Sets the font used to print character strings.
setFontSize ( float $size ) Defines the size of the current font.
setFontStyle ( string $style ) Defines the style of the current font.
setInfo ( array | string $info, string $value = '' ) Set the info to a document.
setLeftMargin ( float $margin ) Defines the left margin.
setLineWidth ( float $width ) Defines the line width.
setLink ( integer $link, float $y, integer $page ) Defines the page and position a link points to.
setMargins ( float $left, float $top, float $right = null ) Defines the left, top and right margins.
setPage ( integer $page ) Set the current page
setRightMargin ( float $margin ) Defines the right margin.
setTextColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 ) Sets the text color.
setTopMargin ( float $margin ) Defines the top margin.
setX ( float $x ) Defines the abscissa of the current position.
setXY ( float $x, float $y ) Defines the abscissa and ordinate of the current position.
setY ( float $y ) Defines the ordinate of the current position.
text ( float $x, float $y, string $text ) Prints a character string.
write ( float $height, string $text, mixed $link = '' ) This method prints text from the current position.
writeRotated ( integer $x, integer $y, string $text, float $text_angle, float $font_angle ) Writes text at an angle.

Protected Methods

Method Description
_beginDoc ( ) : void Begin the PDF document.
_beginPage ( string $orientation ) : void Begin a new page.
_doUnderline ( integer $x, integer $y, string $text ) : string Underline a block of text.
_endDoc ( ) : void End the PDF document
_endPage ( ) : void Set the end of page contents.
_escape ( string $s ) : string Escape parentheses and forward slash.
_freadInt ( resource $f ) : integer Read a 4-byte integer from stream.
_getFontFile ( string $fontkey ) : array Load information about a font from its key name.
_hexToRgb ( $hex ) Convert hex-based color to RGB
_link ( integer $x, integer $y, integer $width, integer $height, string $link ) : void Save link to page links array.
_newobj ( ) : void Begin a new object.
_out ( string $s ) : void Add a line to the document.
_parseJPG ( string $file ) : array Extract info from a JPEG file.
_parsePNG ( string $file ) : array Extract info from a PNG file.
_putCatalog ( ) : void Write the PDF catalog.
_putFonts ( ) : void Write the PDF fonts.
_putImages ( ) : void Write the PDF images.
_putInfo ( ) : void Write the PDF information.
_putPages ( ) : void Write the PDF pages.
_putResources ( ) : void Write the PDF resources.
_putStream ( string $s ) : void Add a line to the document wrapped in 'stream' and 'endstream'.
_putTrailer ( ) : void Write the PDF trailer.
_textString ( string $s ) : string Format a text string by escaping and wrapping in parentheses.
_toPt ( integer $val ) : integer Scale a value.

Method Details

__construct() public method

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'));
public __construct ( array $params = [] )
$params array A hash with parameters for the created PDF object. Possible parameters are: - orientation - Default page orientation. Possible values are (case insensitive): - P or Portrait (default) - L or Landscape - unit - User measure units. Possible values values are: - pt: point - mm: millimeter (default) - 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. - format - The format used for pages. It can be either one of the following values (case insensitive): - A3 - A4 (default) - 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 the unit parameter).

_beginDoc() protected method

Begin the PDF document.
protected _beginDoc ( ) : void
return void

_beginPage() protected method

Begin a new page.
protected _beginPage ( string $orientation ) : void
$orientation string Orientation code
return void

_doUnderline() protected method

Underline a block of text.
protected _doUnderline ( integer $x, integer $y, string $text ) : string
$x integer X-coordinate
$y integer Y-coordinate
$text string Text to underline
return string Underlined string

_endDoc() protected method

End the PDF document
protected _endDoc ( ) : void
return void

_endPage() protected method

Set the end of page contents.
protected _endPage ( ) : void
return void

_escape() protected method

Escape parentheses and forward slash.
protected _escape ( string $s ) : string
$s string String to escape.
return string Escaped string.

_freadInt() protected method

Read a 4-byte integer from stream.
protected _freadInt ( resource $f ) : integer
$f resource Stream resource
return integer Byte

_getFontFile() protected static method

Load information about a font from its key name.
protected static _getFontFile ( string $fontkey ) : array
$fontkey string Font name key
return array Array of all font widths, including this font.

_hexToRgb() protected method

Convert hex-based color to RGB
protected _hexToRgb ( $hex )

_newobj() protected method

Begin a new object.
protected _newobj ( ) : void
return void

_out() protected method

Add a line to the document.
protected _out ( string $s ) : void
$s string Line to add.
return void

_parseJPG() protected method

Extract info from a JPEG file.
protected _parseJPG ( string $file ) : array
$file string Filename of JPEG image
return array Assoc. array of info

_parsePNG() protected method

Extract info from a PNG file.
protected _parsePNG ( string $file ) : array
$file string Filename of PNG image
return array Assoc. array of info

_putCatalog() protected method

Write the PDF catalog.
protected _putCatalog ( ) : void
return void

_putFonts() protected method

Write the PDF fonts.
protected _putFonts ( ) : void
return void

_putImages() protected method

Write the PDF images.
protected _putImages ( ) : void
return void

_putInfo() protected method

Write the PDF information.
protected _putInfo ( ) : void
return void

_putPages() protected method

Write the PDF pages.
protected _putPages ( ) : void
return void

_putResources() protected method

Write the PDF resources.
protected _putResources ( ) : void
return void

_putStream() protected method

Add a line to the document wrapped in 'stream' and 'endstream'.
protected _putStream ( string $s ) : void
$s string Line to add.
return void

_putTrailer() protected method

Write the PDF trailer.
protected _putTrailer ( ) : void
return void

_textString() protected method

Format a text string by escaping and wrapping in parentheses.
protected _textString ( string $s ) : string
$s string String to format.
return string

_toPt() protected method

Scale a value.
protected _toPt ( integer $val ) : integer
$val integer Value
return integer Value multiplied by scale

acceptPageBreak() public method

This method is called automatically and should not be called directly by the application.
See also: setAutoPageBreak()
public acceptPageBreak ( ) : boolean
return boolean

addFont() public method

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');
See also: setFont()
public addFont ( string $family, string $style = '', string $file = '' )
$family string Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
$style string Font style. Possible values are (case insensitive): - empty string: regular (default) - B: bold - I: italic - BI or IB: bold italic
$file string The font definition file. By default, the name is built from the family and style, in lower case with no space.

addPage() public method

If a page is already present, the {@link 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 {@link header()} is called to display the header. The font which was set before calling is automatically restored. There is no need to call {@link 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.
See also: header()
See also: footer()
See also: setMargins()
public addPage ( string $orientation = '' )
$orientation string Page orientation. Possible values are (case insensitive): - P or Portrait - L or Landscape The default value is the one passed to the constructor.

aliasNbPages() public method

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();
See also: getPageNo()
See also: footer()
public aliasNbPages ( string $alias = '{nb}' )
$alias string The alias.

cell() public method

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.
See also: setFont()
See also: setDrawColor()
See also: setFillColor()
See also: setLineWidth()
See also: addLink()
See also: newLine()
See also: multiCell()
See also: write()
See also: setAutoPageBreak()
public cell ( float $width, float $height, string $text = '', mixed $border, integer $ln, string $align = '', integer $fill, string $link = '' )
$width float Cell width. If 0, the cell extends up to the right margin.
$height float Cell height.
$text string String to print.
$border mixed Indicates if borders must be drawn around the cell. The value can be either a number: - 0: no border (default) - 1: frame or a string containing some or all of the following characters (in any order): - L: left - T: top - R: right - B: bottom
$ln integer Indicates where the current position should go after the call. Possible values are: - 0: to the right (default) - 1: to the beginning of the next line - 2: below Putting 1 is equivalent to putting 0 and calling {@link newLine()} just after.
$align string Allows to center or align the text. Possible values are: - L or empty string: left (default) - C: center - R: right
$fill integer Indicates if the cell fill type. Possible values are: - 0: transparent (default) - 1: painted
$link string URL or identifier returned by {@link addLink()}.

circle() public method

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).
public circle ( float $x, float $y, float $r, string $style = '' )
$x float Abscissa of the center of the circle.
$y float Ordinate of the center of the circle.
$r float Circle radius.
$style string Style of rendering. Possible values are: - D or empty string: draw (default) - F: fill - DF or FD: draw and fill

close() public method

If the document contains no page, {@link addPage()} is called to prevent from getting an invalid document.
See also: open()
public close ( )

flush() public method

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 also: getOutput()
public flush ( )

getDefaultOrientation() public method

P (portrait) or L (landscape)
public getDefaultOrientation ( ) : string
return string

getDrawColor() public method

Get the draw color
public getDrawColor ( ) : string
return string

getFillColor() public method

Get the fill color
public getFillColor ( ) : string
return string

getFormatHeight() public method

public getFormatHeight ( ) : float
return float

getFormatWidth() public method

public getFormatWidth ( ) : float
return float

getOutput() public method

Returns the raw Pdf file.
See also: flush()
public getOutput ( )

getPage() public method

Get the current page
public getPage ( ) : integer
return integer

getPageHeight() public method

Returns the actual page height.
public getPageHeight ( ) : float
return float The page height.

getPageNo() public method

Returns the current page number.
See also: aliasNbPages()
public getPageNo ( ) : integer
return integer

getPageWidth() public method

Returns the actual page width.
public getPageWidth ( ) : float
return float The page width.

getScale() public method

public getScale ( ) : integer
return integer

getStringWidth() public method

Returns the length of a text string. A font must be selected.
public getStringWidth ( string $text, boolean $pt = false ) : float
$text string The text whose length is to be computed.
$pt boolean Whether the width should be returned in points or user units.
return float

getTextColor() public method

Get the text color
public getTextColor ( ) : string
return string

getX() public method

Returns the abscissa of the current position in user units.
See also: setX()
See also: getY()
See also: setY()
public getX ( ) : float
return float

getY() public method

Returns the ordinate of the current position in user units.
See also: setY()
See also: getX()
See also: setX()
public getY ( ) : float
return float

header() public method

It is automatically called by {@link 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 also: footer()
public header ( )

image() public method

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.
See also: addLink()
public image ( string $file, float $x, float $y, float $width, float $height, string $type = '', mixed $link = '' )
$file string Name of the file containing the image.
$x float Abscissa of the upper-left corner.
$y float Ordinate of the upper-left corner.
$width float Width of the image in the page. If equal to zero, it is automatically calculated to keep the original proportions.
$height float Height of the image in the page. If not specified or equal to zero, it is automatically calculated to keep the original proportions.
$type string Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
$link mixed URL or identifier returned by {@link addLink()}.

line() public method

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).
See also: setLineWidth()
See also: setDrawColor()
public line ( float $x1, float $y1, float $x2, float $y2 )
$x1 float Abscissa of first point.
$y1 float Ordinate of first point.
$x2 float Abscissa of second point.
$y2 float Ordinate of second point.

multiCell() public method

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.
See also: setFont()
See also: setDrawColor()
See also: setFillColor()
See also: setLineWidth()
See also: cell()
See also: write()
See also: setAutoPageBreak()
public multiCell ( float $width, float $height, string $text, mixed $border, string $align = 'J', integer $fill )
$width float Width of cells. If 0, they extend up to the right margin of the page.
$height float Height of cells.
$text string String to print.
$border mixed Indicates if borders must be drawn around the cell block. The value can be either a number: - 0: no border (default) - 1: frame or a string containing some or all of the following characters (in any order): - L: left - T: top - R: right - B: bottom
$align string Sets the text alignment. Possible values are: - L: left alignment - C: center - R: right alignment - J: justification (default value)
$fill integer Indicates if the cell background must: - 0: transparent (default) - 1: painted

newLine() public method

The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
See also: cell()
public newLine ( float $height = '' )
$height float The height of the break. By default, the value equals the height of the last printed cell.

open() public method

No page is created by this method, therefore it is necessary to call {@link addPage()}.
See also: addPage()
See also: close()
public open ( )

rect() public method

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).
See also: setLineWidth()
See also: setDrawColor()
See also: setFillColor()
public rect ( float $x, float $y, float $width, float $height, float $style = '' )
$x float Abscissa of upper-left corner.
$y float Ordinate of upper-left corner.
$width float Width.
$height float Height.
$style float Style of rendering. Possible values are: - D or empty string: draw (default) - F: fill - DF or FD: draw and fill

save() public method

Saves the PDF file on the filesystem.
public save ( string $filename = 'unknown.pdf' )
$filename string The filename for the output file.

setAutoPageBreak() public method

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.
public setAutoPageBreak ( boolean $auto, float $margin )
$auto boolean Boolean indicating if mode should be on or off.
$margin float Distance from the bottom of the page.

setCompression() public method

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 {@link http://www.php.net/zlib/ zlib extension} is required for this feature. If not present, compression will be turned off.
public setCompression ( boolean $compress )
$compress boolean Boolean indicating if compression must be enabled or not.

setDisplayMode() public method

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.
public setDisplayMode ( mixed $zoom, $layout = 'continuous' )
$zoom mixed The zoom to use. It can be one of the following string values: - fullpage: entire page on screen - fullwidth: maximum width of window - real: uses real size (100% zoom) - default: uses viewer default mode or a number indicating the zooming factor.

setDrawColor() public method

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.
See also: setFillColor()
See also: line()
See also: rect()
See also: cell()
See also: multiCell()
public setDrawColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )
$cs string Indicates the colorspace which can be either 'rgb', 'hex', 'cmyk' or 'gray'. Defaults to 'rgb'.
$c1 float First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
$c2 float Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c3 float Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c4 float Fourth color component, floating point value between 0 and 1. Required for cmyk.

setFillColor() public method

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.
See also: setTextColor()
See also: setDrawColor()
See also: rect()
See also: cell()
See also: multiCell()
public setFillColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )
$cs string Indicates the colorspace which can be either 'rgb', 'hex', 'cmyk', or 'gray'. Defaults to 'rgb'.
$c1 float First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
$c2 float Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c3 float Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c4 float Fourth color component, floating point value between 0 and 1. Required for cmyk.

setFont() public method

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 {@link 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 {@link setFontSize()}.
See also: addFont()
See also: setFontSize()
See also: cell()
See also: multiCell()
See also: write()
public setFont ( string $family, string $style = '', integer $size = null, boolean $force = false )
$family string Family font. It can be either a name defined by {@link addFont()} or one of the standard families (case insensitive): - Courier (fixed-width) - Helvetica or Arial (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 string Font style. Possible values are (case insensitive): - empty string: regular - B: bold - I: italic - U: underline or any combination. Bold and italic styles do not apply to Symbol and ZapfDingbats.
$size integer 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.
$force boolean Force the setting of the font. Each new page will require a new call to {@link setFont()} and setting this to true will make sure that the checks for same font calls will be skipped.

setFontSize() public method

Defines the size of the current font.
See also: setFont()
public setFontSize ( float $size )
$size float The size (in points).

setFontStyle() public method

Defines the style of the current font.
See also: setFont()
public setFontStyle ( string $style )
$style string The font style.

setInfo() public method

Possible info settings are: - title - subject - author - keywords - creator
public setInfo ( array | string $info, string $value = '' )
$info array | string If passed as an array then the complete hash containing the info to be inserted into the document. Otherwise the name of setting to be set.
$value string The value of the setting.

setLeftMargin() public method

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.
See also: setAutoPageBreak()
See also: setMargins()
See also: setRightMargin()
See also: setTopMargin()
public setLeftMargin ( float $margin )
$margin float The margin.

setLineWidth() public method

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.
See also: line()
See also: rect()
See also: cell()
See also: multiCell()
public setLineWidth ( float $width )
$width float The width.

setMargins() public method

By default, they equal 1 cm. Call this method to change them.
See also: setAutoPageBreak()
See also: setLeftMargin()
See also: setRightMargin()
See also: setTopMargin()
public setMargins ( float $left, float $top, float $right = null )
$left float Left margin.
$top float Top margin.
$right float Right margin. If not specified default to the value of the left one.

setPage() public method

Set the current page
public setPage ( integer $page )
$page integer

setRightMargin() public method

The method can be called before creating the first page.
public setRightMargin ( float $margin )
$margin float The margin.

setTextColor() public method

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.
See also: setFillColor()
See also: setDrawColor()
See also: rect()
See also: cell()
See also: multiCell()
public setTextColor ( string $cs = 'rgb', float $c1, float $c2, float $c3, float $c4 )
$cs string Indicates the colorspace which can be either 'rgb', 'hex', 'cmyk' or 'gray'. Defaults to 'rgb'.
$c1 float First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
$c2 float Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c3 float Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
$c4 float Fourth color component, floating point value between 0 and 1. Required for cmyk.

setTopMargin() public method

The method can be called before creating the first page.
public setTopMargin ( float $margin )
$margin float The margin.

setX() public method

If the passed value is negative, it is relative to the right of the page.
See also: getX()
See also: getY()
See also: setY()
See also: setXY()
public setX ( float $x )
$x float The value of the abscissa.

setXY() public method

If the passed values are negative, they are relative respectively to the right and bottom of the page.
See also: setX()
See also: setY()
public setXY ( float $x, float $y )
$x float The value of the abscissa.
$y float The value of the ordinate.

setY() public method

If the passed value is negative, it is relative to the bottom of the page.
See also: getX()
See also: getY()
See also: setY()
See also: setXY()
public setY ( float $y )
$y float The value of the ordinate.

text() public method

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 {@link cell()}, {@link multiCell()} or {@link 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).
See also: setFont()
See also: cell()
See also: multiCell()
See also: write()
public text ( float $x, float $y, string $text )
$x float Abscissa of the origin.
$y float Ordinate of the origin.
$text string String to print.

write() public method

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');
See also: setFont()
See also: addLink()
See also: multiCell()
See also: setAutoPageBreak()
public write ( float $height, string $text, mixed $link = '' )
$height float Line height.
$text string String to print.
$link mixed URL or identifier returned by {@link addLink()}.

writeRotated() public method

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).
See also: setFont()
public writeRotated ( integer $x, integer $y, string $text, float $text_angle, float $font_angle )
$x integer X coordinate.
$y integer Y coordinate.
$text string Text to write.
$text_angle float Angle to rotate (Eg. 90 = bottom to top).
$font_angle float Rotate characters as well as text.

Property Details

$_alias_nb_pages protected_oe property

Alias for total number of pages.
protected string $_alias_nb_pages
return string

$_auto_page_break protected_oe property

Automatic page breaking.
protected bool $_auto_page_break
return boolean

$_break_margin protected_oe property

Break page margin size, the bottom margin which triggers a page break.
protected float $_break_margin
return float

$_buffer protected_oe property

Buffer holding in-memory Pdf.
protected string $_buffer
return string

$_buflen protected_oe property

Buffer length, including already flushed content.
protected int $_buflen
return integer

$_cell_margin protected_oe property

Cell margin size.
protected float $_cell_margin
return float

$_color_flag protected_oe property

Whether text color is different from fill color.
protected bool $_color_flag
return boolean

$_compress protected_oe property

Flag indicating if PDF file is to be compressed or not.
protected bool $_compress
return boolean

$_core_fonts protected_oe property

An array of standard font names.
protected array $_core_fonts
return array

$_current_font protected_oe property

An array containing current font info.
protected array $_current_font
return array

$_current_orientation protected_oe property

The current page orientation.
protected string $_current_orientation
return string

$_default_orientation protected_oe property

The default page orientation.
protected string $_default_orientation
return string

$_diffs protected_oe property

An array of encoding differences.
protected array $_diffs
return array

$_draw_color protected_oe property

Commands for drawing color.
protected string $_draw_color
return string

$_fill_color protected_oe property

Commands for filling color.
protected string $_fill_color
return string

$_flushed protected_oe property

Whether the buffer has been flushed already.
protected bool $_flushed
return boolean

$_font_family protected_oe property

Current font family.
protected string $_font_family
return string

$_font_files protected_oe property

An array of font files.
protected array $_font_files
return array

$_font_size protected_oe property

Current font size in user units.
protected float $_font_size
return float

$_font_size_pt protected_oe property

Current font size in points.
protected float $_font_size_pt
return float

$_font_style protected_oe property

Current font style.
protected string $_font_style
return string

$_font_widths protected_oe static_oe property

Widths of specific font files
protected static array $_font_widths
return array

$_fonts protected_oe property

An array of used fonts.
protected array $_fonts
return array

$_images protected_oe property

An array of used images.
protected array $_images
return array

$_info protected_oe property

An array containing the document info, consisting of: - title - subject - author - keywords - creator
protected array $_info
return array

$_last_height protected_oe property

The height of the last cell printed.
protected float $_last_height
return float

$_layout_mode protected_oe property

Layout display mode.
protected string $_layout_mode
return string

$_left_margin protected_oe property

Left page margin size.
protected float $_left_margin
return float

$_line_width protected_oe property

Line width in user units.
protected float $_line_width
return float

$_n protected_oe property

Current object number.
protected int $_n
return integer

$_offsets protected_oe property

Array of object offsets.
protected array $_offsets
return array

$_orientation_changes protected_oe property

Array indicating orientation changes.
protected array $_orientation_changes
return array

$_page protected_oe property

Current page number.
protected int $_page
return integer

$_page_break_trigger protected_oe property

Threshold used to trigger page breaks.
protected float $_page_break_trigger
return float

$_pages protected_oe property

Array containing the pages.
protected array $_pages
return array

$_right_margin protected_oe property

Right page margin size.
protected float $_right_margin
return float

$_scale protected_oe property

Scale factor (number of points in user units).
protected float $_scale
return float

$_state protected_oe property

Current document state.
  0 - initial state
  1 - document opened
  2 - page opened
  3 - document closed
protected int $_state
return integer

$_text_color protected_oe property

Commands for text color.
protected string $_text_color
return string

$_top_margin protected_oe property

Top page margin size.
protected float $_top_margin
return float

$_underline protected_oe property

Underlining flag.
protected bool $_underline
return boolean

$_word_spacing protected_oe property

Word spacing.
protected int $_word_spacing
return integer

$_zoom_mode protected_oe property

Zoom display mode.
protected string $_zoom_mode
return string

$fh public_oe property

Current height of page format in user units.
public float $fh
return float

$fhPt public_oe property

Current height of page format in points.
public float $fhPt
return float

$fw public_oe property

Current width of page format in user units.
public float $fw
return float

$fwPt public_oe property

Current width of page format in points.
public float $fwPt
return float

$h public_oe property

Current height of page in user units
public float $h
return float

$hPt public_oe property

Current height of page in points.
public float $hPt
return float

$w public_oe property

Current width of page in user units
public float $w
return float

$wPt public_oe property

Current width of page in points.
public float $wPt
return float

$x public_oe property

Value is set in user units and is calculated from the top left corner as origin.
public float $x
return float

$y public_oe property

Value is set in user units and is calculated from the top left corner as origin.
public float $y
return float