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 508]
Tags:
$AliasNumPage = '{pnb}'
[line 514]
Tags:
$annotation_fonts = array()
[line 1452]
List of fonts used on form fields (fontname => fontkey).
Tags:
$annots_start_obj_id = 200000
[line 1361]
Start ID for annotation objects
Tags:
$annot_obj_id = 200000
[line 1368]
Max ID of annotation object
Tags:
$apxo_obj_id = 400000
[line 1445]
Current ID of appearance streams XObjects
Tags:
$apxo_start_obj_id = 400000
[line 1438]
Start ID for appearance streams XObjects
Tags:
$author = ''
[line 490]
Tags:
$AutoPageBreak =
[line 448]
Tags:
$barcode = false
[line 606]
Tags:
$bgcolor =
[line 699]
Tags:
$bMargin =
[line 289]
Tags:
$booklet = false
[line 1100]
Booklet mode for double-sided pages
Tags:
$buffer =
[line 193]
Tags:
$bufferlen = 0
[line 1200]
Length of the buffer in bytes.
Tags:
$byterange_string = '/ByteRange[0 ********** ********** **********]'
[line 1333]
ByteRange placemark used during signature process.
Tags:
$cache_file_length = array()
[line 1256]
Array used to store the lengths of cache files
Tags:
$cache_maxsize_UTF8StringToArray = 8
[line 1284]
Maximum size of cache array used for UTF8StringToArray() method.
Tags:
$cache_size_UTF8StringToArray = 0
[line 1291]
Current size of cache array used for UTF8StringToArray() method.
Tags:
$cache_UTF8StringToArray = array()
[line 1277]
Cache array for UTF8StringToArray() method.
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 950]
Default cell height ratio.
Tags:
$cMargin =
[line 296]
Tags:
$cntmrk = array()
[line 987]
Array used to store content positions inside the pages buffer. keys are the page numbers
Tags:
$ColorFlag =
[line 442]
Tags:
$compress =
[line 211]
Tags:
$CoreFonts =
[line 332]
Tags:
$creator = ''
[line 502]
Tags:
$CurOrientation =
[line 217]
Tags:
$CurrentFont =
[line 406]
Tags:
$currpagegroup =
[line 908]
Contains the alias of the current page group
Tags:
$curr_annot_obj_id = 200000
[line 1375]
Current ID of annotation object
Tags:
$customlistindent = -1
[line 1122]
Tags:
$default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255),'strokeColor'=>array(128,128,128))
[line 1389]
Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
Tags:
$default_monospaced_font = 'courier'
[line 1242]
Default monospaced font
Tags:
$default_table_columns = 4
[line 648]
Tags:
$diffs = array()
[line 350]
Tags:
$diskcache = false
[line 1207]
If true enables disk caching.
Tags:
$dpi = 72
[line 887]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 424]
Tags:
$embeddedfiles = array()
[line 1136]
Tags:
$embedded_start_obj_id = 100000
[line 1354]
Start ID for embedded file objects
Tags:
$encoding = 'UTF-8'
[line 718]
Tags:
$encrypted =
[line 748]
Indicates whether document is protected
Tags:
$encryption_key =
[line 802]
RC4 encryption key
Tags:
$enc_obj_id =
[line 776]
encryption object id
Tags:
$endlinex = 0
[line 1016]
End position of the latest inserted line
Tags:
$epsmarker = 'x#!#EPS#!#x'
[line 1079]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 936]
Array of transparency objects and parameters.
Tags:
$feps = 0.005
[line 1107]
Epsilon value used for float calculations
Tags:
$fgcolor =
[line 669]
Tags:
$fhPt =
[line 241]
Tags:
$FillColor =
[line 430]
Tags:
$FontAscent =
[line 387]
Tags:
$FontDescent =
[line 394]
Tags:
$FontFamily =
[line 374]
Tags:
$FontFiles = array()
[line 344]
Tags:
$fontkeys = array()
[line 1221]
Store the font keys.
Tags:
$fontlist = array()
[line 663]
Tags:
$fonts = array()
[line 338]
Tags:
$FontSize =
[line 418]
Tags:
$FontSizePt =
[line 412]
Tags:
$FontStyle =
[line 380]
Tags:
$font_obj_ids = array()
[line 1228]
Store the font object IDs.
Tags:
$footerlen = array()
[line 1002]
Array used to store footer length of each page.
Tags:
$footerpos = array()
[line 994]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 594]
Tags:
$footer_margin =
[line 568]
Tags:
$form_action = ''
[line 1417]
Current form action (used during XHTML rendering)
Tags:
$form_enctype = 'application/x-www-form-urlencoded'
[line 1424]
Current form encryption type (used during XHTML rendering)
Tags:
$form_mode = 'post'
[line 1431]
Current method to submit forms.
Tags:
$form_obj_id = array()
[line 1382]
List of form annotations IDs
Tags:
$fwPt =
[line 235]
Tags:
$gradients = array()
[line 971]
Array for storing gradient information.
Tags:
$h =
[line 265]
Tags:
$header_font =
[line 588]
Tags:
$header_logo = ''
[line 624]
Tags:
$header_logo_width = 30
[line 630]
Tags:
$header_margin =
[line 562]
Tags:
$header_string = ''
[line 642]
Tags:
$header_title = ''
[line 636]
Tags:
$hPt =
[line 253]
Tags:
$HREF = array()
[line 657]
Tags:
$htmlLinkColorArray = array(0, 0, 255)
[line 1158]
Default color for html links
Tags:
$htmlLinkFontStyle = 'U'
[line 1165]
Default font style to add to html links
Tags:
$htmlvspace = 0
[line 1058]
Count the latest inserted vertical spaces on HTML
Tags:
$imagekeys = array()
[line 1193]
Store the image keys.
Tags:
$images = array()
[line 356]
Tags:
$imgscale = 1
[line 538]
Tags:
$img_rb_x =
[line 522]
Tags:
$img_rb_y =
[line 530]
Tags:
$InFooter = false
[line 460]
Tags:
$internal_encoding =
[line 725]
Tags:
$inthead = false
[line 1487]
True when we are in thead
Tags:
$intmrk = array()
[line 979]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$isunicode = false
[line 546]
Tags:
$javascript = ''
[line 828]
javascript code
Tags:
$jpeg_quality =
[line 943]
Set the default JPEG compression quality (1-100)
Tags:
$js_objects = array()
[line 1396]
Javascript objects array
Tags:
$js_obj_id = 300000
[line 1410]
Current ID of javascript object
Tags:
$js_start_obj_id = 300000
[line 1403]
Start ID for javascript objects
Tags:
$k =
[line 229]
Tags:
$keywords = ''
[line 496]
Tags:
$l =
[line 600]
Tags:
$lasth =
[line 320]
Tags:
$last_rc4_key =
[line 783]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_rc4_key_c =
[line 790]
last RC4 computed key
Tags:
$LayoutMode =
[line 472]
Tags:
$linestyleCap = '0 J'
[line 1030]
PDF string for last line width
Tags:
$linestyleDash = '[] 0 d'
[line 1044]
PDF string for last line width
Tags:
$linestyleJoin = '0 j'
[line 1037]
PDF string for last line width
Tags:
$linestyleWidth = ''
[line 1023]
PDF string for last line width
Tags:
$linethrough =
[line 842]
line trough state
Tags:
$LineWidth =
[line 326]
Tags:
$links = array()
[line 368]
Tags:
$lispacer = ''
[line 711]
Tags:
$listcount = array()
[line 681]
Tags:
$listindent =
[line 693]
Tags:
$listnum = 0
[line 687]
Tags:
$listordered = array()
[line 675]
Tags:
$lisymbol = ''
[line 1072]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 271]
Tags:
$n =
[line 181]
Tags:
$newline = true
[line 1009]
True if a newline is created.
Tags:
$newpagegroup = array()
[line 894]
Array of page numbers were a new page group was started
Tags:
$numfonts = 0
[line 1214]
Counts the number of fonts.
Tags:
$numimages = 0
[line 1186]
Counts the number of pages.
Tags:
$numpages = 0
[line 1172]
Counts the number of pages.
Tags:
$n_js =
[line 835]
javascript counter
Tags:
$n_ocg_print =
[line 922]
Print visibility.
Tags:
$n_ocg_view =
[line 929]
View visibility.
Tags:
$objcopy =
[line 1249]
Used to store a cloned copy of the current class object
Tags:
$offsets =
[line 187]
Tags:
$oldcMargin =
[line 302]
Tags:
$opencell = true
[line 1129]
Tags:
$openMarkedContent = false
[line 1051]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 575]
Tags:
$original_rMargin =
[line 582]
Tags:
$OutlineRoot =
[line 818]
Outline root for bookmark
Tags:
$outlines = array()
[line 811]
Outlines for bookmark
Tags:
$Ovalue =
[line 762]
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 796]
RC4 padding
Tags:
$page =
[line 175]
Tags:
$PageAnnots = array()
[line 362]
Tags:
$PageBreakTrigger =
[line 454]
Tags:
$pagedim = array()
[line 223]
Tags:
$pagegroups =
[line 901]
Contains the number of pages of the groups
Tags:
$pagelen = array()
[line 1179]
Array containing page lengths in bytes.
Tags:
$PageMode =
[line 964]
A name object specifying how the document should be displayed when opened.
Tags:
$pageopen = array()
[line 1235]
Store the fage status (true when opened, false when closed).
Tags:
$pages = array()
[line 199]
Tags:
$page_obj_id = array()
[line 1347]
ID of page objects
Tags:
$PDFVersion = '1.7'
[line 553]
Tags:
$premode = false
[line 1143]
Tags:
$print_footer = true
[line 618]
Tags:
$print_header = true
[line 612]
Tags:
$Pvalue =
[line 769]
P entry in pdf document
Tags:
$radiobutton_groups = array()
[line 1459]
List of radio buttons parent objects.
Tags:
$radio_groups = array()
[line 1466]
List of radio group objects IDs
Tags:
$re_spaces = '/[\s]/'
[line 1319]
Regular expression used to find blank characters used for word-wrapping.
Tags:
$rMargin =
[line 283]
Tags:
$rtl = false
[line 732]
Tags:
$sign = false
[line 1298]
If true enables document signing
Tags:
$signature_data = array()
[line 1305]
Signature data
Tags:
$signature_max_length = 11742
[line 1312]
Signature max length
Tags:
$sig_annot_ref = '***SIGANNREF*** 0 R'
[line 1340]
Placemark used during signature process.
Tags:
$sig_obj_id = 0
[line 1326]
Signature object ID
Tags:
$spot_colors = array()
[line 1065]
Array of Spot colors
Tags:
$start_transaction_page = 0
[line 1480]
Store page number when startTransaction() is called.
Tags:
$state =
[line 205]
Tags:
$subject = ''
[line 484]
Tags:
$tagvspaces = array()
[line 1114]
Array used for custom vertical spaces for HTML tags
Tags:
$tempfontsize = 10
[line 705]
Tags:
$TextColor =
[line 436]
Tags:
$textindent = 0
[line 1473]
Text indentation value (used for text-indent CSS attribute)
Tags:
$thead = ''
[line 1263]
Table header content to be repeated on each new page
Tags:
$theadMargins = array()
[line 1270]
Margins used for table header.
Tags:
$title = ''
[line 478]
Tags:
$tMargin =
[line 277]
Tags:
$tmprtl = false
[line 739]
Tags:
$transfmatrix = array()
[line 1086]
Array of transformation matrix
Tags:
$transfmatrix_key = 0
[line 1093]
Current key for transformation matrix
Tags:
$transfmrk = array()
[line 1151]
Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers
Tags:
$underline =
[line 400]
Tags:
$ur =
[line 852]
If true enables user's rights on PDF reader
Tags:
$ur_annots =
[line 866]
Names specifying additional annotation-related usage rights for the document.
Tags:
$ur_document =
[line 859]
Names specifying additional document-wide usage rights for the document.
Tags:
$ur_form =
[line 873]
Names specifying additional form-field-related usage rights for the document.
Tags:
$ur_signature =
[line 880]
Names specifying additional signature-related usage rights for the document.
Tags:
$Uvalue =
[line 755]
U entry in pdf document
Tags:
$viewer_preferences =
[line 957]
PDF viewer preferences.
Tags:
$visibility = 'all'
[line 915]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 259]
Tags:
$wPt =
[line 247]
Tags:
$x =
[line 308]
Tags:
$y =
[line 314]
Tags:
$ZoomMode =
[line 466]
Tags:
Class Methods
constructor __construct [line 1506]
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 1632]
Default destructor.
Tags:
method AcceptPageBreak [line 3636]
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 11483]
the addExtGState(
$parms, array
$params)
|
|
Add transparency parameters to the current extgstate
Tags:
Parameters:
method AddFont [line 3188]
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 7852]
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 15119]
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 addJavascriptObject [line 10103]
int addJavascriptObject(
string
$script, [boolean
$onload = false])
|
|
Adds a javascript object and return object ID
Tags:
Parameters:
method AddLink [line 3429]
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 2385]
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 2810]
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 16143]
void addTOC(
[int
$page = ''], [string
$numbersfont = ''], [string
$filler = '.'], [string
$toc_name = 'TOC'])
|
|
Output a Table of Content Index (TOC). After calling this method you have to call addPage() to add other content. You can override this method to achieve different styles.
Tags:
Parameters:
method AliasNbPages [line 11291]
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 11318]
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 3485]
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 9345]
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 7750]
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 9989]
void Bookmark(
string
$txt, [int
$level = 0], [float
$y = -1], [int
$page = ''])
|
|
Adds a bookmark.
Tags:
Parameters:
method Button [line 10997]
void Button(
string
$name, int
$w, int
$h, string
$caption, mixed
$action, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a button field
Tags:
Parameters:
method Cell [line 3697]
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 10927]
void CheckBox(
string
$name, int
$w, [boolean
$checked = false], [array
$prop = array()], [array
$opt = array()], [string
$onvalue = 'Yes'], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a CheckBox field
Tags:
Parameters:
method checkPageBreak [line 3649]
boolean checkPageBreak(
[float
$h = 0], [mixed
$y = ''], [boolean
$addpage = true])
|
|
Add page if needed.
Tags:
Parameters:
method Circle [line 8979]
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 11736]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 2279]
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 14766]
void closeHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method ComboBox [line 10866]
void ComboBox(
string
$name, int
$w, int
$h, array
$values, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a Combo-box field
Tags:
Parameters:
method commitTransaction [line 16301]
void commitTransaction(
)
|
|
Delete the copy of the current TCPDF object used for undo operation.
Tags:
method convertHTMLColorToDec [line 7885]
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 11656]
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 8754]
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 16001]
true deletePage(
int
$page)
|
|
Remove the specified page.
Tags:
Parameters:
method Ellipse [line 8875]
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 16355]
boolean empty_string(
srting
$str)
|
|
Determine whether a string is empty.
Tags:
Parameters:
method endPage [line 2404]
Terminate the current page
Tags:
method Error [line 2251]
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 2643]
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 11395]
void formatPageNumber(
int
$num)
|
|
Format the page numbers. This method can be overriden for custom formats.
Tags:
Parameters:
method formatTOCPageNumber [line 11407]
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 5286]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 11303]
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 11331]
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 getAnnotOptFromJSProp [line 10234]
array getAnnotOptFromJSProp(
array
$prop)
|
|
Convert JavaScript form fields properties array to Annotation Properties array.
Tags:
Parameters:
method GetArrStringWidth [line 3091]
mixed GetArrStringWidth(
string
$sa, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0], [boolean
$getarray = false])
|
|
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.
Tags:
Parameters:
method getBarcode [line 12207]
Get current barcode.
Tags:
method getBorderMode [line 4150]
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 1982]
int getBreakMargin(
[int
$pagenum = ''])
|
|
Returns the page break margin.
Tags:
Parameters:
method getBuffer [line 15687]
Get buffer content.
Tags:
method getCellCode [line 3749]
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 11576]
void getCellHeightRatio(
)
|
|
return the height of cell repect font height.
Tags:
method GetCharWidth [line 3127]
int GetCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getFontBuffer [line 15847]
string getFontBuffer(
string
$font)
|
|
Get font buffer content.
Tags:
Parameters:
method getFontFamily [line 12693]
Returns the current font family name.
Tags:
method getFontSize [line 12673]
Returns the current font size.
Tags:
method getFontSizePt [line 12683]
Returns the current font size in points unit.
Tags:
method getFontsList [line 3166]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFontStyle [line 12703]
Returns the current font style.
Tags:
method getFooterFont [line 7811]
method getFooterMargin [line 2557]
Returns footer margin in user units.
Tags:
method getFormDefaultProp [line 10609]
array getFormDefaultProp(
)
|
|
Return the default properties for form fields.
Tags:
method getGDgamma [line 5229]
void getGDgamma(
float
$v)
|
|
Correct the gamma value to be used with GD library
Tags:
Parameters:
method getGraphicVars [line 15555]
Returns current graphic variables as array.
Tags:
method getGroupPageNo [line 11344]
current getGroupPageNo(
)
|
|
Return the current page in the group.
Tags:
method getGroupPageNoFormatted [line 11354]
void getGroupPageNoFormatted(
)
|
|
Returns the current group page number formatted as a string.
Tags:
method getHeaderData [line 2512]
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 7791]
method getHeaderMargin [line 2537]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 12739]
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 15274]
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 15789]
string getImageBuffer(
string
$image)
|
|
Get image buffer content.
Tags:
Parameters:
method getImageFileType [line 4711]
string getImageFileType(
string
$imgfile)
|
|
Return the image type given the file name and path
Tags:
Parameters:
method getImageRBX [line 2583]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 2592]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 1921]
Returns the adjusting factor to convert pixels to user units.
Tags:
method getLastH [line 1899]
Get the last cell height.
Tags:
method GetLineWidth [line 8468]
Returns the current the line width.
Tags:
method getMargins [line 12636]
Returns an array containing current margins:
Tags:
method GetNumChars [line 3154]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumLines [line 4229]
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 2372]
Get the total number of insered pages.
Tags:
method getObjFilename [line 15619]
void getObjFilename(
$name, string
$prefix)
|
|
Returns a temporary filename for caching object on filesystem.
Tags:
Parameters:
method getOriginalMargins [line 12659]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 2360]
Get current document page number.
Tags:
method getPageBuffer [line 15730]
string getPageBuffer(
int
$page)
|
|
Get page buffer content.
Tags:
Parameters:
method getPageDimensions [line 1934]
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 11366]
alias getPageGroupAlias(
)
|
|
Return the alias of the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces. (will be replaced by the total number of pages in this group).
Tags:
method getPageHeight [line 1966]
int getPageHeight(
[int
$pagenum = ''])
|
|
Returns the page height in units.
Tags:
Parameters:
method getPageNumGroupAlias [line 11381]
alias getPageNumGroupAlias(
)
|
|
Return the alias for the page number on the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces. (will be replaced by the total number of pages in this group).
Tags:
method getPageWidth [line 1950]
int getPageWidth(
[int
$pagenum = ''])
|
|
Returns the page width in units.
Tags:
Parameters:
method getPDFData [line 7834]
Returns the PDF data.
Tags:
method getRemainingWidth [line 4613]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 1834]
Return the RTL status
Tags:
method getScaleFactor [line 1996]
Returns the scale factor (number of points in user unit).
Tags:
method getSpaceString [line 13207]
Returns the string used to find spaces
Tags:
method GetStringWidth [line 3075]
mixed GetStringWidth(
string
$s, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0], [boolean
$getarray = false])
|
|
Returns the length of a string in user unit. A font must be selected.
Tags:
Parameters:
method GetX [line 5270]
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 5297]
Returns the ordinate of the current position.
Tags:
method get_mqr [line 4989]
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
Tags:
method Gradient [line 11759]
void Gradient(
int
$type, array
$col1, array
$col2, array
$coords)
|
|
Output gradient.
Tags:
Parameters:
method Header [line 2601]
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 4754]
image Image(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [mixed
$resize = false], [int
$dpi = 300], [string
$palign = ''], [boolean
$ismask = false], [mixed
$imgmask = false], [mixed
$border = 0], [boolean
$fitbox = false], [boolean
$hidden = 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 11931]
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 5185]
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 10090]
void IncludeJS(
string
$script)
|
|
Adds a javascript
Tags:
Parameters:
method intToRoman [line 15348]
string intToRoman(
int
$number)
|
|
Returns the Roman representation of an integer number
Tags:
Parameters:
method isRTLTextDir [line 1878]
Return the current temporary RTL status
Tags:
method lastPage [line 2349]
void lastPage(
[boolean
$resetmargins = false])
|
|
Reset pointer to the last document page.
Tags:
Parameters:
method Line [line 8621]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 11616]
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 3468]
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 10806]
void ListBox(
string
$name, int
$w, int
$h, array
$values, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a List-box field
Tags:
Parameters:
method Ln [line 5242]
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 8240]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 8276]
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 8263]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 8251]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method movePage [line 15864]
true movePage(
int
$frompage, int
$topage)
|
|
Move a page to a previous position.
Tags:
Parameters:
method MultiCell [line 3991]
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 16344]
cloned objclone(
object
$object)
|
|
Creates a copy of a class object
Tags:
Parameters:
method Open [line 2266]
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 14221]
void openHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 5389]
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 2794]
Returns the current page number.
Tags:
method PageNoFormatted [line 11417]
Returns the current page number formatted as a string.
Tags:
method PieSector [line 11853]
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 7942]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to User's Units.
Tags:
Parameters:
method Polycurve [line 8811]
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 9031]
void Polygon(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [boolean
$closed = true])
|
|
Draws a polygon.
Tags:
Parameters:
method PolyLine [line 9005]
void PolyLine(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], boolean
$closed)
|
|
Draws a polygonal line
Tags:
Parameters:
method putHtmlListBullet [line 15413]
void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])
|
|
Output an HTML list bullet or ordered item symbol
Tags:
Parameters:
method RadialGradient [line 11634]
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 10718]
void RadioButton(
string
$name, int
$w, [array
$prop = array()], [array
$opt = array()], [string
$onvalue = 'On'], [boolean
$checked = false], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a RadioButton field
Tags:
Parameters:
method readDiskCache [line 15659]
mixed readDiskCache(
$filename, string
$file)
|
|
Read data from a temporary file on filesystem.
Tags:
Parameters:
method Rect [line 8656]
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 9156]
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 3714]
string removeSHY(
[string
$txt = ''])
|
|
Removes SHY characters from text.
Tags:
Parameters:
method rfread [line 5155]
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 16315]
TCPDF rollbackTransaction(
[boolean
$self = false])
|
|
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
Tags:
Parameters:
method Rotate [line 8335]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 9260]
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 8205]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 8165]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 8191]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 8178]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method setAlpha [line 11533]
void setAlpha(
float
$alpha, [string
$bm = 'Normal'])
|
|
Set alpha for stroking (CA) and non-stroking (ca) operations.
Tags:
Parameters:
method SetAuthor [line 2215]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 2082]
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 12197]
void setBarcode(
[string
$bc = ''])
|
|
Set document barcode.
Tags:
Parameters:
method SetBooklet [line 15188]
void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])
|
|
Set the booklet mode for double-sided pages.
Tags:
Parameters:
method setBuffer [line 15669]
void setBuffer(
string
$data)
|
|
Set buffer content (always append data).
Tags:
Parameters:
method setCellHeightRatio [line 11567]
void setCellHeightRatio(
int
$h)
|
|
Set the height of the cell (line height) respect the font height.
Tags:
Parameters:
method SetCellPadding [line 2070]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method SetCompression [line 2175]
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 2479]
void setContentMark(
[int
$page = 0])
|
|
Set start-writing mark on selected page.
Tags:
Parameters:
method SetCreator [line 2239]
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 3418]
void SetDefaultMonospacedFont(
string
$font)
|
|
Defines the default monospaced font.
Tags:
Parameters:
method setDefaultTableColumns [line 11557]
void setDefaultTableColumns(
[int
$cols = 4])
|
|
Set the default number of columns in a row for HTML tables.
Tags:
Parameters:
method SetDisplayMode [line 2097]
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 2849]
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 2826]
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 2887]
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 11502]
void setExtGState(
array
$gs)
|
|
Add an extgstate
Tags:
Parameters:
method SetFillColor [line 2929]
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 2906]
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 2971]
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 3373]
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 15805]
void setFontBuffer(
string
$font, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method SetFontSize [line 3393]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFontSubBuffer [line 15827]
void setFontSubBuffer(
string
$font, string
$key, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method setFooter [line 2713]
This method is used to render the page footer.
Tags:
method setFooterFont [line 7801]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 2547]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setFormDefaultProp [line 10598]
void setFormDefaultProp(
[array
$prop = array()])
|
|
Set default properties for form fields.
Tags:
Parameters:
method setGraphicVars [line 15586]
void setGraphicVars(
$gvars
$gvars)
|
|
Set graphic variables.
Tags:
Parameters:
method setHeader [line 2678]
This method is used to render the page header.
Tags:
method setHeaderData [line 2498]
void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 7781]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 2527]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setHtmlLinksStyle [line 15259]
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 15228]
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 15746]
void setImageBuffer(
string
$image, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setImageScale [line 1910]
void setImageScale(
float
$scale)
|
|
Set the adjusting factor to convert pixels to user units.
Tags:
Parameters:
method setImageSubBuffer [line 15769]
void setImageSubBuffer(
string
$image, string
$key, array
$data)
|
|
Set image buffer content for a specified sub-key.
Tags:
Parameters:
method setJPEGQuality [line 11544]
void setJPEGQuality(
int
$quality)
|
|
Set the default JPEG compression quality (1-100)
Tags:
Parameters:
method SetKeywords [line 2227]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 7821]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 1889]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 2026]
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 8493]
void SetLineStyle(
array
$style)
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 8452]
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 3445]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setListIndentWidth [line 15238]
void setListIndentWidth(
float
$width)
|
|
Set custom width for list indentation.
Tags:
Parameters:
method setLIsymbol [line 15148]
void setLIsymbol(
[string
$symbol = '!'])
|
|
Set the default bullet to be used as LI bullet symbol
Tags:
Parameters:
method SetMargins [line 2009]
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 15248]
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 2302]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageBuffer [line 15703]
void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])
|
|
Set page buffer content.
Tags:
Parameters:
method setPageFormat [line 1689]
void setPageFormat(
mixed
$format, [string
$orientation = 'P'])
|
|
Set the page format
Tags:
Parameters:
method setPageMark [line 2468]
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 1762]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageUnit [line 1647]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 11586]
void setPDFVersion(
[
$version = '1.7'])
|
|
Set the PDF version (check PDF reference for valid values). Default value is 1.t
Tags:
Parameters:
method setPrintFooter [line 2574]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 2565]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 8105]
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 2056]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 1818]
void setRTL(
Boolean
$enable, [Boolean
$resetx = true])
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setSignature [line 11248]
void setSignature(
[mixed
$signing_cert = ''], [mixed
$private_key = ''], [string
$private_key_password = ''], [string
$extracerts = ''], [int
$cert_type = 2], [array
$info = array()])
|
|
Enable document signature (requires the OpenSSL Library). The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader.
Tags:
Parameters:
method setSpacesRE [line 1803]
void setSpacesRE(
[string
$re = '/[\s]/'])
|
|
Set regular expression to detect withespaces or word separators.
Tags:
Parameters:
method SetSubject [line 2203]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setTableHeader [line 2759]
This method is used to render the table header on new page (if any).
Tags:
method setTempRTL [line 1844]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 3013]
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 2990]
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 3052]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 2191]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 2041]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 11218]
void setUserRights(
[boolean
$enable = true], [string
$document = '/FullSave'], [string
$annots = '/Create/Delete/Modify/Copy/Import/Export'], [string
$form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate'], [string
$signature = '/Modify'])
|
|
Set User's Rights for PDF Reader WARNING: This works only using the Adobe private key with the setSignature() method!. Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary
Tags:
Parameters:
method setViewerPreferences [line 11599]
void setViewerPreferences(
array
$preferences)
|
|
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. (see Section 8.1 of PDF reference, "Viewer Preferences"). - HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.
- HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.
- HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.
- FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.
- CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.
- DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.
- NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:
- UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- UseOC Optional content group panel visible
This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone. - ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
- PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are:
- None, which indicates that the print dialog should reflect no page scaling
- AppDefault (default), which indicates that applications should use the current print scaling
- Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:
- Simplex - Print single-sided
- DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet
- DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet
Default value: none - PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.
- PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application
- NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1
Tags:
Parameters:
method setVisibility [line 11447]
void setVisibility(
string
$v)
|
|
Set the visibility of the successive elements. This can be useful, for instance, to put a background image or color that will show on screen but won't print.
Tags:
Parameters:
method SetX [line 5310]
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 5373]
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 5342]
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 set_mqr [line 4974]
void set_mqr(
boolean
$mqr)
|
|
Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist)
Tags:
Parameters:
method Skew [line 8395]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 8368]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 8381]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 9211]
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 2428]
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 11276]
void startPageGroup(
[int
$page = ''])
|
|
Create a new page group. NOTE: call this function before calling AddPage()
Tags:
Parameters:
method startTransaction [line 16285]
Stores a copy of the current TCPDF object used for undo operation.
Tags:
method StartTransform [line 8133]
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 8148]
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 15204]
void swapMargins(
[boolean
$reverse = true])
|
|
Swap the left and right margins.
Tags:
Parameters:
method Text [line 3596]
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 10627]
void TextField(
string
$name, float
$w, float
$h, [array
$prop = array()], [array
$opt = array()], [float
$x = ''], [float
$y = ''], [boolean
$js = false])
|
|
Creates a text field
Tags:
Parameters:
method Transform [line 8428]
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 8311]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 8288]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 8299]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 7953]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UniArrSubString [line 4652]
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 4685]
Returns the unicode caracter specified by UTF-8 code
Tags:
Parameters:
method UTF8ArrayToUniArray [line 4673]
Return UTF8ArrayToUniArray(
string
$ta)
|
|
Convert an array of UTF8 values to array of unicode characters
Tags:
Parameters:
method UTF8ArrSubString [line 4629]
Return UTF8ArrSubString(
string
$strarr, [int
$start = ''], [int
$end = ''])
|
|
Extract a slice of the $strarr array and return it as string.
Tags:
Parameters:
method UTF8ArrToLatin1 [line 7691]
array UTF8ArrToLatin1(
array
$unicode)
|
|
Converts UTF-8 characters array to Latin1
Tags:
Parameters:
method utf8Bidi [line 9418]
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 7554]
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 9404]
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 7661]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 7645]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 4273]
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 12226]
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 12483]
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 12433]
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 15631]
void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)
|
|
Writes data to a temporary file on filesystem.
Tags:
Parameters:
method writeHTML [line 13227]
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 12727]
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 10199]
void _addfield(
string
$type, string
$name, int
$x, int
$y, int
$w, int
$h, array
$prop)
|
|
Adds a javascript form field.
Tags:
Parameters:
method _beginpage [line 7284]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _dataannobjstring [line 7433]
string _dataannobjstring(
string
$s)
|
|
Format a data string for annotation objects
Tags:
Parameters:
method _datastring [line 7420]
string _datastring(
string
$s)
|
|
Format a data string for meta information
Tags:
Parameters:
method _datestring [line 7446]
Returns a formatted date for meta information
Tags:
method _destroy [line 5545]
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 5573]
Check for locale-related bug
Tags:
method _dolinethrough [line 7359]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dolinethroughw [line 7386]
void _dolinethroughw(
int
$x, int
$y,
$w, string
$txt)
|
|
Line through for rectangular text area.
Tags:
Parameters:
method _dounderline [line 7347]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _dounderlinew [line 7372]
void _dounderlinew(
int
$x, int
$y, int
$w)
|
|
Underline for rectangular text area.
Tags:
Parameters:
method _enddoc [line 7167]
Output end of document (EOF).
Tags:
method _endpage [line 7323]
method _escape [line 7409]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 7471]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 7398]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 8073]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getfontpath [line 5589]
method _JScolor [line 10175]
void _JScolor(
string
$color)
|
|
Convert color to javascript color.
Tags:
Parameters:
method _md5_16 [line 8034]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 7333]
Begin a new object and return the object number.
Tags:
method _objectkey [line 7966]
Compute encryption key depending on object number where the encrypted data is stored
Tags:
Parameters:
method _out [line 7502]
Output a string to the document.
Tags:
Parameters:
method _outarc [line 11833]
void _outarc(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Output an arc
Tags:
Parameters:
method _outCurve [line 8601]
void _outCurve(
float
$x1, float
$y1, float
$x2, float
$y2, float
$x3, float
$y3)
|
|
Draws a Bezier curve from last draw point. The Bezier curve is a tangent to the line between the control points at either end of the curve.
Tags:
Parameters:
method _outLine [line 8565]
void _outLine(
float
$x, float
$y)
|
|
Draws a line from last draw point.
Tags:
Parameters:
method _outPoint [line 8551]
void _outPoint(
float
$x, float
$y)
|
|
Set a draw point.
Tags:
Parameters:
method _outRect [line 8582]
void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)
|
|
Draws a rectangle.
Tags:
Parameters:
method _Ovalue [line 8047]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for RC4 encryption)
Tags:
Parameters:
method _parsejpeg [line 5024]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 5050]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannotsobjs [line 5772]
Output annotations objects for all pages. !!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.
Tags:
method _putannotsrefs [line 5741]
void _putannotsrefs(
int
$n)
|
|
Output referencees to page annotations
Tags:
Parameters:
method _putAPXObject [line 6378]
int _putAPXObject(
[int
$w = 0], [int
$h = 0], [string
$stream = ''])
|
|
Put appearance streams XObject used to define annotation's appearance states
Tags:
Parameters:
method _putbookmarks [line 10017]
Create a bookmark PDF string.
Tags:
method _putcatalog [line 6992]
method _putcidfont0 [line 6729]
int _putcidfont0(
array
$font)
|
|
Output CID-0 fonts. A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
Tags:
Parameters:
method _putEmbeddedFiles [line 3565]
void _putEmbeddedFiles(
)
|
|
Embedd the attached files.
Tags:
method _putencryption [line 7975]
Put encryption on PDF document.
Tags:
method _putextgstates [line 11512]
void _putextgstates(
array
$gs)
|
|
Put extgstates for object transparency
Tags:
Parameters:
method _putfonts [line 6406]
method _putfontwidths [line 6541]
void _putfontwidths(
array
$font, [int
$cidoffset = 0])
|
|
Outputs font widths
Tags:
Parameters:
method _putheader [line 7159]
method _putimages [line 6794]
method _putinfo [line 6952]
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Tags:
method _putjavascript [line 10115]
Create a javascript PDF string.
Tags:
method _putocg [line 11426]
Put visibility settings.
Tags:
method _putpages [line 5600]
method _putresourcedict [line 6877]
Output Resources Dictionary.
Tags:
method _putresources [line 6918]
method _putshaders [line 11783]
method _putsignature [line 11147]
Add certification signature (DocMDP or UR3) You can set only one signature type
Tags:
method _putspotcolors [line 6849]
Output Spot Colors Resources.
Tags:
method _putstream [line 7488]
void _putstream(
string
$s)
|
|
Output a stream.
Tags:
Parameters:
method _puttrailer [line 7145]
method _puttruetypeunicode [line 6640]
int _puttruetypeunicode(
array
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putviewerpreferences [line 7075]
void _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _putxobjectdict [line 6866]
Output object dictionary for images.
Tags:
method _RC4 [line 7994]
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 7457]
string _textstring(
string
$s)
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 5008]
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 8060]
Compute U value (used for RC4 encryption)
Tags:
|
|