Class: TCPDF
Source Location: /class/system/tcpdf/tcpdf.php
This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.
Author(s):
Version:
|
|
|
Class Details
Class Variables
Class Methods
constructor __construct [line 738]
TCPDF __construct(
[string
$orientation = 'P'], [string
$unit = 'mm'], [mixed
$format = 'A4'], [boolean
$unicode = true], [String
$encoding = "UTF-8"])
|
|
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).
Tags:
Parameters:
destructor __destruct [line 924]
Default destructor.
Tags:
method AcceptPageBreak [line 1952]
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.
Example:
The method is overriden in an inherited class in order to obtain a 3 column layout:
class PDF extends TCPDF {
var $col=0;
public function SetCol($col) {
//Move position to a column
$this->col=$col;
$x=10+$col*65;
$this->SetLeftMargin($x);
$this->SetX($x);
}
public 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();
Tags:
method AddFont [line 1630]
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 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');
Tags:
Parameters:
method addHtmlLink [line 4153]
void addHtmlLink(
string
$url, string
$name, [int
$fill = 0])
|
|
Output anchor link.
Tags:
Parameters:
method AddLink [line 1846]
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().
Tags:
method AddPage [line 1231]
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.
Tags:
Parameters:
method AliasNbPages [line 1173]
void AliasNbPages(
[string
$alias = '{nb}'])
|
|
Defines an alias for the total number of pages. It will be substituted as the document is closed. Example:
class PDF extends TCPDF {
public 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();
Tags:
Parameters:
method Cell [line 1972]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$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.
Tags:
Parameters:
method Close [line 1205]
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.
Tags:
method Error [line 1184]
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
Tags:
Parameters:
method Footer [line 1403]
This method is used to render the page footer. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags:
Overridden in child classes as:
- idd_pdf::Footer()
method getBreakMargin [line 977]
Returns the page break margin.
Tags:
method getImageScale [line 947]
Returns the image scale.
Tags:
method getPageHeight [line 967]
Returns the page height in units.
Tags:
method getPageWidth [line 957]
Returns the page width in units.
Tags:
method getPDFData [line 3651]
Returns the PDF data.
Tags:
method getScaleFactor [line 987]
Returns the scale factor (number of points in user unit).
Tags:
method GetStringWidth [line 1530]
int GetStringWidth(
string
$s)
|
|
Returns the length of a string in user unit. A font must be selected. Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]
Tags:
Parameters:
method GetX [line 2412]
Returns the abscissa of the current position.
Tags:
method GetY [line 2439]
Returns the ordinate of the current position.
Tags:
method Header [line 1350]
This method is used to render the page header. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags:
Overridden in child classes as:
- idd_pdf::Header()
method Image [line 2330]
void Image(
string
$file, float
$x, float
$y, [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''])
|
|
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. 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: 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.
Tags:
Parameters:
method Line [line 1586]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2)
|
|
Draws a line between two points.
Tags:
Parameters:
method Link [line 1882]
void Link(
float
$x, float
$y, float
$w, float
$h, 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.
Tags:
Parameters:
method Ln [line 2395]
void Ln(
[float
$h = ''])
|
|
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
Tags:
Parameters:
method MultiCell [line 2074]
void MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
$ln = 1])
|
|
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.
Tags:
Parameters:
method Open [line 1195]
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
Tags:
method Output [line 2482]
void Output(
[string
$name = ''], [string
$dest = ''])
|
|
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.
Tags:
Parameters:
method PageNo [line 1446]
Returns the current page number.
Tags:
method Rect [line 1601]
void Rect(
float
$x, float
$y, float
$w, float
$h, [string
$style = ''])
|
|
Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.
Tags:
Parameters:
method SetAuthor [line 1125]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 1052]
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.
Tags:
Parameters:
method setBarcode [line 3568]
void setBarcode(
[string
$bc = ""])
|
|
Set document barcode.
Tags:
Parameters:
method SetCompression [line 1087]
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.
Tags:
Parameters:
method SetCreator [line 1147]
void SetCreator(
string
$creator)
|
|
Defines the creator of the document. This is typically the name of the application that generates the PDF.
Tags:
Parameters:
method SetDisplayMode [line 1065]
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.
Tags:
Parameters:
method SetDrawColor [line 1459]
void SetDrawColor(
int
$r, [int
$g = -1], [int
$b = -1])
|
|
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.
Tags:
Parameters:
method SetFillColor [line 1481]
void SetFillColor(
int
$r, [int
$g = -1], [int
$b = -1], [boolean
$storeprev = false])
|
|
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.
Tags:
Parameters:
method SetFont [line 1729]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0])
|
|
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.
Tags:
Parameters:
method SetFontSize [line 1828]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFooterFont [line 3551]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 1326]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setHeaderData [line 1305]
void setHeaderData(
[string
$ln = ""], [string
$lw = 0], [string
$ht = ""], [string
$hs = ""])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 3542]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 1317]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setImageScale [line 937]
void setImageScale(
float
$scale)
|
|
Set the image scale.
Tags:
Parameters:
method SetKeywords [line 1136]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 3560]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method SetLeftMargin [line 1015]
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.
Tags:
Parameters:
method SetLineWidth [line 1569]
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.
Tags:
Parameters:
method SetLink [line 1861]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to
Tags:
Parameters:
method SetMargins [line 999]
void SetMargins(
float
$left, float
$top, [float
$right = -1])
|
|
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
Tags:
Parameters:
method setPrintFooter [line 1342]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 1334]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetRightMargin [line 1040]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method SetSubject [line 1114]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method SetTextColor [line 1508]
void SetTextColor(
int
$r, [int
$g = -1], [int
$b = -1], [boolean
$storeprev = false])
|
|
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.
Tags:
Parameters:
method SetTitle [line 1103]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 1029]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method SetX [line 2423]
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.
Tags:
Parameters:
method SetXY [line 2468]
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.
Tags:
Parameters:
method SetY [line 2450]
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.
Tags:
Parameters:
method Text [line 1895]
void Text(
float
$x, float
$y, string
$txt)
|
|
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.
Tags:
Parameters:
method unhtmlentities [line 4194]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UTF8StringToArray [line 3403]
array UTF8StringToArray(
string
$str)
|
|
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
---------------------------------------------------------------------
Tags:
Parameters:
method UTF8ToUTF16BE [line 3505]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
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
Tags:
Parameters:
method Write [line 2222]
void Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0])
|
|
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');
Tags:
Parameters:
method writeBarcode [line 3584]
void writeBarcode(
int
$x, int
$y, int
$w, int
$h, string
$type, string
$style, string
$font, int
$xres, string
$code)
|
|
Print Barcode.
Tags:
Parameters:
method writeHTML [line 3667]
void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = 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
Tags:
Parameters:
method writeHTMLCell [line 3739]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 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.
Tags:
Parameters:
method _begindoc [line 2590]
method _beginpage [line 2996]
void _beginpage(
$orientation)
|
|
_beginpage
Tags:
Parameters:
method _dochecks [line 2564]
Check for locale-related bug
Tags:
method _dounderline [line 3054]
void _dounderline(
$x,
$y,
$txt)
|
|
Underline text
Tags:
Parameters:
method _enddoc [line 2957]
method _endpage [line 3036]
End of page contents
Tags:
method _escape [line 3228]
Add \ before \, ( and )
Tags:
Parameters:
method _escapetext [line 3216]
Format a text string
Tags:
Parameters:
method _freadint [line 3194]
Read a 4-byte integer from file
Tags:
Parameters:
method _getfontpath [line 2579]
method _newobj [line 3044]
method _out [line 3247]
Add a line to the document
Tags:
Parameters:
method _parsejpg [line 3065]
Extract info from a JPEG file
Tags:
Parameters:
method _parsepng [line 3097]
Extract info from a PNG file
Tags:
Parameters:
method _putcatalog [line 2909]
method _putfonts [line 2673]
Adds fonts _putfonts
Tags:
method _putheader [line 2949]
method _putimages [line 2791]
method _putinfo [line 2885]
method _putpages [line 2600]
method _putresourcedict [line 2853]
method _putresources [line 2869]
method _putstream [line 3237]
method _puttrailer [line 2939]
method _puttruetypeunicode [line 3263]
void _puttruetypeunicode(
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putxobjectdict [line 2843]
method _textstring [line 3204]
Format a text string
Tags:
Parameters:
|
|
