Class: TCPDF
Source Location: /shared/code/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 516]
Tags:
$AliasNumPage = '{pnb}'
[line 522]
Tags:
$annotation_fonts = array()
[line 1391]
List of fonts used on form fields (fontname => fontkey).
Tags:
$author = ''
[line 498]
Tags:
$AutoPageBreak =
[line 450]
Tags:
$barcode = false
[line 619]
Tags:
$bgcolor =
[line 717]
Tags:
$bMargin =
[line 284]
Tags:
$booklet = false
[line 1081]
Booklet mode for double-sided pages
Tags:
$bordermrk = array()
[line 953]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$buffer =
[line 188]
Tags:
$bufferlen = 0
[line 1181]
Length of the buffer in bytes.
Tags:
$byterange_string = '/ByteRange[0 ********** ********** **********]'
[line 1328]
ByteRange placemark used during signature process.
Tags:
$cache_file_length = array()
[line 1237]
Array used to store the lengths of cache files
Tags:
$cache_maxsize_UTF8StringToArray = 8
[line 1265]
Maximum size of cache array used for UTF8StringToArray() method.
Tags:
$cache_size_UTF8StringToArray = 0
[line 1272]
Current size of cache array used for UTF8StringToArray() method.
Tags:
$cache_UTF8StringToArray = array()
[line 1258]
Cache array for UTF8StringToArray() method.
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 916]
Default cell height ratio.
Tags:
$cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
[line 298]
Tags:
$cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
[line 291]
Tags:
$cntmrk = array()
[line 969]
Array used to store content positions inside the pages buffer. keys are the page numbers
Tags:
$ColorFlag =
[line 444]
Tags:
$columns = array()
[line 1440]
Array of column measures (width, space, starting Y position)
Tags:
$column_start_page = 0
[line 1461]
Starting page for columns
Tags:
$colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0),'p'=>array('L'=>0,'T'=>0,'R'=>0,'B'=>0))
[line 1475]
Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding
Tags:
$compress =
[line 206]
Tags:
$CoreFonts =
[line 328]
Tags:
$creator = ''
[line 510]
Tags:
$CurOrientation =
[line 212]
Tags:
$CurrentFont =
[line 408]
Tags:
$current_column = 0
[line 1454]
Current column number
Tags:
$currpagegroup =
[line 874]
Contains the alias of the current page group
Tags:
$customlistindent = -1
[line 1103]
Tags:
$default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255),'strokeColor'=>array(128,128,128))
[line 1356]
Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
Tags:
$default_graphic_vars = array()
[line 1530]
Tags:
$default_monospaced_font = 'courier'
[line 1223]
Default monospaced font
Tags:
$default_table_columns = 4
[line 661]
Tags:
$diffs = array()
[line 346]
Tags:
$diskcache = false
[line 1188]
If true enables disk caching.
Tags:
$docinfounicode = true
[line 480]
Tags:
$dpi = 72
[line 853]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 426]
Tags:
$embeddedfiles = array()
[line 1117]
Tags:
$emptypagemrk = array()
[line 961]
Array used to store page positions to track empty pages. keys are the page numbers
Tags:
$encoding = 'UTF-8'
[line 736]
Tags:
$encryptdata = array()
[line 773]
Array containing encryption settings
Tags:
$encrypted =
[line 766]
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 793]
Encryption padding
Tags:
$endlinex = 0
[line 997]
End position of the latest inserted line
Tags:
$epsmarker = 'x#!#EPS#!#x'
[line 1060]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 902]
Array of transparency objects and parameters.
Tags:
$feps = 0.005
[line 1088]
Epsilon value used for float calculations
Tags:
$fgcolor =
[line 681]
Tags:
$fhPt =
[line 236]
Tags:
$file_id =
[line 800]
File ID (used on trailer)
Tags:
$FillColor =
[line 432]
Tags:
$FontAscent =
[line 383]
Tags:
$FontDescent =
[line 390]
Tags:
$FontFamily =
[line 370]
Tags:
$FontFiles = array()
[line 340]
Tags:
$fontkeys = array()
[line 1202]
Store the font keys.
Tags:
$fontlist = array()
[line 675]
Tags:
$fonts = array()
[line 334]
Tags:
$FontSize =
[line 420]
Tags:
$FontSizePt =
[line 414]
Tags:
$FontStyle =
[line 376]
Tags:
$font_obj_ids = array()
[line 1209]
Store the font object IDs.
Tags:
$font_spacing = 0
[line 1565]
Tags:
$font_stretching = 100
[line 1558]
Tags:
$font_subsetting = true
[line 1523]
Tags:
$footerlen = array()
[line 983]
Array used to store footer length of each page.
Tags:
$footerpos = array()
[line 976]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 607]
Tags:
$footer_margin =
[line 581]
Tags:
$form_action = ''
[line 1370]
Current form action (used during XHTML rendering)
Tags:
$form_enctype = 'application/x-www-form-urlencoded'
[line 1377]
Current form encryption type (used during XHTML rendering)
Tags:
$form_mode = 'post'
[line 1384]
Current method to submit forms.
Tags:
$form_obj_id = array()
[line 1349]
List of form annotations IDs
Tags:
$fwPt =
[line 230]
Tags:
$gradients = array()
[line 937]
Array for storing gradient information.
Tags:
$h =
[line 260]
Tags:
$header_font =
[line 601]
Tags:
$header_logo = ''
[line 637]
Tags:
$header_logo_width = 30
[line 643]
Tags:
$header_margin =
[line 575]
Tags:
$header_string = ''
[line 655]
Tags:
$header_title = ''
[line 649]
Tags:
$hPt =
[line 248]
Tags:
$HREF = array()
[line 669]
Tags:
$htmlLinkColorArray = array(0, 0, 255)
[line 1139]
Default color for html links
Tags:
$htmlLinkFontStyle = 'U'
[line 1146]
Default font style to add to html links
Tags:
$htmlvspace = 0
[line 1039]
Count the latest inserted vertical spaces on HTML
Tags:
$imagekeys = array()
[line 1174]
Store the image keys.
Tags:
$images = array()
[line 352]
Tags:
$imgscale = 1
[line 546]
Tags:
$img_rb_x =
[line 530]
Tags:
$img_rb_y =
[line 538]
Tags:
$InFooter = false
[line 462]
Tags:
$internal_encoding =
[line 743]
Tags:
$inthead = false
[line 1433]
True when we are printing the thead section on a new page
Tags:
$intmrk = array()
[line 945]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$inxobj = false
[line 1544]
Tags:
$isunicode = false
[line 554]
Tags:
$javascript = ''
[line 825]
javascript code
Tags:
$jpeg_quality =
[line 909]
Set the default JPEG compression quality (1-100)
Tags:
$js_objects = array()
[line 1363]
Javascript objects array
Tags:
$k =
[line 224]
Tags:
$keywords = ''
[line 504]
Tags:
$l =
[line 613]
Tags:
$lasth =
[line 316]
Tags:
$last_enc_key =
[line 780]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_enc_key_c =
[line 787]
last RC4 computed key
Tags:
$LayoutMode =
[line 474]
Tags:
$linestyleCap = '0 J'
[line 1011]
PDF string for last line width
Tags:
$linestyleDash = '[] 0 d'
[line 1025]
PDF string for last line width
Tags:
$linestyleJoin = '0 j'
[line 1018]
PDF string for last line width
Tags:
$linestyleWidth = ''
[line 1004]
PDF string for last line width
Tags:
$linethrough =
[line 839]
line trough state
Tags:
$LineWidth =
[line 322]
Tags:
$links = array()
[line 364]
Tags:
$lispacer = ''
[line 729]
Tags:
$listcount = array()
[line 693]
Tags:
$listindent = 0
[line 705]
Tags:
$listindentlevel = 0
[line 711]
Tags:
$listnum = 0
[line 699]
Tags:
$listordered = array()
[line 687]
Tags:
$lisymbol = ''
[line 1053]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 266]
Tags:
$maxselcol = array('page' => 0, 'column' => 0)
[line 1468]
Maximum page and column selected
Tags:
$n =
[line 176]
Tags:
$newline = true
[line 990]
True if a newline is created.
Tags:
$newpagegroup = array()
[line 860]
Array of page numbers were a new page group was started
Tags:
$numfonts = 0
[line 1195]
Counts the number of fonts.
Tags:
$numimages = 0
[line 1167]
Counts the number of pages.
Tags:
$numpages = 0
[line 1153]
Counts the number of pages.
Tags:
$num_columns = 1
[line 1447]
Number of colums
Tags:
$n_js =
[line 832]
javascript counter
Tags:
$n_ocg_print =
[line 888]
Print visibility.
Tags:
$n_ocg_view =
[line 895]
View visibility.
Tags:
$objcopy =
[line 1230]
Used to store a cloned copy of the current class object
Tags:
$offsets =
[line 182]
Tags:
$opencell = true
[line 1110]
Tags:
$openMarkedContent = false
[line 1032]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 588]
Tags:
$original_rMargin =
[line 595]
Tags:
$OutlineRoot =
[line 816]
Outline root for bookmark
Tags:
$outlines = array()
[line 809]
Outlines for bookmark
Tags:
$overline =
[line 402]
Tags:
$page =
[line 170]
Tags:
$PageAnnots = array()
[line 358]
Tags:
$PageBreakTrigger =
[line 456]
Tags:
$pagedim = array()
[line 218]
Tags:
$pagegroups =
[line 867]
Contains the number of pages of the groups
Tags:
$pagelen = array()
[line 1160]
Array containing page lengths in bytes.
Tags:
$PageMode =
[line 930]
A name object specifying how the document should be displayed when opened.
Tags:
$pageopen = array()
[line 1216]
Store the fage status (true when opened, false when closed).
Tags:
$pages = array()
[line 194]
Tags:
$page_obj_id = array()
[line 1342]
ID of page objects
Tags:
$page_regions = array()
[line 1573]
Tags:
$pdfunit = 'mm'
[line 1503]
Tags:
$PDFVersion = '1.7'
[line 569]
Tags:
$premode = false
[line 1124]
Tags:
$print_footer = true
[line 631]
Tags:
$print_header = true
[line 625]
Tags:
$radiobutton_groups = array()
[line 1398]
List of radio buttons parent objects.
Tags:
$radio_groups = array()
[line 1405]
List of radio group objects IDs
Tags:
$rasterize_vector_images = false
[line 1516]
Tags:
$re_space = array('p' => '[^\S\xa0]', 'm' => '')
[line 1314]
Array of parts $re_spaces
Tags:
$re_spaces = '/[^\S\xa0]/'
[line 1307]
Regular expression used to find blank characters used for word-wrapping.
Tags:
$rMargin =
[line 278]
Tags:
$rtl = false
[line 750]
Tags:
$sign = false
[line 1279]
If true enables document signing
Tags:
$signature_appearance = array('page' => 1, 'rect' => '0 0 0 0')
[line 1300]
data for signature appearance
Tags:
$signature_data = array()
[line 1286]
Signature data
Tags:
$signature_max_length = 11742
[line 1293]
Signature max length
Tags:
$sig_annot_ref = '***SIGANNREF*** 0 R'
[line 1335]
Placemark used during signature process.
Tags:
$sig_obj_id = 0
[line 1321]
Signature object ID
Tags:
$spotcolor = array()
[line 1587]
Tags:
$spot_colors = array()
[line 1046]
Array of Spot colors
Tags:
$start_transaction_page = 0
[line 1419]
Store page number when startTransaction() is called.
Tags:
$start_transaction_y = 0
[line 1426]
Store Y position when startTransaction() is called.
Tags:
$state =
[line 200]
Tags:
$strokecolor =
[line 1496]
Tags:
$subject = ''
[line 492]
Tags:
$svgclipid = 0
[line 1657]
Tags:
$svgclipmode = false
[line 1636]
Tags:
$svgclippaths = array()
[line 1643]
Tags:
$svgcliptm = array()
[line 1650]
Tags:
$svgdefs = array()
[line 1629]
Tags:
$svgdefsmode = false
[line 1622]
Tags:
$svgdir = ''
[line 1594]
Tags:
$svggradientid = 0
[line 1615]
Tags:
$svggradients = array()
[line 1608]
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 1678]
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 1685]
Tags:
$svgtext = ''
[line 1664]
Tags:
$svgtextmode = array()
[line 1671]
Tags:
$svgunit = 'px'
[line 1601]
Tags:
$tagvspaces = array()
[line 1095]
Array used for custom vertical spaces for HTML tags
Tags:
$tcpdf_version = '5.9.029'
[line 162]
Tags:
$tempfontsize = 10
[line 723]
Tags:
$TextColor =
[line 438]
Tags:
$textindent = 0
[line 1412]
Text indentation value (used for text-indent CSS attribute)
Tags:
$textrendermode = 0
[line 1482]
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 1489]
Text stroke width in doc units
Tags:
$thead = ''
[line 1244]
Table header content to be repeated on each new page
Tags:
$theadMargins = array()
[line 1251]
Margins used for table header.
Tags:
$title = ''
[line 486]
Tags:
$tMargin =
[line 272]
Tags:
$tmprtl = false
[line 757]
Tags:
$tocpage = false
[line 1509]
Tags:
$transfmatrix = array()
[line 1067]
Array of transformation matrix
Tags:
$transfmatrix_key = 0
[line 1074]
Current key for transformation matrix
Tags:
$transfmrk = array()
[line 1132]
Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers
Tags:
$underline =
[line 396]
Tags:
$unicode =
[line 562]
Tags:
$ur = array()
[line 846]
Array with additional document-wide usage rights for the document.
Tags:
$viewer_preferences =
[line 923]
PDF viewer preferences.
Tags:
$visibility = 'all'
[line 881]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 254]
Tags:
$webcolor = array()
[line 1580]
Tags:
$wPt =
[line 242]
Tags:
$x =
[line 304]
Tags:
$xobjects = array()
[line 1537]
Tags:
$xobjid = ''
[line 1551]
Tags:
$y =
[line 310]
Tags:
$ZoomMode =
[line 468]
Tags:
Class Methods
constructor __construct [line 1767]
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 1915]
Default destructor.
Tags:
method AcceptPageBreak [line 5258]
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 15682]
the addExtGState(
$parms, array
$params)
|
|
Add transparency parameters to the current extgstate
Tags:
Parameters:
method AddFont [line 4700]
array AddFont(
string
$family, [string
$style = ''], [string
$fontfile = ''], [mixed
$subset = 'default'])
|
|
Imports a TrueType, Type1, core, or CID0 font and makes it available. It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
Tags:
Parameters:
method addHtmlLink [line 11456]
the addHtmlLink(
string
$url, string
$name, [boolean
$fill = false], [boolean
$firstline = false], [array
$color = ''], [string
$style = -1], [boolean
$firstblock = false])
|
|
Output anchor link.
Tags:
Parameters:
method addHTMLTOC [line 23264]
void addHTMLTOC(
[int
$page = ''], [string
$toc_name = 'TOC'], [array
$templates = array()], [boolean
$correct_align = true])
|
|
Output a Table Of Content Index (TOC) using HTML templates. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page.
Tags:
Parameters:
method addHTMLVertSpace [line 21650]
void addHTMLVertSpace(
[string
$hbz = 0], [string
$hb = 0], [boolean
$cell = false], [boolean
$firsttag = false], [boolean
$lasttag = false])
|
|
Add vertical spaces if needed.
Tags:
Parameters:
method addJavascriptObject [line 14266]
int addJavascriptObject(
string
$script, [boolean
$onload = false])
|
|
Adds a javascript object and return object ID
Tags:
Parameters:
method AddLink [line 5053]
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 3770]
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 addPageRegion [line 24357]
void addPageRegion(
array
$region)
|
|
Add a single no-write region on selected page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
Tags:
Parameters:
method AddSpotColor [line 4248]
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 23092]
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 3745]
void addTOCPage(
[string
$orientation = ''], [
$format = ''], [boolean
$keepmargins = false])
|
|
Adds a new TOC (Table Of Content) page to the document.
Tags:
Parameters:
method adjustCellPadding [line 3350]
array adjustCellPadding(
[mixed
$brd = 0])
|
|
Adjust the internal Cell padding array to take account of the line width.
Tags:
Parameters:
method AliasNbPages [line 15496]
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 15523]
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 5109]
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 13471]
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 11351]
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 14138]
void Bookmark(
string
$txt, [int
$level = 0], [float
$y = -1], [int
$page = ''])
|
|
Adds a bookmark.
Tags:
Parameters:
method Button [line 15152]
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 5363]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'])
|
|
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Tags:
Parameters:
method CheckBox [line 15082]
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 5285]
boolean checkPageBreak(
[float
$h = 0], [mixed
$y = ''], [boolean
$addpage = true])
|
|
Add page if needed.
Tags:
Parameters:
method checkPageRegions [line 24393]
void checkPageRegions(
float
$h,
&$x,
&$y, float
$x, float
$y)
|
|
Check page for no-write regions and adapt current coordinates and page margins if necessary. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
Tags:
Parameters:
method Circle [line 13159]
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 16143]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 3624]
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 21135]
void closeHTMLTagHandler(
&$dom, int
$key, boolean
$cell, [int
$maxbottomliney = 0], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method colorRegistrationBar [line 15818]
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 15023]
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 23388]
void commitTransaction(
)
|
|
Delete the copy of the current TCPDF object used for undo operation.
Tags:
method convertHexStringToString [line 12275]
String convertHexStringToString(
string
$bs)
|
|
Convert hexadecimal string to string
Tags:
Parameters:
method convertHTMLColorToDec [line 11500]
array convertHTMLColorToDec(
[string
$hcolor = '#FFFFFF'])
|
|
Returns an array (RGB or CMYK) from an html color name or a six-digit (i.e. #3FE5AA) or three-digit (i.e. #7FF) hexadecimal color representation.
Tags:
Parameters:
method convertStringToHexString [line 12297]
byte convertStringToHexString(
string
$s)
|
|
Convert string to hexadecimal string (byte string)
Tags:
Parameters:
method convertSVGtMatrix [line 24895]
array convertSVGtMatrix(
array
$tm)
|
|
Convert SVG transformation matrix to PDF.
Tags:
Parameters:
method CoonsPatchMesh [line 16058]
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 23022]
true copyPage(
[int
$page = 0])
|
|
Clone the specified page to a new page.
Tags:
Parameters:
method cropMark [line 15916]
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 12936]
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 22879]
true deletePage(
int
$page)
|
|
Remove the specified page.
Tags:
Parameters:
method drawHTMLTagBorder [line 21692]
void drawHTMLTagBorder(
array
$tag, int
$xmax)
|
|
Draw an HTML block border and fill
Tags:
Parameters:
method Ellipse [line 13000]
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 23442]
boolean empty_string(
string
$str)
|
|
Determine whether a string is empty.
Tags:
Parameters:
method endPage [line 3794]
void endPage(
[boolean
$tocpage = false])
|
|
Terminate the current page
Tags:
Parameters:
method endSVGElementHandler [line 26023]
void endSVGElementHandler(
resource
$parser, string
$name)
|
|
Sets the closing SVG element handler function for the XML parser.
Tags:
Parameters:
method endTemplate [line 24124]
End the current XObject Template started with startTemplate() and restore the previous graphic state. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
Tags:
method endTOCPage [line 3755]
Terminate the current TOC (Table Of Content) page
Tags:
method Error [line 3597]
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid. 2004-06-11 :: Nicola Asuni : changed bold tag with strong
Tags:
Parameters:
method extractCSSproperties [line 17618]
An extractCSSproperties(
string
$cssdata)
|
|
Extracts the CSS properties from a CSS string.
Tags:
Parameters:
method fitBlock [line 7039]
void fitBlock(
&$w,
&$h,
&$x,
&$y, [boolean
$fitonpage = false], float
$w, float
$h, float
$x, float
$y)
|
|
Set the block dimensions accounting for page breaks and page/column fitting
Tags:
Parameters:
method fixHTMLCode [line 17557]
string fixHTMLCode(
string
$html, [string
$default_css = ''], [array
$tagvs = ''], [array
$tidy_options = ''])
|
|
Cleanup HTML code (requires HTML Tidy library).
Tags:
Parameters:
method Footer [line 4051]
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:
Overridden in child classes as:
- TCPDFEX::Footer()
- This method is used to render the page footer and overrides the original Footer() method on TCPDF.
method formatPageNumber [line 15600]
void formatPageNumber(
int
$num)
|
|
Format the page numbers. This method can be overriden for custom formats.
Tags:
Parameters:
method formatTOCPageNumber [line 15612]
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 7879]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 15508]
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 15536]
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 14391]
array getAnnotOptFromJSProp(
array
$prop)
|
|
Convert JavaScript form fields properties array to Annotation Properties array.
Tags:
Parameters:
method GetArrStringWidth [line 4579]
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 16842]
Get current barcode.
Tags:
method getBorderMode [line 6326]
border getBorderMode(
mixed
$brd, [string
$position = 'start'])
|
|
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
Tags:
Parameters:
method getBorderStartPosition [line 21676]
array getBorderStartPosition(
)
|
|
Return the starting coordinates to draw an html border
Tags:
method getBreakMargin [line 3168]
int getBreakMargin(
[int
$pagenum = ''])
|
|
Returns the page break margin.
Tags:
Parameters:
method getBuffer [line 22555]
Get buffer content.
Tags:
method getCellBorder [line 5807]
string getCellBorder(
float
$x, float
$y, float
$w, float
$h, mixed
$brd, string
$mode)
|
|
Returns the code to draw the cell border
Tags:
Parameters:
method getCellCode [line 5399]
string getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'])
|
|
Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Tags:
Parameters:
method getCellHeightRatio [line 15778]
void getCellHeightRatio(
)
|
|
return the height of cell repect font height.
Tags:
method getCellMargins [line 3339]
Get the internal Cell margin array.
Tags:
method getCellPaddings [line 3303]
Get the internal Cell padding array.
Tags:
method GetCharWidth [line 4616]
float GetCharWidth(
int
$char, [boolean
$notlast = true])
|
|
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking/kerning).
Tags:
Parameters:
method getColumn [line 23593]
Return the current column number
Tags:
method getCSSBorderDashStyle [line 17918]
int getCSSBorderDashStyle(
string
$style)
|
|
Returns the border dash style from CSS property
Tags:
Parameters:
method getCSSBorderMargin [line 18113]
array getCSSBorderMargin(
string
$cssbspace, [float
$width = 0])
|
|
Get the border-spacing from CSS attribute.
Tags:
Parameters:
method getCSSBorderStyle [line 17954]
array getCSSBorderStyle(
string
$cssborder)
|
|
Returns the border style array from CSS border properties
Tags:
Parameters:
method getCSSBorderWidth [line 17898]
int getCSSBorderWidth(
string
$width)
|
|
Returns the border width from CSS property
Tags:
Parameters:
method getCSSFontSpacing [line 18147]
float getCSSFontSpacing(
string
$spacing, [float
$parent = 0])
|
|
Returns the letter-spacing value from CSS value
Tags:
Parameters:
method getCSSFontStretching [line 18178]
float getCSSFontStretching(
string
$stretch, [float
$parent = 100])
|
|
Returns the percentage of font stretching from CSS value
Tags:
Parameters:
method getCSSMargin [line 18059]
array getCSSMargin(
string
$cssmargin, [float
$width = 0])
|
|
Get the internal Cell margin from CSS attribute.
Tags:
Parameters:
method getCSSPadding [line 18005]
array getCSSPadding(
string
$csspadding, [float
$width = 0])
|
|
Get the internal Cell padding from CSS attribute.
Tags:
Parameters:
method getEncPermissionsString [line 12314]
String getEncPermissionsString(
string
$protection)
|
|
Convert encryption P value to a string of bytes, low-order byte first.
Tags:
Parameters:
method getFontAscent [line 5025]
int getFontAscent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font ascent value
Tags:
Parameters:
method getFontBuffer [line 22719]
string getFontBuffer(
string
$font)
|
|
Get font buffer content.
Tags:
Parameters:
method getFontDescent [line 5004]
int getFontDescent(
string
$font, [string
$style = ''], [float
$size = 0])
|
|
Return the font descent value
Tags:
Parameters:
method getFontFamily [line 17531]
Returns the current font family name.
Tags:
method getFontFamilyName [line 24022]
string getFontFamilyName(
string
$fontfamily)
|
|
Return normalized font name
Tags:
Parameters:
method getFontSize [line 17511]
Returns the current font size.
Tags:
method getFontSizePt [line 17521]
Returns the current font size in points unit.
Tags:
method getFontsList [line 4677]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFontSpacing [line 24310]
Get the amount to increase or decrease the space between characters in a text.
Tags:
method getFontStretching [line 24288]
float getFontStretching(
)
|
|
Get the percentage of character stretching.
Tags:
method getFontStyle [line 17541]
Returns the current font style.
Tags:
method getFontSubsetting [line 23958]
boolean getFontSubsetting(
)
|
|
Return the default option for font subsetting.
Tags:
method getFooterFont [line 11414]
method getFooterMargin [line 3958]
Returns footer margin in user units.
Tags:
method getFormDefaultProp [line 14766]
array getFormDefaultProp(
)
|
|
Return the default properties for form fields.
Tags:
method getGDgamma [line 7815]
void getGDgamma(
float
$v)
|
|
Correct the gamma value to be used with GD library
Tags:
Parameters:
method getGraphicVars [line 22346]
Returns current graphic variables as array.
Tags:
method getGroupPageNo [line 15549]
current getGroupPageNo(
)
|
|
Return the current page in the group.
Tags:
method getGroupPageNoFormatted [line 15559]
void getGroupPageNoFormatted(
)
|
|
Returns the current group page number formatted as a string.
Tags:
method getHeaderData [line 3913]
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 11394]
method getHeaderMargin [line 3938]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 18248]
array getHtmlDomArray(
string
$html)
|
|
Returns the HTML DOM array.
Tags:
Parameters:
method getHTMLUnitToUnits [line 22019]
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 23759]
array getHyphenPatternsFromTEX(
string
$file)
|
|
Returns an array of hyphenation patterns.
Tags:
Parameters:
method getImageBuffer [line 22657]
string getImageBuffer(
string
$image)
|
|
Get image buffer content.
Tags:
Parameters:
method getImageFileType [line 7009]
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 3984]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 3993]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 3107]
Returns the adjusting factor to convert pixels to user units.
Tags:
method getLastH [line 3085]
Get the last cell height.
Tags:
method GetLineWidth [line 12676]
Returns the current the line width.
Tags:
method getMargins [line 17470]
Returns an array containing current margins:
Tags:
method getNumberOfColumns [line 23603]
int getNumberOfColumns(
)
|
|
Return the current number of columns.
Tags:
method GetNumChars [line 4665]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumLines [line 6404]
float getNumLines(
string
$txt, [float
$w = 0], [boolean
$reseth = false], [boolean
$autopadding = true], [float
$cellpadding = ''], [mixed
$border = 0])
|
|
This method return the estimated number of lines for print a simple text string using Multicell() method.
Tags:
Parameters:
method getNumPages [line 3733]
Get the total number of insered pages.
Tags:
method getObjFilename [line 22469]
void getObjFilename(
$name, string
$prefix)
|
|
Returns a temporary filename for caching object on filesystem.
Tags:
Parameters:
method getOriginalMargins [line 17497]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 3722]
Get current document page number.
Tags:
method getPageBuffer [line 22598]
string getPageBuffer(
int
$page)
|
|
Get page buffer content.
Tags:
Parameters:
method getPageDimensions [line 3120]
array getPageDimensions(
[int
$pagenum = ''])
|
|
Returns an array of page dimensions: - $this->pagedim[$this->page]['w'] = page width in points
- $this->pagedim[$this->page]['h'] = height in points
- $this->pagedim[$this->page]['wk'] = page width in user units
- $this->pagedim[$this->page]['hk'] = page height in user units
- $this->pagedim[$this->page]['tm'] = top margin
- $this->pagedim[$this->page]['bm'] = bottom margin
- $this->pagedim[$this->page]['lm'] = left margin
- $this->pagedim[$this->page]['rm'] = right margin
- $this->pagedim[$this->page]['pb'] = auto page break
- $this->pagedim[$this->page]['or'] = page orientation
- $this->pagedim[$this->page]['olm'] = original left margin
- $this->pagedim[$this->page]['orm'] = original right margin
- $this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
- $this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.
- $this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation
- $this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.
- $this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade
- $this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.
- $this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.
- $this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.
- $this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.
- $this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
- $this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
- $this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed
- $this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['CropBox'] : the visible region of default user space
- $this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment
- $this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming
- $this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points
- $this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content
- $this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points
Tags:
Parameters:
method getPageGroupAlias [line 15571]
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 3152]
int getPageHeight(
[int
$pagenum = ''])
|
|
Returns the page height in units.
Tags:
Parameters:
method getPageNumGroupAlias [line 15586]
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 getPageRegions [line 24322]
Return an array of no-write page regions
Tags:
method getPageSizeFromFormat [line 2291]
array getPageSizeFromFormat(
mixed
$format)
|
|
Get page dimensions from format name.
Tags:
Parameters:
method getPageWidth [line 3136]
int getPageWidth(
[int
$pagenum = ''])
|
|
Returns the page width in units.
Tags:
Parameters:
method getPathPaintOperator [line 23870]
void getPathPaintOperator(
string
$style, [string
$default = 'S'], boolean
$mode)
|
|
Get the Path-Painting Operators.
Tags:
Parameters:
method getPDFData [line 11437]
Returns the PDF data.
Tags:
method getRandomSeed [line 11620]
string getRandomSeed(
[string
$seed = ''])
|
|
Returns a string containing random data to be used as a seed for encryption methods.
Tags:
Parameters:
method getRawCharWidth [line 4638]
float getRawCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getRemainingWidth [line 6909]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 3013]
Return the RTL status
Tags:
method getScaleFactor [line 3182]
Returns the scale factor (number of points in user unit).
Tags:
method getSpaceString [line 19011]
Returns the string used to find spaces
Tags:
method getStringHeight [line 6507]
float getStringHeight(
float
$w, string
$txt, [boolean
$reseth = false], [boolean
$autopadding = true], [float
$cellpadding = ''], [mixed
$border = 0])
|
|
This method return the estimated needed height for print a simple text string in Multicell() method. Generally, if you want to know the exact height for a block of content you can use the following alternative technique: // store current object
$pdf->startTransaction();
// store starting values
$start_y = $pdf->GetY();
$start_page = $pdf->getPage();
// call your printing functions with your parameters
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$pdf->MultiCell($w=0, $h=0, $txt, $border=1, $align='L', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0);
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// get the new Y
$end_y = $pdf->GetY();
$end_page = $pdf->getPage();
// calculate height
$height = 0;
if ($end_page == $start_page) {
$height = $end_y - $start_y;
} else {
for ($page=$start_page; $page <= $end_page; ++$page) {
$this->setPage($page);
if ($page == $start_page) {
// first page
$height = $this->h - $start_y - $this->bMargin;
} elseif ($page == $end_page) {
// last page
$height = $end_y - $this->tMargin;
} else {
$height = $this->h - $this->tMargin - $this->bMargin;
}
}
}
// restore previous object
$pdf = $pdf->rollbackTransaction();
Tags:
Parameters:
method GetStringWidth [line 4563]
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 24781]
array getSVGTransformMatrix(
string
$attribute)
|
|
Get the tranformation matrix from SVG transform attribute
Tags:
Parameters:
method getTagStyleFromCSS [line 17870]
string getTagStyleFromCSS(
array
$dom, int
$key, array
$css)
|
|
Returns the styles that apply for the selected HTML tag.
Tags:
Parameters:
method getTCPDFVersion [line 1930]
Return the current TCPDF version.
Tags:
method getTransformationMatrixProduct [line 24877]
transformation getTransformationMatrixProduct(
array
$ta, array
$tb)
|
|
Get the product of two SVG tranformation matrices
Tags:
Parameters:
method getUserPermissionCode [line 12136]
void getUserPermissionCode(
Array
$permissions, [int
$mode = 0])
|
|
Return the premission code used on encryption (P value).
Tags:
Parameters:
method getVectorsAngle [line 25538]
void getVectorsAngle(
int
$x1, int
$y1, int
$x2, int
$y2)
|
|
Returns the angle in radiants between two vectors
Tags:
Parameters:
method GetX [line 7863]
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 7890]
Returns the ordinate of the current position.
Tags:
method get_mqr [line 7508]
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
Tags:
method Gradient [line 16167]
void Gradient(
int
$type, array
$coords, array
$stops, [array
$background = array()], [boolean
$antialias = false])
|
|
Output gradient.
Tags:
Parameters:
method Header [line 4002]
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:
Overridden in child classes as:
- TCPDFEX::Header()
- This method is used to render the page header and overrides the original Header() method on TCPDF.
method hyphenateText [line 23798]
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 23689]
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 7124]
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], [mixed
$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 16516]
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], [boolean
$fixoutvals = false])
|
|
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
Tags:
Parameters:
method ImagePngAlpha [line 7754]
void ImagePngAlpha(
string
$file, float
$x, float
$y, float
$wpx, float
$hpx, float
$w, float
$h, string
$type, mixed
$link, string
$align, boolean
$resize, int
$dpi, string
$palign)
|
|
Extract info from a PNG image with alpha channel using the GD library.
Tags:
Parameters:
method ImageSVG [line 24479]
void ImageSVG(
string
$file, [float
$x = ''], [float
$y = ''], [float
$w = 0], [float
$h = 0], [mixed
$link = ''], [string
$align = ''], [string
$palign = ''], [mixed
$border = 0], [boolean
$fitonpage = false])
|
|
Embedd a Scalable Vector Graphics (SVG) image. NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
Tags:
Parameters:
method IncludeJS [line 14253]
void IncludeJS(
string
$script)
|
|
Adds a javascript
Tags:
Parameters:
method intToRoman [line 22098]
string intToRoman(
int
$number)
|
|
Returns the Roman representation of an integer number
Tags:
Parameters:
method isRTLTextDir [line 3055]
Return the current temporary RTL status
Tags:
method isUnicodeFont [line 24010]
Return true if the current font is unicode type.
Tags:
method isValidCSSSelectorForTag [line 17710]
true isValidCSSSelectorForTag(
array
$dom, int
$key, string
$selector)
|
|
Returns true if the CSS selector is valid for the selected HTML tag
Tags:
Parameters:
method lastPage [line 3711]
void lastPage(
[boolean
$resetmargins = false])
|
|
Reset pointer to the last document page.
Tags:
Parameters:
method Line [line 12853]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 16017]
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 5092]
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 14965]
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 7828]
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 12450]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 12486]
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 12473]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 12461]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method movePage [line 22736]
true movePage(
int
$frompage, int
$topage)
|
|
Move a page to a previous position.
Tags:
Parameters:
method MultiCell [line 6010]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [boolean
$fill = false], [int
$ln = 1], [float
$x = ''], [float
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = false], [boolean
$autopadding = true], [float
$maxh = 0], [string
$valign = 'T'], [boolean
$fitcell = false])
|
|
This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other. Text can be aligned, centered or justified. The cell block can be framed and the background painted.
Tags:
Parameters:
method objclone [line 23431]
cloned objclone(
object
$object)
|
|
Creates a copy of a class object
Tags:
Parameters:
method Open [line 3612]
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 20518]
void openHTMLTagHandler(
&$dom, int
$key, boolean
$cell, array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 7982]
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 4232]
Returns the current page number.
Tags:
method PageNoFormatted [line 15622]
Returns the current page number formatted as a string.
Tags:
method PieSector [line 16454]
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 16475]
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 11595]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to User's Units.
Tags:
Parameters:
method Polycurve [line 12963]
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 13197]
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 13178]
void PolyLine(
array
$p, [string
$style = ''], [array
$line_style = array()], [array
$fill_color = array()], boolean
$closed)
|
|
Draws a polygonal line
Tags:
Parameters:
method printTemplate [line 24153]
void printTemplate(
string
$id, [int
$x = ''], [int
$y = ''], [int
$w = 0], [int
$h = 0], [string
$align = ''], [string
$palign = ''], [boolean
$fitonpage = false])
|
|
Print an XObject Template. You can print an XObject Template inside the currently opened Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
Tags:
Parameters:
method putHtmlListBullet [line 22163]
void putHtmlListBullet(
int
$listdepth, [string
$listtype = ''], [float
$size = 10])
|
|
Output an HTML list bullet or ordered item symbol
Tags:
Parameters:
method RadialGradient [line 16035]
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 14873]
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 22509]
mixed readDiskCache(
$filename, string
$file)
|
|
Read data from a temporary file on filesystem.
Tags:
Parameters:
method Rect [line 12881]
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 15986]
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 13295]
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 removePageRegion [line 24376]
void removePageRegion(
int
$key)
|
|
Remove a single no-write region.
Tags:
Parameters:
method removeSHY [line 5336]
string removeSHY(
[string
$txt = ''])
|
|
Removes SHY characters from text. Unicode Data: - Name : SOFT HYPHEN, commonly abbreviated as SHY
- HTML Entity (decimal): &#173;
- HTML Entity (hex): &#xad;
- HTML Entity (named): &shy;
- How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]
- UTF-8 (hex): 0xC2 0xAD (c2ad)
- UTF-8 character: chr(194).chr(173)
Tags:
Parameters:
method replaceBuffer [line 22537]
void replaceBuffer(
string
$data)
|
|
Replace the buffer content
Tags:
Parameters:
method resetLastH [line 3075]
Reset the last cell height.
Tags:
method revstrpos [line 23455]
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 7722]
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 23402]
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 12543]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 13385]
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 13404]
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 12417]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 12377]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 12403]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 12390]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method segSVGContentHandler [line 26092]
void segSVGContentHandler(
resource
$parser, string
$data)
|
|
Sets the character data handler function for the XML parser.
Tags:
Parameters:
method selectColumn [line 23518]
void selectColumn(
[int
$col = ''])
|
|
Set position at a given column
Tags:
Parameters:
method serializeTCPDFtagParameters [line 23614]
sting serializeTCPDFtagParameters(
array
$pararray)
|
|
Serialize an array of parameters to be used with TCPDF tag in HTML code.
Tags:
Parameters:
method setAlpha [line 15735]
void setAlpha(
float
$alpha, [string
$bm = 'Normal'])
|
|
Set alpha for stroking (CA) and non-stroking (ca) operations.
Tags:
Parameters:
method SetAuthor [line 3564]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 3425]
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 16832]
void setBarcode(
[string
$bc = ''])
|
|
Set document barcode.
Tags:
Parameters:
method SetBooklet [line 21933]
void SetBooklet(
[boolean
$booklet = true], [float
$inner = -1], [float
$outer = -1])
|
|
Set the booklet mode for double-sided pages.
Tags:
Parameters:
method setBuffer [line 22519]
void setBuffer(
string
$data)
|
|
Set buffer content (always append data).
Tags:
Parameters:
method setCellHeightRatio [line 15769]
void setCellHeightRatio(
int
$h)
|
|
Set the height of the cell (line height) respect the font height.
Tags:
Parameters:
method setCellMargins [line 3317]
void setCellMargins(
[float
$left = ''], [float
$top = ''], [float
$right = ''], [float
$bottom = ''])
|
|
Set the internal Cell margins.
Tags:
Parameters:
method SetCellPadding [line 3262]
void SetCellPadding(
float
$pad)
|
|
Set the same internal Cell padding for top, right, bottom, left-
Tags:
Parameters:
method setCellPaddings [line 3281]
void setCellPaddings(
[float
$left = ''], [float
$top = ''], [float
$right = ''], [float
$bottom = ''])
|
|
Set the internal Cell paddings.
Tags:
Parameters:
method setColumnsArray [line 23505]
void setColumnsArray(
array
$columns)
|
|
Set columns array. Each column is represented by an array of arrays with the following keys: (w = width, s = space between columns, y = column top position).
Tags:
Parameters:
method SetCompression [line 3516]
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 3880]
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 3586]
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 5042]
void SetDefaultMonospacedFont(
string
$font)
|
|
Defines the default monospaced font.
Tags:
Parameters:
method setDefaultTableColumns [line 15759]
void setDefaultTableColumns(
[int
$cols = 4])
|
|
Set the default number of columns in a row for HTML tables.
Tags:
Parameters:
method SetDisplayMode [line 3439]
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 SetDocInfoUnicode [line 3531]
void SetDocInfoUnicode(
[
$unicode = true], boolean
$uni)
|
|
Turn on/off Unicode mode for document information dictionary (meta tags). This has effect only when unicode mode is set to false.
Tags:
Parameters:
method SetDrawColor [line 4299]
string SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1], [boolean
$ret = false], [string
$name = ''])
|
|
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 4271]
string SetDrawColorArray(
array
$color, [boolean
$ret = false])
|
|
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB, CMYK or GRAY SCALE components. 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 4349]
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 23472]
void setEqualColumns(
[int
$numcols = 0], [int
$width = 0], [int
$y = ''])
|
|
Set multiple columns of the same size
Tags:
Parameters:
method setExtGState [line 15701]
void setExtGState(
array
$gs)
|
|
Add an extgstate
Tags:
Parameters:
method SetFillColor [line 4397]
string SetFillColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1], [boolean
$ret = false], [string
$name = ''])
|
|
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 4370]
void SetFillColorArray(
array
$color, [boolean
$ret = false])
|
|
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB, CMYK or GRAY SCALE components. 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 4448]
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 4939]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0], [string
$fontfile = ''], [mixed
$subset = 'default'])
|
|
Sets the font used to print character strings. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this: - They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant
Tags:
Parameters:
method setFontBuffer [line 22673]
void setFontBuffer(
string
$font, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method SetFontSize [line 4960]
void SetFontSize(
float
$size, [boolean
$out = true])
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFontSpacing [line 24299]
void setFontSpacing(
[float
$spacing = 0])
|
|
Set the amount to increase or decrease the space between characters in a text.
Tags:
Parameters:
method setFontStretching [line 24277]
void setFontStretching(
[int
$perc = 100])
|
|
Set the percentage of character stretching.
Tags:
Parameters:
method setFontSubBuffer [line 22699]
void setFontSubBuffer(
string
$font, string
$key, array
$data)
|
|
Set font buffer content.
Tags:
Parameters:
method setFontSubsetting [line 23947]
void setFontSubsetting(
[boolean
$enable = true])
|
|
Enable or disable default option for font subsetting.
Tags:
Parameters:
method setFooter [line 4135]
This method is used to render the page footer.
Tags:
method setFooterFont [line 11404]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 3948]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setFormDefaultProp [line 14755]
void setFormDefaultProp(
[array
$prop = array()])
|
|
Set default properties for form fields.
Tags:
Parameters:
method setGraphicVars [line 22406]
void setGraphicVars(
array
$gvars, [boolean
$extended = false])
|
|
Set graphic variables.
Tags:
Parameters:
method setHeader [line 4098]
This method is used to render the page header.
Tags:
method setHeaderData [line 3899]
void setHeaderData(
[string
$ln = ''], [string
$lw = 0], [string
$ht = ''], [string
$hs = ''])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 11384]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 3928]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setHtmlLinksStyle [line 22004]
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 21973]
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 22614]
void setImageBuffer(
string
$image, array
$data)
|
|
Set image buffer content.
Tags:
Parameters:
method setImageScale [line 3096]
void setImageScale(
float
$scale)
|
|
Set the adjusting factor to convert pixels to user units.
Tags:
Parameters:
method setImageSubBuffer [line 22637]
void setImageSubBuffer(
string
$image, string
$key, array
$data)
|
|
Set image buffer content for a specified sub-key.
Tags:
Parameters:
method setJPEGQuality [line 15746]
void setJPEGQuality(
int
$quality)
|
|
Set the default JPEG compression quality (1-100)
Tags:
Parameters:
method SetKeywords [line 3575]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 11424]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 3066]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 3218]
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 12703]
string SetLineStyle(
array
$style, [boolean
$ret = false])
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 12660]
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 5069]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setListIndentWidth [line 21983]
void setListIndentWidth(
float
$width)
|
|
Set custom width for list indentation.
Tags:
Parameters:
method setLIsymbol [line 21889]
void setLIsymbol(
[string
$symbol = '!'])
|
|
Set the default bullet to be used as LI bullet symbol
Tags:
Parameters:
method SetMargins [line 3196]
void SetMargins(
float
$left, float
$top, [float
$right = -1], [boolean
$keepmargins = false])
|
|
Defines the left, top and right margins.
Tags:
Parameters:
method setOpenCell [line 21993]
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 3664]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageBoxes [line 2818]
void setPageBoxes(
int
$page, string
$type, float
$llx, float
$lly, float
$urx, float
$ury, [boolean
$points = false])
|
|
Set page boundaries.
Tags:
Parameters:
method setPageBuffer [line 22571]
void setPageBuffer(
int
$page, string
$data, [boolean
$append = false])
|
|
Set page buffer content.
Tags:
Parameters:
method setPageFormat [line 2700]
void setPageFormat(
mixed
$format, [string
$orientation = 'P'])
|
|
Change the format of the current page
Tags:
Parameters:
method setPageMark [line 3867]
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 2867]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageRegions [line 24337]
void setPageRegions(
[array
$regions = array()])
|
|
Set no-write regions on page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
Tags:
Parameters:
method setPageUnit [line 1940]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 15788]
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 3975]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 3966]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 12180]
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 23844]
void setRasterizeVectorImages(
boolean
$mode)
|
|
Enable/disable rasterization of vector images using ImageMagick library.
Tags:
Parameters:
method SetRightMargin [line 3248]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 2997]
void setRTL(
Boolean
$enable, [Boolean
$resetx = true])
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method setSignature [line 15425]
void setSignature(
[mixed
$signing_cert = ''], [mixed
$private_key = ''], [string
$private_key_password = ''], [string
$extracerts = ''], [int
$cert_type = 2], [array
$info = array()])
|
|
Enable document signature (requires the OpenSSL Library). The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
Tags:
Parameters:
method setSignatureAppearance [line 15461]
void setSignatureAppearance(
[float
$x = 0], [float
$y = 0], [float
$w = 0], [float
$h = 0], [int
$page = -1])
|
|
Set the digital signature appearance (a cliccable rectangle area to get signature properties)
Tags:
Parameters:
method setSpacesRE [line 2972]
void setSpacesRE(
[string
$re = '/[^\S\xa0]/'])
|
|
Set regular expression to detect withespaces or word separators. The pattern delimiter must be the forward-slash character '/'. Some example patterns are: Non-Unicode or missing PCRE unicode support: '/[^\S\xa0]/'
Unicode and PCRE unicode support: '/[^\S\P{Z}\xa0]/u'
Unicode and PCRE unicode support in Chinese mode: '/[^\S\P{Z}\P{Lo}\xa0]/u'
if PCRE unicode support is turned ON (\P is the negate class of \p):
\p{Z} or \p{Separator}: any kind of Unicode whitespace or invisible separator.
\p{Lo} or \p{Other_Letter}: a Unicode letter or ideograph that does not have lowercase and uppercase variants.
\p{Lo} is needed for Chinese characters because are packed next to each other without spaces in between.
Tags:
Parameters:
method SetSubject [line 3553]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setSVGStyles [line 24934]
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 4186]
This method is used to render the table header on new page (if any).
Tags:
method setTempRTL [line 3023]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 4495]
void SetTextColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1], [boolean
$ret = false], [string
$name = ''])
|
|
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 4469]
void SetTextColorArray(
array
$color, [boolean
$ret = false])
|
|
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 23626]
void setTextRenderingMode(
[int
$stroke = 0], [boolean
$fill = true], [boolean
$clip = false])
|
|
Set Text rendering mode.
Tags:
Parameters:
method SetTextSpotColor [line 4539]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 3542]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 3233]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 15389]
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'], [string
$ef = '/Create/Delete/Modify/Import'], [string
$formex = ''])
|
|
Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary
Tags:
Parameters:
method setViewerPreferences [line 15801]
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 15646]
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 7903]
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 7967]
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 7935]
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 7493]
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 12600]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 12573]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 12586]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 13343]
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 3821]
void startPage(
[string
$orientation = ''], [mixed
$format = ''], [
$tocpage = false])
|
|
Starts a new page to the document. The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
Tags:
Parameters:
method startPageGroup [line 15481]
void startPageGroup(
[int
$page = ''])
|
|
Create a new page group. NOTE: call this function before calling AddPage()
Tags:
Parameters:
method startSVGElementHandler [line 25562]
void startSVGElementHandler(
resource
$parser, string
$name, array
$attribs, [array
$ctm = array()])
|
|
Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
Tags:
Parameters:
method startTemplate [line 24064]
int startTemplate(
[int
$w = 0], [int
$h = 0])
|
|
Start a new XObject Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked. Note: X,Y coordinates will be reset to 0,0.
Tags:
Parameters:
method startTransaction [line 23371]
Stores a copy of the current TCPDF object used for undo operation.
Tags:
method StartTransform [line 12335]
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 12355]
Stops a 2D tranformation restoring previous graphic state. This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Tags:
method stringLeftTrim [line 23971]
left stringLeftTrim(
string
$str, [string
$replace = ''])
|
|
Left trim the input string
Tags:
Parameters:
method stringRightTrim [line 23984]
right stringRightTrim(
string
$str, [string
$replace = ''])
|
|
Right trim the input string
Tags:
Parameters:
method stringTrim [line 23997]
trimmed stringTrim(
string
$str, [string
$replace = ''])
|
|
Trim the input string
Tags:
Parameters:
method SVGPath [line 25214]
array SVGPath(
string
$d, [string
$style = ''])
|
|
Draws an SVG path
Tags:
Parameters:
method SVGTransform [line 24915]
void SVGTransform(
array
$tm)
|
|
Apply SVG graphic transformation matrix.
Tags:
Parameters:
method swapMargins [line 21949]
void swapMargins(
[boolean
$reverse = true])
|
|
Swap the left and right margins.
Tags:
Parameters:
method swapPageBoxCoordinates [line 2844]
void swapPageBoxCoordinates(
int
$page)
|
|
Swap X and Y coordinates of page boxes (change page boxes orientation).
Tags:
Parameters:
method Text [line 5238]
void Text(
float
$x, float
$y, string
$txt, [int
$fstroke = false], [boolean
$fclip = false], [boolean
$ffill = true], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [boolean
$fill = false], [mixed
$link = ''], [int
$stretch = 0], [boolean
$ignore_min_height = false], [string
$calign = 'T'], [string
$valign = 'M'], [boolean
$rtloff = false])
|
|
Prints a text cell at the specified position. This method allows to place a string precisely on the page.
Tags:
Parameters:
method TextField [line 14784]
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 12631]
void Transform(
array
$tm)
|
|
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 12521]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 12498]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 12509]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 11606]
string unhtmlentities(
string
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method UniArrSubString [line 6949]
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 6982]
Returns the unicode caracter specified by UTF-8 value
Tags:
Parameters:
method UTF8ArrayToUniArray [line 6970]
Return UTF8ArrayToUniArray(
string
$ta)
|
|
Convert an array of UTF8 values to array of unicode characters
Tags:
Parameters:
method UTF8ArrSubString [line 6926]
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 11293]
array UTF8ArrToLatin1(
array
$unicode)
|
|
Converts UTF-8 characters array to array of Latin1 characters
Tags:
Parameters:
method utf8Bidi [line 13565]
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 13551]
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 11129]
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 13536]
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 11264]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 11248]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 6544]
mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [boolean
$fill = false], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0], [boolean
$firstline = false], [boolean
$firstblock = false], [float
$maxh = 0], [float
$wadj = 0], [array
$margin = ''])
|
|
This method prints text from the current position.
Tags:
Parameters:
method write1DBarcode [line 16876]
void write1DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [float
$xres = ''], [array
$style = ''], [string
$align = ''])
|
|
Print a Linear Barcode.
Tags:
Parameters:
method write2DBarcode [line 17247]
void write2DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [array
$style = ''], [string
$align = ''], [boolean
$distort = false])
|
|
Print 2D Barcode.
Tags:
Parameters:
method writeBarcode [line 17182]
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 22481]
void writeDiskCache(
$filename, mixed
$data, [boolean
$append = false], string
$file)
|
|
Writes data to a temporary file on filesystem.
Tags:
Parameters:
method writeHTML [line 19055]
void writeHTML(
string
$html, [boolean
$ln = true], [boolean
$fill = false], [boolean
$reseth = false], [boolean
$cell = false], [string
$align = ''])
|
|
Allows to preserve some HTML formatting (limited support). IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
Tags:
Parameters:
method writeHTMLCell [line 19039]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [boolean
$fill = false], [boolean
$reseth = true], [string
$align = ''], [boolean
$autopadding = true])
|
|
Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
Tags:
Parameters:
method _addfield [line 14356]
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 11880]
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 10795]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _datastring [line 10976]
string _datastring(
string
$s, [int
$n = 0])
|
|
Format a data string for meta information
Tags:
Parameters:
method _datestring [line 10991]
string _datestring(
[int
$n = 0])
|
|
Returns a formatted date for meta information
Tags:
Parameters:
method _destroy [line 8186]
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 8214]
Check for locale-related bug
Tags:
method _dolinethrough [line 10902]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dolinethroughw [line 10915]
void _dolinethroughw(
int
$x, int
$y,
$w, string
$txt)
|
|
Line through for rectangular text area.
Tags:
Parameters:
method _dooverline [line 10928]
void _dooverline(
int
$x, int
$y, string
$txt)
|
|
Overline text.
Tags:
Parameters:
method _dooverlinew [line 10941]
void _dooverlinew(
int
$x, int
$y, int
$w)
|
|
Overline for rectangular text area.
Tags:
Parameters:
method _dounderline [line 10877]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _dounderlinew [line 10890]
void _dounderlinew(
int
$x, int
$y, int
$w)
|
|
Underline for rectangular text area.
Tags:
Parameters:
method _encrypt_data [line 11683]
encrypted _encrypt_data(
int
$n, string
$s)
|
|
Encrypt the input string.
Tags:
Parameters:
method _enddoc [line 10723]
Output end of document (EOF).
Tags:
method _endpage [line 10839]
method _escape [line 10964]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 11019]
string _escapetext(
string
$s)
|
|
THIS METHOD IS DEPRECATED Format a text string
Tags:
Parameters:
method _fixAES256Password [line 12006]
string _fixAES256Password(
$password)
|
|
Convert password for AES-256 encryption mode
Tags:
Parameters:
method _freadint [line 10953]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte (32 bit) integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 12021]
void _generateencryptionkey(
)
|
|
Compute encryption key
Tags:
method _getannotsrefs [line 8462]
string _getannotsrefs(
int
$n)
|
|
Get references to page annotations.
Tags:
Parameters:
method _getBYTE [line 9196]
int _getBYTE(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get BYTE from string (8-bit unsigned integer).
Tags:
Parameters:
method _getfontpath [line 8230]
method _getobj [line 10861]
string _getobj(
[int
$objid = ''])
|
|
Return the starting object string for the selected object ID.
Tags:
Parameters:
method _getrawstream [line 11039]
void _getrawstream(
string
$s, [int
$n = 0])
|
|
get raw output stream.
Tags:
Parameters:
method _getSHORT [line 9181]
int _getSHORT(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get SHORT from string (Big Endian 16-bit signed integer).
Tags:
Parameters:
method _getstream [line 11054]
void _getstream(
string
$s, [int
$n = 0])
|
|
Format output stream (DEPRECATED).
Tags:
Parameters:
method _getTrueTypeFontSubset [line 9211]
string _getTrueTypeFontSubset(
string
$font, array
$subsetchars)
|
|
Returns a subset of the TrueType font data without the unused glyphs.
Tags:
Parameters:
method _getTTFtableChecksum [line 9542]
int _getTTFtableChecksum(
string
$table, int
$length)
|
|
Returs the checksum of a TTF table.
Tags:
Parameters:
method _getULONG [line 9151]
int _getULONG(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get ULONG from string (Big Endian 32-bit unsigned integer).
Tags:
Parameters:
method _getUSHORT [line 9166]
int _getUSHORT(
&$str,
&$offset, string
$str, int
$offset)
|
|
Get USHORT from string (Big Endian 16-bit unsigned integer).
Tags:
Parameters:
method _getxobjectdict [line 10407]
string _getxobjectdict(
)
|
|
Return XObjects Dictionary.
Tags:
method _JScolor [line 14332]
void _JScolor(
string
$color)
|
|
Convert color to javascript color.
Tags:
Parameters:
method _md5_16 [line 11898]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 10849]
Begin a new object and return the object number.
Tags:
method _objectkey [line 11663]
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 _OEvalue [line 11993]
Compute OE value (used for encryption)
Tags:
method _out [line 11074]
Output a string to the document.
Tags:
Parameters:
method _outCurve [line 12808]
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 12822]
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 12838]
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 13037]
array _outellipticalarc(
float
$xc, float
$yc, float
$rx, float
$ry, [
$xang = 0], [
$angs = 0], [
$angf = 360], [boolean
$pie = false], [integer
$nc = 2], [boolean
$startpoint = true], [boolean
$ccw = true], 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 12778]
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 12766]
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 12792]
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 11955]
Compute O value (used for encryption)
Tags:
method _parsejpeg [line 7591]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 7617]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannotsobjs [line 8498]
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 8450]
void _putannotsrefs(
int
$n)
|
|
Output references to page annotations
Tags:
Parameters:
method _putAPXObject [line 9110]
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 14169]
Create a bookmark PDF string.
Tags:
method _putcatalog [line 10548]
method _putcidfont0 [line 10206]
void _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 5197]
void _putEmbeddedFiles(
)
|
|
Embedd the attached files.
Tags:
method _putencryption [line 11711]
Put encryption on PDF document.
Tags:
method _putextgstates [line 15711]
void _putextgstates(
array
$gs)
|
|
Put extgstates for object transparency
Tags:
Parameters:
method _putfonts [line 9663]
method _putfontwidths [line 9564]
PDF _putfontwidths(
array
$font, [int
$cidoffset = 0])
|
|
Outputs font widths
Tags:
Parameters:
method _putheader [line 10715]
method _putimages [line 10276]
method _putinfo [line 10499]
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Tags:
method _putjavascript [line 14278]
Create a javascript PDF string.
Tags:
method _putocg [line 15631]
Put visibility settings.
Tags:
method _putpages [line 8241]
method _putresourcedict [line 10419]
Output Resources Dictionary.
Tags:
method _putresources [line 10477]
method _putshaders [line 16265]
Output gradient shaders.
Tags:
method _putsignature [line 15304]
Add certification signature (DocMDP or UR3) You can set only one signature type
Tags:
method _putspotcolors [line 10387]
Output Spot Colors Resources.
Tags:
method _putstream [line 11065]
void _putstream(
string
$s, [int
$n = 0])
|
|
Output a stream (DEPRECATED).
Tags:
Parameters:
method _puttruetypeunicode [line 9819]
void _puttruetypeunicode(
array
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putviewerpreferences [line 10644]
string _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _putxobjects [line 10335]
Output Form XObjects Templates.
Tags:
method _RC4 [line 11834]
String _RC4(
string
$key, String
$text)
|
|
Returns the input text encrypted using RC4 algorithm and the specified key. RC4 is the standard encryption algorithm used in PDF format
Tags:
Parameters:
method _setGDImageTransparency [line 7570]
void _setGDImageTransparency(
image
$new_image, image
$image)
|
|
Set the transparency for the given GD image.
Tags:
Parameters:
method _textstring [line 11003]
string _textstring(
string
$s, [int
$n = 0])
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 7527]
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 7546]
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 _UEvalue [line 11942]
Compute UE value (used for encryption)
Tags:
method _Uvalue [line 11909]
Compute U value (used for encryption)
Tags:
|
|