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 505]
Tags:
$AliasNumPage = '{pnb}'
[line 511]
Tags:
$annotation_fonts = array()
[line 1406]
List of fonts used on form fields (fontname => fontkey).
Tags:
$author = ''
[line 487]
Tags:
$AutoPageBreak =
[line 445]
Tags:
$barcode = false
[line 600]
Tags:
$bgcolor =
[line 699]
Tags:
$bMargin =
[line 287]
Tags:
$booklet = false
[line 1096]
Booklet mode for double-sided pages
Tags:
$bordermrk = array()
[line 967]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$buffer =
[line 191]
Tags:
$bufferlen = 0
[line 1196]
Length of the buffer in bytes.
Tags:
$byterange_string = '/ByteRange[0 ********** ********** **********]'
[line 1343]
ByteRange placemark used during signature process.
Tags:
$cache_file_length = array()
[line 1252]
Array used to store the lengths of cache files
Tags:
$cache_maxsize_UTF8StringToArray = 8
[line 1280]
Maximum size of cache array used for UTF8StringToArray() method.
Tags:
$cache_size_UTF8StringToArray = 0
[line 1287]
Current size of cache array used for UTF8StringToArray() method.
Tags:
$cache_UTF8StringToArray = array()
[line 1273]
Cache array for UTF8StringToArray() method.
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 930]
Default cell height ratio.
Tags:
$cMargin =
[line 293]
Tags:
$cntmrk = array()
[line 983]
Array used to store content positions inside the pages buffer. keys are the page numbers
Tags:
$ColorFlag =
[line 439]
Tags:
$columns = array()
[line 1455]
Array of column measures (width, space, starting Y position)
Tags:
$column_start_page = 0
[line 1476]
Starting page for columns
Tags:
$colxshift = array('x' => 0, 's' => 0, 'p' => 0)
[line 1490]
Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding
Tags:
$compress =
[line 209]
Tags:
$CoreFonts =
[line 323]
Tags:
$creator = ''
[line 499]
Tags:
$CurOrientation =
[line 215]
Tags:
$CurrentFont =
[line 403]
Tags:
$current_column = 0
[line 1469]
Current column number
Tags:
$currpagegroup =
[line 888]
Contains the alias of the current page group
Tags:
$customlistindent = -1
[line 1118]
Tags:
$default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255),'strokeColor'=>array(128,128,128))
[line 1371]
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_graphic_vars = array()
[line 1545]
Tags:
$default_monospaced_font = 'courier'
[line 1238]
Default monospaced font
Tags:
$default_table_columns = 4
[line 642]
Tags:
$diffs = array()
[line 341]
Tags:
$diskcache = false
[line 1203]
If true enables disk caching.
Tags:
$dpi = 72
[line 867]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 421]
Tags:
$embeddedfiles = array()
[line 1132]
Tags:
$emptypagemrk = array()
[line 975]
Array used to store page positions to track empty pages. keys are the page numbers
Tags:
$encoding = 'UTF-8'
[line 718]
Tags:
$encryptdata = array()
[line 755]
Array containing encryption settings
Tags:
$encrypted =
[line 748]
Indicates whether document is protected
Tags:
$enc_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 775]
Encryption padding
Tags:
$endlinex = 0
[line 1012]
End position of the latest inserted line
Tags:
$epsmarker = 'x#!#EPS#!#x'
[line 1075]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 916]
Array of transparency objects and parameters.
Tags:
$feps = 0.005
[line 1103]
Epsilon value used for float calculations
Tags:
$fgcolor =
[line 663]
Tags:
$fhPt =
[line 239]
Tags:
$file_id =
[line 782]
File ID (used on trailer)
Tags:
$FillColor =
[line 427]
Tags:
$FontAscent =
[line 378]
Tags:
$FontDescent =
[line 385]
Tags:
$FontFamily =
[line 365]
Tags:
$FontFiles = array()
[line 335]
Tags:
$fontkeys = array()
[line 1217]
Store the font keys.
Tags:
$fontlist = array()
[line 657]
Tags:
$fonts = array()
[line 329]
Tags:
$FontSize =
[line 415]
Tags:
$FontSizePt =
[line 409]
Tags:
$FontStyle =
[line 371]
Tags:
$font_obj_ids = array()
[line 1224]
Store the font object IDs.
Tags:
$font_subsetting = true
[line 1538]
Tags:
$footerlen = array()
[line 998]
Array used to store footer length of each page.
Tags:
$footerpos = array()
[line 990]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 588]
Tags:
$footer_margin =
[line 562]
Tags:
$form_action = ''
[line 1385]
Current form action (used during XHTML rendering)
Tags:
$form_enctype = 'application/x-www-form-urlencoded'
[line 1392]
Current form encryption type (used during XHTML rendering)
Tags:
$form_mode = 'post'
[line 1399]
Current method to submit forms.
Tags:
$form_obj_id = array()
[line 1364]
List of form annotations IDs
Tags:
$fwPt =
[line 233]
Tags:
$gradients = array()
[line 951]
Array for storing gradient information.
Tags:
$h =
[line 263]
Tags:
$header_font =
[line 582]
Tags:
$header_logo = ''
[line 618]
Tags:
$header_logo_width = 30
[line 624]
Tags:
$header_margin =
[line 556]
Tags:
$header_string = ''
[line 636]
Tags:
$header_title = ''
[line 630]
Tags:
$hPt =
[line 251]
Tags:
$HREF = array()
[line 651]
Tags:
$htmlLinkColorArray = array(0, 0, 255)
[line 1154]
Default color for html links
Tags:
$htmlLinkFontStyle = 'U'
[line 1161]
Default font style to add to html links
Tags:
$htmlvspace = 0
[line 1054]
Count the latest inserted vertical spaces on HTML
Tags:
$imagekeys = array()
[line 1189]
Store the image keys.
Tags:
$images = array()
[line 347]
Tags:
$imgscale = 1
[line 535]
Tags:
$img_rb_x =
[line 519]
Tags:
$img_rb_y =
[line 527]
Tags:
$InFooter = false
[line 457]
Tags:
$internal_encoding =
[line 725]
Tags:
$inthead = false
[line 1448]
True when we are printing the thead section on a new page
Tags:
$intmrk = array()
[line 959]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$isunicode = false
[line 543]
Tags:
$javascript = ''
[line 808]
javascript code
Tags:
$jpeg_quality =
[line 923]
Set the default JPEG compression quality (1-100)
Tags:
$js_objects = array()
[line 1378]
Javascript objects array
Tags:
$k =
[line 227]
Tags:
$keywords = ''
[line 493]
Tags:
$l =
[line 594]
Tags:
$lasth =
[line 311]
Tags:
$last_enc_key =
[line 762]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_enc_key_c =
[line 769]
last RC4 computed key
Tags:
$LayoutMode =
[line 469]
Tags:
$linestyleCap = '0 J'
[line 1026]
PDF string for last line width
Tags:
$linestyleDash = '[] 0 d'
[line 1040]
PDF string for last line width
Tags:
$linestyleJoin = '0 j'
[line 1033]
PDF string for last line width
Tags:
$linestyleWidth = ''
[line 1019]
PDF string for last line width
Tags:
$linethrough =
[line 822]
line trough state
Tags:
$LineWidth =
[line 317]
Tags:
$links = array()
[line 359]
Tags:
$lispacer = ''
[line 711]
Tags:
$listcount = array()
[line 675]
Tags:
$listindent = 0
[line 687]
Tags:
$listindentlevel = 0
[line 693]
Tags:
$listnum = 0
[line 681]
Tags:
$listordered = array()
[line 669]
Tags:
$lisymbol = ''
[line 1068]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 269]
Tags:
$maxselcol = array('page' => 0, 'column' => 0)
[line 1483]
Maximum page and column selected
Tags:
$n =
[line 179]
Tags:
$newline = true
[line 1005]
True if a newline is created.
Tags:
$newpagegroup = array()
[line 874]
Array of page numbers were a new page group was started
Tags:
$numfonts = 0
[line 1210]
Counts the number of fonts.
Tags:
$numimages = 0
[line 1182]
Counts the number of pages.
Tags:
$numpages = 0
[line 1168]
Counts the number of pages.
Tags:
$num_columns = 1
[line 1462]
Number of colums
Tags:
$n_js =
[line 815]
javascript counter
Tags:
$n_ocg_print =
[line 902]
Print visibility.
Tags:
$n_ocg_view =
[line 909]
View visibility.
Tags:
$objcopy =
[line 1245]
Used to store a cloned copy of the current class object
Tags:
$offsets =
[line 185]
Tags:
$opencell = true
[line 1125]
Tags:
$openMarkedContent = false
[line 1047]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 569]
Tags:
$original_rMargin =
[line 576]
Tags:
$OutlineRoot =
[line 798]
Outline root for bookmark
Tags:
$outlines = array()
[line 791]
Outlines for bookmark
Tags:
$overline =
[line 397]
Tags:
$page =
[line 173]
Tags:
$PageAnnots = array()
[line 353]
Tags:
$PageBreakTrigger =
[line 451]
Tags:
$pagedim = array()
[line 221]
Tags:
$pagegroups =
[line 881]
Contains the number of pages of the groups
Tags:
$pagelen = array()
[line 1175]
Array containing page lengths in bytes.
Tags:
$PageMode =
[line 944]
A name object specifying how the document should be displayed when opened.
Tags:
$pageopen = array()
[line 1231]
Store the fage status (true when opened, false when closed).
Tags:
$pages = array()
[line 197]
Tags:
$page_obj_id = array()
[line 1357]
ID of page objects
Tags:
$pdfunit = 'mm'
[line 1518]
Tags:
$PDFVersion = '1.7'
[line 550]
Tags:
$premode = false
[line 1139]
Tags:
$print_footer = true
[line 612]
Tags:
$print_header = true
[line 606]
Tags:
$radiobutton_groups = array()
[line 1413]
List of radio buttons parent objects.
Tags:
$radio_groups = array()
[line 1420]
List of radio group objects IDs
Tags:
$rasterize_vector_images = false
[line 1531]
Tags:
$re_space = array('p' => '[^\S\xa0]', 'm' => '')
[line 1329]
Array of parts $re_spaces
Tags:
$re_spaces = '/[^\S\xa0]/'
[line 1322]
Regular expression used to find blank characters used for word-wrapping.
Tags:
$rMargin =
[line 281]
Tags:
$rtl = false
[line 732]
Tags:
$sign = false
[line 1294]
If true enables document signing
Tags:
$signature_appearance = array('page' => 1, 'rect' => '0 0 0 0')
[line 1315]
data for signature appearance
Tags:
$signature_data = array()
[line 1301]
Signature data
Tags:
$signature_max_length = 11742
[line 1308]
Signature max length
Tags:
$sig_annot_ref = '***SIGANNREF*** 0 R'
[line 1350]
Placemark used during signature process.
Tags:
$sig_obj_id = 0
[line 1336]
Signature object ID
Tags:
$spot_colors = array()
[line 1061]
Array of Spot colors
Tags:
$start_transaction_page = 0
[line 1434]
Store page number when startTransaction() is called.
Tags:
$start_transaction_y = 0
[line 1441]
Store Y position when startTransaction() is called.
Tags:
$state =
[line 203]
Tags:
$strokecolor =
[line 1511]
Tags:
$subject = ''
[line 481]
Tags:
$svgclipid = 0
[line 1608]
Tags:
$svgclipmode = false
[line 1594]
Tags:
$svgclippaths = array()
[line 1601]
Tags:
$svgdefs = array()
[line 1587]
Tags:
$svgdefsmode = false
[line 1580]
Tags:
$svgdir = ''
[line 1552]
Tags:
$svggradientid = 0
[line 1573]
Tags:
$svggradients = array()
[line 1566]
Tags:
$svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode')
[line 1622]
Tags:
$svgstyles = array(array(
'alignment-baseline' => 'auto',
'baseline-shift' => 'baseline',
'clip' => 'auto',
'clip-path' => 'none',
'clip-rule' => 'nonzero',
'color' => 'black',
'color-interpolation' => 'sRGB',
'color-interpolation-filters' => 'linearRGB',
'color-profile' => 'auto',
'color-rendering' => 'auto',
'cursor' => 'auto',
'direction' => 'ltr',
'display' => 'inline',
'dominant-baseline' => 'auto',
'enable-background' => 'accumulate',
'fill' => 'black',
'fill-opacity' => 1,
'fill-rule' => 'nonzero',
'filter' => 'none',
'flood-color' => 'black',
'flood-opacity' => 1,
'font' => '',
'font-family' => 'helvetica',
'font-size' => 'medium',
'font-size-adjust' => 'none',
'font-stretch' => 'normal',
'font-style' => 'normal',
'font-variant' => 'normal',
'font-weight' => 'normal',
'glyph-orientation-horizontal' => '0deg',
'glyph-orientation-vertical' => 'auto',
'image-rendering' => 'auto',
'kerning' => 'auto',
'letter-spacing' => 'normal',
'lighting-color' => 'white',
'marker' => '',
'marker-end' => 'none',
'marker-mid' => 'none',
'marker-start' => 'none',
'mask' => 'none',
'opacity' => 1,
'overflow' => 'auto',
'pointer-events' => 'visiblePainted',
'shape-rendering' => 'auto',
'stop-color' => 'black',
'stop-opacity' => 1,
'stroke' => 'none',
'stroke-dasharray' => 'none',
'stroke-dashoffset' => 0,
'stroke-linecap' => 'butt',
'stroke-linejoin' => 'miter',
'stroke-miterlimit' => 4,
'stroke-opacity' => 1,
'stroke-width' => 1,
'text-anchor' => 'start',
'text-decoration' => 'none',
'text-rendering' => 'auto',
'unicode-bidi' => 'normal',
'visibility' => 'visible',
'word-spacing' => 'normal',
'writing-mode' => 'lr-tb',
'text-color' => 'black',
'transfmatrix' => array(1, 0, 0, 1, 0, 0)))
[line 1629]
Tags:
$svgtext = ''
[line 1615]
Tags:
$svgunit = 'px'
[line 1559]
Tags:
$tagvspaces = array()
[line 1110]
Array used for custom vertical spaces for HTML tags
Tags:
$tempfontsize = 10
[line 705]
Tags:
$TextColor =
[line 433]
Tags:
$textindent = 0
[line 1427]
Text indentation value (used for text-indent CSS attribute)
Tags:
$textrendermode = 0
[line 1497]
Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping.
Tags:
$textstrokewidth = 0
[line 1504]
Text stroke width in doc units
Tags:
$thead = ''
[line 1259]
Table header content to be repeated on each new page
Tags:
$theadMargins = array()
[line 1266]
Margins used for table header.
Tags:
$title = ''
[line 475]
Tags:
$tMargin =
[line 275]
Tags:
$tmprtl = false
[line 739]
Tags:
$tocpage = false
[line 1524]
Tags:
$transfmatrix = array()
[line 1082]
Array of transformation matrix
Tags:
$transfmatrix_key = 0
[line 1089]
Current key for transformation matrix
Tags:
$transfmrk = array()
[line 1147]
Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers
Tags:
$underline =
[line 391]
Tags:
$ur =
[line 832]
If true enables user's rights on PDF reader
Tags:
$ur_annots =
[line 846]
Names specifying additional annotation-related usage rights for the document.
Tags:
$ur_document =
[line 839]
Names specifying additional document-wide usage rights for the document.
Tags:
$ur_form =
[line 853]
Names specifying additional form-field-related usage rights for the document.
Tags:
$ur_signature =
[line 860]
Names specifying additional signature-related usage rights for the document.
Tags:
$viewer_preferences =
[line 937]
PDF viewer preferences.
Tags:
$visibility = 'all'
[line 895]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 257]
Tags:
$wPt =
[line 245]
Tags:
$x =
[line 299]
Tags:
$y =
[line 305]
Tags:
$ZoomMode =
[line 463]
Tags:
Class Methods
constructor __construct [line 1713]
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 1844]
Default destructor.
Tags:
method AcceptPageBreak [line 4858]
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 14715]
the addExtGState(
$parms, array
$params)
|
|
Add transparency parameters to the current extgstate
Tags:
Parameters:
method AddFont [line 4325]
array AddFont(
string
$family, [string
$style = ''], [string
$fontfile = ''], [mixed
$subset = 'default'])
|
|
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 10745]
the addHtmlLink(
string
$url, string
$name, [boolean
$fill = false], [boolean
$firstline = false], [array
$color = ''], [string
$style = -1], [boolean
$firstblock = false])
|
|
Output anchor link.
Tags:
Parameters:
method addHTMLTOC [line 21350]
void addHTMLTOC(
[int
$page = ''], [string
$toc_name = 'TOC'], [array
$templates = array()], [boolean
$correct_align = true])
|
|
Output a Table Of Content Index (TOC) using HTML templates. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page.
Tags:
Parameters:
method addHTMLVertSpace [line 19857]
void addHTMLVertSpace(
[string
$hbz = 0], [string
$hb = 0], [boolean
$cell = false], [boolean
$firstorlast = false])
|
|
Add vertical spaces if needed.
Tags:
Parameters:
method addJavascriptObject [line 13312]
int addJavascriptObject(
string
$script, [boolean
$onload = false])
|
|
Adds a javascript object and return object ID
Tags:
Parameters:
method AddLink [line 4658]
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 3483]
void AddPage(
[string
$orientation = ''], [mixed
$format = ''], [boolean
$keepmargins = false], [boolean
$tocpage = false])
|
|
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 3934]
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 21187]
void addTOC(
[int
$page = ''], [string
$numbersfont = ''], [string
$filler = '.'], [string
$toc_name = 'TOC'])
|
|
Output a Table of Content Index (TOC). Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page. You can override this method to achieve different styles.
Tags:
Parameters:
method addTOCPage [line 3458]
void addTOCPage(
[string
$orientation = ''], [
$format = ''], [boolean
$keepmargins = false])
|
|
Adds a new TOC (Table Of Content) page to the document.
Tags:
Parameters:
method AliasNbPages [line 14529]
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 14556]
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 4714]
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 12516]
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 10640]
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 13184]
void Bookmark(
string
$txt, [int
$level = 0], [float
$y = -1], [int
$page = ''])
|
|
Adds a bookmark.
Tags:
Parameters:
method Button [line 14202]
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 4965]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'])
|
|
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 14132]
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 4885]
boolean checkPageBreak(
[float
$h = 0], [mixed
$y = ''], [boolean
$addpage = true])
|
|
Add page if needed.
Tags:
Parameters:
method Circle [line 12204]
void Circle(
float
$x0, float
$y0, float
$r, [
$angstr = 0], [
$angend = 360], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 2], float
$angstr:, float
$angend:)
|
|
Draws a circle. A circle is formed from n Bezier curves.
Tags:
Parameters:
method Clip [line 15176]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 3335]
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 19357]
void closeHTMLTagHandler(
&$dom, int
$key, boolean
$cell, [int
$maxbottomliney = 0], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method colorRegistrationBar [line 14851]
void colorRegistrationBar(
float
$x, float
$y, float
$w, float
$h, [boolean
$transition = true], [boolean
$vertical = false], [string
$colors = 'A,R,G,B,C,M,Y,K'])
|
|
Paints color transition registration bars
Tags:
Parameters:
method ComboBox [line 14071]
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 21462]
void commitTransaction(
)
|
|
Delete the copy of the current TCPDF object used for undo operation.
Tags:
method convertHexStringToString [line 11367]
String convertHexStringToString(
string
$bs)
|
|
Convert hexadecimal string to string
Tags:
Parameters:
method convertHTMLColorToDec [line 10778]
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 convertStringToHexString [line 11389]
byte convertStringToHexString(
string
$s)
|
|
Convert string to hexadecimal string (byte string)
Tags:
Parameters:
method convertSVGtMatrix [line 22530]
array convertSVGtMatrix(
array
$tm)
|
|
Convert SVG transformation matrix to PDF.
Tags:
Parameters:
method CoonsPatchMesh [line 15091]
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], [boolean
$antialias = false])
|
|
Paints a coons patch mesh.
Tags:
Parameters:
method copyPage [line 21117]
true copyPage(
[int
$page = 0])
|
|
Clone the specified page to a new page.
Tags:
Parameters:
method cropMark [line 14949]
void cropMark(
float
$x, float
$y, float
$w, float
$h, [string
$type = 'A,B,C,D'], [array
$color = array(0,0,0)])
|
|
Paints crop mark
Tags:
Parameters:
method Curve [line 12009]
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 20974]
true deletePage(
int
$page)
|
|
Remove the specified page.
Tags:
Parameters:
method drawHTMLTagBorder [line 19894]
void drawHTMLTagBorder(
array
$tag, $xmax
$xmax)
|
|
Draw an HTML block border and fill
Tags:
Parameters:
method Ellipse [line 12073]
void Ellipse(
float
$x0, float
$y0, float
$rx, [float
$ry = ''], [
$angle = 0], [
$astart = 0], [
$afinish = 360], [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 2], float
$angle:, float
$astart:, float
$afinish:)
|
|
Draws an ellipse. An ellipse is formed from n Bezier curves.
Tags:
Parameters:
method empty_string [line 21516]
boolean empty_string(
string
$str)
|
|
Determine whether a string is empty.
Tags:
Parameters:
method endPage [line 3503]
void endPage(
[boolean
$tocpage = false])
|
|
Terminate the current page
Tags:
Parameters:
method endSVGElementHandler [line 23558]
void endSVGElementHandler(
resource
$parser, string
$name)
|
|
Sets the closing SVG element handler function for the XML parser.
Tags:
Parameters:
method endTOCPage [line 3468]
Terminate the current TOC (Table Of Content) page
Tags:
method Error [line 3307]
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 extractCSSproperties [line 16364]
An extractCSSproperties(
string
$cssdata)
|
|
Extracts the CSS properties from a CSS string.
Tags:
Parameters:
method fitBlock [line 6525]
void fitBlock(
&$w,
&$h,
&$x,
&$y, [boolean
$fitonpage = false], float
$w, float
$h, float
$x, float
$y)
|
|
Set the block dimensions accounting for page breaks and page/column fitting
Tags:
Parameters:
method Footer [line 3753]
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 14633]
void formatPageNumber(
int
$num)
|
|
Format the page numbers. This method can be overriden for custom formats.
Tags:
Parameters:
method formatTOCPageNumber [line 14645]
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 7257]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 14541]
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 14569]
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 13438]
array getAnnotOptFromJSProp(
array
$prop)
|
|
Convert JavaScript form fields properties array to Annotation Properties array.
Tags:
Parameters:
method GetArrStringWidth [line 4227]
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 15813]
Get current barcode.
Tags:
method getBorderMode [line 5836]
border getBorderMode(
mixed
$brd, [string
$position = 'start'])
|
|
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
Tags:
Parameters:
method getBorderStartPosition [line 19878]
array getBorderStartPosition(
)
|
|
Return the starting coordinates to draw an html border
Tags:
method getBreakMargin [line 3032]
int getBreakMargin(
[int
$pagenum = ''])
|
|
Returns the page break margin.
Tags:
Parameters:
method getBuffer [line 20654]
Get buffer content.
Tags:
method getCellBorder [line 5363]
string getCellBorder(
float
$x, float
$y, float
$w, float
$h, mixed
$brd, string
$mode)
|
|
Returns the code to draw the cell border
Tags:
Parameters:
method getCellCode [line 4996]
string getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'])
|
|
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 14811]
void getCellHeightRatio(
)
|
|
return the height of cell repect font height.
Tags:
method GetCharWidth [line 4263]
int GetCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getColumn [line 21667]
Return the current column number
Tags:
method getCSSBorderDashStyle [line 16659]
int getCSSBorderDashStyle(
string
$style)
|
|
Returns the border dash style from CSS property
Tags:
Parameters:
method getCSSBorderStyle [line 16695]
array getCSSBorderStyle(
string
$cssborder)
|
|
Returns the border style array from CSS border properties
Tags:
Parameters:
method getCSSBorderWidth [line 16639]
int getCSSBorderWidth(
string
$width)
|
|
Returns the border width from CSS property
Tags:
Parameters:
method getEncPermissionsString [line 11406]
String getEncPermissionsString(
string
$protection)
|
|
Convert encryption P value to a string of bytes, low-order byte first.
Tags:
Parameters:
method getFontAscent [line 4628]
int getFontAscent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font ascent value
Tags:
Parameters:
method getFontBuffer [line 20814]
string getFontBuffer(
string
$font)
|
|
Get font buffer content.
Tags:
Parameters:
method getFontDescent [line 4605]
int getFontDescent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font descent value
Tags:
Parameters:
method getFontFamily [line 16342]
Returns the current font family name.
Tags:
method getFontFamilyName [line 22087]
string getFontFamilyName(
string
$fontfamily)
|
|
Return normalized font name
Tags:
Parameters:
method getFontSize [line 16322]
Returns the current font size.
Tags:
method getFontSizePt [line 16332]
Returns the current font size in points unit.
Tags:
method getFontsList [line 4302]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFontStyle [line 16352]
Returns the current font style.
Tags:
method getFontSubsetting [line 22023]
boolean getFontSubsetting(
)
|
|
Return the default option for font subsetting.
Tags:
method getFooterFont [line 10703]
method getFooterMargin [line 3667]
Returns footer margin in user units.
Tags:
method getFormDefaultProp [line 13813]
array getFormDefaultProp(
)
|
|
Return the default properties for form fields.
Tags:
method getGDgamma [line 7197]
void getGDgamma(
float
$v)
|
|
Correct the gamma value to be used with GD library
Tags:
Parameters:
method getGraphicVars [line 20486]
Returns current graphic variables as array.
Tags:
method getGroupPageNo [line 14582]
current getGroupPageNo(
)
|
|
Return the current page in the group.
Tags:
method getGroupPageNoFormatted [line 14592]
void getGroupPageNoFormatted(
)
|
|
Returns the current group page number formatted as a string.
Tags:
method getHeaderData [line 3622]
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 10683]
method getHeaderMargin [line 3647]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 16743]
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 20197]
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 getHyphenPatternsFromTEX [line 21823]
array getHyphenPatternsFromTEX(
string
$file)
|
|
Returns an array of hyphenation patterns.
Tags:
Parameters:
method getImageBuffer [line 20756]
string getImageBuffer(
string
$image)
|
|
Get image buffer content.
Tags:
Parameters:
method getImageFileType [line 6495]
string getImageFileType(
string
$imgfile, [array
$iminfo = array()])
|
|
Return the image type given the file name or array returned by getimagesize() function.
Tags:
Parameters:
method getImageRBX [line 3693]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 3702]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 2971]
Returns the adjusting factor to convert pixels to user units.
Tags:
method getLastH [line 2949]
Get the last cell height.
Tags:
method GetLineWidth [line 11749]
Returns the current the line width.
Tags:
method getMargins [line 16285]
Returns an array containing current margins:
Tags:
method GetNumChars [line 4290]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumLines [line 5914]
float getNumLines(
string
$txt, [float
$w = 0], [boolean
$reseth = false], [boolean
$autopadding = true], [float
$cellMargin = ''], [float
$lineWidth = ''])
|
|
This method return the estimated number of lines for print a simple text string in Multicell() method.
Tags:
Parameters:
method getNumPages [line 3446]
Get the total number of insered pages.
Tags:
method getObjFilename [line 20568]
void getObjFilename(
$name, string
$prefix)
|
|
Returns a temporary filename for caching object on filesystem.
Tags:
Parameters:
method getOriginalMargins [line 16308]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 3434]
Get current document page number.
Tags:
method getPageBuffer [line 20697]
string getPageBuffer(
int
$page)
|
|
Get page buffer content.
Tags:
Parameters:
method getPageDimensions [line 2984]
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 user units
- $this->pagedim[$this->page]['hk'] = page height in user units
- $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
- $this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
- $this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.
- $this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation
- $this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.
- $this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade
- $this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.
- $this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.
- $this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.
- $this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.
- $this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
- $this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
- $this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed
- $this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['CropBox'] : the visible region of default user space
- $this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment
- $this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming
- $this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content
- $this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points
Tags:
Parameters:
method getPageGroupAlias [line 14604]
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 3016]
int getPageHeight(
[int
$pagenum = ''])
|
|
Returns the page height in units.
Tags:
Parameters:
method getPageNumGroupAlias [line 14619]
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 getPageSizeFromFormat [line 2210]
array getPageSizeFromFormat(
mixed
$format)
|
|
Get page dimensions from format name.
Tags:
Parameters:
method getPageWidth [line 3000]
int getPageWidth(
[int
$pagenum = ''])
|
|
Returns the page width in units.
Tags:
Parameters:
method getPathPaintOperator [line 21935]
void getPathPaintOperator(
string
$style, [string
$default = 'S'], boolean
$mode)
|
|
Get the Path-Painting Operators.
Tags:
Parameters:
method getPDFData [line 10726]
Returns the PDF data.
Tags:
method getRemainingWidth [line 6396]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 2884]
Return the RTL status
Tags:
method getScaleFactor [line 3046]
Returns the scale factor (number of points in user unit).
Tags:
method getSpaceString [line 17442]
Returns the string used to find spaces
Tags:
method getStringHeight [line 6015]
float getStringHeight(
float
$w, string
$txt, [boolean
$reseth = false], [boolean
$autopadding = true], [float
$cellMargin = ''], [float
$lineWidth = ''])
|
|
This method return the estimated needed height for print a simple text string in Multicell() method. Generally, if you want to know the exact height for a block of content you can use the following alternative technique: // store current object
$pdf->startTransaction();
// store starting values
$start_y = $pdf->GetY();
$start_page = $pdf->getPage();
// call your printing functions with your parameters
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$pdf->MultiCell($w=0, $h=0, $txt, $border=1, $align='L', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0);
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// get the new Y
$end_y = $pdf->GetY();
$end_page = $pdf->getPage();
// calculate height
$height = 0;
if ($end_page == $start_page) {
$height = $end_y - $start_y;
} else {
for ($page=$start_page; $page <= $end_page; ++$page) {
$this->setPage($page);
if ($page == $start_page) {
// first page
$height = $this->h - $start_y - $this->bMargin;
} elseif ($page == $end_page) {
// last page
$height = $end_y - $this->tMargin;
} else {
$height = $this->h - $this->tMargin - $this->bMargin;
}
}
}
// restore previous object
$pdf = $pdf->rollbackTransaction();
Tags:
Parameters:
method GetStringWidth [line 4211]
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 getSVGTransformMatrix [line 22408]
array getSVGTransformMatrix(
string
$attribute)
|
|
Get the tranformation matrix from SVG transform attribute
Tags:
Parameters:
method getTagStyleFromCSS [line 16611]
string getTagStyleFromCSS(
array
$dom, int
$key, array
$css)
|
|
Returns the styles that apply for the selected HTML tag.
Tags:
Parameters:
method getTransformationMatrixProduct [line 22512]
transformation getTransformationMatrixProduct(
array
$ta, array
$tb)
|
|
Get the product of two SVG tranformation matrices
Tags:
Parameters:
method getUserPermissionCode [line 11246]
void getUserPermissionCode(
Array
$permissions, [int
$mode = 0])
|
|
Return the premission code used on encryption (P value).
Tags:
Parameters:
method getVectorsAngle [line 23144]
void getVectorsAngle(
int
$x1, int
$y1, int
$x2, int
$y2)
|
|
Returns the angle in radiants between two vectors
Tags:
Parameters:
method GetX [line 7241]
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 7268]
Returns the ordinate of the current position.
Tags:
method get_mqr [line 6913]
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
Tags:
method Gradient [line 15200]
void Gradient(
int
$type, array
$coords, array
$stops, [array
$background = array()], [boolean
$antialias = false])
|
|
Output gradient.
Tags:
Parameters:
method Header [line 3711]
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 hyphenateText [line 21862]
array hyphenateText(
string
$text, mixed
$patterns, [array
$dictionary = array()], [int
$leftmin = 1], [int
$rightmin = 2], [int
$charmin = 1], [int
$charmax = 8])
|
|
Returns text with soft hyphens.
Tags:
Parameters:
method hyphenateWord [line 21753]
array hyphenateWord(
array
$word, array
$patterns, [array
$dictionary = array()], [int
$leftmin = 1], [int
$rightmin = 2], [int
$charmin = 1], [int
$charmax = 8])
|
|
Returns an array of chars containing soft hyphens.
Tags:
Parameters:
method Image [line 6602]
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], [boolean
$fitonpage = 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 15546]
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], [boolean
$fitonpage = false])
|
|
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library. 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 7153]
void ImagePngAlpha(
string
$file, float
$x, float
$y, float
$wpx, float
$hpx, float
$w, float
$h, string
$type, mixed
$link, string
$align, boolean
$resize, int
$dpi, string
$palign)
|
|
Extract info from a PNG image with alpha channel using the GD library.
Tags:
Parameters:
method ImageSVG [line 22137]
void ImageSVG(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [mixed
$link = ''], [string
$align = ''], [string
$palign = ''], [mixed
$border = 0], [boolean
$fitonpage = false])
|
|
Embedd a Scalable Vector Graphics (SVG) image. NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
Tags:
Parameters:
method IncludeJS [line 13299]
void IncludeJS(
string
$script)
|
|
Adds a javascript
Tags:
Parameters:
method intToRoman [line 20276]
string intToRoman(
int
$number)
|
|
Returns the Roman representation of an integer number
Tags:
Parameters:
method isRTLTextDir [line 2928]
Return the current temporary RTL status
Tags:
method isUnicodeFont [line 22075]
Return true if the current font is unicode type.
Tags:
method isValidCSSSelectorForTag [line 16452]
true isValidCSSSelectorForTag(
array
$dom, int
$key, string
$selector)
|
|
Returns true if the CSS selector is valid for the selected HTML tag
Tags:
Parameters:
method lastPage [line 3423]
void lastPage(
[boolean
$resetmargins = false])
|
|
Reset pointer to the last document page.
Tags:
Parameters:
method Line [line 11926]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 15050]
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 4697]
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 14011]
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 7210]
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 11531]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 11567]
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 11554]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 11542]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method movePage [line 20831]
true movePage(
int
$frompage, int
$topage)
|
|
Move a page to a previous position.
Tags:
Parameters:
method MultiCell [line 5566]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [boolean
$fill = false], [int
$ln = 1], [float
$x = ''], [float
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false], [boolean
$autopadding = true], [float
$maxh = 0], [string
$valign = 'T'], [boolean
$fitcell = false])
|
|
This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other. Text can be aligned, centered or justified. The cell block can be framed and the background painted.
Tags:
Parameters:
method objclone [line 21505]
cloned objclone(
object
$object)
|
|
Creates a copy of a class object
Tags:
Parameters:
method Open [line 3322]
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 18756]
void openHTMLTagHandler(
&$dom, int
$key, boolean
$cell, array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 7360]
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 3918]
Returns the current page number.
Tags:
method PageNoFormatted [line 14655]
Returns the current page number formatted as a string.
Tags:
method PieSector [line 15485]
void PieSector(
float
$xc, float
$yc, float
$r, float
$a, float
$b, [string
$style = 'FD'], [
$cw = true], [
$o = 90], float
$cw:, float
$o:)
|
|
Draw the sector of a circle. It can be used for instance to render pie charts.
Tags:
Parameters:
method PieSectorXY [line 15506]
void PieSectorXY(
float
$xc, float
$yc, float
$rx, float
$ry, float
$a, float
$b, [string
$style = 'FD'], [
$cw = false], [
$o = 0], [integer
$nc = 2], float
$cw:, float
$o:)
|
|
Draw the sector of an ellipse. It can be used for instance to render pie charts.
Tags:
Parameters:
method pixelsToUnits [line 10845]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to User's Units.
Tags:
Parameters:
method Polycurve [line 12036]
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 12242]
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 12223]
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 20341]
void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])
|
|
Output an HTML list bullet or ordered item symbol
Tags:
Parameters:
method RadialGradient [line 15068]
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 13922]
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 20608]
mixed readDiskCache(
$filename, string
$file)
|
|
Read data from a temporary file on filesystem.
Tags:
Parameters:
method Rect [line 11954]
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 registrationMark [line 15019]
void registrationMark(
float
$x, float
$y, float
$r, [boolean
$double = false], [array
$cola = array(0,0,0)], [array
$colb = array(255,255,255)])
|
|
Paints a registration mark
Tags:
Parameters:
method RegularPolygon [line 12340]
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 4938]
string removeSHY(
[string
$txt = ''])
|
|
Removes SHY characters from text. Unicode Data: - Name : SOFT HYPHEN, commonly abbreviated as SHY
- HTML Entity (decimal): &#173;
- HTML Entity (hex): &#xad;
- HTML Entity (named): &shy;
- How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]
- UTF-8 (hex): 0xC2 0xAD (c2ad)
- UTF-8 character: chr(194).chr(173)
Tags:
Parameters:
method replaceBuffer [line 20636]
void replaceBuffer(
string
$data)
|
|
Replace the buffer content
Tags:
Parameters:
method revstrpos [line 21529]
Returns revstrpos(
string
$haystack, string
$needle, [int
$offset = 0])
|
|
Find position of last occurrence of a substring in a string
Tags:
Parameters:
method rfread [line 7121]
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 21476]
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 11623]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 12430]
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 RoundedRectXY [line 12449]
void RoundedRectXY(
float
$x, float
$y, float
$w, float
$h, float
$rx, float
$ry, [string
$round_corner = '1111'], [string
$style = ''], [array
$border_style = array()], [array
$fill_color = array()])
|
|
Draws a rounded rectangle.
Tags:
Parameters:
method Scale [line 11499]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 11459]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 11485]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 11472]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method segSVGContentHandler [line 23597]
void segSVGContentHandler(
resource
$parser, string
$data)
|
|
Sets the character data handler function for the XML parser.
Tags:
Parameters:
method selectColumn [line 21592]
void selectColumn(
[int
$col = ''])
|
|
Set position at a given column
Tags:
Parameters:
method serializeTCPDFtagParameters [line 21678]
sting serializeTCPDFtagParameters(
array
$pararray)
|
|
Serialize an array of parameters to be used with TCPDF tag in HTML code.
Tags:
Parameters:
method setAlpha [line 14768]
void setAlpha(
float
$alpha, [string
$bm = 'Normal'])
|
|
Set alpha for stroking (CA) and non-stroking (ca) operations.
Tags:
Parameters:
method SetAuthor [line 3271]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 3138]
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 15803]
void setBarcode(
[string
$bc = ''])
|
|
Set document barcode.
Tags:
Parameters:
method SetBooklet [line 20111]
void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])
|
|
Set the booklet mode for double-sided pages.
Tags:
Parameters:
method setBuffer [line 20618]
void setBuffer(
string
$data)
|
|
Set buffer content (always append data).
Tags:
Parameters:
method setCellHeightRatio [line 14802]
void setCellHeightRatio(
int
$h)
|
|
Set the height of the cell (line height) respect the font height.
Tags:
Parameters:
method SetCellPadding [line 3126]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method setColumnsArray [line 21579]
void setColumnsArray(
array
$columns)
|
|
Set columns array. Each column is represented by and array with the following keys: (w = width, s = space between columns, y = column top position).
Tags:
Parameters:
method SetCompression [line 3231]
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 3589]
void setContentMark(
[int
$page = 0])
|
|
Set start-writing mark on selected page. Borders and fills are always created after content and inserted on the position marked by this method.
Tags:
Parameters:
method SetCreator [line 3295]
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 4647]
void SetDefaultMonospacedFont(
string
$font)
|
|
Defines the default monospaced font.
Tags:
Parameters:
method setDefaultTableColumns [line 14792]
void setDefaultTableColumns(
[int
$cols = 4])
|
|
Set the default number of columns in a row for HTML tables.
Tags:
Parameters:
method SetDisplayMode [line 3153]
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 3978]
string SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1], [boolean
$ret = false])
|
|
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 3952]
string SetDrawColorArray(
array
$color, [boolean
$ret = false])
|
|
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 4023]
void SetDrawSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
Tags:
Parameters:
method setEqualColumns [line 21546]
void setEqualColumns(
[int
$numcols = 0], [int
$width = 0], [int
$y = ''])
|
|
Set multiple columns of the same size
Tags:
Parameters:
method setExtGState [line 14734]
void setExtGState(
array
$gs)
|
|
Add an extgstate
Tags:
Parameters:
method SetFillColor [line 4065]
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 4042]
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 4107]
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 4555]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0], [string
$fontfile = ''], [mixed
$subset = 'default'])
|
|
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 20772]
void setFontBuffer(
string
$font, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method SetFontSize [line 4576]
void SetFontSize(
float
$size, [boolean
$out = true])
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFontSubBuffer [line 20794]
void setFontSubBuffer(
string
$font, string
$key, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method setFontSubsetting [line 22012]
void setFontSubsetting(
[boolean
$enable = true])
|
|
Enable or disable default option for font subsetting.
Tags:
Parameters:
method setFooter [line 3825]
This method is used to render the page footer.
Tags:
method setFooterFont [line 10693]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 3657]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setFormDefaultProp [line 13802]
void setFormDefaultProp(
[array
$prop = array()])
|
|
Set default properties for form fields.
Tags:
Parameters:
method setGraphicVars [line 20526]
void setGraphicVars(
$gvars
$gvars)
|
|
Set graphic variables.
Tags:
Parameters:
method setHeader [line 3788]
This method is used to render the page header.
Tags:
method setHeaderData [line 3608]
void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 10673]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 3637]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setHtmlLinksStyle [line 20182]
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 20151]
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 20713]
void setImageBuffer(
string
$image, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setImageScale [line 2960]
void setImageScale(
float
$scale)
|
|
Set the adjusting factor to convert pixels to user units.
Tags:
Parameters:
method setImageSubBuffer [line 20736]
void setImageSubBuffer(
string
$image, string
$key, array
$data)
|
|
Set image buffer content for a specified sub-key.
Tags:
Parameters:
method setJPEGQuality [line 14779]
void setJPEGQuality(
int
$quality)
|
|
Set the default JPEG compression quality (1-100)
Tags:
Parameters:
method SetKeywords [line 3283]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 10713]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 2939]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 3082]
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 11776]
string SetLineStyle(
array
$style, [boolean
$ret = false])
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 11733]
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 4674]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setListIndentWidth [line 20161]
void setListIndentWidth(
float
$width)
|
|
Set custom width for list indentation.
Tags:
Parameters:
method setLIsymbol [line 20072]
void setLIsymbol(
[string
$symbol = '!'])
|
|
Set the default bullet to be used as LI bullet symbol
Tags:
Parameters:
method SetMargins [line 3060]
void SetMargins(
float
$left, float
$top, [float
$right = -1], [boolean
$keepmargins = false])
|
|
Defines the left, top and right margins.
Tags:
Parameters:
method setOpenCell [line 20171]
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 3376]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageBoxes [line 2689]
void setPageBoxes(
int
$page, string
$type, float
$llx, float
$lly, float
$urx, float
$ury, [boolean
$points = false])
|
|
Set page boundaries.
Tags:
Parameters:
method setPageBuffer [line 20670]
void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])
|
|
Set page buffer content.
Tags:
Parameters:
method setPageFormat [line 2571]
void setPageFormat(
mixed
$format, [
$orientation = 'P'])
|
|
Change the format of the current page
Tags:
Parameters:
method setPageMark [line 3576]
Set start-writing mark on current page stream used to put borders and fills. Borders and fills are always created after content and inserted on the position marked by this method. 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 2738]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageUnit [line 1859]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 14821]
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 3684]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 3675]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 11290]
void SetProtection(
[Array
$permissions = array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high')], [String
$user_pass = ''], [String
$owner_pass = null], [int
$mode = 0], [String
$pubkeys = null])
|
|
Set document protection 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 setRasterizeVectorImages [line 21909]
void setRasterizeVectorImages(
boolean
$mode)
|
|
Enable/disable rasterization of vector images using ImageMagick library.
Tags:
Parameters:
method SetRightMargin [line 3112]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 2868]
void setRTL(
Boolean
$enable, [Boolean
$resetx = true])
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setSignature [line 14461]
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. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
Tags:
Parameters:
method setSignatureAppearance [line 14494]
void setSignatureAppearance(
[float
$x = 0], [float
$y = 0], [float
$w = 0], [float
$h = 0], [int
$page = -1])
|
|
Set the digital signature appearance (a cliccable rectangle area to get signature properties)
Tags:
Parameters:
method setSpacesRE [line 2843]
void setSpacesRE(
[string
$re = '/[^\S\xa0]/'])
|
|
Set regular expression to detect withespaces or word separators. The pattern delimiter must be the forward-slash character '/'. Some example patterns are: Non-Unicode or missing PCRE unicode support: '/[^\S\xa0]/'
Unicode and PCRE unicode support: '/[^\S\P{Z}\xa0]/u'
Unicode and PCRE unicode support in Chinese mode: '/[^\S\P{Z}\P{Lo}\xa0]/u'
if PCRE unicode support is turned ON (\P is the negate class of \p):
\p{Z} or \p{Separator}: any kind of Unicode whitespace or invisible separator.
\p{Lo} or \p{Other_Letter}: a Unicode letter or ideograph that does not have lowercase and uppercase variants.
\p{Lo} is needed for Chinese characters because are packed next to each other without spaces in between.
Tags:
Parameters:
method SetSubject [line 3259]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setSVGStyles [line 22569]
object style setSVGStyles(
array
$svgstyle, array
$prevsvgstyle, [int
$x = 0], [int
$y = 0], [int
$w = 1], [int
$h = 1], [string
$clip_function = ''], [array
$clip_params = array()])
|
|
Apply the requested SVG styles (*** TO BE COMPLETED ***)
Tags:
Parameters:
method setTableHeader [line 3872]
This method is used to render the table header on new page (if any).
Tags:
method setTempRTL [line 2894]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 4149]
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 4126]
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 setTextRenderingMode [line 21690]
void setTextRenderingMode(
[int
$stroke = 0], [boolean
$fill = true], [boolean
$clip = false])
|
|
Set Text rendering mode.
Tags:
Parameters:
method SetTextSpotColor [line 4188]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 3247]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 3097]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 14428]
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 14834]
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 14679]
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 7281]
void SetX(
float
$x, [boolean
$rtloff = false])
|
|
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 7345]
void SetXY(
float
$x, float
$y, [boolean
$rtloff = false])
|
|
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 7313]
void SetY(
float
$y, [bool
$resetx = true], [boolean
$rtloff = false])
|
|
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 6898]
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 11679]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 11652]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 11665]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 12388]
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 3530]
void startPage(
[string
$orientation = ''], [mixed
$format = ''], [
$tocpage = false])
|
|
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 14514]
void startPageGroup(
[int
$page = ''])
|
|
Create a new page group. NOTE: call this function before calling AddPage()
Tags:
Parameters:
method startSVGElementHandler [line 23167]
void startSVGElementHandler(
resource
$parser, string
$name, array
$attribs)
|
|
Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
Tags:
Parameters:
method startTransaction [line 21445]
Stores a copy of the current TCPDF object used for undo operation.
Tags:
method StartTransform [line 11427]
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 11442]
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 stringLeftTrim [line 22036]
left stringLeftTrim(
string
$str, [string
$replace = ''])
|
|
Left trim the input string
Tags:
Parameters:
method stringRightTrim [line 22049]
right stringRightTrim(
string
$str, [string
$replace = ''])
|
|
Right trim the input string
Tags:
Parameters:
method stringTrim [line 22062]
trimmed stringTrim(
string
$str, [string
$replace = ''])
|
|
Trim the input string
Tags:
Parameters:
method SVGPath [line 22824]
array SVGPath(
string
$d, [string
$style = ''])
|
|
Draws an SVG path
Tags:
Parameters:
method SVGTransform [line 22550]
void SVGTransform(
array
$tm)
|
|
Apply SVG graphic transformation matrix.
Tags:
Parameters:
method swapMargins [line 20127]
void swapMargins(
[boolean
$reverse = true])
|
|
Swap the left and right margins.
Tags:
Parameters:
method swapPageBoxCoordinates [line 2715]
void swapPageBoxCoordinates(
int
$page)
|
|
Swap X and Y coordinates of page boxes (change page boxes orientation).
Tags:
Parameters:
method Text [line 4838]
void Text(
float
$x, float
$y, string
$txt, [int
$fstroke = false], [boolean
$fclip = false], [boolean
$ffill = true], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'], [boolean
$rtloff = false])
|
|
Prints a text cell at the specified position. 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 13831]
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 11709]
void Transform(
array
$tm)
|
|
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 11602]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 11579]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 11590]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 10856]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UniArrSubString [line 6435]
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 6468]
Returns the unicode caracter specified by UTF-8 value
Tags:
Parameters:
method UTF8ArrayToUniArray [line 6456]
Return UTF8ArrayToUniArray(
string
$ta)
|
|
Convert an array of UTF8 values to array of unicode characters
Tags:
Parameters:
method UTF8ArrSubString [line 6412]
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 10581]
array UTF8ArrToLatin1(
array
$unicode)
|
|
Converts UTF-8 characters array to array of Latin1 characters
Tags:
Parameters:
method utf8Bidi [line 12610]
array utf8Bidi(
array
$ta, [string
$str = ''], [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method utf8StrArrRev [line 12596]
string utf8StrArrRev(
array
$arr, [string
$str = ''], [bool
$setbom = false], [bool
$forcertl = false])
|
|
Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8StringToArray [line 10416]
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 12581]
string utf8StrRev(
string
$str, [bool
$setbom = false], [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8ToLatin1 [line 10551]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 10535]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 6055]
mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [boolean
$fill = false], [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 15832]
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 16068]
void write2DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [array
$style = ''], [string
$align = ''], [boolean
$distort = false])
|
|
Print 2D Barcode.
Tags:
Parameters:
method writeBarcode [line 16017]
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 20580]
void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)
|
|
Writes data to a temporary file on filesystem.
Tags:
Parameters:
method writeHTML [line 17486]
void writeHTML(
string
$html, [boolean
$ln = true], [boolean
$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 17470]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [boolean
$fill = false], [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 13403]
void _addfield(
string
$type, string
$name, int
$x, int
$y, int
$w, int
$h, array
$prop)
|
|
Adds a javascript form field.
Tags:
Parameters:
method _AES [line 11078]
String _AES(
string
$key, String
$text)
|
|
Returns the input text exrypted using AES algorithm and the specified key. This method requires mcrypt.
Tags:
Parameters:
method _beginpage [line 10102]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _datastring [line 10269]
string _datastring(
string
$s, [int
$n = 0])
|
|
Format a data string for meta information
Tags:
Parameters:
method _datestring [line 10283]
Returns a formatted date for meta information
Tags:
method _destroy [line 7554]
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 7582]
Check for locale-related bug
Tags:
method _dolinethrough [line 10195]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dolinethroughw [line 10208]
void _dolinethroughw(
int
$x, int
$y,
$w, string
$txt)
|
|
Line through for rectangular text area.
Tags:
Parameters:
method _dooverline [line 10221]
void _dooverline(
int
$x, int
$y, string
$txt)
|
|
Overline text.
Tags:
Parameters:
method _dooverlinew [line 10234]
void _dooverlinew(
int
$x, int
$y, int
$w)
|
|
Overline for rectangular text area.
Tags:
Parameters:
method _dounderline [line 10170]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _dounderlinew [line 10183]
void _dounderlinew(
int
$x, int
$y, int
$w)
|
|
Underline for rectangular text area.
Tags:
Parameters:
method _encrypt_data [line 10889]
void _encrypt_data(
int
$n, string
$s)
|
|
Encrypt the input string.
Tags:
Parameters:
method _enddoc [line 10014]
Output end of document (EOF).
Tags:
method _endpage [line 10146]
method _escape [line 10257]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 10309]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 10246]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte (32 bit) integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 11165]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getannotsrefs [line 7831]
string _getannotsrefs(
int
$n)
|
|
Get references to page annotations.
Tags:
Parameters:
method _getBYTE [line 8552]
int _getBYTE(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get BYTE from string (8-bit unsigned integer).
Tags:
Parameters:
method _getfontpath [line 7598]
method _getrawstream [line 10329]
void _getrawstream(
string
$s, [int
$n = 0])
|
|
get raw output stream.
Tags:
Parameters:
method _getSHORT [line 8537]
int _getSHORT(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get SHORT from string (Big Endian 16-bit signed integer).
Tags:
Parameters:
method _getstream [line 10344]
void _getstream(
string
$s, [int
$n = 0])
|
|
Format output stream (DEPRECATED).
Tags:
Parameters:
method _getTrueTypeFontSubset [line 8567]
string _getTrueTypeFontSubset(
string
$font, array
$subsetchars)
|
|
Returns a subset of the TrueType font data without the unused glyphs.
Tags:
Parameters:
method _getTTFtableChecksum [line 8898]
int _getTTFtableChecksum(
string
$table, int
$length)
|
|
Returs the checksum of a TTF table.
Tags:
Parameters:
method _getULONG [line 8507]
int _getULONG(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get ULONG from string (Big Endian 32-bit unsigned integer).
Tags:
Parameters:
method _getUSHORT [line 8522]
int _getUSHORT(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get USHORT from string (Big Endian 16-bit unsigned integer).
Tags:
Parameters:
method _JScolor [line 13379]
void _JScolor(
string
$color)
|
|
Convert color to javascript color.
Tags:
Parameters:
method _md5_16 [line 11096]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 10156]
Begin a new object and return the object number.
Tags:
method _objectkey [line 10870]
Compute encryption key depending on object number where the encrypted data is stored. This is used for all strings and streams without crypt filter specifier.
Tags:
Parameters:
method _out [line 10364]
Output a string to the document.
Tags:
Parameters:
method _outCurve [line 11881]
void _outCurve(
float
$x1, float
$y1, float
$x2, float
$y2, float
$x3, float
$y3)
|
|
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
Tags:
Parameters:
method _outCurveV [line 11895]
void _outCurveV(
float
$x2, float
$y2, float
$x3, float
$y3)
|
|
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
Tags:
Parameters:
method _outCurveY [line 11911]
void _outCurveY(
float
$x1, float
$y1, float
$x3, float
$y3, float
$x2, float
$y2)
|
|
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points. The new current point shall be (x3, y3).
Tags:
Parameters:
method _outellipticalarc [line 12107]
void _outellipticalarc(
float
$xc, float
$yc, float
$rx, float
$ry, [
$xang = 0], [
$angs = 0], [
$angf = 360], [boolean
$pie = false], [integer
$nc = 2], float
$xang:, float
$angs:, float
$angf:)
|
|
Append an elliptical arc to the current path. An ellipse is formed from n Bezier curves.
Tags:
Parameters:
method _outLine [line 11851]
void _outLine(
float
$x, float
$y)
|
|
Append a straight line segment from the current point to the point (x, y). The new current point shall be (x, y).
Tags:
Parameters:
method _outPoint [line 11839]
void _outPoint(
float
$x, float
$y)
|
|
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
Tags:
Parameters:
method _outRect [line 11865]
void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)
|
|
Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
Tags:
Parameters:
method _Ovalue [line 11109]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for encryption)
Tags:
Parameters:
method _parsejpeg [line 6990]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 7016]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannotsobjs [line 7859]
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 7819]
void _putannotsrefs(
int
$n)
|
|
Output references to page annotations
Tags:
Parameters:
method _putAPXObject [line 8472]
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 13215]
Create a bookmark PDF string.
Tags:
method _putcatalog [line 9845]
method _putcidfont0 [line 9568]
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 4795]
void _putEmbeddedFiles(
)
|
|
Embedd the attached files.
Tags:
method _putencryption [line 10913]
Put encryption on PDF document.
Tags:
method _putextgstates [line 14744]
void _putextgstates(
array
$gs)
|
|
Put extgstates for object transparency
Tags:
Parameters:
method _putfonts [line 9019]
method _putfontwidths [line 8920]
PDF _putfontwidths(
array
$font, [int
$cidoffset = 0])
|
|
Outputs font widths
Tags:
Parameters:
method _putheader [line 10006]
method _putimages [line 9639]
method _putinfo [line 9798]
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Tags:
method _putjavascript [line 13324]
Create a javascript PDF string.
Tags:
method _putocg [line 14664]
Put visibility settings.
Tags:
method _putpages [line 7609]
method _putresourcedict [line 9713]
Output Resources Dictionary.
Tags:
method _putresources [line 9774]
method _putshaders [line 15298]
Output gradient shaders.
Tags:
method _putsignature [line 14352]
Add certification signature (DocMDP or UR3) You can set only one signature type
Tags:
method _putspotcolors [line 9695]
Output Spot Colors Resources.
Tags:
method _putstream [line 10355]
void _putstream(
string
$s, [int
$n = 0])
|
|
Output a stream (DEPRECATED).
Tags:
Parameters:
method _puttruetypeunicode [line 9179]
int _puttruetypeunicode(
array
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putviewerpreferences [line 9935]
string _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _RC4 [line 11032]
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 _setGDImageTransparency [line 6969]
void _setGDImageTransparency(
image
$new_image, image
$image)
|
|
Set the transparency for the given GD image.
Tags:
Parameters:
method _textstring [line 10295]
string _textstring(
string
$s, [int
$n = 0])
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 6932]
void _toJPEG(
image
$image, string
$file)
|
|
Convert the loaded 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 _toPNG [line 6951]
void _toPNG(
image
$image, string
$file)
|
|
Convert the loaded image to a PNG 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 11138]
Compute U value (used for encryption)
Tags:
|
|