• Main
• News
• Help
• Forum
• Extensions
• Shop
• Developers

Other package element indexes

• Unknown
• core
• Joomla-Framework
• PHPMailer
• Cache_Lite
• PEAR
• PHP_Compat
• OpenID
• Yadis
• patTemplate
• patError
• utf8
• phpGACL
• Element index (all packages)

_begindoc

TCPDF::_begindoc() in tcpdf.php

Start document

_beginpage

TCPDF::_beginpage() in tcpdf.php

_beginpage

_dochecks

TCPDF::_dochecks() in tcpdf.php

Check for locale-related bug

_dounderline

TCPDF::_dounderline() in tcpdf.php

Underline text

_enddoc

TCPDF::_enddoc() in tcpdf.php

_enddoc

_endpage

TCPDF::_endpage() in tcpdf.php

End of page contents

_escape

TCPDF::_escape() in tcpdf.php

Add \ before \, ( and )

_escapetext

TCPDF::_escapetext() in tcpdf.php

Format a text string

_freadint

TCPDF::_freadint() in tcpdf.php

Read a 4-byte integer from file

_getfontpath

TCPDF::_getfontpath() in tcpdf.php

Return fonts path

_newobj

TCPDF::_newobj() in tcpdf.php

Begin a new object

_out

TCPDF::_out() in tcpdf.php

Add a line to the document

_parsejpg

TCPDF::_parsejpg() in tcpdf.php

Extract info from a JPEG file

_parsepng

TCPDF::_parsepng() in tcpdf.php

Extract info from a PNG file

_putcatalog

TCPDF::_putcatalog() in tcpdf.php

_putcatalog

_putfonts

TCPDF::_putfonts() in tcpdf.php

Adds fonts

_putheader

TCPDF::_putheader() in tcpdf.php

_putheader

_putimages

TCPDF::_putimages() in tcpdf.php

_putimages

_putinfo

TCPDF::_putinfo() in tcpdf.php

_putinfo

_putpages

TCPDF::_putpages() in tcpdf.php

_putpages

_putresourcedict

TCPDF::_putresourcedict() in tcpdf.php

_putresourcedict

_putresources

TCPDF::_putresources() in tcpdf.php

_putresources

_putstream

TCPDF::_putstream() in tcpdf.php

_puttrailer

TCPDF::_puttrailer() in tcpdf.php

_puttrailer

_puttruetypeunicode

TCPDF::_puttruetypeunicode() in tcpdf.php

Adds unicode fonts.

_putxobjectdict

TCPDF::_putxobjectdict() in tcpdf.php

_putxobjectdict

_textstring

TCPDF::_textstring() in tcpdf.php

Format a text string

$AliasNbPages

TCPDF::$AliasNbPages in tcpdf.php

$author

TCPDF::$author in tcpdf.php

$AutoPageBreak

TCPDF::$AutoPageBreak in tcpdf.php

AcceptPageBreak

TCPDF::AcceptPageBreak() in tcpdf.php

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

AddFont

TCPDF::AddFont() in tcpdf.php

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 definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by FPDF_FONTPATH if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.

addHtmlLink

TCPDF::addHtmlLink() in tcpdf.php

Output anchor link.

AddLink

TCPDF::AddLink() in tcpdf.php

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(), Write(), Image() or Link(). The destination is defined with SetLink().

AddPage

TCPDF::AddPage() in tcpdf.php

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.

AliasNbPages

TCPDF::AliasNbPages() in tcpdf.php

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

$bMargin

TCPDF::$bMargin in tcpdf.php

$buffer

TCPDF::$buffer in tcpdf.php

$cMargin

TCPDF::$cMargin in tcpdf.php

$ColorFlag

TCPDF::$ColorFlag in tcpdf.php

$compress

TCPDF::$compress in tcpdf.php

$CoreFonts

TCPDF::$CoreFonts in tcpdf.php

$creator

TCPDF::$creator in tcpdf.php

$CurOrientation

TCPDF::$CurOrientation in tcpdf.php

$CurrentFont

TCPDF::$CurrentFont in tcpdf.php

Cell

TCPDF::Cell() in tcpdf.php

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.

Close

TCPDF::Close() in tcpdf.php

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.

$DefOrientation

TCPDF::$DefOrientation in tcpdf.php

$diffs

TCPDF::$diffs in tcpdf.php

$DrawColor

TCPDF::$DrawColor in tcpdf.php

Error

TCPDF::Error() in tcpdf.php

This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.

eng.php

eng.php in eng.php

$fh

TCPDF::$fh in tcpdf.php

$fhPt

TCPDF::$fhPt in tcpdf.php

$FillColor

TCPDF::$FillColor in tcpdf.php

$FontFamily

TCPDF::$FontFamily in tcpdf.php

$FontFiles

TCPDF::$FontFiles in tcpdf.php

$fonts

TCPDF::$fonts in tcpdf.php

$FontSize

TCPDF::$FontSize in tcpdf.php

$FontSizePt

TCPDF::$FontSizePt in tcpdf.php

$FontStyle

TCPDF::$FontStyle in tcpdf.php

$fw

TCPDF::$fw in tcpdf.php

$fwPt

TCPDF::$fwPt in tcpdf.php

Footer

TCPDF::Footer() in tcpdf.php

This method is used to render the page footer.

FPDF_FONTPATH

FPDF_FONTPATH in tcpdf_config.php

path for PDF fonts

getBreakMargin

TCPDF::getBreakMargin() in tcpdf.php

Returns the page break margin.

getImageScale

TCPDF::getImageScale() in tcpdf.php

Returns the image scale.

getPageHeight

TCPDF::getPageHeight() in tcpdf.php

Returns the page height in units.

getPageWidth

TCPDF::getPageWidth() in tcpdf.php

Returns the page width in units.

getPDFData

TCPDF::getPDFData() in tcpdf.php

Returns the PDF data.

getScaleFactor

TCPDF::getScaleFactor() in tcpdf.php

Returns the scale factor (number of points in user unit).

GetStringWidth

TCPDF::GetStringWidth() in tcpdf.php

Returns the length of a string in user unit. A font must be selected.

GetX

TCPDF::GetX() in tcpdf.php

Returns the abscissa of the current position.

GetY

TCPDF::GetY() in tcpdf.php

Returns the ordinate of the current position.

$h

TCPDF::$h in tcpdf.php

$hPt

TCPDF::$hPt in tcpdf.php

Header

TCPDF::Header() in tcpdf.php

This method is used to render the page header.

HEAD_MAGNIFICATION

HEAD_MAGNIFICATION in tcpdf_config.php

magnification factor for titles

$images

TCPDF::$images in tcpdf.php

$imgscale

TCPDF::$imgscale in tcpdf.php

$img_rb_x

TCPDF::$img_rb_x in tcpdf.php

$img_rb_y

TCPDF::$img_rb_y in tcpdf.php

$InFooter

TCPDF::$InFooter in tcpdf.php

$isunicode

TCPDF::$isunicode in tcpdf.php

Image

TCPDF::Image() in tcpdf.php

Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:

• explicit width and height (expressed in user unit)
• 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 72 dpi

Supported formats are JPEG and PNG.

$k

TCPDF::$k in tcpdf.php

$keywords

TCPDF::$keywords in tcpdf.php

K_BLANK_IMAGE

K_BLANK_IMAGE in tcpdf_config.php

blank image

K_CELL_HEIGHT_RATIO

K_CELL_HEIGHT_RATIO in tcpdf_config.php

height of cell repect font height

K_PATH_CACHE

K_PATH_CACHE in tcpdf_config.php

cache directory for temporary files (full path)

K_PATH_IMAGES

K_PATH_IMAGES in tcpdf_config.php

images directory

K_PATH_MAIN

K_PATH_MAIN in tcpdf_config.php

installation path

K_PATH_URL

K_PATH_URL in tcpdf_config.php

url path

K_PATH_URL_CACHE

K_PATH_URL_CACHE in tcpdf_config.php

cache directory for temporary files (url path)

K_SMALL_RATIO

K_SMALL_RATIO in tcpdf_config.php

reduction factor for small font

K_TITLE_MAGNIFICATION

K_TITLE_MAGNIFICATION in tcpdf_config.php

title magnification respect main font size

$lasth

TCPDF::$lasth in tcpdf.php

$LayoutMode

TCPDF::$LayoutMode in tcpdf.php

$LineWidth

TCPDF::$LineWidth in tcpdf.php

$links

TCPDF::$links in tcpdf.php

$lMargin

TCPDF::$lMargin in tcpdf.php

Line

TCPDF::Line() in tcpdf.php

Draws a line between two points.

Link

TCPDF::Link() in tcpdf.php

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.

Ln

TCPDF::Ln() in tcpdf.php

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

MultiCell

TCPDF::MultiCell() in tcpdf.php

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.

$n

TCPDF::$n in tcpdf.php

$offsets

TCPDF::$offsets in tcpdf.php

$OrientationChanges

TCPDF::$OrientationChanges in tcpdf.php

Open

TCPDF::Open() in tcpdf.php

This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.

Output

TCPDF::Output() in tcpdf.php

Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.

$page

TCPDF::$page in tcpdf.php

$PageBreakTrigger

TCPDF::$PageBreakTrigger in tcpdf.php

$PageLinks

TCPDF::$PageLinks in tcpdf.php

$pages

TCPDF::$pages in tcpdf.php

$PDFVersion

TCPDF::$PDFVersion in tcpdf.php

PageNo

TCPDF::PageNo() in tcpdf.php

Returns the current page number.

PDF_AUTHOR

PDF_AUTHOR in tcpdf_config.php

document author

PDF_CREATOR

PDF_CREATOR in tcpdf_config.php

document creator

PDF_FONT_NAME_DATA

PDF_FONT_NAME_DATA in tcpdf_config.php

data font name

PDF_FONT_NAME_MAIN

PDF_FONT_NAME_MAIN in tcpdf_config.php

main font name

PDF_FONT_SIZE_DATA

PDF_FONT_SIZE_DATA in tcpdf_config.php

data font size

PDF_FONT_SIZE_MAIN

PDF_FONT_SIZE_MAIN in tcpdf_config.php

main font size

PDF_HEADER_LOGO

PDF_HEADER_LOGO in tcpdf_config.php

image logo

PDF_HEADER_LOGO_WIDTH

PDF_HEADER_LOGO_WIDTH in tcpdf_config.php

header logo image width [mm]

PDF_HEADER_STRING

PDF_HEADER_STRING in tcpdf_config.php

header description string

PDF_HEADER_TITLE

PDF_HEADER_TITLE in tcpdf_config.php

header title

PDF_IMAGE_SCALE_RATIO

PDF_IMAGE_SCALE_RATIO in tcpdf_config.php

scale factor for images (number of points in user unit)

PDF_MARGIN_BOTTOM

PDF_MARGIN_BOTTOM in tcpdf_config.php

bottom margin

PDF_MARGIN_FOOTER

PDF_MARGIN_FOOTER in tcpdf_config.php

footer margin

PDF_MARGIN_HEADER

PDF_MARGIN_HEADER in tcpdf_config.php

header margin

PDF_MARGIN_LEFT

PDF_MARGIN_LEFT in tcpdf_config.php

left margin

PDF_MARGIN_RIGHT

PDF_MARGIN_RIGHT in tcpdf_config.php

right margin

PDF_MARGIN_TOP

PDF_MARGIN_TOP in tcpdf_config.php

top margin

PDF_PAGE_FORMAT

PDF_PAGE_FORMAT in tcpdf_config.php

page format

PDF_PAGE_ORIENTATION

PDF_PAGE_ORIENTATION in tcpdf_config.php

page orientation (P=portrait, L=landscape)

PDF_PRODUCER

PDF_PRODUCER in tcpdf.php

define default PDF document producer

PDF_UNIT

PDF_UNIT in tcpdf_config.php

document unit of measure [pt=point, mm=millimeter, cm=centimeter, in=inch]

$rMargin

TCPDF::$rMargin in tcpdf.php

Rect

TCPDF::Rect() in tcpdf.php

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

$state

TCPDF::$state in tcpdf.php

$subject

TCPDF::$subject in tcpdf.php

SetAuthor

TCPDF::SetAuthor() in tcpdf.php

Defines the author of the document.

SetAutoPageBreak

TCPDF::SetAutoPageBreak() in tcpdf.php

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.

setBarcode

TCPDF::setBarcode() in tcpdf.php

Set document barcode.

SetCompression

TCPDF::SetCompression() in tcpdf.php

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.

SetCreator

TCPDF::SetCreator() in tcpdf.php

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

SetDisplayMode

TCPDF::SetDisplayMode() in tcpdf.php

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.

SetDrawColor

TCPDF::SetDrawColor() in tcpdf.php

Defines the color used for all drawing operations (lines, rectangles and cell borders). 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.

SetFillColor

TCPDF::SetFillColor() in tcpdf.php

Defines the color used for all filling operations (filled rectangles and cell backgrounds). 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.

SetFont

TCPDF::SetFont() in tcpdf.php

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.

SetFontSize

TCPDF::SetFontSize() in tcpdf.php

Defines the size of the current font.

setFooterFont

TCPDF::setFooterFont() in tcpdf.php

Set footer font.

setFooterMargin

TCPDF::setFooterMargin() in tcpdf.php

Set footer margin.

setHeaderData

TCPDF::setHeaderData() in tcpdf.php

Set header data.

setHeaderFont

TCPDF::setHeaderFont() in tcpdf.php

Set header font.

setHeaderMargin

TCPDF::setHeaderMargin() in tcpdf.php

Set header margin.

setImageScale

TCPDF::setImageScale() in tcpdf.php

Set the image scale.

SetKeywords

TCPDF::SetKeywords() in tcpdf.php

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

setLanguageArray

TCPDF::setLanguageArray() in tcpdf.php

Set language array.

SetLeftMargin

TCPDF::SetLeftMargin() in tcpdf.php

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.

SetLineWidth

TCPDF::SetLineWidth() in tcpdf.php

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.

SetLink

TCPDF::SetLink() in tcpdf.php

Defines the page and position a link points to

SetMargins

TCPDF::SetMargins() in tcpdf.php

Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.

SetRightMargin

TCPDF::SetRightMargin() in tcpdf.php

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

SetSubject

TCPDF::SetSubject() in tcpdf.php

Defines the subject of the document.

SetTextColor

TCPDF::SetTextColor() in tcpdf.php

Defines the color used for text. 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.

SetTitle

TCPDF::SetTitle() in tcpdf.php

Defines the title of the document.

SetTopMargin

TCPDF::SetTopMargin() in tcpdf.php

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

SetX

TCPDF::SetX() in tcpdf.php

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

SetXY

TCPDF::SetXY() in tcpdf.php

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.

SetY

TCPDF::SetY() in tcpdf.php

Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.

$TextColor

TCPDF::$TextColor in tcpdf.php

$title

TCPDF::$title in tcpdf.php

$tMargin

TCPDF::$tMargin in tcpdf.php

TCPDF

TCPDF in tcpdf.php

This is a PHP4 class for generating PDF files on-the-fly without requiring external extensions.

TCPDF

TCPDF::TCPDF() in tcpdf.php

This is the class constructor.

tcpdf_config.php

tcpdf_config.php in tcpdf_config.php

tcpdf.php

tcpdf.php in tcpdf.php

Text

TCPDF::Text() in tcpdf.php

Prints a character string. The origin is on the left of the first charcter, 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.

$underline

TCPDF::$underline in tcpdf.php

unhtmlentities

TCPDF::unhtmlentities() in tcpdf.php

Reverse function for htmlentities.

unNbsp

TCPDF::unNbsp() in tcpdf.php

UTF8StringToArray

TCPDF::UTF8StringToArray() in tcpdf.php

Converts UTF-8 strings to codepoints array.

UTF8ToUTF16BE

TCPDF::UTF8ToUTF16BE() in tcpdf.php

Converts UTF-8 strings to UTF16-BE.

$w

TCPDF::$w in tcpdf.php

$wPt

TCPDF::$wPt in tcpdf.php

$ws

TCPDF::$ws in tcpdf.php

Write

TCPDF::Write() in tcpdf.php

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.

writeHTML

TCPDF::writeHTML() in tcpdf.php

Allows to preserve some HTML formatting.

writeHTMLCell

TCPDF::writeHTMLCell() in tcpdf.php

Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

$x

TCPDF::$x in tcpdf.php

$y

TCPDF::$y in tcpdf.php

$ZoomMode

TCPDF::$ZoomMode in tcpdf.php