Class: TCPDF
Source Location: /tcpdf.php
This is a PHP class for generating PDF documents without requiring external extensions.
Author(s):
- Nicola Asuni - info@tecnick.com
Version:
|
|
|
Class Details
Class Variables
$AliasNbPages = '{nb}'
[line 506]
Tags:
$AliasNumPage = '{pnb}'
[line 512]
Tags:
$author = ''
[line 488]
Tags:
$AutoPageBreak =
[line 446]
Tags:
$barcode = false
[line 604]
Tags:
$bgcolor =
[line 697]
Tags:
$bMargin =
[line 287]
Tags:
$booklet = false
[line 1091]
Booklet mode for double-sided pages
Tags:
$buffer =
[line 191]
Tags:
$bufferlen = 0
[line 1191]
Lenght of the buffer in bytes.
Tags:
$cache_file_lenght = array()
[line 1240]
Array used to store the lenghts of cache files
Tags:
$cache_maxsize_UTF8StringToArray = 8
[line 1268]
Maximum size of cache array used for UTF8StringToArray() method.
Tags:
$cache_size_UTF8StringToArray = 0
[line 1275]
Current size of cache array used for UTF8StringToArray() method.
Tags:
$cache_UTF8StringToArray = array()
[line 1261]
Cache array for UTF8StringToArray() method.
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 948]
Default cell height ratio.
Tags:
$cMargin =
[line 294]
Tags:
$cntmrk = array()
[line 985]
Array used to store content positions inside the pages buffer. keys are the page numbers
Tags:
$ColorFlag =
[line 440]
Tags:
$compress =
[line 209]
Tags:
$CoreFonts =
[line 330]
Tags:
$creator = ''
[line 500]
Tags:
$CurOrientation =
[line 215]
Tags:
$CurrentFont =
[line 404]
Tags:
$currpagegroup =
[line 906]
Contains the alias of the current page group
Tags:
$customlistindent = -1
[line 1113]
Tags:
$default_monospaced_font = 'courier'
[line 1226]
Default monospaced font
Tags:
$default_table_columns = 4
[line 646]
Tags:
$diffs = array()
[line 348]
Tags:
$diskcache = false
[line 1198]
If true enables disk caching.
Tags:
$dpi = 72
[line 885]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 422]
Tags:
$embeddedfiles = array()
[line 1127]
Tags:
$encoding = 'UTF-8'
[line 716]
Tags:
$encrypted =
[line 746]
Indicates whether document is protected
Tags:
$encryption_key =
[line 800]
RC4 encryption key
Tags:
$enc_obj_id =
[line 774]
encryption object id
Tags:
$endlinex = 0
[line 1014]
End position of the latest inserted line
Tags:
$epsmarker = 'x#!#EPS#!#x'
[line 1077]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 934]
Array of transparency objects and parameters.
Tags:
$feps = 0.005
[line 1098]
Epsilon value used for float calculations
Tags:
$fgcolor =
[line 667]
Tags:
$fhPt =
[line 239]
Tags:
$FillColor =
[line 428]
Tags:
$FontAscent =
[line 385]
Tags:
$FontDescent =
[line 392]
Tags:
$FontFamily =
[line 372]
Tags:
$FontFiles = array()
[line 342]
Tags:
$fontkeys = array()
[line 1212]
Store the font keys.
Tags:
$fontlist = array()
[line 661]
Tags:
$fonts = array()
[line 336]
Tags:
$FontSize =
[line 416]
Tags:
$FontSizePt =
[line 410]
Tags:
$FontStyle =
[line 378]
Tags:
$footerlen = array()
[line 1000]
Array used to store footer lenght of each page.
Tags:
$footerpos = array()
[line 992]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 592]
Tags:
$footer_margin =
[line 566]
Tags:
$fwPt =
[line 233]
Tags:
$gradients = array()
[line 969]
Array for storing gradient information.
Tags:
$h =
[line 263]
Tags:
$header_font =
[line 586]
Tags:
$header_logo = ''
[line 622]
Tags:
$header_logo_width = 30
[line 628]
Tags:
$header_margin =
[line 560]
Tags:
$header_string = ''
[line 640]
Tags:
$header_title = ''
[line 634]
Tags:
$hPt =
[line 251]
Tags:
$HREF = array()
[line 655]
Tags:
$htmlLinkColorArray = array(0, 0, 255)
[line 1149]
Default color for html links
Tags:
$htmlLinkFontStyle = 'U'
[line 1156]
Default font style to add to html links
Tags:
$htmlvspace = 0
[line 1056]
Count the latest inserted vertical spaces on HTML
Tags:
$imagekeys = array()
[line 1184]
Store the image keys.
Tags:
$images = array()
[line 354]
Tags:
$imgscale = 1
[line 536]
Tags:
$img_rb_x =
[line 520]
Tags:
$img_rb_y =
[line 528]
Tags:
$InFooter = false
[line 458]
Tags:
$internal_encoding =
[line 723]
Tags:
$intmrk = array()
[line 977]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$isunicode = false
[line 544]
Tags:
$javascript = ''
[line 826]
javascript code
Tags:
$jpeg_quality =
[line 941]
Set the default JPEG compression quality (1-100)
Tags:
$k =
[line 227]
Tags:
$keywords = ''
[line 494]
Tags:
$l =
[line 598]
Tags:
$lasth =
[line 318]
Tags:
$last_rc4_key =
[line 781]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_rc4_key_c =
[line 788]
last RC4 computed key
Tags:
$LayoutMode =
[line 470]
Tags:
$linestyleCap = '0 J'
[line 1028]
PDF string for last line width
Tags:
$linestyleDash = '[] 0 d'
[line 1042]
PDF string for last line width
Tags:
$linestyleJoin = '0 j'
[line 1035]
PDF string for last line width
Tags:
$linestyleWidth = ''
[line 1021]
PDF string for last line width
Tags:
$linethrough =
[line 840]
line trough state
Tags:
$LineWidth =
[line 324]
Tags:
$links = array()
[line 366]
Tags:
$lispacer = ''
[line 709]
Tags:
$listcount = array()
[line 679]
Tags:
$listindent =
[line 691]
Tags:
$listnum = 0
[line 685]
Tags:
$listordered = array()
[line 673]
Tags:
$lisymbol = ''
[line 1070]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 269]
Tags:
$n =
[line 179]
Tags:
$newline = true
[line 1007]
True if a newline is created.
Tags:
$newpagegroup = array()
[line 892]
Array of page numbers were a new page group was started
Tags:
$numfonts = 0
[line 1205]
Counts the number of fonts.
Tags:
$numimages = 0
[line 1177]
Counts the number of pages.
Tags:
$numpages = 0
[line 1163]
Counts the number of pages.
Tags:
$n_js =
[line 833]
javascript counter
Tags:
$n_ocg_print =
[line 920]
Print visibility.
Tags:
$n_ocg_view =
[line 927]
View visibility.
Tags:
$objcopy =
[line 1233]
Used to store a cloned copy of the current class object
Tags:
$offsets =
[line 185]
Tags:
$oldcMargin =
[line 300]
Tags:
$opencell = true
[line 1120]
Tags:
$openMarkedContent = false
[line 1049]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 573]
Tags:
$original_rMargin =
[line 580]
Tags:
$OutlineRoot =
[line 816]
Outline root for bookmark
Tags:
$outlines = array()
[line 809]
Outlines for bookmark
Tags:
$Ovalue =
[line 760]
O entry in pdf document
Tags:
$padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A"
[line 794]
RC4 padding
Tags:
$page =
[line 173]
Tags:
$PageAnnots = array()
[line 360]
Tags:
$PageBreakTrigger =
[line 452]
Tags:
$pagedim = array()
[line 221]
Tags:
$pagegroups =
[line 899]
Contains the number of pages of the groups
Tags:
$pagelen = array()
[line 1170]
Array containing page lenghts in bytes.
Tags:
$PageMode =
[line 962]
A name object specifying how the document should be displayed when opened.
Tags:
$pageopen = array()
[line 1219]
Store the fage status (true when opened, false when closed).
Tags:
$pages = array()
[line 197]
Tags:
$PDFVersion = '1.7'
[line 551]
Tags:
$premode = false
[line 1134]
Tags:
$print_footer = true
[line 616]
Tags:
$print_header = true
[line 610]
Tags:
$Pvalue =
[line 767]
P entry in pdf document
Tags:
$re_spaces = '/[\s]/'
[line 1303]
Regular expression used to find blank characters used for word-wrapping.
Tags:
$rMargin =
[line 281]
Tags:
$rtl = false
[line 730]
Tags:
$sign = false
[line 1282]
If true enables document signing
Tags:
$signature_data = array()
[line 1289]
Signature data
Tags:
$signature_max_lenght = 5120
[line 1296]
Signature max lenght
Tags:
$spot_colors = array()
[line 1063]
Array of Spot colors
Tags:
$state =
[line 203]
Tags:
$subject = ''
[line 482]
Tags:
$tagvspaces = array()
[line 1105]
Array used for custom vertical spaces for HTML tags
Tags:
$tempfontsize = 10
[line 703]
Tags:
$TextColor =
[line 434]
Tags:
$thead = ''
[line 1247]
Table header content to be repeated on each new page
Tags:
$theadMargins = array()
[line 1254]
Margins used for table header.
Tags:
$title = ''
[line 476]
Tags:
$tMargin =
[line 275]
Tags:
$tmprtl = false
[line 737]
Tags:
$transfmatrix = array()
[line 1084]
Array of transformation matrix
Tags:
$transfmrk = array()
[line 1142]
Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers
Tags:
$underline =
[line 398]
Tags:
$ur =
[line 850]
If true enables user's rights on PDF reader
Tags:
$ur_annots =
[line 864]
Names specifying additional annotation-related usage rights for the document.
Tags:
$ur_document =
[line 857]
Names specifying additional document-wide usage rights for the document.
Tags:
$ur_form =
[line 871]
Names specifying additional form-field-related usage rights for the document.
Tags:
$ur_signature =
[line 878]
Names specifying additional signature-related usage rights for the document.
Tags:
$Uvalue =
[line 753]
U entry in pdf document
Tags:
$viewer_preferences =
[line 955]
PDF viewer preferences.
Tags:
$visibility = 'all'
[line 913]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 257]
Tags:
$wPt =
[line 245]
Tags:
$x =
[line 306]
Tags:
$y =
[line 312]
Tags:
$ZoomMode =
[line 464]
Tags:
Class Methods
constructor __construct [line 1322]
TCPDF __construct(
[string
$orientation = 'P'], [string
$unit = 'mm'], [mixed
$format = 'A4'], [boolean
$unicode = true], [String
$encoding = 'UTF-8'], [boolean
$diskcache = false])
|
|
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 1443]
Default destructor.
Tags:
method AcceptPageBreak [line 3354]
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.
Tags:
method addExtGState [line 9686]
void addExtGState(
$parms)
|
|
Tags:
Parameters:
method AddFont [line 2952]
array AddFont(
string
$family, [string
$style = ''], [string
$fontfile = ''])
|
|
Imports a TrueType, Type1, core, or CID0 font and makes it available. It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). 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.
Tags:
Parameters:
method addHtmlLink [line 6970]
the addHtmlLink(
string
$url, string
$name, [int
$fill = 0], [boolean
$firstline = false], [array
$color = ''], [string
$style = -1])
|
|
Output anchor link.
Tags:
Parameters:
method addHTMLVertSpace [line 12833]
void addHTMLVertSpace(
int
$n, [boolean
$cell = false], [string
$h = ''], [boolean
$firstorlast = false], [string
$tag = ''], [boolean
$closing = false])
|
|
Add vertical spaces if needed.
Tags:
Parameters:
method AddLink [line 3174]
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 2168]
void AddPage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled). The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
Tags:
Parameters:
method AddSpotColor [line 2585]
void AddSpotColor(
$name, int
$c, int
$m, int
$y, int
$k)
|
|
Defines a new spot color. 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 addTOC [line 13855]
void addTOC(
[int
$page = ''], [string
$numbersfont = ''], [string
$filler = '.'])
|
|
Output a Table of Content Index (TOC). You can override this method to achieve different styles.
Tags:
Parameters:
method AliasNbPages [line 9494]
void AliasNbPages(
[string
$alias = '{nb}'])
|
|
Defines an alias for the total number of pages. It will be substituted as the document is closed.
Tags:
Parameters:
method AliasNumPage [line 9521]
void AliasNumPage(
[string
$alias = '{pnb}'])
|
|
Defines an alias for the page number. It will be substituted as the document is closed.
Tags:
Parameters:
method Annotation [line 3230]
void Annotation(
float
$x, float
$y, float
$w, float
$h, string
$text, [array
$opt = array('Subtype'=>'Text')], [int
$spaces = 0])
|
|
Puts a markup annotation on a rectangular area of the page. !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
Tags:
Parameters:
method Arrow [line 8400]
void Arrow(
float
$x0, float
$y0,
$x1, float
$y1, [int
$head_style = 0], [float
$arm_size = 5], [int
$arm_angle = 15])
|
|
Draws a grahic arrow.
Tags:
Parameters:
method arrUTF8ToUTF16BE [line 6868]
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 9016]
void Bookmark(
$txt, [
$level = 0], [
$y = -1], [
$page = ''])
|
|
Tags:
Parameters:
method Button [line 9298]
void Button(
$name,
$w,
$h,
$caption,
$action, [
$prop = array()])
|
|
Tags:
Parameters:
method Cell [line 3415]
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], [boolean
$ignore_min_height = false])
|
|
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 9278]
void CheckBox(
$name,
$w, [
$checked = false], [
$prop = array()])
|
|
Tags:
Parameters:
method checkPageBreak [line 3367]
boolean checkPageBreak(
[float
$h = 0], [mixed
$y = ''], [boolean
$addpage = true])
|
|
Add page if needed.
Tags:
Parameters:
method Circle [line 8087]
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 Clip [line 9949]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 2062]
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 closeHTMLTagHandler [line 12502]
void closeHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method ComboBox [line 9259]
void ComboBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method commitTransaction [line 14012]
void commitTransaction(
)
|
|
Delete the copy of the current TCPDF object used for undo operation.
Tags:
method convertHTMLColorToDec [line 7003]
array convertHTMLColorToDec(
[string
$color = '#FFFFFF'])
|
|
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 CoonsPatchMesh [line 9869]
void CoonsPatchMesh(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$col3 = array()], [array
$col4 = array()], [array
$coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33)], [array
$coords_min = 0], [array
$coords_max = 1])
|
|
Paints a coons patch mesh.
Tags:
Parameters:
method Curve [line 7862]
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 deletePage [line 13715]
true deletePage(
int
$page)
|
|
Remove the specified page.
Tags:
Parameters:
method Ellipse [line 7983]
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 empty_string [line 14059]
boolean empty_string(
srting
$str)
|
|
Determine whether a string is empty.
Tags:
Parameters:
method endPage [line 2187]
Terminate the current page
Tags:
method Error [line 2034]
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 2426]
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 formatPageNumber [line 9598]
void formatPageNumber(
int
$num)
|
|
Format the page numbers. This method can be overriden for custom formats.
Tags:
Parameters:
method formatTOCPageNumber [line 9610]
void formatTOCPageNumber(
int
$num)
|
|
Format the page numbers on the Table Of Content. This method can be overriden for custom formats.
Tags:
Parameters:
method GetAbsX [line 4912]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 9506]
string getAliasNbPages(
)
|
|
Returns the string alias used for the total number of pages. If the current font is unicode type, the returned string is surrounded by additional curly braces.
Tags:
method getAliasNumPage [line 9534]
string getAliasNumPage(
)
|
|
Returns the string alias used for the page number. If the current font is unicode type, the returned string is surrounded by additional curly braces.
Tags:
method GetArrStringWidth [line 2864]
int GetArrStringWidth(
$sa, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0], string
$arr)
|
|
Returns the string length of an array of chars in user unit. A font must be selected.
Tags:
Parameters:
method getBarcode [line 10414]
Get current barcode.
Tags:
method getBorderMode [line 3861]
border getBorderMode(
mixed
$border, [string
$position = 'start'])
|
|
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
Tags:
Parameters:
method getBreakMargin [line 1765]
int getBreakMargin(
[int
$pagenum = ''])
|
|
Returns the page break margin.
Tags:
Parameters:
method getBuffer [line 13401]
Get buffer content.
Tags:
method getCellCode [line 3467]
void getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false])
|
|
Returns the PDF string code to print 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 getCellHeightRatio [line 9772]
void getCellHeightRatio(
)
|
|
Tags:
method GetCharWidth [line 2891]
int GetCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getFontBuffer [line 13561]
string getFontBuffer(
string
$font)
|
|
Get font buffer content.
Tags:
Parameters:
method getFontFamily [line 10890]
Returns the current font family name.
Tags:
method getFontSize [line 10870]
Returns the current font size.
Tags:
method getFontSizePt [line 10880]
Returns the current font size in points unit.
Tags:
method getFontsList [line 2930]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFontStyle [line 10900]
Returns the current font style.
Tags:
method getFooterFont [line 6929]
method getFooterMargin [line 2340]
Returns footer margin in user units.
Tags:
method getGDgamma [line 4855]
void getGDgamma(
float
$v)
|
|
Correct the gamma value to be used with GD library
Tags:
Parameters:
method getGraphicVars [line 13269]
Returns current graphic variables as array.
Tags:
method getGroupPageNo [line 9547]
method getGroupPageNoFormatted [line 9557]
void getGroupPageNoFormatted(
)
|
|
Returns the current group page number formatted as a string.
Tags:
method getHeaderData [line 2295]
Returns header data: - $ret['logo'] = logo image
- $ret['logo_width'] = width of the image logo in user units
- $ret['title'] = header title
- $ret['string'] = header description string
Tags:
method getHeaderFont [line 6909]
method getHeaderMargin [line 2320]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 10936]
array getHtmlDomArray(
string
$html)
|
|
Returns the HTML DOM array. - $dom[$key]['tag'] = true if tag, false otherwise;
- $dom[$key]['value'] = tag name or text;
- $dom[$key]['opening'] = true if opening tag, false otherwise;
- $dom[$key]['attribute'] = array of attributes (attribute name is the key);
- $dom[$key]['style'] = array of style attributes (attribute name is the key);
- $dom[$key]['parent'] = id of parent element;
- $dom[$key]['fontname'] = font family name;
- $dom[$key]['fontstyle'] = font style;
- $dom[$key]['fontsize'] = font size in points;
- $dom[$key]['bgcolor'] = RGB array of background color;
- $dom[$key]['fgcolor'] = RGB array of foreground color;
- $dom[$key]['width'] = width in pixels;
- $dom[$key]['height'] = height in pixels;
- $dom[$key]['align'] = text alignment;
- $dom[$key]['cols'] = number of colums in table;
- $dom[$key]['rows'] = number of rows in table;
Tags:
Parameters:
method getHTMLUnitToUnits [line 12988]
float getHTMLUnitToUnits(
string
$htmlval, [string
$refsize = 1], [string
$defaultunit = 'px'], [
$points = false], boolean
$point)
|
|
convert html string containing value and unit of measure to user's units or points.
Tags:
Parameters:
method getImageBuffer [line 13503]
string getImageBuffer(
string
$image)
|
|
Get page buffer content.
Tags:
Parameters:
method getImageRBX [line 2366]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 2375]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 1704]
Returns the adjusting factor to convert pixels to user units.
Tags:
method getLastH [line 1682]
Get the last cell height.
Tags:
method GetLineWidth [line 7579]
Returns the current the line width.
Tags:
method getMargins [line 10833]
Returns an array containing current margins:
Tags:
method GetNumChars [line 2918]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumLines [line 3940]
int getNumLines(
string
$txt, [float
$w = 0])
|
|
This method returns the estimated number of lines required to print the text.
Tags:
Parameters:
method getNumPages [line 2155]
Get the total number of insered pages.
Tags:
method getObjFilename [line 13333]
void getObjFilename(
$name, string
$prefix)
|
|
Returns a temporary filename for caching object on filesystem.
Tags:
Parameters:
method getOriginalMargins [line 10856]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 2143]
Get current document page number.
Tags:
method getPageBuffer [line 13444]
string getPageBuffer(
int
$page)
|
|
Get page buffer content.
Tags:
Parameters:
method getPageDimensions [line 1717]
array getPageDimensions(
[int
$pagenum = ''])
|
|
Returns an array of page dimensions: - $this->pagedim[$this->page]['w'] => page_width_in_points
- $this->pagedim[$this->page]['h'] => height in points
- $this->pagedim[$this->page]['wk'] => page_width_in_points
- $this->pagedim[$this->page]['hk'] => height
- $this->pagedim[$this->page]['tm'] => top_margin
- $this->pagedim[$this->page]['bm'] => bottom_margin
- $this->pagedim[$this->page]['lm'] => left_margin
- $this->pagedim[$this->page]['rm'] => right_margin
- $this->pagedim[$this->page]['pb'] => auto_page_break
- $this->pagedim[$this->page]['or'] => page_orientation
- $this->pagedim[$this->page]['olm'] => original_left_margin
- $this->pagedim[$this->page]['orm'] => original_right_margin
Tags:
Parameters:
method getPageGroupAlias [line 9569]
void getPageGroupAlias(
)
|
|
Tags:
method getPageHeight [line 1749]
int getPageHeight(
[int
$pagenum = ''])
|
|
Returns the page height in units.
Tags:
Parameters:
method getPageNumGroupAlias [line 9584]
void getPageNumGroupAlias(
)
|
|
Tags:
method getPageWidth [line 1733]
int getPageWidth(
[int
$pagenum = ''])
|
|
Returns the page width in units.
Tags:
Parameters:
method getPDFData [line 6952]
Returns the PDF data.
Tags:
method getRemainingWidth [line 4301]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 1645]
Return the RTL status
Tags:
method getScaleFactor [line 1779]
Returns the scale factor (number of points in user unit).
Tags:
method GetStringWidth [line 2849]
int GetStringWidth(
string
$s, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0])
|
|
Returns the length of a string in user unit. A font must be selected.
Tags:
Parameters:
method GetX [line 4896]
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 4923]
Returns the ordinate of the current position.
Tags:
method Gradient [line 9972]
void Gradient(
int
$type, array
$col1, array
$col2, array
$coords)
|
|
Output gradient.
Tags:
Parameters:
method Header [line 2384]
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 4423]
image 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], [string
$palign = ''], [boolean
$ismask = false], [mixed
$imgmask = false], [mixed
$border = 0], [boolean
$fitbox = false])
|
|
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 ImageEps [line 10144]
void ImageEps(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [mixed
$link = ''], [boolean
$useBoundingBox = true], [string
$align = ''], [string
$palign = ''], [mixed
$border = 0])
|
|
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
Tags:
Parameters:
method ImagePngAlpha [line 4811]
void ImagePngAlpha(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [boolean
$resize = false], [int
$dpi = 300], [string
$palign = ''])
|
|
Extract info from a PNG image with alpha channel using the GD library.
Tags:
Parameters:
method IncludeJS [line 9108]
method intToRoman [line 13062]
string intToRoman(
int
$number)
|
|
Returns the Roman representation of an integer number
Tags:
Parameters:
method lastPage [line 2132]
void lastPage(
[boolean
$resetmargins = false])
|
|
Reset pointer to the last document page.
Tags:
Parameters:
method Line [line 7729]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 9829]
void LinearGradient(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$coords = array(0,0,1,0)])
|
|
Paints a linear colour gradient.
Tags:
Parameters:
method Link [line 3213]
void Link(
float
$x, float
$y, float
$w, float
$h, mixed
$link, [int
$spaces = 0])
|
|
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 9236]
void ListBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method Ln [line 4868]
void Ln(
[float
$h = ''], [boolean
$cell = false])
|
|
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 7351]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 7387]
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 7374]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 7362]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method movePage [line 13578]
true movePage(
int
$frompage, int
$topage)
|
|
Move a page to a previous position.
Tags:
Parameters:
method MultiCell [line 3702]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
$ln = 1], [float
$x = ''], [float
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false], [boolean
$autopadding = true], [float
$maxh = 0])
|
|
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 objclone [line 14048]
cloned objclone(
object
$object)
|
|
Creates a copy of a class object
Tags:
Parameters:
method Open [line 2049]
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 12172]
void openHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 5015]
void Output(
[string
$name = 'doc.pdf'], [string
$dest = 'I'])
|
|
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 2569]
Returns the current page number.
Tags:
method PageNoFormatted [line 9620]
Returns the current page number formatted as a string.
Tags:
method PieSector [line 10066]
void PieSector(
float
$xc, float
$yc, float
$r, float
$a, float
$b, [
$style = 'FD'], [
$cw = true], [
$o = 90], string
$style:, float
$cw:, float
$o:)
|
|
Draw the sector of a circle. It can be used for instance to render pie charts.
Tags:
Parameters:
method pixelsToUnits [line 7056]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to User's Units.
Tags:
Parameters:
method Polycurve [line 7919]
void Polycurve(
float
$x0, float
$y0, float
$segments, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()])
|
|
Draws a poly-Bezier curve. Each Bezier curve segment is a tangent to the line between the control points at either end of the curve.
Tags:
Parameters:
method Polygon [line 8112]
void Polygon(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()])
|
|
Draws a polygon.
Tags:
Parameters:
method putHtmlListBullet [line 13127]
void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])
|
|
Output an HTML list bullet or ordered item symbol
Tags:
Parameters:
method RadialGradient [line 9847]
void RadialGradient(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$coords = array(0.5,0.5,0.5,0.5,1)])
|
|
Paints a radial colour gradient.
Tags:
Parameters:
method RadioButton [line 9218]
void RadioButton(
$name,
$w, [
$prop = array()])
|
|
Tags:
Parameters:
method readDiskCache [line 13373]
mixed readDiskCache(
$filename, string
$file)
|
|
Read data from a temporary file on filesystem.
Tags:
Parameters:
method Rect [line 7764]
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 8211]
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 removeSHY [line 3432]
string removeSHY(
[string
$txt = ''])
|
|
Removes SHY characters from text.
Tags:
Parameters:
method rfread [line 4781]
Returns rfread(
resource
$handle, int
$length)
|
|
Binary-safe and URL-safe file read. Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
Tags:
Parameters:
method rollbackTransaction [line 14025]
TCPDF rollbackTransaction(
)
|
|
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
Tags:
method Rotate [line 7446]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 8315]
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 7316]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 7276]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 7302]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 7289]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method setAlpha [line 9729]
void setAlpha(
$alpha, [
$bm = 'Normal'])
|
|
Tags:
Parameters:
method SetAuthor [line 1998]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 1865]
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 10404]
void setBarcode(
[string
$bc = ''])
|
|
Set document barcode.
Tags:
Parameters:
method SetBooklet [line 12902]
void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])
|
|
Set the booklet mode for double-sided pages.
Tags:
Parameters:
method setBuffer [line 13383]
void setBuffer(
string
$data)
|
|
Set buffer content (always append data).
Tags:
Parameters:
method setCellHeightRatio [line 9763]
void setCellHeightRatio(
$h)
|
|
Tags:
Parameters:
method SetCellPadding [line 1853]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method SetCompression [line 1958]
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 setContentMark [line 2262]
void setContentMark(
[int
$page = 0])
|
|
Set start-writing mark on selected page.
Tags:
Parameters:
method SetCreator [line 2022]
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 SetDefaultMonospacedFont [line 3163]
void SetDefaultMonospacedFont(
string
$font)
|
|
Defines the default monospaced font.
Tags:
Parameters:
method setDefaultTableColumns [line 9753]
void setDefaultTableColumns(
[
$cols = 4])
|
|
Tags:
Parameters:
method SetDisplayMode [line 1880]
void SetDisplayMode(
mixed
$zoom, [string
$layout = 'SinglePage'], [string
$mode = 'UseNone'])
|
|
Defines the way the document is to be displayed by the viewer.
Tags:
Parameters:
method SetDrawColor [line 2624]
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 SetDrawColorArray [line 2601]
void SetDrawColorArray(
array
$color)
|
|
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 SetDrawSpotColor [line 2662]
void SetDrawSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
Tags:
Parameters:
method setExtGState [line 9698]
method SetFillColor [line 2704]
void SetFillColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [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 SetFillColorArray [line 2681]
void SetFillColorArray(
array
$color)
|
|
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 SetFillSpotColor [line 2746]
void SetFillSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
Tags:
Parameters:
method SetFont [line 3118]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0], [string
$fontfile = ''])
|
|
Sets the font used to print character strings. 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. If you just wish to change the current font size, it is simpler to call SetFontSize(). 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
Tags:
Parameters:
method setFontBuffer [line 13519]
void setFontBuffer(
string
$font, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method SetFontSize [line 3138]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFontSubBuffer [line 13541]
void setFontSubBuffer(
string
$font, string
$key, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method setFooter [line 2492]
This method is used to render the page footer.
Tags:
method setFooterFont [line 6919]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 2330]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setGraphicVars [line 13300]
void setGraphicVars(
$gvars
$gvars)
|
|
Set graphic variables.
Tags:
Parameters:
method setHeader [line 2461]
This method is used to render the page header.
Tags:
method setHeaderData [line 2281]
void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 6899]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 2310]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setHtmlLinksStyle [line 12973]
void setHtmlLinksStyle(
[array
$color = array(0,0,255)], [string
$fontstyle = 'U'])
|
|
Set the color and font style for HTML links.
Tags:
Parameters:
method setHtmlVSpace [line 12942]
void setHtmlVSpace(
array
$tagvs)
|
|
Set the vertical spaces for HTML tags. The array must have the following structure (example): $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1))); The first array level contains the tag names, the second level contains 0 for opening tags or 1 for closing tags, the third level contains the vertical space unit (h) and the number spaces to add (n). If the h parameter is not specified, default values are used.
Tags:
Parameters:
method setImageBuffer [line 13460]
void setImageBuffer(
string
$image, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setImageScale [line 1693]
void setImageScale(
float
$scale)
|
|
Set the adjusting factor to convert pixels to user units.
Tags:
Parameters:
method setImageSubBuffer [line 13483]
void setImageSubBuffer(
string
$image, string
$key, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setJPEGQuality [line 9740]
void setJPEGQuality(
$quality)
|
|
Tags:
Parameters:
method SetKeywords [line 2010]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 6939]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 1672]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 1809]
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 7604]
void SetLineStyle(
array
$style)
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 7563]
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 3190]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setListIndentWidth [line 12952]
void setListIndentWidth(
float
$width)
|
|
Set custom width for list indentation.
Tags:
Parameters:
method setLIsymbol [line 12862]
void setLIsymbol(
[string
$symbol = '!'])
|
|
Set the default bullet to be used as LI bullet symbol
Tags:
Parameters:
method SetMargins [line 1792]
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 setOpenCell [line 12962]
void setOpenCell(
boolean
$isopen)
|
|
Set the top/bottom cell sides to be open or closed when the cell cross the page.
Tags:
Parameters:
method setPage [line 2085]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageBuffer [line 13417]
void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])
|
|
Set page buffer content.
Tags:
Parameters:
method setPageFormat [line 1500]
void setPageFormat(
mixed
$format, [string
$orientation = 'P'])
|
|
Set the page format
Tags:
Parameters:
method setPageMark [line 2251]
Set start-writing mark on current page for multicell borders and fills. This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
Tags:
method setPageOrientation [line 1573]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageUnit [line 1458]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 9782]
void setPDFVersion(
[
$version = '1.7'])
|
|
Tags:
Parameters:
method setPrintFooter [line 2357]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 2348]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 7219]
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 1839]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 1629]
void setRTL(
Boolean
$enable, [Boolean
$resetx = true])
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setSignature [line 9454]
void setSignature(
[
$signing_cert = ''], [
$private_key = ''], [
$private_key_password = ''], [
$extracerts = ''], [
$cert_type = 2], [
$info = array()])
|
|
Tags:
Parameters:
method setSpacesRE [line 1614]
void setSpacesRE(
[string
$re = '/[\s]/'])
|
|
Set regular expression to detect withespaces or word separators.
Tags:
Parameters:
method SetSubject [line 1986]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setTableHeader [line 2534]
This method is used to render the table header on new page (if any).
Tags:
method setTempRTL [line 1655]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 2788]
void SetTextColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [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 SetTextColorArray [line 2765]
void SetTextColorArray(
array
$color)
|
|
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 SetTextSpotColor [line 2827]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 1974]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 1824]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 9428]
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 setViewerPreferences [line 9812]
void setViewerPreferences(
$preferences)
|
|
Tags:
Parameters:
method setVisibility [line 9650]
method SetX [line 4936]
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 4999]
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 4968]
void SetY(
float
$y, [bool
$resetx = true])
|
|
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 7506]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 7479]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 7492]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 8266]
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 startPage [line 2211]
void startPage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Starts a new page to the document. The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
Tags:
Parameters:
method startPageGroup [line 9479]
void startPageGroup(
[
$page = ''])
|
|
Tags:
Parameters:
method startTransaction [line 13998]
Stores a copy of the current TCPDF object used for undo operation.
Tags:
method StartTransform [line 7247]
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 7260]
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 swapMargins [line 12918]
void swapMargins(
[boolean
$reverse = true])
|
|
Swap the left and right margins.
Tags:
Parameters:
method Text [line 3314]
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.
Tags:
Parameters:
method TextField [line 9205]
void TextField(
$name,
$w,
$h, [
$prop = array()])
|
|
Tags:
Parameters:
method Transform [line 7539]
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 7422]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 7399]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 7410]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 7067]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UniArrSubString [line 4340]
Return UniArrSubString(
string
$uniarr, [int
$start = ''], [int
$end = ''])
|
|
Extract a slice of the $uniarr array and return it as string.
Tags:
Parameters:
method unichr [line 4373]
Returns the unicode caracter specified by UTF-8 code
Tags:
Parameters:
method UTF8ArrayToUniArray [line 4361]
Return UTF8ArrayToUniArray(
string
$ta)
|
|
Convert an array of UTF8 values to array of unicode characters
Tags:
Parameters:
method UTF8ArrSubString [line 4317]
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 8449]
string utf8Bidi(
array
$ta, [string
$str = ''], [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8StringToArray [line 6701]
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 8435]
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 UTF8ToLatin1 [line 6808]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 6792]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 3983]
mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0], [boolean
$firstline = false], [boolean
$firstblock = false], [float
$maxh = 0])
|
|
This method prints text from the current position.
Tags:
Parameters:
method write1DBarcode [line 10433]
void write1DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [float
$xres = 0.4], [array
$style = ''], [string
$align = ''])
|
|
Print a Linear Barcode.
Tags:
Parameters:
method write2DBarcode [line 10686]
void write2DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [array
$style = ''], [string
$align = ''])
|
|
Print 2D Barcode.
Tags:
Parameters:
method writeBarcode [line 10636]
void writeBarcode(
int
$x, int
$y, int
$w, int
$h, string
$type, string
$style, string
$font, int
$xres, string
$code)
|
|
This function is DEPRECATED, please use the new write1DBarcode() function.
Tags:
Parameters:
method writeDiskCache [line 13345]
void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)
|
|
Writes data to a temporary file on filesystem.
Tags:
Parameters:
method writeHTML [line 11336]
void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = false], [boolean
$reseth = false], [boolean
$cell = false], [string
$align = ''])
|
|
Allows to preserve some HTML formatting (limited support). IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. 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, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
Tags:
Parameters:
method writeHTMLCell [line 10924]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 0], [boolean
$reseth = true], [string
$align = ''], [boolean
$autopadding = 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 9170]
void _addfield(
$type,
$name,
$x,
$y,
$w,
$h,
$prop)
|
|
Tags:
Parameters:
method _beginpage [line 6481]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _datastring [line 6591]
string _datastring(
string
$s)
|
|
Format a date string for meta information
Tags:
Parameters:
method _destroy [line 5170]
void _destroy(
[boolean
$destroyall = false], [boolean
$preserve_objcopy = false])
|
|
Unset all class variables except the following critical variables: internal_encoding, state, bufferlen, buffer and diskcache.
Tags:
Parameters:
method _dochecks [line 5197]
Check for locale-related bug
Tags:
method _dolinethrough [line 6556]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dounderline [line 6542]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _enddoc [line 6420]
Output end of document (EOF).
Tags:
method _endpage [line 6520]
method _escape [line 6580]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 6618]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 6569]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 7187]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getfontpath [line 5213]
method _JScolor [line 9146]
method _md5_16 [line 7148]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 6529]
Begin a new object.
Tags:
method _objectkey [line 7080]
Compute encryption key depending on object number where the encrypted data is stored
Tags:
Parameters:
method _out [line 6649]
Output a string to the document.
Tags:
Parameters:
method _outarc [line 10046]
void _outarc(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Output an arc
Tags:
Parameters:
method _outCurve [line 7709]
void _outCurve(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Tags:
Parameters:
method _outLine [line 7673]
method _outPoint [line 7659]
method _outRect [line 7690]
void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)
|
|
Draws a rectangle.
Tags:
Parameters:
method _Ovalue [line 7161]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for RC4 encryption)
Tags:
Parameters:
method _parsejpeg [line 4650]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 4676]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannots [line 5369]
Output Page Annotations. !!! THIS FUNCTION IS NOT YET COMPLETED !!! See section 8.4 of PDF reference.
Tags:
Parameters:
method _putbookmarks [line 9044]
method _putcatalog [line 6285]
method _putcertification [line 9371]
void _putcertification(
)
|
|
Tags:
method _putcidfont0 [line 6034]
void _putcidfont0(
array
$font)
|
|
Output CID-0 fonts.
Tags:
Parameters:
method _putEmbeddedFiles [line 3283]
void _putEmbeddedFiles(
)
|
|
Embedd the attached files.
Tags:
method _putencryption [line 7089]
Put encryption on PDF document.
Tags:
method _putextgstates [line 9708]
method _putfonts [line 5724]
method _putfontwidths [line 5851]
void _putfontwidths(
array
$font, [int
$cidoffset = 0])
|
|
Outputs font widths
Tags:
Parameters:
method _putheader [line 6412]
method _putimages [line 6094]
method _putinfo [line 6251]
Adds some Metadata information (see Chapter 10.2 of PDF Reference)
Tags:
method _putjavascript [line 9118]
method _putocg [line 9629]
method _putpages [line 5224]
method _putresourcedict [line 6177]
Output Resources Dictionary.
Tags:
method _putresources [line 6218]
method _putshaders [line 9996]
method _putspotcolors [line 6149]
Output Spot Colors Resources.
Tags:
method _putstream [line 6635]
void _putstream(
string
$s)
|
|
Output a stream.
Tags:
Parameters:
method _puttrailer [line 6398]
method _puttruetypeunicode [line 5949]
void _puttruetypeunicode(
array
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putuserrights [line 9321]
method _putviewerpreferences [line 6328]
void _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _putxobjectdict [line 6166]
Output object dictionary for images.
Tags:
method _RC4 [line 7108]
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 6604]
string _textstring(
string
$s)
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 4634]
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 _Uvalue [line 7174]
Compute U value (used for RC4 encryption)
Tags:
|
|