apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: File_PDF

Source Location: /File_PDF-0.3.3/PDF.php

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 39]


[ Top ]


Class Variables

$fh =

[line 156]

Current height of page format in user units.

Type:   float


[ Top ]

$fhPt =

[line 142]

Current height of page format in points.

Type:   float


[ Top ]

$fw =

[line 149]

Current width of page format in user units.

Type:   float


[ Top ]

$fwPt =

[line 135]

Current width of page format in points.

Type:   float


[ Top ]

$h =

[line 184]

Current height of page in user units

Type:   float


[ Top ]

$hPt =

[line 170]

Current height of page in points.

Type:   float


[ Top ]

$w =

[line 177]

Current width of page in user units

Type:   float


[ Top ]

$wPt =

[line 163]

Current width of page in points.

Type:   float


[ Top ]

$x =

[line 235]

The current horizontal position for cell positioning.

Value is set in user units and is calculated from the top left corner as origin.


Type:   float


[ Top ]

$y =

[line 244]

The current vertical position for cell positioning.

Value is set in user units and is calculated from the top left corner as origin.


Type:   float


[ Top ]



Method Detail

acceptPageBreak   [line 1789]

boolean 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 setAutoPageBreak().

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

  • See: setAutoPageBreak()

[ Top ]

addFont   [line 1434]

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

The location of the definition file (and the font file itself when embedding) must be found at the full path name included.

Example:

  1.  $pdf->addFont('Comic''I');
  2.  is equivalent to:
  3.  $pdf->addFont('Comic''I''comici.php');

  • See: setFont()

Parameters:

string   $family   —  Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
string   $style   —  Font style. Possible values are (case insensitive):
  • empty string: regular (default)
  • B: bold
  • I: italic
  • BI or IB: bold italic
string   $file   —  The font definition file. By default, the name is built from the family and style, in lower case with no space.

[ Top ]

addLink   [line 1659]

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

  • See: setLink()
  • See: link()
  • See: image()
  • See: write()
  • See: cell()

[ Top ]

addPage   [line 921]

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

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.

  • See: setMargins()
  • See: footer()
  • See: header()

Parameters:

string   $orientation   —  Page orientation. Possible values are (case insensitive):
  • P or Portrait
  • L or Landscape
The default value is the one passed to the constructor.

[ Top ]

aliasNbPages   [line 846]

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

Defines an alias for the total number of pages.

It will be substituted as the document is closed.

Example:

  1.  class My_File_PDF extends File_PDF {
  2.      function footer()
  3.      {
  4.          // Go to 1.5 cm from bottom
  5.          $this->setY(-15);
  6.          // Select Arial italic 8
  7.          $this->setFont('Arial''I'8);
  8.          // Print current and total page numbers
  9.          $this->cell(010'Page ' $this->getPageNo('/{nb}'0,
  10.                      0'C');
  11.      }
  12.  }
  13.  $pdf = My_File_PDF::factory();
  14.  $pdf->aliasNbPages();

  • See: footer()
  • See: getPageNo()

Parameters:

string   $alias   —  The alias.

[ Top ]

cell   [line 1846]

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

  • See: multiCell()
  • See: write()
  • See: setAutoPageBreak()
  • See: newLine()
  • See: addLink()
  • See: setDrawColor()
  • See: setFillColor()
  • See: setLineWidth()
  • See: setFont()

Parameters:

float   $width   —  Cell width. If 0, the cell extends up to the right margin.
float   $height   —  Cell height.
string   $text   —  String to print.
mixed   $border   —  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
integer   $ln   —  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 newLine() just after.
string   $align   —  Allows to center or align the text. Possible values are:
  • L or empty string: left (default)
  • C: center
  • R: right
integer   $fill   —  Indicates if the cell fill type. Possible values are:
  • 0: transparent (default)
  • 1: painted
string   $link   —  URL or identifier returned by addLink().

[ Top ]

circle   [line 1340]

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

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:

float   $x   —  Abscissa of the center of the circle.
float   $y   —  Ordinate of the center of the circle.
float   $r   —  Circle radius.
string   $style   —  Style of rendering. Possible values are:
  • D or empty string: draw (default)
  • F: fill
  • DF or FD: draw and fill

[ Top ]

close   [line 876]

void close( )

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.

  • See: output()
  • See: open()

[ Top ]

factory   [line 497]

void &factory( [array $params = array()], [string $class = 'File_PDF'])

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:

  1.  $pdf = File_PDF::factory(array('orientation' => 'P',
  2.                                 'unit' => 'mm',
  3.                                 'format' => 'A4'));


Parameters:

array   $params   —  A hash with parameters for the created PDF object. Possible parameters are:
    • P or Portrait (default)
      • 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.
        • 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).
        string   $class   —  The concrete class name to return an instance of. Defaults to File_PDF.

        [ Top ]

        flush   [line 2509]

        void flush( )

        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 output() or save() methods, use getOutput() at the end. Calling this method doubles the memory usage during the call.

        • See: getOutput()
        • Since: File_PDF 0.2.0
        • Since: Horde 3.2

        [ Top ]

        footer   [line 1059]

        void footer( )

        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 File_PDF:: is empty, so you have to subclass it and override the method if you want a specific processing.

        Example:

        1.  class My_File_PDF extends File_PDF {
        2.     function footer()
        3.     {
        4.         // Go to 1.5 cm from bottom
        5.         $this->setY(-15);
        6.         // Select Arial italic 8
        7.         $this->setFont('Arial''I'8);
        8.         // Print centered page number
        9.         $this->cell(010'Page ' $this->getPageNo()00'C');
        10.     }
        11.  }

        • See: header()

        [ Top ]

        getOutput   [line 2528]

        void getOutput( )

        Returns the raw PDF file.
        • See: flush()
        • See: output()

        [ Top ]

        getPageHeight   [line 707]

        float getPageHeight( )

        Returns the actual page height.
        • Return: The page height.
        • Since: File_PDF 0.2.0
        • Since: Horde 3.2

        [ Top ]

        getPageNo   [line 1071]

        integer getPageNo( )

        Returns the current page number.
        • See: aliasNbPages()

        [ Top ]

        getPageWidth   [line 694]

        float getPageWidth( )

        Returns the actual page width.
        • Return: The page width.
        • Since: File_PDF 0.2.0
        • Since: Horde 3.2

        [ Top ]

        getStringWidth   [line 1206]

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

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

        Parameters:

        string   $text   —  The text whose length is to be computed.
        boolean   $pt   —  Whether the width should be returned in points or user units.

        [ Top ]

        getX   [line 2412]

        float getX( )

        Returns the abscissa of the current position in user units.
        • See: setY()
        • See: getY()
        • See: setX()

        [ Top ]

        getY   [line 2450]

        float getY( )

        Returns the ordinate of the current position in user units.
        • See: setX()
        • See: getX()
        • See: setY()

        [ Top ]

        header   [line 1029]

        void header( )

        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 File_PDF:: is empty, so you have to subclass it and override the method if you want a specific processing.

        Example:

        1.  class My_File_PDF extends File_PDF {
        2.      function header()
        3.      {
        4.          // Select Arial bold 15
        5.          $this->setFont('Arial''B'15);
        6.          // Move to the right
        7.          $this->cell(80);
        8.          // Framed title
        9.          $this->cell(3010'Title'10'C');
        10.          // Line break
        11.          $this->newLine(20);
        12.      }
        13.  }

        • See: footer()

        [ Top ]

        image   [line 2319]

        void image( string $file, float $x, float $y, [float $width = 0], [float $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.

        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: addLink()

        Parameters:

        string   $file   —  Name of the file containing the image.
        float   $x   —  Abscissa of the upper-left corner.
        float   $y   —  Ordinate of the upper-left corner.
        float   $width   —  Width of the image in the page. If equal to zero, it is automatically calculated to keep the original proportions.
        float   $height   —  Height of the image in the page. If not specified or equal to zero, it is automatically calculated to keep the original proportions.
        string   $type   —  Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
        mixed   $link   —  URL or identifier returned by addLink().

        [ Top ]

        line   [line 1260]

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

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

        • See: setDrawColor()
        • See: setLineWidth()

        Parameters:

        float   $x1   —  Abscissa of first point.
        float   $y1   —  Ordinate of first point.
        float   $x2   —  Abscissa of second point.
        float   $y2   —  Ordinate of second point.

        [ Top ]

        link   [line 1712]

        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 cell(), write() or 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).

        • See: image()
        • See: write()
        • See: cell()
        • See: addLink()

        Parameters:

        float   $x   —  Abscissa of the upper-left corner of the rectangle.
        float   $y   —  Ordinate of the upper-left corner of the rectangle.
        float   $width   —  Width of the rectangle.
        float   $height   —  Height of the rectangle.
        mixed   $link   —  URL or identifier returned by addLink().

        [ Top ]

        multiCell   [line 1976]

        void multiCell( float $width, float $height, string $text, [mixed $border = 0], [string $align = 'J'], [integer $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.

        • See: write()
        • See: setAutoPageBreak()
        • See: cell()
        • See: setLineWidth()
        • See: setDrawColor()
        • See: setFillColor()
        • See: setFont()

        Parameters:

        float   $width   —  Width of cells. If 0, they extend up to the right margin of the page.
        float   $height   —  Height of cells.
        string   $text   —  String to print.
        mixed   $border   —  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
        string   $align   —  Sets the text alignment. Possible values are:
        • L: left alignment
        • C: center
        • R: right alignment
        • J: justification (default value)
        integer   $fill   —  Indicates if the cell background must:
        • 0: transparent (default)
        • 1: painted

        [ Top ]

        newLine   [line 2393]

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

        Performs a line break.

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

        • See: cell()

        Parameters:

        float   $height   —  The height of the break. By default, the value equals the height of the last printed cell.

        [ Top ]

        open   [line 861]

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

        • See: close()
        • See: addPage()

        [ Top ]

        output   [line 2547]

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

        Sends the buffered data to the browser.

        Parameters:

        string   $filename   —  The filename for the output file.
        boolean   $inline   —  True if inline, false if attachment.

        [ Top ]

        raiseError   [line 609]

        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:

        mixed   $error   —  The error message.

        [ Top ]

        rect   [line 1299]

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

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

        • See: setFillColor()
        • See: setDrawColor()
        • See: setLineWidth()

        Parameters:

        float   $x   —  Abscissa of upper-left corner.
        float   $y   —  Ordinate of upper-left corner.
        float   $width   —  Width.
        float   $height   —  Height.
        float   $style   —  Style of rendering. Possible values are:
        • D or empty string: draw (default)
        • F: fill
        • DF or FD: draw and fill

        [ Top ]

        save   [line 2586]

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

        Saves the PDF file on the filesystem.

        Parameters:

        string   $filename   —  The filename for the output file.

        [ Top ]

        setAutoPageBreak   [line 722]

        void setAutoPageBreak( boolean $auto, [float $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:

        boolean   $auto   —  Boolean indicating if mode should be on or off.
        float   $margin   —  Distance from the bottom of the page.

        [ Top ]

        setCompression   [line 787]

        void setCompression( boolean $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:

        boolean   $compress   —  Boolean indicating if compression must be enabled or not.

        [ Top ]

        setDisplayMode   [line 753]

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

        mixed   $zoom   —  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.
        string   $layout   —  layout The page layout. Possible values are:
        • single: one page at once
        • continuous: pages in continuously
        • two: two pages on two columns
        • default: uses viewer default mode
        Default value is continuous.

        [ Top ]

        setDrawColor   [line 1182]

        void setDrawColor( [string $cs = 'rgb'], float $c1, [float $c2 = 0], [float $c3 = 0], [float $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.

        • See: multiCell()
        • See: cell()
        • See: rect()
        • See: line()
        • See: setFillColor()

        Parameters:

        string   $cs   —  Indicates the colorspace which can be either 'rgb', 'cmyk' or 'gray'. Defaults to 'rgb'.
        float   $c1   —  First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
        float   $c2   —  Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c3   —  Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c4   —  Fourth color component, floating point value between 0 and 1. Required for cmyk.

        [ Top ]

        setFillColor   [line 1101]

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

        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.

        • See: multiCell()
        • See: cell()
        • See: rect()
        • See: setDrawColor()
        • See: setTextColor()

        Parameters:

        string   $cs   —  Indicates the colorspace which can be either 'rgb', 'cmyk' or 'gray'. Defaults to 'rgb'.
        float   $c1   —  First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
        float   $c2   —  Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c3   —  Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c4   —  Fourth color component, floating point value between 0 and 1. Required for cmyk.

        [ Top ]

        setFont   [line 1529]

        void setFont( string $family, [string $style = ''], [integer $size = null], [boolean $force = false])

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

        • See: write()
        • See: multiCell()
        • See: cell()
        • See: setFontSize()
        • See: addFont()

        Parameters:

        string   $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 (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.
        string   $style   —  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.
        integer   $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.
        boolean   $force   —  Force the setting of the font. Each new page will require a new call to setFont() and settings this to true will make sure that the checks for same font calls will be skipped.

        [ Top ]

        setFontSize   [line 1612]

        void setFontSize( float $size)

        Defines the size of the current font.
        • See: setFont()

        Parameters:

        float   $size   —  The size (in points).

        [ Top ]

        setFontStyle   [line 1638]

        void setFontStyle( string $style)

        Defines the style of the current font.
        • See: setFont()
        • Since: File_PDF 0.2.0
        • Since: Horde 3.2

        Parameters:

        string   $style   —  The font style.

        [ Top ]

        setInfo   [line 809]

        void setInfo( array|string $info, [string $value = ''])

        Set the info to a document.

        Possible info settings are:

        • title
        • subject
        • author
        • keywords
        • creator


        Parameters:

        array|string   $info   —  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.
        string   $value   —  The value of the setting.

        [ Top ]

        setLeftMargin   [line 652]

        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.

        • See: setTopMargin()
        • See: setRightMargin()
        • See: setMargins()
        • See: setAutoPageBreak()

        Parameters:

        float   $margin   —  The margin.

        [ Top ]

        setLineWidth   [line 1238]

        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.

        • See: multiCell()
        • See: cell()
        • See: rect()
        • See: line()

        Parameters:

        float   $width   —  The width.

        [ Top ]

        setLink   [line 1678]

        void setLink( integer $link, [float $y = 0], [integer $page = -1])

        Defines the page and position a link points to.
        • See: addLink()

        Parameters:

        integer   $link   —  The link identifier returned by addLink().
        float   $y   —  Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page).
        integer   $page   —  Number of target page; -1 indicates the current page.

        [ Top ]

        setMargins   [line 630]

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

        Defines the left, top and right margins.

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

        • See: setTopMargin()
        • See: setRightMargin()
        • See: setLeftMargin()
        • See: setAutoPageBreak()

        Parameters:

        float   $left   —  Left margin.
        float   $top   —  Top margin.
        float   $right   —  Right margin. If not specified default to the value of the left one.

        [ Top ]

        setRightMargin   [line 681]

        void setRightMargin( float $margin)

        Defines the right margin.

        The method can be called before creating the first page.


        Parameters:

        float   $margin   —  The margin.

        [ Top ]

        setTextColor   [line 1144]

        void setTextColor( string $cs, float $c1, [float $c2 = 0], [float $c3 = 0], [float $c4 = 0])

        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.

        • See: cell()
        • See: multiCell()
        • See: rect()
        • See: setDrawColor()
        • See: setFillColor()
        • Since: File_PDF 0.2.0
        • Since: Horde 3.2

        Parameters:

        string   $cs   —  Indicates the colorspace which can be either 'rgb', 'cmyk' or 'gray'. Defaults to 'rgb'.
        float   $c1   —  First color component, floating point value between 0 and 1. Required for gray, rgb and cmyk.
        float   $c2   —  Second color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c3   —  Third color component, floating point value between 0 and 1. Required for rgb and cmyk.
        float   $c4   —  Fourth color component, floating point value between 0 and 1. Required for cmyk.

        [ Top ]

        setTopMargin   [line 669]

        void setTopMargin( float $margin)

        Defines the top margin.

        The method can be called before creating the first page.


        Parameters:

        float   $margin   —  The margin.

        [ Top ]

        setX   [line 2430]

        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.

        • See: setXY()
        • See: setY()
        • See: getY()
        • See: getX()

        Parameters:

        float   $x   —  The value of the abscissa.

        [ Top ]

        setXY   [line 2491]

        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.

        • See: setY()
        • See: setX()

        Parameters:

        float   $x   —  The value of the abscissa.
        float   $y   —  The value of the ordinate.

        [ Top ]

        setY   [line 2468]

        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.

        • See: setXY()
        • See: setY()
        • See: getY()
        • See: getX()

        Parameters:

        float   $y   —  The value of the ordinate.

        [ Top ]

        text   [line 1751]

        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 cell(), multiCell() or 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: write()
        • See: multiCell()
        • See: cell()
        • See: setFont()

        Parameters:

        float   $x   —  Abscissa of the origin.
        float   $y   —  Ordinate of the origin.
        string   $text   —  String to print.

        [ Top ]

        write   [line 2132]

        void write( float $height, string $text, [mixed $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:

        1.  // Begin with regular font
        2.  $pdf->setFont('Arial'''14);
        3.  $pdf->write(5'Visit ');
        4.  // Then put a blue underlined link
        5.  $pdf->setTextColor(00255);
        6.  $pdf->setFont('''U');
        7.  $pdf->write(5'www.fpdf.org''http://www.fpdf.org');

        • See: setAutoPageBreak()
        • See: multiCell()
        • See: addLink()
        • See: setFont()

        Parameters:

        float   $height   —  Line height.
        string   $text   —  String to print.
        mixed   $link   —  URL or identifier returned by addLink().

        [ Top ]

        writeRotated   [line 2239]

        void writeRotated( integer $x, integer $y, string $text, float $text_angle, [float $font_angle = 0])

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

        • See: setFont()

        Parameters:

        integer   $x   —  X coordinate.
        integer   $y   —  Y coordinate.
        string   $text   —  Text to write.
        float   $text_angle   —  Angle to rotate (Eg. 90 = bottom to top).
        float   $font_angle   —  Rotate characters as well as text.

        [ Top ]


        Documentation generated on Mon, 11 Mar 2019 15:44:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.