Class: TCPDF
Source Location: /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 1005]
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 1222]
Default destructor.
Tags:
method AcceptPageBreak [line 2448]
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('vera','',12);
for($i=1;$i<=300;$i++) {
$pdf->Cell(0,5,"Line $i",0,1);
}
$pdf->Output();
Tags:
method addExtGState [line 7383]
void addExtGState(
$parms)
|
|
Tags:
Parameters:
method AddFont [line 2096]
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 K_PATH_FONTS 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 5234]
void addHtmlLink(
string
$url, string
$name, [int
$fill = 0])
|
|
Output anchor link.
Tags:
Parameters:
method AddLink [line 2322]
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 1621]
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 1521]
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 vera italic 8
$this->SetFont('vera','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 arrUTF8ToUTF16BE [line 4534]
string arrUTF8ToUTF16BE(
array
$unicode, [boolean
$setbom = true])
|
|
Converts array of UTF-8 characters to UTF16-BE string. 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 Bookmark [line 6955]
void Bookmark(
$txt, [
$level = 0], [
$y = -1])
|
|
Tags:
Parameters:
method Button [line 7209]
void Button(
$name,
$w,
$h,
$caption,
$action, [
$prop = array()])
|
|
Tags:
Parameters:
method Cell [line 2469]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0])
|
|
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 CheckBox [line 7189]
void CheckBox(
$name,
$w, [
$checked = false], [
$prop = array()])
|
|
Tags:
Parameters:
method Circle [line 6192]
void Circle(
float
$x0, float
$y0, float
$r, [
$astart = 0], [
$afinish = 360], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$astart:, float
$afinish:)
|
|
Draws a circle. A circle is formed from n Bezier curves.
Tags:
Parameters:
method Close [line 1553]
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 closedHTMLTagHandler [line 5071]
void closedHTMLTagHandler(
string
$tag)
|
|
Process closing tags.
Tags:
Parameters:
method ComboBox [line 7170]
void ComboBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method convertHTMLColorToDec [line 5252]
array convertHTMLColorToDec(
[string
$color = "#000000"])
|
|
Returns an associative array (keys: R,G,B) from an html color name or a six-digit or three-digit hexadecimal color representation (i.e. #3FE5AA or #7FF).
Tags:
Parameters:
method Curve [line 6045]
void Curve(
float
$x0, float
$y0, float
$x1, float
$y1, float
$x2, float
$y2, float
$x3, float
$y3, [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()])
|
|
Draws a Bezier curve. The Bezier curve is a tangent to the line between the control points at either end of the curve.
Tags:
Parameters:
method Ellipse [line 6097]
void Ellipse(
float
$x0, float
$y0, float
$rx, [float
$ry = 0], [
$angle = 0], [
$astart = 0], [
$afinish = 360], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$angle:, float
$astart:, float
$afinish:)
|
|
Draws an ellipse. An ellipse is formed from n Bezier curves.
Tags:
Parameters:
method Error [line 1532]
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 1845]
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:
method GetAbsX [line 3400]
Returns the absolute X value of current position.
Tags:
method GetArrStringWidth [line 2037]
int GetArrStringWidth(
$sa, string
$arr)
|
|
Returns the string length of an array of chars in user unit. A font must be selected.
Tags:
Parameters:
method getBreakMargin [line 1310]
Returns the page break margin.
Tags:
method GetCharWidth [line 2052]
int GetCharWidth(
string
$char)
|
|
Returns the length of the char in user unit. A font must be selected.
Tags:
Parameters:
method getGroupPageNo [line 7314]
method getImageScale [line 1280]
Returns the image scale.
Tags:
method GetLineWidth [line 5777]
Returns the current the line width.
Tags:
method GetNumChars [line 2074]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumPages [line 1609]
Get the total number of insered pages.
Tags:
method getPage [line 1598]
Get current document page number.
Tags:
method getPageGroupAlias [line 7325]
void getPageGroupAlias(
)
|
|
Tags:
method getPageHeight [line 1300]
Returns the page height in units.
Tags:
method getPageWidth [line 1290]
Returns the page width in units.
Tags:
method getPDFData [line 4674]
Returns the PDF data.
Tags:
method getRemainingWidth [line 3003]
Returns the remaining width between the current position and margins.
Tags:
method getScaleFactor [line 1320]
Returns the scale factor (number of points in user unit).
Tags:
method GetStringWidth [line 2026]
int GetStringWidth(
string
$s)
|
|
Returns the length of a string in user unit. A font must be selected.
Tags:
Parameters:
method GetX [line 3385]
Returns the relative X value of current position. The value is relative to the left border for LTR languages and to the right border for RTL languages.
Tags:
method GetY [line 3410]
Returns the ordinate of the current position.
Tags:
method Header [line 1761]
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:
method Image [line 3084]
void Image(
string
$file, float
$x, float
$y, [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [boolean
$resize = false], [int
$dpi = 300])
|
|
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 images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; 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 IncludeJS [line 7032]
method lastPage [line 1576]
Reset pointer to the last document page.
Tags:
method Line [line 5926]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method Link [line 2358]
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 ListBox [line 7147]
void ListBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method Ln [line 3364]
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 MirrorH [line 5571]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 5604]
void MirrorL(
[float
$angle = 0], [int
$x = ''], [int
$y = ''])
|
|
Reflection against a straight line through point (x, y) with the gradient angle (angle).
Tags:
Parameters:
method MirrorP [line 5592]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 5581]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method MultiCell [line 2721]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
$ln = 1], [int
$x = ''], [int
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false])
|
|
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 1543]
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 openHTMLTagHandler [line 4798]
void openHTMLTagHandler(
string
$tag, string
$attr, [int
$fill = 0])
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 3482]
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 1917]
Returns the current page number.
Tags:
method pixelsToUnits [line 5297]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to Units.
Tags:
Parameters:
method Polygon [line 6215]
void Polygon(
array
$p, [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()])
|
|
Draws a polygon.
Tags:
Parameters:
method RadioButton [line 7129]
void RadioButton(
$name,
$w, [
$prop = array()])
|
|
Tags:
Parameters:
method Rect [line 5958]
void Rect(
float
$x, float
$y, float
$w, float
$h, [string
$style = ''], [array
$border_style = array()], [array
$fill_color = array()])
|
|
Draws a rectangle.
Tags:
Parameters:
method RegularPolygon [line 6304]
void RegularPolygon(
float
$x0, float
$y0,
$r, integer
$ns, [float
$angle = 0], [boolean
$draw_circle = false], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [string
$circle_style = ""], [array
$circle_outLine_style = array()], [array
$circle_fill_color = array()], float
$r:)
|
|
Draws a regular polygon.
Tags:
Parameters:
method Rotate [line 5659]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 6402]
void RoundedRect(
float
$x, float
$y, float
$w, float
$h, float
$r, [string
$round_corner = "1111"], [string
$style = ""], [array
$border_style = array()], [array
$fill_color = array()])
|
|
Draws a rounded rectangle.
Tags:
Parameters:
method Scale [line 5538]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 5501]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 5525]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 5513]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method setAlpha [line 7426]
void setAlpha(
$alpha, [
$bm = 'Normal'])
|
|
Tags:
Parameters:
method SetAuthor [line 1473]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 1400]
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 4591]
void setBarcode(
[string
$bc = ""])
|
|
Set document barcode.
Tags:
Parameters:
method SetCellPadding [line 1389]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method SetCompression [line 1435]
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 1495]
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 1413]
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 1931]
void SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -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 setExtGState [line 7395]
method SetFillColor [line 1958]
void SetFillColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [boolean
$storeprev = false], [int
$col4 = -1])
|
|
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 2195]
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 K_PATH_FONTS constant
Example for the last case (note the trailing slash): define('K_PATH_FONTS','/home/www/font/');
require('tcpdf.php');
//Times regular 12
$pdf->SetFont('Times');
//Arial bold 14
$pdf->SetFont('vera','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 2297]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFooterFont [line 4573]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 1737]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setHeaderData [line 1716]
void setHeaderData(
[string
$ln = ""], [string
$lw = 0], [string
$ht = ""], [string
$hs = ""])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 4564]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 1728]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setImageScale [line 1270]
void setImageScale(
float
$scale)
|
|
Set the image scale.
Tags:
Parameters:
method setJPEGQuality [line 7437]
void setJPEGQuality(
$quality)
|
|
Tags:
Parameters:
method SetKeywords [line 1484]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 4582]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 1260]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 1348]
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 SetLineStyle [line 5803]
void SetLineStyle(
array
$style)
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 5763]
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 2337]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to
Tags:
Parameters:
method SetMargins [line 1332]
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 setPage [line 1586]
Move pointer to the apecified document page.
Tags:
Parameters:
method setPrintFooter [line 1753]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 1745]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 5451]
void SetProtection(
[Array
$permissions = array()], [String
$user_pass = ''], [String
$owner_pass = null])
|
|
Set document protection The permission array is composed of values taken from the following ones: - copy: copy text and images to the clipboard
- print: print the document
- modify: modify it (except for annotations and forms)
- annot-forms: add annotations and forms
Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
Tags:
Parameters:
method SetRightMargin [line 1376]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 1234]
void setRTL(
Boolean
$enable)
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setStyle [line 5215]
void setStyle(
string
$tag, boolean
$enable)
|
|
Sets font style.
Tags:
Parameters:
method SetSubject [line 1462]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setTempRTL [line 1244]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 1995]
void SetTextColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [boolean
$storeprev = false], [int
$col4 = -1])
|
|
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 1451]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 1362]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 7285]
void setUserRights(
[
$enable = true], [
$document = "/FullSave"], [
$annots = "/Create/Delete/Modify/Copy/Import/Export"], [
$form = "/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate"], [
$signature = "/Modify"])
|
|
Tags:
Parameters:
method setVisibility [line 7355]
method SetX [line 3422]
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
Tags:
Parameters:
method SetXY [line 3468]
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 3446]
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 Skew [line 5716]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 5691]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 5703]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 6355]
void StarPolygon(
float
$x0, float
$y0, float
$r, integer
$nv, integer
$ng, [
$angle = 0], [
$draw_circle = false], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [string
$circle_style = ""], [array
$circle_outLine_style = array()], [array
$circle_fill_color = array()], float
$angle:, boolean
$draw_circle:)
|
|
Draws a star polygon
Tags:
Parameters:
method startPageGroup [line 7304]
method StartTransform [line 5479]
Starts a 2D tranformation saving current graphic state. This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Tags:
method StopTransform [line 5490]
Stops a 2D tranformation restoring previous graphic state. This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Tags:
method Text [line 2372]
void Text(
float
$x, float
$y, string
$txt, [int
$stroke = 0], [boolean
$clip = false])
|
|
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 TextField [line 7116]
void TextField(
$name,
$w,
$h, [
$prop = array()])
|
|
Tags:
Parameters:
method Transform [line 5747]
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 5636]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 5615]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 5625]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 5308]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method unichr [line 3040]
Returns the unicode caracter specified by UTF-8 code
Tags:
Parameters:
method UTF8ArrSubString [line 3019]
Return UTF8ArrSubString(
string
$strarr, [int
$start = ''], [int
$end = ''])
|
|
Extract a slice of the $strarr array and return it as string.
Tags:
Parameters:
method utf8Bidi [line 6491]
string utf8Bidi(
array
$ta, [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8StringToArray [line 4408]
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 utf8StrRev [line 6479]
string utf8StrRev(
string
$str, [
$setbom = false], [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8ToUTF16BE [line 4488]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 2855]
int Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0])
|
|
This method prints text from the current position.
Tags:
Parameters:
method writeBarcode [line 4607]
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 4692]
void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = 0], [boolean
$reseth = false], [boolean
$cell = false])
|
|
Allows to preserve some HTML formatting (limited support). Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, small, span, strong, sub, sup, table, td, th, tr, u, ul,
Tags:
Parameters:
method writeHTMLCell [line 4787]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 0], [boolean
$reseth = true])
|
|
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 _addfield [line 7091]
void _addfield(
$type,
$name,
$x,
$y,
$w,
$h,
$prop)
|
|
Tags:
Parameters:
method _begindoc [line 3590]
method _beginpage [line 4070]
void _beginpage(
string
$orientation)
|
|
Initialize a page.
Tags:
Parameters:
method _datestring [line 3952]
string _datestring(
string
$s)
|
|
Format a date string for meta information
Tags:
Parameters:
method _dochecks [line 3564]
Check for locale-related bug
Tags:
method _dolinethrough [line 4160]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text
Tags:
Parameters:
method _dounderline [line 4146]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text
Tags:
Parameters:
method _enddoc [line 4030]
method _endpage [line 4124]
End of page contents
Tags:
method _escape [line 4228]
string _escape(
string
$s)
|
|
Add \ before \, ( and )
Tags:
Parameters:
method _escapetext [line 4214]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 4173]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte integer from file
Tags:
Parameters:
method _generateencryptionkey [line 5420]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getfontpath [line 3579]
method _JScolor [line 7067]
method _md5_16 [line 5384]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 4133]
method _objectkey [line 5319]
Compute encryption key depending on object number where the encrypted data is stored
Tags:
Parameters:
method _out [line 4252]
Output a string to the document.
Tags:
Parameters:
method _outCurve [line 5906]
void _outCurve(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Tags:
Parameters:
method _outLine [line 5870]
method _outPoint [line 5856]
method _outRect [line 5887]
void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)
|
|
Draws a rectangle.
Tags:
Parameters:
method _Ovalue [line 5396]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for RC4 encryption)
Tags:
Parameters:
method _parsejpeg [line 3236]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using GD library
Tags:
Parameters:
method _parsepng [line 3268]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using GD
Tags:
Parameters:
method _putbookmarks [line 6968]
method _putcatalog [line 3963]
method _putencryption [line 5327]
Put encryption on PDF document
Tags:
method _putextgstates [line 7405]
method _putfonts [line 3683]
Adds fonts _putfonts
Tags:
method _putheader [line 4022]
method _putimages [line 3801]
method _putinfo [line 3923]
Adds some Metadata information (see Chapter 10.2 of PDF Reference)
Tags:
method _putjavascript [line 7042]
method _putocg [line 7334]
method _putpages [line 3600]
method _putresourcedict [line 3868]
Put Resources Dictionary.
Tags:
method _putresources [line 3893]
method _putstream [line 4238]
void _putstream(
string
$s)
|
|
Output a stream.
Tags:
Parameters:
method _puttrailer [line 4008]
method _puttruetypeunicode [line 4268]
void _puttruetypeunicode(
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putuserrights [line 7231]
method _putxobjectdict [line 3858]
method _RC4 [line 5345]
String _RC4(
string
$key, String
$text)
|
|
Returns the input text exrypted using RC4 algorithm and the specified key. RC4 is the standard encryption algorithm used in PDF format
Tags:
Parameters:
method _textstring [line 4184]
string _textstring(
string
$s)
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 3220]
void _toJPEG(
image
$image, string
$file)
|
|
Convert the loaded php image to a JPEG and then return a structure for the PDF creator. This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
Tags:
Parameters:
method _uristring [line 4201]
string _uristring(
string
$s)
|
|
Format an URI string
Tags:
Parameters:
method _Uvalue [line 5408]
Compute U value (used for RC4 encryption)
Tags:
|
|
