 |
PEEL Shopping
Open source ecommerce : PEEL Shopping
|
PHP class for generating PDF documents without requiring external extensions. More...
Public Member Functions | |
| __construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false) | |
| This is the class constructor. More... | |
| __destruct () | |
| Default destructor. More... | |
| getTCPDFVersion () | |
| Return the current TCPDF version. More... | |
| setPageUnit ($unit) | |
| Set the units of measure for the document. More... | |
| getPageSizeFromFormat ($format) | |
| Get page dimensions from format name. More... | |
| setPageBoxes ($page, $type, $llx, $lly, $urx, $ury, $points=false) | |
| Set page boundaries. More... | |
| setPageOrientation ($orientation, $autopagebreak='', $bottommargin='') | |
| Set page orientation. More... | |
| setSpacesRE ($re='/[^\S\xa0]/') | |
| Set regular expression to detect withespaces or word separators. More... | |
| setRTL ($enable, $resetx=true) | |
| Enable or disable Right-To-Left language mode. More... | |
| getRTL () | |
| Return the RTL status. More... | |
| setTempRTL ($mode) | |
| Force temporary RTL language direction. More... | |
| isRTLTextDir () | |
| Return the current temporary RTL status. More... | |
| setLastH ($h) | |
| Set the last cell height. More... | |
| resetLastH () | |
| Reset the last cell height. More... | |
| getLastH () | |
| Get the last cell height. More... | |
| setImageScale ($scale) | |
| Set the adjusting factor to convert pixels to user units. More... | |
| getImageScale () | |
| Returns the adjusting factor to convert pixels to user units. More... | |
| getPageDimensions ($pagenum='') | |
| Returns an array of page dimensions: More... | |
| getPageWidth ($pagenum='') | |
| Returns the page width in units. More... | |
| getPageHeight ($pagenum='') | |
| Returns the page height in units. More... | |
| getBreakMargin ($pagenum='') | |
| Returns the page break margin. More... | |
| getScaleFactor () | |
| Returns the scale factor (number of points in user unit). More... | |
| SetMargins ($left, $top, $right=-1, $keepmargins=false) | |
| Defines the left, top and right margins. More... | |
| SetLeftMargin ($margin) | |
| Defines the left margin. More... | |
| SetTopMargin ($margin) | |
| Defines the top margin. More... | |
| SetRightMargin ($margin) | |
| Defines the right margin. More... | |
| SetCellPadding ($pad) | |
| Set the same internal Cell padding for top, right, bottom, left-. More... | |
| setCellPaddings ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell paddings. More... | |
| getCellPaddings () | |
| Get the internal Cell padding array. More... | |
| setCellMargins ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell margins. More... | |
| getCellMargins () | |
| Get the internal Cell margin array. More... | |
| SetAutoPageBreak ($auto, $margin=0) | |
| Enables or disables the automatic page breaking mode. More... | |
| getAutoPageBreak () | |
| Return the auto-page-break mode (true or false). More... | |
| SetDisplayMode ($zoom, $layout='SinglePage', $mode='UseNone') | |
| Defines the way the document is to be displayed by the viewer. More... | |
| SetCompression ($compress=true) | |
| Activates or deactivates page compression. More... | |
| setSRGBmode ($mode=false) | |
| Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document. More... | |
| SetDocInfoUnicode ($unicode=true) | |
| Turn on/off Unicode mode for document information dictionary (meta tags). More... | |
| SetTitle ($title) | |
| Defines the title of the document. More... | |
| SetSubject ($subject) | |
| Defines the subject of the document. More... | |
| SetAuthor ($author) | |
| Defines the author of the document. More... | |
| SetKeywords ($keywords) | |
| Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. More... | |
| SetCreator ($creator) | |
| Defines the creator of the document. More... | |
| Error ($msg) | |
| This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. More... | |
| Open () | |
| This method begins the generation of the PDF document. More... | |
| Close () | |
| Terminates the PDF document. More... | |
| setPage ($pnum, $resetmargins=false) | |
| Move pointer at the specified document page and update page dimensions. More... | |
| lastPage ($resetmargins=false) | |
| Reset pointer to the last document page. More... | |
| getPage () | |
| Get current document page number. More... | |
| getNumPages () | |
| Get the total number of insered pages. More... | |
| addTOCPage ($orientation='', $format='', $keepmargins=false) | |
| Adds a new TOC (Table Of Content) page to the document. More... | |
| endTOCPage () | |
| Terminate the current TOC (Table Of Content) page. More... | |
| AddPage ($orientation='', $format='', $keepmargins=false, $tocpage=false) | |
| Adds a new page to the document. More... | |
| endPage ($tocpage=false) | |
| Terminate the current page. More... | |
| startPage ($orientation='', $format='', $tocpage=false) | |
| Starts a new page to the document. More... | |
| setPageMark () | |
| Set start-writing mark on current page stream used to put borders and fills. More... | |
| setHeaderData ($ln='', $lw=0, $ht='', $hs='', $tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set header data. More... | |
| setFooterData ($tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set footer data. More... | |
| getHeaderData () | |
| Returns header data: More... | |
| setHeaderMargin ($hm=10) | |
| Set header margin. More... | |
| getHeaderMargin () | |
| Returns header margin in user units. More... | |
| setFooterMargin ($fm=10) | |
| Set footer margin. More... | |
| getFooterMargin () | |
| Returns footer margin in user units. More... | |
| setPrintHeader ($val=true) | |
| Set a flag to print page header. More... | |
| setPrintFooter ($val=true) | |
| Set a flag to print page footer. More... | |
| getImageRBX () | |
| Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. More... | |
| getImageRBY () | |
| Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image. More... | |
| resetHeaderTemplate () | |
| Reset the xobject template used by Header() method. More... | |
| setHeaderTemplateAutoreset ($val=true) | |
| Set a flag to automatically reset the xobject template used by Header() method at each page. More... | |
| Header () | |
| This method is used to render the page header. More... | |
| Footer () | |
| This method is used to render the page footer. More... | |
| PageNo () | |
| Returns the current page number. More... | |
| AddSpotColor ($name, $c, $m, $y, $k) | |
| Defines a new spot color. More... | |
| getSpotColor ($name) | |
| Return the Spot color array. More... | |
| setSpotColor ($type, $name, $tint=100) | |
| Set the spot color for the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawSpotColor ($name, $tint=100) | |
| Defines the spot color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillSpotColor ($name, $tint=100) | |
| Defines the spot color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextSpotColor ($name, $tint=100) | |
| Defines the spot color used for text. More... | |
| setColorArray ($type, $color, $ret=false) | |
| Set the color array for the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawColorArray ($color, $ret=false) | |
| Defines the color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillColorArray ($color, $ret=false) | |
| Defines the color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextColorArray ($color, $ret=false) | |
| Defines the color used for text. More... | |
| setColor ($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used by the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for text. More... | |
| GetStringWidth ($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
| Returns the length of a string in user unit. More... | |
| GetArrStringWidth ($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
| Returns the string length of an array of chars in user unit or an array of characters widths. More... | |
| GetCharWidth ($char, $notlast=true) | |
| Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking). More... | |
| getRawCharWidth ($char) | |
| Returns the length of the char in user unit for the current font. More... | |
| GetNumChars ($s) | |
| Returns the numbero of characters in a string. More... | |
| AddFont ($family, $style='', $fontfile='', $subset='default') | |
| Imports a TrueType, Type1, core, or CID0 font and makes it available. More... | |
| SetFont ($family, $style='', $size=null, $fontfile='', $subset='default', $out=true) | |
| Sets the font used to print character strings. More... | |
| SetFontSize ($size, $out=true) | |
| Defines the size of the current font. More... | |
| getFontBBox () | |
| Returns the bounding box of the current font in user units. More... | |
| getAbsFontMeasure ($s) | |
| Convert a relative font measure into absolute value. More... | |
| getCharBBox ($char) | |
| Returns the glyph bounding box of the specified character in the current font in user units. More... | |
| getFontDescent ($font, $style='', $size=0) | |
| Return the font descent value. More... | |
| getFontAscent ($font, $style='', $size=0) | |
| Return the font ascent value. More... | |
| isCharDefined ($char, $font='', $style='') | |
| Return true in the character is present in the specified font. More... | |
| replaceMissingChars ($text, $font='', $style='', $subs=array()) | |
| Replace missing font characters on selected font with specified substitutions. More... | |
| SetDefaultMonospacedFont ($font) | |
| Defines the default monospaced font. More... | |
| AddLink () | |
| Creates a new internal link and returns its identifier. More... | |
| SetLink ($link, $y=0, $page=-1) | |
| Defines the page and position a link points to. More... | |
| Link ($x, $y, $w, $h, $link, $spaces=0) | |
| Puts a link on a rectangular area of the page. More... | |
| Annotation ($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) | |
| Puts a markup annotation on a rectangular area of the page. More... | |
| Text ($x, $y, $txt, $fstroke=false, $fclip=false, $ffill=true, $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M', $rtloff=false) | |
| Prints a text cell at the specified position. More... | |
| AcceptPageBreak () | |
| Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. More... | |
| removeSHY ($txt='') | |
| Removes SHY characters from text. More... | |
| Cell ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
| Prints a cell (rectangular area) with optional borders, background color and character string. More... | |
| MultiCell ($w, $h, $txt, $border=0, $align='J', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0, $valign='T', $fitcell=false) | |
| This method allows printing text with line breaks. More... | |
| getNumLines ($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
| This method return the estimated number of lines for print a simple text string using Multicell() method. More... | |
| getStringHeight ($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
| This method return the estimated height needed for printing a simple text string using the Multicell() method. More... | |
| Write ($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='') | |
| This method prints text from the current position. More... | |
| UTF8ArrSubString ($strarr, $start='', $end='') | |
| Extract a slice of the $strarr array and return it as string. More... | |
| UniArrSubString ($uniarr, $start='', $end='') | |
| Extract a slice of the $uniarr array and return it as string. More... | |
| UTF8ArrayToUniArray ($ta) | |
| Convert an array of UTF8 values to array of unicode characters. More... | |
| unichr ($c) | |
| Returns the unicode caracter specified by UTF-8 value. More... | |
| getImageFileType ($imgfile, $iminfo=array()) | |
| Return the image type given the file name or array returned by getimagesize() function. More... | |
| Image ($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false, $alt=false, $altimgs=array()) | |
| Puts an image in the page. More... | |
| set_mqr ($mqr) | |
| Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist) More... | |
| get_mqr () | |
| Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist) More... | |
| Ln ($h='', $cell=false) | |
| Performs a line break. More... | |
| GetX () | |
| Returns the relative X value of current position. More... | |
| GetAbsX () | |
| Returns the absolute X value of current position. More... | |
| GetY () | |
| Returns the ordinate of the current position. More... | |
| SetX ($x, $rtloff=false) | |
| Defines the abscissa of the current position. More... | |
| SetY ($y, $resetx=true, $rtloff=false) | |
| Moves the current abscissa back to the left margin and sets the ordinate. More... | |
| SetXY ($x, $y, $rtloff=false) | |
| Defines the abscissa and ordinate of the current position. More... | |
| SetAbsX ($x) | |
| Set the absolute X coordinate of the current pointer. More... | |
| SetAbsY ($y) | |
| Set the absolute Y coordinate of the current pointer. More... | |
| SetAbsXY ($x, $y) | |
| Set the absolute X and Y coordinates of the current pointer. More... | |
| Output ($name='doc.pdf', $dest='I') | |
| Send the document to a given destination: string, local file or browser. More... | |
| _destroy ($destroyall=false, $preserve_objcopy=false) | |
| Unset all class variables except the following critical variables. More... | |
| addTTFfont ($fontfile, $fonttype='', $enc='', $flags=32, $outpath='', $platid=3, $encid=1, $addcbbox=false) | |
| Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable). More... | |
| setExtraXMP ($xmp) | |
| Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag. More... | |
| setDocCreationTimestamp ($time) | |
| Set the document creation timestamp. More... | |
| setDocModificationTimestamp ($time) | |
| Set the document modification timestamp. More... | |
| getDocCreationTimestamp () | |
| Returns document creation timestamp in seconds. More... | |
| getDocModificationTimestamp () | |
| Returns document modification timestamp in seconds. More... | |
| getTimestamp ($date) | |
| Returns timestamp in seconds from formatted date-time. More... | |
| getFormattedDate ($time) | |
| Returns a formatted date-time. More... | |
| setHeaderFont ($font) | |
| Set header font. More... | |
| getHeaderFont () | |
| Get header font. More... | |
| setFooterFont ($font) | |
| Set footer font. More... | |
| getFooterFont () | |
| Get Footer font. More... | |
| setLanguageArray ($language) | |
| Set language array. More... | |
| getPDFData () | |
| Returns the PDF data. More... | |
| addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) | |
| Output anchor link. More... | |
| convertHTMLColorToDec ($hcolor='#FFFFFF', $defcol=array('R'=>128,'G'=>128,'B'=>128)) | |
| Returns an array (RGB or CMYK) from an html color name, or a six-digit (i.e. More... | |
| pixelsToUnits ($px) | |
| Converts pixels to User's Units. More... | |
| unhtmlentities ($text_to_convert) | |
| Reverse function for htmlentities. More... | |
| SetProtection ($permissions=array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass='', $owner_pass=null, $mode=0, $pubkeys=null) | |
| Set document protection Remark: the protection against modification is for people who have the full Acrobat product. More... | |
| StartTransform () | |
| Starts a 2D tranformation saving current graphic state. More... | |
| StopTransform () | |
| Stops a 2D tranformation restoring previous graphic state. More... | |
| ScaleX ($s_x, $x='', $y='') | |
| Horizontal Scaling. More... | |
| ScaleY ($s_y, $x='', $y='') | |
| Vertical Scaling. More... | |
| ScaleXY ($s, $x='', $y='') | |
| Vertical and horizontal proportional Scaling. More... | |
| Scale ($s_x, $s_y, $x='', $y='') | |
| Vertical and horizontal non-proportional Scaling. More... | |
| MirrorH ($x='') | |
| Horizontal Mirroring. More... | |
| MirrorV ($y='') | |
| Verical Mirroring. More... | |
| MirrorP ($x='', $y='') | |
| Point reflection mirroring. More... | |
| MirrorL ($angle=0, $x='', $y='') | |
| Reflection against a straight line through point (x, y) with the gradient angle (angle). More... | |
| TranslateX ($t_x) | |
| Translate graphic object horizontally. More... | |
| TranslateY ($t_y) | |
| Translate graphic object vertically. More... | |
| Translate ($t_x, $t_y) | |
| Translate graphic object horizontally and vertically. More... | |
| Rotate ($angle, $x='', $y='') | |
| Rotate object. More... | |
| SkewX ($angle_x, $x='', $y='') | |
| Skew horizontally. More... | |
| SkewY ($angle_y, $x='', $y='') | |
| Skew vertically. More... | |
| Skew ($angle_x, $angle_y, $x='', $y='') | |
| Skew. More... | |
| SetLineWidth ($width) | |
| Defines the line width. More... | |
| GetLineWidth () | |
| Returns the current the line width. More... | |
| SetLineStyle ($style, $ret=false) | |
| Set line style. More... | |
| Line ($x1, $y1, $x2, $y2, $style=array()) | |
| Draws a line between two points. More... | |
| Rect ($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rectangle. More... | |
| Curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a Bezier curve. More... | |
| Polycurve ($x0, $y0, $segments, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a poly-Bezier curve. More... | |
| Ellipse ($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws an ellipse. More... | |
| Circle ($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws a circle. More... | |
| PolyLine ($p, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a polygonal line. More... | |
| Polygon ($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) | |
| Draws a polygon. More... | |
| RegularPolygon ($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
| Draws a regular polygon. More... | |
| StarPolygon ($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
| Draws a star polygon. More... | |
| RoundedRect ($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. More... | |
| RoundedRectXY ($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. More... | |
| Arrow ($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) | |
| Draws a grahic arrow. More... | |
| setDestination ($name, $y=-1, $page='', $x=-1) | |
| Add a Named Destination. More... | |
| getDestination () | |
| Return the Named Destination array. More... | |
| setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0)) | |
| Adds a bookmark - alias for Bookmark(). More... | |
| Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1) | |
| Adds a bookmark. More... | |
| IncludeJS ($script) | |
| Adds a javascript. More... | |
| addJavascriptObject ($script, $onload=false) | |
| Adds a javascript object and return object ID. More... | |
| setFormDefaultProp ($prop=array()) | |
| Set default properties for form fields. More... | |
| getFormDefaultProp () | |
| Return the default properties for form fields. More... | |
| TextField ($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a text field. More... | |
| RadioButton ($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false) | |
| Creates a RadioButton field. More... | |
| ListBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a List-box field. More... | |
| ComboBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a Combo-box field. More... | |
| CheckBox ($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false) | |
| Creates a CheckBox field. More... | |
| Button ($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a button field. More... | |
| setUserRights ($enable=true, $document='/FullSave', $annots='/Create/Delete/Modify/Copy/Import/Export', $form='/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', $signature='/Modify', $ef='/Create/Delete/Modify/Import', $formex='') | |
| Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. More... | |
| setSignature ($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array()) | |
| Enable document signature (requires the OpenSSL Library). More... | |
| setSignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1) | |
| Set the digital signature appearance (a cliccable rectangle area to get signature properties) More... | |
| addEmptySignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1) | |
| Add an empty digital signature appearance (a cliccable rectangle area to get signature properties) More... | |
| startPageGroup ($page= '') | |
| Create a new page group. More... | |
| AliasNbPages ($s='') | |
| This method is DEPRECATED and doesn't have any effect. More... | |
| AliasNumPage ($s='') | |
| This method is DEPRECATED and doesn't have any effect. More... | |
| setStartingPageNumber ($num=1) | |
| Set the starting page number. More... | |
| getAliasRightShift () | |
| Returns the string alias used right align page numbers. More... | |
| getAliasNbPages () | |
| Returns the string alias used for the total number of pages. More... | |
| getAliasNumPage () | |
| Returns the string alias used for the page number. More... | |
| getPageGroupAlias () | |
| Return the alias for the total number of pages in the current page group. More... | |
| getPageNumGroupAlias () | |
| Return the alias for the page number on the current page group. More... | |
| getGroupPageNo () | |
| Return the current page in the group. More... | |
| getGroupPageNoFormatted () | |
| Returns the current group page number formatted as a string. More... | |
| PageNoFormatted () | |
| Returns the current page number formatted as a string. More... | |
| startLayer ($name='', $print=true, $view=true) | |
| Start a new pdf layer. More... | |
| endLayer () | |
| End the current PDF layer. More... | |
| setVisibility ($v) | |
| Set the visibility of the successive elements. More... | |
| setOverprint ($stroking=true, $nonstroking='', $mode=0) | |
| Set overprint mode for stroking (OP) and non-stroking (op) painting operations. More... | |
| getOverprint () | |
| Get the overprint mode array (OP, op, OPM). More... | |
| setAlpha ($stroking=1, $bm='Normal', $nonstroking='', $ais=false) | |
| Set alpha for stroking (CA) and non-stroking (ca) operations. More... | |
| getAlpha () | |
| Get the alpha mode array (CA, ca, BM, AIS). More... | |
| setJPEGQuality ($quality) | |
| Set the default JPEG compression quality (1-100) More... | |
| setDefaultTableColumns ($cols=4) | |
| Set the default number of columns in a row for HTML tables. More... | |
| setCellHeightRatio ($h) | |
| Set the height of the cell (line height) respect the font height. More... | |
| getCellHeightRatio () | |
| return the height of cell repect font height. More... | |
| setPDFVersion ($version='1.7') | |
| Set the PDF version (check PDF reference for valid values). More... | |
| setViewerPreferences ($preferences) | |
| Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. More... | |
| colorRegistrationBar ($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A, R, G, B, C, M, Y, K') | |
| Paints color transition registration bars. More... | |
| cropMark ($x, $y, $w, $h, $type='T, R, B, L', $color=array(0, 0, 0)) | |
| Paints crop marks. More... | |
| registrationMark ($x, $y, $r, $double=false, $cola=array(0, 0, 0), $colb=array(255, 255, 255)) | |
| Paints a registration mark. More... | |
| LinearGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0)) | |
| Paints a linear colour gradient. More... | |
| RadialGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0.5, 0.5, 0.5, 0.5, 1)) | |
| Paints a radial colour gradient. More... | |
| CoonsPatchMesh ($x, $y, $w, $h, $col1=array(), $col2=array(), $col3=array(), $col4=array(), $coords=array(0.00, 0.0, 0.33, 0.00, 0.67, 0.00, 1.00, 0.00, 1.00, 0.33, 1.00, 0.67, 1.00, 1.00, 0.67, 1.00, 0.33, 1.00, 0.00, 1.00, 0.00, 0.67, 0.00, 0.33), $coords_min=0, $coords_max=1, $antialias=false) | |
| Paints a coons patch mesh. More... | |
| Gradient ($type, $coords, $stops, $background=array(), $antialias=false) | |
| Output gradient. More... | |
| PieSector ($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) | |
| Draw the sector of a circle. More... | |
| PieSectorXY ($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) | |
| Draw the sector of an ellipse. More... | |
| ImageEps ($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false) | |
| Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. More... | |
| setBarcode ($bc='') | |
| Set document barcode. More... | |
| getBarcode () | |
| Get current barcode. More... | |
| write1DBarcode ($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='') | |
| Print a Linear Barcode. More... | |
| writeBarcode ($x, $y, $w, $h, $type, $style, $font, $xres, $code) | |
| This function is DEPRECATED, please use the new write1DBarcode() function. More... | |
| write2DBarcode ($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false) | |
| Print 2D Barcode. More... | |
| getMargins () | |
| Returns an array containing current margins: More... | |
| getOriginalMargins () | |
| Returns an array containing original margins: More... | |
| getFontSize () | |
| Returns the current font size. More... | |
| getFontSizePt () | |
| Returns the current font size in points unit. More... | |
| getFontFamily () | |
| Returns the current font family name. More... | |
| getFontStyle () | |
| Returns the current font style. More... | |
| fixHTMLCode ($html, $default_css='', $tagvs='', $tidy_options='') | |
| Cleanup HTML code (requires HTML Tidy library). More... | |
| getCSSPadding ($csspadding, $width=0) | |
| Get the internal Cell padding from CSS attribute. More... | |
| getCSSMargin ($cssmargin, $width=0) | |
| Get the internal Cell margin from CSS attribute. More... | |
| getCSSBorderMargin ($cssbspace, $width=0) | |
| Get the border-spacing from CSS attribute. More... | |
| writeHTMLCell ($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=false, $reseth=true, $align='', $autopadding=true) | |
| Prints a cell (rectangular area) with optional borders, background color and html text string. More... | |
| writeHTML ($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='') | |
| Allows to preserve some HTML formatting (limited support). More... | |
| setLIsymbol ($symbol='!') | |
| Set the default bullet to be used as LI bullet symbol. More... | |
| SetBooklet ($booklet=true, $inner=-1, $outer=-1) | |
| Set the booklet mode for double-sided pages. More... | |
| setHtmlVSpace ($tagvs) | |
| Set the vertical spaces for HTML tags. More... | |
| setListIndentWidth ($width) | |
| Set custom width for list indentation. More... | |
| setOpenCell ($isopen) | |
| Set the top/bottom cell sides to be open or closed when the cell cross the page. More... | |
| setHtmlLinksStyle ($color=array(0, 0, 255), $fontstyle='U') | |
| Set the color and font style for HTML links. More... | |
| getHTMLUnitToUnits ($htmlval, $refsize=1, $defaultunit='px', $points=false) | |
| Convert HTML string containing value and unit of measure to user's units or points. More... | |
| intToRoman ($number) | |
| Returns the Roman representation of an integer number. More... | |
| movePage ($frompage, $topage) | |
| Move a page to a previous position. More... | |
| deletePage ($page) | |
| Remove the specified page. More... | |
| copyPage ($page=0) | |
| Clone the specified page to a new page. More... | |
| addTOC ($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0, 0, 0)) | |
| Output a Table of Content Index (TOC). More... | |
| addHTMLTOC ($page='', $toc_name='TOC', $templates=array(), $correct_align=true, $style='', $color=array(0, 0, 0)) | |
| Output a Table Of Content Index (TOC) using HTML templates. More... | |
| startTransaction () | |
| Stores a copy of the current TCPDF object used for undo operation. More... | |
| commitTransaction () | |
| Delete the copy of the current TCPDF object used for undo operation. More... | |
| rollbackTransaction ($self=false) | |
| This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction(). More... | |
| objclone ($object) | |
| Creates a copy of a class object. More... | |
| empty_string ($str) | |
| Determine whether a string is empty. More... | |
| revstrpos ($haystack, $needle, $offset=0) | |
| Find position of last occurrence of a substring in a string. More... | |
| setEqualColumns ($numcols=0, $width=0, $y='') | |
| Set multiple columns of the same size. More... | |
| resetColumns () | |
| Remove columns and reset page margins. More... | |
| setColumnsArray ($columns) | |
| Set columns array. More... | |
| selectColumn ($col='') | |
| Set position at a given column. More... | |
| getColumn () | |
| Return the current column number. More... | |
| getNumberOfColumns () | |
| Return the current number of columns. More... | |
| serializeTCPDFtagParameters ($pararray) | |
| Serialize an array of parameters to be used with TCPDF tag in HTML code. More... | |
| setTextRenderingMode ($stroke=0, $fill=true, $clip=false) | |
| Set Text rendering mode. More... | |
| setTextShadow ($params=array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal')) | |
| Set parameters for drop shadow effect for text. More... | |
| getTextShadow () | |
| Return the text shadow parameters array. More... | |
| getHyphenPatternsFromTEX ($file) | |
| Returns an array of hyphenation patterns. More... | |
| hyphenateText ($text, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns text with soft hyphens. More... | |
| setRasterizeVectorImages ($mode) | |
| Enable/disable rasterization of vector images using ImageMagick library. More... | |
| setFontSubsetting ($enable=true) | |
| Enable or disable default option for font subsetting. More... | |
| getFontSubsetting () | |
| Return the default option for font subsetting. More... | |
| stringLeftTrim ($str, $replace='') | |
| Left trim the input string. More... | |
| stringRightTrim ($str, $replace='') | |
| Right trim the input string. More... | |
| stringTrim ($str, $replace='') | |
| Trim the input string. More... | |
| isUnicodeFont () | |
| Return true if the current font is unicode type. More... | |
| getFontFamilyName ($fontfamily) | |
| Return normalized font name. More... | |
| startTemplate ($w=0, $h=0, $group=false) | |
| Start a new XObject Template. More... | |
| endTemplate () | |
| End the current XObject Template started with startTemplate() and restore the previous graphic state. More... | |
| printTemplate ($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false) | |
| Print an XObject Template. More... | |
| setFontStretching ($perc=100) | |
| Set the percentage of character stretching. More... | |
| getFontStretching () | |
| Get the percentage of character stretching. More... | |
| setFontSpacing ($spacing=0) | |
| Set the amount to increase or decrease the space between characters in a text. More... | |
| getFontSpacing () | |
| Get the amount to increase or decrease the space between characters in a text. More... | |
| getPageRegions () | |
| Return an array of no-write page regions. More... | |
| setPageRegions ($regions=array()) | |
| Set no-write regions on page. More... | |
| addPageRegion ($region) | |
| Add a single no-write region on selected page. More... | |
| removePageRegion ($key) | |
| Remove a single no-write region. More... | |
| ImageSVG ($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false) | |
| Embedd a Scalable Vector Graphics (SVG) image. More... | |
Protected Member Functions | |
| setPageFormat ($format, $orientation='P') | |
| Change the format of the current page. More... | |
| swapPageBoxCoordinates ($page) | |
| Swap X and Y coordinates of page boxes (change page boxes orientation). More... | |
| adjustCellPadding ($brd=0) | |
| Adjust the internal Cell padding array to take account of the line width. More... | |
| setContentMark ($page=0) | |
| Set start-writing mark on selected page. More... | |
| setHeader () | |
| This method is used to render the page header. More... | |
| setFooter () | |
| This method is used to render the page footer. More... | |
| inPageBody () | |
| Check if we are on the page body (excluding page header and footer). More... | |
| setTableHeader () | |
| This method is used to render the table header on new page (if any). More... | |
| getColorStringFromArray ($c) | |
| Convert a color array into a string representation. More... | |
| getFontsList () | |
| Fill the list of available fonts ($this->fontlist). More... | |
| _putEmbeddedFiles () | |
| Embedd the attached files. More... | |
| checkPageBreak ($h=0, $y='', $addpage=true) | |
| Add page if needed. More... | |
| getCellCode ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
| Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. More... | |
| replaceChar ($oldchar, $newchar) | |
| Replace a char if is defined on the current font. More... | |
| getCellBorder ($x, $y, $w, $h, $brd) | |
| Returns the code to draw the cell border. More... | |
| getBorderMode ($brd, $position='start') | |
| Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages) More... | |
| getRemainingWidth () | |
| Returns the remaining width between the current position and margins. More... | |
| fitBlock ($w, $h, $x, $y, $fitonpage=false) | |
| Set the block dimensions accounting for page breaks and page/column fitting. More... | |
| _toJPEG ($image) | |
| Convert the loaded image to a JPEG and then return a structure for the PDF creator. More... | |
| _toPNG ($image) | |
| Convert the loaded image to a PNG and then return a structure for the PDF creator. More... | |
| _setGDImageTransparency ($new_image, $image) | |
| Set the transparency for the given GD image. More... | |
| _parsejpeg ($file) | |
| Extract info from a JPEG file without using the GD library. More... | |
| _parsepng ($file) | |
| Extract info from a PNG file without using the GD library. More... | |
| rfread ($handle, $length) | |
| Binary-safe and URL-safe file read. More... | |
| ImagePngAlpha ($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='') | |
| Extract info from a PNG image with alpha channel using the GD library. More... | |
| getGDgamma ($c) | |
| Get the GD-corrected PNG gamma value from alpha color. More... | |
| sendOutputData ($data, $length) | |
| Ouput input data and compress it if possible. More... | |
| _dochecks () | |
| Check for locale-related bug. More... | |
| _getfontpath () | |
| Return fonts path. More... | |
| getInternalPageNumberAliases ($a= '') | |
| Return an array containing variations for the basic page number alias. More... | |
| getAllInternalPageNumberAliases () | |
| Return an array containing all internal page aliases. More... | |
| replacePageNumAliases ($page, $replace, $diff=0) | |
| Replace page number aliases with number. More... | |
| replaceRightShiftPageNumAliases ($page, $aliases, $diff) | |
| Replace right shift page number aliases with spaces to correct right alignment. More... | |
| setPageBoxTypes ($boxes) | |
| Set page boxes to be included on page descriptions. More... | |
| _putpages () | |
| Output pages (and replace page number aliases). More... | |
| _putannotsrefs ($n) | |
| Output references to page annotations. More... | |
| _getannotsrefs ($n) | |
| Get references to page annotations. More... | |
| _putannotsobjs () | |
| Output annotations objects for all pages. More... | |
| _putAPXObject ($w=0, $h=0, $stream='') | |
| Put appearance streams XObject used to define annotation's appearance states. More... | |
| _getULONG ($str, $offset) | |
| Get ULONG from string (Big Endian 32-bit unsigned integer). More... | |
| _getUSHORT ($str, $offset) | |
| Get USHORT from string (Big Endian 16-bit unsigned integer). More... | |
| _getSHORT ($str, $offset) | |
| Get SHORT from string (Big Endian 16-bit signed integer). More... | |
| _getFWORD ($str, $offset) | |
| Get FWORD from string (Big Endian 16-bit signed integer). More... | |
| _getUFWORD ($str, $offset) | |
| Get UFWORD from string (Big Endian 16-bit unsigned integer). More... | |
| _getFIXED ($str, $offset) | |
| Get FIXED from string (32-bit signed fixed-point number (16.16). More... | |
| _getBYTE ($str, $offset) | |
| Get BYTE from string (8-bit unsigned integer). More... | |
| updateCIDtoGIDmap ($map, $cid, $gid) | |
| Update the CIDToGIDMap string with a new value. More... | |
| _getTrueTypeFontSubset ($font, $subsetchars) | |
| Returns a subset of the TrueType font data without the unused glyphs. More... | |
| _getTTFtableChecksum ($table, $length) | |
| Returs the checksum of a TTF table. More... | |
| _putfontwidths ($font, $cidoffset=0) | |
| Outputs font widths. More... | |
| _putfonts () | |
| Output fonts. More... | |
| _puttruetypeunicode ($font) | |
| Adds unicode fonts. More... | |
| _putcidfont0 ($font) | |
| Output CID-0 fonts. More... | |
| _putimages () | |
| Output images. More... | |
| _putxobjects () | |
| Output Form XObjects Templates. More... | |
| _putspotcolors () | |
| Output Spot Colors Resources. More... | |
| _getxobjectdict () | |
| Return XObjects Dictionary. More... | |
| _putresourcedict () | |
| Output Resources Dictionary. More... | |
| _putresources () | |
| Output Resources. More... | |
| _putinfo () | |
| Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference) More... | |
| _putXMP () | |
| Put XMP data object and return ID. More... | |
| _putcatalog () | |
| Output Catalog. More... | |
| _putviewerpreferences () | |
| Output viewer preferences. More... | |
| _putheader () | |
| Output PDF File Header (7.5.2). More... | |
| _enddoc () | |
| Output end of document (EOF). More... | |
| _beginpage ($orientation='', $format='') | |
| Initialize a new page. More... | |
| _endpage () | |
| Mark end of page. More... | |
| _newobj () | |
| Begin a new object and return the object number. More... | |
| _getobj ($objid='') | |
| Return the starting object string for the selected object ID. More... | |
| _dounderline ($x, $y, $txt) | |
| Underline text. More... | |
| _dounderlinew ($x, $y, $w) | |
| Underline for rectangular text area. More... | |
| _dolinethrough ($x, $y, $txt) | |
| Line through text. More... | |
| _dolinethroughw ($x, $y, $w) | |
| Line through for rectangular text area. More... | |
| _dooverline ($x, $y, $txt) | |
| Overline text. More... | |
| _dooverlinew ($x, $y, $w) | |
| Overline for rectangular text area. More... | |
| _freadint ($f) | |
| Read a 4-byte (32 bit) integer from file. More... | |
| _escape ($s) | |
| Add "\" before "\", "(" and ")". More... | |
| _datastring ($s, $n=0) | |
| Format a data string for meta information. More... | |
| _datestring ($n=0, $timestamp=0) | |
| Returns a formatted date for meta information. More... | |
| _textstring ($s, $n=0) | |
| Format a text string for meta information. More... | |
| _escapetext ($s) | |
| THIS METHOD IS DEPRECATED Format a text string. More... | |
| _escapeXML ($str) | |
| Escape some special characters (< > &) for XML output. More... | |
| _getrawstream ($s, $n=0) | |
| get raw output stream. More... | |
| _getstream ($s, $n=0) | |
| Format output stream (DEPRECATED). More... | |
| _putstream ($s, $n=0) | |
| Output a stream (DEPRECATED). More... | |
| _out ($s) | |
| Output a string to the document. More... | |
| UTF8StringToArray ($str) | |
| Converts UTF-8 strings to codepoints array. More... | |
| UTF8ToUTF16BE ($str, $setbom=false) | |
| Converts UTF-8 strings to UTF16-BE. More... | |
| UTF8ToLatin1 ($str) | |
| Converts UTF-8 strings to Latin1 when using the standard 14 core fonts. More... | |
| UTF8ArrToLatin1 ($unicode) | |
| Converts UTF-8 characters array to array of Latin1 characters More... | |
| arrUTF8ToUTF16BE ($unicode, $setbom=false) | |
| Converts array of UTF-8 characters to UTF16-BE string. More... | |
| getRandomSeed ($seed='') | |
| Returns a string containing random data to be used as a seed for encryption methods. More... | |
| _objectkey ($n) | |
| Compute encryption key depending on object number where the encrypted data is stored. More... | |
| _encrypt_data ($n, $s) | |
| Encrypt the input string. More... | |
| _putencryption () | |
| Put encryption on PDF document. More... | |
| _RC4 ($key, $text) | |
| Returns the input text encrypted using RC4 algorithm and the specified key. More... | |
| _AES ($key, $text) | |
| Returns the input text exrypted using AES algorithm and the specified key. More... | |
| _md5_16 ($str) | |
| Encrypts a string using MD5 and returns it's value as a binary string. More... | |
| _Uvalue () | |
| Compute U value (used for encryption) More... | |
| _UEvalue () | |
| Compute UE value (used for encryption) More... | |
| _Ovalue () | |
| Compute O value (used for encryption) More... | |
| _OEvalue () | |
| Compute OE value (used for encryption) More... | |
| _fixAES256Password ($password) | |
| Convert password for AES-256 encryption mode. More... | |
| _generateencryptionkey () | |
| Compute encryption key. More... | |
| getUserPermissionCode ($permissions, $mode=0) | |
| Return the premission code used on encryption (P value). More... | |
| convertHexStringToString ($bs) | |
| Convert hexadecimal string to string. More... | |
| convertStringToHexString ($s) | |
| Convert string to hexadecimal string (byte string) More... | |
| getEncPermissionsString ($protection) | |
| Convert encryption P value to a string of bytes, low-order byte first. More... | |
| Transform ($tm) | |
| Apply graphic transformations. More... | |
| _outPoint ($x, $y) | |
| Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. More... | |
| _outLine ($x, $y) | |
| Append a straight line segment from the current point to the point (x, y). More... | |
| _outRect ($x, $y, $w, $h, $op) | |
| Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space. More... | |
| _outCurve ($x1, $y1, $x2, $y2, $x3, $y3) | |
| Append a cubic Bézier curve to the current path. More... | |
| _outCurveV ($x2, $y2, $x3, $y3) | |
| Append a cubic Bézier curve to the current path. More... | |
| _outCurveY ($x1, $y1, $x3, $y3) | |
| Append a cubic Bézier curve to the current path. More... | |
| _outellipticalarc ($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false) | |
| Append an elliptical arc to the current path. More... | |
| utf8StrRev ($str, $setbom=false, $forcertl=false) | |
| Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). More... | |
| utf8StrArrRev ($arr, $str='', $setbom=false, $forcertl=false) | |
| Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). More... | |
| utf8Bidi ($ta, $str='', $forcertl=false) | |
| Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). More... | |
| encodeNameObject ($name) | |
| Encode a name object. More... | |
| _putdests () | |
| Insert Named Destinations. More... | |
| sortBookmarks () | |
| Sort bookmarks for page and key. More... | |
| _putbookmarks () | |
| Create a bookmark PDF string. More... | |
| _putjavascript () | |
| Create a javascript PDF string. More... | |
| _JScolor ($color) | |
| Convert color to javascript color. More... | |
| _addfield ($type, $name, $x, $y, $w, $h, $prop) | |
| Adds a javascript form field. More... | |
| getAnnotOptFromJSProp ($prop) | |
| Convert JavaScript form fields properties array to Annotation Properties array. More... | |
| _putsignature () | |
| Add certification signature (DocMDP or UR3) You can set only one signature type. More... | |
| getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1) | |
| Get the array that defines the signature appearance (page and rectangle coordinates). More... | |
| formatPageNumber ($num) | |
| Format the page numbers. More... | |
| formatTOCPageNumber ($num) | |
| Format the page numbers on the Table Of Content. More... | |
| _putocg () | |
| Put pdf layers. More... | |
| addExtGState ($parms) | |
| Add transparency parameters to the current extgstate. More... | |
| setExtGState ($gs) | |
| Add an extgstate. More... | |
| _putextgstates () | |
| Put extgstates for object transparency. More... | |
| Clip ($x, $y, $w, $h) | |
| Set a rectangular clipping area. More... | |
| _putshaders () | |
| Output gradient shaders. More... | |
| extractCSSproperties ($cssdata) | |
| Extracts the CSS properties from a CSS string. More... | |
| isValidCSSSelectorForTag ($dom, $key, $selector) | |
| Returns true if the CSS selector is valid for the selected HTML tag. More... | |
| getCSSdataArray ($dom, $key, $css) | |
| Returns the styles array that apply for the selected HTML tag. More... | |
| getTagStyleFromCSSarray ($css) | |
| Compact CSS data array into single string. More... | |
| getCSSBorderWidth ($width) | |
| Returns the border width from CSS property. More... | |
| getCSSBorderDashStyle ($style) | |
| Returns the border dash style from CSS property. More... | |
| getCSSBorderStyle ($cssborder) | |
| Returns the border style array from CSS border properties. More... | |
| getCSSFontSpacing ($spacing, $parent=0) | |
| Returns the letter-spacing value from CSS value. More... | |
| getCSSFontStretching ($stretch, $parent=100) | |
| Returns the percentage of font stretching from CSS value. More... | |
| getHtmlDomArray ($html) | |
| Returns the HTML DOM array. More... | |
| getSpaceString () | |
| Returns the string used to find spaces. More... | |
| openHTMLTagHandler ($dom, $key, $cell) | |
| Process opening tags. More... | |
| closeHTMLTagHandler ($dom, $key, $cell, $maxbottomliney=0) | |
| Process closing tags. More... | |
| addHTMLVertSpace ($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false) | |
| Add vertical spaces if needed. More... | |
| getBorderStartPosition () | |
| Return the starting coordinates to draw an html border. More... | |
| drawHTMLTagBorder ($tag, $xmax) | |
| Draw an HTML block border and fill. More... | |
| swapMargins ($reverse=true) | |
| Swap the left and right margins. More... | |
| putHtmlListBullet ($listdepth, $listtype='', $size=10) | |
| Output an HTML list bullet or ordered item symbol. More... | |
| getGraphicVars () | |
| Returns current graphic variables as array. More... | |
| setGraphicVars ($gvars, $extended=false) | |
| Set graphic variables. More... | |
| getObjFilename ($name) | |
| Returns a temporary filename for caching object on filesystem. More... | |
| writeDiskCache ($filename, $data, $append=false) | |
| Writes data to a temporary file on filesystem. More... | |
| readDiskCache ($filename) | |
| Read data from a temporary file on filesystem. More... | |
| setBuffer ($data) | |
| Set buffer content (always append data). More... | |
| replaceBuffer ($data) | |
| Replace the buffer content. More... | |
| getBuffer () | |
| Get buffer content. More... | |
| setPageBuffer ($page, $data, $append=false) | |
| Set page buffer content. More... | |
| getPageBuffer ($page) | |
| Get page buffer content. More... | |
| setImageBuffer ($image, $data) | |
| Set image buffer content. More... | |
| setImageSubBuffer ($image, $key, $data) | |
| Set image buffer content for a specified sub-key. More... | |
| getImageBuffer ($image) | |
| Get image buffer content. More... | |
| setFontBuffer ($font, $data) | |
| Set font buffer content. More... | |
| setFontSubBuffer ($font, $key, $data) | |
| Set font buffer content. More... | |
| getFontBuffer ($font) | |
| Get font buffer content. More... | |
| hyphenateWord ($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns an array of chars containing soft hyphens. More... | |
| getPathPaintOperator ($style, $default='S') | |
| Get the Path-Painting Operators. More... | |
| checkPageRegions ($h, $x, $y) | |
| Check page for no-write regions and adapt current coordinates and page margins if necessary. More... | |
| getSVGTransformMatrix ($attribute) | |
| Get the tranformation matrix from SVG transform attribute. More... | |
| getTransformationMatrixProduct ($ta, $tb) | |
| Get the product of two SVG tranformation matrices. More... | |
| convertSVGtMatrix ($tm) | |
| Convert SVG transformation matrix to PDF. More... | |
| SVGTransform ($tm) | |
| Apply SVG graphic transformation matrix. More... | |
| setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()) | |
| Apply the requested SVG styles (*** TO BE COMPLETED ***) More... | |
| SVGPath ($d, $style='') | |
| Draws an SVG path. More... | |
| getVectorsAngle ($x1, $y1, $x2, $y2) | |
| Returns the angle in radiants between two vectors. More... | |
| startSVGElementHandler ($parser, $name, $attribs, $ctm=array()) | |
| Sets the opening SVG element handler function for the XML parser. More... | |
| endSVGElementHandler ($parser, $name) | |
| Sets the closing SVG element handler function for the XML parser. More... | |
| segSVGContentHandler ($parser, $data) | |
| Sets the character data handler function for the XML parser. More... | |
Protected Attributes | |
| $page | |
| Current page number. More... | |
| $n | |
| Current object number. More... | |
| $offsets = array() | |
| Array of object offsets. More... | |
| $pageobjects = array() | |
| Array of object IDs for each page. More... | |
| $buffer | |
| Buffer holding in-memory PDF. More... | |
| $pages = array() | |
| Array containing pages. More... | |
| $state | |
| Current document state. More... | |
| $compress | |
| Compression flag. More... | |
| $CurOrientation | |
| Current page orientation (P = Portrait, L = Landscape). More... | |
| $pagedim = array() | |
| Page dimensions. More... | |
| $k | |
| Scale factor (number of points in user unit). More... | |
| $fwPt | |
| Width of page format in points. More... | |
| $fhPt | |
| Height of page format in points. More... | |
| $wPt | |
| Current width of page in points. More... | |
| $hPt | |
| Current height of page in points. More... | |
| $w | |
| Current width of page in user unit. More... | |
| $h | |
| Current height of page in user unit. More... | |
| $lMargin | |
| Left margin. More... | |
| $rMargin | |
| Right margin. More... | |
| $clMargin | |
| Cell left margin (used by regions). More... | |
| $crMargin | |
| Cell right margin (used by regions). More... | |
| $tMargin | |
| Top margin. More... | |
| $bMargin | |
| Page break margin. More... | |
| $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). More... | |
| $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). More... | |
| $x | |
| Current horizontal position in user unit for cell positioning. More... | |
| $y | |
| Current vertical position in user unit for cell positioning. More... | |
| $lasth | |
| Height of last cell printed. More... | |
| $LineWidth | |
| Line width in user unit. More... | |
| $CoreFonts | |
| Array of standard font names. More... | |
| $fonts = array() | |
| Array of used fonts. More... | |
| $FontFiles = array() | |
| Array of font files. More... | |
| $diffs = array() | |
| Array of encoding differences. More... | |
| $images = array() | |
| Array of used images. More... | |
| $cached_files = array() | |
| Array of cached files. More... | |
| $PageAnnots = array() | |
| Array of Annotations in pages. More... | |
| $links = array() | |
| Array of internal links. More... | |
| $FontFamily | |
| Current font family. More... | |
| $FontStyle | |
| Current font style. More... | |
| $FontAscent | |
| Current font ascent (distance between font top and baseline). More... | |
| $FontDescent | |
| Current font descent (distance between font bottom and baseline). More... | |
| $underline | |
| Underlining flag. More... | |
| $overline | |
| Overlining flag. More... | |
| $CurrentFont | |
| Current font info. More... | |
| $FontSizePt | |
| Current font size in points. More... | |
| $FontSize | |
| Current font size in user unit. More... | |
| $DrawColor | |
| Commands for drawing color. More... | |
| $FillColor | |
| Commands for filling color. More... | |
| $TextColor | |
| Commands for text color. More... | |
| $ColorFlag | |
| Indicates whether fill and text colors are different. More... | |
| $AutoPageBreak | |
| Automatic page breaking. More... | |
| $PageBreakTrigger | |
| Threshold used to trigger page breaks. More... | |
| $InHeader = false | |
| Flag set when processing page header. More... | |
| $InFooter = false | |
| Flag set when processing page footer. More... | |
| $ZoomMode | |
| Zoom display mode. More... | |
| $LayoutMode | |
| Layout display mode. More... | |
| $docinfounicode = true | |
| If true set the document information dictionary in Unicode. More... | |
| $title = '' | |
| Document title. More... | |
| $subject = '' | |
| Document subject. More... | |
| $author = '' | |
| Document author. More... | |
| $keywords = '' | |
| Document keywords. More... | |
| $creator = '' | |
| Document creator. More... | |
| $starting_page_number = 1 | |
| Starting page number. More... | |
| $alias_tot_pages = '{:ptp:}' | |
| String alias for total number of pages. More... | |
| $alias_num_page = '{:pnp:}' | |
| String alias for page number. More... | |
| $alias_group_tot_pages = '{:ptg:}' | |
| String alias for total number of pages in a single group. More... | |
| $alias_group_num_page = '{:png:}' | |
| String alias for group page number. More... | |
| $alias_right_shift = '{rsc:' | |
| String alias for right shift compensation used to correctly align page numbers on the right. More... | |
| $img_rb_x | |
| The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. More... | |
| $img_rb_y | |
| The right-bottom corner Y coordinate of last inserted image. More... | |
| $imgscale = 1 | |
| Adjusting factor to convert pixels to user units. More... | |
| $isunicode = false | |
| Boolean flag set to true when the input text is unicode (require unicode fonts). More... | |
| $unicode | |
| Object containing unicode data. More... | |
| $encmaps | |
| Object containing font encoding maps. More... | |
| $PDFVersion = '1.7' | |
| PDF version. More... | |
| $header_xobjid = -1 | |
| ID of the stored default header template (-1 = not set). More... | |
| $header_xobj_autoreset = false | |
| If true reset the Header Xobject template at each page. More... | |
| $header_margin | |
| Minimum distance between header and top page margin. More... | |
| $footer_margin | |
| Minimum distance between footer and bottom page margin. More... | |
| $original_lMargin | |
| Original left margin value. More... | |
| $original_rMargin | |
| Original right margin value. More... | |
| $header_font | |
| Default font used on page header. More... | |
| $footer_font | |
| Default font used on page footer. More... | |
| $l | |
| Language templates. More... | |
| $barcode = false | |
| Barcode to print on page footer (only if set). More... | |
| $print_header = true | |
| Boolean flag to print/hide page header. More... | |
| $print_footer = true | |
| Boolean flag to print/hide page footer. More... | |
| $header_logo = '' | |
| Header image logo. More... | |
| $header_logo_width = 30 | |
| Width of header image logo in user units. More... | |
| $header_title = '' | |
| Title to be printed on default page header. More... | |
| $header_string = '' | |
| String to pring on page header after title. More... | |
| $header_text_color = array(0,0,0) | |
| Color for header text (RGB array). More... | |
| $header_line_color = array(0,0,0) | |
| Color for header line (RGB array). More... | |
| $footer_text_color = array(0,0,0) | |
| Color for footer text (RGB array). More... | |
| $footer_line_color = array(0,0,0) | |
| Color for footer line (RGB array). More... | |
| $txtshadow = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal') | |
| Text shadow data array. More... | |
| $default_table_columns = 4 | |
| Default number of columns for html table. More... | |
| $HREF = array() | |
| HTML PARSER: array to store current link and rendering styles. More... | |
| $fontlist = array() | |
| List of available fonts on filesystem. More... | |
| $fgcolor | |
| Current foreground color. More... | |
| $listordered = array() | |
| HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise. More... | |
| $listcount = array() | |
| HTML PARSER: array count list items on nested lists. More... | |
| $listnum = 0 | |
| HTML PARSER: current list nesting level. More... | |
| $listindent = 0 | |
| HTML PARSER: indent amount for lists. More... | |
| $listindentlevel = 0 | |
| HTML PARSER: current list indententation level. More... | |
| $bgcolor | |
| Current background color. More... | |
| $tempfontsize = 10 | |
| Temporary font size in points. More... | |
| $lispacer = '' | |
| Spacer string for LI tags. More... | |
| $encoding = 'UTF-8' | |
| Default encoding. More... | |
| $internal_encoding | |
| PHP internal encoding. More... | |
| $rtl = false | |
| Boolean flag to indicate if the document language is Right-To-Left. More... | |
| $tmprtl = false | |
| Boolean flag used to force RTL or LTR string direction. More... | |
| $encrypted | |
| IBoolean flag indicating whether document is protected. More... | |
| $encryptdata = array() | |
| Array containing encryption settings. More... | |
| $last_enc_key | |
| Last RC4 key encrypted (cached for optimisation). More... | |
| $last_enc_key_c | |
| Last RC4 computed key. More... | |
| $enc_padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A" | |
| Encryption padding string. More... | |
| $file_id | |
| File ID (used on document trailer). More... | |
| $outlines = array() | |
| Outlines for bookmark. More... | |
| $OutlineRoot | |
| Outline root for bookmark. More... | |
| $javascript = '' | |
| Javascript code. More... | |
| $n_js | |
| Javascript counter. More... | |
| $linethrough | |
| line trough state More... | |
| $ur = array() | |
| Array with additional document-wide usage rights for the document. More... | |
| $dpi = 72 | |
| DPI (Dot Per Inch) Document Resolution (do not change). More... | |
| $newpagegroup = array() | |
| Array of page numbers were a new page group was started (the page numbers are the keys of the array). More... | |
| $pagegroups = array() | |
| Array that contains the number of pages in each page group. More... | |
| $currpagegroup = 0 | |
| Current page group number. More... | |
| $extgstates | |
| Array of transparency objects and parameters. More... | |
| $jpeg_quality | |
| Set the default JPEG compression quality (1-100). More... | |
| $cell_height_ratio = K_CELL_HEIGHT_RATIO | |
| Default cell height ratio. More... | |
| $viewer_preferences | |
| PDF viewer preferences. More... | |
| $PageMode | |
| A name object specifying how the document should be displayed when opened. More... | |
| $gradients = array() | |
| Array for storing gradient information. More... | |
| $intmrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). More... | |
| $bordermrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). More... | |
| $emptypagemrk = array() | |
| Array used to store page positions to track empty pages (keys are the page numbers). More... | |
| $cntmrk = array() | |
| Array used to store content positions inside the pages buffer (keys are the page numbers). More... | |
| $footerpos = array() | |
| Array used to store footer positions of each page. More... | |
| $footerlen = array() | |
| Array used to store footer length of each page. More... | |
| $newline = true | |
| Boolean flag to indicate if a new line is created. More... | |
| $endlinex = 0 | |
| End position of the latest inserted line. More... | |
| $linestyleWidth = '' | |
| PDF string for width value of the last line. More... | |
| $linestyleCap = '0 J' | |
| PDF string for CAP value of the last line. More... | |
| $linestyleJoin = '0 j' | |
| PDF string for join value of the last line. More... | |
| $linestyleDash = '[] 0 d' | |
| PDF string for dash value of the last line. More... | |
| $openMarkedContent = false | |
| Boolean flag to indicate if marked-content sequence is open. More... | |
| $htmlvspace = 0 | |
| Count the latest inserted vertical spaces on HTML. More... | |
| $spot_colors = array() | |
| Array of Spot colors. More... | |
| $lisymbol = '' | |
| Symbol used for HTML unordered list items. More... | |
| $epsmarker = 'x#!#EPS#!#x' | |
| String used to mark the beginning and end of EPS image blocks. More... | |
| $transfmatrix = array() | |
| Array of transformation matrix. More... | |
| $transfmatrix_key = 0 | |
| Current key for transformation matrix. More... | |
| $booklet = false | |
| Booklet mode for double-sided pages. More... | |
| $feps = 0.005 | |
| Epsilon value used for float calculations. More... | |
| $tagvspaces = array() | |
| Array used for custom vertical spaces for HTML tags. More... | |
| $customlistindent = -1 | |
| HTML PARSER: custom indent amount for lists. More... | |
| $opencell = true | |
| Boolean flag to indicate if the border of the cell sides that cross the page should be removed. More... | |
| $embeddedfiles = array() | |
| Array of files to embedd. More... | |
| $premode = false | |
| Boolean flag to indicate if we are inside a PRE tag. More... | |
| $transfmrk = array() | |
| Array used to store positions of graphics transformation blocks inside the page buffer. More... | |
| $htmlLinkColorArray = array(0, 0, 255) | |
| Default color for html links. More... | |
| $htmlLinkFontStyle = 'U' | |
| Default font style to add to html links. More... | |
| $numpages = 0 | |
| Counts the number of pages. More... | |
| $pagelen = array() | |
| Array containing page lengths in bytes. More... | |
| $numimages = 0 | |
| Counts the number of pages. More... | |
| $imagekeys = array() | |
| Store the image keys. More... | |
| $bufferlen = 0 | |
| Length of the buffer in bytes. More... | |
| $diskcache = false | |
| If true enables disk caching. More... | |
| $numfonts = 0 | |
| Counts the number of fonts. More... | |
| $fontkeys = array() | |
| Store the font keys. More... | |
| $font_obj_ids = array() | |
| Store the font object IDs. More... | |
| $pageopen = array() | |
| Store the fage status (true when opened, false when closed). More... | |
| $default_monospaced_font = 'courier' | |
| Default monospace font. More... | |
| $objcopy | |
| Cloned copy of the current class object. More... | |
| $cache_file_length = array() | |
| Array used to store the lengths of cache files. More... | |
| $thead = '' | |
| Table header content to be repeated on each new page. More... | |
| $theadMargins = array() | |
| Margins used for table header. More... | |
| $cache_UTF8StringToArray = array() | |
| Cache array for UTF8StringToArray() method. More... | |
| $cache_maxsize_UTF8StringToArray = 8 | |
| Maximum size of cache array used for UTF8StringToArray() method. More... | |
| $cache_size_UTF8StringToArray = 0 | |
| Current size of cache array used for UTF8StringToArray() method. More... | |
| $sign = false | |
| Boolean flag to enable document digital signature. More... | |
| $signature_data = array() | |
| Digital signature data. More... | |
| $signature_max_length = 11742 | |
| Digital signature max length. More... | |
| $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0') | |
| Data for digital signature appearance. More... | |
| $empty_signature_appearance = array() | |
| Array of empty digital signature appearances. More... | |
| $re_spaces = '/[^\S\xa0]/' | |
| Regular expression used to find blank characters (required for word-wrapping). More... | |
| $re_space = array('p' => '[^\S\xa0]', 'm' => '') | |
| Array of $re_spaces parts. More... | |
| $sig_obj_id = 0 | |
| Digital signature object ID. More... | |
| $byterange_string = '/ByteRange[0 ********** ********** **********]' | |
| ByteRange placemark used during digital signature process. More... | |
| $sig_annot_ref = '***SIGANNREF*** 0 R' | |
| Placemark used during digital signature process. More... | |
| $page_obj_id = array() | |
| ID of page objects. More... | |
| $form_obj_id = array() | |
| List of form annotations IDs. More... | |
| $default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128)) | |
| Deafult Javascript field properties. More... | |
| $js_objects = array() | |
| Javascript objects array. More... | |
| $form_action = '' | |
| Current form action (used during XHTML rendering). More... | |
| $form_enctype = 'application/x-www-form-urlencoded' | |
| Current form encryption type (used during XHTML rendering). More... | |
| $form_mode = 'post' | |
| Current method to submit forms. More... | |
| $annotation_fonts = array() | |
| List of fonts used on form fields (fontname => fontkey). More... | |
| $radiobutton_groups = array() | |
| List of radio buttons parent objects. More... | |
| $radio_groups = array() | |
| List of radio group objects IDs. More... | |
| $textindent = 0 | |
| Text indentation value (used for text-indent CSS attribute). More... | |
| $start_transaction_page = 0 | |
| Store page number when startTransaction() is called. More... | |
| $start_transaction_y = 0 | |
| Store Y position when startTransaction() is called. More... | |
| $inthead = false | |
| True when we are printing the thead section on a new page. More... | |
| $columns = array() | |
| Array of column measures (width, space, starting Y position). More... | |
| $num_columns = 1 | |
| Number of colums. More... | |
| $current_column = 0 | |
| Current column number. More... | |
| $column_start_page = 0 | |
| Starting page for columns. More... | |
| $maxselcol = array('page' => 0, 'column' => 0) | |
| Maximum page and column selected. More... | |
| $colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0)) | |
| Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding. More... | |
| $textrendermode = 0 | |
| 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. More... | |
| $textstrokewidth = 0 | |
| Text stroke width in doc units. More... | |
| $strokecolor | |
| Current stroke color. More... | |
| $pdfunit = 'mm' | |
| Default unit of measure for document. More... | |
| $tocpage = false | |
| Boolean flag true when we are on TOC (Table Of Content) page. More... | |
| $rasterize_vector_images = false | |
| Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library. More... | |
| $font_subsetting = true | |
| Boolean flag: if true enables font subsetting by default. More... | |
| $default_graphic_vars = array() | |
| Array of default graphic settings. More... | |
| $xobjects = array() | |
| Array of XObjects. More... | |
| $inxobj = false | |
| Boolean value true when we are inside an XObject. More... | |
| $xobjid = '' | |
| Current XObject ID. More... | |
| $font_stretching = 100 | |
| Percentage of character stretching. More... | |
| $font_spacing = 0 | |
| Increases or decreases the space between characters in a text by the specified amount (tracking). More... | |
| $page_regions = array() | |
| Array of no-write regions. More... | |
| $check_page_regions = true | |
| Boolean value true when page region check is active. More... | |
| $webcolor = array() | |
| Array containing HTML color names and values. More... | |
| $spotcolor = array() | |
| Array containing spot color names and values. More... | |
| $pdflayers = array() | |
| Array of PDF layers data. More... | |
| $dests = array() | |
| A dictionary of names and corresponding destinations (Dests key on document Catalog). More... | |
| $n_dests | |
| Object ID for Named Destinations. More... | |
| $svgdir = '' | |
| Directory used for the last SVG image. More... | |
| $svgunit = 'px' | |
| Deafult unit of measure for SVG. More... | |
| $svggradients = array() | |
| Array of SVG gradients. More... | |
| $svggradientid = 0 | |
| ID of last SVG gradient. More... | |
| $svgdefsmode = false | |
| Boolean value true when in SVG defs group. More... | |
| $svgdefs = array() | |
| Array of SVG defs. More... | |
| $svgclipmode = false | |
| Boolean value true when in SVG clipPath tag. More... | |
| $svgclippaths = array() | |
| Array of SVG clipPath commands. More... | |
| $svgcliptm = array() | |
| Array of SVG clipPath tranformation matrix. More... | |
| $svgclipid = 0 | |
| ID of last SVG clipPath. More... | |
| $svgtext = '' | |
| SVG text. More... | |
| $svgtextmode = array() | |
| SVG text properties. More... | |
| $svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode') | |
| Array of hinheritable SVG properties. More... | |
| $svgstyles | |
| Array of SVG properties. More... | |
| $force_srgb = false | |
| If true force sRGB color profile for all document. More... | |
| $pdfa_mode = false | |
| If true set the document to PDF/A mode. More... | |
| $doc_creation_timestamp | |
| Document creation date-time. More... | |
| $doc_modification_timestamp | |
| Document modification date-time. More... | |
| $custom_xmp = '' | |
| Custom XMP data. More... | |
| $overprint = array('OP' => false, 'op' => false, 'OPM' => 0) | |
| Overprint mode array. More... | |
| $alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => false) | |
| Alpha mode array. More... | |
| $page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox') | |
| Define the page boundaries boxes to be set on document. More... | |
| $pdfproducer | |
| Set the document producer metadata. More... | |
| $tcpdflink = true | |
| If true print TCPDF meta link. More... | |
| $gdgammacache = array() | |
| Cache array for computed GD gamma values. More... | |
PHP class for generating PDF documents without requiring external extensions.
TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
| __construct | ( | $orientation = 'P', |
|
$unit = 'mm', |
|||
$format = 'A4', |
|||
$unicode = true, |
|||
$encoding = 'UTF-8', |
|||
$diskcache = false, |
|||
$pdfa = false |
|||
| ) |
This is the class constructor.
It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $unit | (string) User measure unit. Possible values are:
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) 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 | (boolean) TRUE means that the input text is unicode (default = true) |
| $encoding | (string) Charset encoding; default is UTF-8. |
| $diskcache | (boolean) If TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower). |
| $pdfa | (boolean) If TRUE set the document to PDF/A mode. |
|
protected |
Adds a javascript form field.
| $type | (string) field type |
| $name | (string) field name |
| $x | (int) horizontal position |
| $y | (int) vertical position |
| $w | (int) width |
| $h | (int) height |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
|
protected |
|
protected |
Initialize a new page.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $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(). |
|
protected |
|
protected |
| _destroy | ( | $destroyall = false, |
|
$preserve_objcopy = false |
|||
| ) |
Unset all class variables except the following critical variables.
| $destroyall | (boolean) if true destroys all class variables, otherwise preserves critical variables. |
| $preserve_objcopy | (boolean) if true preserves the objcopy variable |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Returns a subset of the TrueType font data without the unused glyphs.
| $font | (string) TrueType font data. |
| $subsetchars | (array) Array of used characters (the glyphs to keep). |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Append a cubic Bézier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
| $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. |
|
protected |
Append a cubic Bézier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
| $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. |
|
protected |
Append a cubic Bézier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points. The new current point shall be (x3, y3).
| $x1 | (float) Abscissa of control point 1. |
| $y1 | (float) Ordinate of control point 1. |
| $x3 | (float) Abscissa of end point. |
| $y3 | (float) Ordinate of end point. |
|
protected |
Append an elliptical arc to the current path.
An ellipse is formed from n Bezier curves.
| $xc | (float) Abscissa of center point. |
| $yc | (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. |
| $xang | (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0. |
| $angs | (float) Angle start of draw line. Default value: 0. |
| $angf | (float) Angle finish of draw line. Default value: 360. |
| $pie | (boolean) if true do not mark the border point (used to draw pie sectors). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
| $startpoint | (boolean) if true output a starting point. |
| $ccw | (boolean) if true draws in counter-clockwise. |
| $svg | (boolean) if true the angles are in svg mode (already calculated). |
|
protected |
|
protected |
|
protected |
Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $op | (string) options |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Output Form XObjects Templates.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Convert the loaded image to a PNG and then return a structure for the PDF creator.
This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
| $image | (image) Image object. return image PNG image object. |
|
protected |
|
protected |
| AcceptPageBreak | ( | ) |
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
The default implementation returns a value according to the mode selected by SetAutoPageBreak().
This method is called automatically and should not be called directly by the application.
| addEmptySignatureAppearance | ( | $x = 0, |
|
$y = 0, |
|||
$w = 0, |
|||
$h = 0, |
|||
$page = -1 |
|||
| ) |
Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
| $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) option page number (if < 0 the current page is used). |
|
protected |
| AddFont | ( | $family, | |
$style = '', |
|||
$fontfile = '', |
|||
$subset = 'default' |
|||
| ) |
Imports a TrueType, Type1, core, or CID0 font and makes it available.
It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
| $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):
|
| $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) 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. |
| addHtmlLink | ( | $url, | |
| $name, | |||
$fill = false, |
|||
$firstline = false, |
|||
$color = '', |
|||
$style = -1, |
|||
$firstblock = false |
|||
| ) |
Output anchor link.
| $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 | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $firstline | (boolean) if true prints only the first line and return the remaining string. |
| $color | (array) array of RGB text color |
| $style | (string) font style (U, D, B, I) |
| $firstblock | (boolean) if true the string is the starting of a line. |
| addHTMLTOC | ( | $page = '', |
|
$toc_name = 'TOC', |
|||
$templates = array(), |
|||
$correct_align = true, |
|||
$style = '', |
|||
$color = array(0,0,0) |
|||
| ) |
Output a Table Of Content Index (TOC) using HTML templates.
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.
| $page | (int) page number where this TOC should be inserted (leave empty for current page). |
| $toc_name | (string) name to use for TOC bookmark. |
| $templates | (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number. |
| $correct_align | (boolean) 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) RGB color array for title (values from 0 to 255). |
|
protected |
Add vertical spaces if needed.
| $hbz | (string) Distance between current y and line bottom. |
| $hb | (string) The height of the break. |
| $cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
| $firsttag | (boolean) set to true when the tag is the first. |
| $lasttag | (boolean) set to true when the tag is the last. |
| addJavascriptObject | ( | $script, | |
$onload = false |
|||
| ) |
| AddLink | ( | ) |
| AddPage | ( | $orientation = '', |
|
$format = '', |
|||
$keepmargins = false, |
|||
$tocpage = false |
|||
| ) |
Adds a new page to the document.
If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled). The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $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 | (boolean) if true overwrites the default page margins with the current margins |
| $tocpage | (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content). |
| addPageRegion | ( | $region | ) |
Add a single no-write region on selected page.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
| $region | (array) 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). |
| AddSpotColor | ( | $name, | |
| $c, | |||
| $m, | |||
| $y, | |||
| $k | |||
| ) |
Defines a new spot color.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $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. |
| addTOC | ( | $page = '', |
|
$numbersfont = '', |
|||
$filler = '.', |
|||
$toc_name = 'TOC', |
|||
$style = '', |
|||
$color = array(0,0,0) |
|||
| ) |
Output a Table of Content Index (TOC).
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.
| $page | (int) 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) name to use for TOC bookmark. |
| $style | (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array for bookmark title (values from 0 to 255). |
| addTOCPage | ( | $orientation = '', |
|
$format = '', |
|||
$keepmargins = false |
|||
| ) |
Adds a new TOC (Table Of Content) page to the document.
| $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 | (boolean) if true overwrites the default page margins with the current margins |
| addTTFfont | ( | $fontfile, | |
$fonttype = '', |
|||
$enc = '', |
|||
$flags = 32, |
|||
$outpath = '', |
|||
$platid = 3, |
|||
$encid = 1, |
|||
$addcbbox = false |
|||
| ) |
Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable).
| $fontfile | (string) Font file (full path). |
| $fonttype | (string) Font type. Leave empty for autodetect mode. Valid values are: TrueTypeUnicode, TrueType, Type1, CID0JP = CID-0 Japanese, CID0KR = CID-0 Korean, CID0CS = CID-0 Chinese Simplified, CID0CT = CID-0 Chinese Traditional. |
| $enc | (string) Name of the encoding table to use. Leave empty for default mode. Omit this parameter for TrueType Unicode and symbolic fonts like Symbol or ZapfDingBats. |
| $flags | (int) Unsigned 32-bit integer containing flags specifying various characteristics of the font (PDF32000:2008 - 9.8.2 Font Descriptor Flags): +1 for fixed font; +4 for symbol or +32 for non-symbol; +64 for italic. Fixed and Italic mode are generally autodetected so you have to set it to 32 = non-symbolic font (default) or 4 = symbolic font. |
| $outpath | (string) Output path for generated font files (must be writeable by the web server). Leave empty for default font folder. |
| $platid | (int) Platform ID for CMAP table to extract (when building a Unicode font for Windows this value should be 3, for Macintosh should be 1). |
| $encid | (int) Encoding ID for CMAP table to extract (when building a Unicode font for Windows this value should be 1, for Macintosh should be 0). When Platform ID is 3, legal values for Encoding ID are: 0=Symbol, 1=Unicode, 2=ShiftJIS, 3=PRC, 4=Big5, 5=Wansung, 6=Johab, 7=Reserved, 8=Reserved, 9=Reserved, 10=UCS-4. |
| $addcbbox | (boolean) If true includes the character bounding box information on the php font file. |
|
protected |
Adjust the internal Cell padding array to take account of the line width.
| $brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| AliasNbPages | ( | $s = '' | ) |
| AliasNumPage | ( | $s = '' | ) |
| Annotation | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $text, | |||
$opt = array('Subtype'=>'Text'), |
|||
$spaces = 0 |
|||
| ) |
Puts a markup annotation on a rectangular area of the page.
!!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
| $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) array of options (see section 8.4 of PDF reference 1.7). |
| $spaces | (int) number of spaces on the text to link |
| Arrow | ( | $x0, | |
| $y0, | |||
| $x1, | |||
| $y1, | |||
$head_style = 0, |
|||
$arm_size = 5, |
|||
$arm_angle = 15 |
|||
| ) |
Draws a grahic arrow.
| $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) length of arrowhead arms |
| $arm_angle | (int) angle between an arm and the shaft |
|
protected |
Converts array of UTF-8 characters to UTF16-BE string.
Based on: http://www.faqs.org/rfcs/rfc2781.html
Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to UTF-16 proceeds as follows. Let U be the character number, no greater than 0x10FFFF.
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate. 2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits. 3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits. 4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate.Graphically, steps 2 through 4 look like: U' = yyyyyyyyyyxxxxxxxxxx W1 = 110110yyyyyyyyyy W2 = 110111xxxxxxxxxx
| $unicode | (array) array containing UTF-8 unicode values |
| $setbom | (boolean) if true set the Byte Order Mark (BOM = 0xFEFF) |
| Bookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0), |
|||
$x = -1 |
|||
| ) |
Adds a bookmark.
| $txt | (string) Bookmark description. |
| $level | (int) Bookmark level (minimum value is 0). |
| $y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
| $style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array (values from 0 to 255). |
| $x | (float) X position in user units of the bookmark on the selected page (default = -1 = current position;). |
| Button | ( | $name, | |
| $w, | |||
| $h, | |||
| $caption, | |||
| $action, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a button field.
| $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) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
| Cell | ( | $w, | |
$h = 0, |
|||
$txt = '', |
|||
$border = 0, |
|||
$ln = 0, |
|||
$align = '', |
|||
$fill = false, |
|||
$link = '', |
|||
$stretch = 0, |
|||
$ignore_min_height = false, |
|||
$calign = 'T', |
|||
$valign = 'M' |
|||
| ) |
Prints a cell (rectangular area) with optional borders, background color and character string.
The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
| $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:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) 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:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
| CheckBox | ( | $name, | |
| $w, | |||
$checked = false, |
|||
$prop = array(), |
|||
$opt = array(), |
|||
$onvalue = 'Yes', |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a CheckBox field.
| $name | (string) field name |
| $w | (int) width |
| $checked | (boolean) define the initial state. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $onvalue | (string) value to be returned if selected. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
|
protected |
Add page if needed.
| $h | (float) Cell height. Default value: 0. |
| $y | (mixed) starting y position, leave empty for current position. |
| $addpage | (boolean) if true add a page, otherwise only return the true/false state |
|
protected |
Check page for no-write regions and adapt current coordinates and page margins if necessary.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
| $h | (float) height of the text/image/object to print in user units |
| $x | (float) current X coordinate in user units |
| $y | (float) current Y coordinate in user units |
| Circle | ( | $x0, | |
| $y0, | |||
| $r, | |||
$angstr = 0, |
|||
$angend = 360, |
|||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$nc = 2 |
|||
| ) |
Draws a circle.
A circle is formed from n Bezier curves.
| $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) Angle finish of draw line. Default value: 360. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of circle. |
|
protected |
Set a rectangular clipping area.
| $x | (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode). |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
| Close | ( | ) |
|
protected |
Process closing tags.
| $dom | (array) html dom array |
| $key | (int) current element id |
| $cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
| $maxbottomliney | (int) maximum y value of current line |
| colorRegistrationBar | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$transition = true, |
|||
$vertical = false, |
|||
$colors = 'A, |
|||
| R | , | ||
| G | , | ||
| B | , | ||
| C | , | ||
| M | , | ||
| Y | , | ||
| K' | |||
| ) |
Paints color transition registration bars.
| $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 | (boolean) if true prints tcolor transitions to white. |
| $vertical | (boolean) if true prints bar vertically. |
| $colors | (string) colors to print, one letter per color separated by comma (for example 'A,W,R,G,B,C,M,Y,K'): A=black, W=white, R=red, G=green, B=blue, C=cyan, M=magenta, Y=yellow, K=black. |
| ComboBox | ( | $name, | |
| $w, | |||
| $h, | |||
| $values, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a Combo-box field.
| $name | (string) field name |
| $w | (int) width |
| $h | (int) height |
| $values | (array) array containing the list of values. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
| commitTransaction | ( | ) |
|
protected |
| convertHTMLColorToDec | ( | $hcolor = '#FFFFFF', |
|
$defcol = array('R'=>128,'G'=>128,'B'=>128) |
|||
| ) |
Returns an array (RGB or CMYK) from an html color name, or a six-digit (i.e.
#3FE5AA), or three-digit (i.e. #7FF) hexadecimal color, or a javascript color array, or javascript color name.
| $hcolor | (string) HTML color. |
| $defcol | (array) Color to return in case of error. |
|
protected |
|
protected |
| CoonsPatchMesh | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$col1 = array(), |
|||
$col2 = array(), |
|||
$col3 = array(), |
|||
$col4 = array(), |
|||
$coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33), |
|||
$coords_min = 0, |
|||
$coords_max = 1, |
|||
$antialias = false |
|||
| ) |
Paints a coons patch mesh.
| $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) first color (lower left corner) (RGB components). |
| $col2 | (array) second color (lower right corner) (RGB components). |
| $col3 | (array) third color (upper right corner) (RGB components). |
| $col4 | (array) fourth color (upper left corner) (RGB components). |
| $coords | (array)
|
| $coords_min | (array) 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) 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 | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
| copyPage | ( | $page = 0 | ) |
| cropMark | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$type = 'T, |
|||
| R | , | ||
| B | , | ||
| L' | , | ||
$color = array(0,0,0) |
|||
| ) |
Paints crop marks.
| $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) 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) crop mark color (default black). |
| Curve | ( | $x0, | |
| $y0, | |||
| $x1, | |||
| $y1, | |||
| $x2, | |||
| $y2, | |||
| $x3, | |||
| $y3, | |||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a Bezier curve.
The Bezier curve is a tangent to the line between the control points at either end of the curve.
| $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) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (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). |
| deletePage | ( | $page | ) |
|
protected |
| Ellipse | ( | $x0, | |
| $y0, | |||
| $rx, | |||
$ry = '', |
|||
$angle = 0, |
|||
$astart = 0, |
|||
$afinish = 360, |
|||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$nc = 2 |
|||
| ) |
Draws an ellipse.
An ellipse is formed from n Bezier curves.
| $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) Angle finish of draw line. Default value: 360. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (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 | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
| empty_string | ( | $str | ) |
|
protected |
| endLayer | ( | ) |
| endPage | ( | $tocpage = false | ) |
Terminate the current page.
| $tocpage | (boolean) if true set the tocpage state to false (end the page used to display Table Of Content). |
|
protected |
Sets the closing SVG element handler function for the XML parser.
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
| endTemplate | ( | ) |
End the current XObject Template started with startTemplate() and restore the previous graphic state.
An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
| endTOCPage | ( | ) |
Terminate the current TOC (Table Of Content) page.
| Error | ( | $msg | ) |
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution.
An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid. 2004-06-11 :: Nicola Asuni : changed bold tag with strong
| $msg | (string) The error message |
|
protected |
|
protected |
Set the block dimensions accounting for page breaks and page/column fitting.
| $w | (float) width |
| $h | (float) height |
| $x | (float) X coordinate |
| $y | (float) Y coodiante |
| $fitonpage | (boolean) if true the block is resized to not exceed page dimensions. |
| fixHTMLCode | ( | $html, | |
$default_css = '', |
|||
$tagvs = '', |
|||
$tidy_options = '' |
|||
| ) |
Cleanup HTML code (requires HTML Tidy library).
| $html | (string) htmlcode to fix |
| $default_css | (string) CSS commands to add |
| $tagvs | (array) parameters for setHtmlVSpace method |
| $tidy_options | (array) options for tidy_parse_string function |
| Footer | ( | ) |
|
protected |
|
protected |
Format the page numbers on the Table Of Content.
This method can be overriden for custom formats.
| $num | (int) page number |
| get_mqr | ( | ) |
| getAbsFontMeasure | ( | $s | ) |
| GetAbsX | ( | ) |
| getAliasNbPages | ( | ) |
Returns the string alias used for the total number of pages.
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in the document.
| getAliasNumPage | ( | ) |
| getAliasRightShift | ( | ) |
|
protected |
| getAlpha | ( | ) |
|
protected |
Convert JavaScript form fields properties array to Annotation Properties array.
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| GetArrStringWidth | ( | $sa, | |
$fontname = '', |
|||
$fontstyle = '', |
|||
$fontsize = 0, |
|||
$getarray = false |
|||
| ) |
Returns the string length of an array of chars in user unit or an array of characters widths.
A font must be selected.
| $sa | (string) 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):
|
| $fontsize | (float) Font size in points. The default value is the current size. |
| $getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
| getAutoPageBreak | ( | ) |
| getBarcode | ( | ) |
|
protected |
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
| $brd | (mixed) Indicates if borders must be drawn around the cell block. The value can be a number:
|
| $position | (string) multicell position: 'start', 'middle', 'end' |
|
protected |
| getBreakMargin | ( | $pagenum = '' | ) |
Returns the page break margin.
| $pagenum | (int) page number (empty = current page) |
|
protected |
|
protected |
Returns the code to draw the cell border.
| $x | (float) X coordinate. |
| $y | (float) Y coordinate. |
| $w | (float) Cell width. |
| $h | (float) Cell height. |
| $brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
|
protected |
Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string.
The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
| $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:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) 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:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
| getCellHeightRatio | ( | ) |
| getCellMargins | ( | ) |
Get the internal Cell margin array.
| getCellPaddings | ( | ) |
Get the internal Cell padding array.
| getCharBBox | ( | $char | ) |
| GetCharWidth | ( | $char, | |
$notlast = true |
|||
| ) |
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
| $char | (int) The char code whose length is to be returned |
| $notlast | (boolean) If false ignore the font-spacing. |
|
protected |
| getColumn | ( | ) |
|
protected |
| getCSSBorderMargin | ( | $cssbspace, | |
$width = 0 |
|||
| ) |
|
protected |
|
protected |
|
protected |
Returns the styles array that apply for the selected HTML tag.
| $dom | (array) array of HTML tags and properties |
| $key | (int) key of the current HTML tag |
| $css | (array) array of CSS properties |
|
protected |
Returns the letter-spacing value from CSS value.
| $spacing | (string) letter-spacing value |
| $parent | (float) font spacing (tracking) value of the parent element |
|
protected |
| getCSSMargin | ( | $cssmargin, | |
$width = 0 |
|||
| ) |
| getCSSPadding | ( | $csspadding, | |
$width = 0 |
|||
| ) |
| getDestination | ( | ) |
| getDocCreationTimestamp | ( | ) |
| getDocModificationTimestamp | ( | ) |
|
protected |
| getFontAscent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
| getFontBBox | ( | ) |
|
protected |
| getFontDescent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
| getFontFamily | ( | ) |
| getFontFamilyName | ( | $fontfamily | ) |
| getFontSize | ( | ) |
| getFontSizePt | ( | ) |
|
protected |
| getFontSpacing | ( | ) |
| getFontStretching | ( | ) |
| getFontStyle | ( | ) |
| getFontSubsetting | ( | ) |
| getFooterFont | ( | ) |
| getFooterMargin | ( | ) |
| getFormattedDate | ( | $time | ) |
| getFormDefaultProp | ( | ) |
|
protected |
|
protected |
| getGroupPageNo | ( | ) |
| getGroupPageNoFormatted | ( | ) |
Returns the current group page number formatted as a string.
| getHeaderData | ( | ) |
| getHeaderFont | ( | ) |
| getHeaderMargin | ( | ) |
|
protected |
| getHTMLUnitToUnits | ( | $htmlval, | |
$refsize = 1, |
|||
$defaultunit = 'px', |
|||
$points = false |
|||
| ) |
Convert HTML string containing value and unit of measure to user's units or points.
| $htmlval | (string) string containing values and unit |
| $refsize | (string) reference value in points |
| $defaultunit | (string) default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt). |
| $points | (boolean) if true returns points, otherwise returns value in user's units |
| getHyphenPatternsFromTEX | ( | $file | ) |
Returns an array of hyphenation patterns.
| $file | (string) TEX file containing hypenation patterns. TEX pattrns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/ |
|
protected |
| getImageFileType | ( | $imgfile, | |
$iminfo = array() |
|||
| ) |
Return the image type given the file name or array returned by getimagesize() function.
| $imgfile | (string) image file name |
| $iminfo | (array) array of image information returned by getimagesize() function. |
| getImageRBX | ( | ) |
| getImageRBY | ( | ) |
| getImageScale | ( | ) |
|
protected |
| getLastH | ( | ) |
| GetLineWidth | ( | ) |
Returns the current the line width.
| getMargins | ( | ) |
Returns an array containing current margins:
| getNumberOfColumns | ( | ) |
| GetNumChars | ( | $s | ) |
| getNumLines | ( | $txt, | |
$w = 0, |
|||
$reseth = false, |
|||
$autopadding = true, |
|||
$cellpadding = '', |
|||
$border = 0 |
|||
| ) |
This method return the estimated number of lines for print a simple text string using Multicell() method.
| $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 | (boolean) if true reset the last cell height (default false). |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
| $cellpadding | (float) 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:
|
| getNumPages | ( | ) |
|
protected |
| getOriginalMargins | ( | ) |
| getOverprint | ( | ) |
| getPage | ( | ) |
Get current document page number.
|
protected |
| getPageDimensions | ( | $pagenum = '' | ) |
Returns an array of page dimensions:
| $pagenum | (int) page number (empty = current page) |
| getPageGroupAlias | ( | ) |
Return the alias for the total number of pages in the current page group.
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.
| getPageHeight | ( | $pagenum = '' | ) |
Returns the page height in units.
| $pagenum | (int) page number (empty = current page) |
| getPageNumGroupAlias | ( | ) |
Return the alias for the page number on the current page group.
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number (relative to the belonging group).
| getPageRegions | ( | ) |
Return an array of no-write page regions.
| getPageSizeFromFormat | ( | $format | ) |
Get page dimensions from format name.
| $format | (mixed) The format name. It can be:
|
| getPageWidth | ( | $pagenum = '' | ) |
Returns the page width in units.
| $pagenum | (int) page number (empty = current page) |
|
protected |
Get the Path-Painting Operators.
| $style | (string) Style of rendering. Possible values are:
|
| $default | (string) default style |
|
protected |
| getRawCharWidth | ( | $char | ) |
|
protected |
| getRTL | ( | ) |
| getScaleFactor | ( | ) |
|
protected |
Get the array that defines the signature appearance (page and rectangle coordinates).
| $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) option page number (if < 0 the current page is used). |
|
protected |
| getSpotColor | ( | $name | ) |
| getStringHeight | ( | $w, | |
| $txt, | |||
$reseth = false, |
|||
$autopadding = true, |
|||
$cellpadding = '', |
|||
$border = 0 |
|||
| ) |
This method return the estimated height needed for printing a simple text string using the Multicell() method.
Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
| $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 | (boolean) if true reset the last cell height (default false). |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
| $cellpadding | (float) 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:
|
| GetStringWidth | ( | $s, | |
$fontname = '', |
|||
$fontstyle = '', |
|||
$fontsize = 0, |
|||
$getarray = false |
|||
| ) |
Returns the length of a string in user unit.
A font must be selected.
| $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):
|
| $fontsize | (float) Font size in points. The default value is the current size. |
| $getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
|
protected |
|
protected |
| getTCPDFVersion | ( | ) |
| getTextShadow | ( | ) |
| getTimestamp | ( | $date | ) |
|
protected |
|
protected |
Return the premission code used on encryption (P value).
| $permissions | (Array) the set of permissions (specify the ones you want to block). |
| $mode | (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit. |
|
protected |
Returns the angle in radiants between two vectors.
| $x1 | (int) X coordinate of first vector point |
| $y1 | (int) Y coordinate of first vector point |
| $x2 | (int) X coordinate of second vector point |
| $y2 | (int) Y coordinate of second vector point |
| GetX | ( | ) |
| GetY | ( | ) |
| Gradient | ( | $type, | |
| $coords, | |||
| $stops, | |||
$background = array(), |
|||
$antialias = false |
|||
| ) |
Output gradient.
| $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) array of coordinates. |
| $stops | (array) 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) An array of colour components appropriate to the colour space, specifying a single background colour value. |
| $antialias | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
| Header | ( | ) |
| hyphenateText | ( | $text, | |
| $patterns, | |||
$dictionary = array(), |
|||
$leftmin = 1, |
|||
$rightmin = 2, |
|||
$charmin = 1, |
|||
$charmax = 8 |
|||
| ) |
Returns text with soft hyphens.
| $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) Array of words to be returned without applying the hyphenation algoritm. |
| $leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
| $rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
| $charmin | (int) Minimum word length to apply the hyphenation algoritm. |
| $charmax | (int) Maximum length of broken piece of word. |
|
protected |
Returns an array of chars containing soft hyphens.
| $word | (array) array of chars |
| $patterns | (array) Array of hypenation patterns. |
| $dictionary | (array) Array of words to be returned without applying the hyphenation algoritm. |
| $leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
| $rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
| $charmin | (int) Minimum word length to apply the hyphenation algoritm. |
| $charmax | (int) Maximum length of broken piece of word. |
| Image | ( | $file, | |
$x = '', |
|||
$y = '', |
|||
$w = 0, |
|||
$h = 0, |
|||
$type = '', |
|||
$link = '', |
|||
$align = '', |
|||
$resize = false, |
|||
$dpi = 300, |
|||
$palign = '', |
|||
$ismask = false, |
|||
$imgmask = false, |
|||
$border = 0, |
|||
$fitbox = false, |
|||
$hidden = false, |
|||
$fitonpage = false, |
|||
$alt = false, |
|||
$altimgs = array() |
|||
| ) |
Puts an image in the page.
The upper-left corner must be given. The dimensions can be specified in different ways:
Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
| $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) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL). |
| $y | (float) 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:
|
| $resize | (mixed) 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) dot-per-inch resolution used on resize |
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $ismask | (boolean) true if this image is a mask, false otherwise |
| $imgmask | (mixed) 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:
|
| $fitbox | (mixed) 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 | (boolean) If true do not display the image. |
| $fitonpage | (boolean) If true the image is resized to not exceed page dimensions. |
| $alt | (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned). |
| $altimgs | (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. |
| ImageEps | ( | $file, | |
$x = '', |
|||
$y = '', |
|||
$w = 0, |
|||
$h = 0, |
|||
$link = '', |
|||
$useBoundingBox = true, |
|||
$align = '', |
|||
$palign = '', |
|||
$border = 0, |
|||
$fitonpage = false, |
|||
$fixoutvals = false |
|||
| ) |
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
| $file | (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) 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 | (boolean) 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:
|
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
| $fixoutvals | (boolean) if true remove values outside the bounding box. |
|
protected |
Extract info from a PNG image with alpha channel using the GD library.
| $file | (string) Name of the file containing the image. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $wpx | (float) Original width of the image in pixels. |
| $hpx | (float) original height of the image in pixels. |
| $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:
|
| $resize | (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library). |
| $dpi | (int) dot-per-inch resolution used on resize |
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $filehash | (string) File hash used to build unique file names. |
| ImageSVG | ( | $file, | |
$x = '', |
|||
$y = '', |
|||
$w = 0, |
|||
$h = 0, |
|||
$link = '', |
|||
$align = '', |
|||
$palign = '', |
|||
$border = 0, |
|||
$fitonpage = false |
|||
| ) |
Embedd a Scalable Vector Graphics (SVG) image.
NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
| $file | (string) Name of the SVG file or a '@' character followed by the SVG data string. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) 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:
|
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
| IncludeJS | ( | $script | ) |
|
protected |
| intToRoman | ( | $number | ) |
| isCharDefined | ( | $char, | |
$font = '', |
|||
$style = '' |
|||
| ) |
Return true in the character is present in the specified font.
| $char | (mixed) Character to check (integer value or string) |
| $font | (string) Font name (family name). |
| $style | (string) Font style. |
| isRTLTextDir | ( | ) |
| isUnicodeFont | ( | ) |
|
protected |
Returns true if the CSS selector is valid for the selected HTML tag.
| $dom | (array) array of HTML tags and properties |
| $key | (int) key of the current HTML tag |
| $selector | (string) CSS selector string |
| lastPage | ( | $resetmargins = false | ) |
Reset pointer to the last document page.
| $resetmargins | (boolean) if true reset left, right, top margins and Y position. |
| Line | ( | $x1, | |
| $y1, | |||
| $x2, | |||
| $y2, | |||
$style = array() |
|||
| ) |
Draws a line between two points.
| $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) Line style. Array like for SetLineStyle(). Default value: default line style (empty array). |
| LinearGradient | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$col1 = array(), |
|||
$col2 = array(), |
|||
$coords = array(0,0,1,0) |
|||
| ) |
Paints a linear colour gradient.
| $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) first color (Grayscale, RGB or CMYK components). |
| $col2 | (array) second color (Grayscale, RGB or CMYK components). |
| $coords | (array) 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). |
| Link | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $link, | |||
$spaces = 0 |
|||
| ) |
Puts a link on a rectangular area of the page.
Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
| $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 |
| ListBox | ( | $name, | |
| $w, | |||
| $h, | |||
| $values, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a List-box field.
| $name | (string) field name |
| $w | (int) width |
| $h | (int) height |
| $values | (array) array containing the list of values. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
| Ln | ( | $h = '', |
|
$cell = false |
|||
| ) |
Performs a line break.
The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
| $h | (float) The height of the break. By default, the value equals the height of the last printed cell. |
| $cell | (boolean) if true add the current left (or right o for RTL) padding to the X coordinate |
| MirrorH | ( | $x = '' | ) |
Horizontal Mirroring.
| $x | (int) abscissa of the point. Default is current x position |
| MirrorL | ( | $angle = 0, |
|
$x = '', |
|||
$y = '' |
|||
| ) |
Reflection against a straight line through point (x, y) with the gradient angle (angle).
| $angle | (float) gradient angle of the straight line. Default is 0 (horizontal line). |
| $x | (int) abscissa of the point. Default is current x position |
| $y | (int) ordinate of the point. Default is current y position |
| MirrorP | ( | $x = '', |
|
$y = '' |
|||
| ) |
Point reflection mirroring.
| $x | (int) abscissa of the point. Default is current x position |
| $y | (int) ordinate of the point. Default is current y position |
| MirrorV | ( | $y = '' | ) |
Verical Mirroring.
| $y | (int) ordinate of the point. Default is current y position |
| movePage | ( | $frompage, | |
| $topage | |||
| ) |
| MultiCell | ( | $w, | |
| $h, | |||
| $txt, | |||
$border = 0, |
|||
$align = 'J', |
|||
$fill = false, |
|||
$ln = 1, |
|||
$x = '', |
|||
$y = '', |
|||
$reseth = true, |
|||
$stretch = 0, |
|||
$ishtml = false, |
|||
$autopadding = true, |
|||
$maxh = 0, |
|||
$valign = 'T', |
|||
$fitcell = false |
|||
| ) |
This method allows printing text with line breaks.
They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the
character). As many cells as necessary are output, one below the other.
Text can be aligned, centered or justified. The cell block can be framed and the background painted.
| $w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
| $h | (float) Cell minimum height. The cell extends automatically if needed. |
| $txt | (string) String to print |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $x | (float) x position in user units |
| $y | (float) y position in user units |
| $reseth | (boolean) if true reset the last cell height (default true). |
| $stretch | (int) font stretch mode:
|
| $ishtml | (boolean) INTERNAL USE ONLY – set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods. |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
| $maxh | (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false. |
| $valign | (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:
|
| $fitcell | (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). |
| objclone | ( | $object | ) |
| Open | ( | ) |
|
protected |
| Output | ( | $name = 'doc.pdf', |
|
$dest = 'I' |
|||
| ) |
Send the document to a given destination: string, local file or browser.
In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.
| $name | (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character. |
| $dest | (string) Destination where to send the document. It can take one of the following values:
|
| PageNo | ( | ) |
| PageNoFormatted | ( | ) |
Returns the current page number formatted as a string.
| PieSector | ( | $xc, | |
| $yc, | |||
| $r, | |||
| $a, | |||
| $b, | |||
$style = 'FD', |
|||
$cw = true, |
|||
$o = 90 |
|||
| ) |
Draw the sector of a circle.
It can be used for instance to render pie charts.
| $xc | (float) abscissa of the center. |
| $yc | (float) ordinate of the center. |
| $r | (float) radius. |
| $a | (float) start angle (in degrees). |
| $b | (float) end angle (in degrees). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $cw | (float) indicates whether to go clockwise (default: true). |
| $o | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90. |
| PieSectorXY | ( | $xc, | |
| $yc, | |||
| $rx, | |||
| $ry, | |||
| $a, | |||
| $b, | |||
$style = 'FD', |
|||
$cw = false, |
|||
$o = 0, |
|||
$nc = 2 |
|||
| ) |
Draw the sector of an ellipse.
It can be used for instance to render pie charts.
| $xc | (float) abscissa of the center. |
| $yc | (float) ordinate of the center. |
| $rx | (float) the x-axis radius. |
| $ry | (float) the y-axis radius. |
| $a | (float) start angle (in degrees). |
| $b | (float) end angle (in degrees). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $cw | (float) indicates whether to go clockwise. |
| $o | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of arc. |
| pixelsToUnits | ( | $px | ) |
Converts pixels to User's Units.
| $px | (int) pixels |
| Polycurve | ( | $x0, | |
| $y0, | |||
| $segments, | |||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a poly-Bezier curve.
Each Bezier curve segment is a tangent to the line between the control points at either end of the curve.
| $x0 | (float) Abscissa of start point. |
| $y0 | (float) Ordinate of start point. |
| $segments | (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (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). |
| Polygon | ( | $p, | |
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$closed = true |
|||
| ) |
Draws a polygon.
| $p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon. Array with keys among the following:
|
| $fill_color | (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). |
| $closed | (boolean) if true the polygon is closes, otherwise will remain open |
| PolyLine | ( | $p, | |
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a polygonal line.
| $p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon. Array with keys among the following:
|
| $fill_color | (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). |
| printTemplate | ( | $id, | |
$x = '', |
|||
$y = '', |
|||
$w = 0, |
|||
$h = 0, |
|||
$align = '', |
|||
$palign = '', |
|||
$fitonpage = false |
|||
| ) |
Print an XObject Template.
You can print an XObject Template inside the currently opened Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
| $id | (string) The ID of XObject Template to print. |
| $x | (int) X position in user units (empty string = current x position) |
| $y | (int) Y position in user units (empty string = current y position) |
| $w | (int) Width in user units (zero = remaining page width) |
| $h | (int) Height in user units (zero = remaining page height) |
| $align | (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:
|
| $palign | (string) Allows to center or align the template on the current line. Possible values are:
|
| $fitonpage | (boolean) If true the template is resized to not exceed page dimensions. |
|
protected |
| RadialGradient | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$col1 = array(), |
|||
$col2 = array(), |
|||
$coords = array(0.5,0.5,0.5,0.5,1) |
|||
| ) |
Paints a radial colour gradient.
| $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) first color (Grayscale, RGB or CMYK components). |
| $col2 | (array) second color (Grayscale, RGB or CMYK components). |
| $coords | (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined. |
| RadioButton | ( | $name, | |
| $w, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$onvalue = 'On', |
|||
$checked = false, |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a RadioButton field.
| $name | (string) Field name. |
| $w | (int) Width or the radio button. |
| $prop | (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $onvalue | (string) Value to be returned if selected. |
| $checked | (boolean) Define the initial state. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered). |
|
protected |
| Rect | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $border_style | (array) Border style of rectangle. Array with keys among the following:
|
| $fill_color | (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). |
| registrationMark | ( | $x, | |
| $y, | |||
| $r, | |||
$double = false, |
|||
$cola = array(0,0,0), |
|||
$colb = array(255,255,255) |
|||
| ) |
Paints a registration mark.
| $x | (float) abscissa of the registration mark center. |
| $y | (float) ordinate of the registration mark center. |
| $r | (float) radius of the crop mark. |
| $double | (boolean) if true print two concentric crop marks. |
| $cola | (array) crop mark color (default black). |
| $colb | (array) second crop mark color. |
| RegularPolygon | ( | $x0, | |
| $y0, | |||
| $r, | |||
| $ns, | |||
$angle = 0, |
|||
$draw_circle = false, |
|||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$circle_style = '', |
|||
$circle_outLine_style = array(), |
|||
$circle_fill_color = array() |
|||
| ) |
Draws a regular polygon.
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $r | (float) Radius of inscribed circle. |
| $ns | (integer) Number of sides. |
| $angle | (float) Angle oriented (anti-clockwise). Default value: 0. |
| $draw_circle | (boolean) Draw inscribed circle or not. Default value: false. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon sides. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
| $circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
| $circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
| removePageRegion | ( | $key | ) |
Remove a single no-write region.
| $key | (int) region key |
| removeSHY | ( | $txt = '' | ) |
Removes SHY characters from text.
Unicode Data:
| $txt | (string) input string |
|
protected |
|
protected |
Replace a char if is defined on the current font.
| $oldchar | (int) Integer code (unicode) of the character to replace. |
| $newchar | (int) Integer code (unicode) of the new character. |
| replaceMissingChars | ( | $text, | |
$font = '', |
|||
$style = '', |
|||
$subs = array() |
|||
| ) |
Replace missing font characters on selected font with specified substitutions.
| $text | (string) Text to process. |
| $font | (string) Font name (family name). |
| $style | (string) Font style. |
| $subs | (array) Array of possible character substitutions. The key is the character to check (integer value) and the value is a single intege value or an array of possible substitutes. |
|
protected |
Replace page number aliases with number.
| $page | (string) Page content. |
| $replace | (array) Array of replacements (array keys are replacement strings, values are alias arrays). |
| $diff | (int) If passed, this will be set to the total char number difference between alias and replacements. |
|
protected |
Replace right shift page number aliases with spaces to correct right alignment.
This works perfectly only when using monospaced fonts.
| $page | (string) Page content. |
| $aliases | (array) Array of page aliases. |
| $diff | (int) initial difference to add. |
| resetColumns | ( | ) |
| resetHeaderTemplate | ( | ) |
| resetLastH | ( | ) |
| revstrpos | ( | $haystack, | |
| $needle, | |||
$offset = 0 |
|||
| ) |
Find position of last occurrence of a substring in a string.
| $haystack | (string) The string to search in. |
| $needle | (string) substring to search. |
| $offset | (int) May be specified to begin searching an arbitrary number of characters into the string. |
|
protected |
Binary-safe and URL-safe file read.
Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
| $handle | (resource) |
| $length | (int) |
| rollbackTransaction | ( | $self = false | ) |
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
| $self | (boolean) if true restores current class object to previous state without the need of reassignment via the returned value. |
| Rotate | ( | $angle, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Rotate object.
| $angle | (float) angle in degrees for counter-clockwise rotation |
| $x | (int) abscissa of the rotation center. Default is current x position |
| $y | (int) ordinate of the rotation center. Default is current y position |
| RoundedRect | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $r, | |||
$round_corner = '1111', |
|||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rounded rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $r | (float) the radius of the circle used to round off the corners of the rectangle. |
| $round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111"). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $border_style | (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (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). |
| RoundedRectXY | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $rx, | |||
| $ry, | |||
$round_corner = '1111', |
|||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rounded rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $rx | (float) the x-axis radius of the ellipse used to round off the corners of the rectangle. |
| $ry | (float) the y-axis radius of the ellipse used to round off the corners of the rectangle. |
| $round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111"). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $border_style | (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (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). |
| Scale | ( | $s_x, | |
| $s_y, | |||
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical and horizontal non-proportional Scaling.
| $s_x | (float) scaling factor for width as percent. 0 is not allowed. |
| $s_y | (float) scaling factor for height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
| ScaleX | ( | $s_x, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Horizontal Scaling.
| $s_x | (float) scaling factor for width as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
| ScaleXY | ( | $s, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical and horizontal proportional Scaling.
| $s | (float) scaling factor for width and height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
| ScaleY | ( | $s_y, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical Scaling.
| $s_y | (float) scaling factor for height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
|
protected |
Sets the character data handler function for the XML parser.
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $data | (string) The second parameter, data, contains the character data as a string. |
| selectColumn | ( | $col = '' | ) |
Set position at a given column.
| $col | (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column. |
|
protected |
| serializeTCPDFtagParameters | ( | $pararray | ) |
| set_mqr | ( | $mqr | ) |
| SetAbsX | ( | $x | ) |
Set the absolute X coordinate of the current pointer.
| $x | (float) The value of the abscissa in user units. |
| SetAbsXY | ( | $x, | |
| $y | |||
| ) |
Set the absolute X and Y coordinates of the current pointer.
| $x | (float) The value of the abscissa in user units. |
| $y | (float) (float) The value of the ordinate in user units. |
| SetAbsY | ( | $y | ) |
Set the absolute Y coordinate of the current pointer.
| $y | (float) (float) The value of the ordinate in user units. |
| setAlpha | ( | $stroking = 1, |
|
$bm = 'Normal', |
|||
$nonstroking = '', |
|||
$ais = false |
|||
| ) |
Set alpha for stroking (CA) and non-stroking (ca) operations.
| $stroking | (float) Alpha value for stroking operations: real value from 0 (transparent) to 1 (opaque). |
| $bm | (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity |
| $nonstroking | (float) Alpha value for non-stroking operations: real value from 0 (transparent) to 1 (opaque). |
| $ais | (boolean) |
| SetAuthor | ( | $author | ) |
Defines the author of the document.
| $author | (string) The name of the author. |
| SetAutoPageBreak | ( | $auto, | |
$margin = 0 |
|||
| ) |
Enables or disables the automatic page breaking mode.
When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
| $auto | (boolean) Boolean indicating if mode should be on or off. |
| $margin | (float) Distance from the bottom of the page. |
| setBarcode | ( | $bc = '' | ) |
| SetBooklet | ( | $booklet = true, |
|
$inner = -1, |
|||
$outer = -1 |
|||
| ) |
| setBookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0) |
|||
| ) |
Adds a bookmark - alias for Bookmark().
| $txt | (string) Bookmark description. |
| $level | (int) Bookmark level (minimum value is 0). |
| $y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
| $style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array (values from 0 to 255). |
|
protected |
| setCellHeightRatio | ( | $h | ) |
| setCellMargins | ( | $left = '', |
|
$top = '', |
|||
$right = '', |
|||
$bottom = '' |
|||
| ) |
Set the internal Cell margins.
| $left | (float) left margin |
| $top | (float) top margin |
| $right | (float) right margin |
| $bottom | (float) bottom margin |
| SetCellPadding | ( | $pad | ) |
Set the same internal Cell padding for top, right, bottom, left-.
| $pad | (float) internal padding. |
| setCellPaddings | ( | $left = '', |
|
$top = '', |
|||
$right = '', |
|||
$bottom = '' |
|||
| ) |
Set the internal Cell paddings.
| $left | (float) left padding |
| $top | (float) top padding |
| $right | (float) right padding |
| $bottom | (float) bottom padding |
| setColor | ( | $type, | |
$col1 = 0, |
|||
$col2 = -1, |
|||
$col3 = -1, |
|||
$col4 = -1, |
|||
$ret = false, |
|||
$name = '' |
|||
| ) |
Defines the color used by the specified type ('draw', 'fill', 'text').
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) spot color name (if any) |
| setColorArray | ( | $type, | |
| $color, | |||
$ret = false |
|||
| ) |
Set the color array for the specified type ('draw', 'fill', 'text').
It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $color | (array) Array of colors (1=gray, 3=RGB, 4=CMYK or 5=spotcolor=CMYK+name values). |
| $ret | (boolean) If true do not send the PDF command. |
| setColumnsArray | ( | $columns | ) |
| SetCompression | ( | $compress = true | ) |
Activates or deactivates page compression.
When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default. Note: the Zlib extension is required for this feature. If not present, compression will be turned off.
| $compress | (boolean) Boolean indicating if compression must be enabled. |
|
protected |
| SetCreator | ( | $creator | ) |
Defines the creator of the document.
This is typically the name of the application that generates the PDF.
| $creator | (string) The name of the creator. |
| SetDefaultMonospacedFont | ( | $font | ) |
| setDefaultTableColumns | ( | $cols = 4 | ) |
| setDestination | ( | $name, | |
$y = -1, |
|||
$page = '', |
|||
$x = -1 |
|||
| ) |
Add a Named Destination.
NOTE: destination names are unique, so only last entry will be saved.
| $name | (string) Destination name. |
| $y | (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
| $x | (float) X position in user units of the destiantion on the selected page (default = -1 = current position;). |
| SetDisplayMode | ( | $zoom, | |
$layout = 'SinglePage', |
|||
$mode = 'UseNone' |
|||
| ) |
Defines the way the document is to be displayed by the viewer.
| $zoom | (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
|
| $layout | (string) The page layout. Possible values are:
|
| $mode | (string) A name object specifying how the document should be displayed when opened:
|
| setDocCreationTimestamp | ( | $time | ) |
| SetDocInfoUnicode | ( | $unicode = true | ) |
| setDocModificationTimestamp | ( | $time | ) |
| SetDrawColor | ( | $col1 = 0, |
|
$col2 = -1, |
|||
$col3 = -1, |
|||
$col4 = -1, |
|||
$ret = false, |
|||
$name = '' |
|||
| ) |
Defines the color used for all drawing operations (lines, rectangles and cell borders).
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) spot color name (if any) |
| SetDrawColorArray | ( | $color, | |
$ret = false |
|||
| ) |
Defines the color used for all drawing operations (lines, rectangles and cell borders).
It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
| SetDrawSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
| setEqualColumns | ( | $numcols = 0, |
|
$width = 0, |
|||
$y = '' |
|||
| ) |
|
protected |
| setExtraXMP | ( | $xmp | ) |
Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.
IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!
| $xmp | (string) Custom XMP data. |
| SetFillColor | ( | $col1 = 0, |
|
$col2 = -1, |
|||
$col3 = -1, |
|||
$col4 = -1, |
|||
$ret = false, |
|||
$name = '' |
|||
| ) |
Defines the color used for all filling operations (filled rectangles and cell backgrounds).
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) Spot color name (if any). |
| SetFillColorArray | ( | $color, | |
$ret = false |
|||
| ) |
Defines the color used for all filling operations (filled rectangles and cell backgrounds).
It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
| SetFillSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
| SetFont | ( | $family, | |
$style = '', |
|||
$size = null, |
|||
$fontfile = '', |
|||
$subset = 'default', |
|||
$out = true |
|||
| ) |
Sets the font used to print character strings.
The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:
| $family | (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):
|
| $style | (string) Font style. Possible values are (case insensitive):
|
| $size | (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12 |
| $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) 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. |
| $out | (boolean) if true output the font size command, otherwise only set the font properties. |
|
protected |
| SetFontSize | ( | $size, | |
$out = true |
|||
| ) |
| setFontSpacing | ( | $spacing = 0 | ) |
| setFontStretching | ( | $perc = 100 | ) |
|
protected |
| setFontSubsetting | ( | $enable = true | ) |
|
protected |
| setFooterData | ( | $tc = array(0,0,0), |
|
$lc = array(0,0,0) |
|||
| ) |
| setFooterFont | ( | $font | ) |
| setFooterMargin | ( | $fm = 10 | ) |
| setFormDefaultProp | ( | $prop = array() | ) |
|
protected |
|
protected |
| setHeaderData | ( | $ln = '', |
|
$lw = 0, |
|||
$ht = '', |
|||
$hs = '', |
|||
$tc = array(0,0,0), |
|||
$lc = array(0,0,0) |
|||
| ) |
Set header data.
| $ln | (string) header image logo |
| $lw | (string) header image logo width in mm |
| $ht | (string) string to print as title on document header |
| $hs | (string) string to print on document header |
| $tc | (array) RGB array color for text. |
| $lc | (array) RGB array color for line. |
| setHeaderFont | ( | $font | ) |
| setHeaderMargin | ( | $hm = 10 | ) |
| setHeaderTemplateAutoreset | ( | $val = true | ) |
| setHtmlLinksStyle | ( | $color = array(0,0,255), |
|
$fontstyle = 'U' |
|||
| ) |
| setHtmlVSpace | ( | $tagvs | ) |
Set the vertical spaces for HTML tags.
The array must have the following structure (example): $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1))); The first array level contains the tag names, the second level contains 0 for opening tags or 1 for closing tags, the third level contains the vertical space unit (h) and the number spaces to add (n). If the h parameter is not specified, default values are used.
| $tagvs | (array) array of tags and relative vertical spaces. |
|
protected |
| setImageScale | ( | $scale | ) |
|
protected |
| setJPEGQuality | ( | $quality | ) |
| SetKeywords | ( | $keywords | ) |
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
| $keywords | (string) The list of keywords. |
| setLanguageArray | ( | $language | ) |
| setLastH | ( | $h | ) |
| SetLeftMargin | ( | $margin | ) |
Defines the left margin.
The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
| $margin | (float) The margin. |
| SetLineStyle | ( | $style, | |
$ret = false |
|||
| ) |
Set line style.
| $style | (array) Line style. Array with keys among the following:
|
| $ret | (boolean) if true do not send the command. |
| SetLineWidth | ( | $width | ) |
| SetLink | ( | $link, | |
$y = 0, |
|||
$page = -1 |
|||
| ) |
Defines the page and position a link points to.
| $link | (int) The link identifier returned by AddLink() |
| $y | (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page) |
| $page | (int) Number of target page; -1 indicates the current page. This is the default value |
| setListIndentWidth | ( | $width | ) |
| setLIsymbol | ( | $symbol = '!' | ) |
Set the default bullet to be used as LI bullet symbol.
| $symbol | (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext') |
| SetMargins | ( | $left, | |
| $top, | |||
$right = -1, |
|||
$keepmargins = false |
|||
| ) |
Defines the left, top and right margins.
| $left | (float) Left margin. |
| $top | (float) Top margin. |
| $right | (float) Right margin. Default value is the left one. |
| $keepmargins | (boolean) if true overwrites the default page margins |
| setOpenCell | ( | $isopen | ) |
| setOverprint | ( | $stroking = true, |
|
$nonstroking = '', |
|||
$mode = 0 |
|||
| ) |
Set overprint mode for stroking (OP) and non-stroking (op) painting operations.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
| $stroking | (boolean) If true apply overprint for stroking operations. |
| $nonstroking | (boolean) If true apply overprint for painting operations other than stroking. |
| $mode | (integer) Overprint mode: (0 = each source colour component value replaces the value previously painted for the corresponding device colorant; 1 = a tint value of 0.0 for a source colour component shall leave the corresponding component of the previously painted colour unchanged). |
| setPage | ( | $pnum, | |
$resetmargins = false |
|||
| ) |
Move pointer at the specified document page and update page dimensions.
| $pnum | (int) page number (1 ... numpages) |
| $resetmargins | (boolean) if true reset left, right, top margins and Y position. |
| setPageBoxes | ( | $page, | |
| $type, | |||
| $llx, | |||
| $lly, | |||
| $urx, | |||
| $ury, | |||
$points = false |
|||
| ) |
Set page boundaries.
| $page | (int) page number |
| $type | (string) valid values are:
|
| $llx | (float) lower-left x coordinate in user units |
| $lly | (float) lower-left y coordinate in user units |
| $urx | (float) upper-right x coordinate in user units |
| $ury | (float) upper-right y coordinate in user units |
| $points | (boolean) if true uses user units as unit of measure, otherwise uses PDF points |
|
protected |
|
protected |
|
protected |
Change the format of the current page.
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
|
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| setPageMark | ( | ) |
Set start-writing mark on current page stream used to put borders and fills.
Borders and fills are always created after content and inserted on the position marked by this method. This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
| setPageOrientation | ( | $orientation, | |
$autopagebreak = '', |
|||
$bottommargin = '' |
|||
| ) |
Set page orientation.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $autopagebreak | (boolean) Boolean indicating if auto-page-break mode should be on or off. |
| $bottommargin | (float) bottom margin of the page. |
| setPageRegions | ( | $regions = array() | ) |
Set no-write regions on page.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
| $regions | (array) array of no-write regions. For each region you can define an array as follow: ('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). Omit this parameter to remove all regions. |
| setPageUnit | ( | $unit | ) |
Set the units of measure for the document.
| $unit | (string) User measure unit. Possible values are:
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. |
| setPDFVersion | ( | $version = '1.7' | ) |
| setPrintFooter | ( | $val = true | ) |
| setPrintHeader | ( | $val = true | ) |
| SetProtection | ( | $permissions = array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), |
|
$user_pass = '', |
|||
$owner_pass = null, |
|||
$mode = 0, |
|||
$pubkeys = null |
|||
| ) |
Set document protection Remark: the protection against modification is for people who have the full Acrobat product.
If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
| $permissions | (Array) the set of permissions (specify the ones you want to block):
|
| $user_pass | (String) user password. Empty by default. |
| $owner_pass | (String) owner password. If not specified, a random value is used. |
| $mode | (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit. |
| $pubkeys | (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../tcpdf.crt', 'p' => array('print'))) |
| setRasterizeVectorImages | ( | $mode | ) |
| SetRightMargin | ( | $margin | ) |
Defines the right margin.
The method can be called before creating the first page.
| $margin | (float) The margin. |
| setRTL | ( | $enable, | |
$resetx = true |
|||
| ) |
| setSignature | ( | $signing_cert = '', |
|
$private_key = '', |
|||
$private_key_password = '', |
|||
$extracerts = '', |
|||
$cert_type = 2, |
|||
$info = array() |
|||
| ) |
Enable document signature (requires the OpenSSL Library).
The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
| $signing_cert | (mixed) signing certificate (string or filename prefixed with 'file://') |
| $private_key | (mixed) private key (string or filename prefixed with 'file://') |
| $private_key_password | (string) password |
| $extracerts | (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used. |
| $cert_type | (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature. |
| $info | (array) array of option information: Name, Location, Reason, ContactInfo. |
| setSignatureAppearance | ( | $x = 0, |
|
$y = 0, |
|||
$w = 0, |
|||
$h = 0, |
|||
$page = -1 |
|||
| ) |
Set the digital signature appearance (a cliccable rectangle area to get signature properties)
| $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) option page number (if < 0 the current page is used). |
| setSpacesRE | ( | $re = '/[^\S\xa0]/' | ) |
Set regular expression to detect withespaces or word separators.
The pattern delimiter must be the forward-slash character "/". Some example patterns are:
Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
Unicode and PCRE unicode support: "/[^\S\P{Z}\xa0]/u"
Unicode and PCRE unicode support in Chinese mode: "/[^\S\P{Z}\P{Lo}\xa0]/u"
if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
"\p{Z}" or "\p{Separator}": any kind of Unicode whitespace or invisible separator.
"\p{Lo}" or "\p{Other_Letter}": a Unicode letter or ideograph that does not have lowercase and uppercase variants.
"\p{Lo}" is needed for Chinese characters because are packed next to each other without spaces in between.
| $re | (string) regular expression (leave empty for default). |
| setSpotColor | ( | $type, | |
| $name, | |||
$tint = 100 |
|||
| ) |
Set the spot color for the specified type ('draw', 'fill', 'text').
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
| setSRGBmode | ( | $mode = false | ) |
| setStartingPageNumber | ( | $num = 1 | ) |
| SetSubject | ( | $subject | ) |
Defines the subject of the document.
| $subject | (string) The subject. |
|
protected |
Apply the requested SVG styles (*** TO BE COMPLETED ***)
| $svgstyle | (array) array of SVG styles to apply |
| $prevsvgstyle | (array) array of previous SVG style |
| $x | (int) X origin of the bounding box |
| $y | (int) Y origin of the bounding box |
| $w | (int) width of the bounding box |
| $h | (int) height of the bounding box |
| $clip_function | (string) clip function |
| $clip_params | (array) array of parameters for clipping function |
|
protected |
| setTempRTL | ( | $mode | ) |
| SetTextColor | ( | $col1 = 0, |
|
$col2 = -1, |
|||
$col3 = -1, |
|||
$col4 = -1, |
|||
$ret = false, |
|||
$name = '' |
|||
| ) |
Defines the color used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) Spot color name (if any). |
| SetTextColorArray | ( | $color, | |
$ret = false |
|||
| ) |
Defines the color used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
| setTextRenderingMode | ( | $stroke = 0, |
|
$fill = true, |
|||
$clip = false |
|||
| ) |
| setTextShadow | ( | $params = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal') | ) |
Set parameters for drop shadow effect for text.
| $params | (array) Array of parameters: enabled (boolean) set to true to enable shadow; depth_w (float) shadow width in user units; depth_h (float) shadow height in user units; color (array) shadow color or false to use the stroke color; opacity (float) Alpha value: real value from 0 (transparent) to 1 (opaque); blend_mode (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity. |
| SetTextSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for text.
| $name | (string) Name of the spot color. |
| $tint | (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
| SetTitle | ( | $title | ) |
Defines the title of the document.
| $title | (string) The title. |
| SetTopMargin | ( | $margin | ) |
Defines the top margin.
The method can be called before creating the first page.
| $margin | (float) The margin. |
| setUserRights | ( | $enable = true, |
|
$document = '/FullSave', |
|||
$annots = '/Create/Delete/Modify/Copy/Import/Export', |
|||
$form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', |
|||
$signature = '/Modify', |
|||
$ef = '/Create/Delete/Modify/Import', |
|||
$formex = '' |
|||
| ) |
Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work.
Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary
| $enable | (boolean) if true enable user's rights on PDF reader |
| $document | (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data. |
| $annots | (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations. |
| $form | (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate |
| $signature | (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field. |
| $ef | (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files Names specifying additional embedded-files-related usage rights for the document. |
| $formex | (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode. |
| setViewerPreferences | ( | $preferences | ) |
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
(see Section 8.1 of PDF reference, "Viewer Preferences").
| $preferences | (array) array of options. |
| setVisibility | ( | $v | ) |
Set the visibility of the successive elements.
This can be useful, for instance, to put a background image or color that will show on screen but won't print.
| $v | (string) visibility mode. Legal values are: all, print, screen or view. |
| SetX | ( | $x, | |
$rtloff = false |
|||
| ) |
Defines the abscissa of the current position.
If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
| $x | (float) The value of the abscissa in user units. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
| SetXY | ( | $x, | |
| $y, | |||
$rtloff = false |
|||
| ) |
Defines the abscissa and ordinate of the current position.
If the passed values are negative, they are relative respectively to the right and bottom of the page.
| $x | (float) The value of the abscissa. |
| $y | (float) The value of the ordinate. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
| SetY | ( | $y, | |
$resetx = true, |
|||
$rtloff = false |
|||
| ) |
Moves the current abscissa back to the left margin and sets the ordinate.
If the passed value is negative, it is relative to the bottom of the page.
| $y | (float) The value of the ordinate in user units. |
| $resetx | (bool) if true (default) reset the X position. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
| Skew | ( | $angle_x, | |
| $angle_y, | |||
$x = '', |
|||
$y = '' |
|||
| ) |
Skew.
| $angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
| $angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
| SkewX | ( | $angle_x, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Skew horizontally.
| $angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
| SkewY | ( | $angle_y, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Skew vertically.
| $angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
|
protected |
| StarPolygon | ( | $x0, | |
| $y0, | |||
| $r, | |||
| $nv, | |||
| $ng, | |||
$angle = 0, |
|||
$draw_circle = false, |
|||
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$circle_style = '', |
|||
$circle_outLine_style = array(), |
|||
$circle_fill_color = array() |
|||
| ) |
Draws a star polygon.
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $r | (float) Radius of inscribed circle. |
| $nv | (integer) Number of vertices. |
| $ng | (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon). |
| $angle | (float) Angle oriented (anti-clockwise). Default value: 0. |
| $draw_circle | (boolean) Draw inscribed circle or not. Default value is false. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon sides. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
| $circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
| $circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
| startLayer | ( | $name = '', |
|
$print = true, |
|||
$view = true |
|||
| ) |
| startPage | ( | $orientation = '', |
|
$format = '', |
|||
$tocpage = false |
|||
| ) |
Starts a new page to the document.
The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $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(). |
| $tocpage | (boolean) if true the page is designated to contain the Table-Of-Content. |
| startPageGroup | ( | $page = '' | ) |
|
protected |
Sets the opening SVG element handler function for the XML parser.
(*** TO BE COMPLETED ***)
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
| $attribs | (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on. |
| $ctm | (array) tranformation matrix for clipping mode (starting transformation matrix). |
| startTemplate | ( | $w = 0, |
|
$h = 0, |
|||
$group = false |
|||
| ) |
Start a new XObject Template.
An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked. Note: X,Y coordinates will be reset to 0,0.
| $w | (int) Template width in user units (empty string or zero = page width less margins). |
| $h | (int) Template height in user units (empty string or zero = page height less margins). |
| $group | (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group). |
| startTransaction | ( | ) |
| StartTransform | ( | ) |
Starts a 2D tranformation saving current graphic state.
This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
| StopTransform | ( | ) |
Stops a 2D tranformation restoring previous graphic state.
This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
| stringLeftTrim | ( | $str, | |
$replace = '' |
|||
| ) |
| stringRightTrim | ( | $str, | |
$replace = '' |
|||
| ) |
| stringTrim | ( | $str, | |
$replace = '' |
|||
| ) |
|
protected |
Draws an SVG path.
| $d | (string) attribute d of the path SVG element |
| $style | (string) Style of rendering. Possible values are:
|
|
protected |
|
protected |
|
protected |
| Text | ( | $x, | |
| $y, | |||
| $txt, | |||
$fstroke = false, |
|||
$fclip = false, |
|||
$ffill = true, |
|||
$border = 0, |
|||
$ln = 0, |
|||
$align = '', |
|||
$fill = false, |
|||
$link = '', |
|||
$stretch = 0, |
|||
$ignore_min_height = false, |
|||
$calign = 'T', |
|||
$valign = 'M', |
|||
$rtloff = false |
|||
| ) |
Prints a text cell at the specified position.
This method allows to place a string precisely on the page.
| $x | (float) Abscissa of the cell origin |
| $y | (float) Ordinate of the cell origin |
| $txt | (string) String to print |
| $fstroke | (int) outline size in user units (false = disable) |
| $fclip | (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation). |
| $ffill | (boolean) if true fills the text |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) 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:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
| $rtloff | (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position. |
| TextField | ( | $name, | |
| $w, | |||
| $h, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a text field.
| $name | (string) field name |
| $w | (float) Width of the rectangle |
| $h | (float) Height of the rectangle |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
|
protected |
Apply graphic transformations.
| $tm | (array) transformation matrix |
| Translate | ( | $t_x, | |
| $t_y | |||
| ) |
Translate graphic object horizontally and vertically.
| $t_x | (int) movement to the right |
| $t_y | (int) movement to the bottom |
| TranslateX | ( | $t_x | ) |
Translate graphic object horizontally.
| $t_x | (int) movement to the right (or left for RTL) |
| TranslateY | ( | $t_y | ) |
Translate graphic object vertically.
| $t_y | (int) movement to the bottom |
| unhtmlentities | ( | $text_to_convert | ) |
| UniArrSubString | ( | $uniarr, | |
$start = '', |
|||
$end = '' |
|||
| ) |
Extract a slice of the $uniarr array and return it as string.
| $uniarr | (string) The input array of characters. |
| $start | (int) the starting element of $strarr. |
| $end | (int) first element that will not be returned. |
| unichr | ( | $c | ) |
|
protected |
| UTF8ArrayToUniArray | ( | $ta | ) |
| UTF8ArrSubString | ( | $strarr, | |
$start = '', |
|||
$end = '' |
|||
| ) |
|
protected |
|
protected |
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $ta | (array) array of characters composing the string. |
| $str | (string) string to process |
| $forcertl | (bool) if 'R' forces RTL, if 'L' forces LTR |
|
protected |
Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $arr | (array) array of unicode values. |
| $str | (string) string to manipulate (or empty value). |
| $setbom | (bool) if true set the Byte Order Mark (BOM = 0xFEFF) |
| $forcertl | (bool) if true forces RTL text direction |
|
protected |
Converts UTF-8 strings to codepoints array.
Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html
Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------ABFN notation: --------------------------------------------------------------------- UTF8-octets = *( UTF8-char ) UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4 UTF8-1 = x00-7F UTF8-2 = xC2-DF UTF8-tail
UTF8-3 = xE0 xA0-BF UTF8-tail / xE1-EC 2( UTF8-tail ) /
xED x80-9F UTF8-tail / xEE-EF 2( UTF8-tail )
UTF8-4 = xF0 x90-BF 2( UTF8-tail ) / xF1-F3 3( UTF8-tail ) /
xF4 x80-8F 2( UTF8-tail )
UTF8-tail = x80-BF
---------------------------------------------------------------------
| $str | (string) string to process. |
|
protected |
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $str | (string) string to manipulate. |
| $setbom | (bool) if true set the Byte Order Mark (BOM = 0xFEFF) |
| $forcertl | (bool) if true forces RTL text direction |
|
protected |
|
protected |
Converts UTF-8 strings to UTF16-BE.
| $str | (string) string to process. |
| $setbom | (boolean) if true set the Byte Order Mark (BOM = 0xFEFF) |
| Write | ( | $h, | |
| $txt, | |||
$link = '', |
|||
$fill = false, |
|||
$align = '', |
|||
$ln = false, |
|||
$stretch = 0, |
|||
$firstline = false, |
|||
$firstblock = false, |
|||
$maxh = 0, |
|||
$wadj = 0, |
|||
$margin = '' |
|||
| ) |
This method prints text from the current position.
| $h | (float) Line height |
| $txt | (string) String to print |
| $link | (mixed) URL or identifier returned by AddLink() |
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $align | (string) Allows to center or align the text. Possible values are:
|
| $ln | (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line. |
| $stretch | (int) font stretch mode:
|
| $firstline | (boolean) if true prints only the first line and return the remaining string. |
| $firstblock | (boolean) if true the string is the starting of a line. |
| $maxh | (float) maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. |
| $wadj | (float) first line width will be reduced by this amount (used in HTML mode). |
| $margin | (array) margin array of the parent container |
| write1DBarcode | ( | $code, | |
| $type, | |||
$x = '', |
|||
$y = '', |
|||
$w = '', |
|||
$h = '', |
|||
$xres = '', |
|||
$style = '', |
|||
$align = '' |
|||
| ) |
Print a Linear Barcode.
| $code | (string) code to print |
| $type | (string) type of barcode (see barcodes.php for supported formats). |
| $x | (int) x position in user units (empty string = current x position) |
| $y | (int) y position in user units (empty string = current y position) |
| $w | (int) width in user units (empty string = remaining page width) |
| $h | (int) height in user units (empty string = remaining page height) |
| $xres | (float) width of the smallest bar in user units (empty string = default value = 0.4mm) |
| $style | (array) array of options:
|
| $align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
| write2DBarcode | ( | $code, | |
| $type, | |||
$x = '', |
|||
$y = '', |
|||
$w = '', |
|||
$h = '', |
|||
$style = '', |
|||
$align = '', |
|||
$distort = false |
|||
| ) |
Print 2D Barcode.
| $code | (string) code to print |
| $type | (string) type of barcode (see 2dbarcodes.php for supported formats). |
| $x | (int) x position in user units |
| $y | (int) y position in user units |
| $w | (int) width in user units |
| $h | (int) height in user units |
| $style | (array) array of options:
|
| $align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
| $distort | (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio |
| writeBarcode | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $type, | |||
| $style, | |||
| $font, | |||
| $xres, | |||
| $code | |||
| ) |
This function is DEPRECATED, please use the new write1DBarcode() function.
| $x | (int) x position in user units |
| $y | (int) y position in user units |
| $w | (int) width in user units |
| $h | (int) height position in user units |
| $type | (string) type of barcode |
| $style | (string) barcode style |
| $font | (string) font for text |
| $xres | (int) x resolution |
| $code | (string) code to print |
|
protected |
| writeHTML | ( | $html, | |
$ln = true, |
|||
$fill = false, |
|||
$reseth = false, |
|||
$cell = false, |
|||
$align = '' |
|||
| ) |
Allows to preserve some HTML formatting (limited support).
IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
| $html | (string) text to display |
| $ln | (boolean) if true add a new line after text (default = true) |
| $fill | (boolean) Indicates if the background must be painted (true) or transparent (false). |
| $reseth | (boolean) if true reset the last cell height (default false). |
| $cell | (boolean) if true add the current left (or right for RTL) padding to each Write (default false). |
| $align | (string) Allows to center or align the text. Possible values are:
|
| writeHTMLCell | ( | $w, | |
| $h, | |||
| $x, | |||
| $y, | |||
$html = '', |
|||
$border = 0, |
|||
$ln = 0, |
|||
$fill = false, |
|||
$reseth = true, |
|||
$align = '', |
|||
$autopadding = true |
|||
| ) |
Prints a cell (rectangular area) with optional borders, background color and html text string.
The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
| $w | (float) Cell width. If 0, the cell extends up to the right margin. |
| $h | (float) Cell minimum height. The cell extends automatically if needed. |
| $x | (float) upper-left corner X coordinate |
| $y | (float) upper-left corner Y coordinate |
| $html | (string) html text to print. Default value: empty string. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $reseth | (boolean) if true reset the last cell height (default true). |
| $align | (string) Allows to center or align the text. Possible values are:
|
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Maximum size of cache array used for UTF8StringToArray() method.
|
protected |
Current size of cache array used for UTF8StringToArray() method.
|
protected |
Cache array for UTF8StringToArray() method.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Store page number when startTransaction() is called.
|
protected |
Store Y position when startTransaction() is called.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
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 |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
This documentation for Open ecommerce PEEL Shopping and PEEL.fr has been generated by Doxygen on Thu Oct 15 2015 14:41:44 - 
is a product of 
SAS. All rights reserved.