Tags
Table of Contents
- $allowLocalFiles : bool
- Whether to allow local file path in image html tags, when prefixed with file://
- $alpha : mixed
- Alpha mode array.
- $annotation_fonts : mixed
- List of fonts used on form fields (fontname => fontkey).
- $author : mixed
- Document author.
- $AutoPageBreak : mixed
- Automatic page breaking.
- $barcode : mixed
- Barcode to print on page footer (only if set).
- $bgcolor : mixed
- Current background color.
- $bMargin : mixed
- Page break margin.
- $booklet : mixed
- Booklet mode for double-sided pages.
- $bordermrk : mixed
- Array used to store positions inside the pages buffer (keys are the page numbers).
- $buffer : mixed
- Buffer holding in-memory PDF.
- $bufferlen : mixed
- Length of the buffer in bytes.
- $cache_file_length : mixed
- Array used to store the lengths of cache files.
- $cell_height_ratio : float
- Default cell height ratio.
- $cell_margin : mixed
- Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
- $cell_padding : mixed
- Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
- $check_page_regions : mixed
- Boolean value true when page region check is active.
- $cleaned_ids : mixed
- $clMargin : mixed
- Cell left margin (used by regions).
- $cntmrk : mixed
- Array used to store content positions inside the pages buffer (keys are the page numbers).
- $ColorFlag : mixed
- Indicates whether fill and text colors are different.
- $column_start_page : mixed
- Starting page for columns.
- $columns : mixed
- Array of column measures (width, space, starting Y position).
- $colxshift : mixed
- Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.
- $compress : mixed
- Compression flag.
- $CoreFonts : mixed
- Array of standard font names.
- $creator : mixed
- Document creator.
- $crMargin : mixed
- Cell right margin (used by regions).
- $CurOrientation : mixed
- Current page orientation (P = Portrait, L = Landscape).
- $current_column : mixed
- Current column number.
- $CurrentFont : mixed
- Current font info.
- $currpagegroup : mixed
- Current page group number.
- $custom_xmp : mixed
- Custom XMP data.
- $custom_xmp_rdf : mixed
- Custom XMP RDF data.
- $customlistindent : mixed
- HTML PARSER: custom indent amount for lists. Negative value means disabled.
- $default_form_prop : mixed
- 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.
- $default_graphic_vars : mixed
- Array of default graphic settings.
- $default_monospaced_font : mixed
- Default monospace font.
- $default_table_columns : mixed
- Default number of columns for html table.
- $dests : mixed
- A dictionary of names and corresponding destinations (Dests key on document Catalog).
- $diffs : mixed
- Array of encoding differences.
- $doc_creation_timestamp : mixed
- Document creation date-time
- $doc_modification_timestamp : mixed
- Document modification date-time
- $docinfounicode : mixed
- If true set the document information dictionary in Unicode.
- $dpi : mixed
- DPI (Dot Per Inch) Document Resolution (do not change).
- $DrawColor : mixed
- Commands for drawing color.
- $efnames : mixed
- Embedded Files Names
- $embeddedfiles : mixed
- Array of files to embedd.
- $empty_signature_appearance : mixed
- Array of empty digital signature appearances.
- $emptypagemrk : mixed
- Array used to store page positions to track empty pages (keys are the page numbers).
- $encoding : mixed
- Default encoding.
- $encryptdata : mixed
- Array containing encryption settings.
- $encrypted : mixed
- IBoolean flag indicating whether document is protected.
- $endlinex : mixed
- End position of the latest inserted line.
- $epsmarker : mixed
- String used to mark the beginning and end of EPS image blocks.
- $extgstates : mixed
- Array of transparency objects and parameters.
- $feps : mixed
- Epsilon value used for float calculations.
- $fgcolor : mixed
- Current foreground color.
- $fhPt : mixed
- Height of page format in points.
- $file_id : mixed
- File ID (used on document trailer).
- $fileContentCache : array<string|int, mixed>
- Cache array for file content
- $FillColor : mixed
- Commands for filling color.
- $font_obj_ids : mixed
- Store the font object IDs.
- $font_spacing : mixed
- Increases or decreases the space between characters in a text by the specified amount (tracking).
- $font_stretching : mixed
- Percentage of character stretching.
- $font_subsetting : mixed
- Boolean flag: if true enables font subsetting by default.
- $FontAscent : mixed
- Current font ascent (distance between font top and baseline).
- $FontDescent : mixed
- Current font descent (distance between font bottom and baseline).
- $FontFamily : mixed
- Current font family.
- $FontFiles : mixed
- Array of font files.
- $fontkeys : mixed
- Store the font keys.
- $fontlist : mixed
- List of available fonts on filesystem.
- $fonts : mixed
- Array of used fonts.
- $FontSize : mixed
- Current font size in user unit.
- $FontSizePt : mixed
- Current font size in points.
- $FontStyle : mixed
- Current font style.
- $footer_font : array<int, string|float|null>
- Default font used on page footer.
- $footer_line_color : array<string|int, int>
- Color for footer line (RGB array).
- $footer_margin : mixed
- Minimum distance between footer and bottom page margin.
- $footer_text_color : array<string|int, int>
- Color for footer text (RGB array).
- $footerlen : mixed
- Array used to store footer length of each page.
- $footerpos : mixed
- Array used to store footer positions of each page.
- $force_srgb : mixed
- If true force sRGB color profile for all document.
- $form_action : mixed
- Current form action (used during XHTML rendering).
- $form_enctype : mixed
- Current form encryption type (used during XHTML rendering).
- $form_mode : mixed
- Current method to submit forms.
- $form_obj_id : mixed
- List of form annotations IDs.
- $fwPt : mixed
- Width of page format in points.
- $gdgammacache : mixed
- Cache array for computed GD gamma values.
- $gradients : mixed
- Array for storing gradient information.
- $h : mixed
- Current height of page in user unit.
- $header_font : array<int, string|float|null>
- Default font used on page header.
- $header_line_color : array<string|int, int>
- Color for header line (RGB array).
- $header_logo : mixed
- Header image logo.
- $header_logo_width : mixed
- Width of header image logo in user units.
- $header_margin : mixed
- Minimum distance between header and top page margin.
- $header_string : mixed
- String to print on page header after title.
- $header_text_color : array<string|int, int>
- Color for header text (RGB array).
- $header_title : mixed
- Title to be printed on default page header.
- $header_xobj_autoreset : mixed
- If true reset the Header Xobject template at each page
- $header_xobjid : mixed
- ID of the stored default header template (-1 = not set).
- $hPt : mixed
- Current height of page in points.
- $HREF : mixed
- HTML PARSER: array to store current link and rendering styles.
- $htmlLinkColorArray : mixed
- Default color for html links.
- $htmlLinkFontStyle : mixed
- Default font style to add to html links.
- $htmlvspace : mixed
- Count the latest inserted vertical spaces on HTML.
- $imagekeys : mixed
- Store the image keys.
- $images : mixed
- Array of used images.
- $img_rb_x : mixed
- The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
- $img_rb_y : mixed
- The right-bottom corner Y coordinate of last inserted image.
- $imgscale : mixed
- Adjusting factor to convert pixels to user units.
- $InFooter : mixed
- Flag set when processing page footer.
- $InHeader : mixed
- Flag set when processing page header.
- $inthead : mixed
- True when we are printing the thead section on a new page.
- $intmrk : mixed
- Array used to store positions inside the pages buffer (keys are the page numbers).
- $inxobj : mixed
- Boolean value true when we are inside an XObject.
- $isunicode : mixed
- Boolean flag set to true when the input text is unicode (require unicode fonts).
- $javascript : mixed
- Javascript code.
- $jpeg_quality : mixed
- Set the default JPEG compression quality (1-100).
- $js_objects : mixed
- Javascript objects array.
- $k : mixed
- Scale factor (number of points in user unit).
- $keywords : mixed
- Document keywords.
- $l : mixed
- Language templates.
- $last_enc_key : mixed
- Last RC4 key encrypted (cached for optimisation).
- $last_enc_key_c : mixed
- Last RC4 computed key.
- $lasth : mixed
- Height of last cell printed.
- $LayoutMode : mixed
- Layout display mode.
- $linestyleCap : mixed
- PDF string for CAP value of the last line.
- $linestyleDash : mixed
- PDF string for dash value of the last line.
- $linestyleJoin : mixed
- PDF string for join value of the last line.
- $linestyleWidth : mixed
- PDF string for width value of the last line.
- $linethrough : mixed
- line through state
- $LineWidth : mixed
- Line width in user unit.
- $links : mixed
- Array of internal links.
- $lispacer : mixed
- Spacer string for LI tags.
- $listcount : mixed
- HTML PARSER: array count list items on nested lists.
- $listindent : mixed
- HTML PARSER: indent amount for lists.
- $listindentlevel : mixed
- HTML PARSER: current list indententation level.
- $listnum : mixed
- HTML PARSER: current list nesting level.
- $listordered : mixed
- HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
- $lisymbol : mixed
- Symbol used for HTML unordered list items.
- $lMargin : mixed
- Left margin.
- $maxselcol : mixed
- Maximum page and column selected.
- $n : mixed
- Current object number.
- $n_dests : mixed
- Object ID for Named Destinations
- $n_js : mixed
- Javascript counter.
- $newline : mixed
- Boolean flag to indicate if a new line is created.
- $newpagegroup : mixed
- Array of page numbers were a new page group was started (the page numbers are the keys of the array).
- $num_columns : mixed
- Number of colums.
- $numfonts : mixed
- Counts the number of fonts.
- $numimages : mixed
- Counts the number of pages.
- $numpages : mixed
- Counts the number of pages.
- $objcopy : mixed
- Cloned copy of the current class object.
- $offsets : mixed
- Array of object offsets.
- $opencell : mixed
- Boolean flag to indicate if the border of the cell sides that cross the page should be removed.
- $openMarkedContent : mixed
- Boolean flag to indicate if marked-content sequence is open.
- $original_lMargin : mixed
- Original left margin value.
- $original_rMargin : mixed
- Original right margin value.
- $OutlineRoot : mixed
- Outline root for bookmark.
- $outlines : mixed
- Outlines for bookmark.
- $overline : mixed
- Overlining flag.
- $overprint : array<string, bool|int>
- Overprint mode array.
- $page : mixed
- Current page number.
- $page_boxes : mixed
- Define the page boundaries boxes to be set on document.
- $page_obj_id : mixed
- ID of page objects.
- $page_regions : mixed
- Array of no-write regions.
- $PageAnnots : mixed
- Array of Annotations in pages.
- $PageBreakTrigger : mixed
- Threshold used to trigger page breaks.
- $pagedim : mixed
- Page dimensions.
- $pagegroups : mixed
- Array that contains the number of pages in each page group.
- $pagelen : mixed
- Array containing page lengths in bytes.
- $PageMode : mixed
- A name object specifying how the document should be displayed when opened.
- $pageobjects : mixed
- Array of object IDs for each page.
- $pageopen : mixed
- Store the fage status (true when opened, false when closed).
- $pages : mixed
- Array containing pages.
- $pdfa_mode : mixed
- If true set the document to PDF/A mode.
- $pdfa_version : mixed
- version of PDF/A mode (1 - 3).
- $pdflayers : mixed
- Array of PDF layers data.
- $pdfunit : mixed
- Default unit of measure for document.
- $PDFVersion : mixed
- PDF version.
- $premode : mixed
- Boolean flag to indicate if we are inside a PRE tag.
- $print_footer : mixed
- Boolean flag to print/hide page footer.
- $print_header : mixed
- Boolean flag to print/hide page header.
- $radio_groups : mixed
- List of radio group objects IDs.
- $radiobutton_groups : mixed
- List of radio buttons parent objects.
- $rasterize_vector_images : mixed
- Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
- $re_space : mixed
- Array of $re_spaces parts.
- $re_spaces : mixed
- Regular expression used to find blank characters (required for word-wrapping).
- $rMargin : mixed
- Right margin.
- $rtl : mixed
- Boolean flag to indicate if the document language is Right-To-Left.
- $sig_obj_id : mixed
- Digital signature object ID.
- $sign : mixed
- Boolean flag to enable document digital signature.
- $signature_appearance : mixed
- Data for digital signature appearance.
- $signature_data : mixed
- Digital signature data.
- $signature_max_length : mixed
- Digital signature max length.
- $spot_colors : mixed
- Array of Spot colors.
- $start_transaction_page : mixed
- Store page number when startTransaction() is called.
- $start_transaction_y : mixed
- Store Y position when startTransaction() is called.
- $starting_page_number : mixed
- Starting page number.
- $state : mixed
- Current document state.
- $strokecolor : mixed
- Current stroke color.
- $subject : mixed
- Document subject.
- $svg_tag_depth : mixed
- Depth of the svg tag, to keep track if the svg tag is a subtag or the root tag.
- $svgclipid : mixed
- ID of last SVG clipPath.
- $svgclipmode : mixed
- Boolean value true when in SVG clipPath tag.
- $svgclippaths : mixed
- Array of SVG clipPath commands.
- $svgcliptm : mixed
- Array of SVG clipPath tranformation matrix.
- $svgdefs : mixed
- Array of SVG defs.
- $svgdefsmode : mixed
- Boolean value true when in SVG defs group.
- $svgdir : mixed
- Directory used for the last SVG image.
- $svggradientid : mixed
- ID of last SVG gradient.
- $svggradients : mixed
- Array of SVG gradients.
- $svgstyles : mixed
- Array of SVG properties.
- $svgtext : mixed
- SVG text.
- $svgtextmode : mixed
- SVG text properties.
- $svgunit : mixed
- Deafult unit of measure for SVG.
- $tagvspaces : mixed
- Array used for custom vertical spaces for HTML tags.
- $tcpdflink : mixed
- If true print TCPDF meta link.
- $tempfontsize : mixed
- Temporary font size in points.
- $TextColor : mixed
- Commands for text color.
- $textindent : mixed
- Text indentation value (used for text-indent CSS attribute).
- $textrendermode : mixed
- 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.
- $textstrokewidth : mixed
- Text stroke width in doc units.
- $thead : mixed
- Table header content to be repeated on each new page.
- $theadMargins : mixed
- Margins used for table header.
- $title : mixed
- Document title.
- $tMargin : mixed
- Top margin.
- $tmprtl : mixed
- Boolean flag used to force RTL or LTR string direction.
- $tocpage : mixed
- Boolean flag true when we are on TOC (Table Of Content) page.
- $transfmatrix : mixed
- Array of transformation matrix.
- $transfmatrix_key : mixed
- Current key for transformation matrix.
- $transfmrk : mixed
- Array used to store positions of graphics transformation blocks inside the page buffer.
- $tsa_data : mixed
- Timestamping data.
- $tsa_timestamp : mixed
- Boolean flag to enable document timestamping with TSA.
- $txtshadow : mixed
- Text shadow data array.
- $underline : mixed
- Underlining flag.
- $ur : mixed
- Array with additional document-wide usage rights for the document.
- $viewer_preferences : mixed
- PDF viewer preferences.
- $w : mixed
- Current width of page in user unit.
- $wPt : mixed
- Current width of page in points.
- $x : mixed
- Current horizontal position in user unit for cell positioning.
- $xobjects : mixed
- Array of XObjects.
- $xobjid : mixed
- Current XObject ID.
- $y : mixed
- Current vertical position in user unit for cell positioning.
- $ZoomMode : mixed
- Zoom display mode.
- __construct() : mixed
- This is the class constructor.
- __destruct() : mixed
- Default destructor.
- _destroy() : mixed
- Unset all class variables except the following critical variables.
- _putshaders() : mixed
- Output gradient shaders.
- AcceptPageBreak() : bool
- Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
- addEmptySignatureAppearance() : mixed
- Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
- AddFont() : array<string|int, mixed>|false
- Imports a TrueType, Type1, core, or CID0 font and makes it available.
- addHtmlLink() : int
- Output anchor link.
- addHTMLTOC() : mixed
- Output a Table Of Content Index (TOC) using HTML templates.
- addJavascriptObject() : int
- Adds a javascript object and return object ID
- AddLink() : mixed
- Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br /> The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
- AddPage() : mixed
- 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).
- addPageRegion() : mixed
- Add a single no-write region on selected page.
- AddSpotColor() : mixed
- Defines a new spot color.
- addTOC() : mixed
- Output a Table of Content Index (TOC).
- addTOCPage() : mixed
- Adds a new TOC (Table Of Content) page to the document.
- Annotation() : mixed
- Puts a markup annotation on a rectangular area of the page.
- Arrow() : mixed
- Draws a grahic arrow.
- Bookmark() : mixed
- Adds a bookmark.
- Button() : mixed
- Creates a button field
- Cell() : mixed
- 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.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
- CheckBox() : mixed
- Creates a CheckBox field
- Circle() : mixed
- Draws a circle.
- Close() : mixed
- Terminates the PDF document.
- colorRegistrationBar() : mixed
- Paints color transition registration bars
- ComboBox() : mixed
- Creates a Combo-box field
- commitTransaction() : mixed
- Delete the copy of the current TCPDF object used for undo operation.
- CoonsPatchMesh() : mixed
- Paints a coons patch mesh.
- copyPage() : bool
- Clone the specified page to a new page.
- cropMark() : mixed
- Paints crop marks.
- Curve() : mixed
- Draws a Bezier curve.
- deletePage() : bool
- Remove the specified page.
- Ellipse() : mixed
- Draws an ellipse.
- endLayer() : mixed
- End the current PDF layer.
- endPage() : mixed
- Terminate the current page
- endTemplate() : string|false
- End the current XObject Template started with startTemplate() and restore the previous graphic state.
- endTOCPage() : mixed
- Terminate the current TOC (Table Of Content) page
- Error() : mixed
- Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
- fixHTMLCode() : string
- Cleanup HTML code (requires HTML Tidy library).
- Footer() : mixed
- This method is used to render the page footer.
- getAbsFontMeasure() : float
- Convert a relative font measure into absolute value.
- GetAbsX() : float
- Returns the absolute X value of current position.
- getAliasNbPages() : string
- Returns the string alias used for the total number of pages.
- getAliasNumPage() : string
- Returns the string alias used for the page number.
- getAliasRightShift() : string
- Returns the string alias used right align page numbers.
- getAllSpotColors() : array<string|int, mixed>
- Returns the array of spot colors.
- getAlpha() : array<string, bool|string>
- Get the alpha mode array (CA, ca, BM, AIS).
- GetArrStringWidth() : array<string|int, float>|float
- Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>
- getAutoPageBreak() : bool
- Return the auto-page-break mode (true or false).
- getBarcode() : string
- Get current barcode.
- getBreakMargin() : int|float
- Returns the page break margin.
- getCellHeight() : float
- Return the cell height
- getCellHeightRatio() : float
- return the height of cell repect font height.
- getCellMargins() : array<string|int, mixed>
- Get the internal Cell margin array.
- getCellPaddings() : array<string|int, mixed>
- Get the internal Cell padding array.
- getCharBBox() : false|array<string|int, mixed>
- Returns the glyph bounding box of the specified character in the current font in user units.
- GetCharWidth() : float
- Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
- getColumn() : int
- Return the current column number
- getCSSBorderMargin() : array<string|int, mixed>
- Get the border-spacing from CSS attribute.
- getCSSMargin() : array<string|int, mixed>
- Get the internal Cell margin from CSS attribute.
- getCSSPadding() : array<string|int, mixed>
- Get the internal Cell padding from CSS attribute.
- getDestination() : array<string|int, mixed>
- Return the Named Destination array.
- getDocCreationTimestamp() : int
- Returns document creation timestamp in seconds.
- getDocModificationTimestamp() : int
- Returns document modification timestamp in seconds.
- getFontAscent() : int
- Return the font ascent value.
- getFontBBox() : array<string|int, mixed>
- Returns the bounding box of the current font in user units.
- getFontDescent() : int
- Return the font descent value
- getFontFamily() : string
- Returns the current font family name.
- getFontFamilyName() : string
- Return normalized font name
- getFontSize() : float
- Returns the current font size.
- getFontSizePt() : int
- Returns the current font size in points unit.
- getFontSpacing() : int
- Get the amount to increase or decrease the space between characters in a text.
- getFontStretching() : float
- Get the percentage of character stretching.
- getFontStyle() : string
- Returns the current font style.
- getFontSubsetting() : bool
- Return the default option for font subsetting.
- getFooterFont() : array<int, string|float|null>
- Get Footer font.
- getFooterMargin() : float
- Returns footer margin in user units.
- getFormDefaultProp() : array<string|int, mixed>
- Return the default properties for form fields.
- getGroupPageNo() : int
- Return the current page in the group.
- getGroupPageNoFormatted() : mixed
- Returns the current group page number formatted as a string.
- getHeaderData() : array<string, mixed>
- Returns header data: <ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul>
- getHeaderFont() : array<int, string|float|null>
- Get header font.
- getHeaderMargin() : float
- Returns header margin in user units.
- getHTMLFontUnits() : float
- Convert HTML string containing font size value to points
- getHTMLUnitToUnits() : float
- Convert HTML string containing value and unit of measure to user's units or points.
- getImageRBX() : float
- Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
- getImageRBY() : float
- Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
- getImageScale() : float
- Returns the adjusting factor to convert pixels to user units.
- getLastH() : float
- Get the last cell height.
- GetLineWidth() : int
- Returns the current the line width.
- getMargins() : array<string|int, mixed>
- Returns an array containing current margins: <ul> <li>$ret['left'] = left margin</li> <li>$ret['right'] = right margin</li> <li>$ret['top'] = top margin</li> <li>$ret['bottom'] = bottom margin</li> <li>$ret['header'] = header margin</li> <li>$ret['footer'] = footer margin</li> <li>$ret['cell'] = cell padding array</li> <li>$ret['padding_left'] = cell left padding</li> <li>$ret['padding_top'] = cell top padding</li> <li>$ret['padding_right'] = cell right padding</li> <li>$ret['padding_bottom'] = cell bottom padding</li> </ul>
- getNumberOfColumns() : int
- Return the current number of columns.
- GetNumChars() : int
- Returns the numbero of characters in a string.
- getNumLines() : float
- This method return the estimated number of lines for print a simple text string using Multicell() method.
- getNumPages() : int
- Get the total number of insered pages.
- getOriginalMargins() : array<string|int, mixed>
- Returns an array containing original margins: <ul> <li>$ret['left'] = left margin</li> <li>$ret['right'] = right margin</li> </ul>
- getOverprint() : array<string, bool|int>
- Get the overprint mode array (OP, op, OPM).
- getPage() : int
- Get current document page number.
- getPageDimensions() : array<string|int, mixed>
- Returns an array of page dimensions: <ul><li>$this->pagedim[$this->page]['w'] = page width in points</li><li>$this->pagedim[$this->page]['h'] = height in points</li><li>$this->pagedim[$this->page]['wk'] = page width in user units</li><li>$this->pagedim[$this->page]['hk'] = page height in user units</li><li>$this->pagedim[$this->page]['tm'] = top margin</li><li>$this->pagedim[$this->page]['bm'] = bottom margin</li><li>$this->pagedim[$this->page]['lm'] = left margin</li><li>$this->pagedim[$this->page]['rm'] = right margin</li><li>$this->pagedim[$this->page]['pb'] = auto page break</li><li>$this->pagedim[$this->page]['or'] = page orientation</li><li>$this->pagedim[$this->page]['olm'] = original left margin</li><li>$this->pagedim[$this->page]['orm'] = original right margin</li><li>$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.</li><li>$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.</li><li>$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<ul><li>$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.</li><li>$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li><li>$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.</li><li>$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.</li><li>$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.</li><li>$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.</li><li>$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. </li><li>$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.</li></ul></li><li>$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed<ul><li>$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['CropBox'] : the visible region of default user space<ul><li>$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment<ul><li>$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming<ul><li>$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content<ul><li>$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points</li></ul></li></ul>
- getPageGroupAlias() : string
- Return the alias for the total number of pages in the current page group.
- getPageHeight() : int|float
- Returns the page height in units.
- getPageNumGroupAlias() : string
- Return the alias for the page number on the current page group.
- getPageRegions() : array<string|int, mixed>
- Return an array of no-write page regions
- getPageWidth() : int|float
- Returns the page width in units.
- getPDFData() : mixed
- Returns the PDF data.
- getRawCharWidth() : float
- Returns the length of the char in user unit for the current font.
- getRTL() : bool
- Return the RTL status
- getScaleFactor() : int
- Returns the scale factor (number of points in user unit).
- getStringHeight() : float
- This method return the estimated height needed for printing a simple text string using the Multicell() method.
- GetStringWidth() : array<string|int, float>|float
- Returns the length of a string in user unit. A font must be selected.<br>
- getTextShadow() : array<string|int, mixed>
- Return the text shadow parameters array.
- GetX() : float
- Returns the relative X value of current position.
- GetY() : float
- Returns the ordinate of the current position.
- Gradient() : mixed
- Output gradient.
- Header() : mixed
- This method is used to render the page header.
- hyphenateText() : string
- Returns text with soft hyphens.
- Image() : mixed|false
- Puts an image in the page.
- ImageEps() : mixed
- Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
- ImageSVG() : mixed
- Embedd a Scalable Vector Graphics (SVG) image.
- IncludeJS() : mixed
- Adds a javascript
- isCharDefined() : bool
- Return true in the character is present in the specified font.
- isRTLTextDir() : bool
- Return the current temporary RTL status
- isUnicodeFont() : bool
- Return true if the current font is unicode type.
- lastPage() : mixed
- Reset pointer to the last document page.
- Line() : mixed
- Draws a line between two points.
- LinearGradient() : mixed
- Paints a linear colour gradient.
- Link() : mixed
- Puts a link on a rectangular area of the page.
- ListBox() : mixed
- Creates a List-box field
- Ln() : mixed
- Performs a line break.
- MirrorH() : mixed
- Horizontal Mirroring.
- MirrorL() : mixed
- Reflection against a straight line through point (x, y) with the gradient angle (angle).
- MirrorP() : mixed
- Point reflection mirroring.
- MirrorV() : mixed
- Verical Mirroring.
- movePage() : bool
- Move a page to a previous position.
- MultiCell() : int
- This method allows printing text with line breaks.
- Open() : mixed
- This method begins the generation of the PDF document.
- Output() : string
- Send the document to a given destination: string, local file or browser.
- PageNo() : int
- Returns the current page number.
- PageNoFormatted() : mixed
- Returns the current page number formatted as a string.
- PieSector() : mixed
- Draw the sector of a circle.
- PieSectorXY() : mixed
- Draw the sector of an ellipse.
- pixelsToUnits() : float
- Converts pixels to User's Units.
- Polycurve() : mixed
- Draws a poly-Bezier curve.
- Polygon() : mixed
- Draws a polygon.
- PolyLine() : mixed
- Draws a polygonal line
- printTemplate() : mixed
- Print an XObject Template.
- RadialGradient() : mixed
- Paints a radial colour gradient.
- RadioButton() : mixed
- Creates a RadioButton field.
- Rect() : mixed
- Draws a rectangle.
- registrationMark() : mixed
- Paints a registration mark
- registrationMarkCMYK() : mixed
- Paints a CMYK registration mark
- RegularPolygon() : mixed
- Draws a regular polygon.
- removePageRegion() : mixed
- Remove a single no-write region.
- replaceMissingChars() : string
- Replace missing font characters on selected font with specified substitutions.
- resetColumns() : mixed
- Remove columns and reset page margins.
- resetHeaderTemplate() : mixed
- Reset the xobject template used by Header() method.
- resetLastH() : mixed
- Reset the last cell height.
- rollbackTransaction() : TCPDF
- This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
- Rotate() : mixed
- Rotate object.
- RoundedRect() : mixed
- Draws a rounded rectangle.
- RoundedRectXY() : mixed
- Draws a rounded rectangle.
- Scale() : mixed
- Vertical and horizontal non-proportional Scaling.
- ScaleX() : mixed
- Horizontal Scaling.
- ScaleXY() : mixed
- Vertical and horizontal proportional Scaling.
- ScaleY() : mixed
- Vertical Scaling.
- selectColumn() : mixed
- Set position at a given column
- serializeTCPDFtagParameters() : string
- Serialize an array of parameters to be used with TCPDF tag in HTML code.
- setAbsX() : mixed
- Set the absolute X coordinate of the current pointer.
- setAbsXY() : mixed
- Set the absolute X and Y coordinates of the current pointer.
- setAbsY() : mixed
- Set the absolute Y coordinate of the current pointer.
- setAllowLocalFiles() : mixed
- Whether to allow local file path in image html tags, when prefixed with file://
- setAlpha() : mixed
- Set alpha for stroking (CA) and non-stroking (ca) operations.
- setAuthor() : mixed
- Defines the author of the document.
- setAutoPageBreak() : mixed
- 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.
- setBarcode() : mixed
- Set document barcode.
- setBooklet() : mixed
- Set the booklet mode for double-sided pages.
- setBookmark() : mixed
- Adds a bookmark - alias for Bookmark().
- setCellHeightRatio() : mixed
- Set the height of the cell (line height) respect the font height.
- setCellMargins() : mixed
- Set the internal Cell margins.
- setCellPadding() : mixed
- Set the same internal Cell padding for top, right, bottom, left-
- setCellPaddings() : mixed
- Set the internal Cell paddings.
- setColor() : string
- Defines the color used by the specified type ('draw', 'fill', 'text').
- setColorArray() : string
- Set the color array for the specified type ('draw', 'fill', 'text').
- setColumnsArray() : mixed
- Set columns array.
- setCompression() : mixed
- 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.
- setCreator() : mixed
- Defines the creator of the document. This is typically the name of the application that generates the PDF.
- setDefaultMonospacedFont() : mixed
- Defines the default monospaced font.
- setDefaultTableColumns() : mixed
- Set the default number of columns in a row for HTML tables.
- setDestination() : string|false
- Add a Named Destination.
- setDisplayMode() : mixed
- Defines the way the document is to be displayed by the viewer.
- setDocCreationTimestamp() : mixed
- Set the document creation timestamp
- setDocInfoUnicode() : mixed
- Turn on/off Unicode mode for document information dictionary (meta tags).
- setDocModificationTimestamp() : mixed
- Set the document modification timestamp
- setDrawColor() : string
- 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.
- setDrawColorArray() : string
- Defines the color used for all drawing operations (lines, rectangles and cell borders).
- setDrawSpotColor() : mixed
- Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
- setEqualColumns() : mixed
- Set multiple columns of the same size
- setExtraXMP() : mixed
- Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.
- setExtraXMPRDF() : mixed
- Set additional XMP data to be added on the default XMP data just before the end of "rdf:RDF" tag.
- setFillColor() : string
- 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.
- setFillColorArray() : mixed
- Defines the color used for all filling operations (filled rectangles and cell backgrounds).
- setFillSpotColor() : mixed
- Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
- setFont() : mixed
- Sets the font used to print character strings.
- setFontSize() : mixed
- Defines the size of the current font.
- setFontSpacing() : mixed
- Set the amount to increase or decrease the space between characters in a text.
- setFontStretching() : mixed
- Set the percentage of character stretching.
- setFontSubsetting() : mixed
- Enable or disable default option for font subsetting.
- setFooterData() : mixed
- Set footer data.
- setFooterFont() : mixed
- Set footer font.
- setFooterMargin() : mixed
- Set footer margin.
- setFormDefaultProp() : mixed
- Set default properties for form fields.
- setHeaderData() : mixed
- Set header data.
- setHeaderFont() : mixed
- Set header font.
- setHeaderMargin() : mixed
- Set header margin.
- setHeaderTemplateAutoreset() : mixed
- Set a flag to automatically reset the xobject template used by Header() method at each page.
- setHtmlLinksStyle() : mixed
- Set the color and font style for HTML links.
- setHtmlVSpace() : mixed
- Set the vertical spaces for HTML tags.
- setImageScale() : mixed
- Set the adjusting factor to convert pixels to user units.
- setJPEGQuality() : mixed
- Set the default JPEG compression quality (1-100)
- setKeywords() : mixed
- Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
- setLanguageArray() : mixed
- Set language array.
- setLastH() : mixed
- Set the last cell height.
- setLeftMargin() : mixed
- 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.
- setLineStyle() : string
- Set line style.
- setLineWidth() : mixed
- 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.
- setLink() : mixed
- Defines the page and position a link points to.
- setListIndentWidth() : mixed
- Set custom width for list indentation.
- setLIsymbol() : mixed
- Set the default bullet to be used as LI bullet symbol
- setMargins() : mixed
- Defines the left, top and right margins.
- setOpenCell() : mixed
- Set the top/bottom cell sides to be open or closed when the cell cross the page.
- setOverprint() : mixed
- Set overprint mode for stroking (OP) and non-stroking (op) painting operations.
- setPage() : mixed
- Move pointer at the specified document page and update page dimensions.
- setPageMark() : mixed
- Set start-writing mark on current page stream used to put borders and fills.
- setPageOrientation() : mixed
- Set page orientation.
- setPageRegions() : mixed
- Set no-write regions on page.
- setPageUnit() : mixed
- Set the units of measure for the document.
- setPDFVersion() : mixed
- Set the PDF version (check PDF reference for valid values).
- setPrintFooter() : mixed
- Set a flag to print page footer.
- setPrintHeader() : mixed
- Set a flag to print page header.
- setProtection() : mixed
- Set document protection Remark: the protection against modification is for people who have the full Acrobat product.
- setRasterizeVectorImages() : mixed
- Enable/disable rasterization of vector images using ImageMagick library.
- setRightMargin() : mixed
- Defines the right margin. The method can be called before creating the first page.
- setRTL() : mixed
- Enable or disable Right-To-Left language mode
- setSignature() : mixed
- Enable document signature (requires the OpenSSL Library).
- setSignatureAppearance() : mixed
- Set the digital signature appearance (a cliccable rectangle area to get signature properties)
- setSpacesRE() : mixed
- Set regular expression to detect withespaces or word separators.
- setSpotColor() : string
- Set the spot color for the specified type ('draw', 'fill', 'text').
- setSRGBmode() : mixed
- Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.
- setStartingPageNumber() : mixed
- Set the starting page number.
- setSubject() : mixed
- Defines the subject of the document.
- setTempRTL() : mixed
- Force temporary RTL language direction
- setTextColor() : string
- 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.
- setTextColorArray() : mixed
- Defines the color used for text. It can be expressed in RGB components or gray scale.
- setTextRenderingMode() : mixed
- Set Text rendering mode.
- setTextShadow() : mixed
- Set parameters for drop shadow effect for text.
- setTextSpotColor() : mixed
- Defines the spot color used for text.
- setTimeStamp() : mixed
- Enable document timestamping (requires the OpenSSL Library).
- setTitle() : mixed
- Defines the title of the document.
- setTopMargin() : mixed
- Defines the top margin. The method can be called before creating the first page.
- setUserRights() : mixed
- Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work.
- setViewerPreferences() : mixed
- Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
- setVisibility() : mixed
- Set the visibility of the successive elements.
- setX() : mixed
- Defines the abscissa of the current position.
- setXY() : mixed
- Defines the abscissa and ordinate of the current position.
- setY() : mixed
- Moves the current abscissa back to the left margin and sets the ordinate.
- Skew() : mixed
- Skew.
- SkewX() : mixed
- Skew horizontally.
- SkewY() : mixed
- Skew vertically.
- StarPolygon() : mixed
- Draws a star polygon
- startLayer() : mixed
- Start a new pdf layer.
- startPage() : mixed
- Starts a new page to the document. The page must be closed using the endPage() function.
- startPageGroup() : mixed
- Create a new page group.
- startTemplate() : string|false
- Start a new XObject Template.
- startTransaction() : mixed
- Stores a copy of the current TCPDF object used for undo operation.
- StartTransform() : mixed
- Starts a 2D tranformation saving current graphic state.
- StopTransform() : mixed
- Stops a 2D tranformation restoring previous graphic state.
- stringLeftTrim() : string
- Left trim the input string
- stringRightTrim() : string
- Right trim the input string
- stringTrim() : string
- Trim the input string
- Text() : mixed
- Prints a text cell at the specified position.
- TextField() : mixed
- Creates a text field
- Translate() : mixed
- Translate graphic object horizontally and vertically.
- TranslateX() : mixed
- Translate graphic object horizontally.
- TranslateY() : mixed
- Translate graphic object vertically.
- unhtmlentities() : string
- Reverse function for htmlentities.
- Write() : mixed
- This method prints text from the current position.<br />
- write1DBarcode() : mixed
- Print a Linear Barcode.
- write2DBarcode() : mixed
- Print 2D Barcode.
- writeHTML() : mixed
- Allows to preserve some HTML formatting (limited support).<br /> IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
- writeHTMLCell() : mixed
- Prints a cell (rectangular area) with optional borders, background color and html text string.
- _addfield() : mixed
- Adds a javascript form field.
- _beginpage() : mixed
- Initialize a new page.
- _datastring() : string
- Format a data string for meta information
- _datestring() : string
- Returns a formatted date for meta information
- _dochecks() : mixed
- Check for locale-related bug
- _dolinethrough() : mixed
- Line through text.
- _dolinethroughw() : mixed
- Line through for rectangular text area.
- _dooverline() : mixed
- Overline text.
- _dooverlinew() : mixed
- Overline for rectangular text area.
- _dounderline() : mixed
- Underline text.
- _dounderlinew() : mixed
- Underline for rectangular text area.
- _encrypt_data() : string
- Encrypt the input string.
- _enddoc() : mixed
- Output end of document (EOF).
- _endpage() : mixed
- Mark end of page.
- _fixAES256Password() : string
- Convert password for AES-256 encryption mode
- _generateencryptionkey() : mixed
- Compute encryption key
- _getannotsrefs() : string
- Get references to page annotations.
- _getobj() : string
- Return the starting object string for the selected object ID.
- _getrawstream() : mixed
- get raw output stream.
- _getxobjectdict() : string
- Return XObjects Dictionary.
- _newobj() : int
- Begin a new object and return the object number.
- _objectkey() : int
- Compute encryption key depending on object number where the encrypted data is stored.
- _OEvalue() : string
- Compute OE value (used for encryption)
- _out() : mixed
- Output a string to the document.
- _outCurve() : mixed
- Append a cubic Bezier 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 Bezier control points.
- _outCurveV() : mixed
- Append a cubic Bezier 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 Bezier control points.
- _outCurveY() : mixed
- Append a cubic Bezier 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 Bezier control points.
- _outellipticalarc() : array<string|int, mixed>
- Append an elliptical arc to the current path.
- _outLine() : mixed
- Append a straight line segment from the current point to the point (x, y).
- _outPoint() : mixed
- Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
- _outRect() : mixed
- Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
- _outRestoreGraphicsState() : mixed
- Outputs the "restore graphics state" operator 'Q'
- _outSaveGraphicsState() : mixed
- Outputs the "save graphics state" operator 'q'
- _Ovalue() : string
- Compute O value (used for encryption)
- _putannotsobjs() : mixed
- Output annotations objects for all pages.
- _putAPXObject() : int
- Put appearance streams XObject used to define annotation's appearance states.
- _putbookmarks() : mixed
- Create a bookmark PDF string.
- _putcatalog() : int
- Output Catalog.
- _putcidfont0() : mixed
- Output CID-0 fonts.
- _putdests() : mixed
- Insert Named Destinations.
- _putEmbeddedFiles() : mixed
- Embedd the attached files.
- _putencryption() : mixed
- Put encryption on PDF document.
- _putextgstates() : mixed
- Put extgstates for object transparency
- _putfonts() : mixed
- Output fonts.
- _putheader() : mixed
- Output PDF File Header (7.5.2).
- _putimages() : mixed
- Output images.
- _putinfo() : int
- Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
- _putjavascript() : mixed
- Create a javascript PDF string.
- _putocg() : mixed
- Put pdf layers.
- _putpages() : mixed
- Output pages (and replace page number aliases).
- _putresourcedict() : mixed
- Output Resources Dictionary.
- _putresources() : mixed
- Output Resources.
- _putsignature() : mixed
- Add certification signature (DocMDP or UR3) You can set only one signature type
- _putspotcolors() : mixed
- Output Spot Colors Resources.
- _puttruetypeunicode() : mixed
- Adds unicode fonts.<br> Based on PDF Reference 1.3 (section 5)
- _putviewerpreferences() : string
- Output viewer preferences.
- _putXMP() : int
- Put XMP data object and return ID.
- _putxobjects() : mixed
- Output Form XObjects Templates.
- _textstring() : string
- Format a text string for meta information
- _UEvalue() : string
- Compute UE value (used for encryption)
- _Uvalue() : string
- Compute U value (used for encryption)
- addExtGState() : int|void
- Add transparency parameters to the current extgstate
- addHTMLVertSpace() : mixed
- Add vertical spaces if needed.
- adjustCellPadding() : void|array<string|int, mixed>
- Adjust the internal Cell padding array to take account of the line width.
- applyTSA() : string
- NOT YET IMPLEMENTED Request TSA for a timestamp
- checkPageBreak() : bool
- Add page if needed.
- checkPageRegions() : array<string|int, float>
- Check page for no-write regions and adapt current coordinates and page margins if necessary.
- Clip() : mixed
- Set a rectangular clipping area.
- closeHTMLTagHandler() : array<string|int, mixed>
- Process closing tags.
- convertSVGtMatrix() : array<string|int, mixed>
- Convert SVG transformation matrix to PDF.
- drawHTMLTagBorder() : mixed
- Draw an HTML block border and fill
- endSVGElementHandler() : mixed
- Sets the closing SVG element handler function for the XML parser.
- fileExists() : bool
- Avoid multiple calls to an external server to see if a file exists
- fitBlock() : array<string|int, mixed>
- Set the block dimensions accounting for page breaks and page/column fitting
- getAllInternalPageNumberAliases() : array<string|int, mixed>
- Return an array containing all internal page aliases.
- getBorderStartPosition() : array<string|int, mixed>
- Return the starting coordinates to draw an html border
- getBuffer() : string
- Get buffer content.
- getCachedFileContents() : string
- Keeps files in memory, so it doesn't need to downloaded everytime in a loop
- getCellBorder() : string
- Returns the code to draw the cell border
- getCellCode() : string
- 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.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
- getCSSBorderDashStyle() : int
- Returns the border dash style from CSS property
- getCSSBorderStyle() : array<string|int, mixed>
- Returns the border style array from CSS border properties
- getCSSBorderWidth() : int
- Returns the border width from CSS property
- getCSSFontSpacing() : float
- Returns the letter-spacing value from CSS value
- getCSSFontStretching() : float
- Returns the percentage of font stretching from CSS value
- getFontBuffer() : string|false
- Get font buffer content.
- getFontsList() : mixed
- Fill the list of available fonts ($this->fontlist).
- getGDgamma() : mixed
- Get the GD-corrected PNG gamma value from alpha color
- getGraphicVars() : array<string|int, mixed>
- Returns current graphic variables as array.
- getHashForTCPDFtagParams() : string
- Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance.
- getHtmlDomArray() : array<string|int, mixed>
- Returns the HTML DOM array.
- getImageBuffer() : string|false
- Get image buffer content.
- getInternalPageNumberAliases() : array<string|int, mixed>
- Return an array containing variations for the basic page number alias.
- getPageBuffer() : string
- Get page buffer content.
- getRemainingWidth() : float
- Returns the remaining width between the current position and margins.
- getSignatureAppearanceArray() : array<string|int, mixed>
- Get the array that defines the signature appearance (page and rectangle coordinates).
- getSpaceString() : string
- Returns the string used to find spaces
- hyphenateWord() : array<string|int, mixed>
- Returns an array of chars containing soft hyphens.
- ImagePngAlpha() : mixed
- Extract info from a PNG image with alpha channel using the Imagick or GD library.
- inPageBody() : bool
- Check if we are on the page body (excluding page header and footer).
- openHTMLTagHandler() : array<string|int, mixed>
- Process opening tags.
- putHtmlListBullet() : mixed
- Output an HTML list bullet or ordered item symbol
- removeTagNamespace() : mixed
- Return the tag name without the namespace
- replaceBuffer() : mixed
- Replace the buffer content
- replaceChar() : int
- Replace a char if is defined on the current font.
- replaceRightShiftPageNumAliases() : string
- Replace right shift page number aliases with spaces to correct right alignment.
- segSVGContentHandler() : mixed
- Sets the character data handler function for the XML parser.
- setBuffer() : mixed
- Set buffer content (always append data).
- setContentMark() : mixed
- Set start-writing mark on selected page.
- setExtGState() : mixed
- Add an extgstate
- setFontBuffer() : mixed
- Set font buffer content.
- setFontSubBuffer() : mixed
- Set font buffer content.
- setFooter() : mixed
- This method is used to render the page footer.
- setGraphicVars() : mixed
- Set graphic variables.
- setHeader() : mixed
- This method is used to render the page header.
- setImageBuffer() : int
- Set image buffer content.
- setImageSubBuffer() : mixed
- Set image buffer content for a specified sub-key.
- setPageBoxTypes() : mixed
- Set page boxes to be included on page descriptions.
- setPageBuffer() : mixed
- Set page buffer content.
- setPageFormat() : mixed
- Change the format of the current page
- setSVGStyles() : string
- Apply the requested SVG styles (*** TO BE COMPLETED ***)
- setTableHeader() : mixed
- This method is used to render the table header on new page (if any).
- sortBookmarks() : mixed
- Sort bookmarks for page and key.
- startSVGElementHandler() : mixed
- Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
- SVGPath() : array<string|int, mixed>
- Draws an SVG path
- SVGTransform() : mixed
- Apply SVG graphic transformation matrix.
- swapMargins() : mixed
- Swap the left and right margins.
- Transform() : mixed
- Apply graphic transformations.
- unserializeTCPDFtagParameters() : array<string|int, mixed>
- Unserialize parameters to be used with TCPDF tag in HTML code.
Properties
$allowLocalFiles
Whether to allow local file path in image html tags, when prefixed with file://
protected bool $allowLocalFiles =
\false
Tags
$alpha
Alpha mode array.
protected mixed $alpha = array('CA' => 1, 'ca'
=> 1, 'BM' => '/Normal', 'AIS' => \false)
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Tags
$annotation_fonts
List of fonts used on form fields (fontname => fontkey).
protected mixed $annotation_fonts =
array()
Tags
$author
Document author.
protected mixed $author = ''
Tags
$AutoPageBreak
Automatic page breaking.
protected mixed $AutoPageBreak
Tags
$barcode
Barcode to print on page footer (only if set).
protected mixed $barcode = \false
Tags
$bgcolor
Current background color.
protected mixed $bgcolor
Tags
$bMargin
Page break margin.
protected mixed $bMargin
Tags
$booklet
Booklet mode for double-sided pages.
protected mixed $booklet = \false
Tags
$bordermrk
Array used to store positions inside the pages buffer (keys are the page numbers).
protected mixed $bordermrk = array()
Tags
$buffer
Buffer holding in-memory PDF.
protected mixed $buffer
Tags
$bufferlen
Length of the buffer in bytes.
protected mixed $bufferlen = 0
Tags
$cache_file_length
Array used to store the lengths of cache files.
protected mixed $cache_file_length =
array()
Tags
$cell_height_ratio
Default cell height ratio.
protected float $cell_height_ratio =
\K_CELL_HEIGHT_RATIO
Tags
$cell_margin
Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
protected mixed $cell_margin = array('T' => 0, 'R'
=> 0, 'B' => 0, 'L' => 0)
Tags
$cell_padding
Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
protected mixed $cell_padding = array('T' => 0, 'R'
=> 0, 'B' => 0, 'L' => 0)
Tags
$check_page_regions
Boolean value true when page region check is active.
protected mixed $check_page_regions =
\true
Tags
$cleaned_ids
protected static mixed $cleaned_ids = array()
$clMargin
Cell left margin (used by regions).
protected mixed $clMargin
Tags
$cntmrk
Array used to store content positions inside the pages buffer (keys are the page numbers).
protected mixed $cntmrk = array()
Tags
$ColorFlag
Indicates whether fill and text colors are different.
protected mixed $ColorFlag
Tags
$column_start_page
Starting page for columns.
protected mixed $column_start_page =
0
Tags
$columns
Array of column measures (width, space, starting Y position).
protected mixed $columns = array()
Tags
$colxshift
Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.
protected mixed $colxshift = array('x' => 0, 's'
=> array('H' => 0, 'V' => 0), 'p' => array('L' => 0,
'T' => 0, 'R' => 0, 'B' => 0))
Tags
$compress
Compression flag.
protected mixed $compress
Tags
$CoreFonts
Array of standard font names.
protected mixed $CoreFonts
Tags
$creator
Document creator.
protected mixed $creator = ''
Tags
$crMargin
Cell right margin (used by regions).
protected mixed $crMargin
Tags
$CurOrientation
Current page orientation (P = Portrait, L = Landscape).
protected mixed $CurOrientation
Tags
$current_column
Current column number.
protected mixed $current_column =
0
Tags
$CurrentFont
Current font info.
protected mixed $CurrentFont
Tags
$currpagegroup
Current page group number.
protected mixed $currpagegroup =
0
Tags
$custom_xmp
Custom XMP data.
protected mixed $custom_xmp = ''
Tags
$custom_xmp_rdf
Custom XMP RDF data.
protected mixed $custom_xmp_rdf =
''
Tags
$customlistindent
HTML PARSER: custom indent amount for lists. Negative value means disabled.
protected mixed $customlistindent =
-1
Tags
$default_form_prop
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.
protected mixed $default_form_prop =
array('lineWidth' => 1,
'borderStyle' => 'solid', 'fillColor' => array(255, 255,
255), 'strokeColor' => array(128, 128, 128))
Tags
$default_graphic_vars
Array of default graphic settings.
protected mixed $default_graphic_vars =
array()
Tags
$default_monospaced_font
Default monospace font.
protected mixed $default_monospaced_font =
'courier'
Tags
$default_table_columns
Default number of columns for html table.
protected mixed $default_table_columns =
4
Tags
$dests
A dictionary of names and corresponding destinations (Dests key on document Catalog).
protected mixed $dests = array()
Tags
$diffs
Array of encoding differences.
protected mixed $diffs = array()
Tags
$doc_creation_timestamp
Document creation date-time
protected mixed $doc_creation_timestamp
Tags
$doc_modification_timestamp
Document modification date-time
protected mixed $doc_modification_timestamp
Tags
$docinfounicode
If true set the document information dictionary in Unicode.
protected mixed $docinfounicode =
\true
Tags
$dpi
DPI (Dot Per Inch) Document Resolution (do not change).
protected mixed $dpi = 72
Tags
$DrawColor
Commands for drawing color.
protected mixed $DrawColor
Tags
$efnames
Embedded Files Names
protected mixed $efnames = array()
Tags
$embeddedfiles
Array of files to embedd.
protected mixed $embeddedfiles =
array()
Tags
$empty_signature_appearance
Array of empty digital signature appearances.
protected mixed $empty_signature_appearance
= array()
Tags
$emptypagemrk
Array used to store page positions to track empty pages (keys are the page numbers).
protected mixed $emptypagemrk = array()
Tags
$encoding
Default encoding.
protected mixed $encoding = 'UTF-8'
Tags
$encryptdata
Array containing encryption settings.
protected mixed $encryptdata = array()
Tags
$encrypted
IBoolean flag indicating whether document is protected.
protected mixed $encrypted
Tags
$endlinex
End position of the latest inserted line.
protected mixed $endlinex = 0
Tags
$epsmarker
String used to mark the beginning and end of EPS image blocks.
protected mixed $epsmarker = 'x#!#EPS#!#x'
Tags
$extgstates
Array of transparency objects and parameters.
protected mixed $extgstates
Tags
$feps
Epsilon value used for float calculations.
protected mixed $feps = 0.005
Tags
$fgcolor
Current foreground color.
protected mixed $fgcolor
Tags
$fhPt
Height of page format in points.
protected mixed $fhPt
Tags
$file_id
File ID (used on document trailer).
protected mixed $file_id
Tags
$fileContentCache
Cache array for file content
protected array<string|int,
mixed> $fileContentCache =
array()
Tags
$FillColor
Commands for filling color.
protected mixed $FillColor
Tags
$font_obj_ids
Store the font object IDs.
protected mixed $font_obj_ids = array()
Tags
$font_spacing
Increases or decreases the space between characters in a text by the specified amount (tracking).
protected mixed $font_spacing = 0
Tags
$font_stretching
Percentage of character stretching.
protected mixed $font_stretching =
100
Tags
$font_subsetting
Boolean flag: if true enables font subsetting by default.
protected mixed $font_subsetting =
\true
Tags
$FontAscent
Current font ascent (distance between font top and baseline).
protected mixed $FontAscent
Tags
$FontDescent
Current font descent (distance between font bottom and baseline).
protected mixed $FontDescent
Tags
$FontFamily
Current font family.
protected mixed $FontFamily
Tags
$FontFiles
Array of font files.
protected mixed $FontFiles = array()
Tags
$fontkeys
Store the font keys.
protected mixed $fontkeys = array()
Tags
$fontlist
List of available fonts on filesystem.
protected mixed $fontlist = array()
Tags
$fonts
Array of used fonts.
protected mixed $fonts = array()
Tags
$FontSize
Current font size in user unit.
protected mixed $FontSize
Tags
$FontSizePt
Current font size in points.
protected mixed $FontSizePt
Tags
$FontStyle
Current font style.
protected mixed $FontStyle
Tags
$footer_font
Default font used on page footer.
protected array<int,
string|float|null> $footer_font
Tags
$footer_line_color
Color for footer line (RGB array).
protected array<string|int, int>
$footer_line_color =
array(0, 0,
0)
Tags
$footer_margin
Minimum distance between footer and bottom page margin.
protected mixed $footer_margin
Tags
$footer_text_color
Color for footer text (RGB array).
protected array<string|int, int>
$footer_text_color =
array(0, 0,
0)
Tags
$footerlen
Array used to store footer length of each page.
protected mixed $footerlen = array()
Tags
$footerpos
Array used to store footer positions of each page.
protected mixed $footerpos = array()
Tags
$force_srgb
If true force sRGB color profile for all document.
protected mixed $force_srgb = \false
Tags
$form_action
Current form action (used during XHTML rendering).
protected mixed $form_action = ''
Tags
$form_enctype
Current form encryption type (used during XHTML rendering).
protected mixed $form_enctype = 'application/x-www-form-urlencoded'
Tags
$form_mode
Current method to submit forms.
protected mixed $form_mode = 'post'
Tags
$form_obj_id
List of form annotations IDs.
protected mixed $form_obj_id = array()
Tags
$fwPt
Width of page format in points.
protected mixed $fwPt
Tags
$gdgammacache
Cache array for computed GD gamma values.
protected mixed $gdgammacache = array()
Tags
$gradients
Array for storing gradient information.
protected mixed $gradients = array()
Tags
$h
Current height of page in user unit.
protected mixed $h
Tags
$header_font
Default font used on page header.
protected array<int,
string|float|null> $header_font
Tags
$header_line_color
Color for header line (RGB array).
protected array<string|int, int>
$header_line_color =
array(0, 0,
0)
Tags
$header_logo
Header image logo.
protected mixed $header_logo = ''
Tags
$header_logo_width
Width of header image logo in user units.
protected mixed $header_logo_width =
30
Tags
$header_margin
Minimum distance between header and top page margin.
protected mixed $header_margin
Tags
$header_string
String to print on page header after title.
protected mixed $header_string =
''
Tags
$header_text_color
Color for header text (RGB array).
protected array<string|int, int>
$header_text_color =
array(0, 0,
0)
Tags
$header_title
Title to be printed on default page header.
protected mixed $header_title = ''
Tags
$header_xobj_autoreset
If true reset the Header Xobject template at each page
protected mixed $header_xobj_autoreset =
\false
Tags
$header_xobjid
ID of the stored default header template (-1 = not set).
protected mixed $header_xobjid =
\false
Tags
$hPt
Current height of page in points.
protected mixed $hPt
Tags
$HREF
HTML PARSER: array to store current link and rendering styles.
protected mixed $HREF = array()
Tags
$htmlLinkColorArray
Default color for html links.
protected mixed $htmlLinkColorArray =
array(0, 0,
255)
Tags
$htmlLinkFontStyle
Default font style to add to html links.
protected mixed $htmlLinkFontStyle =
'U'
Tags
$htmlvspace
Count the latest inserted vertical spaces on HTML.
protected mixed $htmlvspace = 0
Tags
$imagekeys
Store the image keys.
protected mixed $imagekeys = array()
Tags
$images
Array of used images.
protected mixed $images = array()
Tags
$img_rb_x
The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
protected mixed $img_rb_x
Tags
$img_rb_y
The right-bottom corner Y coordinate of last inserted image.
protected mixed $img_rb_y
Tags
$imgscale
Adjusting factor to convert pixels to user units.
protected mixed $imgscale = 1
Tags
$InFooter
Flag set when processing page footer.
protected mixed $InFooter = \false
Tags
$InHeader
Flag set when processing page header.
protected mixed $InHeader = \false
Tags
$inthead
True when we are printing the thead section on a new page.
protected mixed $inthead = \false
Tags
$intmrk
Array used to store positions inside the pages buffer (keys are the page numbers).
protected mixed $intmrk = array()
Tags
$inxobj
Boolean value true when we are inside an XObject.
protected mixed $inxobj = \false
Tags
$isunicode
Boolean flag set to true when the input text is unicode (require unicode fonts).
protected mixed $isunicode = \false
Tags
$javascript
Javascript code.
protected mixed $javascript = ''
Tags
$jpeg_quality
Set the default JPEG compression quality (1-100).
protected mixed $jpeg_quality
Tags
$js_objects
Javascript objects array.
protected mixed $js_objects = array()
Tags
$k
Scale factor (number of points in user unit).
protected mixed $k
Tags
$keywords
Document keywords.
protected mixed $keywords = ''
Tags
$l
Language templates.
protected mixed $l
Tags
$last_enc_key
Last RC4 key encrypted (cached for optimisation).
protected mixed $last_enc_key
Tags
$last_enc_key_c
Last RC4 computed key.
protected mixed $last_enc_key_c
Tags
$lasth
Height of last cell printed.
protected mixed $lasth
Tags
$LayoutMode
Layout display mode.
protected mixed $LayoutMode
Tags
$linestyleCap
PDF string for CAP value of the last line.
protected mixed $linestyleCap = '0 J'
Tags
$linestyleDash
PDF string for dash value of the last line.
protected mixed $linestyleDash =
'[] 0
d'
Tags
$linestyleJoin
PDF string for join value of the last line.
protected mixed $linestyleJoin =
'0
j'
Tags
$linestyleWidth
PDF string for width value of the last line.
protected mixed $linestyleWidth =
''
Tags
$linethrough
line through state
protected mixed $linethrough
Tags
$LineWidth
Line width in user unit.
protected mixed $LineWidth
Tags
$links
Array of internal links.
protected mixed $links = array()
Tags
$lispacer
Spacer string for LI tags.
protected mixed $lispacer = ''
Tags
$listcount
HTML PARSER: array count list items on nested lists.
protected mixed $listcount = array()
Tags
$listindent
HTML PARSER: indent amount for lists.
protected mixed $listindent = 0
Tags
$listindentlevel
HTML PARSER: current list indententation level.
protected mixed $listindentlevel =
0
Tags
$listnum
HTML PARSER: current list nesting level.
protected mixed $listnum = 0
Tags
$listordered
HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
protected mixed $listordered = array()
Tags
$lisymbol
Symbol used for HTML unordered list items.
protected mixed $lisymbol = ''
Tags
$lMargin
Left margin.
protected mixed $lMargin
Tags
$maxselcol
Maximum page and column selected.
protected mixed $maxselcol = array('page' => 0,
'column' => 0)
Tags
$n
Current object number.
protected mixed $n
Tags
$n_dests
Object ID for Named Destinations
protected mixed $n_dests
Tags
$n_js
Javascript counter.
protected mixed $n_js
Tags
$newline
Boolean flag to indicate if a new line is created.
protected mixed $newline = \true
Tags
$newpagegroup
Array of page numbers were a new page group was started (the page numbers are the keys of the array).
protected mixed $newpagegroup = array()
Tags
$num_columns
Number of colums.
protected mixed $num_columns = 1
Tags
$numfonts
Counts the number of fonts.
protected mixed $numfonts = 0
Tags
$numimages
Counts the number of pages.
protected mixed $numimages = 0
Tags
$numpages
Counts the number of pages.
protected mixed $numpages = 0
Tags
$objcopy
Cloned copy of the current class object.
protected mixed $objcopy
Tags
$offsets
Array of object offsets.
protected mixed $offsets = array()
Tags
$opencell
Boolean flag to indicate if the border of the cell sides that cross the page should be removed.
protected mixed $opencell = \true
Tags
$openMarkedContent
Boolean flag to indicate if marked-content sequence is open.
protected mixed $openMarkedContent =
\false
Tags
$original_lMargin
Original left margin value.
protected mixed $original_lMargin
Tags
$original_rMargin
Original right margin value.
protected mixed $original_rMargin
Tags
$OutlineRoot
Outline root for bookmark.
protected mixed $OutlineRoot
Tags
$outlines
Outlines for bookmark.
protected mixed $outlines = array()
Tags
$overline
Overlining flag.
protected mixed $overline
Tags
$overprint
Overprint mode array.
protected array<string,
bool|int> $overprint = array('OP' => \false,
'op' => \false, 'OPM' => 0)
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Tags
$page
Current page number.
protected mixed $page
Tags
$page_boxes
Define the page boundaries boxes to be set on document.
protected mixed $page_boxes = array('MediaBox',
'CropBox', 'BleedBox', 'TrimBox', 'ArtBox')
Tags
$page_obj_id
ID of page objects.
protected mixed $page_obj_id = array()
Tags
$page_regions
Array of no-write regions.
protected mixed $page_regions = array()
('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right)
Tags
$PageAnnots
Array of Annotations in pages.
protected mixed $PageAnnots = array()
Tags
$PageBreakTrigger
Threshold used to trigger page breaks.
protected mixed $PageBreakTrigger
Tags
$pagedim
Page dimensions.
protected mixed $pagedim = array()
Tags
$pagegroups
Array that contains the number of pages in each page group.
protected mixed $pagegroups = array()
Tags
$pagelen
Array containing page lengths in bytes.
protected mixed $pagelen = array()
Tags
$PageMode
A name object specifying how the document should be displayed when opened.
protected mixed $PageMode
Tags
$pageobjects
Array of object IDs for each page.
protected mixed $pageobjects = array()
Tags
$pageopen
Store the fage status (true when opened, false when closed).
protected mixed $pageopen = array()
Tags
$pages
Array containing pages.
protected mixed $pages = array()
Tags
$pdfa_mode
If true set the document to PDF/A mode.
protected mixed $pdfa_mode = \false
Tags
$pdfa_version
version of PDF/A mode (1 - 3).
protected mixed $pdfa_version = 1
Tags
$pdflayers
Array of PDF layers data.
protected mixed $pdflayers = array()
Tags
$pdfunit
Default unit of measure for document.
protected mixed $pdfunit = 'mm'
Tags
$PDFVersion
PDF version.
protected mixed $PDFVersion = '1.7'
Tags
$premode
Boolean flag to indicate if we are inside a PRE tag.
protected mixed $premode = \false
Tags
$print_footer
Boolean flag to print/hide page footer.
protected mixed $print_footer = \true
Tags
$print_header
Boolean flag to print/hide page header.
protected mixed $print_header = \true
Tags
$radio_groups
List of radio group objects IDs.
protected mixed $radio_groups = array()
Tags
$radiobutton_groups
List of radio buttons parent objects.
protected mixed $radiobutton_groups =
array()
Tags
$rasterize_vector_images
Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
protected mixed $rasterize_vector_images =
\false
Tags
$re_space
Array of $re_spaces parts.
protected mixed $re_space = array('p' =>
'[^\\S\\xa0]', 'm' => '')
Tags
$re_spaces
Regular expression used to find blank characters (required for word-wrapping).
protected mixed $re_spaces = '/[^\\S\\xa0]/'
Tags
$rMargin
Right margin.
protected mixed $rMargin
Tags
$rtl
Boolean flag to indicate if the document language is Right-To-Left.
protected mixed $rtl = \false
Tags
$sig_obj_id
Digital signature object ID.
protected mixed $sig_obj_id = 0
Tags
$sign
Boolean flag to enable document digital signature.
protected mixed $sign = \false
Tags
$signature_appearance
Data for digital signature appearance.
protected mixed $signature_appearance =
array('page'
=> 1, 'rect' => '0 0 0 0')
Tags
$signature_data
Digital signature data.
protected mixed $signature_data =
array()
Tags
$signature_max_length
Digital signature max length.
protected mixed $signature_max_length =
11742
Tags
$spot_colors
Array of Spot colors.
protected mixed $spot_colors = array()
Tags
$start_transaction_page
Store page number when startTransaction() is called.
protected mixed $start_transaction_page =
0
Tags
$start_transaction_y
Store Y position when startTransaction() is called.
protected mixed $start_transaction_y =
0
Tags
$starting_page_number
Starting page number.
protected mixed $starting_page_number =
1
Tags
$state
Current document state.
protected mixed $state
Tags
$strokecolor
Current stroke color.
protected mixed $strokecolor
Tags
$subject
Document subject.
protected mixed $subject = ''
Tags
$svg_tag_depth
Depth of the svg tag, to keep track if the svg tag is a subtag or the root tag.
protected mixed $svg_tag_depth =
0
Tags
$svgclipid
ID of last SVG clipPath.
protected mixed $svgclipid = 0
Tags
$svgclipmode
Boolean value true when in SVG clipPath tag.
protected mixed $svgclipmode = \false
Tags
$svgclippaths
Array of SVG clipPath commands.
protected mixed $svgclippaths = array()
Tags
$svgcliptm
Array of SVG clipPath tranformation matrix.
protected mixed $svgcliptm = array()
Tags
$svgdefs
Array of SVG defs.
protected mixed $svgdefs = array()
Tags
$svgdefsmode
Boolean value true when in SVG defs group.
protected mixed $svgdefsmode = \false
Tags
$svgdir
Directory used for the last SVG image.
protected mixed $svgdir = ''
Tags
$svggradientid
ID of last SVG gradient.
protected mixed $svggradientid =
0
Tags
$svggradients
Array of SVG gradients.
protected mixed $svggradients = array()
Tags
$svgstyles
Array of SVG properties.
protected mixed $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)))
Tags
$svgtext
SVG text.
protected mixed $svgtext = ''
Tags
$svgtextmode
SVG text properties.
protected mixed $svgtextmode = array()
Tags
$svgunit
Deafult unit of measure for SVG.
protected mixed $svgunit = 'px'
Tags
$tagvspaces
Array used for custom vertical spaces for HTML tags.
protected mixed $tagvspaces = array()
Tags
$tcpdflink
If true print TCPDF meta link.
protected mixed $tcpdflink = \true
Tags
$tempfontsize
Temporary font size in points.
protected mixed $tempfontsize = 10
Tags
$TextColor
Commands for text color.
protected mixed $TextColor
Tags
$textindent
Text indentation value (used for text-indent CSS attribute).
protected mixed $textindent = 0
Tags
$textrendermode
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.
protected mixed $textrendermode =
0
Tags
$textstrokewidth
Text stroke width in doc units.
protected mixed $textstrokewidth =
0
Tags
$thead
Table header content to be repeated on each new page.
protected mixed $thead = ''
Tags
$theadMargins
Margins used for table header.
protected mixed $theadMargins = array()
Tags
$title
Document title.
protected mixed $title = ''
Tags
$tMargin
Top margin.
protected mixed $tMargin
Tags
$tmprtl
Boolean flag used to force RTL or LTR string direction.
protected mixed $tmprtl = \false
Tags
$tocpage
Boolean flag true when we are on TOC (Table Of Content) page.
protected mixed $tocpage = \false
Tags
$transfmatrix
Array of transformation matrix.
protected mixed $transfmatrix = array()
Tags
$transfmatrix_key
Current key for transformation matrix.
protected mixed $transfmatrix_key =
0
Tags
$transfmrk
Array used to store positions of graphics transformation blocks inside the page buffer.
protected mixed $transfmrk = array()
keys are the page numbers
Tags
$tsa_data
Timestamping data.
protected mixed $tsa_data = array()
Tags
$tsa_timestamp
Boolean flag to enable document timestamping with TSA.
protected mixed $tsa_timestamp =
\false
Tags
$txtshadow
Text shadow data array.
protected mixed $txtshadow = array('enabled' =>
\false, 'depth_w' => 0, 'depth_h' => 0, 'color' => \false,
'opacity' => 1, 'blend_mode' => 'Normal')
Tags
$underline
Underlining flag.
protected mixed $underline
Tags
$ur
Array with additional document-wide usage rights for the document.
protected mixed $ur = array()
Tags
$viewer_preferences
PDF viewer preferences.
protected mixed $viewer_preferences
Tags
$w
Current width of page in user unit.
protected mixed $w
Tags
$wPt
Current width of page in points.
protected mixed $wPt
Tags
$x
Current horizontal position in user unit for cell positioning.
protected mixed $x
Tags
$xobjects
Array of XObjects.
protected mixed $xobjects = array()
Tags
$xobjid
Current XObject ID.
protected mixed $xobjid = ''
Tags
$y
Current vertical position in user unit for cell positioning.
protected mixed $y
Tags
$ZoomMode
Zoom display mode.
protected mixed $ZoomMode
Tags
Methods
__construct()
This is the class constructor.
public __construct([string $orientation
= 'P'
][,
string $unit
= 'mm'
][,
mixed $format
= 'A4'
][,
bool $unicode
= true
][,
string $encoding
= 'UTF-8'
][,
bool $diskcache
= false
][,
false|int $pdfa
= false
]) : mixed
It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
Parameters
- $orientation : string = 'P'
-
page orientation. Possible values are (case insensitive):
- P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
- $unit : string = 'mm'
-
User measure unit. Possible values are:
- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. - $format : mixed = 'A4'
-
The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- $unicode : bool = true
-
TRUE means that the input text is unicode (default = true)
- $encoding : string = 'UTF-8'
-
Charset encoding (used only when converting back html entities); default is UTF-8.
- $diskcache : bool = false
-
DEPRECATED FEATURE
- $pdfa : false|int = false
-
If not false, set the document to PDF/A mode and the good version (1 or 3).
Tags
Return values
mixed —__destruct()
Default destructor.
public __destruct()
: mixed
Tags
Return values
mixed —_destroy()
Unset all class variables except the following critical variables.
public _destroy([bool $destroyall
= false
][,
bool $preserve_objcopy
= false
]) : mixed
Parameters
- $destroyall : bool = false
-
if true destroys all class variables, otherwise preserves critical variables.
- $preserve_objcopy : bool = false
-
if true preserves the objcopy variable
Tags
Return values
mixed —_putshaders()
Output gradient shaders.
public _putshaders()
: mixed
Tags
Return values
mixed —AcceptPageBreak()
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
public AcceptPageBreak()
: bool
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
Return values
bool —addEmptySignatureAppearance()
Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
public addEmptySignatureAppearance(float $x,
float $y,
float $w,
float $h[,
int $page
= -1
][,
string $name
= ''
]) : mixed
Parameters
- $x : float
-
Abscissa of the upper-left corner.
- $y : float
-
Ordinate of the upper-left corner.
- $w : float
-
Width of the signature area.
- $h : float
-
Height of the signature area.
- $page : int = -1
-
option page number (if < 0 the current page is used).
- $name : string = ''
-
Name of the signature.
Tags
Return values
mixed —AddFont()
Imports a TrueType, Type1, core, or CID0 font and makes it available.
public AddFont(string $family[,
string $style
= ''
][,
string $fontfile
= ''
][,
mixed $subset
= 'default'
]) : array<string|int,
mixed>|false
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.
Parameters
- $family : string
-
Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
- $style : string = ''
-
Font style. Possible values are (case insensitive):
- empty string: regular (default)
- B: bold
- I: italic
- BI or IB: bold italic
- $fontfile : string = ''
-
The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
- $subset : mixed = 'default'
-
if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
Tags
Return values
array<string|int, mixed>|false —array containing the font data, or false in case of error.
addHtmlLink()
Output anchor link.
public addHtmlLink(string $url,
string $name[,
bool $fill
= false
][,
bool $firstline
= false
][,
array<string|int,
mixed>|null $color
= null
][,
string $style
= -1
][,
bool $firstblock
= false
]) : int
Parameters
- $url : string
-
link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
- $name : string
-
link name
- $fill : bool = false
-
Indicates if the cell background must be painted (true) or transparent (false).
- $firstline : bool = false
-
if true prints only the first line and return the remaining string.
- $color : array<string|int, mixed>|null = null
-
array of RGB text color
- $style : string = -1
-
font style (U, D, B, I)
- $firstblock : bool = false
-
if true the string is the starting of a line.
Tags
Return values
int —the number of cells used or the remaining text if $firstline = true;
addHTMLTOC()
Output a Table Of Content Index (TOC) using HTML templates.
public addHTMLTOC([int|null $page
= null
][,
string $toc_name
= 'TOC'
][,
array<string|int,
mixed> $templates
= array()
][,
bool $correct_align
= true
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ]) :
mixed
This method must be called after all Bookmarks were set. 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.
Parameters
- $page : int|null = null
-
page number where this TOC should be inserted (leave empty for current page).
- $toc_name : string = 'TOC'
-
name to use for TOC bookmark.
- $templates : array<string|int, mixed> = array()
-
array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.
- $correct_align : bool = true
-
if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
- $style : string = ''
-
Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
- $color : array<string|int, mixed> = array(0, 0, 0)
-
RGB color array for title (values from 0 to 255).
Tags
Return values
mixed —addJavascriptObject()
Adds a javascript object and return object ID
public addJavascriptObject(string $script[,
bool $onload
= false
]) : int
Parameters
- $script : string
-
Javascript code
- $onload : bool = false
-
if true executes this object when opening the document
Tags
Return values
int —internal object ID
AddLink()
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br /> The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
public AddLink()
: mixed
Tags
Return values
mixed —AddPage()
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).
public AddPage([string $orientation
= ''
][,
mixed $format
= ''
][,
bool $keepmargins
= false
][,
bool $tocpage
= false
]) : mixed
The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
Parameters
- $orientation : string = ''
-
page orientation. Possible values are (case insensitive):
- P or PORTRAIT (default)
- L or LANDSCAPE
- $format : mixed = ''
-
The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- $keepmargins : bool = false
-
if true overwrites the default page margins with the current margins
- $tocpage : bool = false
-
if true set the tocpage state to true (the added page will be used to display Table Of Content).
Tags
Return values
mixed —addPageRegion()
Add a single no-write region on selected page.
public addPageRegion(array<string|int,
mixed> $region)
: mixed
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.
Parameters
- $region : array<string|int, mixed>
-
array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right).
Tags
Return values
mixed —AddSpotColor()
Defines a new spot color.
public AddSpotColor(string $name,
float $c,
float $m,
float $y,
float $k)
: mixed
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.
Parameters
- $name : string
-
Full name of the spot color.
- $c : float
-
Cyan color for CMYK. Value between 0 and 100.
- $m : float
-
Magenta color for CMYK. Value between 0 and 100.
- $y : float
-
Yellow color for CMYK. Value between 0 and 100.
- $k : float
-
Key (Black) color for CMYK. Value between 0 and 100.
Tags
Return values
mixed —addTOC()
Output a Table of Content Index (TOC).
public addTOC([int|null $page
= null
][,
string $numbersfont
= ''
][,
string $filler
= '.'
][,
string $toc_name
= 'TOC'
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ]) :
mixed
This method must be called after all Bookmarks were set. 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.
Parameters
- $page : int|null = null
-
page number where this TOC should be inserted (leave empty for current page).
- $numbersfont : string = ''
-
set the font for page numbers (please use monospaced font for better alignment).
- $filler : string = '.'
-
string used to fill the space between text and page number.
- $toc_name : string = 'TOC'
-
name to use for TOC bookmark.
- $style : string = ''
-
Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
- $color : array<string|int, mixed> = array(0, 0, 0)
-
RGB color array for bookmark title (values from 0 to 255).
Tags
Return values
mixed —addTOCPage()
Adds a new TOC (Table Of Content) page to the document.
public addTOCPage([string $orientation
= ''
][,
mixed $format
= ''
][,
bool $keepmargins
= false
]) : mixed
Parameters
- $orientation : string = ''
-
page orientation.
- $format : mixed = ''
-
The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- $keepmargins : bool = false
-
if true overwrites the default page margins with the current margins
Tags
Return values
mixed —Annotation()
Puts a markup annotation on a rectangular area of the page.
public Annotation(float $x,
float $y,
float $w,
float $h,
string $text[,
array<string|int,
mixed> $opt
= array('Subtype'
=> 'Text') ], int $spaces)
: mixed
!!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
Parameters
- $x : float
-
Abscissa of the upper-left corner of the rectangle
- $y : float
-
Ordinate of the upper-left corner of the rectangle
- $w : float
-
Width of the rectangle
- $h : float
-
Height of the rectangle
- $text : string
-
annotation text or alternate content
- $opt : array<string|int, mixed> = array('Subtype' => 'Text')
-
array of options (see section 8.4 of PDF reference 1.7).
- $spaces : int
-
number of spaces on the text to link
Tags
Return values
mixed —Arrow()
Draws a grahic arrow.
public Arrow(float $x0,
float $y0,
float $x1,
float $y1,
int $head_style[,
float $arm_size
= 5
][,
int $arm_angle
= 15
]) : mixed
Parameters
- $x0 : float
-
Abscissa of first point.
- $y0 : float
-
Ordinate of first point.
- $x1 : float
-
Abscissa of second point.
- $y1 : float
-
Ordinate of second point.
- $head_style : int
-
(0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
- $arm_size : float = 5
-
length of arrowhead arms
- $arm_angle : int = 15
-
angle between an arm and the shaft
Tags
Return values
mixed —Bookmark()
Adds a bookmark.
public Bookmark(string $txt,
int $level[,
float $y
= -1
][,
int|string $page
= ''
][,
string $style
= ''
][,
array<string|int,
mixed> $color
= array(0, 0,
0) ][,
float $x
= -1
][,
mixed $link
= ''
]) : mixed
Parameters
- $txt : string
-
Bookmark description.
- $level : int
-
Bookmark level (minimum value is 0).
- $y : float = -1
-
Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
- $page : int|string = ''
-
Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
- $style : string = ''
-
Font style: B = Bold, I = Italic, BI = Bold + Italic.
- $color : array<string|int, mixed> = array(0, 0, 0)
-
RGB color array (values from 0 to 255).
- $x : float = -1
-
X position in user units of the bookmark on the selected page (default = -1 = current position;).
- $link : mixed = ''
-
URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).
Tags
Return values
mixed —Button()
Creates a button field
public Button(string $name,
int $w,
int $h,
string $caption,
mixed $action[,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed
Parameters
- $name : string
-
field name
- $w : int
-
width
- $h : int
-
height
- $caption : string
-
caption.
- $action : mixed
-
action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
- $prop : array<string|int, mixed> = array()
-
javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- $opt : array<string|int, mixed> = array()
-
annotation parameters. Possible values are described on official PDF32000_2008 reference.
- $x : float|null = null
-
Abscissa of the upper-left corner of the rectangle
- $y : float|null = null
-
Ordinate of the upper-left corner of the rectangle
- $js : bool = false
-
if true put the field using JavaScript (requires Acrobat Writer to be rendered).
Tags
Return values
mixed —Cell()
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.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
public Cell(float $w,
float $h[,
string $txt
= ''
], mixed $border,
int $ln[,
string $align
= ''
][,
bool $fill
= false
][,
mixed $link
= ''
], int $stretch[,
bool $ignore_min_height
= false
][,
string $calign
= 'T'
][,
string $valign
= 'M'
]) : mixed
Parameters
- $w : float
-
Cell width. If 0, the cell extends up to the right margin.
- $h : float
-
Cell height. Default value: 0.
- $txt : string = ''
-
String to print. Default value: empty string.
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- $ln : int
-
Indicates where the current position should go after the call. Possible values are:
- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
- $align : string = ''
-
Allows to center or align the text. Possible values are:
- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
- $fill : bool = false
-
Indicates if the cell background must be painted (true) or transparent (false).
- $link : mixed = ''
-
URL or identifier returned by AddLink().
- $stretch : int
-
font stretch mode:
- 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
- $ignore_min_height : bool = false
-
if true ignore automatic minimum height value.
- $calign : string = 'T'
-
cell vertical alignment relative to the specified Y value. Possible values are:
- T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
- $valign : string = 'M'
-
text vertical alignment inside the cell. Possible values are:
- T : top
- C : center
- B : bottom
Tags
Return values
mixed —CheckBox()
Creates a CheckBox field
public CheckBox(string $name,
int $w[,
bool $checked
= false
][,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
string $onvalue
= 'Yes'
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed
Parameters
- $name : string
-
field name
- $w : int
-
width
- $checked : bool = false
-
define the initial state.
- $prop : array<string|int, mixed> = array()
-
javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- $opt : array<string|int, mixed> = array()
-
annotation parameters. Possible values are described on official PDF32000_2008 reference.
- $onvalue : string = 'Yes'
-
value to be returned if selected.
- $x : float|null = null
-
Abscissa of the upper-left corner of the rectangle
- $y : float|null = null
-
Ordinate of the upper-left corner of the rectangle
- $js : bool = false
-
if true put the field using JavaScript (requires Acrobat Writer to be rendered).
Tags
Return values
mixed —Circle()
Draws a circle.
public Circle(float $x0,
float $y0,
float $r,
float $angstr[,
float $angend
= 360
][,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
][,
int $nc
= 2
]) : mixed
A circle is formed from n Bezier curves.
Parameters
- $x0 : float
-
Abscissa of center point.
- $y0 : float
-
Ordinate of center point.
- $r : float
-
Radius.
- $angstr : float
-
Angle start of draw line. Default value: 0.
- $angend : float = 360
-
Angle finish of draw line. Default value: 360.
- $style : string = ''
-
Style of rendering. See the getPathPaintOperator() function for more information.
- $line_style : array<string|int, mixed> = array()
-
Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).
- $fill_color : array<string|int, mixed> = array()
-
Fill color. Format: array(red, green, blue). Default value: default color (empty array).
- $nc : int = 2
-
Number of curves used to draw a 90 degrees portion of circle.
Tags
Return values
mixed —Close()
Terminates the PDF document.
public Close()
: mixed
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
Return values
mixed —colorRegistrationBar()
Paints color transition registration bars
public colorRegistrationBar(float $x,
float $y,
float $w,
float $h[,
bool $transition
= true
][,
bool $vertical
= false
][,
string $colors
= 'A,R,G,B,C,M,Y,K'
]) : mixed
Parameters
- $x : float
-
abscissa of the top left corner of the rectangle.
- $y : float
-
ordinate of the top left corner of the rectangle.
- $w : float
-
width of the rectangle.
- $h : float
-
height of the rectangle.
- $transition : bool = true
-
if true prints tcolor transitions to white.
- $vertical : bool = false
-
if true prints bar vertically.
- $colors : string = 'A,R,G,B,C,M,Y,K'
-
colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.
Tags
Return values
mixed —ComboBox()
Creates a Combo-box field
public ComboBox(string $name,
int $w,
int $h,
array<string|int,
mixed> $values[,
array<string|int,
mixed> $prop
= array()
][,
array<string|int,
mixed> $opt
= array()
][,
float|null $x
= null
][,
float|null $y
= null
][,
bool $js
= false
]) : mixed
Parameters
- $name : string
-
field name
- $w : int
-
width
- $h : int
-
height
- $values : array<string|int, mixed>
-
array containing the list of values.
- $prop : array<string|int, mixed> = array()
-
javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- $opt : array<string|int, mixed> = array()
-
annotation parameters. Possible values are described on official PDF32000_2008 reference.
- $x : float|null = null
-
Abscissa of the upper-left corner of the rectangle
- $y : float|null = null
-
Ordinate of the upper-left corner of the rectangle
- $js : bool = false
-
if true put the field using JavaScript (requires Acrobat Writer to be rendered).
Tags
Return values
mixed —commitTransaction()
Delete the copy of the current TCPDF object used for undo operation.
public commitTransaction()
: mixed
Tags
Return values
mixed —CoonsPatchMesh()
Paints a coons patch mesh.
public CoonsPatchMesh(float $x,
float $y,
float $w,
float $h[,
array<string|int,
mixed> $col1
= array()
][,
array<string|int,
mixed> $col2
= array()
][,
array<string|int,
mixed> $col3
= array()
][,
array<string|int,
mixed> $col4
= array()
][,
array<string|int,
mixed> $coords
= array(0.0, 0.0,
0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0.67, 1.0, 1.0,
0.67, 1.0, 0.33, 1.0, 0.0, 1.0, 0.0, 0.67, 0.0, 0.33)
], array<string|int,
mixed> $coords_min[,
array<string|int,
mixed> $coords_max
= 1
][,
bool $antialias
= false
]) : mixed
Parameters
- $x : float
-
abscissa of the top left corner of the rectangle.
- $y : float
-
ordinate of the top left corner of the rectangle.
- $w : float
-
width of the rectangle.
- $h : float
-
height of the rectangle.
- $col1 : array<string|int, mixed> = array()
-
first color (lower left corner) (RGB components).
- $col2 : array<string|int, mixed> = array()
-
second color (lower right corner) (RGB components).
- $col3 : array<string|int, mixed> = array()
-
third color (upper right corner) (RGB components).
- $col4 : array<string|int, mixed> = array()
-
fourth color (upper left corner) (RGB components).
- $coords : array<string|int, mixed> = array(0.0, 0.0, 0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0.67, 1.0, 1.0, 0.67, 1.0, 0.33, 1.0, 0.0, 1.0, 0.0, 0.67, 0.0, 0.33)
-
- for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).
- for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches
- $coords_min : array<string|int, mixed>
-
minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
- $coords_max : array<string|int, mixed> = 1
-
maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
- $antialias : bool = false
-
A flag indicating whether to filter the shading function to prevent aliasing artifacts.
Tags
Return values
mixed —copyPage()
Clone the specified page to a new page.
public copyPage(int $page)
: bool
Parameters
- $page : int
-
number of page to copy (0 = current page)
Tags
Return values
bool —true in case of success, false in case of error.
cropMark()
Paints crop marks.
public cropMark(float $x,
float $y,
float $w,
float $h[,
string $type
= 'T,R,B,L'
][,
array<string|int,
mixed> $color
= array(100, 100,
100, 100, 'All') ])
: mixed
Parameters
- $x : float
-
abscissa of the crop mark center.
- $y : float
-
ordinate of the crop mark center.
- $w : float
-
width of the crop mark.
- $h : float
-
height of the crop mark.
- $type : string = 'T,R,B,L'
-
type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT.
- $color : array<string|int, mixed> = array(100, 100, 100, 100, 'All')
-
crop mark color (default spot registration color).
Tags
Return values
mixed —Curve()
Draws a Bezier curve.
public Curve(float $x0,
float $y0,
float $x1,
float $y1,
float $x2,
float $y2,
float $x3,
float $y3[,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
]) : mixed
The Bezier curve is a tangent to the line between the control points at either end of the curve.
Parameters
- $x0 : float
-
Abscissa of start point.
- $y0 : float
-
Ordinate of start point.
- $x1 : float
-
Abscissa of control point 1.
- $y1 : float
-
Ordinate of control point 1.
- $x2 : float
-
Abscissa of control point 2.
- $y2 : float
-
Ordinate of control point 2.
- $x3 : float
-
Abscissa of end point.
- $y3 : float
-
Ordinate of end point.
- $style : string = ''
-
Style of rendering. See the getPathPaintOperator() function for more information.
- $line_style : array<string|int, mixed> = array()
-
Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
- $fill_color : array<string|int, mixed> = array()
-
Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
Tags
Return values
mixed —deletePage()
Remove the specified page.
public deletePage(int $page)
: bool
Parameters
- $page : int
-
page to remove
Tags
Return values
bool —true in case of success, false in case of error.
Ellipse()
Draws an ellipse.
public Ellipse(float $x0,
float $y0,
float $rx,
float $ry,
float $angle,
float $astart[,
float $afinish
= 360
][,
string $style
= ''
][,
array<string|int,
mixed> $line_style
= array()
][,
array<string|int,
mixed> $fill_color
= array()
][,
int $nc
= 2
]) : mixed
An ellipse is formed from n Bezier curves.
Parameters
- $x0 : float
-
Abscissa of center point.
- $y0 : float
-
Ordinate of center point.
- $rx : float
-
Horizontal radius.
- $ry : float
-
Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
- $angle : float
-
Angle oriented (anti-clockwise). Default value: 0.
- $astart : float
-
Angle start of draw line. Default value: 0.
- $afinish : float = 360
-
Angle finish of draw line. Default value: 360.
- $style : string = ''
-
Style of rendering. See the getPathPaintOperator() function for more information.
- $line_style : array<string|int, mixed> = array()
-
Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).
- $fill_color : array<string|int, mixed> = array()
-
Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
- $nc : int = 2
-
Number of curves used to draw a 90 degrees portion of ellipse.
Tags
Return values
mixed —endLayer()
End the current PDF layer.
public endLayer()
: mixed
Tags
Return values
mixed —endPage()
Terminate the current page
public endPage([bool $tocpage
= false
]) : mixed
Parameters
- $tocpage : bool = false
-
if true set the tocpage state to false (end the page used to display Table Of Content).
Tags
Return values
mixed —endTemplate()
End the current XObject Template started with startTemplate() and restore the previous graphic state.
public endTemplate()
: string|false
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
Return values
string|false —the XObject Template ID in case of success or false in case of error.
endTOCPage()
Terminate the current TOC (Table Of Content) page
public endTOCPage()
: mixed
Tags
Return values
mixed —Error()
Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
public Error(string $msg)
: mixed
Parameters
- $msg : string
-
The error message
Tags
Return values
mixed —fixHTMLCode()
Cleanup HTML code (requires HTML Tidy library).
public fixHTMLCode(string $html[,
string $default_css
= ''
][,
array<string|int,
mixed>|null $tagvs
= null
][,
array<string|int,
mixed>|null $tidy_options
= null
]) : string
Parameters
- $html : string
-
htmlcode to fix
- $default_css : string = ''
-
CSS commands to add
- $tagvs : array<string|int, mixed>|null = null
-
parameters for setHtmlVSpace method
- $tidy_options : array<string|int, mixed>|null = null
-
options for tidy_parse_string function
Tags
Return values
string —XHTML code cleaned up
Footer()
This method is used to render the page footer.
public Footer()
: mixed
It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags
Return values
mixed —getAbsFontMeasure()
Convert a relative font measure into absolute value.
public getAbsFontMeasure(int $s)
: float
Parameters
- $s : int
-
Font measure.
Tags
Return values
float —Absolute measure.
GetAbsX()
Returns the absolute X value of current position.
public GetAbsX()
: float
Tags
Return values
float —getAliasNbPages()
Returns the string alias used for the total number of pages.
public getAliasNbPages()
: string
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in the document.
Tags
Return values
string —getAliasNumPage()
Returns the string alias used for the page number.
public getAliasNumPage()
: string
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number.
Tags
Return values
string —getAliasRightShift()
Returns the string alias used right align page numbers.
public getAliasRightShift()
: string
If the current font is unicode type, the returned string wil contain an additional open curly brace.
Tags
Return values
string —getAllSpotColors()
Returns the array of spot colors.
public getAllSpotColors()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —Spot colors array.
getAlpha()
Get the alpha mode array (CA, ca, BM, AIS).
public getAlpha()
: array<string,
bool|string>
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Tags
Return values
array<string, bool|string> —GetArrStringWidth()
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>
public GetArrStringWidth(array<string|int,
mixed> $sa[,
string $fontname
= ''
][,
string $fontstyle
= ''
], float $fontsize[,
bool $getarray
= false
]) : array<string|int,
float>|float
Parameters
- $sa : array<string|int, mixed>
-
The array of chars whose total length is to be computed
- $fontname : string = ''
-
Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
- $fontstyle : string = ''
-
Font style. Possible values are (case insensitive):
- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line through
- O: overline
- $fontsize : float
-
Font size in points. The default value is the current size.
- $getarray : bool = false
-
if true returns an array of characters widths, if false returns the total length.
Tags
Return values
array<string|int, float>|float —total string length or array of characted widths
getAutoPageBreak()
Return the auto-page-break mode (true or false).
public getAutoPageBreak()
: bool
Tags
Return values
bool —auto-page-break mode
getBarcode()
Get current barcode.
public getBarcode()
: string
Tags
Return values
string —getBreakMargin()
Returns the page break margin.
public getBreakMargin([int|null $pagenum
= null
]) : int|float
Parameters
- $pagenum : int|null = null
-
page number (empty = current page)
Tags
Return values
int|float —page break margin.
getCellHeight()
Return the cell height
public getCellHeight(int $fontsize[,
bool $padding
= TRUE
]) : float
Parameters
- $fontsize : int
-
Font size in internal units
- $padding : bool = TRUE
-
If true add cell padding
Tags
Return values
float —getCellHeightRatio()
return the height of cell repect font height.
public getCellHeightRatio()
: float
Tags
Return values
float —getCellMargins()
Get the internal Cell margin array.
public getCellMargins()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —of margin values
getCellPaddings()
Get the internal Cell padding array.
public getCellPaddings()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —of padding values
getCharBBox()
Returns the glyph bounding box of the specified character in the current font in user units.
public getCharBBox(int $char)
: false|array<string|int,
mixed>
Parameters
- $char : int
-
Input character code.
Tags
Return values
false|array<string|int, mixed> —array(xMin, yMin, xMax, yMax) or FALSE if not defined.
GetCharWidth()
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
public GetCharWidth(int $char[,
bool $notlast
= true
]) : float
Parameters
- $char : int
-
The char code whose length is to be returned
- $notlast : bool = true
-
If false ignore the font-spacing.
Tags
Return values
float —char width
getColumn()
Return the current column number
public getColumn()
: int
Tags
Return values
int —current column number
getCSSBorderMargin()
Get the border-spacing from CSS attribute.
public getCSSBorderMargin(string $cssbspace,
float $width)
: array<string|int,
mixed>
Parameters
- $cssbspace : string
-
border-spacing CSS properties
- $width : float
-
width of the containing element
Tags
Return values
array<string|int, mixed> —of border spacings
getCSSMargin()
Get the internal Cell margin from CSS attribute.
public getCSSMargin(string $cssmargin,
float $width)
: array<string|int,
mixed>
Parameters
- $cssmargin : string
-
margin properties
- $width : float
-
width of the containing element
Tags
Return values
array<string|int, mixed> —of cell margins
getCSSPadding()
Get the internal Cell padding from CSS attribute.
public getCSSPadding(string $csspadding,
float $width)
: array<string|int,
mixed>
Parameters
- $csspadding : string
-
padding properties
- $width : float
-
width of the containing element
Tags
Return values
array<string|int, mixed> —of cell paddings
getDestination()
Return the Named Destination array.
public getDestination()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —Named Destination array.
getDocCreationTimestamp()
Returns document creation timestamp in seconds.
public getDocCreationTimestamp()
: int
Tags
Return values
int —Creation timestamp in seconds.
getDocModificationTimestamp()
Returns document modification timestamp in seconds.
public getDocModificationTimestamp()
: int
Tags
Return values
int —Modfication timestamp in seconds.
getFontAscent()
Return the font ascent value.
public getFontAscent(string $font[,
string $style
= ''
], float $size)
: int
Parameters
- $font : string
-
font name
- $style : string = ''
-
font style
- $size : float
-
The size (in points)
Tags
Return values
int —font ascent
getFontBBox()
Returns the bounding box of the current font in user units.
public getFontBBox()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —getFontDescent()
Return the font descent value
public getFontDescent(string $font[,
string $style
= ''
], float $size)
: int
Parameters
- $font : string
-
font name
- $style : string = ''
-
font style
- $size : float
-
The size (in points)
Tags
Return values
int —font descent
getFontFamily()
Returns the current font family name.
public getFontFamily()
: string
Tags
Return values
string —current font family name
getFontFamilyName()
Return normalized font name
public getFontFamilyName(string $fontfamily)
: string
Parameters
- $fontfamily : string
-
property string containing font family names
Tags
Return values
string —normalized font name
getFontSize()
Returns the current font size.
public getFontSize()
: float
Tags
Return values
float —current font size
getFontSizePt()
Returns the current font size in points unit.
public getFontSizePt()
: int
Tags
Return values
int —current font size in points unit
getFontSpacing()
Get the amount to increase or decrease the space between characters in a text.
public getFontSpacing()
: int
Tags
Return values
int —font spacing (tracking) value
getFontStretching()
Get the percentage of character stretching.
public getFontStretching()
: float
Tags
Return values
float —stretching value
getFontStyle()
Returns the current font style.
public getFontStyle()
: string
Tags
Return values
string —current font style
getFontSubsetting()
Return the default option for font subsetting.
public getFontSubsetting()
: bool
Tags
Return values
bool —default font subsetting state.
getFooterFont()
Get Footer font.
public getFooterFont()
: array<int,
string|float|null>
Tags
Return values
array<int, string|float|null> —Array describing the basic font parameters: (family, style, size).
getFooterMargin()
Returns footer margin in user units.
public getFooterMargin()
: float
Tags
Return values
float —getFormDefaultProp()
Return the default properties for form fields.
public getFormDefaultProp()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —$prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
getGroupPageNo()
Return the current page in the group.
public getGroupPageNo()
: int
Tags
Return values
int —current page in the group
getGroupPageNoFormatted()
Returns the current group page number formatted as a string.
public getGroupPageNoFormatted()
: mixed
Tags
Return values
mixed —getHeaderData()
Returns header data: <ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul>
public getHeaderData()
: array<string,
mixed>
Tags
Return values
array<string, mixed> —getHeaderFont()
Get header font.
public getHeaderFont()
: array<int,
string|float|null>
Tags
Return values
array<int, string|float|null> —Array describing the basic font parameters: (family, style, size).
getHeaderMargin()
Returns header margin in user units.
public getHeaderMargin()
: float
Tags
Return values
float —getHTMLFontUnits()
Convert HTML string containing font size value to points
public getHTMLFontUnits(string $val[,
float $refsize
= 12
][,
float $parent_size
= 12
][,
string $defaultunit
= 'pt'
]) : float
Parameters
- $val : string
-
String containing font size value and unit.
- $refsize : float = 12
-
Reference font size in points.
- $parent_size : float = 12
-
Parent font size in points.
- $defaultunit : string = 'pt'
-
Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
Tags
Return values
float —value in points
getHTMLUnitToUnits()
Convert HTML string containing value and unit of measure to user's units or points.
public getHTMLUnitToUnits(string $htmlval[,
string $refsize
= 1
][,
string $defaultunit
= 'px'
][,
bool $points
= false
]) : float
Parameters
- $htmlval : string
-
String containing values and unit.
- $refsize : string = 1
-
Reference value in points.
- $defaultunit : string = 'px'
-
Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
- $points : bool = false
-
If true returns points, otherwise returns value in user's units.
Tags
Return values
float —value in user's unit or point if $points=true
getImageRBX()
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
public getImageRBX()
: float
Tags
Return values
float —getImageRBY()
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
public getImageRBY()
: float
Tags
Return values
float —getImageScale()
Returns the adjusting factor to convert pixels to user units.
public getImageScale()
: float
Tags
Return values
float —adjusting factor to convert pixels to user units.
getLastH()
Get the last cell height.
public getLastH()
: float
Tags
Return values
float —last cell height
GetLineWidth()
Returns the current the line width.
public GetLineWidth()
: int
Tags
Return values
int —Line width
getMargins()
Returns an array containing current margins: <ul> <li>$ret['left'] = left margin</li> <li>$ret['right'] = right margin</li> <li>$ret['top'] = top margin</li> <li>$ret['bottom'] = bottom margin</li> <li>$ret['header'] = header margin</li> <li>$ret['footer'] = footer margin</li> <li>$ret['cell'] = cell padding array</li> <li>$ret['padding_left'] = cell left padding</li> <li>$ret['padding_top'] = cell top padding</li> <li>$ret['padding_right'] = cell right padding</li> <li>$ret['padding_bottom'] = cell bottom padding</li> </ul>
public getMargins()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —containing all margins measures
getNumberOfColumns()
Return the current number of columns.
public getNumberOfColumns()
: int
Tags
Return values
int —number of columns
GetNumChars()
Returns the numbero of characters in a string.
public GetNumChars(string $s)
: int
Parameters
- $s : string
-
The input string.
Tags
Return values
int —number of characters
getNumLines()
This method return the estimated number of lines for print a simple text string using Multicell() method.
public getNumLines(string $txt,
float $w[,
bool $reseth
= false
][,
bool $autopadding
= true
][,
array<string|int,
mixed>|null $cellpadding
= null
], mixed $border)
: float
Parameters
- $txt : string
-
String for calculating his height
- $w : float
-
Width of cells. If 0, they extend up to the right margin of the page.
- $reseth : bool = false
-
if true reset the last cell height (default false).
- $autopadding : bool = true
-
if true, uses internal padding and automatically adjust it to account for line width (default true).
- $cellpadding : array<string|int, mixed>|null = null
-
Internal cell padding, if empty uses default cell padding.
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
Tags
Return values
float —Return the minimal height needed for multicell method for printing the $txt param.
getNumPages()
Get the total number of insered pages.
public getNumPages()
: int
Tags
Return values
int —number of pages
getOriginalMargins()
Returns an array containing original margins: <ul> <li>$ret['left'] = left margin</li> <li>$ret['right'] = right margin</li> </ul>
public getOriginalMargins()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —containing all margins measures
getOverprint()
Get the overprint mode array (OP, op, OPM).
public getOverprint()
: array<string,
bool|int>
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Tags
Return values
array<string, bool|int> —getPage()
Get current document page number.
public getPage()
: int
Tags
Return values
int —page number
getPageDimensions()
Returns an array of page dimensions: <ul><li>$this->pagedim[$this->page]['w'] = page width in points</li><li>$this->pagedim[$this->page]['h'] = height in points</li><li>$this->pagedim[$this->page]['wk'] = page width in user units</li><li>$this->pagedim[$this->page]['hk'] = page height in user units</li><li>$this->pagedim[$this->page]['tm'] = top margin</li><li>$this->pagedim[$this->page]['bm'] = bottom margin</li><li>$this->pagedim[$this->page]['lm'] = left margin</li><li>$this->pagedim[$this->page]['rm'] = right margin</li><li>$this->pagedim[$this->page]['pb'] = auto page break</li><li>$this->pagedim[$this->page]['or'] = page orientation</li><li>$this->pagedim[$this->page]['olm'] = original left margin</li><li>$this->pagedim[$this->page]['orm'] = original right margin</li><li>$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.</li><li>$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.</li><li>$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<ul><li>$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.</li><li>$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li><li>$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.</li><li>$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.</li><li>$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.</li><li>$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.</li><li>$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. </li><li>$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.</li></ul></li><li>$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed<ul><li>$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['CropBox'] : the visible region of default user space<ul><li>$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment<ul><li>$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming<ul><li>$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content<ul><li>$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points</li></ul></li></ul>
public getPageDimensions([int|null $pagenum
= null
]) : array<string|int,
mixed>
Parameters
- $pagenum : int|null = null
-
page number (empty = current page)
Tags
Return values
array<string|int, mixed> —of page dimensions.
getPageGroupAlias()
Return the alias for the total number of pages in the current page group.
public getPageGroupAlias()
: string
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in this group.
Tags
Return values
string —alias of the current page group
getPageHeight()
Returns the page height in units.
public getPageHeight([int|null $pagenum
= null
]) : int|float
Parameters
- $pagenum : int|null = null
-
page number (empty = current page)
Tags
Return values
int|float —page height.
getPageNumGroupAlias()
Return the alias for the page number on the current page group.
public getPageNumGroupAlias()
: string
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number (relative to the belonging group).
Tags
Return values
string —alias of the current page group
getPageRegions()
Return an array of no-write page regions
public getPageRegions()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —of no-write page regions
getPageWidth()
Returns the page width in units.
public getPageWidth([int|null $pagenum
= null
]) : int|float
Parameters
- $pagenum : int|null = null
-
page number (empty = current page)
Tags
Return values
int|float —page width.
getPDFData()
Returns the PDF data.
public getPDFData()
: mixed
Tags
Return values
mixed —getRawCharWidth()
Returns the length of the char in user unit for the current font.
public getRawCharWidth(int $char)
: float
Parameters
- $char : int
-
The char code whose length is to be returned
Tags
Return values
float —char width
getRTL()
Return the RTL status
public getRTL()
: bool
Tags
Return values
bool —getScaleFactor()
Returns the scale factor (number of points in user unit).
public getScaleFactor()
: int
Tags
Return values
int —scale factor.
getStringHeight()
This method return the estimated height needed for printing a simple text string using the Multicell() method.
public getStringHeight(float $w,
string $txt[,
bool $reseth
= false
][,
bool $autopadding
= true
][,
array<string|int,
mixed>|null $cellpadding
= null
], mixed $border)
: float
Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
Parameters
- $w : float
-
Width of cells. If 0, they extend up to the right margin of the page.
- $txt : string
-
String for calculating his height
- $reseth : bool = false
-
if true reset the last cell height (default false).
- $autopadding : bool = true
-
if true, uses internal padding and automatically adjust it to account for line width (default true).
- $cellpadding : array<string|int, mixed>|null = null
-
Internal cell padding, if empty uses default cell padding.
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
Tags
Return values
float —Return the minimal height needed for multicell method for printing the $txt param.
GetStringWidth()
Returns the length of a string in user unit. A font must be selected.<br>
public GetStringWidth(string $s[,
string $fontname
= ''
][,
string $fontstyle
= ''
], float $fontsize[,
bool $getarray
= false
]) : array<string|int,
float>|float
Parameters
- $s : string
-
The string whose length is to be computed
- $fontname : string = ''
-
Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
- $fontstyle : string = ''
-
Font style. Possible values are (case insensitive):
- empty string: regular
- B: bold
- I: italic
- U: underline
- D: line-through
- O: overline
- $fontsize : float
-
Font size in points. The default value is the current size.
- $getarray : bool = false
-
if true returns an array of characters widths, if false returns the total length.
Tags
Return values
array<string|int, float>|float —total string length or array of characted widths
getTextShadow()
Return the text shadow parameters array.
public getTextShadow()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —array of parameters.
GetX()
Returns the relative X value of current position.
public GetX()
: float
The value is relative to the left border for LTR languages and to the right border for RTL languages.
Tags
Return values
float —GetY()
Returns the ordinate of the current position.
public GetY()
: float
Tags
Return values
float —Gradient()
Output gradient.
public Gradient(int $type,
array<string|int,
mixed> $coords,
array<string|int,
mixed> $stops[,
array<string|int,
mixed> $background
= array()
][,
bool $antialias
= false
]) : mixed
Parameters
- $type : int
-
type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
- $coords : array<string|int, mixed>
-
array of coordinates.
- $stops : array<string|int, mixed>
-
array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
- $background : array<string|int, mixed> = array()
-
An array of colour components appropriate to the colour space, specifying a single background colour value.
- $antialias : bool = false
-
A flag indicating whether to filter the shading function to prevent aliasing artifacts.
Tags
Return values
mixed —Header()
This method is used to render the page header.
public Header()
: mixed
It is automatically called by AddPage() and could be overwritten in your own inherited class.
Tags
Return values
mixed —hyphenateText()
Returns text with soft hyphens.
public hyphenateText(string $text,
mixed $patterns[,
array<string|int,
mixed> $dictionary
= array()
][,
int $leftmin
= 1
][,
int $rightmin
= 2
][,
int $charmin
= 1
][,
int $charmax
= 8
]) : string
Parameters
- $text : string
-
text to process
- $patterns : mixed
-
Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
- $dictionary : array<string|int, mixed> = array()
-
Array of words to be returned without applying the hyphenation algorithm.
- $leftmin : int = 1
-
Minimum number of character to leave on the left of the word without applying the hyphens.
- $rightmin : int = 2
-
Minimum number of character to leave on the right of the word without applying the hyphens.
- $charmin : int = 1
-
Minimum word length to apply the hyphenation algorithm.
- $charmax : int = 8
-
Maximum length of broken piece of word.
Tags
Return values
string —text with soft hyphens
Image()
Puts an image in the page.
public Image(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
string $type
= ''
][,
mixed $link
= ''
][,
string $align
= ''
][,
mixed $resize
= false
][,
int $dpi
= 300
][,
string $palign
= ''
][,
bool $ismask
= false
][,
mixed $imgmask
= false
], mixed $border[,
mixed $fitbox
= false
][,
bool $hidden
= false
][,
bool $fitonpage
= false
][,
bool $alt
= false
][,
array<string|int,
mixed> $altimgs
= array()
]) : mixed|false
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
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.
Parameters
- $file : string
-
Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg').
- $x : float|null = null
-
Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
- $y : float|null = null
-
Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
- $w : float
-
Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $h : float
-
Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $type : string = ''
-
Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
- $link : mixed = ''
-
URL or identifier returned by AddLink().
- $align : string = ''
-
Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- $resize : mixed = false
-
If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).
- $dpi : int = 300
-
dot-per-inch resolution used on resize
- $palign : string = ''
-
Allows to center or align the image on the current line. Possible values are:
- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
- $ismask : bool = false
-
true if this image is a mask, false otherwise
- $imgmask : mixed = false
-
image object returned by this function or false
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- $fitbox : mixed = false
-
If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).
- $hidden : bool = false
-
If true do not display the image.
- $fitonpage : bool = false
-
If true the image is resized to not exceed page dimensions.
- $alt : bool = false
-
If true the image will be added as alternative and not directly printed (the ID of the image will be returned).
- $altimgs : array<string|int, mixed> = array()
-
Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.
Tags
Return values
mixed|false —image information
ImageEps()
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
public ImageEps(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
mixed $link
= ''
][,
bool $useBoundingBox
= true
][,
string $align
= ''
][,
string $palign
= ''
], mixed $border[,
bool $fitonpage
= false
][,
bool $fixoutvals
= false
]) : mixed
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).
Parameters
- $file : string
-
Name of the file containing the image or a '@' character followed by the EPS/AI data string.
- $x : float|null = null
-
Abscissa of the upper-left corner.
- $y : float|null = null
-
Ordinate of the upper-left corner.
- $w : float
-
Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $h : float
-
Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $link : mixed = ''
-
URL or identifier returned by AddLink().
- $useBoundingBox : bool = true
-
specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
- $align : string = ''
-
Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- $palign : string = ''
-
Allows to center or align the image on the current line. Possible values are:
- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- $fitonpage : bool = false
-
if true the image is resized to not exceed page dimensions.
- $fixoutvals : bool = false
-
if true remove values outside the bounding box.
Tags
Return values
mixed —ImageSVG()
Embedd a Scalable Vector Graphics (SVG) image.
public ImageSVG(string $file[,
float|null $x
= null
][,
float|null $y
= null
], float $w,
float $h[,
mixed $link
= ''
][,
string $align
= ''
][,
string $palign
= ''
], mixed $border[,
bool $fitonpage
= false
]) : mixed
NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
Parameters
- $file : string
-
Name of the SVG file or a '@' character followed by the SVG data string.
- $x : float|null = null
-
Abscissa of the upper-left corner.
- $y : float|null = null
-
Ordinate of the upper-left corner.
- $w : float
-
Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $h : float
-
Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
- $link : mixed = ''
-
URL or identifier returned by AddLink().
- $align : string = ''
-
Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- $palign : string = ''
-
Allows to center or align the image on the current line. Possible values are:
- L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
- $border : mixed
-
Indicates if borders must be drawn around the cell. The value can be a number:
- 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- $fitonpage : bool = false
-
if true the image is resized to not exceed page dimensions.
Tags
Return values
mixed —IncludeJS()
Adds a javascript
public IncludeJS(string $script)
: mixed
Parameters
- $script : string
-
Javascript code
Tags
Return values
mixed —isCharDefined()
Return true in the character is present in the specified font.
public isCharDefined(mixed $char[,
string $font
= ''
][,
string $style
= ''
]) : bool
Parameters
- $char : mixed
-
Character to check (integer value or string)
- $font : string = ''
-
Font name (family name).
- $style : string = ''
-
Font style.
Tags
Return values
bool —true if the char is defined, false otherwise.
isRTLTextDir()
Return the current temporary RTL status
public isRTLTextDir()
: bool
Tags
Return values
bool —isUnicodeFont()
Return true if the current font is unicode type.
public isUnicodeFont()
: bool
Tags
Return values
bool —true for unicode font, false otherwise.
lastPage()
Reset pointer to the last document page.
public lastPage([bool $resetmargins
= false
]) : mixed
Parameters
- $resetmargins : bool = false
-
if true reset left, right, top margins and Y position.
Tags
Return values
mixed —Line()
Draws a line between two points.
public Line(float $x1,
float $y1,
float $x2,
float $y2[,
array<string|int,
mixed> $style
= array()
]) : mixed
Parameters
- $x1 : float
-
Abscissa of first point.
- $y1 : float
-
Ordinate of first point.
- $x2 : float
-
Abscissa of second point.
- $y2 : float
-
Ordinate of second point.
- $style : array<string|int, mixed> = array()
-
Line style. Array like for SetLineStyle(). Default value: default line style (empty array).
Tags
Return values
mixed —LinearGradient()
Paints a linear colour gradient.
public LinearGradient(float $x,
float $y,
float $w,
float $h[,
array<string|int,
mixed> $col1
= array()
][,
array<string|int,
mixed> $col2
= array()
][,
array<string|int,
mixed> $coords
= array(0, 0, 1,
0) ]) :
mixed
Parameters
- $x : float
-
abscissa of the top left corner of the rectangle.
- $y : float
-
ordinate of the top left corner of the rectangle.
- $w : float
-
width of the rectangle.
- $h : float
-
height of the rectangle.
- $col1 : array<string|int, mixed> = array()
-
first color (Grayscale, RGB or CMYK components).
- $col2 : array<string|int, mixed> = array()
-
second color (Grayscale, RGB or CMYK components).
- $coords : array<string|int, mixed> = array(0, 0, 1, 0)
-
array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
Tags
Return values
mixed —Link()
Puts a link on a rectangular area of the page.
public Link(float $x,
float $y,
float $w,
float $h,
mixed $link,
int $spaces)
: mixed
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.
Parameters
- $x : float
-
Abscissa of the upper-left corner of the rectangle
- $y : float
-
Ordinate of the upper-left corner of the rectangle
- $w : float
-
Width of the rectangle
- $h : float
-
Height of the rectangle
- $link : mixed
-
URL or identifier returned by AddLink()
- $spaces : int
-
number of spaces on the text to link
Tags
Return values
mixed —ListBox()
Creates a List-box field
public ListBox(string $name,
int $w,
int $h