Class: TCPDF
Source Location: /tcpdf.php
This is a PHP class for generating PDF documents without requiring external extensions.
Author(s):
- Nicola Asuni - info@tecnick.com
Version:
|
|
|
Class Details
Class Variables
$AliasNbPages =
[line 511]
Tags:
$author =
[line 493]
Tags:
$AutoPageBreak =
[line 451]
Tags:
$barcode = false
[line 603]
Tags:
$bgcolor =
[line 696]
Tags:
$bMargin =
[line 287]
Tags:
$buffer =
[line 191]
Tags:
$cell_height_ratio = K_CELL_HEIGHT_RATIO
[line 947]
Default cell height ratio.
Tags:
$cMargin =
[line 293]
Tags:
$ColorFlag =
[line 439]
Tags:
$compress =
[line 209]
Tags:
$CoreFonts =
[line 329]
Tags:
$creator =
[line 505]
Tags:
$CurOrientation =
[line 215]
Tags:
$CurrentFont =
[line 403]
Tags:
$currpagegroup =
[line 905]
Contains the alias of the current page group
Tags:
$default_table_columns = 4
[line 645]
Tags:
$diffs = array()
[line 347]
Tags:
$dpi = 72
[line 884]
Dot Per Inch Document Resolution (do not change)
Tags:
$DrawColor =
[line 421]
Tags:
$encoding = "UTF-8"
[line 715]
Tags:
$encrypted =
[line 745]
Indicates whether document is protected
Tags:
$encryption_key =
[line 799]
RC4 encryption key
Tags:
$enc_obj_id =
[line 773]
encryption object id
Tags:
$endlinex = 0
[line 1005]
End position of the latest inserted line
Tags:
$epsmarker = "#!#EPS#!#"
[line 1068]
String used to mark the beginning and end of EPS image blocks
Tags:
$extgstates =
[line 933]
Array of transparency objects and parameters.
Tags:
$fgcolor =
[line 666]
Tags:
$fhPt =
[line 239]
Tags:
$FillColor =
[line 427]
Tags:
$FontAscent =
[line 384]
Tags:
$FontDescent =
[line 391]
Tags:
$FontFamily =
[line 371]
Tags:
$FontFiles = array()
[line 341]
Tags:
$fontlist = array()
[line 660]
Tags:
$fonts = array()
[line 335]
Tags:
$FontSize =
[line 415]
Tags:
$FontSizePt =
[line 409]
Tags:
$FontStyle =
[line 377]
Tags:
$footerlen = array()
[line 991]
Array used to store footer lenght of each page.
Tags:
$footerpos = array()
[line 983]
Array used to store footer positions of each page.
Tags:
$footer_font =
[line 591]
Tags:
$footer_margin =
[line 565]
Tags:
$fwPt =
[line 233]
Tags:
$gradients = array()
[line 968]
Array for storing gradient information.
Tags:
$h =
[line 263]
Tags:
$header_font =
[line 585]
Tags:
$header_logo = ""
[line 621]
Tags:
$header_logo_width = 30
[line 627]
Tags:
$header_margin =
[line 559]
Tags:
$header_string = ""
[line 639]
Tags:
$header_title = ""
[line 633]
Tags:
$hPt =
[line 251]
Tags:
$HREF =
[line 654]
Tags:
$htmlvspace = 0
[line 1047]
Count the latest inserted vertical spaces on HTML.
Tags:
$images = array()
[line 353]
Tags:
$imgscale = 1
[line 535]
Tags:
$img_rb_x =
[line 519]
Tags:
$img_rb_y =
[line 527]
Tags:
$InFooter =
[line 463]
Tags:
$internal_encoding =
[line 722]
Tags:
$intmrk = array()
[line 976]
Array used to store positions inside the pages buffer. keys are the page numbers
Tags:
$isunicode = false
[line 543]
Tags:
$javascript = ""
[line 825]
javascript code
Tags:
$jpeg_quality =
[line 940]
Set the default JPEG compression quality (1-100)
Tags:
$k =
[line 227]
Tags:
$keywords =
[line 499]
Tags:
$l =
[line 597]
Tags:
$lasth =
[line 317]
Tags:
$last_rc4_key =
[line 780]
last RC4 key encrypted (cached for optimisation)
Tags:
$last_rc4_key_c =
[line 787]
last RC4 computed key
Tags:
$LayoutMode =
[line 475]
Tags:
$linestyleCap = "0 J"
[line 1019]
PDF string for last line width
Tags:
$linestyleDash = "[] 0 d"
[line 1033]
PDF string for last line width
Tags:
$linestyleJoin = "0 j"
[line 1026]
PDF string for last line width
Tags:
$linestyleWidth = ""
[line 1012]
PDF string for last line width
Tags:
$linethrough =
[line 839]
line trough state
Tags:
$LineWidth =
[line 323]
Tags:
$links = array()
[line 365]
Tags:
$lispacer = ""
[line 708]
Tags:
$listcount = array()
[line 678]
Tags:
$listindent =
[line 690]
Tags:
$listnum = 0
[line 684]
Tags:
$listordered = array()
[line 672]
Tags:
$lisymbol = "-"
[line 1061]
Symbol used for HTML unordered list items
Tags:
$lMargin =
[line 269]
Tags:
$n =
[line 179]
Tags:
$newline = true
[line 998]
True if a newline is created.
Tags:
$newpagegroup =
[line 891]
Indicates whether a new page group was requested
Tags:
$n_js =
[line 832]
javascript counter
Tags:
$n_ocg_print =
[line 919]
Print visibility.
Tags:
$n_ocg_view =
[line 926]
View visibility.
Tags:
$offsets =
[line 185]
Tags:
$oldcMargin =
[line 299]
Tags:
$openMarkedContent = false
[line 1040]
True if marked-content sequence is open
Tags:
$original_lMargin =
[line 572]
Tags:
$original_rMargin =
[line 579]
Tags:
$OutlineRoot =
[line 815]
Outline root for bookmark
Tags:
$outlines = array()
[line 808]
Outlines for bookmark
Tags:
$Ovalue =
[line 759]
O entry in pdf document
Tags:
$padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A"
[line 793]
RC4 padding
Tags:
$page =
[line 173]
Tags:
$PageAnnots = array()
[line 359]
Tags:
$PageBreakTrigger =
[line 457]
Tags:
$pagedim = array()
[line 221]
Tags:
$pagegroups =
[line 898]
Contains the number of pages of the groups
Tags:
$PageMode =
[line 961]
A name object specifying how the document should be displayed when opened.
Tags:
$pages = array()
[line 197]
Tags:
$PDFVersion = "1.7"
[line 550]
Tags:
$print_footer = true
[line 615]
Tags:
$print_header = true
[line 609]
Tags:
$Pvalue =
[line 766]
P entry in pdf document
Tags:
$rMargin =
[line 281]
Tags:
$rtl = false
[line 729]
Tags:
$spot_colors = array()
[line 1054]
Array of Spot colors
Tags:
$state =
[line 203]
Tags:
$subject =
[line 487]
Tags:
$tempfontsize = 10
[line 702]
Tags:
$TextColor =
[line 433]
Tags:
$title =
[line 481]
Tags:
$tMargin =
[line 275]
Tags:
$tmprtl = false
[line 736]
Tags:
$underline =
[line 397]
Tags:
$ur =
[line 849]
If true enables user's rights on PDF reader
Tags:
$ur_annots =
[line 863]
Names specifying additional annotation-related usage rights for the document.
Tags:
$ur_document =
[line 856]
Names specifying additional document-wide usage rights for the document.
Tags:
$ur_form =
[line 870]
Names specifying additional form-field-related usage rights for the document.
Tags:
$ur_signature =
[line 877]
Names specifying additional signature-related usage rights for the document.
Tags:
$Uvalue =
[line 752]
U entry in pdf document
Tags:
$viewer_preferences =
[line 954]
PDF viewer preferences.
Tags:
$visibility = "all"
[line 912]
Restrict the rendering of some elements to screen or printout.
Tags:
$w =
[line 257]
Tags:
$wPt =
[line 245]
Tags:
$ws =
[line 445]
Tags:
$x =
[line 305]
Tags:
$y =
[line 311]
Tags:
$ZoomMode =
[line 469]
Tags:
Class Methods
constructor __construct [line 1085]
TCPDF __construct(
[string
$orientation = 'P'], [string
$unit = 'mm'], [mixed
$format = 'A4'], [boolean
$unicode = true], [String
$encoding = "UTF-8"])
|
|
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 1188]
Default destructor.
Tags:
method AcceptPageBreak [line 2790]
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 8030]
void addExtGState(
$parms)
|
|
Tags:
Parameters:
method AddFont [line 2520]
array AddFont(
string
$family, [string
$style = ''], [string
$file = ''])
|
|
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. Changed to support UTF-8 Unicode [Nicola Asuni, 2005-01-02].
Tags:
Parameters:
method addHtmlLink [line 5620]
the addHtmlLink(
string
$url, string
$name, [int
$fill = 0], [boolean
$firstline = false])
|
|
Output anchor link.
Tags:
Parameters:
method addHTMLVertSpace [line 10523]
void addHTMLVertSpace(
int
$n, [boolean
$cell = false], [string
$h = ''])
|
|
Add vertical spaces if needed.
Tags:
Parameters:
method AddLink [line 2686]
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 1827]
void AddPage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header. The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
Tags:
Parameters:
method AddSpotColor [line 2166]
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 AliasNbPages [line 1697]
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 Annotation [line 2737]
void Annotation(
float
$x, float
$y, float
$w, float
$h, string
$text, [array
$opt = array('Subtype'=>'Text')])
|
|
Puts a text annotation on a rectangular area of the page. !!!! THIS FUNCTION IS NOT YET FULLY IMPLEMENTED !!!!
Tags:
Parameters:
method arrUTF8ToUTF16BE [line 5530]
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 7572]
void Bookmark(
$txt, [
$level = 0], [
$y = -1])
|
|
Tags:
Parameters:
method Button [line 7844]
void Button(
$name,
$w,
$h,
$caption,
$action, [
$prop = array()])
|
|
Tags:
Parameters:
method Cell [line 2837]
void Cell(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0])
|
|
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 7824]
void CheckBox(
$name,
$w, [
$checked = false], [
$prop = array()])
|
|
Tags:
Parameters:
method checkPageBreak [line 2800]
void checkPageBreak(
float
$h)
|
|
Add page if needed.
Tags:
Parameters:
method Circle [line 6681]
void Circle(
float
$x0, float
$y0, float
$r, [
$astart = 0], [
$afinish = 360], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$astart:, float
$afinish:)
|
|
Draws a circle. A circle is formed from n Bezier curves.
Tags:
Parameters:
method Clip [line 8290]
void Clip(
float
$x, float
$y, float
$w, float
$h)
|
|
Set a rectangular clipping area.
Tags:
Parameters:
method Close [line 1743]
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 10304]
void closeHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process closing tags.
Tags:
Parameters:
method ComboBox [line 7805]
void ComboBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method convertHTMLColorToDec [line 5643]
array convertHTMLColorToDec(
[string
$color = "#000000"])
|
|
Returns an associative array (keys: R,G,B) from an html color name or a six-digit or three-digit hexadecimal color representation (i.e. #3FE5AA or #7FF).
Tags:
Parameters:
method CoonsPatchMesh [line 8213]
void CoonsPatchMesh(
float
$x, float
$y, float
$w, float
$h, [array
$col1 = array()], [array
$col2 = array()], [array
$col3 = array()], [array
$col4 = array()], [array
$coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33)], [array
$coords_min = 0], [array
$coords_max = 1])
|
|
Paints a coons patch mesh.
Tags:
Parameters:
method Curve [line 6456]
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 Ellipse [line 6577]
void Ellipse(
float
$x0, float
$y0, float
$rx, [float
$ry = 0], [
$angle = 0], [
$astart = 0], [
$afinish = 360], [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()], [integer
$nc = 8], float
$angle:, float
$astart:, float
$afinish:)
|
|
Draws an ellipse. An ellipse is formed from n Bezier curves.
Tags:
Parameters:
method Error [line 1722]
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid. 2004-06-11 :: Nicola Asuni : changed bold tag with strong
Tags:
Parameters:
method Footer [line 2052]
This method is used to render the page footer. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags:
method GetAbsX [line 3864]
Returns the absolute X value of current position.
Tags:
method getAliasNbPages [line 1709]
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 GetArrStringWidth [line 2434]
int GetArrStringWidth(
$sa, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0], string
$arr)
|
|
Returns the string length of an array of chars in user unit. A font must be selected.
Tags:
Parameters:
method getBarcode [line 8740]
Get current barcode.
Tags:
method getBreakMargin [line 1446]
Returns the page break margin.
Tags:
method getCellCode [line 2862]
void getCellCode(
float
$w, [float
$h = 0], [string
$txt = ''], [mixed
$border = 0], [int
$ln = 0], [string
$align = ''], [int
$fill = 0], [mixed
$link = ''], [int
$stretch = 0])
|
|
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 8116]
void getCellHeightRatio(
)
|
|
Tags:
method GetCharWidth [line 2460]
int GetCharWidth(
int
$char)
|
|
Returns the length of the char in user unit for the current font.
Tags:
Parameters:
method getFontSize [line 9065]
Returns the current font size.
Tags:
method getFontSizePt [line 9074]
Returns the current font size in points unit.
Tags:
method getFontsList [line 2498]
Fill the list of available fonts ($this->fontlist).
Tags:
method getFooterFont [line 5587]
method getFooterMargin [line 1972]
Returns footer margin in user units.
Tags:
method getGroupPageNo [line 7949]
method getHeaderData [line 1931]
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 5569]
method getHeaderMargin [line 1954]
Returns header margin in user units.
Tags:
method getHtmlDomArray [line 9107]
array getHtmlDomArray(
string
$html)
|
|
Returns the HTML DOM array. - $dom[$key]['tag'] = true if tag, false otherwise;
- $dom[$key]['value'] = tag name or text;
- $dom[$key]['opening'] = true if opening tag, false otherwise;
- $dom[$key]['attribute'] = array of attributes (attribute name is the key);
- $dom[$key]['style'] = array of style attributes (attribute name is the key);
- $dom[$key]['parent'] = id of parent element;
- $dom[$key]['fontname'] = font family name;
- $dom[$key]['fontstyle'] = font style;
- $dom[$key]['fontsize'] = font size in points;
- $dom[$key]['bgcolor'] = RGB array of background color;
- $dom[$key]['fgcolor'] = RGB array of foreground color;
- $dom[$key]['width'] = width in pixels;
- $dom[$key]['height'] = height in pixels;
- $dom[$key]['align'] = text alignment;
- $dom[$key]['cols'] = number of colums in table;
- $dom[$key]['rows'] = number of rows in table;
Tags:
Parameters:
method getImageRBX [line 1995]
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
Tags:
method getImageRBY [line 2003]
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
Tags:
method getImageScale [line 1416]
Returns the image scale.
Tags:
method getLastH [line 1396]
Get the last cell height.
Tags:
method GetLineWidth [line 6175]
Returns the current the line width.
Tags:
method getMargins [line 9030]
Returns an array containing current margins:
Tags:
method GetNumChars [line 2486]
int GetNumChars(
string
$s)
|
|
Returns the numbero of characters in a string.
Tags:
Parameters:
method getNumPages [line 1814]
Get the total number of insered pages.
Tags:
method getOriginalMargins [line 9052]
array getOriginalMargins(
)
|
|
Returns an array containing original margins:
Tags:
method getPage [line 1803]
Get current document page number.
Tags:
method getPageGroupAlias [line 7961]
void getPageGroupAlias(
)
|
|
Tags:
method getPageHeight [line 1436]
Returns the page height in units.
Tags:
method getPageWidth [line 1426]
Returns the page width in units.
Tags:
method getPDFData [line 5604]
Returns the PDF data.
Tags:
method getRemainingWidth [line 3449]
Returns the remaining width between the current position and margins.
Tags:
method getRTL [line 1362]
Return the RTL status
Tags:
method getScaleFactor [line 1456]
Returns the scale factor (number of points in user unit).
Tags:
method GetStringWidth [line 2420]
int GetStringWidth(
string
$s, [string
$fontname = ''], [string
$fontstyle = ''], [float
$fontsize = 0])
|
|
Returns the length of a string in user unit. A font must be selected.
Tags:
Parameters:
method GetX [line 3849]
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 3874]
Returns the ordinate of the current position.
Tags:
method Gradient [line 8313]
void Gradient(
int
$type, array
$col1, array
$col2, array
$coords)
|
|
Output gradient.
Tags:
Parameters:
method Header [line 2011]
This method is used to render the page header. It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags:
method Image [line 3530]
void Image(
string
$file, float
$x, float
$y, [float
$w = 0], [float
$h = 0], [string
$type = ''], [mixed
$link = ''], [string
$align = ''], [boolean
$resize = false], [int
$dpi = 300], [string
$palign = ''])
|
|
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 8484]
void ImageEps(
string
$file, float
$x, float
$y, [float
$w = 0], [float
$h = 0], [mixed
$link = ''], [boolean
$useBoundingBox = true], [string
$align = ''], [string
$palign = ''])
|
|
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
Tags:
Parameters:
method IncludeJS [line 7661]
method lastPage [line 1793]
Reset pointer to the last document page.
Tags:
method Line [line 6325]
void Line(
float
$x1, float
$y1, float
$x2, float
$y2, [array
$style = array()])
|
|
Draws a line between two points.
Tags:
Parameters:
method LinearGradient [line 8173]
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 2722]
void Link(
float
$x, float
$y, float
$w, float
$h, mixed
$link)
|
|
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 7782]
void ListBox(
$name,
$w,
$h,
$values, [
$prop = array()])
|
|
Tags:
Parameters:
method Ln [line 3822]
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 5969]
void MirrorH(
[int
$x = ''])
|
|
Horizontal Mirroring.
Tags:
Parameters:
method MirrorL [line 6002]
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 5990]
void MirrorP(
[int
$x = ''], [int
$y = ''])
|
|
Point reflection mirroring.
Tags:
Parameters:
method MirrorV [line 5979]
void MirrorV(
[int
$y = ''])
|
|
Verical Mirroring.
Tags:
Parameters:
method MultiCell [line 3091]
int MultiCell(
float
$w, float
$h, string
$txt, [mixed
$border = 0], [string
$align = 'J'], [int
$fill = 0], [int
$ln = 1], [int
$x = ''], [int
$y = ''], [boolean
$reseth = true], [int
$stretch = 0], [boolean
$ishtml = 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 Open [line 1733]
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 10081]
void openHTMLTagHandler(
&$dom, int
$key, [boolean
$cell = false], array
$dom)
|
|
Process opening tags.
Tags:
Parameters:
method Output [line 3962]
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 2151]
Returns the current page number.
Tags:
method PieSector [line 8407]
void PieSector(
float
$xc, float
$yc, float
$r, float
$a, float
$b, [
$style = 'FD'], [
$cw = true], [
$o = 90], string
$style:, float
$cw:, float
$o:)
|
|
Draw the sector of a circle. It can be used for instance to render pie charts.
Tags:
Parameters:
method pixelsToUnits [line 5695]
float pixelsToUnits(
int
$px)
|
|
Converts pixels to Units.
Tags:
Parameters:
method Polycurve [line 6513]
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 6706]
void Polygon(
array
$p, [string
$style = ""], [array
$line_style = array()], [array
$fill_color = array()])
|
|
Draws a polygon.
Tags:
Parameters:
method RadialGradient [line 8191]
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 7764]
void RadioButton(
$name,
$w, [
$prop = array()])
|
|
Tags:
Parameters:
method Rect [line 6360]
void Rect(
float
$x, float
$y, float
$w, float
$h, [string
$style = ''], [array
$border_style = array()], [array
$fill_color = array()])
|
|
Draws a rectangle.
Tags:
Parameters:
method RegularPolygon [line 6805]
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 Rotate [line 6057]
void Rotate(
float
$angle, [int
$x = ''], [int
$y = ''])
|
|
Rotate object.
Tags:
Parameters:
method RoundedRect [line 6909]
void RoundedRect(
float
$x, float
$y, float
$w, float
$h, float
$r, [string
$round_corner = "1111"], [string
$style = ""], [array
$border_style = array()], [array
$fill_color = array()])
|
|
Draws a rounded rectangle.
Tags:
Parameters:
method Scale [line 5935]
void Scale(
float
$s_x, float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal non-proportional Scaling.
Tags:
Parameters:
method ScaleX [line 5898]
void ScaleX(
float
$s_x, [int
$x = ''], [int
$y = ''])
|
|
Horizontal Scaling.
Tags:
Parameters:
method ScaleXY [line 5922]
void ScaleXY(
float
$s, [int
$x = ''], [int
$y = ''])
|
|
Vertical and horizontal proportional Scaling.
Tags:
Parameters:
method ScaleY [line 5910]
void ScaleY(
float
$s_y, [int
$x = ''], [int
$y = ''])
|
|
Vertical Scaling.
Tags:
Parameters:
method setAlpha [line 8073]
void setAlpha(
$alpha, [
$bm = 'Normal'])
|
|
Tags:
Parameters:
method SetAuthor [line 1664]
void SetAuthor(
string
$author)
|
|
Defines the author of the document.
Tags:
Parameters:
method SetAutoPageBreak [line 1536]
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 8731]
void setBarcode(
[string
$bc = ""])
|
|
Set document barcode.
Tags:
Parameters:
method setCellHeightRatio [line 8107]
void setCellHeightRatio(
$h)
|
|
Tags:
Parameters:
method SetCellPadding [line 1525]
void SetCellPadding(
float
$pad)
|
|
Set the internal Cell padding.
Tags:
Parameters:
method SetCompression [line 1627]
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 SetCreator [line 1686]
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 setDefaultTableColumns [line 8097]
void setDefaultTableColumns(
[
$cols = 4])
|
|
Tags:
Parameters:
method SetDisplayMode [line 1550]
void SetDisplayMode(
mixed
$zoom, [string
$layout = "SinglePage"], [string
$mode = "UseNone"])
|
|
Defines the way the document is to be displayed by the viewer.
Tags:
Parameters:
method SetDrawColor [line 2203]
void SetDrawColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])
|
|
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetDrawColorArray [line 2181]
void SetDrawColorArray(
array
$color)
|
|
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetDrawSpotColor [line 2240]
void SetDrawSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
Tags:
Parameters:
method setExtGState [line 8042]
method SetFillColor [line 2280]
void SetFillColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])
|
|
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetFillColorArray [line 2258]
void SetFillColorArray(
array
$color)
|
|
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetFillSpotColor [line 2321]
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 2642]
void SetFont(
string
$family, [string
$style = ''], [float
$size = 0])
|
|
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 SetFontSize [line 2661]
void SetFontSize(
float
$size)
|
|
Defines the size of the current font.
Tags:
Parameters:
method setFooter [line 2113]
This method is used to render the page footer.
Tags:
method setFooterFont [line 5578]
void setFooterFont(
array
$font)
|
|
Set footer font.
Tags:
Parameters:
method setFooterMargin [line 1963]
void setFooterMargin(
[int
$fm = 10])
|
|
Set footer margin. (minimum distance between footer and bottom page margin)
Tags:
Parameters:
method setHeader [line 2083]
This method is used to render the page header.
Tags:
method setHeaderData [line 1918]
void setHeaderData(
[string
$ln = ""], [string
$lw = 0], [string
$ht = ""], [string
$hs = ""])
|
|
Set header data.
Tags:
Parameters:
method setHeaderFont [line 5560]
void setHeaderFont(
array
$font)
|
|
Set header font.
Tags:
Parameters:
method setHeaderMargin [line 1945]
void setHeaderMargin(
[int
$hm = 10])
|
|
Set header margin. (minimum distance between header and top page margin)
Tags:
Parameters:
method setImageScale [line 1406]
void setImageScale(
float
$scale)
|
|
Set the image scale.
Tags:
Parameters:
method setJPEGQuality [line 8084]
void setJPEGQuality(
$quality)
|
|
Tags:
Parameters:
method SetKeywords [line 1675]
void SetKeywords(
string
$keywords)
|
|
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
Tags:
Parameters:
method setLanguageArray [line 5596]
void setLanguageArray(
array
$language)
|
|
Set language array.
Tags:
Parameters:
method setLastH [line 1387]
Set the last cell height.
Tags:
Parameters:
method SetLeftMargin [line 1484]
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 6200]
void SetLineStyle(
array
$style)
|
|
Set line style.
Tags:
Parameters:
method SetLineWidth [line 6162]
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 2701]
void SetLink(
int
$link, [float
$y = 0], [int
$page = -1])
|
|
Defines the page and position a link points to.
Tags:
Parameters:
method setLIsymbol [line 10541]
void setLIsymbol(
[string
$symbol = '-'])
|
|
Set the character or string to be used as LI item symbol on UL lists.
Tags:
Parameters:
method SetMargins [line 1468]
void SetMargins(
float
$left, float
$top, [float
$right = -1])
|
|
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
Tags:
Parameters:
method setPage [line 1766]
void setPage(
int
$pnum, [boolean
$resetmargins = false])
|
|
Move pointer at the specified document page and update page dimensions.
Tags:
Parameters:
method setPageFormat [line 1240]
void setPageFormat(
mixed
$format, [string
$orientation = "P"])
|
|
Set the page format
Tags:
Parameters:
method setPageMark [line 1907]
Set start-writing mark on current page for multicell borders and fills. This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
Tags:
method setPageOrientation [line 1312]
void setPageOrientation(
string
$orientation, [boolean
$autopagebreak = ''], [float
$bottommargin = ''])
|
|
Set page orientation.
Tags:
Parameters:
method setPageUnit [line 1200]
void setPageUnit(
string
$unit)
|
|
Set the units of measure for the document.
Tags:
Parameters:
method setPDFVersion [line 8126]
void setPDFVersion(
[
$version = "1.7"])
|
|
Tags:
Parameters:
method setPrintFooter [line 1987]
void setPrintFooter(
[
$val = true], boolean
$value)
|
|
Set a flag to print page footer.
Tags:
Parameters:
method setPrintHeader [line 1979]
void setPrintHeader(
[boolean
$val = true])
|
|
Set a flag to print page header.
Tags:
Parameters:
method SetProtection [line 5848]
void SetProtection(
[Array
$permissions = array()], [String
$user_pass = ''], [String
$owner_pass = null])
|
|
Set document protection The permission array is composed of values taken from the following ones: - copy: copy text and images to the clipboard
- print: print the document
- modify: modify it (except for annotations and forms)
- annot-forms: add annotations and forms
Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
Tags:
Parameters:
method SetRightMargin [line 1512]
void SetRightMargin(
float
$margin)
|
|
Defines the right margin. The method can be called before creating the first page.
Tags:
Parameters:
method setRTL [line 1352]
void setRTL(
Boolean
$enable)
|
|
Enable or disable Right-To-Left language mode
Tags:
Parameters:
method SetSubject [line 1653]
void SetSubject(
string
$subject)
|
|
Defines the subject of the document.
Tags:
Parameters:
method setTempRTL [line 1371]
void setTempRTL(
mixed
$mode)
|
|
Force temporary RTL language direction
Tags:
Parameters:
method SetTextColor [line 2361]
void SetTextColor(
[int
$col1 = 0], [int
$col2 = -1], [int
$col3 = -1], [int
$col4 = -1])
|
|
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetTextColorArray [line 2339]
void SetTextColorArray(
array
$color)
|
|
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
Tags:
Parameters:
method SetTextSpotColor [line 2399]
void SetTextSpotColor(
string
$name, [int
$tint = 100])
|
|
Defines the spot color used for text.
Tags:
Parameters:
method SetTitle [line 1642]
void SetTitle(
string
$title)
|
|
Defines the title of the document.
Tags:
Parameters:
method SetTopMargin [line 1498]
void SetTopMargin(
float
$margin)
|
|
Defines the top margin. The method can be called before creating the first page.
Tags:
Parameters:
method setUserRights [line 7920]
void setUserRights(
[
$enable = true], [
$document = "/FullSave"], [
$annots = "/Create/Delete/Modify/Copy/Import/Export"], [
$form = "/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate"], [
$signature = "/Modify"])
|
|
Tags:
Parameters:
method setViewerPreferences [line 8156]
void setViewerPreferences(
$preferences)
|
|
Tags:
Parameters:
method setVisibility [line 7994]
method SetX [line 3886]
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 3947]
void SetXY(
float
$x, float
$y)
|
|
Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.
Tags:
Parameters:
method SetY [line 3917]
void SetY(
float
$y, [bool
$resetx = true])
|
|
Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.
Tags:
Parameters:
method Skew [line 6114]
void Skew(
float
$angle_x, float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew.
Tags:
Parameters:
method SkewX [line 6089]
void SkewX(
float
$angle_x, [int
$x = ''], [int
$y = ''])
|
|
Skew horizontally.
Tags:
Parameters:
method SkewY [line 6101]
void SkewY(
float
$angle_y, [int
$x = ''], [int
$y = ''])
|
|
Skew vertically.
Tags:
Parameters:
method StarPolygon [line 6860]
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 startPageGroup [line 7939]
method StartTransform [line 5876]
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 5887]
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 Text [line 2751]
void Text(
float
$x, float
$y, string
$txt, [int
$stroke = 0], [boolean
$clip = false])
|
|
Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.
Tags:
Parameters:
method TextField [line 7751]
void TextField(
$name,
$w,
$h, [
$prop = array()])
|
|
Tags:
Parameters:
method Transform [line 6146]
Apply graphic transformations.
Tags:
Parameters:
method Translate [line 6034]
void Translate(
int
$t_x, int
$t_y)
|
|
Translate graphic object horizontally and vertically.
Tags:
Parameters:
method TranslateX [line 6013]
void TranslateX(
int
$t_x)
|
|
Translate graphic object horizontally.
Tags:
Parameters:
method TranslateY [line 6023]
void TranslateY(
int
$t_y)
|
|
Translate graphic object vertically.
Tags:
Parameters:
method unhtmlentities [line 5705]
string unhtmlentities(
$text_to_convert
$text_to_convert)
|
|
Reverse function for htmlentities. Convert entities in UTF-8.
Tags:
Parameters:
method unichr [line 3485]
Returns the unicode caracter specified by UTF-8 code
Tags:
Parameters:
method UTF8ArrSubString [line 3464]
Return UTF8ArrSubString(
string
$strarr, [int
$start = ''], [int
$end = ''])
|
|
Extract a slice of the $strarr array and return it as string.
Tags:
Parameters:
method utf8Bidi [line 7005]
string utf8Bidi(
array
$ta, [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8StringToArray [line 5377]
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 6993]
string utf8StrRev(
string
$str, [
$setbom = false], [bool
$forcertl = false])
|
|
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Tags:
Parameters:
method UTF8ToLatin1 [line 5470]
string UTF8ToLatin1(
string
$str)
|
|
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Tags:
Parameters:
method UTF8ToUTF16BE [line 5454]
string UTF8ToUTF16BE(
string
$str, [boolean
$setbom = true])
|
|
Converts UTF-8 strings to UTF16-BE.
Tags:
Parameters:
method Write [line 3229]
mixed Write(
float
$h, string
$txt, [mixed
$link = ''], [int
$fill = 0], [string
$align = ''], [boolean
$ln = false], [int
$stretch = 0], [boolean
$firstline = false])
|
|
This method prints text from the current position.
Tags:
Parameters:
method write1DBarcode [line 8759]
void write1DBarcode(
string
$code, string
$type, [int
$x = ''], [int
$y = ''], [int
$w = ''], [int
$h = ''], [float
$xres = 0.4], [array
$style = ''], [string
$align = ''])
|
|
Print Barcode.
Tags:
Parameters:
method writeBarcode [line 8980]
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 writeHTML [line 9428]
void writeHTML(
string
$html, [boolean
$ln = true], [int
$fill = false], [boolean
$reseth = false], [boolean
$cell = false], [string
$align = ''])
|
|
Allows to preserve some HTML formatting (limited support). IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, small, span, strong, sub, sup, table, td, th, tr, u, ul,
Tags:
Parameters:
method writeHTMLCell [line 9096]
void writeHTMLCell(
float
$w, float
$h, float
$x, float
$y, [string
$html = ''], [mixed
$border = 0], [int
$ln = 0], [int
$fill = 0], [boolean
$reseth = true], [string
$align = ''])
|
|
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 7723]
void _addfield(
$type,
$name,
$x,
$y,
$w,
$h,
$prop)
|
|
Tags:
Parameters:
method _beginpage [line 5046]
void _beginpage(
[string
$orientation = ''], [mixed
$format = ''])
|
|
Initialize a new page.
Tags:
Parameters:
method _datestring [line 4859]
string _datestring(
string
$s)
|
|
Format a date string for meta information
Tags:
Parameters:
method _dochecks [line 4048]
Check for locale-related bug
Tags:
method _dolinethrough [line 5120]
void _dolinethrough(
int
$x, int
$y, string
$txt)
|
|
Line through text.
Tags:
Parameters:
method _dounderline [line 5106]
void _dounderline(
int
$x, int
$y, string
$txt)
|
|
Underline text.
Tags:
Parameters:
method _enddoc [line 5005]
Output end of document (EOF).
Tags:
method _endpage [line 5084]
method _escape [line 5196]
string _escape(
string
$s)
|
|
Add "\" before "\", "(" and ")"
Tags:
Parameters:
method _escapetext [line 5178]
string _escapetext(
string
$s)
|
|
Format a text string
Tags:
Parameters:
method _freadint [line 5133]
4-byte _freadint(
string
$f)
|
|
Read a 4-byte integer from file.
Tags:
Parameters:
method _generateencryptionkey [line 5817]
void _generateencryptionkey(
String
$user_pass, String
$owner_pass, String
$protection)
|
|
Compute encryption key
Tags:
Parameters:
method _getfontpath [line 4064]
method _JScolor [line 7699]
method _md5_16 [line 5781]
String _md5_16(
string
$str)
|
|
Encrypts a string using MD5 and returns it's value as a binary string.
Tags:
Parameters:
method _newobj [line 5093]
Begin a new object.
Tags:
method _objectkey [line 5716]
Compute encryption key depending on object number where the encrypted data is stored
Tags:
Parameters:
method _out [line 5220]
Output a string to the document.
Tags:
Parameters:
method _outarc [line 8387]
void _outarc(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Output an arc
Tags:
Parameters:
method _outCurve [line 6305]
void _outCurve(
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
Tags:
Parameters:
method _outLine [line 6269]
method _outPoint [line 6255]
method _outRect [line 6286]
void _outRect(
float
$x, float
$y, float
$w, float
$h, string
$op)
|
|
Draws a rectangle.
Tags:
Parameters:
method _Ovalue [line 5793]
String _Ovalue(
String
$user_pass, String
$owner_pass)
|
|
Compute O value (used for RC4 encryption)
Tags:
Parameters:
method _parsejpeg [line 3698]
array _parsejpeg(
string
$file)
|
|
Extract info from a JPEG file without using the GD library.
Tags:
Parameters:
method _parsepng [line 3724]
array _parsepng(
string
$file)
|
|
Extract info from a PNG file without using the GD library.
Tags:
Parameters:
method _putannots [line 4165]
Output Page Annotations. See section 8.4 of PDF reference.
Tags:
Parameters:
method _putbookmarks [line 7597]
method _putcatalog [line 4870]
method _putcidfont0 [line 4600]
void _putcidfont0(
array
$font)
|
|
Output CID-0 fonts.
Tags:
Parameters:
method _putencryption [line 5724]
Put encryption on PDF document.
Tags:
method _putextgstates [line 8052]
method _putfonts [line 4486]
Output fonts. _putfonts
Tags:
method _putheader [line 4997]
method _putimages [line 4676]
method _putinfo [line 4830]
Adds some Metadata information (see Chapter 10.2 of PDF Reference)
Tags:
method _putjavascript [line 7671]
method _putocg [line 7973]
method _putpages [line 4075]
method _putresourcedict [line 4758]
Output Resources Dictionary.
Tags:
method _putresources [line 4798]
method _putshaders [line 8337]
method _putspotcolors [line 4731]
Output Spot Colors Resources.
Tags:
method _putstream [line 5206]
void _putstream(
string
$s)
|
|
Output a stream.
Tags:
Parameters:
method _puttrailer [line 4983]
method _puttruetypeunicode [line 5242]
void _puttruetypeunicode(
$font)
|
|
Adds unicode fonts. Based on PDF Reference 1.3 (section 5)
Tags:
Parameters:
method _putuserrights [line 7866]
method _putviewerpreferences [line 4913]
void _putviewerpreferences(
)
|
|
Output viewer preferences.
Tags:
method _putxobjectdict [line 4748]
Output object dictionary for images.
Tags:
method _RC4 [line 5742]
String _RC4(
string
$key, String
$text)
|
|
Returns the input text exrypted using RC4 algorithm and the specified key. RC4 is the standard encryption algorithm used in PDF format
Tags:
Parameters:
method _textstring [line 5144]
string _textstring(
string
$s)
|
|
Format a text string for meta information
Tags:
Parameters:
method _toJPEG [line 3682]
void _toJPEG(
image
$image, string
$file)
|
|
Convert the loaded php image to a JPEG and then return a structure for the PDF creator. This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
Tags:
Parameters:
method _uristring [line 5165]
string _uristring(
string
$s)
|
|
Format an URI string
Tags:
Parameters:
method _Uvalue [line 5805]
Compute U value (used for RC4 encryption)
Tags:
|
|