Class XPDF - Stefanius67/XFPDF GitHub Wiki

Full name:     \SKien\XFPDF\XPDF
Parent class:    \OPlathey\FPDF\FPDF

Supports:

• Page Header/Footer including Logo
• Colheaders
• Totals, Subtotals, Pagetotals and Carry over
• Use defined fonts, colors and stripped datarows
• Specify print format with JSOn template file

class constructor.

public XPDF::__construct(string $orientation = 'P', string $unit = 'mm', string|array $size = 'A4')

allows to set up the page size, the orientation and the unit of measure used in all methods (except for font sizes).

Parameters:

See Also:

• \OPlathey\FPDF\FPDF::__construct()

[go to top]

Add Column to the Grid.

public XPDF::addCol(string $strColHeader, float $fltWidth, string $strAlign, string|int $strField, int $wFlags) : int

String is directly mapped to field in datarow, number is requested through Col() method

Parameters:

Return Type: int

Index of the inserted col

[go to top]

public XPDF::convText(string $strText) : string

Parameters:

Return Type: string

[go to top]

Last step: create the document.

public XPDF::createPDF(string $strFilename = '') : void

If nor filename is given, the title set with SetInfo() or SetTitle() method is used (or 'XFPDF.pdf' if no title set so far). If the filename not ending with .pdf (case insensitive), the extension ist appended.

Parameters:

[go to top]

Enables automatic calclation of totals.

public XPDF::enableTotals(int $iTotals = self::TOTALS) : void

• totals over all at end of grid (self::TOTALS)
• subtotals at end of each page (self::PAGE_TOTALS)
• carry over at beginning of new page (self::CARRY_OVER)

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Mark the end of the grid.

public XPDF::endGrid() : void

If totals enabled, total row will be printed.

[go to top]

End group and print subtotals row.

public XPDF::endGroup() : void

[go to top]

Print pagefooter.

public XPDF::footer() : void

{@inheritDoc}

See Also:

• \OPlathey\FPDF\FPDF::footer()

[go to top]

Print pageheader / logo / colheaders.

public XPDF::header() : void

{@inheritDoc}

See Also:

• \OPlathey\FPDF\FPDF::header()

[go to top]

Initialisation of grid.

public XPDF::initGrid(string $strFilename) : void

• fonts
• colors
• totals/subtotals/carry over text
• charset
• formating

Parameters:

[go to top]

Have to be called once before datarows be added to the document.

public XPDF::prepare() : void

[go to top]

reset coldefinitions

public XPDF::resetCols() : void

[go to top]

Build row.

public XPDF::row(array $row) : void

If fieldname specified in AddCol(), directly the value from the associative array is inserted (in case of DATE-Field value is formated d.m.Y) all other columns are requested through GetCol() - method

Parameters:

[go to top]

Set color for drawing.

public XPDF::selectDrawColor(string $strColor) : void

Parameters:

[go to top]

Set fillcolor.

public XPDF::selectFillColor(string $strColor) : void

Parameters:

[go to top]

Selects given font.

public XPDF::selectFont(\SKien\XFPDF\XPDFFont $font) : void

Parameters:

[go to top]

Set color for text.

public XPDF::selectTextColor(string $strColor) : void

Parameters:

[go to top]

Set colors for text and drawing in the colheader.

public XPDF::setColHeaderColors(string $strTextColor, string $strFillColor) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for col headers.

public XPDF::setColHeaderFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set infos for image col.

public XPDF::setColImageInfo(int $iCol, float $fltTop, float $fltLeft, float $fltHeight = -1, float $fltWidth = -1) : void

Set the margin from the top left corner of the cell and the height/width of the image.

• If no height and width specified, the image is printed in its origin size
• If only one of both is specified, the image is scaled and the aspect ratio is retained

Parameters:

[go to top]

Set the Date Format to use.

public XPDF::setDateFormat(int|string $format) : void

Date values are formatet using the language set by setLocale().

The $format parameter can either be one of the IntlDateFormatter int Constants

or a string pattern following the definition of IntlDateFormatter (see link below)

Pattern to Format Date and Time

Note: This property can also be set in the JSON file used in initGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()
• https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax

[go to top]

Set the DateTime Format to use.

public XPDF::setDateTimeFormat(int|string $formatD, int $formatT) : void

You can either set the $formatD and $formatT parameter to one of the IntlDateFormatter int Constants (see setDateFormat, setTimeFormat) or set a string pattern following the definition of IntlDateFormatter as first parameter (see link below).

Note: This property can also be set in the JSON file used in initGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::setDateFormat()
• \SKien\XFPDF\XPDF::setTimeFormat()
• \SKien\XFPDF\XPDF::initGrid()
• https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax

[go to top]

Set colors for text and drawing in the pagefooter.

public XPDF::setFooterColors(string $strTextColor, string $strDrawColor) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for page footer.

public XPDF::setFooterFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set colors for text and drawing in the pageheader.

public XPDF::setHeaderColors(string $strTextColor, string $strDrawColor) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for page header.

public XPDF::setHeaderFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set information for document to create.

public XPDF::setInfo(string $strTitle, string $strSubject = '', string $strAuthor = '', string $strKeywords = '', bool $isUTF8 = true) : void

Parameters:

[go to top]

Set lineheight.

public XPDF::setLineHeight(float $fltLineHeight) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set locale for formating.

public XPDF::setLocale(string $strLocale) : void

If $strLocale is an comma separated list each value is tried to be set as new locale until success.
Example: "de_DE.utf8, de_DE, de, DE"

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()
• http://www.php.net/manual/en/function.setlocale.php

[go to top]

Set logo printed in the document header.

public XPDF::setLogo(string $strLogo) : void

The logo is printed right-aligned in the header, and by default, the logo will be scaled to a height of 8mm. Another height can be set with XPDF::setLogoHeight().
For convinience, the loge can be set directly within XPDF::setPageHeader().

Parameters:

See Also:

• \SKien\XFPDF\XPDF::setLogoHeight()
• \SKien\XFPDF\XPDF::setPageHeader()

[go to top]

Set height of the logo in the document header.

public XPDF::setLogoHeight(float $fltLogoHeight) : void

Parameters:

[go to top]

Set format for numbers.

public XPDF::setNumberFormat(int $iDecimals, string $strPrefix = '', string $strSuffix = '') : void

Decimal point and thousands separator from locale settings is used if available.

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set the pagefooter of the document.

public XPDF::setPageFooter(string $strFooter) : void

Parameters:

[go to top]

Set the pageheader of the document.

public XPDF::setPageHeader(string $strTitle, string $strHeaderSubject = '', string $strLogo = '') : void

The title is printed in the left of the pageheader using the font set with XPDF:SetHeaderFont()
Optional the subject and/or the logo can be set. Subject and logo can also be set using XPDF:SetSubject() and XPDF:SetLogo()
The page header is separated from the report by a double line.

Parameters:

See Also:

• XPDF:SetHeaderFont()
• XPDF:SetSubject()
• XPDF:SetLogo()

[go to top]

Set the subject in the pageheader of the document.

public XPDF::setPageSubject(string $strPageSubject) : void

The subject is printed in the left of the pageheader in the 2'nd line using the font set with XPDF:SetSubjectFont()

Parameters:

See Also:

• XPDF:SetSubjectFont()

[go to top]

Set colors for text and drawing in the grid.

public XPDF::setRowColors(string $strTextColor, string $strDrawColor, string $strFillColor, bool $bStripped = true) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for data rows.

public XPDF::setRowFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for sub headers.

public XPDF::setSubHeaderFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set font for subject in the page header.

public XPDF::setSubjectFont(string $strFontname, string $strStyle, int $iSize) : void

!! Can be controled/overwritten through JSON-Format in InitGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Set the Time Format to use.

public XPDF::setTimeFormat(int|string $format) : void

The $format parameter can either be one of the IntlDateFormatter int Constants

or a string pattern following the definition of IntlDateFormatter (see link below)

Note: This property can also be set in the JSON file used in initGrid() !!

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()
• https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax

[go to top]

Set text for totals, subtotals and carry over row.

public XPDF::setTotalsText(string $strTotals, string $strPageTotals = '', string $strCarryOver = '') : void

Following placeholders will be replaced:

• {PN} -> current page
• {PN-1} -> previous page

Parameters:

See Also:

• \SKien\XFPDF\XPDF::initGrid()

[go to top]

Starts group for new subtotals.

public XPDF::startGroup(string $strTotals, string $strHeader = null) : void

Reset calculated subtotals and print subheader if strHeader is set

Parameters:

[go to top]

Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.

public FPDF::acceptPageBreak() : bool

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.

For usage in derived classes see example at http://www.fpdf.org/en/doc/acceptpagebreak.htm.

Return Type: bool

See Also:

• http://www.fpdf.org/en/doc/acceptpagebreak.htm

[go to top]

Imports a TrueType, OpenType or Type1 font and makes it available.

public FPDF::addFont(string $family, string $style = '', string $file = '') : void

It is necessary to generate a font definition file first with the MakeFont utility. The definition file (and the font file itself when embedding) must be present in the font directory. If it is not found, the error "Could not include font definition file" is raised.

Parameters:

[go to top]

Creates a new internal link and returns its identifier.

public FPDF::addLink() : int

An internal link is a clickable area which directs to another place within the document. The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().

Return Type: int

[go to top]

Adds a new page to the document.

public FPDF::addPage(string $orientation = '', string|array $size = '', int $rotation) : void

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 Y-position system is at the top-left corner and increasing Y-positions go downwards.

Parameters:

[go to top]

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

public FPDF::aliasNbPages(string $alias = '{nb}') : void

Parameters:

[go to top]

Set bookmark at current position.

public FPDF::bookmark(string $txt, bool $isUTF8 = true, int $level, int $y) : void

from FPDF.org extension to create Bookmarks

Parameters:

[go to top]

Prints a cell (rectangular area) with optional borders, background color and character string.

public FPDF::cell(float $w, float $h, string $txt = '', int|string $border, float $ln, string $align = '', bool $fill = false, string|int $link = '') : void

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:

[go to top]

Terminates the PDF document.

public FPDF::close() : void

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.

[go to top]

This method is automatically called in case of a fatal error.

public FPDF::error(string $msg) : void

It simply throws an exception with the provided message. An inherited class may override it to customize the error handling but the method should never return, otherwise the resulting document would probably be invalid.

Parameters:

[go to top]

This method is used to render the page footer.

public FPDF::footer() : void

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

[go to top]

Get the trigger for autopagebreak

public FPDF::getPageBreakTrigger() : float

Return Type: float

[go to top]

Get current page height.

public FPDF::getPageHeight() : float

Return Type: float

[go to top]

Get current page width.

public FPDF::getPageWidth() : float

Return Type: float

[go to top]

Returns the length of a string in user unit for current Font.

public FPDF::getStringWidth(string $s) : float

A font must be selected.

Parameters:

Return Type: float

[go to top]

Get current x position.

public FPDF::getX() : float

Return Type: float

[go to top]

Get current Y position.

public FPDF::getY() : float

Return Type: float

[go to top]

This method is used to render the page header.

public FPDF::header() : void

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

[go to top]

Puts an image.

public FPDF::image(string $file, float $x = null, float $y = null, float $w, float $h, string $type = '', string|int $link = '') : void

The size it will take on the page can be specified in different ways:

• explicit width and height (expressed in user unit or dpi)
• one explicit dimension, the other being calculated automatically in order to keep the original proportions
• no explicit dimension, in which case the image is put at 96 dpi

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

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

Parameters:

[go to top]

Draws a line between two points.

public FPDF::line(float $x1, float $y1, float $x2, float $y2) : void

The X/Y-positions refer to the top left corner of the page. Set margins are NOT taken into account.

Parameters:

[go to top]

Puts a link on a rectangular area of the page.

public FPDF::link(float $x, float $y, float $w, float $h, string|int $link) : void

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. Target can be an external URL or an internal link ID created and specified by AddLink()/SetLink()

Parameters:

[go to top]

Performs a line break.

public FPDF::ln(float $h = null) : void

The current X-position goes back to the left margin and the Y-position increases by the amount passed in parameter.

Parameters:

[go to top]

This method allows printing text with line breaks.

public FPDF::multiCell(float $w, float $h, string $txt, int|string $border, string $align = 'J', bool $fill = false) : void

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:

[go to top]

Send the document to a given destination: browser, file or string.

public FPDF::output(string $dest = '', string $name = '', bool $isUTF8 = true) : string

In the case of a browser, the PDF viewer may be used or a download may be forced. The method first calls Close() if necessary to terminate the document.

Parameters:

Return Type: string

[go to top]

Returns the current page number.

public FPDF::pageNo() : int

Return Type: int

[go to top]

Outputs a rectangle.

public FPDF::rect(float $x, float $y, float $w, float $h, string $style = '') : void

It can be drawn (border only), filled (with no border) or both. The X/Y-position refer to the top left corner of the page. Set margins are NOT taken into account.

Parameters:

[go to top]

Defines the author of the document.

public FPDF::setAuthor(string $author, bool $isUTF8 = true) : void

Parameters:

[go to top]

Enables or disables the automatic page breaking mode.

public FPDF::setAutoPageBreak(bool $auto, float $margin) : void

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:

[go to top]

Activates or deactivates page compression.

public FPDF::setCompression(bool $compress) : void

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:

[go to top]

Defines the creator of the document. This is typically the name of the application that generates the PDF.

public FPDF::setCreator(string $creator, bool $isUTF8 = true) : void

Parameters:

[go to top]

Defines the way the document is to be displayed by the viewer.

public FPDF::setDisplayMode(string|float $zoom, string $layout = 'default') : void

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

• single at once
• continuous display
• two columns
• or viewer default.

Parameters:

[go to top]

Defines the color used for all drawing operations (lines, rectangles and cell borders).

public FPDF::setDrawColor(int $r, int $g = null, int $b = null) : void

It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

Parameters:

[go to top]

Defines the color used for all filling operations (filled rectangles and cell backgrounds).

public FPDF::setFillColor(int $r, int $g = null, int $b = null) : void

It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

Parameters:

[go to top]

Sets the font used to print character strings.

public FPDF::setFont(string $family, string $style = '', float $size) : void

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 the Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is kept from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize().

Note:
the font definition files must be accessible. They are searched successively in:

• The directory defined by the FPDF_FONTPATH constant (if this constant is defined)
• The 'font' directory located in the same directory as fpdf.php (if it exists)
• The directories accessible through include()

Parameters:

[go to top]

Defines the size of the current font.

public FPDF::setFontSize(float $size) : void

Parameters:

[go to top]

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

public FPDF::setKeywords(string $keywords, bool $isUTF8 = true) : void

Parameters:

[go to top]

Defines the left margin.

public FPDF::setLeftMargin(float $margin) : void

The method can be called before creating the first page. If the current X-position gets out of page, it is brought back to the margin.

Parameters:

[go to top]

Defines the line width.

public FPDF::setLineWidth(float $width) : void

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:

[go to top]

Defines the page and position a link points to.

public FPDF::setLink(int $link, float $y, int $page = -1) : void

Parameters:

[go to top]

Defines the left, top and right margins.

public FPDF::setMargins(float $left, float $top, float $right = null) : void

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

Parameters:

[go to top]

Defines the right margin.

public FPDF::setRightMargin(float $margin) : void

The method can be called before creating the first page.

Parameters:

[go to top]

Defines the subject of the document.

public FPDF::setSubject(string $subject, bool $isUTF8 = true) : void

Parameters:

[go to top]

Defines the color used for text.

public FPDF::setTextColor(int $r, int $g = null, int $b = null) : void

It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

Parameters:

[go to top]

Defines the title of the document.

public FPDF::setTitle(string $title, bool $isUTF8 = true) : void

Parameters:

[go to top]

Defines the top margin.

public FPDF::setTopMargin(float $margin) : void

The method can be called before creating the first page.

Parameters:

[go to top]

Set new X position.

public FPDF::setX(float $x) : void

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

Parameters:

[go to top]

Set new X and Y position.

public FPDF::setXY(float $x, float $y) : void

If the passed values are negative, they are relative respectively to the right and bottom of the page.

Parameters:

[go to top]

Set new Y position and optionally moves the current X-position back to the left margin.

public FPDF::setY(float $y, bool $resetX = true) : void

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

Parameters:

[go to top]

Prints a character string.

public FPDF::text(float $x, float $y, string $txt) : void

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.

Parameters:

[go to top]

This method prints text from the current position.

public FPDF::write(float $h, string $txt, string|int $link = '') : void

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.

Parameters:

[go to top]