Class: TCPDF
Source Location: /tcpdf.php
This is a PHP class for generating PDF documents without requiring external extensions.
Author(s):
- Nicola Asuni - info@tecnick.com
Version:
|
|
|
Class Details
Class Variables
$AliasNbPages = '{nb}'
[line 508]
Tags:
$AliasNumPage = '{pnb}'
[line 514]
Tags:
$annotation_fonts = array()
[line 1435]
List of fonts used on form fields (fontname => fontkey).
Tags:
$annots_start_obj_id = 200000
[line 1344]
Start ID for annotation objects
Tags:
$annot_obj_id = 200000
[line 1351]
Max ID of annotation object
Tags:
$apxo_obj_id = 400000
[line 1428]
Current ID of appearance streams XObjects
Tags:
$apxo_start_obj_id = 400000
[line 1421]
Start ID for appearance streams XObjects
Tags:
$author = ''
[line 490]
Tags:
$AutoPageBreak =
[line 448]
Tags:
$barcode = false
[line 603]
Tags:
$bgcolor =
[line 702]
Tags:
$bMargin =
[line 283]
Tags:
$booklet = false
[line 1083]
Booklet mode for double-sided pages
Tags:
$buffer =
[line 187]
Tags:
$bufferlen = 0
[line 1183]
Length of the buffer in bytes.
Tags:
$byterange_string = '/ByteRange[0 ********** ********** **********]'
[line 1316]
ByteRange placemark used during signature process.
Tags:
$cache_file_length = array()
[line 1239]
Array used to store the lengths of cache files
Tags:
$cache_maxsize_UTF8StringToArray = 8
[line 1267]
Maximum size of cache array used for UTF8StringToArray() method.
Tags:
$cache_size_UTF8StringToArray = 0
[line 1274]
Current size of cache array used for UTF8StringToArray() method.
Tags:
$cache_UTF8StringToArray = array()
[line 1260]
Cache array for UTF8StringToArray() method.
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 933]
Default cell height ratio.
Tags:
$cMargin =
[line 290]
Tags:
$cntmrk = array()
[line 970]
Array used to store content positions inside the pages buffer. keys are the page numbers
Tags:
$ColorFlag =
[line 442]
Tags:
$columns = array()
[line 1484]
Array of column measures (width, space, starting Y position)
Tags:
$column_start_page = 0
[line 1505]
Starting page for columns
Tags:
$compress =
[line 205]
Tags:
$CoreFonts =
[line 326]
Tags:
$creator = ''
[line 502]
Tags:
$CurOrientation =
[line 211]
Tags:
$CurrentFont =
[line 406]
Tags:
$current_column = 0
[line 1498]
Current column number
Tags:
$currpagegroup =
[line 891]
Contains the alias of the current page group
Tags:
$curr_annot_obj_id = 200000
[line 1358]
Current ID of annotation object
Tags:
$customlistindent = -1
[line 1105]
Tags:
$default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255),'strokeColor'=>array(128,128,128))
[line 1372]
Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
Tags:
$default_monospaced_font = 'courier'
[line 1225]
Default monospaced font
Tags:
$default_table_columns = 4
[line 645]
Tags:
$diffs = array()
[line 344]
Tags:
$diskcache = false
[line 1190]
If true enables disk caching.
Tags:
$dpi = 72
[line 870]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 424]
Tags:
$embeddedfiles = array()
[line 1119]
Tags:
$embedded_start_obj_id = 100000
[line 1337]
Start ID for embedded file objects
Tags:
$encoding = 'UTF-8'
[line 721]
Tags:
$encryptdata = array()
[line 758]
Array containing encryption settings
Tags:
$encrypted =
[line 751]
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 778]
Encryption padding
Tags:
$endlinex = 0
[line 999]
End position of the latest inserted line
Tags:
$epsmarker = 'x#!#EPS#!#x'
[line 1062]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 919]
Array of transparency objects and parameters.
Tags:
$feps = 0.005
[line 1090]
Epsilon value used for float calculations
Tags:
$fgcolor =
[line 666]
Tags:
$fhPt =
[line 235]
Tags:
$file_id =
[line 785]
File ID (used on trailer)
Tags:
$FillColor =
[line 430]
Tags:
$FontAscent =
[line 381]
Tags:
$FontDescent =
[line 388]
Tags:
$FontFamily =
[line 368]
Tags:
$FontFiles = array()
[line 338]
Tags:
$fontkeys = array()
[line 1204]
Store the font keys.
Tags:
$fontlist = array()
[line 660]
Tags:
$fonts = array()
[line 332]
Tags:
$FontSize =
[line 418]
Tags:
$FontSizePt =
[line 412]
Tags:
$FontStyle =
[line 374]
Tags:
$font_obj_ids = array()
[line 1211]
Store the font object IDs.
Tags:
$footerlen = array()
[line 985]
Array used to store footer length of each page.
Tags:
$footerpos = array()
[line 977]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 591]
Tags:
$footer_margin =
[line 565]
Tags:
$form_action = ''
[line 1400]
Current form action (used during XHTML rendering)
Tags:
$form_enctype = 'application/x-www-form-urlencoded'
[line 1407]
Current form encryption type (used during XHTML rendering)
Tags:
$form_mode = 'post'
[line 1414]
Current method to submit forms.
Tags:
$form_obj_id = array()
[line 1365]
List of form annotations IDs
Tags:
$fwPt =
[line 229]
Tags:
$gradients = array()
[line 954]
Array for storing gradient information.
Tags:
$h =
[line 259]
Tags:
$header_font =
[line 585]
Tags:
$header_logo = ''
[line 621]
Tags:
$header_logo_width = 30
[line 627]
Tags:
$header_margin =
[line 559]
Tags:
$header_string = ''
[line 639]
Tags:
$header_title = ''
[line 633]
Tags:
$hPt =
[line 247]
Tags:
$HREF = array()
[line 654]
Tags:
$htmlLinkColorArray = array(0, 0, 255)
[line 1141]
Default color for html links
Tags:
$htmlLinkFontStyle = 'U'
[line 1148]
Default font style to add to html links
Tags:
$htmlvspace = 0
[line 1041]
Count the latest inserted vertical spaces on HTML
Tags:
$imagekeys = array()
[line 1176]
Store the image keys.
Tags:
$images = array()
[line 350]
Tags:
$imgscale = 1
[line 538]
Tags:
$img_rb_x =
[line 522]
Tags:
$img_rb_y =
[line 530]
Tags:
$InFooter = false
[line 460]
Tags:
$internal_encoding =
[line 728]
Tags:
$inthead = false
[line 1477]
True when we are printing the thead section on a new page
Tags:
$intmrk = array()
[line 962]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$isunicode = false
[line 546]
Tags:
$javascript = ''
[line 811]
javascript code
Tags:
$jpeg_quality =
[line 926]
Set the default JPEG compression quality (1-100)
Tags:
$js_objects = array()
[line 1379]
Javascript objects array
Tags:
$js_obj_id = 300000
[line 1393]
Current ID of javascript object
Tags:
$js_start_obj_id = 300000
[line 1386]
Start ID for javascript objects
Tags:
$k =
[line 223]
Tags:
$keywords = ''
[line 496]
Tags:
$l =
[line 597]
Tags:
$lasth =
[line 314]
Tags:
$last_enc_key =
[line 765]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_enc_key_c =
[line 772]
last RC4 computed key
Tags:
$LayoutMode =
[line 472]
Tags:
$linestyleCap = '0 J'
[line 1013]
PDF string for last line width
Tags:
$linestyleDash = '[] 0 d'
[line 1027]
PDF string for last line width
Tags:
$linestyleJoin = '0 j'
[line 1020]
PDF string for last line width
Tags:
$linestyleWidth = ''
[line 1006]
PDF string for last line width
Tags:
$linethrough =
[line 825]
line trough state
Tags:
$LineWidth =
[line 320]
Tags:
$links = array()
[line 362]
Tags:
$lispacer = ''
[line 714]
Tags:
$listcount = array()
[line 678]
Tags:
$listindent = 0
[line 690]
Tags:
$listindentlevel = 0
[line 696]
Tags:
$listnum = 0
[line 684]
Tags:
$listordered = array()
[line 672]
Tags:
$lisymbol = ''
[line 1055]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 265]
Tags:
$n =
[line 175]
Tags:
$newline = true
[line 992]
True if a newline is created.
Tags:
$newpagegroup = array()
[line 877]
Array of page numbers were a new page group was started
Tags:
$numfonts = 0
[line 1197]
Counts the number of fonts.
Tags:
$numimages = 0
[line 1169]
Counts the number of pages.
Tags:
$numpages = 0
[line 1155]
Counts the number of pages.
Tags:
$num_columns = 0
[line 1491]
Number of colums
Tags:
$n_js =
[line 818]
javascript counter
Tags:
$n_ocg_print =
[line 905]
Print visibility.
Tags:
$n_ocg_view =
[line 912]
View visibility.
Tags:
$objcopy =
[line 1232]
Used to store a cloned copy of the current class object
Tags:
$offsets =
[line 181]
Tags:
$oldcMargin =
[line 296]
Tags:
$opencell = true
[line 1112]
Tags:
$openMarkedContent = false
[line 1034]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 572]
Tags:
$original_rMargin =
[line 579]
Tags:
$OutlineRoot =
[line 801]
Outline root for bookmark
Tags:
$outlines = array()
[line 794]
Outlines for bookmark
Tags:
$overline =
[line 400]
Tags:
$page =
[line 169]
Tags:
$PageAnnots = array()
[line 356]
Tags:
$PageBreakTrigger =
[line 454]
Tags:
$pagedim = array()
[line 217]
Tags:
$pagegroups =
[line 884]
Contains the number of pages of the groups
Tags:
$pagelen = array()
[line 1162]
Array containing page lengths in bytes.
Tags:
$PageMode =
[line 947]
A name object specifying how the document should be displayed when opened.
Tags:
$pageopen = array()
[line 1218]
Store the fage status (true when opened, false when closed).
Tags:
$pages = array()
[line 193]
Tags:
$page_obj_id = array()
[line 1330]
ID of page objects
Tags:
$pdfunit = 'mm'
[line 1533]
Tags:
$PDFVersion = '1.7'
[line 553]
Tags:
$premode = false
[line 1126]
Tags:
$print_footer = true
[line 615]
Tags:
$print_header = true
[line 609]
Tags:
$radiobutton_groups = array()
[line 1442]
List of radio buttons parent objects.
Tags:
$radio_groups = array()
[line 1449]
List of radio group objects IDs
Tags:
$rasterize_vector_images = false
[line 1546]
Tags:
$re_spaces = '/[\s]/'
[line 1302]
Regular expression used to find blank characters used for word-wrapping.
Tags:
$rMargin =
[line 277]
Tags:
$rtl = false
[line 735]
Tags:
$sign = false
[line 1281]
If true enables document signing
Tags:
$signature_data = array()
[line 1288]
Signature data
Tags:
$signature_max_length = 11742
[line 1295]
Signature max length
Tags:
$sig_annot_ref = '***SIGANNREF*** 0 R'
[line 1323]
Placemark used during signature process.
Tags:
$sig_obj_id = 0
[line 1309]
Signature object ID
Tags:
$spot_colors = array()
[line 1048]
Array of Spot colors
Tags:
$start_transaction_page = 0
[line 1463]
Store page number when startTransaction() is called.
Tags:
$start_transaction_y = 0
[line 1470]
Store Y position when startTransaction() is called.
Tags:
$state =
[line 199]
Tags:
$strokecolor =
[line 1526]
Tags:
$subject = ''
[line 484]
Tags:
$svgclipid = 0
[line 1609]
Tags:
$svgclipmode = false
[line 1595]
Tags:
$svgclippaths = array()
[line 1602]
Tags:
$svgdefs = array()
[line 1588]
Tags:
$svgdefsmode = false
[line 1581]
Tags:
$svgdir = ''
[line 1553]
Tags:
$svggradientid = 0
[line 1574]
Tags:
$svggradients = array()
[line 1567]
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 1623]
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 1630]
Tags:
$svgtext = ''
[line 1616]
Tags:
$svgunit = 'px'
[line 1560]
Tags:
$tagvspaces = array()
[line 1097]
Array used for custom vertical spaces for HTML tags
Tags:
$tempfontsize = 10
[line 708]
Tags:
$TextColor =
[line 436]
Tags:
$textindent = 0
[line 1456]
Text indentation value (used for text-indent CSS attribute)
Tags:
$textrendermode = 0
[line 1512]
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 1519]
Text stroke width in doc units
Tags:
$thead = ''
[line 1246]
Table header content to be repeated on each new page
Tags:
$theadMargins = array()
[line 1253]
Margins used for table header.
Tags:
$title = ''
[line 478]
Tags:
$tMargin =
[line 271]
Tags:
$tmprtl = false
[line 742]
Tags:
$tocpage = false
[line 1539]
Tags:
$transfmatrix = array()
[line 1069]
Array of transformation matrix
Tags:
$transfmatrix_key = 0
[line 1076]
Current key for transformation matrix
Tags:
$transfmrk = array()
[line 1134]
Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers
Tags:
$underline =
[line 394]
Tags:
$ur =
[line 835]
If true enables user's rights on PDF reader
Tags:
$ur_annots =
[line 849]
Names specifying additional annotation-related usage rights for the document.
Tags:
$ur_document =
[line 842]
Names specifying additional document-wide usage rights for the document.
Tags:
$ur_form =
[line 856]
Names specifying additional form-field-related usage rights for the document.
Tags:
$ur_signature =
[line 863]
Names specifying additional signature-related usage rights for the document.
Tags:
$viewer_preferences =
[line 940]
PDF viewer preferences.
Tags:
$visibility = 'all'
[line 898]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 253]
Tags:
$wPt =
[line 241]
Tags:
$x =
[line 302]
Tags:
$y =
[line 308]
Tags:
$ZoomMode =
[line 466]
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 1842]
Default destructor.
Tags:
method AcceptPageBreak [line 3964]
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 12468]
the addExtGState(
$parms, array
$params)
|
|
Add transparency parameters to the current extgstate
Tags:
Parameters:
method AddFont [line 3464]
array AddFont(
string
$family, [string
$style = ''], [string
$fontfile = ''])
|
|
Imports a TrueType, Type1, core, or CID0 font and makes it available. It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
Tags:
Parameters:
method addHtmlLink [line 8572]
the addHtmlLink(
string
$url, string
$name, [int
$fill = 0], [boolean
$firstline = false], [array
$color = ''], [string
$style = -1], [boolean
$firstblock = false])
|
|
Output anchor link.
Tags:
Parameters:
method addHTMLTOC [line 18064]
void addHTMLTOC(
[int
$page = ''], [string
$toc_name = 'TOC'], [array
$templates = array()], [
$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 16828]
void addHTMLVertSpace(
[string
$hbz = 0], [string
$hb = 0], [boolean
$cell = false], [boolean
$firstorlast = false])
|
|
Add vertical spaces if needed.
Tags:
Parameters:
method addJavascriptObject [line 11096]
int addJavascriptObject(
string
$script, [boolean
$onload = false])
|
|
Adds a javascript object and return object ID
Tags:
Parameters:
method AddLink [line 3766]
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 2638]
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 3083]
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 17914]
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 2613]
void addTOCPage(
[string
$orientation = ''], [
$format = ''], [boolean
$keepmargins = false])
|
|
Adds a new TOC (Table Of Content) page to the document.
Tags:
Parameters:
method AliasNbPages [line 12280]
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 12307]
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 3822]
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 10309]
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 8469]
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 10974]
void Bookmark(
string
$txt, [int
$level = 0], [float
$y = -1], [int
$page = ''])
|
|
Adds a bookmark.
Tags:
Parameters:
method Button [line 11983]
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 4043]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [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 11913]
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 3991]
boolean checkPageBreak(
[float
$h = 0], [mixed
$y = ''], [boolean
$addpage = true])
|
|
Add page if needed.
Tags:
Parameters:
method Circle [line 9997]
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 12929]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 2508]
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 16438]
void closeHTMLTagHandler(
&$dom, int
$key, boolean
$cell, [int
$maxbottomliney = 0], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method colorRegistrationBar [line 12604]
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 11852]
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 18176]
void commitTransaction(
)
|
|
Delete the copy of the current TCPDF object used for undo operation.
Tags:
method convertHexStringToString [line 9184]
String convertHexStringToString(
string
$bs)
|
|
Convert hexadecimal string to string
Tags:
Parameters:
method convertHTMLColorToDec [line 8605]
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 convertSVGtMatrix [line 19111]
array convertSVGtMatrix(
array
$tm)
|
|
Convert SVG transformation matrix to PDF.
Tags:
Parameters:
method CoonsPatchMesh [line 12844]
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 17846]
true copyPage(
[int
$page = 0])
|
|
Clone the specified page to a new page.
Tags:
Parameters:
method cropMark [line 12702]
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 9802]
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 17709]
true deletePage(
int
$page)
|
|
Remove the specified page.
Tags:
Parameters:
method Ellipse [line 9866]
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 18230]
boolean empty_string(
string
$str)
|
|
Determine whether a string is empty.
Tags:
Parameters:
method endPage [line 2658]
void endPage(
[boolean
$tocpage = false])
|
|
Terminate the current page
Tags:
Parameters:
method endSVGElementHandler [line 20138]
void endSVGElementHandler(
resource
$parser, string
$name)
|
|
Sets the closing SVG element handler function for the XML parser.
Tags:
Parameters:
method endTOCPage [line 2623]
Terminate the current TOC (Table Of Content) page
Tags:
method Error [line 2480]
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid. 2004-06-11 :: Nicola Asuni : changed bold tag with strong
Tags:
Parameters:
method Footer [line 2906]
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 12384]
void formatPageNumber(
int
$num)
|
|
Format the page numbers. This method can be overriden for custom formats.
Tags:
Parameters:
method formatTOCPageNumber [line 12396]
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 5918]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 12292]
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 12320]
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 11220]
array getAnnotOptFromJSProp(
array
$prop)
|
|
Convert JavaScript form fields properties array to Annotation Properties array.
Tags:
Parameters:
method GetArrStringWidth [line 3367]
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 13579]
Get current barcode.
Tags:
method getBorderMode [line 4667]
border getBorderMode(
mixed
$border, [string
$position = 'start'])
|
|
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
Tags:
Parameters:
method getBreakMargin [line 2205]
int getBreakMargin(
[int
$pagenum = ''])
|
|
Returns the page break margin.
Tags:
Parameters:
method getBuffer [line 17395]
Get buffer content.
Tags:
method getCellCode [line 4098]
void getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [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 12564]
void getCellHeightRatio(
)
|
|
return the height of cell repect font height.
Tags:
method GetCharWidth [line 3403]
int GetCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getEncPermissionsString [line 9205]
String getEncPermissionsString(
string
$protection)
|
|
Convert encryption P value to a string of bytes, low-order byte first.
Tags:
Parameters:
method getFontAscent [line 3737]
int getFontAscent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font ascent value
Tags:
Parameters:
method getFontBuffer [line 17555]
string getFontBuffer(
string
$font)
|
|
Get font buffer content.
Tags:
Parameters:
method getFontDescent [line 3716]
int getFontDescent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font descent value
Tags:
Parameters:
method getFontFamily [line 14063]
Returns the current font family name.
Tags:
method getFontSize [line 14043]
Returns the current font size.
Tags:
method getFontSizePt [line 14053]
Returns the current font size in points unit.
Tags:
method getFontsList [line 3442]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFontStyle [line 14073]
Returns the current font style.
Tags:
method getFooterFont [line 8530]
method getFooterMargin [line 2820]
Returns footer margin in user units.
Tags:
method getFormDefaultProp [line 11595]
array getFormDefaultProp(
)
|
|
Return the default properties for form fields.
Tags:
method getGDgamma [line 5858]
void getGDgamma(
float
$v)
|
|
Correct the gamma value to be used with GD library
Tags:
Parameters:
method getGraphicVars [line 17259]
Returns current graphic variables as array.
Tags:
method getGroupPageNo [line 12333]
current getGroupPageNo(
)
|
|
Return the current page in the group.
Tags:
method getGroupPageNoFormatted [line 12343]
void getGroupPageNoFormatted(
)
|
|
Returns the current group page number formatted as a string.
Tags:
method getHeaderData [line 2775]
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 8510]
method getHeaderMargin [line 2800]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 14109]
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 16974]
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 18502]
array getHyphenPatternsFromTEX(
string
$file)
|
|
Returns an array of hyphenation patterns.
Tags:
Parameters:
method getImageBuffer [line 17497]
string getImageBuffer(
string
$image)
|
|
Get image buffer content.
Tags:
Parameters:
method getImageFileType [line 5236]
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 2846]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 2855]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 2144]
Returns the adjusting factor to convert pixels to user units.
Tags:
method getLastH [line 2122]
Get the last cell height.
Tags:
method GetLineWidth [line 9548]
Returns the current the line width.
Tags:
method getMargins [line 14006]
Returns an array containing current margins:
Tags:
method GetNumChars [line 3430]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumLines [line 4755]
int getNumLines(
string
$txt, [float
$w = 0])
|
|
This method returns the estimated number of lines required to print the text (not the real number just a quick estimation). If you want o know the exact number of lines you have to use the following technique: // store current object
$pdf->startTransaction();
// get the number of lines for multicell
$lines = $pdf->MultiCell($w, 0, $txt, 0, 'L', 0, 0, '', '', true, 0, false, true, 0);
// restore previous object
$pdf = $pdf->rollbackTransaction();
Tags:
Parameters:
method getNumPages [line 2601]
Get the total number of insered pages.
Tags:
method getObjFilename [line 17327]
void getObjFilename(
$name, string
$prefix)
|
|
Returns a temporary filename for caching object on filesystem.
Tags:
Parameters:
method getOriginalMargins [line 14029]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 2589]
Get current document page number.
Tags:
method getPageBuffer [line 17438]
string getPageBuffer(
int
$page)
|
|
Get page buffer content.
Tags:
Parameters:
method getPageDimensions [line 2157]
array getPageDimensions(
[int
$pagenum = ''])
|
|
Returns an array of page dimensions: - $this->pagedim[$this->page]['w'] => page_width_in_points
- $this->pagedim[$this->page]['h'] => height in points
- $this->pagedim[$this->page]['wk'] => page_width_in_points
- $this->pagedim[$this->page]['hk'] => height
- $this->pagedim[$this->page]['tm'] => top_margin
- $this->pagedim[$this->page]['bm'] => bottom_margin
- $this->pagedim[$this->page]['lm'] => left_margin
- $this->pagedim[$this->page]['rm'] => right_margin
- $this->pagedim[$this->page]['pb'] => auto_page_break
- $this->pagedim[$this->page]['or'] => page_orientation
- $this->pagedim[$this->page]['olm'] => original_left_margin
- $this->pagedim[$this->page]['orm'] => original_right_margin
Tags:
Parameters:
method getPageGroupAlias [line 12355]
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 2189]
int getPageHeight(
[int
$pagenum = ''])
|
|
Returns the page height in units.
Tags:
Parameters:
method getPageNumGroupAlias [line 12370]
alias getPageNumGroupAlias(
)
|
|
Return the alias for the page number on the current page group If the current font is unicode type, the returned string is surrounded by additional curly braces. (will be replaced by the total number of pages in this group).
Tags:
method getPageWidth [line 2173]
int getPageWidth(
[int
$pagenum = ''])
|
|
Returns the page width in units.
Tags:
Parameters:
method getPathPaintOperator [line 18614]
void getPathPaintOperator(
string
$style, [string
$default = 'S'], boolean
$mode)
|
|
Get the Path-Painting Operators.
Tags:
Parameters:
method getPDFData [line 8553]
Returns the PDF data.
Tags:
method getRemainingWidth [line 5137]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 2057]
Return the RTL status
Tags:
method getScaleFactor [line 2219]
Returns the scale factor (number of points in user unit).
Tags:
method getSpaceString [line 14652]
Returns the string used to find spaces
Tags:
method GetStringWidth [line 3351]
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 18989]
array getSVGTransformMatrix(
string
$attribute)
|
|
Get the tranformation matrix from SVG transform attribute
Tags:
Parameters:
method getTransformationMatrixProduct [line 19093]
transformation getTransformationMatrixProduct(
array
$ta, array
$tb)
|
|
Get the product of two SVG tranformation matrices
Tags:
Parameters:
method getUserPermissionCode [line 9063]
void getUserPermissionCode(
Array
$permissions, [int
$mode = 0])
|
|
Return the premission code used on encryption (P value).
Tags:
Parameters:
method getVectorsAngle [line 19724]
void getVectorsAngle(
int
$x1, int
$y1, int
$x2, int
$y2)
|
|
Returns the angle in radiants between two vectors
Tags:
Parameters:
method GetX [line 5902]
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 5929]
Returns the ordinate of the current position.
Tags:
method get_mqr [line 5576]
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
Tags:
method Gradient [line 12953]
void Gradient(
int
$type, array
$coords, array
$stops, [array
$background = array()], [boolean
$antialias = false])
|
|
Output gradient.
Tags:
Parameters:
method Header [line 2864]
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 18541]
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 18432]
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 5286]
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 13293]
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 SVG 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 5814]
void ImagePngAlpha(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [boolean
$resize = false], [int
$dpi = 300], [string
$palign = ''])
|
|
Extract info from a PNG image with alpha channel using the GD library.
Tags:
Parameters:
method ImageSVG [line 18705]
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 SVG images using ImageMagick library.
Tags:
Parameters:
method IncludeJS [line 11083]
void IncludeJS(
string
$script)
|
|
Adds a javascript
Tags:
Parameters:
method intToRoman [line 17053]
string intToRoman(
int
$number)
|
|
Returns the Roman representation of an integer number
Tags:
Parameters:
method isRTLTextDir [line 2101]
Return the current temporary RTL status
Tags:
method lastPage [line 2578]
void lastPage(
[boolean
$resetmargins = false])
|
|
Reset pointer to the last document page.
Tags:
Parameters:
method Line [line 9718]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 12803]
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 3805]
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 11792]
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 5871]
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 9330]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 9366]
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 9353]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 9341]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method movePage [line 17572]
true movePage(
int
$frompage, int
$topage)
|
|
Move a page to a previous position.
Tags:
Parameters:
method MultiCell [line 4508]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
$ln = 1], [float
$x = ''], [float
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false], [boolean
$autopadding = true], [float
$maxh = 0])
|
|
This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other. Text can be aligned, centered or justified. The cell block can be framed and the background painted.
Tags:
Parameters:
method objclone [line 18219]
cloned objclone(
object
$object)
|
|
Creates a copy of a class object
Tags:
Parameters:
method Open [line 2495]
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 15822]
void openHTMLTagHandler(
&$dom, int
$key, boolean
$cell, array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 6021]
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 3067]
Returns the current page number.
Tags:
method PageNoFormatted [line 12406]
Returns the current page number formatted as a string.
Tags:
method PieSector [line 13232]
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 13253]
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 8662]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to User's Units.
Tags:
Parameters:
method Polycurve [line 9829]
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 10035]
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 10016]
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 17118]
void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])
|
|
Output an HTML list bullet or ordered item symbol
Tags:
Parameters:
method RadialGradient [line 12821]
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 11704]
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 17367]
mixed readDiskCache(
$filename, string
$file)
|
|
Read data from a temporary file on filesystem.
Tags:
Parameters:
method Rect [line 9746]
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 12772]
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 10133]
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 4061]
string removeSHY(
[string
$txt = ''])
|
|
Removes SHY characters from text.
Tags:
Parameters:
method revstrpos [line 18243]
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 5784]
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 18190]
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 9422]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 10223]
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 10242]
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 9298]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 9258]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 9284]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 9271]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method segSVGContentHandler [line 20176]
void segSVGContentHandler(
resource
$parser, string
$data)
|
|
Sets the character data handler function for the XML parser.
Tags:
Parameters:
method selectColumn [line 18306]
void selectColumn(
[int
$col = ''])
|
|
Set position at a given column
Tags:
Parameters:
method serializeTCPDFtagParameters [line 18357]
sting serializeTCPDFtagParameters(
array
$pararray)
|
|
Serialize an array of parameters to be used with TCPDF tag in HTML code.
Tags:
Parameters:
method setAlpha [line 12521]
void setAlpha(
float
$alpha, [string
$bm = 'Normal'])
|
|
Set alpha for stroking (CA) and non-stroking (ca) operations.
Tags:
Parameters:
method SetAuthor [line 2444]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 2311]
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 13569]
void setBarcode(
[string
$bc = ''])
|
|
Set document barcode.
Tags:
Parameters:
method SetBooklet [line 16888]
void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])
|
|
Set the booklet mode for double-sided pages.
Tags:
Parameters:
method setBuffer [line 17377]
void setBuffer(
string
$data)
|
|
Set buffer content (always append data).
Tags:
Parameters:
method setCellHeightRatio [line 12555]
void setCellHeightRatio(
int
$h)
|
|
Set the height of the cell (line height) respect the font height.
Tags:
Parameters:
method SetCellPadding [line 2299]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method setColumnsArray [line 18293]
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 2404]
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 2742]
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 2468]
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 3755]
void SetDefaultMonospacedFont(
string
$font)
|
|
Defines the default monospaced font.
Tags:
Parameters:
method setDefaultTableColumns [line 12545]
void setDefaultTableColumns(
[int
$cols = 4])
|
|
Set the default number of columns in a row for HTML tables.
Tags:
Parameters:
method SetDisplayMode [line 2326]
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 3122]
void SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])
|
|
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetDrawColorArray [line 3099]
void SetDrawColorArray(
array
$color)
|
|
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetDrawSpotColor [line 3163]
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 18260]
void setEqualColumns(
[int
$numcols = 0], [int
$width = 0], [int
$y = ''])
|
|
Set multiple columns of the same size
Tags:
Parameters:
method setExtGState [line 12487]
void setExtGState(
array
$gs)
|
|
Add an extgstate
Tags:
Parameters:
method SetFillColor [line 3205]
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 3182]
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 3247]
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 3668]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0], [string
$fontfile = ''])
|
|
Sets the font used to print character strings. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this: - They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant
Tags:
Parameters:
method setFontBuffer [line 17513]
void setFontBuffer(
string
$font, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method SetFontSize [line 3688]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFontSubBuffer [line 17535]
void setFontSubBuffer(
string
$font, string
$key, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method setFooter [line 2977]
This method is used to render the page footer.
Tags:
method setFooterFont [line 8520]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 2810]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setFormDefaultProp [line 11584]
void setFormDefaultProp(
[array
$prop = array()])
|
|
Set default properties for form fields.
Tags:
Parameters:
method setGraphicVars [line 17292]
void setGraphicVars(
$gvars
$gvars)
|
|
Set graphic variables.
Tags:
Parameters:
method setHeader [line 2941]
This method is used to render the page header.
Tags:
method setHeaderData [line 2761]
void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 8500]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 2790]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setHtmlLinksStyle [line 16959]
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 16928]
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 17454]
void setImageBuffer(
string
$image, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setImageScale [line 2133]
void setImageScale(
float
$scale)
|
|
Set the adjusting factor to convert pixels to user units.
Tags:
Parameters:
method setImageSubBuffer [line 17477]
void setImageSubBuffer(
string
$image, string
$key, array
$data)
|
|
Set image buffer content for a specified sub-key.
Tags:
Parameters:
method setJPEGQuality [line 12532]
void setJPEGQuality(
int
$quality)
|
|
Set the default JPEG compression quality (1-100)
Tags:
Parameters:
method SetKeywords [line 2456]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 8540]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 2112]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 2255]
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 9573]
void SetLineStyle(
array
$style)
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 9532]
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 3782]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setListIndentWidth [line 16938]
void setListIndentWidth(
float
$width)
|
|
Set custom width for list indentation.
Tags:
Parameters:
method setLIsymbol [line 16849]
void setLIsymbol(
[string
$symbol = '!'])
|
|
Set the default bullet to be used as LI bullet symbol
Tags:
Parameters:
method SetMargins [line 2233]
void SetMargins(
float
$left, float
$top, [float
$right = -1], [boolean
$keepmargins = false])
|
|
Defines the left, top and right margins.
Tags:
Parameters:
method setOpenCell [line 16948]
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 2531]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageBuffer [line 17411]
void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])
|
|
Set page buffer content.
Tags:
Parameters:
method setPageFormat [line 1901]
void setPageFormat(
mixed
$format, [string
$orientation = 'P'])
|
|
Set the page format
Tags:
Parameters:
method setPageMark [line 2730]
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 1974]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageUnit [line 1857]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 12574]
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 2837]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 2828]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 9107]
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 18588]
void setRasterizeVectorImages(
boolean
$mode)
|
|
Enable/disable rasterization of SVG images using ImageMagick library.
Tags:
Parameters:
method SetRightMargin [line 2285]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 2041]
void setRTL(
Boolean
$enable, [Boolean
$resetx = true])
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setSignature [line 12236]
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 setSpacesRE [line 2026]
void setSpacesRE(
[string
$re = '/[\s]/'])
|
|
Set regular expression to detect withespaces or word separators.
Tags:
Parameters:
method SetSubject [line 2432]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setSVGStyles [line 19150]
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 3023]
This method is used to render the table header on new page (if any).
Tags:
method setTempRTL [line 2067]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 3289]
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 3266]
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 18369]
void setTextRenderingMode(
[int
$stroke = 0], [boolean
$fill = true], [boolean
$clip = false])
|
|
Set Text rendering mode.
Tags:
Parameters:
method SetTextSpotColor [line 3328]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 2420]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 2270]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 12203]
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 12587]
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 12432]
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 5942]
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 6006]
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 5974]
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 5561]
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 9478]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 9451]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 9464]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 10181]
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 2686]
void startPage(
[string
$orientation = ''], [mixed
$format = ''], [boolean
$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 12265]
void startPageGroup(
[int
$page = ''])
|
|
Create a new page group. NOTE: call this function before calling AddPage()
Tags:
Parameters:
method startSVGElementHandler [line 19747]
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 18159]
Stores a copy of the current TCPDF object used for undo operation.
Tags:
method StartTransform [line 9226]
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 9241]
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 SVGPath [line 19406]
array SVGPath(
string
$d, [string
$style = ''])
|
|
Draws an SVG path
Tags:
Parameters:
method SVGTransform [line 19131]
void SVGTransform(
array
$tm)
|
|
Apply SVG graphic transformation matrix.
Tags:
Parameters:
method swapMargins [line 16904]
void swapMargins(
[boolean
$reverse = true])
|
|
Swap the left and right margins.
Tags:
Parameters:
method Text [line 3944]
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 = ''], [int
$fill = 0], [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 11613]
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 9508]
void Transform(
array
$tm)
|
|
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 9401]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 9378]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 9389]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 8673]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UniArrSubString [line 5176]
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 5209]
Returns the unicode caracter specified by UTF-8 value
Tags:
Parameters:
method UTF8ArrayToUniArray [line 5197]
Return UTF8ArrayToUniArray(
string
$ta)
|
|
Convert an array of UTF8 values to array of unicode characters
Tags:
Parameters:
method UTF8ArrSubString [line 5153]
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 8410]
array UTF8ArrToLatin1(
array
$unicode)
|
|
Converts UTF-8 characters array to array of Latin1 characters
Tags:
Parameters:
method utf8Bidi [line 10403]
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 10389]
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 8273]
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 10374]
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 8380]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 8364]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 4799]
mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0], [boolean
$firstline = false], [boolean
$firstblock = false], [float
$maxh = 0])
|
|
This method prints text from the current position.
Tags:
Parameters:
method write1DBarcode [line 13598]
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 13840]
void write2DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [array
$style = ''], [string
$align = ''])
|
|
Print 2D Barcode.
Tags:
Parameters:
method writeBarcode [line 13790]
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 17339]
void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)
|
|
Writes data to a temporary file on filesystem.
Tags:
Parameters:
method writeHTML [line 14672]
void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = false], [boolean
$reseth = false], [boolean
$cell = false], [string
$align = ''])
|
|
Allows to preserve some HTML formatting (limited support). IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
Tags:
Parameters:
method writeHTMLCell [line 14097]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 0], [boolean
$reseth = true], [string
$align = ''], [boolean
$autopadding = true])
|
|
Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Tags:
Parameters:
method _addfield [line 11185]
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 8895]
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 7957]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _dataannobjstring [line 8129]
string _dataannobjstring(
string
$s)
|
|
Format a data string for annotation objects
Tags:
Parameters:
method _datastring [line 8118]
string _datastring(
string
$s)
|
|
Format a data string for meta information
Tags:
Parameters:
method _datestring [line 8140]
Returns a formatted date for meta information
Tags:
method _destroy [line 6215]
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 6243]
Check for locale-related bug
Tags:
method _dolinethrough [line 8045]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dolinethroughw [line 8058]
void _dolinethroughw(
int
$x, int
$y,
$w, string
$txt)
|
|
Line through for rectangular text area.
Tags:
Parameters:
method _dooverline [line 8071]
void _dooverline(
int
$x, int
$y, string
$txt)
|
|
Overline text.
Tags:
Parameters:
method _dooverlinew [line 8084]
void _dooverlinew(
int
$x, int
$y, int
$w)
|
|
Overline for rectangular text area.
Tags:
Parameters:
method _dounderline [line 8020]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _dounderlinew [line 8033]
void _dounderlinew(
int
$x, int
$y, int
$w)
|
|
Underline for rectangular text area.
Tags:
Parameters:
method _encrypt_data [line 8706]
void _encrypt_data(
int
$n, string
$s)
|
|
Encrypt the input string.
Tags:
Parameters:
method _enddoc [line 7856]
Output end of document (EOF).
Tags:
method _endpage [line 7996]
method _escape [line 8107]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 8179]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 8096]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 8982]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getfontpath [line 6259]
method _getstream [line 8197]
void _getstream(
string
$s, [int
$n = 0])
|
|
Format output stream.
Tags:
Parameters:
method _JScolor [line 11161]
void _JScolor(
string
$color)
|
|
Convert color to javascript color.
Tags:
Parameters:
method _md5_16 [line 8913]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 8006]
Begin a new object and return the object number.
Tags:
method _objectkey [line 8687]
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 8221]
Output a string to the document.
Tags:
Parameters:
method _outCurve [line 9673]
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 9687]
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 9703]
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 9900]
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 9643]
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 9631]
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 9657]
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 8926]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for encryption)
Tags:
Parameters:
method _parsejpeg [line 5653]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 5679]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannotsobjs [line 6438]
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 6406]
void _putannotsrefs(
int
$n)
|
|
Output references to page annotations
Tags:
Parameters:
method _putAPXObject [line 7050]
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 11002]
Create a bookmark PDF string.
Tags:
method _putcatalog [line 7674]
method _putcidfont0 [line 7408]
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 3902]
void _putEmbeddedFiles(
)
|
|
Embedd the attached files.
Tags:
method _putencryption [line 8730]
Put encryption on PDF document.
Tags:
method _putextgstates [line 12497]
void _putextgstates(
array
$gs)
|
|
Put extgstates for object transparency
Tags:
Parameters:
method _putfonts [line 7079]
method _putfontwidths [line 7216]
PDF _putfontwidths(
array
$font, [int
$cidoffset = 0])
|
|
Outputs font widths
Tags:
Parameters:
method _putheader [line 7848]
method _putimages [line 7475]
method _putinfo [line 7630]
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Tags:
method _putjavascript [line 11108]
Create a javascript PDF string.
Tags:
method _putocg [line 12415]
Put visibility settings.
Tags:
method _putpages [line 6270]
method _putresourcedict [line 7547]
Output Resources Dictionary.
Tags:
method _putresources [line 7607]
method _putshaders [line 13051]
Output gradient shaders.
Tags:
method _putsignature [line 12133]
Add certification signature (DocMDP or UR3) You can set only one signature type
Tags:
method _putspotcolors [line 7529]
Output Spot Colors Resources.
Tags:
method _putstream [line 8212]
void _putstream(
string
$s, [int
$n = 0])
|
|
Output a stream.
Tags:
Parameters:
method _puttrailer [line 7831]
method _puttruetypeunicode [line 7315]
int _puttruetypeunicode(
array
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putviewerpreferences [line 7760]
string _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _RC4 [line 8849]
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 5632]
void _setGDImageTransparency(
image
$new_image, image
$image)
|
|
Set the transparency for the given GD image.
Tags:
Parameters:
method _textannobjstring [line 8165]
string _textannobjstring(
string
$s)
|
|
Format a UTF-8 text string for meta information on annotations
Tags:
Parameters:
method _textstring [line 8151]
string _textstring(
string
$s)
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 5595]
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 5614]
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 8955]
Compute U value (used for encryption)
Tags:
|
|