TCPDF
This is a PHP4 class for generating PDF files on-the-fly without requiring external extensions.
This class is an extension and improvement of the FPDF class by Olivier Plathey (http://www.fpdf.org).
This version contains some changes: [porting to PHP4, support for UTF-8 Unicode, code style and formatting, php documentation (www.phpdoc.org), ISO page formats, minor improvements, image scale factor]
TCPDF project (http://tcpdf.sourceforge.net) is based on the public Domain FPDF class by Olivier Plathey (http://www.fpdf.org).
To add your own TTF fonts please read /fonts/README.TXT
Located in /tcpdf/tcpdf.php (line 92)
TCPDF
TCPDF
TCPDF
([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
void
Cell
(float $w, [float $h = 0], [string $txt = ''], [mixed $border = 0], [int $ln = 0], [string $align = ''], [int $fill = 0], [mixed $link = ''])
void
Image
(string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''])
void
MultiCell
(float $w, float $h, string $txt, [mixed $border = 0], [string $align = 'J'], [int $fill = 0])
void
writeHTMLCell
(float $w, float $h, float $x, float $y, [string $html = ''], [mixed $border = 0], [int $ln = 0], [int $fill = 0])
alias
$AliasNbPages
(line 436)
author
$author
(line 418)
automatic
$AutoPageBreak
(line 376)
page
$bMargin
(line 232)
buffer
$buffer
(line 118)
cell
$cMargin
(line 238)
indicates
$ColorFlag
(line 364)
compression
$compress
(line 136)
array
$CoreFonts
(line 268)
creator
$creator
(line 430)
current
$CurOrientation
(line 148)
current
$CurrentFont
(line 328)
default
$DefOrientation
(line 142)
array
$diffs
(line 286)
commands
$DrawColor
(line 346)
height
$fh
(line 184)
height
$fhPt
(line 172)
commands
$FillColor
(line 352)
current
$FontFamily
(line 310)
array
$FontFiles
(line 280)
array
$fonts
(line 274)
current
$FontSize
(line 340)
current
$FontSizePt
(line 334)
current
$FontStyle
(line 316)
width
$fw
(line 178)
width
$fwPt
(line 166)
current
$h
(line 208)
current
$hPt
(line 196)
array
$images
(line 292)
image
$imgscale
= 1 (line 460)
right-bottom
$img_rb_x
(line 444)
right-bottom
$img_rb_y
(line 452)
flag
$InFooter
(line 388)
boolean
$isunicode
= false (line 468)
scale
$k
(line 160)
keywords
$keywords
(line 424)
height
$lasth
(line 256)
layout
$LayoutMode
(line 400)
line
$LineWidth
(line 262)
array
$links
(line 304)
left
$lMargin
(line 214)
current
$n
(line 106)
array
$offsets
(line 112)
array
$OrientationChanges
(line 154)
current
$page
(line 100)
threshold
$PageBreakTrigger
(line 382)
array
$PageLinks
(line 298)
array
$pages
(line 124)
PDF
$PDFVersion
= "1.3" (line 475)
right
$rMargin
(line 226)
current
$state
(line 130)
subject
$subject
(line 412)
commands
$TextColor
(line 358)
title
$title
(line 406)
top
$tMargin
(line 220)
underlining
$underline
(line 322)
current
$w
(line 202)
current
$wPt
(line 190)
word
$ws
(line 370)
current
$x
(line 244)
current
$y
(line 250)
zoom
$ZoomMode
(line 394)
This is the class constructor.
It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
-
string
$orientation: page orientation. Possible values are (case insensitive):
- P or Portrait (default)
- L or Landscape
-
string
$unit: User measure unit. Possible 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. -
mixed
$format: The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).
- 4A0
- 2A0
- A0
- A1
- A2
- A3
- A4 (default)
- A5
- A6
- A7
- A8
- A9
- A10
- B0
- B1
- B2
- B3
- B4
- B5
- B6
- B7
- B8
- B9
- B10
- C0
- C1
- C2
- C3
- C4
- C5
- C6
- C7
- C8
- C9
- C10
- RA0
- RA1
- RA2
- RA3
- RA4
- SRA0
- SRA1
- SRA2
- SRA3
- SRA4
- LETTER
- LEGAL
- EXECUTIVE
- FOLIO
- boolean $unicode: TRUE means that the input text is unicode (default = true)
- String $encoding: charset encoding; default is UTF-8
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.
Example:
The method is overriden in an inherited class in order to obtain a 3 column layout:
class PDF extends TCPDF {
var $col=0;
function SetCol($col) {
//Move position to a column
$this->col=$col;
$x=10+$col*65;
$this->SetLeftMargin($x);
$this->SetX($x);
}
function AcceptPageBreak() {
if($this->col<2) {
//Go to next column
$this->SetCol($this->col+1);
$this->SetY(10);
return false;
}
else {
//Go back to first column and issue page break
$this->SetCol(0);
return true;
}
}
}
$pdf=new PDF();
$pdf->Open();
$pdf->AddPage();
$pdf->SetFont('Arial','',12);
for($i=1;$i<=300;$i++) {
$pdf->Cell(0,5,"Line $i",0,1);
}
$pdf->Output();
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.
Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. Example:
$pdf->AddFont('Comic','I');
// is equivalent to:
$pdf->AddFont('Comic','I','comici.php');
- 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.
Output anchor link.
- string $url: link URL
- string $name: link name
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
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().
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.
-
string
$orientation: Page orientation. Possible values are (case insensitive):
- P or Portrait
- L or Landscape
Defines an alias for the total number of pages. It will be substituted as the document is closed.
Example:
class PDF extends TCPDF {
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->PageNo().'/{nb}',0,0,'C');
}
}
$pdf=new PDF();
$pdf->AliasNbPages();
- string $alias: The alias. Default value: {nb}.
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.
- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell height. Default value: 0.
- string $txt: String to print. Default value: empty string.
-
mixed
$border: Indicates if borders must be drawn around the cell. The value can be either a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
-
int
$ln: Indicates where the current position should go after the call. Possible values are:
- 0: to the right
- 1: to the beginning of the next line
- 2: below
-
string
$align: Allows to center or align the text. Possible values are:
- L or empty string: left align (default value)
- C: center
- R: right align
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
- mixed $link: URL or identifier returned by AddLink().
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.
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.
2004-06-11 :: Nicola Asuni : changed bold tag with strong
- string $msg: The error message
This method is used to render the page footer.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
Returns the scale factor (number of points in user unit).
Returns the length of a string in user unit. A font must be selected.
Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]
- string $s: The string whose length is to be computed
This method is used to render the page header.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
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
For JPEG, all flavors are allowed:
- gray scales
- true colors (24 bits)
- CMYK (32 bits)
- gray scales on at most 8 bits (256 levels)
- indexed colors
- true colors (24 bits)
- Interlacing
- Alpha channel
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.
- 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 $w: Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- float $h: Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- 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().
Draws a line between two points.
- float $x1: Abscissa of first point
- float $y1: Ordinate of first point
- float $x2: Abscissa of second point
- float $y2: Ordinate of second point
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.
- float $x: Abscissa of the upper-left corner of the rectangle
- float $y: Ordinate of the upper-left corner of the rectangle
- float $w: Width of the rectangle
- float $h: Height of the rectangle
- mixed $link: URL or identifier returned by AddLink()
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
- float $h: The height of the break. By default, the value equals the height of the last printed cell.
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.
- float $w: Width of cells. If 0, they extend up to the right margin of the page.
- float $h: Height of cells.
- string $txt: 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
- L: left
- T: top
- R: right
- B: bottom
-
string
$align: Allows to center or align the text. Possible values are:
- L or empty string: left align
- C: center
- R: right align
- J: justification (default value)
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.
Note: no page is created by this method
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.
- string $name: The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.
-
string
$dest: Destination where to send the document. It can take one of the following values:
- I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
- D: send to the browser and force a file download with the name given by name.
- F: save to a local file with the name given by name.
- S: return the document as a string. name is ignored.
Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D).
Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.
- float $x: Abscissa of upper-left corner
- float $y: Ordinate of upper-left corner
- float $w: Width
- float $h: Height
-
string
$style: Style of rendering. Possible values are:
- D or empty string: draw (default)
- F: fill
- DF or FD: draw and fill
Defines the author of the document.
- string $author: The name of the author.
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.
- boolean $auto: Boolean indicating if mode should be on or off.
- float $margin: Distance from the bottom of the page.
Set document barcode.
- string $bc: barcode
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.
- boolean $compress: Boolean indicating if compression must be enabled.
Defines the creator of the document. This is typically the name of the application that generates the PDF.
- string $creator: The name of the creator.
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.
-
mixed
$zoom: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
- fullpage: displays the entire page on screen
- fullwidth: uses maximum width of window
- real: uses real size (equivalent to 100% zoom)
- default: uses viewer default mode
-
string
$layout: The page layout. Possible values are:
- single: displays one page at once
- continuous: displays pages continuously (default)
- two: displays two pages on two columns
- default: uses viewer default mode
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.
- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
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.
- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevFillColor variable.
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. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:
- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the FPDF_FONTPATH constant
Example for the last case (note the trailing slash):
define('FPDF_FONTPATH','/home/www/font/');
require('tcpdf.php');
//Times regular 12
$pdf->SetFont('Times');
//Arial bold 14
$pdf->SetFont('Arial','B',14);
//Removes bold
$pdf->SetFont('');
//Times bold, italic and underlined 14
$pdf->SetFont('Times','BIU');If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.
-
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 (synonymous; sans serif)
- Times (serif)
- Symbol (symbolic)
- ZapfDingbats (symbolic)
-
string
$style: Font style. Possible values are (case insensitive):
- empty string: regular
- B: bold
- I: italic
- U: underline
- float $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
Defines the size of the current font.
- float $size: The size (in points)
Set footer margin.
(minimum distance between footer and bottom page margin)
- int $fm: distance in millimeters
Set header data.
- string $ln: header image logo
- string $lw: header image logo width in mm
- string $ht: string to print as title on document header
- string $hs: string to print on document header
Set header margin.
(minimum distance between header and top page margin)
- int $hm: distance in millimeters
Set the image scale.
- float $scale: image scale.
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
- string $keywords: The list of keywords.
Set language array.
- array $language
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.
- float $margin: The margin.
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.
- float $width: The width.
Defines the page and position a link points to
- int $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)
- int $page: Number of target page; -1 indicates the current page. This is the default value
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
- float $left: Left margin.
- float $top: Top margin.
- float $right: Right margin. Default value is the left one.
Defines the right margin. The method can be called before creating the first page.
- float $margin: The margin.
Defines the subject of the document.
- string $subject: The subject.
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.
- int $r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
- int $g: Green component (between 0 and 255)
- int $b: Blue component (between 0 and 255)
- boolean $storeprev: if true stores the RGB array on $prevTextColor variable.
Defines the title of the document.
- string $title: The title.
Defines the top margin. The method can be called before creating the first page.
- float $margin: The margin.
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.
- float $x: The value of the abscissa.
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.
- float $x: The value of the abscissa
- float $y: The value of the ordinate
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.
- float $y: The value of the ordinate.
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.
- float $x: Abscissa of the origin
- float $y: Ordinate of the origin
- string $txt: String to print
Reverse function for htmlentities.
Convert entities in UTF-8.
- $text_to_convert $text: Text to convert.
Converts UTF-8 strings to codepoints array.
Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html
Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------
ABFN notation:
---------------------------------------------------------------------
UTF8-octets = *( UTF8-char )
UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
UTF8-1 = %x00-7F
UTF8-2 = %xC2-DF UTF8-tail
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
%xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
%xF4 %x80-8F 2( UTF8-tail )
UTF8-tail = %x80-BF
---------------------------------------------------------------------
- string $str: string to process.
Converts UTF-8 strings to UTF16-BE.
Based on: http://www.faqs.org/rfcs/rfc2781.html
Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to
UTF-16 proceeds as follows. Let U be the character number, no greater
than 0x10FFFF.
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate.
2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits.
3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits.
4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate.
Graphically, steps 2 through 4 look like:
U' = yyyyyyyyyyxxxxxxxxxx
W1 = 110110yyyyyyyyyy
W2 = 110111xxxxxxxxxx
- string $str: string to process.
- boolean $setbom: if true set the Byte Order Mark (BOM = 0xFEFF)
This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.
Example:
//Begin with regular font
$pdf->SetFont('Arial','',14);
$pdf->Write(5,'Visit ');
//Then put a blue underlined link
$pdf->SetTextColor(0,0,255);
$pdf->SetFont('','U');
$pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');
- float $h: Line height
- string $txt: String to print
- mixed $link: URL or identifier returned by AddLink()
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.
Allows to preserve some HTML formatting.
Supports: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small
- string $html: text to display
- boolean $ln: if true add a new line after text (default = true)
- int $fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.
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.
- float $w: Cell width. If 0, the cell extends up to the right margin.
- float $h: Cell minimum height. The cell extends automatically if needed.
- float $x: upper-left corner X coordinate
- float $y: upper-left corner Y coordinate
- string $html: html text to print. Default value: empty string.
-
mixed
$border: Indicates if borders must be drawn around the cell. The value can be either a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
-
int
$ln: Indicates where the current position should go after the call. Possible values are:
- 0: to the right
- 1: to the beginning of the next line
- 2: below
- int $fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)
- $font
Documentation generated on Mon, 05 Mar 2007 21:28:49 +0000 by phpDocumentor 1.3.1