|
ILIAS
Release_5_0_x_branch Revision 61816
|
|
ILIAS
Release_5_0_x_branch Revision 61816
|
PHP class for generating PDF documents without requiring external extensions. More...
Inheritance diagram for TCPDF: Collaboration diagram for TCPDF:Public Member Functions | |
| __construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false) | |
| This is the class constructor. | |
| __destruct () | |
| Default destructor. | |
| setPageUnit ($unit) | |
| Set the units of measure for the document. | |
| setPageOrientation ($orientation, $autopagebreak='', $bottommargin='') | |
| Set page orientation. | |
| setSpacesRE ($re='/[^\S\xa0]/') | |
| Set regular expression to detect withespaces or word separators. | |
| setRTL ($enable, $resetx=true) | |
| Enable or disable Right-To-Left language mode. | |
| getRTL () | |
| Return the RTL status. | |
| setTempRTL ($mode) | |
| Force temporary RTL language direction. | |
| isRTLTextDir () | |
| Return the current temporary RTL status. | |
| setLastH ($h) | |
| Set the last cell height. | |
| resetLastH () | |
| Reset the last cell height. | |
| getLastH () | |
| Get the last cell height. | |
| setImageScale ($scale) | |
| Set the adjusting factor to convert pixels to user units. | |
| getImageScale () | |
| Returns the adjusting factor to convert pixels to user units. | |
| getPageDimensions ($pagenum='') | |
| Returns an array of page dimensions: | |
| getPageWidth ($pagenum='') | |
| Returns the page width in units. | |
| getPageHeight ($pagenum='') | |
| Returns the page height in units. | |
| getBreakMargin ($pagenum='') | |
| Returns the page break margin. | |
| getScaleFactor () | |
| Returns the scale factor (number of points in user unit). | |
| SetMargins ($left, $top, $right=-1, $keepmargins=false) | |
| Defines the left, top and right margins. | |
| SetLeftMargin ($margin) | |
| Defines the left margin. | |
| SetTopMargin ($margin) | |
| Defines the top margin. | |
| SetRightMargin ($margin) | |
| Defines the right margin. | |
| SetCellPadding ($pad) | |
| Set the same internal Cell padding for top, right, bottom, left-. | |
| setCellPaddings ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell paddings. | |
| getCellPaddings () | |
| Get the internal Cell padding array. | |
| setCellMargins ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell margins. | |
| getCellMargins () | |
| Get the internal Cell margin array. | |
| SetAutoPageBreak ($auto, $margin=0) | |
| Enables or disables the automatic page breaking mode. | |
| getAutoPageBreak () | |
| Return the auto-page-break mode (true or false). | |
| SetDisplayMode ($zoom, $layout='SinglePage', $mode='UseNone') | |
| Defines the way the document is to be displayed by the viewer. | |
| SetCompression ($compress=true) | |
| Activates or deactivates page compression. | |
| setSRGBmode ($mode=false) | |
| Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document. | |
| SetDocInfoUnicode ($unicode=true) | |
| Turn on/off Unicode mode for document information dictionary (meta tags). | |
| SetTitle ($title) | |
| Defines the title of the document. | |
| SetSubject ($subject) | |
| Defines the subject of the document. | |
| SetAuthor ($author) | |
| Defines the author of the document. | |
| SetKeywords ($keywords) | |
| Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. | |
| SetCreator ($creator) | |
| Defines the creator of the document. | |
| Error ($msg) | |
| This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. | |
| Open () | |
| This method begins the generation of the PDF document. | |
| Close () | |
| Terminates the PDF document. | |
| setPage ($pnum, $resetmargins=false) | |
| Move pointer at the specified document page and update page dimensions. | |
| lastPage ($resetmargins=false) | |
| Reset pointer to the last document page. | |
| getPage () | |
| Get current document page number. | |
| getNumPages () | |
| Get the total number of insered pages. | |
| addTOCPage ($orientation='', $format='', $keepmargins=false) | |
| Adds a new TOC (Table Of Content) page to the document. | |
| endTOCPage () | |
| Terminate the current TOC (Table Of Content) page. | |
| AddPage ($orientation='', $format='', $keepmargins=false, $tocpage=false) | |
| Adds a new page to the document. | |
| endPage ($tocpage=false) | |
| Terminate the current page. | |
| startPage ($orientation='', $format='', $tocpage=false) | |
| Starts a new page to the document. | |
| setPageMark () | |
| Set start-writing mark on current page stream used to put borders and fills. | |
| setHeaderData ($ln='', $lw=0, $ht='', $hs='', $tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set header data. | |
| setFooterData ($tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set footer data. | |
| getHeaderData () | |
| Returns header data: | |
| setHeaderMargin ($hm=10) | |
| Set header margin. | |
| getHeaderMargin () | |
| Returns header margin in user units. | |
| setFooterMargin ($fm=10) | |
| Set footer margin. | |
| getFooterMargin () | |
| Returns footer margin in user units. | |
| setPrintHeader ($val=true) | |
| Set a flag to print page header. | |
| setPrintFooter ($val=true) | |
| Set a flag to print page footer. | |
| getImageRBX () | |
| Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. | |
| getImageRBY () | |
| Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image. | |
| resetHeaderTemplate () | |
| Reset the xobject template used by Header() method. | |
| setHeaderTemplateAutoreset ($val=true) | |
| Set a flag to automatically reset the xobject template used by Header() method at each page. | |
| Header () | |
| This method is used to render the page header. | |
| Footer () | |
| This method is used to render the page footer. | |
| PageNo () | |
| Returns the current page number. | |
| AddSpotColor ($name, $c, $m, $y, $k) | |
| Defines a new spot color. | |
| setSpotColor ($type, $name, $tint=100) | |
| Set the spot color for the specified type ('draw', 'fill', 'text'). | |
| SetDrawSpotColor ($name, $tint=100) | |
| Defines the spot color used for all drawing operations (lines, rectangles and cell borders). | |
| SetFillSpotColor ($name, $tint=100) | |
| Defines the spot color used for all filling operations (filled rectangles and cell backgrounds). | |
| SetTextSpotColor ($name, $tint=100) | |
| Defines the spot color used for text. | |
| setColorArray ($type, $color, $ret=false) | |
| Set the color array for the specified type ('draw', 'fill', 'text'). | |
| SetDrawColorArray ($color, $ret=false) | |
| Defines the color used for all drawing operations (lines, rectangles and cell borders). | |
| SetFillColorArray ($color, $ret=false) | |
| Defines the color used for all filling operations (filled rectangles and cell backgrounds). | |
| SetTextColorArray ($color, $ret=false) | |
| Defines the color used for text. | |
| setColor ($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used by the specified type ('draw', 'fill', 'text'). | |
| 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). | |
| 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). | |
| SetTextColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for text. | |
| GetStringWidth ($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
| Returns the length of a string in user unit. | |
| 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. | |
| GetCharWidth ($char, $notlast=true) | |
| Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking). | |
| getRawCharWidth ($char) | |
| Returns the length of the char in user unit for the current font. | |
| GetNumChars ($s) | |
| Returns the numbero of characters in a string. | |
| unichr ($c) | |
| Returns the unicode caracter specified by the value. | |
| 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). | |
| AddFont ($family, $style='', $fontfile='', $subset='default') | |
| Imports a TrueType, Type1, core, or CID0 font and makes it available. | |
| SetFont ($family, $style='', $size=null, $fontfile='', $subset='default', $out=true) | |
| Sets the font used to print character strings. | |
| SetFontSize ($size, $out=true) | |
| Defines the size of the current font. | |
| getFontBBox () | |
| Returns the bounding box of the current font in user units. | |
| getAbsFontMeasure ($s) | |
| Convert a relative font measure into absolute value. | |
| getCharBBox ($char) | |
| Returns the glyph bounding box of the specified character in the current font in user units. | |
| getFontDescent ($font, $style='', $size=0) | |
| Return the font descent value. | |
| getFontAscent ($font, $style='', $size=0) | |
| Return the font ascent value. | |
| isCharDefined ($char, $font='', $style='') | |
| Return true in the character is present in the specified font. | |
| replaceMissingChars ($text, $font='', $style='', $subs=array()) | |
| Replace missing font characters on selected font with specified substitutions. | |
| SetDefaultMonospacedFont ($font) | |
| Defines the default monospaced font. | |
| AddLink () | |
| Creates a new internal link and returns its identifier. | |
| SetLink ($link, $y=0, $page=-1) | |
| Defines the page and position a link points to. | |
| Link ($x, $y, $w, $h, $link, $spaces=0) | |
| Puts a link on a rectangular area of the page. | |
| Annotation ($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0) | |
| Puts a markup annotation on a rectangular area of the page. | |
| 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. | |
| AcceptPageBreak () | |
| Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| Ln ($h='', $cell=false) | |
| Performs a line break. | |
| GetX () | |
| Returns the relative X value of current position. | |
| GetAbsX () | |
| Returns the absolute X value of current position. | |
| GetY () | |
| Returns the ordinate of the current position. | |
| SetX ($x, $rtloff=false) | |
| Defines the abscissa of the current position. | |
| SetY ($y, $resetx=true, $rtloff=false) | |
| Moves the current abscissa back to the left margin and sets the ordinate. | |
| SetXY ($x, $y, $rtloff=false) | |
| Defines the abscissa and ordinate of the current position. | |
| SetAbsX ($x) | |
| Set the absolute X coordinate of the current pointer. | |
| SetAbsY ($y) | |
| Set the absolute Y coordinate of the current pointer. | |
| SetAbsXY ($x, $y) | |
| Set the absolute X and Y coordinates of the current pointer. | |
| Output ($name='doc.pdf', $dest='I') | |
| Send the document to a given destination: string, local file or browser. | |
| _destroy ($destroyall=false, $preserve_objcopy=false) | |
| Unset all class variables except the following critical variables. | |
| setExtraXMP ($xmp) | |
| Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag. | |
| setDocCreationTimestamp ($time) | |
| Set the document creation timestamp. | |
| setDocModificationTimestamp ($time) | |
| Set the document modification timestamp. | |
| getDocCreationTimestamp () | |
| Returns document creation timestamp in seconds. | |
| getDocModificationTimestamp () | |
| Returns document modification timestamp in seconds. | |
| setHeaderFont ($font) | |
| Set header font. | |
| getHeaderFont () | |
| Get header font. | |
| setFooterFont ($font) | |
| Set footer font. | |
| getFooterFont () | |
| Get Footer font. | |
| setLanguageArray ($language) | |
| Set language array. | |
| getPDFData () | |
| Returns the PDF data. | |
| addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) | |
| Output anchor link. | |
| pixelsToUnits ($px) | |
| Converts pixels to User's Units. | |
| unhtmlentities ($text_to_convert) | |
| Reverse function for htmlentities. | |
| 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. | |
| StartTransform () | |
| Starts a 2D tranformation saving current graphic state. | |
| StopTransform () | |
| Stops a 2D tranformation restoring previous graphic state. | |
| ScaleX ($s_x, $x='', $y='') | |
| Horizontal Scaling. | |
| ScaleY ($s_y, $x='', $y='') | |
| Vertical Scaling. | |
| ScaleXY ($s, $x='', $y='') | |
| Vertical and horizontal proportional Scaling. | |
| Scale ($s_x, $s_y, $x='', $y='') | |
| Vertical and horizontal non-proportional Scaling. | |
| MirrorH ($x='') | |
| Horizontal Mirroring. | |
| MirrorV ($y='') | |
| Verical Mirroring. | |
| MirrorP ($x='', $y='') | |
| Point reflection mirroring. | |
| MirrorL ($angle=0, $x='', $y='') | |
| Reflection against a straight line through point (x, y) with the gradient angle (angle). | |
| TranslateX ($t_x) | |
| Translate graphic object horizontally. | |
| TranslateY ($t_y) | |
| Translate graphic object vertically. | |
| Translate ($t_x, $t_y) | |
| Translate graphic object horizontally and vertically. | |
| Rotate ($angle, $x='', $y='') | |
| Rotate object. | |
| SkewX ($angle_x, $x='', $y='') | |
| Skew horizontally. | |
| SkewY ($angle_y, $x='', $y='') | |
| Skew vertically. | |
| Skew ($angle_x, $angle_y, $x='', $y='') | |
| Skew. | |
| SetLineWidth ($width) | |
| Defines the line width. | |
| GetLineWidth () | |
| Returns the current the line width. | |
| SetLineStyle ($style, $ret=false) | |
| Set line style. | |
| Line ($x1, $y1, $x2, $y2, $style=array()) | |
| Draws a line between two points. | |
| Rect ($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rectangle. | |
| Curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a Bezier curve. | |
| Polycurve ($x0, $y0, $segments, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a poly-Bezier curve. | |
| Ellipse ($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws an ellipse. | |
| Circle ($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws a circle. | |
| PolyLine ($p, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a polygonal line. | |
| Polygon ($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) | |
| Draws a polygon. | |
| 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. | |
| 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. | |
| RoundedRect ($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. | |
| RoundedRectXY ($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. | |
| Arrow ($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) | |
| Draws a grahic arrow. | |
| setDestination ($name, $y=-1, $page='', $x=-1) | |
| Add a Named Destination. | |
| getDestination () | |
| Return the Named Destination array. | |
| setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
| Adds a bookmark - alias for Bookmark(). | |
| Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
| Adds a bookmark. | |
| IncludeJS ($script) | |
| Adds a javascript. | |
| addJavascriptObject ($script, $onload=false) | |
| Adds a javascript object and return object ID. | |
| setFormDefaultProp ($prop=array()) | |
| Set default properties for form fields. | |
| getFormDefaultProp () | |
| Return the default properties for form fields. | |
| TextField ($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a text field. | |
| RadioButton ($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false) | |
| Creates a RadioButton field. | |
| ListBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a List-box field. | |
| ComboBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a Combo-box field. | |
| CheckBox ($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false) | |
| Creates a CheckBox field. | |
| Button ($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a button field. | |
| 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. | |
| setSignature ($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array()) | |
| Enable document signature (requires the OpenSSL Library). | |
| setSignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
| Set the digital signature appearance (a cliccable rectangle area to get signature properties) | |
| addEmptySignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
| Add an empty digital signature appearance (a cliccable rectangle area to get signature properties) | |
| startPageGroup ($page='') | |
| Create a new page group. | |
| setStartingPageNumber ($num=1) | |
| Set the starting page number. | |
| getAliasRightShift () | |
| Returns the string alias used right align page numbers. | |
| getAliasNbPages () | |
| Returns the string alias used for the total number of pages. | |
| getAliasNumPage () | |
| Returns the string alias used for the page number. | |
| getPageGroupAlias () | |
| Return the alias for the total number of pages in the current page group. | |
| getPageNumGroupAlias () | |
| Return the alias for the page number on the current page group. | |
| getGroupPageNo () | |
| Return the current page in the group. | |
| getGroupPageNoFormatted () | |
| Returns the current group page number formatted as a string. | |
| PageNoFormatted () | |
| Returns the current page number formatted as a string. | |
| startLayer ($name='', $print=true, $view=true) | |
| Start a new pdf layer. | |
| endLayer () | |
| End the current PDF layer. | |
| setVisibility ($v) | |
| Set the visibility of the successive elements. | |
| setOverprint ($stroking=true, $nonstroking='', $mode=0) | |
| Set overprint mode for stroking (OP) and non-stroking (op) painting operations. | |
| getOverprint () | |
| Get the overprint mode array (OP, op, OPM). | |
| setAlpha ($stroking=1, $bm='Normal', $nonstroking='', $ais=false) | |
| Set alpha for stroking (CA) and non-stroking (ca) operations. | |
| getAlpha () | |
| Get the alpha mode array (CA, ca, BM, AIS). | |
| setJPEGQuality ($quality) | |
| Set the default JPEG compression quality (1-100) | |
| setDefaultTableColumns ($cols=4) | |
| Set the default number of columns in a row for HTML tables. | |
| setCellHeightRatio ($h) | |
| Set the height of the cell (line height) respect the font height. | |
| getCellHeightRatio () | |
| return the height of cell repect font height. | |
| setPDFVersion ($version='1.7') | |
| Set the PDF version (check PDF reference for valid values). | |
| setViewerPreferences ($preferences) | |
| Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. | |
| colorRegistrationBar ($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A, R, G, B, C, M, Y, K') | |
| Paints color transition registration bars. | |
| cropMark ($x, $y, $w, $h, $type='T, R, B, L', $color=array(0, 0, 0)) | |
| Paints crop marks. | |
| registrationMark ($x, $y, $r, $double=false, $cola=array(0, 0, 0), $colb=array(255, 255, 255)) | |
| Paints a registration mark. | |
| LinearGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0)) | |
| Paints a linear colour gradient. | |
| 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. | |
| 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. | |
| Gradient ($type, $coords, $stops, $background=array(), $antialias=false) | |
| Output gradient. | |
| PieSector ($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) | |
| Draw the sector of a circle. | |
| PieSectorXY ($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) | |
| Draw the sector of an ellipse. | |
| 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. | |
| setBarcode ($bc='') | |
| Set document barcode. | |
| getBarcode () | |
| Get current barcode. | |
| write1DBarcode ($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='') | |
| Print a Linear Barcode. | |
| write2DBarcode ($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false) | |
| Print 2D Barcode. | |
| getMargins () | |
| Returns an array containing current margins: | |
| getOriginalMargins () | |
| Returns an array containing original margins: | |
| getFontSize () | |
| Returns the current font size. | |
| getFontSizePt () | |
| Returns the current font size in points unit. | |
| getFontFamily () | |
| Returns the current font family name. | |
| getFontStyle () | |
| Returns the current font style. | |
| fixHTMLCode ($html, $default_css='', $tagvs='', $tidy_options='') | |
| Cleanup HTML code (requires HTML Tidy library). | |
| getCSSPadding ($csspadding, $width=0) | |
| Get the internal Cell padding from CSS attribute. | |
| getCSSMargin ($cssmargin, $width=0) | |
| Get the internal Cell margin from CSS attribute. | |
| getCSSBorderMargin ($cssbspace, $width=0) | |
| Get the border-spacing from CSS attribute. | |
| getHTMLFontUnits ($val, $refsize=12, $parent_size=12, $defaultunit='pt') | |
| Convert HTML string containing font size value to points. | |
| serializeTCPDFtagParameters ($pararray) | |
| Serialize an array of parameters to be used with TCPDF tag in HTML code. | |
| 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. | |
| writeHTML ($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='') | |
| Allows to preserve some HTML formatting (limited support). | |
| setLIsymbol ($symbol='!') | |
| Set the default bullet to be used as LI bullet symbol. | |
| SetBooklet ($booklet=true, $inner=-1, $outer=-1) | |
| Set the booklet mode for double-sided pages. | |
| setHtmlVSpace ($tagvs) | |
| Set the vertical spaces for HTML tags. | |
| setListIndentWidth ($width) | |
| Set custom width for list indentation. | |
| setOpenCell ($isopen) | |
| Set the top/bottom cell sides to be open or closed when the cell cross the page. | |
| setHtmlLinksStyle ($color=array(0, 0, 255), $fontstyle='U') | |
| Set the color and font style for HTML links. | |
| getHTMLUnitToUnits ($htmlval, $refsize=1, $defaultunit='px', $points=false) | |
| Convert HTML string containing value and unit of measure to user's units or points. | |
| movePage ($frompage, $topage) | |
| Move a page to a previous position. | |
| deletePage ($page) | |
| Remove the specified page. | |
| copyPage ($page=0) | |
| Clone the specified page to a new page. | |
| addTOC ($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0, 0, 0)) | |
| Output a Table of Content Index (TOC). | |
| 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. | |
| startTransaction () | |
| Stores a copy of the current TCPDF object used for undo operation. | |
| commitTransaction () | |
| Delete the copy of the current TCPDF object used for undo operation. | |
| rollbackTransaction ($self=false) | |
| This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction(). | |
| setEqualColumns ($numcols=0, $width=0, $y='') | |
| Set multiple columns of the same size. | |
| resetColumns () | |
| Remove columns and reset page margins. | |
| setColumnsArray ($columns) | |
| Set columns array. | |
| selectColumn ($col='') | |
| Set position at a given column. | |
| getColumn () | |
| Return the current column number. | |
| getNumberOfColumns () | |
| Return the current number of columns. | |
| setTextRenderingMode ($stroke=0, $fill=true, $clip=false) | |
| Set Text rendering mode. | |
| 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. | |
| getTextShadow () | |
| Return the text shadow parameters array. | |
| hyphenateText ($text, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns text with soft hyphens. | |
| setRasterizeVectorImages ($mode) | |
| Enable/disable rasterization of vector images using ImageMagick library. | |
| setFontSubsetting ($enable=true) | |
| Enable or disable default option for font subsetting. | |
| getFontSubsetting () | |
| Return the default option for font subsetting. | |
| stringLeftTrim ($str, $replace='') | |
| Left trim the input string. | |
| stringRightTrim ($str, $replace='') | |
| Right trim the input string. | |
| stringTrim ($str, $replace='') | |
| Trim the input string. | |
| isUnicodeFont () | |
| Return true if the current font is unicode type. | |
| getFontFamilyName ($fontfamily) | |
| Return normalized font name. | |
| startTemplate ($w=0, $h=0, $group=false) | |
| Start a new XObject Template. | |
| endTemplate () | |
| End the current XObject Template started with startTemplate() and restore the previous graphic state. | |
| printTemplate ($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false) | |
| Print an XObject Template. | |
| setFontStretching ($perc=100) | |
| Set the percentage of character stretching. | |
| getFontStretching () | |
| Get the percentage of character stretching. | |
| setFontSpacing ($spacing=0) | |
| Set the amount to increase or decrease the space between characters in a text. | |
| getFontSpacing () | |
| Get the amount to increase or decrease the space between characters in a text. | |
| getPageRegions () | |
| Return an array of no-write page regions. | |
| setPageRegions ($regions=array()) | |
| Set no-write regions on page. | |
| addPageRegion ($region) | |
| Add a single no-write region on selected page. | |
| removePageRegion ($key) | |
| Remove a single no-write region. | |
| ImageSVG ($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false) | |
| Embedd a Scalable Vector Graphics (SVG) image. | |
Protected Member Functions | |
| setPageFormat ($format, $orientation='P') | |
| Change the format of the current page. | |
| adjustCellPadding ($brd=0) | |
| Adjust the internal Cell padding array to take account of the line width. | |
| setContentMark ($page=0) | |
| Set start-writing mark on selected page. | |
| setHeader () | |
| This method is used to render the page header. | |
| setFooter () | |
| This method is used to render the page footer. | |
| inPageBody () | |
| Check if we are on the page body (excluding page header and footer). | |
| setTableHeader () | |
| This method is used to render the table header on new page (if any). | |
| getFontsList () | |
| Fill the list of available fonts ($this->fontlist). | |
| _putEmbeddedFiles () | |
| Embedd the attached files. | |
| checkPageBreak ($h=0, $y='', $addpage=true) | |
| Add page if needed. | |
| 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. | |
| replaceChar ($oldchar, $newchar) | |
| Replace a char if is defined on the current font. | |
| getCellBorder ($x, $y, $w, $h, $brd) | |
| Returns the code to draw the cell border. | |
| getRemainingWidth () | |
| Returns the remaining width between the current position and margins. | |
| fitBlock ($w, $h, $x, $y, $fitonpage=false) | |
| Set the block dimensions accounting for page breaks and page/column fitting. | |
| 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. | |
| getGDgamma ($c) | |
| Get the GD-corrected PNG gamma value from alpha color. | |
| _dochecks () | |
| Check for locale-related bug. | |
| getInternalPageNumberAliases ($a= '') | |
| Return an array containing variations for the basic page number alias. | |
| getAllInternalPageNumberAliases () | |
| Return an array containing all internal page aliases. | |
| replaceRightShiftPageNumAliases ($page, $aliases, $diff) | |
| Replace right shift page number aliases with spaces to correct right alignment. | |
| setPageBoxTypes ($boxes) | |
| Set page boxes to be included on page descriptions. | |
| _putpages () | |
| Output pages (and replace page number aliases). | |
| _putannotsrefs ($n) | |
| Output references to page annotations. | |
| _getannotsrefs ($n) | |
| Get references to page annotations. | |
| _putannotsobjs () | |
| Output annotations objects for all pages. | |
| _putAPXObject ($w=0, $h=0, $stream='') | |
| Put appearance streams XObject used to define annotation's appearance states. | |
| _putfonts () | |
| Output fonts. | |
| _puttruetypeunicode ($font) | |
| Adds unicode fonts. | |
| _putcidfont0 ($font) | |
| Output CID-0 fonts. | |
| _putimages () | |
| Output images. | |
| _putxobjects () | |
| Output Form XObjects Templates. | |
| _putspotcolors () | |
| Output Spot Colors Resources. | |
| _getxobjectdict () | |
| Return XObjects Dictionary. | |
| _putresourcedict () | |
| Output Resources Dictionary. | |
| _putresources () | |
| Output Resources. | |
| _putinfo () | |
| Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference) | |
| _putXMP () | |
| Put XMP data object and return ID. | |
| _putcatalog () | |
| Output Catalog. | |
| _putviewerpreferences () | |
| Output viewer preferences. | |
| _putheader () | |
| Output PDF File Header (7.5.2). | |
| _enddoc () | |
| Output end of document (EOF). | |
| _beginpage ($orientation='', $format='') | |
| Initialize a new page. | |
| _endpage () | |
| Mark end of page. | |
| _newobj () | |
| Begin a new object and return the object number. | |
| _getobj ($objid='') | |
| Return the starting object string for the selected object ID. | |
| _dounderline ($x, $y, $txt) | |
| Underline text. | |
| _dounderlinew ($x, $y, $w) | |
| Underline for rectangular text area. | |
| _dolinethrough ($x, $y, $txt) | |
| Line through text. | |
| _dolinethroughw ($x, $y, $w) | |
| Line through for rectangular text area. | |
| _dooverline ($x, $y, $txt) | |
| Overline text. | |
| _dooverlinew ($x, $y, $w) | |
| Overline for rectangular text area. | |
| _datastring ($s, $n=0) | |
| Format a data string for meta information. | |
| _datestring ($n=0, $timestamp=0) | |
| Returns a formatted date for meta information. | |
| _textstring ($s, $n=0) | |
| Format a text string for meta information. | |
| _escapetext ($s) | |
| THIS METHOD IS DEPRECATED Format a text string. | |
| _getrawstream ($s, $n=0) | |
| get raw output stream. | |
| _getstream ($s, $n=0) | |
| Format output stream (DEPRECATED). | |
| _putstream ($s, $n=0) | |
| Output a stream (DEPRECATED). | |
| _out ($s) | |
| Output a string to the document. | |
| _objectkey ($n) | |
| Compute encryption key depending on object number where the encrypted data is stored. | |
| _encrypt_data ($n, $s) | |
| Encrypt the input string. | |
| _putencryption () | |
| Put encryption on PDF document. | |
| _Uvalue () | |
| Compute U value (used for encryption) | |
| _UEvalue () | |
| Compute UE value (used for encryption) | |
| _Ovalue () | |
| Compute O value (used for encryption) | |
| _OEvalue () | |
| Compute OE value (used for encryption) | |
| _fixAES256Password ($password) | |
| Convert password for AES-256 encryption mode. | |
| _generateencryptionkey () | |
| Compute encryption key. | |
| Transform ($tm) | |
| Apply graphic transformations. | |
| _outPoint ($x, $y) | |
| Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. | |
| _outLine ($x, $y) | |
| Append a straight line segment from the current point to the point (x, y). | |
| _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. | |
| _outCurve ($x1, $y1, $x2, $y2, $x3, $y3) | |
| Append a cubic B�zier curve to the current path. | |
| _outCurveV ($x2, $y2, $x3, $y3) | |
| Append a cubic B�zier curve to the current path. | |
| _outCurveY ($x1, $y1, $x3, $y3) | |
| Append a cubic B�zier curve to the current path. | |
| _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. | |
| _putdests () | |
| Insert Named Destinations. | |
| sortBookmarks () | |
| Sort bookmarks for page and key. | |
| _putbookmarks () | |
| Create a bookmark PDF string. | |
| _putjavascript () | |
| Create a javascript PDF string. | |
| _addfield ($type, $name, $x, $y, $w, $h, $prop) | |
| Adds a javascript form field. | |
| _putsignature () | |
| Add certification signature (DocMDP or UR3) You can set only one signature type. | |
| getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
| Get the array that defines the signature appearance (page and rectangle coordinates). | |
| _putocg () | |
| Put pdf layers. | |
| addExtGState ($parms) | |
| Add transparency parameters to the current extgstate. | |
| setExtGState ($gs) | |
| Add an extgstate. | |
| _putextgstates () | |
| Put extgstates for object transparency. | |
| Clip ($x, $y, $w, $h) | |
| Set a rectangular clipping area. | |
| _putshaders () | |
| Output gradient shaders. | |
| getCSSBorderWidth ($width) | |
| Returns the border width from CSS property. | |
| getCSSBorderDashStyle ($style) | |
| Returns the border dash style from CSS property. | |
| getCSSBorderStyle ($cssborder) | |
| Returns the border style array from CSS border properties. | |
| getCSSFontSpacing ($spacing, $parent=0) | |
| Returns the letter-spacing value from CSS value. | |
| getCSSFontStretching ($stretch, $parent=100) | |
| Returns the percentage of font stretching from CSS value. | |
| getHtmlDomArray ($html) | |
| Returns the HTML DOM array. | |
| getSpaceString () | |
| Returns the string used to find spaces. | |
| openHTMLTagHandler ($dom, $key, $cell) | |
| Process opening tags. | |
| closeHTMLTagHandler ($dom, $key, $cell, $maxbottomliney=0) | |
| Process closing tags. | |
| addHTMLVertSpace ($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false) | |
| Add vertical spaces if needed. | |
| getBorderStartPosition () | |
| Return the starting coordinates to draw an html border. | |
| drawHTMLTagBorder ($tag, $xmax) | |
| Draw an HTML block border and fill. | |
| swapMargins ($reverse=true) | |
| Swap the left and right margins. | |
| putHtmlListBullet ($listdepth, $listtype='', $size=10) | |
| Output an HTML list bullet or ordered item symbol. | |
| getGraphicVars () | |
| Returns current graphic variables as array. | |
| setGraphicVars ($gvars, $extended=false) | |
| Set graphic variables. | |
| writeDiskCache ($filename, $data, $append=false) | |
| Writes data to a temporary file on filesystem. | |
| readDiskCache ($filename) | |
| Read data from a temporary file on filesystem. | |
| setBuffer ($data) | |
| Set buffer content (always append data). | |
| replaceBuffer ($data) | |
| Replace the buffer content. | |
| getBuffer () | |
| Get buffer content. | |
| setPageBuffer ($page, $data, $append=false) | |
| Set page buffer content. | |
| getPageBuffer ($page) | |
| Get page buffer content. | |
| setImageBuffer ($image, $data) | |
| Set image buffer content. | |
| setImageSubBuffer ($image, $key, $data) | |
| Set image buffer content for a specified sub-key. | |
| getImageBuffer ($image) | |
| Get image buffer content. | |
| setFontBuffer ($font, $data) | |
| Set font buffer content. | |
| setFontSubBuffer ($font, $key, $data) | |
| Set font buffer content. | |
| getFontBuffer ($font) | |
| Get font buffer content. | |
| hyphenateWord ($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns an array of chars containing soft hyphens. | |
| checkPageRegions ($h, $x, $y) | |
| Check page for no-write regions and adapt current coordinates and page margins if necessary. | |
| convertSVGtMatrix ($tm) | |
| Convert SVG transformation matrix to PDF. | |
| SVGTransform ($tm) | |
| Apply SVG graphic transformation matrix. | |
| setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()) | |
| Apply the requested SVG styles (*** TO BE COMPLETED ***) | |
| SVGPath ($d, $style='') | |
| Draws an SVG path. | |
| startSVGElementHandler ($parser, $name, $attribs, $ctm=array()) | |
| Sets the opening SVG element handler function for the XML parser. | |
| endSVGElementHandler ($parser, $name) | |
| Sets the closing SVG element handler function for the XML parser. | |
| segSVGContentHandler ($parser, $data) | |
| Sets the character data handler function for the XML parser. | |
Protected Attributes | |
| $page | |
| Current page number. | |
| $n | |
| Current object number. | |
| $offsets = array() | |
| Array of object offsets. | |
| $pageobjects = array() | |
| Array of object IDs for each page. | |
| $buffer | |
| Buffer holding in-memory PDF. | |
| $pages = array() | |
| Array containing pages. | |
| $state | |
| Current document state. | |
| $compress | |
| Compression flag. | |
| $CurOrientation | |
| Current page orientation (P = Portrait, L = Landscape). | |
| $pagedim = array() | |
| Page dimensions. | |
| $k | |
| Scale factor (number of points in user unit). | |
| $fwPt | |
| Width of page format in points. | |
| $fhPt | |
| Height of page format in points. | |
| $wPt | |
| Current width of page in points. | |
| $hPt | |
| Current height of page in points. | |
| $w | |
| Current width of page in user unit. | |
| $h | |
| Current height of page in user unit. | |
| $lMargin | |
| Left margin. | |
| $rMargin | |
| Right margin. | |
| $clMargin | |
| Cell left margin (used by regions). | |
| $crMargin | |
| Cell right margin (used by regions). | |
| $tMargin | |
| Top margin. | |
| $bMargin | |
| Page break margin. | |
| $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). | |
| $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). | |
| $x | |
| Current horizontal position in user unit for cell positioning. | |
| $y | |
| Current vertical position in user unit for cell positioning. | |
| $lasth | |
| Height of last cell printed. | |
| $LineWidth | |
| Line width in user unit. | |
| $CoreFonts | |
| Array of standard font names. | |
| $fonts = array() | |
| Array of used fonts. | |
| $FontFiles = array() | |
| Array of font files. | |
| $diffs = array() | |
| Array of encoding differences. | |
| $images = array() | |
| Array of used images. | |
| $cached_files = array() | |
| Array of cached files. | |
| $PageAnnots = array() | |
| Array of Annotations in pages. | |
| $links = array() | |
| Array of internal links. | |
| $FontFamily | |
| Current font family. | |
| $FontStyle | |
| Current font style. | |
| $FontAscent | |
| Current font ascent (distance between font top and baseline). | |
| $FontDescent | |
| Current font descent (distance between font bottom and baseline). | |
| $underline | |
| Underlining flag. | |
| $overline | |
| Overlining flag. | |
| $CurrentFont | |
| Current font info. | |
| $FontSizePt | |
| Current font size in points. | |
| $FontSize | |
| Current font size in user unit. | |
| $DrawColor | |
| Commands for drawing color. | |
| $FillColor | |
| Commands for filling color. | |
| $TextColor | |
| Commands for text color. | |
| $ColorFlag | |
| Indicates whether fill and text colors are different. | |
| $AutoPageBreak | |
| Automatic page breaking. | |
| $PageBreakTrigger | |
| Threshold used to trigger page breaks. | |
| $InHeader = false | |
| Flag set when processing page header. | |
| $InFooter = false | |
| Flag set when processing page footer. | |
| $ZoomMode | |
| Zoom display mode. | |
| $LayoutMode | |
| Layout display mode. | |
| $docinfounicode = true | |
| If true set the document information dictionary in Unicode. | |
| $title = '' | |
| Document title. | |
| $subject = '' | |
| Document subject. | |
| $author = '' | |
| Document author. | |
| $keywords = '' | |
| Document keywords. | |
| $creator = '' | |
| Document creator. | |
| $starting_page_number = 1 | |
| Starting page number. | |
| $img_rb_x | |
| The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. | |
| $img_rb_y | |
| The right-bottom corner Y coordinate of last inserted image. | |
| $imgscale = 1 | |
| Adjusting factor to convert pixels to user units. | |
| $isunicode = false | |
| Boolean flag set to true when the input text is unicode (require unicode fonts). | |
| $PDFVersion = '1.7' | |
| PDF version. | |
| $header_xobjid = -1 | |
| ID of the stored default header template (-1 = not set). | |
| $header_xobj_autoreset = false | |
| If true reset the Header Xobject template at each page. | |
| $header_margin | |
| Minimum distance between header and top page margin. | |
| $footer_margin | |
| Minimum distance between footer and bottom page margin. | |
| $original_lMargin | |
| Original left margin value. | |
| $original_rMargin | |
| Original right margin value. | |
| $header_font | |
| Default font used on page header. | |
| $footer_font | |
| Default font used on page footer. | |
| $l | |
| Language templates. | |
| $barcode = false | |
| Barcode to print on page footer (only if set). | |
| $print_header = true | |
| Boolean flag to print/hide page header. | |
| $print_footer = true | |
| Boolean flag to print/hide page footer. | |
| $header_logo = '' | |
| Header image logo. | |
| $header_logo_width = 30 | |
| Width of header image logo in user units. | |
| $header_title = '' | |
| Title to be printed on default page header. | |
| $header_string = '' | |
| String to pring on page header after title. | |
| $header_text_color = array(0,0,0) | |
| Color for header text (RGB array). | |
| $header_line_color = array(0,0,0) | |
| Color for header line (RGB array). | |
| $footer_text_color = array(0,0,0) | |
| Color for footer text (RGB array). | |
| $footer_line_color = array(0,0,0) | |
| Color for footer line (RGB array). | |
| $txtshadow = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal') | |
| Text shadow data array. | |
| $default_table_columns = 4 | |
| Default number of columns for html table. | |
| $HREF = array() | |
| HTML PARSER: array to store current link and rendering styles. | |
| $fontlist = array() | |
| List of available fonts on filesystem. | |
| $fgcolor | |
| Current foreground color. | |
| $listordered = array() | |
| HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise. | |
| $listcount = array() | |
| HTML PARSER: array count list items on nested lists. | |
| $listnum = 0 | |
| HTML PARSER: current list nesting level. | |
| $listindent = 0 | |
| HTML PARSER: indent amount for lists. | |
| $listindentlevel = 0 | |
| HTML PARSER: current list indententation level. | |
| $bgcolor | |
| Current background color. | |
| $tempfontsize = 10 | |
| Temporary font size in points. | |
| $lispacer = '' | |
| Spacer string for LI tags. | |
| $encoding = 'UTF-8' | |
| Default encoding. | |
| $internal_encoding | |
| PHP internal encoding. | |
| $rtl = false | |
| Boolean flag to indicate if the document language is Right-To-Left. | |
| $tmprtl = false | |
| Boolean flag used to force RTL or LTR string direction. | |
| $encrypted | |
| IBoolean flag indicating whether document is protected. | |
| $encryptdata = array() | |
| Array containing encryption settings. | |
| $last_enc_key | |
| Last RC4 key encrypted (cached for optimisation). | |
| $last_enc_key_c | |
| Last RC4 computed key. | |
| $file_id | |
| File ID (used on document trailer). | |
| $outlines = array() | |
| Outlines for bookmark. | |
| $OutlineRoot | |
| Outline root for bookmark. | |
| $javascript = '' | |
| Javascript code. | |
| $n_js | |
| Javascript counter. | |
| $linethrough | |
| line through state | |
| $ur = array() | |
| Array with additional document-wide usage rights for the document. | |
| $dpi = 72 | |
| DPI (Dot Per Inch) Document Resolution (do not change). | |
| $newpagegroup = array() | |
| Array of page numbers were a new page group was started (the page numbers are the keys of the array). | |
| $pagegroups = array() | |
| Array that contains the number of pages in each page group. | |
| $currpagegroup = 0 | |
| Current page group number. | |
| $extgstates | |
| Array of transparency objects and parameters. | |
| $jpeg_quality | |
| Set the default JPEG compression quality (1-100). | |
| $cell_height_ratio = K_CELL_HEIGHT_RATIO | |
| Default cell height ratio. | |
| $viewer_preferences | |
| PDF viewer preferences. | |
| $PageMode | |
| A name object specifying how the document should be displayed when opened. | |
| $gradients = array() | |
| Array for storing gradient information. | |
| $intmrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). | |
| $bordermrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). | |
| $emptypagemrk = array() | |
| Array used to store page positions to track empty pages (keys are the page numbers). | |
| $cntmrk = array() | |
| Array used to store content positions inside the pages buffer (keys are the page numbers). | |
| $footerpos = array() | |
| Array used to store footer positions of each page. | |
| $footerlen = array() | |
| Array used to store footer length of each page. | |
| $newline = true | |
| Boolean flag to indicate if a new line is created. | |
| $endlinex = 0 | |
| End position of the latest inserted line. | |
| $linestyleWidth = '' | |
| PDF string for width value of the last line. | |
| $linestyleCap = '0 J' | |
| PDF string for CAP value of the last line. | |
| $linestyleJoin = '0 j' | |
| PDF string for join value of the last line. | |
| $linestyleDash = '[] 0 d' | |
| PDF string for dash value of the last line. | |
| $openMarkedContent = false | |
| Boolean flag to indicate if marked-content sequence is open. | |
| $htmlvspace = 0 | |
| Count the latest inserted vertical spaces on HTML. | |
| $spot_colors = array() | |
| Array of Spot colors. | |
| $lisymbol = '' | |
| Symbol used for HTML unordered list items. | |
| $epsmarker = 'x#!#EPS#!#x' | |
| String used to mark the beginning and end of EPS image blocks. | |
| $transfmatrix = array() | |
| Array of transformation matrix. | |
| $transfmatrix_key = 0 | |
| Current key for transformation matrix. | |
| $booklet = false | |
| Booklet mode for double-sided pages. | |
| $feps = 0.005 | |
| Epsilon value used for float calculations. | |
| $tagvspaces = array() | |
| Array used for custom vertical spaces for HTML tags. | |
| $customlistindent = -1 | |
| HTML PARSER: custom indent amount for lists. | |
| $opencell = true | |
| Boolean flag to indicate if the border of the cell sides that cross the page should be removed. | |
| $embeddedfiles = array() | |
| Array of files to embedd. | |
| $premode = false | |
| Boolean flag to indicate if we are inside a PRE tag. | |
| $transfmrk = array() | |
| Array used to store positions of graphics transformation blocks inside the page buffer. | |
| $htmlLinkColorArray = array(0, 0, 255) | |
| Default color for html links. | |
| $htmlLinkFontStyle = 'U' | |
| Default font style to add to html links. | |
| $numpages = 0 | |
| Counts the number of pages. | |
| $pagelen = array() | |
| Array containing page lengths in bytes. | |
| $numimages = 0 | |
| Counts the number of pages. | |
| $imagekeys = array() | |
| Store the image keys. | |
| $bufferlen = 0 | |
| Length of the buffer in bytes. | |
| $diskcache = false | |
| If true enables disk caching. | |
| $numfonts = 0 | |
| Counts the number of fonts. | |
| $fontkeys = array() | |
| Store the font keys. | |
| $font_obj_ids = array() | |
| Store the font object IDs. | |
| $pageopen = array() | |
| Store the fage status (true when opened, false when closed). | |
| $default_monospaced_font = 'courier' | |
| Default monospace font. | |
| $objcopy | |
| Cloned copy of the current class object. | |
| $cache_file_length = array() | |
| Array used to store the lengths of cache files. | |
| $thead = '' | |
| Table header content to be repeated on each new page. | |
| $theadMargins = array() | |
| Margins used for table header. | |
| $sign = false | |
| Boolean flag to enable document digital signature. | |
| $signature_data = array() | |
| Digital signature data. | |
| $signature_max_length = 11742 | |
| Digital signature max length. | |
| $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0') | |
| Data for digital signature appearance. | |
| $empty_signature_appearance = array() | |
| Array of empty digital signature appearances. | |
| $re_spaces = '/[^\S\xa0]/' | |
| Regular expression used to find blank characters (required for word-wrapping). | |
| $re_space = array('p' => '[^\S\xa0]', 'm' => '') | |
| Array of $re_spaces parts. | |
| $sig_obj_id = 0 | |
| Digital signature object ID. | |
| $page_obj_id = array() | |
| ID of page objects. | |
| $form_obj_id = array() | |
| List of form annotations IDs. | |
| $default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128)) | |
| Deafult Javascript field properties. | |
| $js_objects = array() | |
| Javascript objects array. | |
| $form_action = '' | |
| Current form action (used during XHTML rendering). | |
| $form_enctype = 'application/x-www-form-urlencoded' | |
| Current form encryption type (used during XHTML rendering). | |
| $form_mode = 'post' | |
| Current method to submit forms. | |
| $annotation_fonts = array() | |
| List of fonts used on form fields (fontname => fontkey). | |
| $radiobutton_groups = array() | |
| List of radio buttons parent objects. | |
| $radio_groups = array() | |
| List of radio group objects IDs. | |
| $textindent = 0 | |
| Text indentation value (used for text-indent CSS attribute). | |
| $start_transaction_page = 0 | |
| Store page number when startTransaction() is called. | |
| $start_transaction_y = 0 | |
| Store Y position when startTransaction() is called. | |
| $inthead = false | |
| True when we are printing the thead section on a new page. | |
| $columns = array() | |
| Array of column measures (width, space, starting Y position). | |
| $num_columns = 1 | |
| Number of colums. | |
| $current_column = 0 | |
| Current column number. | |
| $column_start_page = 0 | |
| Starting page for columns. | |
| $maxselcol = array('page' => 0, 'column' => 0) | |
| Maximum page and column selected. | |
| $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. | |
| $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. | |
| $textstrokewidth = 0 | |
| Text stroke width in doc units. | |
| $strokecolor | |
| Current stroke color. | |
| $pdfunit = 'mm' | |
| Default unit of measure for document. | |
| $tocpage = false | |
| Boolean flag true when we are on TOC (Table Of Content) page. | |
| $rasterize_vector_images = false | |
| Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library. | |
| $font_subsetting = true | |
| Boolean flag: if true enables font subsetting by default. | |
| $default_graphic_vars = array() | |
| Array of default graphic settings. | |
| $xobjects = array() | |
| Array of XObjects. | |
| $inxobj = false | |
| Boolean value true when we are inside an XObject. | |
| $xobjid = '' | |
| Current XObject ID. | |
| $font_stretching = 100 | |
| Percentage of character stretching. | |
| $font_spacing = 0 | |
| Increases or decreases the space between characters in a text by the specified amount (tracking). | |
| $page_regions = array() | |
| Array of no-write regions. | |
| $check_page_regions = true | |
| Boolean value true when page region check is active. | |
| $pdflayers = array() | |
| Array of PDF layers data. | |
| $dests = array() | |
| A dictionary of names and corresponding destinations (Dests key on document Catalog). | |
| $n_dests | |
| Object ID for Named Destinations. | |
| $efnames = array() | |
| Embedded Files Names. | |
| $svgdir = '' | |
| Directory used for the last SVG image. | |
| $svgunit = 'px' | |
| Deafult unit of measure for SVG. | |
| $svggradients = array() | |
| Array of SVG gradients. | |
| $svggradientid = 0 | |
| ID of last SVG gradient. | |
| $svgdefsmode = false | |
| Boolean value true when in SVG defs group. | |
| $svgdefs = array() | |
| Array of SVG defs. | |
| $svgclipmode = false | |
| Boolean value true when in SVG clipPath tag. | |
| $svgclippaths = array() | |
| Array of SVG clipPath commands. | |
| $svgcliptm = array() | |
| Array of SVG clipPath tranformation matrix. | |
| $svgclipid = 0 | |
| ID of last SVG clipPath. | |
| $svgtext = '' | |
| SVG text. | |
| $svgtextmode = array() | |
| SVG text properties. | |
| $svgstyles | |
| Array of SVG properties. | |
| $force_srgb = false | |
| If true force sRGB color profile for all document. | |
| $pdfa_mode = false | |
| If true set the document to PDF/A mode. | |
| $doc_creation_timestamp | |
| Document creation date-time. | |
| $doc_modification_timestamp | |
| Document modification date-time. | |
| $custom_xmp = '' | |
| Custom XMP data. | |
| $overprint = array('OP' => false, 'op' => false, 'OPM' => 0) | |
| Overprint mode array. | |
| $alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => false) | |
| Alpha mode array. | |
| $page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox') | |
| Define the page boundaries boxes to be set on document. | |
| $tcpdflink = true | |
| If true print TCPDF meta link. | |
| $gdgammacache = array() | |
| Cache array for computed GD gamma values. | |
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.
| TCPDF::__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 (used only when converting back html entities); 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. |
Definition at line 1878 of file tcpdf.php.
References $diskcache, $doc_creation_timestamp, $encoding, $k, $lMargin, $rMargin, _dochecks(), getFontsList(), getGraphicVars(), TCPDF_STATIC\getRandomSeed(), n, SetAutoPageBreak(), setCellMargins(), setCellPaddings(), SetCompression(), SetDisplayMode(), SetFont(), SetMargins(), setPageFormat(), setPageUnit(), setPDFVersion(), setSpacesRE(), setTextShadow(), and TCPDF_FONTS\utf8Bidi().
Here is the call graph for this function:| TCPDF::__destruct | ( | ) |
Default destructor.
Definition at line 2029 of file tcpdf.php.
References _destroy().
Here is the call graph for this function:
|
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. |
Definition at line 12592 of file tcpdf.php.
References $h, $k, $w, $x, $y, and TCPDF_COLORS\_JScolor().
Referenced by Button(), ListBox(), RadioButton(), and TextField().
Here is the call graph for this function: Here is the caller graph for this function:
|
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(). |
Definition at line 9989 of file tcpdf.php.
References $CurOrientation, $currpagegroup, $lMargin, $page, $rMargin, $tMargin, TCPDF_STATIC\empty_string(), setPageBuffer(), setPageFormat(), and setPageOrientation().
Referenced by startPage().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Format a data string for meta information.
| $s | (string) data string to escape. |
| $n | (int) object ID |
Definition at line 10148 of file tcpdf.php.
References $n, _encrypt_data(), and TCPDF_STATIC\_escape().
Referenced by _datestring(), and _textstring().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns a formatted date for meta information.
| $n | (int) Object ID. |
| $timestamp | (int) Timestamp to convert. |
Definition at line 10210 of file tcpdf.php.
References $doc_creation_timestamp, $n, $timestamp, _datastring(), and TCPDF_STATIC\getFormattedDate().
Here is the call graph for this function:| TCPDF::_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 |
Definition at line 7729 of file tcpdf.php.
References TCPDF_STATIC\empty_string().
Referenced by __destruct(), Close(), and Error().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Check for locale-related bug.
Definition at line 7767 of file tcpdf.php.
References Error().
Referenced by __construct().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Line through text.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $txt | (string) text to linethrough |
Definition at line 10096 of file tcpdf.php.
References $txt, $w, $x, $y, _dolinethroughw(), and GetStringWidth().
Here is the call graph for this function:
|
protected |
Line through for rectangular text area.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $w | (int) line length (width) |
Definition at line 10109 of file tcpdf.php.
References $FontSizePt, $w, $x, and $y.
Referenced by _dolinethrough().
Here is the caller graph for this function:
|
protected |
Overline text.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $txt | (string) text to overline |
Definition at line 10122 of file tcpdf.php.
References $txt, $w, $x, $y, _dooverlinew(), and GetStringWidth().
Here is the call graph for this function:
|
protected |
Overline for rectangular text area.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $w | (int) width to overline |
Definition at line 10135 of file tcpdf.php.
References $FontSizePt, $w, $x, and $y.
Referenced by _dooverline().
Here is the caller graph for this function:
|
protected |
Underline text.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $txt | (string) text to underline |
Definition at line 10071 of file tcpdf.php.
References $txt, $w, $x, $y, _dounderlinew(), and GetStringWidth().
Here is the call graph for this function:
|
protected |
Underline for rectangular text area.
| $x | (int) X coordinate |
| $y | (int) Y coordinate |
| $w | (int) width to underline |
Definition at line 10084 of file tcpdf.php.
References $FontSizePt, $w, $x, and $y.
Referenced by _dounderline().
Here is the caller graph for this function:
|
protected |
Encrypt the input string.
| $n | (int) object number |
| $s | (string) data string to encrypt |
Definition at line 10487 of file tcpdf.php.
References $n, TCPDF_STATIC\_AES(), _objectkey(), and TCPDF_STATIC\_RC4().
Referenced by _datastring(), and _getrawstream().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output end of document (EOF).
Definition at line 9887 of file tcpdf.php.
References $bufferlen, $n, $out, _getobj(), _out(), _putcatalog(), _putheader(), _putinfo(), _putpages(), _putresources(), _putsignature(), n, and setFontSubBuffer().
Referenced by Close().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Mark end of page.
Definition at line 10032 of file tcpdf.php.
References setVisibility().
Referenced by endPage().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
THIS METHOD IS DEPRECATED Format a text string.
| $s | (string) string to escape. |
Definition at line 10240 of file tcpdf.php.
References TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev(), and TCPDF_FONTS\UTF8ToLatin1().
Here is the call graph for this function:
|
protected |
Convert password for AES-256 encryption mode.
| $password | (string) password |
Definition at line 10733 of file tcpdf.php.
References unichr(), TCPDF_FONTS\utf8Bidi(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by _generateencryptionkey().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Compute encryption key.
Definition at line 10748 of file tcpdf.php.
References TCPDF_STATIC\$enc_padding, _fixAES256Password(), TCPDF_STATIC\_md5_16(), _OEvalue(), _Ovalue(), _UEvalue(), _Uvalue(), Error(), TCPDF_STATIC\getEncPermissionsString(), TCPDF_STATIC\getObjFilename(), TCPDF_STATIC\getRandomSeed(), and TCPDF_STATIC\getUserPermissionCode().
Referenced by SetProtection().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Get references to page annotations.
| $n | (int) page number |
Definition at line 8046 of file tcpdf.php.
Referenced by _putannotsrefs(), and _putpages().
Here is the caller graph for this function:
|
protected |
Return the starting object string for the selected object ID.
| $objid | (int) Object ID (leave empty to get a new ID). |
Definition at line 10054 of file tcpdf.php.
References $bufferlen, $n, and $page.
Referenced by _enddoc(), _newobj(), _putannotsobjs(), _putAPXObject(), _putcidfont0(), _putEmbeddedFiles(), _putfonts(), _putjavascript(), _putpages(), _putresourcedict(), _putsignature(), _puttruetypeunicode(), and _putxobjects().
Here is the caller graph for this function:
|
protected |
get raw output stream.
| $s | (string) string to output. |
| $n | (int) object reference for encryption mode |
Definition at line 10260 of file tcpdf.php.
References $n, and _encrypt_data().
Referenced by _getstream(), _putAPXObject(), _putcatalog(), _putEmbeddedFiles(), _putfonts(), _putimages(), _putpages(), _putshaders(), _puttruetypeunicode(), and _putxobjects().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Format output stream (DEPRECATED).
| $s | (string) string to output. |
| $n | (int) object reference for encryption mode |
Definition at line 10275 of file tcpdf.php.
References $n, and _getrawstream().
Referenced by _putstream().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Return XObjects Dictionary.
Definition at line 9327 of file tcpdf.php.
References $out.
Referenced by _putresourcedict().
Here is the caller graph for this function:
|
protected |
Begin a new object and return the object number.
Definition at line 10042 of file tcpdf.php.
References $n, _getobj(), and _out().
Referenced by _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putshaders(), _putspotcolors(), _puttruetypeunicode(), and _putXMP().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Compute encryption key depending on object number where the encrypted data is stored.
This is used for all strings and streams without crypt filter specifier.
| $n | (int) object number |
Definition at line 10467 of file tcpdf.php.
References $n, and TCPDF_STATIC\_md5_16().
Referenced by _encrypt_data().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Compute OE value (used for encryption)
Definition at line 10719 of file tcpdf.php.
Referenced by _generateencryptionkey().
Here is the caller graph for this function:
|
protected |
Output a string to the document.
| $s | (string) string to output. |
Definition at line 10295 of file tcpdf.php.
References $page, $xobjid, getPageBuffer(), setBuffer(), and setPageBuffer().
Referenced by _enddoc(), _newobj(), _outCurve(), _outCurveV(), _outCurveY(), _outLine(), _outPoint(), _outRect(), _putannotsobjs(), _putannotsrefs(), _putAPXObject(), _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putheader(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putresourcedict(), _putshaders(), _putsignature(), _putspotcolors(), _putstream(), _puttruetypeunicode(), _putXMP(), _putxobjects(), Cell(), Clip(), Close(), CoonsPatchMesh(), Curve(), Ellipse(), endLayer(), Gradient(), Image(), ImageEps(), Line(), PieSectorXY(), Polycurve(), Polygon(), RoundedRectXY(), setColor(), setExtGState(), SetFontSize(), setFooter(), setHeader(), SetLineStyle(), SetLineWidth(), setSpotColor(), setVisibility(), startLayer(), StartTransform(), StopTransform(), and Transform().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 11459 of file tcpdf.php.
References _out().
Referenced by _outellipticalarc(), Curve(), Polycurve(), and RoundedRectXY().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 11475 of file tcpdf.php.
References _out().
Here is the call graph for this function:
|
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. |
Definition at line 11491 of file tcpdf.php.
References _out().
Here is the call graph for this function:
|
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). |
Definition at line 11720 of file tcpdf.php.
References $alpha, $k, _outCurve(), _outLine(), and _outPoint().
Referenced by Ellipse(), and PieSectorXY().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Append a straight line segment from the current point to the point (x, y).
The new current point shall be (x, y).
| $x | (float) Abscissa of end point. |
| $y | (float) Ordinate of end point. |
Definition at line 11425 of file tcpdf.php.
References $x, $y, and _out().
Referenced by _outellipticalarc(), Line(), Polygon(), and RoundedRectXY().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
| $x | (float) Abscissa of point. |
| $y | (float) Ordinate of point. |
Definition at line 11411 of file tcpdf.php.
References $x, $y, and _out().
Referenced by _outellipticalarc(), Curve(), Line(), Polycurve(), Polygon(), and RoundedRectXY().
Here is the call graph for this function: Here is the caller graph for this function:
|
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 |
Definition at line 11441 of file tcpdf.php.
References $h, $w, $x, $y, and _out().
Referenced by Rect().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Compute O value (used for encryption)
Definition at line 10681 of file tcpdf.php.
References TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4(), and TCPDF_STATIC\getRandomSeed().
Referenced by _generateencryptionkey().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output annotations objects for all pages.
!!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.
Definition at line 8090 of file tcpdf.php.
References $d, $filename, $k, $l, $n, $numpages, $t, _getobj(), _out(), _putAPXObject(), _textstring(), getImageBuffer(), and unhtmlentities().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output references to page annotations.
| $n | (int) page number |
Definition at line 8034 of file tcpdf.php.
References $n, _getannotsrefs(), and _out().
Here is the call graph for this function:
|
protected |
Put appearance streams XObject used to define annotation's appearance states.
| $w | (int) annotation width |
| $h | (int) annotation height |
| $stream | (string) appearance stream |
Definition at line 8721 of file tcpdf.php.
References $h, $n, $out, $w, _getobj(), _getrawstream(), _out(), and n.
Referenced by _putannotsobjs().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Create a bookmark PDF string.
Definition at line 12379 of file tcpdf.php.
References $filename, $l, $n, $out, $title, _newobj(), _out(), n, sortBookmarks(), stringTrim(), and unhtmlentities().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output Catalog.
Definition at line 9625 of file tcpdf.php.
References $out, _getrawstream(), _newobj(), _out(), _putviewerpreferences(), _putXMP(), TCPDF_STATIC\empty_string(), and getFontBuffer().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output CID-0 fonts.
A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
| $font | (array) font data |
Definition at line 9025 of file tcpdf.php.
References $k, $out, _getobj(), _newobj(), and _out().
Here is the call graph for this function:
|
protected |
Insert Named Destinations.
Definition at line 12277 of file tcpdf.php.
References $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Embedd the attached files.
Definition at line 4868 of file tcpdf.php.
References $filename, $out, _getobj(), _getrawstream(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Put encryption on PDF document.
Definition at line 10515 of file tcpdf.php.
References $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Put extgstates for object transparency.
Definition at line 13793 of file tcpdf.php.
References $k, $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output fonts.
Definition at line 8751 of file tcpdf.php.
References $file, $k, $n, $out, TCPDF_FONTS\_getfontpath(), _getobj(), _getrawstream(), TCPDF_FONTS\_getTrueTypeFontSubset(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), TCPDF_STATIC\get_mqr(), getFontBuffer(), and TCPDF_STATIC\set_mqr().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output PDF File Header (7.5.2).
Definition at line 9878 of file tcpdf.php.
References _out().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output images.
Definition at line 9095 of file tcpdf.php.
References $compress, $file, $out, _getrawstream(), _newobj(), _out(), getImageBuffer(), n, and setImageSubBuffer().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Definition at line 9426 of file tcpdf.php.
References $isunicode, $out, _newobj(), _out(), TCPDF_STATIC\empty_string(), and TCPDF_STATIC\getTCPDFProducer().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Create a javascript PDF string.
Definition at line 12534 of file tcpdf.php.
References $out, _getobj(), _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Put pdf layers.
Definition at line 13652 of file tcpdf.php.
References $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output pages (and replace page number aliases).
Definition at line 7871 of file tcpdf.php.
References $compress, $k, $n, $numpages, $out, $pagelen, _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\formatPageNumber(), getAllInternalPageNumberAliases(), GetNumChars(), getPageBuffer(), TCPDF_STATIC\replacePageNumAliases(), replaceRightShiftPageNumAliases(), and TCPDF_FONTS\UTF8ToUTF16BE().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output Resources Dictionary.
Definition at line 9339 of file tcpdf.php.
References $k, $out, _getobj(), _getxobjectdict(), _out(), and getFontBuffer().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output Resources.
Definition at line 9403 of file tcpdf.php.
References _putannotsobjs(), _putbookmarks(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putjavascript(), _putocg(), _putresourcedict(), _putshaders(), _putspotcolors(), and _putxobjects().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output gradient shaders.
Definition at line 14445 of file tcpdf.php.
References $n, $out, _getrawstream(), _newobj(), _out(), and n.
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Add certification signature (DocMDP or UR3) You can set only one signature type.
Definition at line 13301 of file tcpdf.php.
References $out, _getobj(), _out(), and TCPDF_STATIC\empty_string().
Referenced by _enddoc().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output Spot Colors Resources.
Definition at line 9307 of file tcpdf.php.
References $n, $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output a stream (DEPRECATED).
| $s | (string) string to output. |
| $n | (int) object reference for encryption mode |
Definition at line 10286 of file tcpdf.php.
References $n, _getstream(), and _out().
Here is the call graph for this function:
|
protected |
Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)
| $font | (array) font data |
Definition at line 8913 of file tcpdf.php.
References $compress, $out, TCPDF_FONT_DATA\$uni_identity_h, TCPDF_FONTS\_getfontpath(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), and n.
Here is the call graph for this function:
|
protected |
Output viewer preferences.
Definition at line 9806 of file tcpdf.php.
References $k, $out, $viewer_preferences, and TCPDF_STATIC\empty_string().
Referenced by _putcatalog().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Put XMP data object and return ID.
Definition at line 9487 of file tcpdf.php.
References $custom_xmp, $encrypted, $isunicode, $out, TCPDF_STATIC\_escapeXML(), _newobj(), _out(), TCPDF_STATIC\getFormattedDate(), and TCPDF_STATIC\getTCPDFProducer().
Referenced by _putcatalog().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output Form XObjects Templates.
Definition at line 9204 of file tcpdf.php.
References $k, $out, _getobj(), _getrawstream(), and _out().
Referenced by _putresources().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Format a text string for meta information.
| $s | (string) string to escape. |
| $n | (int) object ID |
Definition at line 10224 of file tcpdf.php.
References $n, _datastring(), and TCPDF_FONTS\UTF8ToUTF16BE().
Referenced by _putannotsobjs(), and Button().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Compute UE value (used for encryption)
Definition at line 10668 of file tcpdf.php.
Referenced by _generateencryptionkey().
Here is the caller graph for this function:
|
protected |
Compute U value (used for encryption)
Definition at line 10635 of file tcpdf.php.
References TCPDF_STATIC\$enc_padding, TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4(), and TCPDF_STATIC\getRandomSeed().
Referenced by _generateencryptionkey().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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.
Definition at line 4942 of file tcpdf.php.
References $AutoPageBreak, AddPage(), and selectColumn().
Referenced by checkPageBreak(), and Write().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::addEmptySignatureAppearance | ( | $x = 0, |
|
$y = 0, |
|||
$w = 0, |
|||
$h = 0, |
|||
$page = -1, |
|||
$name = '' |
|||
| ) |
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). |
| $name | (string) Name of the signature. |
Definition at line 13475 of file tcpdf.php.
References $h, $n, $page, $w, $x, $y, getSignatureAppearanceArray(), and n.
Here is the call graph for this function:
|
protected |
Add transparency parameters to the current extgstate.
| $parms | (array) parameters |
Definition at line 13749 of file tcpdf.php.
Referenced by setAlpha(), and setOverprint().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 4205 of file tcpdf.php.
References $d, $file, $font_subsetting, $FontFamily, $numfonts, $xobjid, TCPDF_FONTS\_getfontpath(), TCPDF_STATIC\empty_string(), Error(), getFontBuffer(), setFontBuffer(), and setFontSubBuffer().
Referenced by getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars(), and SetFont().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 10396 of file tcpdf.php.
References $fgcolor, $FontStyle, $page, $ret, AddLink(), SetFont(), SetLink(), SetTextColorArray(), and Write().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 21332 of file tcpdf.php.
References $n, $row, TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber(), and TCPDF_FONTS\UTF8ToUTF16BE().
Here is the call graph for this function:
|
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. |
Definition at line 19658 of file tcpdf.php.
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::addJavascriptObject | ( | $script, | |
$onload = false |
|||
| ) |
Adds a javascript object and return object ID.
| $script | (string) Javascript code |
| $onload | (boolean) if true executes this object when opening the document |
Definition at line 12518 of file tcpdf.php.
Referenced by Button().
Here is the caller graph for this function:| TCPDF::AddLink | ( | ) |
Creates a new internal link and returns its identifier.
An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
Definition at line 4722 of file tcpdf.php.
References $n.
Referenced by addHtmlLink(), and openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3123 of file tcpdf.php.
References $lMargin, $rMargin, $tocpage, endPage(), and startPage().
Referenced by AcceptPageBreak(), addTOCPage(), checkPageBreak(), and Close().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 22359 of file tcpdf.php.
| TCPDF::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. |
Definition at line 3718 of file tcpdf.php.
Referenced by ImageEps(), and setColor().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 21127 of file tcpdf.php.
References $n, $txt, TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber(), and TCPDF_FONTS\UTF8ToUTF16BE().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 3098 of file tcpdf.php.
References AddPage().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 4188 of file tcpdf.php.
|
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:
|
Definition at line 2733 of file tcpdf.php.
References $cell_padding, and $LineWidth.
Referenced by Cell(), getCellCode(), getNumLines(), getStringHeight(), and MultiCell().
Here is the caller graph for this function:| TCPDF::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 |
Definition at line 4778 of file tcpdf.php.
References $h, $k, $page, $w, $x, $xobjid, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Image(), TCPDF_STATIC\isValidURL(), and n.
Referenced by Button(), Link(), RadioButton(), and TextField().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 12165 of file tcpdf.php.
References $LineWidth, Line(), and Polygon().
Here is the call graph for this function:| TCPDF::Bookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0), |
|||
$x = -1, |
|||
$link = '' |
|||
| ) |
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;). |
| $link | (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name). |
Definition at line 12320 of file tcpdf.php.
References $h, $page, $txt, $w, $x, $y, GetX(), GetY(), and PageNo().
Referenced by setBookmark().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 13134 of file tcpdf.php.
References $h, $k, $n, $w, $x, $y, _addfield(), _textstring(), addJavascriptObject(), Annotation(), Cell(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), n, SetFillColor(), and startTemplate().
Referenced by openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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:
|
Definition at line 5023 of file tcpdf.php.
References $alpha, $bgcolor, $cell_height_ratio, $cell_margin, $cell_padding, $fgcolor, $h, $strokecolor, $txt, $w, $x, $y, _out(), adjustCellPadding(), checkPageBreak(), getCellCode(), setAlpha(), SetDrawColorArray(), SetFillColorArray(), and SetTextColorArray().
Referenced by Button(), Close(), Footer(), Header(), Image(), ImageEps(), Text(), Write(), and write1DBarcode().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 13054 of file tcpdf.php.
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:
|
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 |
Definition at line 4969 of file tcpdf.php.
References $h, $page, $tMargin, $x, $y, AcceptPageBreak(), AddPage(), TCPDF_STATIC\empty_string(), and inPageBody().
Referenced by Cell(), fitBlock(), MultiCell(), openHTMLTagHandler(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
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 |
Definition at line 22396 of file tcpdf.php.
Referenced by Annotation(), Button(), getCellCode(), getRemainingWidth(), Image(), ImageEps(), ListBox(), MultiCell(), RadioButton(), TextField(), Write(), write1DBarcode(), and write2DBarcode().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 11848 of file tcpdf.php.
References Ellipse().
Referenced by registrationMark(), RegularPolygon(), and StarPolygon().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 14313 of file tcpdf.php.
References $h, $w, $x, $y, and _out().
Referenced by CoonsPatchMesh(), LinearGradient(), and RadialGradient().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::Close | ( | ) |
Terminates the PDF document.
It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.
Definition at line 2972 of file tcpdf.php.
References $k, _destroy(), _enddoc(), _out(), AddPage(), Cell(), endLayer(), endPage(), getGraphicVars(), SetAutoPageBreak(), setEqualColumns(), SetFont(), setGraphicVars(), and setTextRenderingMode().
Referenced by getPDFData(), and Output().
Here is the call graph for this function: Here is the caller graph for this function:
|
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 |
Definition at line 19123 of file tcpdf.php.
Referenced by writeHTML().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 13980 of file tcpdf.php.
References $h, $w, $x, $y, LinearGradient(), Rect(), and SetFillColorArray().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 12967 of file tcpdf.php.
| TCPDF::commitTransaction | ( | ) |
|
protected |
Convert SVG transformation matrix to PDF.
| $tm | (array) original SVG transformation matrix |
Definition at line 22803 of file tcpdf.php.
References $d.
| TCPDF::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. |
Definition at line 14221 of file tcpdf.php.
References $h, $n, $w, $x, $xobjid, $y, _out(), and Clip().
Here is the call graph for this function:| TCPDF::copyPage | ( | $page = 0 | ) |
Clone the specified page to a new page.
| $page | (int) number of page to copy (0 = current page) |
Definition at line 21050 of file tcpdf.php.
| TCPDF::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). |
Definition at line 14078 of file tcpdf.php.
References $h, $w, $x, $y, Line(), and SetLineStyle().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 11609 of file tcpdf.php.
References _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Here is the call graph for this function:| TCPDF::deletePage | ( | $page | ) |
Remove the specified page.
| $page | (int) page to remove |
Definition at line 20868 of file tcpdf.php.
|
protected |
Draw an HTML block border and fill.
| $tag | (array) array of tag properties. |
| $xmax | (int) end X coordinate for border. |
Definition at line 19700 of file tcpdf.php.
References TCPDF_STATIC\empty_string(), and TCPDF_STATIC\getBorderMode().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 11679 of file tcpdf.php.
References _out(), _outellipticalarc(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Referenced by Circle().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::endLayer | ( | ) |
End the current PDF layer.
Definition at line 13697 of file tcpdf.php.
References _out().
Referenced by Close(), and setVisibility().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3147 of file tcpdf.php.
References $page, $tocpage, _endpage(), and setFooter().
Referenced by AddPage(), Close(), and endTOCPage().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 24006 of file tcpdf.php.
| TCPDF::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.
Definition at line 22123 of file tcpdf.php.
Referenced by Button(), Header(), and TextField().
Here is the caller graph for this function:| TCPDF::endTOCPage | ( | ) |
Terminate the current TOC (Table Of Content) page.
Definition at line 3108 of file tcpdf.php.
References endPage().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 2940 of file tcpdf.php.
References _destroy().
Referenced by _dochecks(), _generateencryptionkey(), _putfonts(), _puttruetypeunicode(), AddFont(), Image(), ImageEps(), ImagePngAlpha(), TCPDF_IMPORT\importPDF(), openHTMLTagHandler(), Output(), Scale(), SetDisplayMode(), setPage(), setPageUnit(), SetProtection(), setSignature(), setSpotColor(), setVisibility(), Skew(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 6719 of file tcpdf.php.
References $h, $lMargin, $PageBreakTrigger, $rMargin, $tMargin, $w, $x, $y, and checkPageBreak().
Referenced by Image(), ImageEps(), write1DBarcode(), and write2DBarcode().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 15694 of file tcpdf.php.
| TCPDF::Footer | ( | ) |
This method is used to render the page footer.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
Definition at line 3490 of file tcpdf.php.
References $barcode, $k, $y, Cell(), getAliasNbPages(), getAliasRightShift(), getBarcode(), getPageGroupAlias(), getRTL(), Ln(), SetLineStyle(), SetTextColorArray(), SetX(), SetY(), and write1DBarcode().
Referenced by setFooter().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getAbsFontMeasure | ( | $s | ) |
Convert a relative font measure into absolute value.
| $s | (int) Font measure. |
Definition at line 4579 of file tcpdf.php.
Referenced by getFontBBox(), getRawCharWidth(), and RadioButton().
Here is the caller graph for this function:| TCPDF::GetAbsX | ( | ) |
| TCPDF::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.
Definition at line 13565 of file tcpdf.php.
References TCPDF_STATIC\$alias_tot_pages, and isUnicodeFont().
Referenced by Footer().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getAliasNumPage | ( | ) |
Returns the string alias used for the page number.
If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number.
Definition at line 13580 of file tcpdf.php.
References TCPDF_STATIC\$alias_num_page, and isUnicodeFont().
Here is the call graph for this function:| TCPDF::getAliasRightShift | ( | ) |
Returns the string alias used right align page numbers.
If the current font is unicode type, the returned string wil contain an additional open curly brace.
Definition at line 13544 of file tcpdf.php.
References TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, GetNumChars(), GetStringWidth(), and isUnicodeFont().
Referenced by Footer().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Return an array containing all internal page aliases.
Definition at line 7805 of file tcpdf.php.
References TCPDF_STATIC\$alias_group_num_page, TCPDF_STATIC\$alias_group_tot_pages, TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, $k, and getInternalPageNumberAliases().
Referenced by _putpages().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getAlpha | ( | ) |
| TCPDF::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. |
Definition at line 4050 of file tcpdf.php.
References $FontFamily, $FontSizePt, $FontStyle, $w, TCPDF_STATIC\empty_string(), GetCharWidth(), isUnicodeFont(), SetFont(), and TCPDF_FONTS\UTF8ArrToLatin1Arr().
Referenced by getCellCode(), getNumLines(), GetStringWidth(), and Write().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getAutoPageBreak | ( | ) |
Return the auto-page-break mode (true or false).
Definition at line 2820 of file tcpdf.php.
References $AutoPageBreak.
| TCPDF::getBarcode | ( | ) |
|
protected |
Return the starting coordinates to draw an html border.
Definition at line 19684 of file tcpdf.php.
| TCPDF::getBreakMargin | ( | $pagenum = '' | ) |
Returns the page break margin.
| $pagenum | (int) page number (empty = current page) |
Definition at line 2551 of file tcpdf.php.
References $bMargin.
|
protected |
Get buffer content.
Definition at line 20521 of file tcpdf.php.
Referenced by Output().
Here is the caller graph for this function:
|
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:
|
Definition at line 5583 of file tcpdf.php.
References $h, $k, $LineWidth, $w, $x, $y, and SetLineStyle().
Referenced by getCellCode().
Here is the call graph for this function: Here is the caller graph for this function:
|
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:
|
Definition at line 5092 of file tcpdf.php.
References $cell_height_ratio, $cell_margin, $cell_padding, $font_spacing, $font_stretching, $FontAscent, $FontDescent, $FontSize, $h, $k, $lMargin, $rMargin, $txt, $w, $x, $y, TCPDF_STATIC\_escape(), adjustCellPadding(), TCPDF_FONTS\arrUTF8ToUTF16BE(), checkPageRegions(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), getCellBorder(), GetNumChars(), GetStringWidth(), isCharDefined(), isUnicodeFont(), Link(), TCPDF_STATIC\removeSHY(), replaceChar(), setFontSubBuffer(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi(), TCPDF_FONTS\UTF8StringToArray(), and TCPDF_FONTS\UTF8ToLatin1().
Referenced by Cell(), and MultiCell().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getCellHeightRatio | ( | ) |
return the height of cell repect font height.
Definition at line 13935 of file tcpdf.php.
References $cell_height_ratio.
| TCPDF::getCellMargins | ( | ) |
Get the internal Cell margin array.
Definition at line 2722 of file tcpdf.php.
References $cell_margin.
| TCPDF::getCellPaddings | ( | ) |
Get the internal Cell padding array.
Definition at line 2686 of file tcpdf.php.
References $cell_padding.
| TCPDF::getCharBBox | ( | $char | ) |
Returns the glyph bounding box of the specified character in the current font in user units.
| $char | (int) Input character code. |
Definition at line 4589 of file tcpdf.php.
| TCPDF::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. |
Definition at line 4089 of file tcpdf.php.
References $font_spacing, and getRawCharWidth().
Referenced by GetArrStringWidth(), and Write().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getColumn | ( | ) |
Return the current column number.
|
protected |
Returns the border dash style from CSS property.
| $style | (string) border style to convert |
Definition at line 15725 of file tcpdf.php.
Referenced by getCSSBorderStyle(), and getHtmlDomArray().
Here is the caller graph for this function:| TCPDF::getCSSBorderMargin | ( | $cssbspace, | |
$width = 0 |
|||
| ) |
Get the border-spacing from CSS attribute.
| $cssbspace | (string) border-spacing CSS properties |
| $width | (float) width of the containing element |
Definition at line 15920 of file tcpdf.php.
References $rMargin, $space, and getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns the border style array from CSS border properties.
| $cssborder | (string) border properties |
Definition at line 15761 of file tcpdf.php.
References TCPDF_COLORS\convertHTMLColorToDec(), getCSSBorderDashStyle(), and getCSSBorderWidth().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns the border width from CSS property.
| $width | (string) border width |
Definition at line 15705 of file tcpdf.php.
References $k, and getHTMLUnitToUnits().
Referenced by getCSSBorderStyle(), and getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns the letter-spacing value from CSS value.
| $spacing | (string) letter-spacing value |
| $parent | (float) font spacing (tracking) value of the parent element |
Definition at line 15954 of file tcpdf.php.
References getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns the percentage of font stretching from CSS value.
| $stretch | (string) stretch mode |
| $parent | (float) stretch value of the parent element |
Definition at line 15985 of file tcpdf.php.
References getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getCSSMargin | ( | $cssmargin, | |
$width = 0 |
|||
| ) |
Get the internal Cell margin from CSS attribute.
| $cssmargin | (string) margin properties |
| $width | (float) width of the containing element |
Definition at line 15866 of file tcpdf.php.
References $cell_margin, $rMargin, and getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getCSSPadding | ( | $csspadding, | |
$width = 0 |
|||
| ) |
Get the internal Cell padding from CSS attribute.
| $csspadding | (string) padding properties |
| $width | (float) width of the containing element |
Definition at line 15812 of file tcpdf.php.
References $cell_padding, $rMargin, and getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getDestination | ( | ) |
| TCPDF::getDocCreationTimestamp | ( | ) |
Returns document creation timestamp in seconds.
Definition at line 10188 of file tcpdf.php.
References $doc_creation_timestamp.
| TCPDF::getDocModificationTimestamp | ( | ) |
Returns document modification timestamp in seconds.
Definition at line 10198 of file tcpdf.php.
References $doc_modification_timestamp.
| TCPDF::getFontAscent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
Return the font ascent value.
| $font | (string) font name |
| $style | (string) font style |
| $size | (float) The size (in points) |
Definition at line 4627 of file tcpdf.php.
References $size, AddFont(), and getFontBuffer().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getFontBBox | ( | ) |
Returns the bounding box of the current font in user units.
Definition at line 4540 of file tcpdf.php.
References $w, and getAbsFontMeasure().
Here is the call graph for this function:
|
protected |
Get font buffer content.
| $font | (string) font key |
Definition at line 20688 of file tcpdf.php.
Referenced by _putcatalog(), _putfonts(), _putresourcedict(), AddFont(), getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars(), and SetFont().
Here is the caller graph for this function:| TCPDF::getFontDescent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
Return the font descent value.
| $font | (string) font name |
| $style | (string) font style |
| $size | (float) The size (in points) |
Definition at line 4606 of file tcpdf.php.
References $size, AddFont(), and getFontBuffer().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getFontFamily | ( | ) |
Returns the current font family name.
Definition at line 15668 of file tcpdf.php.
References $FontFamily.
| TCPDF::getFontFamilyName | ( | $fontfamily | ) |
Return normalized font name.
| $fontfamily | (string) property string containing font family names |
Definition at line 22015 of file tcpdf.php.
Referenced by getHtmlDomArray().
Here is the caller graph for this function:| TCPDF::getFontSize | ( | ) |
| TCPDF::getFontSizePt | ( | ) |
Returns the current font size in points unit.
Definition at line 15658 of file tcpdf.php.
References $FontSizePt.
|
protected |
Fill the list of available fonts ($this->fontlist).
Definition at line 4149 of file tcpdf.php.
References $file, and TCPDF_FONTS\_getfontpath().
Referenced by __construct().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getFontSpacing | ( | ) |
Get the amount to increase or decrease the space between characters in a text.
| TCPDF::getFontStretching | ( | ) |
Get the percentage of character stretching.
| TCPDF::getFontStyle | ( | ) |
Returns the current font style.
Definition at line 15678 of file tcpdf.php.
References $FontStyle.
| TCPDF::getFontSubsetting | ( | ) |
Return the default option for font subsetting.
| TCPDF::getFooterFont | ( | ) |
Get Footer font.
Definition at line 10354 of file tcpdf.php.
References $footer_font.
| TCPDF::getFooterMargin | ( | ) |
Returns footer margin in user units.
Definition at line 3352 of file tcpdf.php.
References $footer_margin.
| TCPDF::getFormDefaultProp | ( | ) |
Return the default properties for form fields.
Definition at line 12639 of file tcpdf.php.
References $default_form_prop.
Referenced by Button(), RadioButton(), and TextField().
Here is the caller graph for this function:
|
protected |
Get the GD-corrected PNG gamma value from alpha color.
| $c | (int) alpha color |
Definition at line 7300 of file tcpdf.php.
References $alpha.
Referenced by ImagePngAlpha().
Here is the caller graph for this function:
|
protected |
Returns current graphic variables as array.
Definition at line 20318 of file tcpdf.php.
Referenced by __construct(), Close(), setFooter(), startPage(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the caller graph for this function:| TCPDF::getGroupPageNo | ( | ) |
Return the current page in the group.
Definition at line 13623 of file tcpdf.php.
References $currpagegroup.
Referenced by getGroupPageNoFormatted().
Here is the caller graph for this function:| TCPDF::getGroupPageNoFormatted | ( | ) |
Returns the current group page number formatted as a string.
Definition at line 13633 of file tcpdf.php.
References TCPDF_STATIC\formatPageNumber(), and getGroupPageNo().
Here is the call graph for this function:| TCPDF::getHeaderData | ( | ) |
Returns header data:
Definition at line 3305 of file tcpdf.php.
References $header_line_color, $header_logo, $header_logo_width, $header_string, $header_text_color, $header_title, and $ret.
Referenced by Header().
Here is the caller graph for this function:| TCPDF::getHeaderFont | ( | ) |
Get header font.
Definition at line 10334 of file tcpdf.php.
References $header_font.
Referenced by Header().
Here is the caller graph for this function:| TCPDF::getHeaderMargin | ( | ) |
Returns header margin in user units.
Definition at line 3332 of file tcpdf.php.
References $header_margin.
|
protected |
Returns the HTML DOM array.
| $html | (string) html code |
Definition at line 16111 of file tcpdf.php.
References $cell_height_ratio, $cell_margin, $cell_padding, $default_monospaced_font, $fgcolor, $font_spacing, $font_stretching, $FontFamily, $FontSizePt, $FontStyle, $htmlLinkColorArray, $htmlLinkFontStyle, $strokecolor, $textstrokewidth, $thead, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\extractCSSproperties(), getCSSBorderDashStyle(), getCSSBorderMargin(), getCSSBorderStyle(), getCSSBorderWidth(), TCPDF_STATIC\getCSSdataArray(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getFontFamilyName(), getHTMLFontUnits(), getHTMLUnitToUnits(), TCPDF_STATIC\getTagStyleFromCSSarray(), stringTrim(), and unhtmlentities().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getHTMLFontUnits | ( | $val, | |
$refsize = 12, |
|||
$parent_size = 12, |
|||
$defaultunit = 'pt' |
|||
| ) |
Convert HTML string containing font size value to points.
| $val | (string) String containing font size value and unit. |
| $refsize | (float) Reference font size in points. |
| $parent_size | (float) Parent font size in points. |
| $defaultunit | (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt). |
Definition at line 16057 of file tcpdf.php.
References $size, TCPDF_FONTS\getFontRefSize(), and getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 20032 of file tcpdf.php.
Referenced by getCSSBorderMargin(), getCSSBorderWidth(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getHtmlDomArray(), getHTMLFontUnits(), Image(), openHTMLTagHandler(), and writeHTML().
Here is the caller graph for this function:
|
protected |
Get image buffer content.
| $image | (string) image key |
Definition at line 20626 of file tcpdf.php.
Referenced by _putannotsobjs(), _putimages(), and Image().
Here is the caller graph for this function:| TCPDF::getImageRBX | ( | ) |
| TCPDF::getImageRBY | ( | ) |
| TCPDF::getImageScale | ( | ) |
|
protected |
Return an array containing variations for the basic page number alias.
| $a | (string) Base alias. |
Definition at line 7784 of file tcpdf.php.
References TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev(), and TCPDF_FONTS\UTF8ToLatin1().
Referenced by getAllInternalPageNumberAliases().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getLastH | ( | ) |
| TCPDF::GetLineWidth | ( | ) |
Returns the current the line width.
Definition at line 11322 of file tcpdf.php.
References $LineWidth.
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::getMargins | ( | ) |
Returns an array containing current margins:
Definition at line 15607 of file tcpdf.php.
References $ret.
| TCPDF::getNumberOfColumns | ( | ) |
Return the current number of columns.
| TCPDF::GetNumChars | ( | $s | ) |
Returns the numbero of characters in a string.
| $s | (string) The input string. |
Definition at line 4137 of file tcpdf.php.
References isUnicodeFont(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by _putpages(), getAliasRightShift(), and getCellCode().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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:
|
Definition at line 6134 of file tcpdf.php.
References $cell_padding, $lasth, $lMargin, $txt, $w, $x, adjustCellPadding(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), resetLastH(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by getStringHeight().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getNumPages | ( | ) |
Get the total number of insered pages.
Definition at line 3085 of file tcpdf.php.
References $numpages.
Referenced by lastPage().
Here is the caller graph for this function:| TCPDF::getOriginalMargins | ( | ) |
| TCPDF::getOverprint | ( | ) |
Get the overprint mode array (OP, op, OPM).
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definition at line 13848 of file tcpdf.php.
References $overprint.
| TCPDF::getPage | ( | ) |
Get current document page number.
Definition at line 3074 of file tcpdf.php.
References $page.
|
protected |
Get page buffer content.
| $page | (int) page number |
Definition at line 20564 of file tcpdf.php.
Referenced by _out(), _putpages(), MultiCell(), and writeHTML().
Here is the caller graph for this function:| TCPDF::getPageDimensions | ( | $pagenum = '' | ) |
Returns an array of page dimensions:
| $pagenum | (int) page number (empty = current page) |
Definition at line 2503 of file tcpdf.php.
References $page.
| TCPDF::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.
Definition at line 13595 of file tcpdf.php.
References TCPDF_STATIC\$alias_group_tot_pages, and isUnicodeFont().
Referenced by Footer().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getPageHeight | ( | $pagenum = '' | ) |
Returns the page height in units.
| $pagenum | (int) page number (empty = current page) |
Definition at line 2535 of file tcpdf.php.
References $h.
| TCPDF::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).
Definition at line 13610 of file tcpdf.php.
References TCPDF_STATIC\$alias_group_num_page, and isUnicodeFont().
Here is the call graph for this function:| TCPDF::getPageRegions | ( | ) |
Return an array of no-write page regions.
| TCPDF::getPageWidth | ( | $pagenum = '' | ) |
Returns the page width in units.
| $pagenum | (int) page number (empty = current page) |
Definition at line 2519 of file tcpdf.php.
References $w.
| TCPDF::getPDFData | ( | ) |
| TCPDF::getRawCharWidth | ( | $char | ) |
Returns the length of the char in user unit for the current font.
| $char | (int) The char code whose length is to be returned |
Definition at line 4111 of file tcpdf.php.
References $w, and getAbsFontMeasure().
Referenced by GetCharWidth().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Returns the remaining width between the current position and margins.
Definition at line 6699 of file tcpdf.php.
References checkPageRegions().
Referenced by Write().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getRTL | ( | ) |
| TCPDF::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). |
| $name | (string) Name of the signature. |
Definition at line 13493 of file tcpdf.php.
References $d, $h, $k, $page, $w, $x, and $y.
Referenced by addEmptySignatureAppearance(), and setSignatureAppearance().
Here is the caller graph for this function:
|
protected |
Returns the string used to find spaces.
Definition at line 16854 of file tcpdf.php.
References isUnicodeFont().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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:
|
Definition at line 6240 of file tcpdf.php.
References $cell_height_ratio, $cell_padding, $lasth, $txt, $w, adjustCellPadding(), and getNumLines().
Referenced by MultiCell().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 4034 of file tcpdf.php.
References GetArrStringWidth(), TCPDF_FONTS\utf8Bidi(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by _dolinethrough(), _dooverline(), _dounderline(), getAliasRightShift(), getCellCode(), openHTMLTagHandler(), Write(), write1DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::getTextShadow | ( | ) |
Return the text shadow parameters array.
| TCPDF::GetX | ( | ) |
Returns the relative X value of current position.
The value is relative to the left border for LTR languages and to the right border for RTL languages.
Definition at line 7362 of file tcpdf.php.
References $x.
Referenced by Bookmark(), MultiCell(), openHTMLTagHandler(), and setDestination().
Here is the caller graph for this function:| TCPDF::GetY | ( | ) |
Returns the ordinate of the current position.
Definition at line 7389 of file tcpdf.php.
References $y.
Referenced by Bookmark(), MultiCell(), openHTMLTagHandler(), and setDestination().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 14340 of file tcpdf.php.
References $n, $xobjid, and _out().
Referenced by LinearGradient(), and RadialGradient().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::Header | ( | ) |
This method is used to render the page header.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
Definition at line 3413 of file tcpdf.php.
References $header_margin, $original_lMargin, $original_rMargin, $x, $y, Cell(), endTemplate(), getHeaderData(), getHeaderFont(), TCPDF_IMAGES\getImageFileType(), getImageRBY(), getRTL(), Image(), ImageEps(), ImageSVG(), MultiCell(), printTemplate(), SetFont(), SetLineStyle(), SetTextColorArray(), SetX(), SetY(), and startTemplate().
Referenced by setHeader().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 21879 of file tcpdf.php.
References TCPDF_FONT_DATA\$uni_type, TCPDF_STATIC\empty_string(), TCPDF_STATIC\getHyphenPatternsFromTEX(), TCPDF_FONTS\UTF8ArrSubString(), and TCPDF_FONTS\UTF8StringToArray().
Here is the call graph for this function:
|
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. |
Definition at line 21803 of file tcpdf.php.
References TCPDF_FONTS\unichr(), TCPDF_FONTS\UTF8ArrSubString(), and TCPDF_FONTS\UTF8StringToArray().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 6808 of file tcpdf.php.
References $dpi, $file, $h, $img, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $xobjid, $y, _out(), TCPDF_IMAGES\_parsejpeg(), TCPDF_IMAGES\_toJPEG(), TCPDF_IMAGES\_toPNG(), Cell(), checkPageRegions(), Error(), fitBlock(), TCPDF_STATIC\get_mqr(), getHTMLUnitToUnits(), getImageBuffer(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getObjFilename(), ImagePngAlpha(), Link(), pixelsToUnits(), TCPDF_STATIC\set_mqr(), TCPDF_IMAGES\setGDImageTransparency(), setImageBuffer(), and SetY().
Referenced by Annotation(), Header(), ImageEps(), ImagePngAlpha(), and openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 14702 of file tcpdf.php.
References $cmd, $file, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $y, _out(), AddSpotColor(), Cell(), checkPageRegions(), Error(), fitBlock(), Image(), Link(), and SetY().
Referenced by Header(), and openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:
|
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. |
Definition at line 7228 of file tcpdf.php.
References $alpha, $dpi, $file, $h, $img, $w, $x, $y, Error(), getGDgamma(), Image(), and TCPDF_STATIC\objclone().
Referenced by Image().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 22499 of file tcpdf.php.
References $file.
Referenced by Header(), and openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::IncludeJS | ( | $script | ) |
|
protected |
Check if we are on the page body (excluding page header and footer).
Definition at line 3633 of file tcpdf.php.
Referenced by checkPageBreak(), MultiCell(), Write(), and writeHTML().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 4647 of file tcpdf.php.
References $FontFamily, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by getCellCode(), and replaceChar().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::isRTLTextDir | ( | ) |
Return the current temporary RTL status.
Definition at line 2438 of file tcpdf.php.
Referenced by Write(), and writeHTML().
Here is the caller graph for this function:| TCPDF::isUnicodeFont | ( | ) |
Return true if the current font is unicode type.
Definition at line 22003 of file tcpdf.php.
Referenced by getAliasNbPages(), getAliasNumPage(), getAliasRightShift(), GetArrStringWidth(), getCellCode(), GetNumChars(), getPageGroupAlias(), getPageNumGroupAlias(), getSpaceString(), Write(), and writeHTML().
Here is the caller graph for this function:| TCPDF::lastPage | ( | $resetmargins = false | ) |
Reset pointer to the last document page.
| $resetmargins | (boolean) if true reset left, right, top margins and Y position. |
Definition at line 3063 of file tcpdf.php.
References getNumPages(), and setPage().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 11508 of file tcpdf.php.
References _out(), _outLine(), _outPoint(), and SetLineStyle().
Referenced by Arrow(), cropMark(), openHTMLTagHandler(), and Rect().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 14180 of file tcpdf.php.
References $h, $w, $x, $y, Clip(), and Gradient().
Referenced by colorRegistrationBar().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 4761 of file tcpdf.php.
References $h, $w, $x, $y, and Annotation().
Referenced by getCellCode(), Image(), and ImageEps().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 12881 of file tcpdf.php.
References $h, $w, $x, $y, _addfield(), checkPageRegions(), and n.
Here is the call graph for this function:| TCPDF::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 |
Definition at line 7327 of file tcpdf.php.
Referenced by Footer(), setRTL(), and writeHTML().
Here is the caller graph for this function:| TCPDF::MirrorH | ( | $x = '' | ) |
Horizontal Mirroring.
| $x | (int) abscissa of the point. Default is current x position |
Definition at line 11093 of file tcpdf.php.
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11129 of file tcpdf.php.
References $x, $y, Rotate(), and Scale().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11116 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:| TCPDF::MirrorV | ( | $y = '' | ) |
Verical Mirroring.
| $y | (int) ordinate of the point. Default is current y position |
Definition at line 11104 of file tcpdf.php.
Here is the call graph for this function:| TCPDF::movePage | ( | $frompage, | |
| $topage | |||
| ) |
Move a page to a previous position.
| $frompage | (int) number of the source page |
| $topage | (int) number of the destination page (must be less than $frompage) |
Definition at line 20705 of file tcpdf.php.
| TCPDF::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). |
Definition at line 5786 of file tcpdf.php.
References $bMargin, $cell_margin, $cell_padding, $check_page_regions, $current_column, $FontSizePt, $h, $lMargin, $num_columns, $page, $rMargin, $tMargin, $txt, $w, $x, $xobjid, $y, adjustCellPadding(), checkPageBreak(), checkPageRegions(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\getBorderMode(), getCellCode(), getPageBuffer(), getStringHeight(), GetX(), GetY(), inPageBody(), resetLastH(), selectColumn(), setCellMargins(), setContentMark(), SetFontSize(), setPage(), setPageBuffer(), SetX(), SetY(), Write(), and writeHTML().
Referenced by Header(), TextField(), writeHTML(), and writeHTMLCell().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::Open | ( | ) |
This method begins the generation of the PDF document.
It is not necessary to call it explicitly because AddPage() does it automatically. Note: no page is created by this method
Definition at line 2960 of file tcpdf.php.
Referenced by startPage().
Here is the caller graph for this function:
|
protected |
Process opening 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). |
Definition at line 18453 of file tcpdf.php.
References $cell_height_ratio, $cell_padding, $form_action, $h, $k, $listindent, $listindentlevel, $listnum, $lisymbol, $lMargin, $n, $page, $rMargin, $w, $x, $y, addHTMLVertSpace(), AddLink(), Button(), CheckBox(), checkPageBreak(), TCPDF_STATIC\empty_string(), Error(), getHTMLUnitToUnits(), TCPDF_IMAGES\getImageFileType(), GetLineWidth(), GetStringWidth(), GetX(), GetY(), Image(), ImageEps(), ImageSVG(), Line(), RadioButton(), SetCellPadding(), SetLineWidth(), SetLink(), setTempRTL(), SetXY(), TextField(), and v().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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:
|
Definition at line 7518 of file tcpdf.php.
References TCPDF_STATIC\$byterange_string, Close(), Error(), getBuffer(), TCPDF_STATIC\getObjFilename(), and TCPDF_STATIC\sendOutputData().
Here is the call graph for this function:| TCPDF::PageNo | ( | ) |
Returns the current page number.
Definition at line 3701 of file tcpdf.php.
References $page.
Referenced by Bookmark(), PageNoFormatted(), and setDestination().
Here is the caller graph for this function:| TCPDF::PageNoFormatted | ( | ) |
Returns the current page number formatted as a string.
Definition at line 13643 of file tcpdf.php.
References TCPDF_STATIC\formatPageNumber(), and PageNo().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 14637 of file tcpdf.php.
References PieSectorXY().
Referenced by registrationMark().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 14658 of file tcpdf.php.
References $d, _out(), _outellipticalarc(), and TCPDF_STATIC\getPathPaintOperator().
Referenced by PieSector().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::pixelsToUnits | ( | $px | ) |
Converts pixels to User's Units.
| $px | (int) pixels |
Definition at line 10441 of file tcpdf.php.
Referenced by Image().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 11639 of file tcpdf.php.
References _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11885 of file tcpdf.php.
References _out(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Referenced by Arrow(), PolyLine(), RegularPolygon(), and StarPolygon().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 11866 of file tcpdf.php.
References Polygon().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 22152 of file tcpdf.php.
References TCPDF_STATIC\getTransformationMatrixProduct().
Referenced by Header().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Output an HTML list bullet or ordered item symbol.
| $listdepth | (int) list nesting level |
| $listtype | (string) type of list |
| $size | (float) current font size |
Definition at line 20116 of file tcpdf.php.
References $img, $size, TCPDF_STATIC\empty_string(), TCPDF_STATIC\intToRoman(), and TCPDF_FONTS\unichr().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 14198 of file tcpdf.php.
References $h, $w, $x, $y, Clip(), and Gradient().
Here is the call graph for this function:| TCPDF::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 of 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). |
Definition at line 12778 of file tcpdf.php.
References $k, $n, $page, $w, $x, $y, _addfield(), AddFont(), Annotation(), checkPageRegions(), TCPDF_STATIC\empty_string(), getAbsFontMeasure(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFontBuffer(), getFormDefaultProp(), and n.
Referenced by openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
| TCPDF::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). |
Definition at line 11538 of file tcpdf.php.
References $h, $w, $x, $y, _outRect(), TCPDF_STATIC\getPathPaintOperator(), Line(), SetFillColorArray(), and SetLineStyle().
Referenced by colorRegistrationBar(), RoundedRectXY(), write1DBarcode(), and write2DBarcode().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 14149 of file tcpdf.php.
References $x, $y, Circle(), PieSector(), and SetFillColorArray().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 11986 of file tcpdf.php.
References Circle(), and Polygon().
Here is the call graph for this function:| TCPDF::removePageRegion | ( | $key | ) |
Remove a single no-write region.
| $key | (int) region key |
Definition at line 22378 of file tcpdf.php.
|
protected |
Replace the buffer content.
| $data | (string) data |
Definition at line 20503 of file tcpdf.php.
References TCPDF_STATIC\empty_string(), and TCPDF_STATIC\getObjFilename().
Here is the call graph for this function:
|
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. |
Definition at line 5560 of file tcpdf.php.
References isCharDefined().
Referenced by getCellCode().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 4674 of file tcpdf.php.
References $FontFamily, $k, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\UTF8ArrayToUniArray(), and TCPDF_FONTS\UTF8StringToArray().
Here is the call graph for this function:
|
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. |
Definition at line 7823 of file tcpdf.php.
References $page, and TCPDF_FONTS\UTF8ToUTF16BE().
Referenced by _putpages().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::resetColumns | ( | ) |
Remove columns and reset page margins.
Definition at line 21560 of file tcpdf.php.
| TCPDF::resetHeaderTemplate | ( | ) |
| TCPDF::resetLastH | ( | ) |
Reset the last cell height.
Definition at line 2458 of file tcpdf.php.
References $cell_height_ratio.
Referenced by getNumLines(), MultiCell(), and writeHTML().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 21496 of file tcpdf.php.
References $file.
Referenced by writeHTML().
Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11186 of file tcpdf.php.
References $k, $x, $y, and Transform().
Referenced by MirrorL().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 12076 of file tcpdf.php.
References $h, $w, $x, $y, and RoundedRectXY().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 12095 of file tcpdf.php.
References $h, $w, $x, $y, _out(), _outCurve(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), Rect(), SetFillColorArray(), and SetLineStyle().
Referenced by RoundedRect().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11060 of file tcpdf.php.
References $k, $x, $y, Error(), and Transform().
Referenced by MirrorH(), MirrorL(), MirrorP(), MirrorV(), ScaleX(), ScaleXY(), and ScaleY().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11020 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11046 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11033 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:
|
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. |
Definition at line 24086 of file tcpdf.php.
| TCPDF::selectColumn | ( | $col = '' | ) |
Set position at a given column.
| $col | (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column. |
Definition at line 21587 of file tcpdf.php.
References TCPDF_STATIC\empty_string().
Referenced by AcceptPageBreak(), MultiCell(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::serializeTCPDFtagParameters | ( | $pararray | ) |
Serialize an array of parameters to be used with TCPDF tag in HTML code.
| $pararray | (array) parameters array |
| TCPDF::SetAbsX | ( | $x | ) |
Set the absolute X coordinate of the current pointer.
| $x | (float) The value of the abscissa in user units. |
Definition at line 7480 of file tcpdf.php.
References $x.
Referenced by SetAbsXY().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 7503 of file tcpdf.php.
References $x, $y, SetAbsX(), and SetAbsY().
Here is the call graph for this function:| TCPDF::SetAbsY | ( | $y | ) |
Set the absolute Y coordinate of the current pointer.
| $y | (float) (float) The value of the ordinate in user units. |
Definition at line 7491 of file tcpdf.php.
References $y.
Referenced by SetAbsXY().
Here is the caller graph for this function:| TCPDF::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) |
Definition at line 13861 of file tcpdf.php.
References addExtGState(), TCPDF_STATIC\empty_string(), and setExtGState().
Referenced by Cell().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::SetAuthor | ( | $author | ) |
Defines the author of the document.
| $author | (string) The name of the author. |
Definition at line 2907 of file tcpdf.php.
References $author.
| TCPDF::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. |
Definition at line 2808 of file tcpdf.php.
Referenced by __construct(), Close(), setPage(), and setPageOrientation().
Here is the caller graph for this function:| TCPDF::setBarcode | ( | $bc = '' | ) |
| TCPDF::SetBooklet | ( | $booklet = true, |
|
$inner = -1, |
|||
$outer = -1 |
|||
| ) |
Set the booklet mode for double-sided pages.
| $booklet | (boolean) true set the booklet mode on, false otherwise. |
| $inner | (float) Inner page margin. |
| $outer | (float) Outer page margin. |
Definition at line 19946 of file tcpdf.php.
| TCPDF::setBookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0), |
|||
$x = -1, |
|||
$link = '' |
|||
| ) |
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). |
| $x | (float) X position in user units of the bookmark on the selected page (default = -1 = current position;). |
| $link | (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name). |
Definition at line 12303 of file tcpdf.php.
References $page, $txt, $x, $y, and Bookmark().
Here is the call graph for this function:
|
protected |
Set buffer content (always append data).
| $data | (string) data |
Definition at line 20485 of file tcpdf.php.
References TCPDF_STATIC\empty_string(), and TCPDF_STATIC\getObjFilename().
Referenced by _out().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setCellHeightRatio | ( | $h | ) |
| TCPDF::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 |
Definition at line 2700 of file tcpdf.php.
Referenced by __construct(), and MultiCell().
Here is the caller graph for this function:| TCPDF::SetCellPadding | ( | $pad | ) |
Set the same internal Cell padding for top, right, bottom, left-.
| $pad | (float) internal padding. |
Definition at line 2645 of file tcpdf.php.
Referenced by openHTMLTagHandler(), setFooter(), setHeader(), Write(), and write1DBarcode().
Here is the caller graph for this function:| TCPDF::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 |
Definition at line 2664 of file tcpdf.php.
Referenced by __construct().
Here is the caller graph for this function:| TCPDF::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) |
Definition at line 3894 of file tcpdf.php.
References $ret, $TextColor, _out(), AddSpotColor(), and setSpotColor().
Referenced by setColorArray(), SetDrawColor(), SetFillColor(), and SetTextColor().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 3819 of file tcpdf.php.
References $k, $ret, $y, and setColor().
Referenced by SetDrawColorArray(), SetFillColorArray(), and SetTextColorArray().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setColumnsArray | ( | $columns | ) |
Set columns array.
Each column is represented by an array of arrays with the following keys: (w = width, s = space between columns, y = column top position).
| $columns | (array) |
Definition at line 21573 of file tcpdf.php.
References $columns.
| TCPDF::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. |
Definition at line 2849 of file tcpdf.php.
References $compress.
Referenced by __construct().
Here is the caller graph for this function:
|
protected |
Set start-writing mark on selected page.
Borders and fills are always created after content and inserted on the position marked by this method.
| $page | (int) page number (default is the current page) |
Definition at line 3257 of file tcpdf.php.
References $page.
Referenced by MultiCell(), and setPageMark().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 2929 of file tcpdf.php.
References $creator.
| TCPDF::SetDefaultMonospacedFont | ( | $font | ) |
| TCPDF::setDefaultTableColumns | ( | $cols = 4 | ) |
| TCPDF::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;). |
Definition at line 12230 of file tcpdf.php.
References $h, $page, $w, $x, $y, TCPDF_STATIC\empty_string(), TCPDF_STATIC\encodeNameObject(), GetX(), GetY(), and PageNo().
Here is the call graph for this function:| TCPDF::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:
|
Definition at line 2832 of file tcpdf.php.
References Error(), TCPDF_STATIC\getPageLayoutMode(), and TCPDF_STATIC\getPageMode().
Referenced by __construct().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setDocCreationTimestamp | ( | $time | ) |
Set the document creation timestamp.
| $time | (mixed) Document creation timestamp in seconds or date-time string. |
Definition at line 10162 of file tcpdf.php.
References TCPDF_STATIC\getTimestamp().
Here is the call graph for this function:| TCPDF::SetDocInfoUnicode | ( | $unicode = true | ) |
Turn on/off Unicode mode for document information dictionary (meta tags).
This has effect only when unicode mode is set to false.
| $unicode | (boolean) if true set the meta information in Unicode |
Definition at line 2874 of file tcpdf.php.
| TCPDF::setDocModificationTimestamp | ( | $time | ) |
Set the document modification timestamp.
| $time | (mixed) Document modification timestamp in seconds or date-time string. |
Definition at line 10175 of file tcpdf.php.
References TCPDF_STATIC\getTimestamp().
Here is the call graph for this function:| TCPDF::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) |
Definition at line 3984 of file tcpdf.php.
References $ret, and setColor().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 3850 of file tcpdf.php.
References $ret, and setColorArray().
Referenced by Cell(), SetLineStyle(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3780 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:| TCPDF::setEqualColumns | ( | $numcols = 0, |
|
$width = 0, |
|||
$y = '' |
|||
| ) |
Set multiple columns of the same size.
| $numcols | (int) number of columns (set to zero to disable columns mode) |
| $width | (int) column width |
| $y | (int) column starting Y position (leave empty for current Y position) |
Definition at line 21528 of file tcpdf.php.
References $space, and TCPDF_STATIC\empty_string().
Referenced by Close().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Add an extgstate.
| $gs | (array) extgstate |
Definition at line 13780 of file tcpdf.php.
References _out().
Referenced by setAlpha(), and setOverprint().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 9477 of file tcpdf.php.
| TCPDF::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). |
Definition at line 4001 of file tcpdf.php.
References $ret, and setColor().
Referenced by Button().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 3864 of file tcpdf.php.
References $ret, and setColorArray().
Referenced by Cell(), colorRegistrationBar(), Curve(), Ellipse(), Polycurve(), Polygon(), Rect(), registrationMark(), RoundedRectXY(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3792 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 4472 of file tcpdf.php.
References $FontSizePt, $out, $size, AddFont(), getFontBuffer(), SetFontSize(), and setFontSubBuffer().
Referenced by __construct(), addHtmlLink(), Close(), GetArrStringWidth(), Header(), setFooter(), setHeader(), write1DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Set font buffer content.
| $font | (string) font key |
| $data | (array) font data |
Definition at line 20642 of file tcpdf.php.
References $n, TCPDF_STATIC\getObjFilename(), and n.
Referenced by AddFont().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::SetFontSize | ( | $size, | |
$out = true |
|||
| ) |
Defines the size of the current font.
| $size | (float) The font size in points. |
| $out | (boolean) if true output the font size command, otherwise only set the font properties. |
Definition at line 4500 of file tcpdf.php.
References $k, $out, $size, and _out().
Referenced by MultiCell(), and SetFont().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setFontSpacing | ( | $spacing = 0 | ) |
Set the amount to increase or decrease the space between characters in a text.
| $spacing | (float) amount to increase or decrease the space between characters in a text (0 = default spacing) |
Definition at line 22301 of file tcpdf.php.
Referenced by writeHTML().
Here is the caller graph for this function:| TCPDF::setFontStretching | ( | $perc = 100 | ) |
Set the percentage of character stretching.
| $perc | (int) percentage of stretching (100 = no stretching) |
Definition at line 22279 of file tcpdf.php.
Referenced by writeHTML().
Here is the caller graph for this function:
|
protected |
Set font buffer content.
| $font | (string) font key |
| $key | (string) font sub-key |
| $data | (array) font data |
Definition at line 20668 of file tcpdf.php.
Referenced by _enddoc(), AddFont(), getCellCode(), and SetFont().
Here is the caller graph for this function:| TCPDF::setFontSubsetting | ( | $enable = true | ) |
Enable or disable default option for font subsetting.
| $enable | (boolean) if true enable font subsetting by default. |
Definition at line 21936 of file tcpdf.php.
|
protected |
This method is used to render the page footer.
Definition at line 3577 of file tcpdf.php.
References $footer_margin, $lasth, $original_lMargin, $original_rMargin, $page, $thead, $theadMargins, _out(), Footer(), getGraphicVars(), SetCellPadding(), SetFont(), setGraphicVars(), and SetXY().
Referenced by endPage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setFooterData | ( | $tc = array(0,0,0), |
|
$lc = array(0,0,0) |
|||
| ) |
| TCPDF::setFooterFont | ( | $font | ) |
| TCPDF::setFooterMargin | ( | $fm = 10 | ) |
| TCPDF::setFormDefaultProp | ( | $prop = array() | ) |
|
protected |
Set graphic variables.
| $gvars | (array) array of graphic variablesto restore |
| $extended | (boolean) if true restore extended graphic variables |
Definition at line 20379 of file tcpdf.php.
References TCPDF_STATIC\empty_string().
Referenced by Close(), setFooter(), setHeader(), startPage(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
This method is used to render the page header.
Definition at line 3537 of file tcpdf.php.
References $lasth, $original_lMargin, $original_rMargin, $thead, $theadMargins, _out(), Header(), SetCellPadding(), SetFont(), setGraphicVars(), and SetXY().
Referenced by startPage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 3278 of file tcpdf.php.
| TCPDF::setHeaderFont | ( | $font | ) |
| TCPDF::setHeaderMargin | ( | $hm = 10 | ) |
| TCPDF::setHeaderTemplateAutoreset | ( | $val = true | ) |
| TCPDF::setHtmlLinksStyle | ( | $color = array(0,0,255), |
|
$fontstyle = 'U' |
|||
| ) |
| TCPDF::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. |
Definition at line 19986 of file tcpdf.php.
|
protected |
Set image buffer content.
| $image | (string) image key |
| $data | (array) image data |
Definition at line 20581 of file tcpdf.php.
References TCPDF_STATIC\getObjFilename().
Referenced by Image().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setImageScale | ( | $scale | ) |
|
protected |
Set image buffer content for a specified sub-key.
| $image | (string) image key |
| $key | (string) image sub-key |
| $data | (array) image data |
Definition at line 20606 of file tcpdf.php.
Referenced by _putimages().
Here is the caller graph for this function:| TCPDF::setJPEGQuality | ( | $quality | ) |
| TCPDF::SetKeywords | ( | $keywords | ) |
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
| $keywords | (string) The list of keywords. |
Definition at line 2918 of file tcpdf.php.
References $keywords.
| TCPDF::setLanguageArray | ( | $language | ) |
| TCPDF::setLastH | ( | $h | ) |
| TCPDF::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. |
Definition at line 2601 of file tcpdf.php.
| TCPDF::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. |
Definition at line 11349 of file tcpdf.php.
References $ret, $tab, _out(), and SetDrawColorArray().
Referenced by cropMark(), Curve(), Ellipse(), Footer(), getCellBorder(), Header(), Line(), Polycurve(), Polygon(), Rect(), and RoundedRectXY().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::SetLineWidth | ( | $width | ) |
Defines the line width.
By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
| $width | (float) The width. |
Definition at line 11306 of file tcpdf.php.
References _out().
Referenced by openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 4738 of file tcpdf.php.
Referenced by addHtmlLink(), and openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::setListIndentWidth | ( | $width | ) |
| TCPDF::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') |
Definition at line 19902 of file tcpdf.php.
| TCPDF::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 |
Definition at line 2579 of file tcpdf.php.
References $lMargin, and $rMargin.
Referenced by __construct().
Here is the caller graph for this function:| TCPDF::setOpenCell | ( | $isopen | ) |
| TCPDF::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). |
Definition at line 13822 of file tcpdf.php.
References addExtGState(), TCPDF_STATIC\empty_string(), and setExtGState().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 3016 of file tcpdf.php.
References $page, Error(), SetAutoPageBreak(), and SetY().
Referenced by lastPage(), MultiCell(), startPage(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Set page boxes to be included on page descriptions.
| $boxes | (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox'). |
Definition at line 7858 of file tcpdf.php.
References TCPDF_STATIC\$pageboxes.
|
protected |
Set page buffer content.
| $page | (int) page number |
| $data | (string) page data |
| $append | (boolean) if true append data, false replace. |
Definition at line 20537 of file tcpdf.php.
References TCPDF_STATIC\getObjFilename().
Referenced by _beginpage(), _out(), MultiCell(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:
|
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):
|
Definition at line 2136 of file tcpdf.php.
References $page, TCPDF_STATIC\getPageSizeFromFormat(), TCPDF_STATIC\setPageBoxes(), and setPageOrientation().
Referenced by __construct(), and _beginpage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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.
Definition at line 3244 of file tcpdf.php.
References $page, and setContentMark().
Referenced by startPage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 2250 of file tcpdf.php.
References $AutoPageBreak, $bMargin, $CurOrientation, $fhPt, $fwPt, $h, $hPt, $k, $lMargin, $original_lMargin, $original_rMargin, $page, $rMargin, $tMargin, $w, $wPt, TCPDF_STATIC\empty_string(), SetAutoPageBreak(), TCPDF_STATIC\setPageBoxes(), and TCPDF_STATIC\swapPageBoxCoordinates().
Referenced by _beginpage(), setPageFormat(), and setPageUnit().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 22339 of file tcpdf.php.
| TCPDF::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. |
Definition at line 2044 of file tcpdf.php.
References $dpi, Error(), and setPageOrientation().
Referenced by __construct().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setPDFVersion | ( | $version = '1.7' | ) |
Set the PDF version (check PDF reference for valid values).
| $version | (string) PDF document version. |
Definition at line 13945 of file tcpdf.php.
Referenced by __construct().
Here is the caller graph for this function:| TCPDF::setPrintFooter | ( | $val = true | ) |
| TCPDF::setPrintHeader | ( | $val = true | ) |
| TCPDF::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://../examples/data/cert/tcpdf.crt', 'p' => array('print'))) |
Definition at line 10869 of file tcpdf.php.
References _generateencryptionkey(), TCPDF_STATIC\convertHexStringToString(), Error(), TCPDF_STATIC\getRandomSeed(), and TCPDF_STATIC\getUserPermissionCode().
Here is the call graph for this function:| TCPDF::setRasterizeVectorImages | ( | $mode | ) |
| TCPDF::SetRightMargin | ( | $margin | ) |
| TCPDF::setRTL | ( | $enable, | |
$resetx = true |
|||
| ) |
Enable or disable Right-To-Left language mode.
| $enable | (Boolean) if true enable Right-To-Left language mode. |
| $resetx | (Boolean) if true reset the X position on direction change. |
Definition at line 2380 of file tcpdf.php.
References Ln().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 13423 of file tcpdf.php.
Referenced by setUserRights().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setSignatureAppearance | ( | $x = 0, |
|
$y = 0, |
|||
$w = 0, |
|||
$h = 0, |
|||
$page = -1, |
|||
$name = '' |
|||
| ) |
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). |
| $name | (string) Name of the signature. |
Definition at line 13459 of file tcpdf.php.
References $h, $page, $w, $x, $y, and getSignatureAppearanceArray().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 2355 of file tcpdf.php.
Referenced by __construct().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3734 of file tcpdf.php.
References $TextColor, $xobjid, _out(), Error(), and TCPDF_COLORS\getSpotColor().
Referenced by setColor(), SetDrawSpotColor(), SetFillSpotColor(), and SetTextSpotColor().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setSRGBmode | ( | $mode = false | ) |
| TCPDF::setStartingPageNumber | ( | $num = 1 | ) |
| TCPDF::SetSubject | ( | $subject | ) |
Defines the subject of the document.
| $subject | (string) The subject. |
Definition at line 2896 of file tcpdf.php.
References $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 |
Definition at line 22842 of file tcpdf.php.
References TCPDF_COLORS\convertHTMLColorToDec().
Here is the call graph for this function:
|
protected |
This method is used to render the table header on new page (if any).
Definition at line 3642 of file tcpdf.php.
References $cell_padding, $lMargin, $page, $rMargin, $tMargin, $y, TCPDF_STATIC\empty_string(), and writeHTML().
Referenced by startPage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setTempRTL | ( | $mode | ) |
Force temporary RTL language direction.
| $mode | (mixed) can be false, 'L' for LTR or 'R' for RTL |
Definition at line 2406 of file tcpdf.php.
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 4018 of file tcpdf.php.
References $ret, and setColor().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 3877 of file tcpdf.php.
References $ret, and setColorArray().
Referenced by addHtmlLink(), Cell(), Footer(), Header(), write1DBarcode(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::setTextRenderingMode | ( | $stroke = 0, |
|
$fill = true, |
|||
$clip = false |
|||
| ) |
Set Text rendering mode.
| $stroke | (int) outline size in user units (0 = disable). |
| $fill | (boolean) if true fills the text (default). |
| $clip | (boolean) if true activate clipping mode |
Definition at line 21688 of file tcpdf.php.
Referenced by Close(), Text(), and writeHTML().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 21743 of file tcpdf.php.
Referenced by __construct().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 3804 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:| TCPDF::SetTitle | ( | $title | ) |
Defines the title of the document.
| $title | (string) The title. |
Definition at line 2885 of file tcpdf.php.
References $title.
| TCPDF::SetTopMargin | ( | $margin | ) |
| TCPDF::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. |
Definition at line 13387 of file tcpdf.php.
References setSignature().
Here is the call graph for this function:| TCPDF::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. |
Definition at line 13963 of file tcpdf.php.
| TCPDF::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. |
Definition at line 13716 of file tcpdf.php.
References _out(), endLayer(), Error(), and startLayer().
Referenced by _endpage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 7402 of file tcpdf.php.
Referenced by Footer(), Header(), MultiCell(), and SetXY().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 7468 of file tcpdf.php.
References $x, $y, SetX(), and SetY().
Referenced by openHTMLTagHandler(), setFooter(), setHeader(), and Text().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 7435 of file tcpdf.php.
References $h, $lMargin, $rMargin, and $y.
Referenced by Footer(), Header(), Image(), ImageEps(), MultiCell(), setPage(), SetXY(), startPage(), write1DBarcode(), and write2DBarcode().
Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11243 of file tcpdf.php.
References $k, $x, $y, Error(), and Transform().
Referenced by SkewX(), and SkewY().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11216 of file tcpdf.php.
References $x, $y, and Skew().
Here is the call graph for this function:| TCPDF::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 |
Definition at line 11229 of file tcpdf.php.
References $x, $y, and Skew().
Here is the call graph for this function:
|
protected |
Sort bookmarks for page and key.
Definition at line 12361 of file tcpdf.php.
References $row.
Referenced by _putbookmarks().
Here is the caller graph for this function:| TCPDF::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). |
Definition at line 12034 of file tcpdf.php.
References Circle(), and Polygon().
Here is the call graph for this function:| TCPDF::startLayer | ( | $name = '', |
|
$print = true, |
|||
$view = true |
|||
| ) |
Start a new pdf layer.
| $name | (string) Layer name (only a-z letters and numbers). Leave empty for automatic name. |
| (boolean) Set to true to print this layer. | |
| $view | (boolean) Set to true to view this layer. |
Definition at line 13677 of file tcpdf.php.
References _out().
Referenced by setVisibility().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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. |
Definition at line 3173 of file tcpdf.php.
References $dests, $links, $numpages, $outlines, $page, $tocpage, _beginpage(), getGraphicVars(), Open(), setGraphicVars(), setHeader(), setPage(), setPageMark(), setTableHeader(), SetY(), and swapMargins().
Referenced by AddPage().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::startPageGroup | ( | $page = '' | ) |
Create a new page group.
NOTE: call this function before calling AddPage()
| $page | (int) starting group page (leave empty for next page). |
Definition at line 13520 of file tcpdf.php.
References $newpagegroup, and $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). |
Definition at line 23488 of file tcpdf.php.
References $d, $img, TCPDF_IMAGES\$svginheritprop, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getSVGTransformMatrix(), and TCPDF_STATIC\getTransformationMatrixProduct().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 22058 of file tcpdf.php.
Referenced by Button(), Header(), and TextField().
Here is the caller graph for this function:| TCPDF::startTransaction | ( | ) |
Stores a copy of the current TCPDF object used for undo operation.
Definition at line 21465 of file tcpdf.php.
References TCPDF_STATIC\objclone().
Referenced by writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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.
Definition at line 10972 of file tcpdf.php.
References $page, $transfmatrix_key, $xobjid, and _out().
Here is the call graph for this function:| TCPDF::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.
Definition at line 10995 of file tcpdf.php.
References $transfmatrix_key, and _out().
Here is the call graph for this function:| TCPDF::stringLeftTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Left trim the input string.
| $str | (string) string to trim |
| $replace | (string) string that replace spaces. |
Definition at line 21964 of file tcpdf.php.
Referenced by writeHTML().
Here is the caller graph for this function:| TCPDF::stringRightTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Right trim the input string.
| $str | (string) string to trim |
| $replace | (string) string that replace spaces. |
Definition at line 21977 of file tcpdf.php.
Referenced by Write(), and writeHTML().
Here is the caller graph for this function:| TCPDF::stringTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Trim the input string.
| $str | (string) string to trim |
| $replace | (string) string that replace spaces. |
Definition at line 21990 of file tcpdf.php.
Referenced by _putbookmarks(), getHtmlDomArray(), and Write().
Here is the caller graph for this function:
|
protected |
Draws an SVG path.
| $d | (string) attribute d of the path SVG element |
| $style | (string) Style of rendering. Possible values are:
|
Definition at line 23126 of file tcpdf.php.
References $cmd, $d, TCPDF_STATIC\getPathPaintOperator(), and TCPDF_STATIC\getVectorsAngle().
Here is the call graph for this function:
|
protected |
Apply SVG graphic transformation matrix.
| $tm | (array) original SVG transformation matrix |
|
protected |
Swap the left and right margins.
| $reverse | (boolean) if true swap left and right margins. |
Definition at line 19962 of file tcpdf.php.
Referenced by startPage().
Here is the caller graph for this function:| TCPDF::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. |
Definition at line 4922 of file tcpdf.php.
References $textrendermode, $textstrokewidth, $txt, $x, $y, Cell(), setTextRenderingMode(), and SetXY().
Here is the call graph for this function:| TCPDF::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). |
Definition at line 12657 of file tcpdf.php.
References $h, $n, $w, $x, $y, _addfield(), Annotation(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), MultiCell(), and startTemplate().
Referenced by openHTMLTagHandler().
Here is the call graph for this function: Here is the caller graph for this function:
|
protected |
Apply graphic transformations.
| $tm | (array) transformation matrix |
Definition at line 11274 of file tcpdf.php.
References $page, $transfmatrix_key, $xobjid, and _out().
Referenced by Rotate(), Scale(), Skew(), and Translate().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 |
Definition at line 11164 of file tcpdf.php.
References $k, and Transform().
Referenced by TranslateX(), and TranslateY().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::TranslateX | ( | $t_x | ) |
Translate graphic object horizontally.
| $t_x | (int) movement to the right (or left for RTL) |
Definition at line 11141 of file tcpdf.php.
References Translate().
Here is the call graph for this function:| TCPDF::TranslateY | ( | $t_y | ) |
Translate graphic object vertically.
| $t_y | (int) movement to the bottom |
Definition at line 11152 of file tcpdf.php.
References Translate().
Here is the call graph for this function:| TCPDF::unhtmlentities | ( | $text_to_convert | ) |
Reverse function for htmlentities.
Convert entities in UTF-8.
| $text_to_convert | (string) Text to convert. |
Definition at line 10452 of file tcpdf.php.
Referenced by _putannotsobjs(), _putbookmarks(), and getHtmlDomArray().
Here is the caller graph for this function:| TCPDF::unichr | ( | $c | ) |
Returns the unicode caracter specified by the value.
| $c | (int) UTF-8 value |
Definition at line 4168 of file tcpdf.php.
Referenced by _fixAES256Password(), and Write().
Here is the caller graph for this function:| TCPDF::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 |
Definition at line 6277 of file tcpdf.php.
References $cell_margin, $cell_padding, $h, $l, $lMargin, $page, $rMargin, $txt, TCPDF_FONT_DATA\$uni_RE_PATTERN_ARABIC, TCPDF_FONT_DATA\$uni_RE_PATTERN_RTL, $w, $x, AcceptPageBreak(), Cell(), checkPageRegions(), GetArrStringWidth(), GetCharWidth(), getRemainingWidth(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), SetCellPadding(), stringRightTrim(), stringTrim(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\unichr(), unichr(), TCPDF_FONTS\UTF8ArrayToUniArray(), TCPDF_FONTS\utf8Bidi(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by addHtmlLink(), MultiCell(), and writeHTML().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 tcpdf_barcodes_1d.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:
|
Definition at line 15065 of file tcpdf.php.
References $cell_padding, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $rtl, $w, $x, $y, Cell(), checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getGraphicVars(), GetStringWidth(), Rect(), SetCellPadding(), SetDrawColorArray(), SetFont(), setGraphicVars(), SetTextColorArray(), and SetY().
Referenced by Footer().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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 tcpdf_barcodes_2d.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 |
Definition at line 15381 of file tcpdf.php.
References $bMargin, $h, $img_rb_x, $img_rb_y, $lMargin, $rtl, $w, $x, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getGraphicVars(), Rect(), SetDrawColorArray(), setGraphicVars(), and SetY().
Here is the call graph for this function:
|
protected |
Writes data to a temporary file on filesystem.
| $filename | (string) file name |
| $data | (mixed) data to write on file |
| $append | (boolean) if true append data, false replace. |
Definition at line 20447 of file tcpdf.php.
References $filename.
| TCPDF::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 NOTE: all the HTML attributes must be enclosed in double-quote.
| $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:
|
Definition at line 16913 of file tcpdf.php.
References $cell_height_ratio, $cell_margin, $cell_padding, $current_column, $customlistindent, $feps, $font_spacing, $font_stretching, $FontFamily, $FontSize, $FontSizePt, $FontStyle, $k, $lasth, $lispacer, $listcount, $listnum, $listordered, $lMargin, $newline, $numpages, $page, $rMargin, $rtl, $textindent, $textstrokewidth, $thead, $w, $wPt, $x, $xobjid, $y, addHtmlLink(), checkPageBreak(), closeHTMLTagHandler(), TCPDF_STATIC\empty_string(), Error(), getFontAscent(), getFontDescent(), getGraphicVars(), getHtmlDomArray(), getHTMLUnitToUnits(), getPageBuffer(), getSpaceString(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), Ln(), MultiCell(), openHTMLTagHandler(), putHtmlListBullet(), resetLastH(), TCPDF_STATIC\revstrpos(), rollbackTransaction(), selectColumn(), SetDrawColorArray(), SetFillColorArray(), SetFont(), setFontSpacing(), setFontStretching(), setGraphicVars(), setPage(), setPageBuffer(), SetTextColorArray(), setTextRenderingMode(), startTransaction(), stringLeftTrim(), stringRightTrim(), and Write().
Referenced by MultiCell(), and setTableHeader().
Here is the call graph for this function: Here is the caller graph for this function:| TCPDF::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.<br />
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
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
NOTE: all the HTML attributes must be enclosed in double-quote.
@param $w (float) Cell width. If 0, the cell extends up to the right margin.
@param $h (float) Cell minimum height. The cell extends automatically if needed.
@param $x (float) upper-left corner X coordinate
@param $y (float) upper-left corner Y coordinate
@param $html (string) html text to print. Default value: empty string.
@param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
@param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
| $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. |
Definition at line 16896 of file tcpdf.php.
References $h, $w, $x, $y, and MultiCell().
Here is the call graph for this function:
|
protected |
Alpha mode array.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definition at line 1838 of file tcpdf.php.
Referenced by _outellipticalarc(), Cell(), getAlpha(), getGDgamma(), and ImagePngAlpha().
|
protected |
|
protected |
|
protected |
Automatic page breaking.
Definition at line 496 of file tcpdf.php.
Referenced by AcceptPageBreak(), getAutoPageBreak(), and setPageOrientation().
|
protected |
Barcode to print on page footer (only if set).
Definition at line 669 of file tcpdf.php.
Referenced by Footer(), and getBarcode().
|
protected |
|
protected |
Page break margin.
Definition at line 324 of file tcpdf.php.
Referenced by getBreakMargin(), MultiCell(), setPageOrientation(), and write2DBarcode().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Default cell height ratio.
Definition at line 974 of file tcpdf.php.
Referenced by Cell(), getCellCode(), getCellHeightRatio(), getHtmlDomArray(), getStringHeight(), openHTMLTagHandler(), resetLastH(), and writeHTML().
|
protected |
Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definition at line 338 of file tcpdf.php.
Referenced by Cell(), getCellCode(), getCellMargins(), getCSSMargin(), getHtmlDomArray(), MultiCell(), Write(), and writeHTML().
|
protected |
Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definition at line 331 of file tcpdf.php.
Referenced by adjustCellPadding(), Cell(), getCellCode(), getCellPaddings(), getCSSPadding(), getHtmlDomArray(), getNumLines(), getStringHeight(), MultiCell(), openHTMLTagHandler(), setTableHeader(), Write(), write1DBarcode(), and writeHTML().
|
protected |
Boolean value true when page region check is active.
Definition at line 1604 of file tcpdf.php.
Referenced by MultiCell().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Compression flag.
Definition at line 234 of file tcpdf.php.
Referenced by _putimages(), _putpages(), _puttruetypeunicode(), and SetCompression().
|
protected |
|
protected |
|
protected |
Current page orientation (P = Portrait, L = Landscape).
Definition at line 240 of file tcpdf.php.
Referenced by _beginpage(), and setPageOrientation().
|
protected |
Current column number.
Definition at line 1479 of file tcpdf.php.
Referenced by MultiCell(), and writeHTML().
|
protected |
Current page group number.
Definition at line 953 of file tcpdf.php.
Referenced by _beginpage(), and getGroupPageNo().
|
protected |
|
protected |
HTML PARSER: custom indent amount for lists.
Negative value means disabled.
Definition at line 1156 of file tcpdf.php.
Referenced by writeHTML().
|
protected |
Deafult Javascript field properties.
Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
Definition at line 1381 of file tcpdf.php.
Referenced by getFormDefaultProp().
|
protected |
|
protected |
Default monospace font.
Definition at line 1276 of file tcpdf.php.
Referenced by getHtmlDomArray().
|
protected |
|
protected |
A dictionary of names and corresponding destinations (Dests key on document Catalog).
Definition at line 1618 of file tcpdf.php.
Referenced by getDestination(), and startPage().
|
protected |
|
protected |
If true enables disk caching.
Definition at line 1241 of file tcpdf.php.
Referenced by __construct().
|
protected |
Document creation date-time.
Definition at line 1808 of file tcpdf.php.
Referenced by __construct(), _datestring(), and getDocCreationTimestamp().
|
protected |
Document modification date-time.
Definition at line 1815 of file tcpdf.php.
Referenced by getDocModificationTimestamp().
|
protected |
|
protected |
DPI (Dot Per Inch) Document Resolution (do not change).
Definition at line 932 of file tcpdf.php.
Referenced by Image(), ImagePngAlpha(), and setPageUnit().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Default encoding.
Definition at line 821 of file tcpdf.php.
Referenced by __construct().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Epsilon value used for float calculations.
Definition at line 1142 of file tcpdf.php.
Referenced by writeHTML().
|
protected |
Current foreground color.
Definition at line 766 of file tcpdf.php.
Referenced by addHtmlLink(), Cell(), and getHtmlDomArray().
|
protected |
Height of page format in points.
Definition at line 264 of file tcpdf.php.
Referenced by setPageOrientation().
|
protected |
|
protected |
|
protected |
Increases or decreases the space between characters in a text by the specified amount (tracking).
Definition at line 1590 of file tcpdf.php.
Referenced by getCellCode(), GetCharWidth(), getHtmlDomArray(), and writeHTML().
|
protected |
Percentage of character stretching.
Definition at line 1583 of file tcpdf.php.
Referenced by getCellCode(), getHtmlDomArray(), and writeHTML().
|
protected |
|
protected |
Current font ascent (distance between font top and baseline).
Definition at line 429 of file tcpdf.php.
Referenced by getCellCode().
|
protected |
Current font descent (distance between font bottom and baseline).
Definition at line 436 of file tcpdf.php.
Referenced by getCellCode().
|
protected |
Current font family.
Definition at line 416 of file tcpdf.php.
Referenced by AddFont(), GetArrStringWidth(), getFontFamily(), getHtmlDomArray(), isCharDefined(), replaceMissingChars(), and writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
Current font size in user unit.
Definition at line 466 of file tcpdf.php.
Referenced by getCellCode(), getFontSize(), and writeHTML().
|
protected |
Current font size in points.
Definition at line 460 of file tcpdf.php.
Referenced by _dolinethroughw(), _dooverlinew(), _dounderlinew(), GetArrStringWidth(), getFontSizePt(), getHtmlDomArray(), MultiCell(), SetFont(), and writeHTML().
|
protected |
Current font style.
Definition at line 422 of file tcpdf.php.
Referenced by addHtmlLink(), GetArrStringWidth(), getFontStyle(), getHtmlDomArray(), and writeHTML().
|
protected |
Default font used on page footer.
Definition at line 657 of file tcpdf.php.
Referenced by getFooterFont().
|
protected |
|
protected |
Minimum distance between footer and bottom page margin.
Definition at line 631 of file tcpdf.php.
Referenced by getFooterMargin(), and setFooter().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Current form action (used during XHTML rendering).
Definition at line 1395 of file tcpdf.php.
Referenced by openHTMLTagHandler().
|
protected |
|
protected |
|
protected |
|
protected |
Width of page format in points.
Definition at line 258 of file tcpdf.php.
Referenced by setPageOrientation().
|
protected |
|
protected |
|
protected |
Current height of page in user unit.
Definition at line 288 of file tcpdf.php.
Referenced by _addfield(), _outRect(), _putAPXObject(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), getCellBorder(), getCellCode(), getPageHeight(), getSignatureAppearanceArray(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), Ln(), MultiCell(), openHTMLTagHandler(), RadialGradient(), Rect(), RoundedRect(), RoundedRectXY(), setCellHeightRatio(), setDestination(), setLastH(), setPageOrientation(), setSignatureAppearance(), SetY(), TextField(), Write(), write1DBarcode(), write2DBarcode(), and writeHTMLCell().
|
protected |
Default font used on page header.
Definition at line 651 of file tcpdf.php.
Referenced by getHeaderFont().
|
protected |
Color for header line (RGB array).
Definition at line 719 of file tcpdf.php.
Referenced by getHeaderData().
|
protected |
|
protected |
Width of header image logo in user units.
Definition at line 693 of file tcpdf.php.
Referenced by getHeaderData().
|
protected |
Minimum distance between header and top page margin.
Definition at line 625 of file tcpdf.php.
Referenced by getHeaderMargin(), and Header().
|
protected |
String to pring on page header after title.
Definition at line 705 of file tcpdf.php.
Referenced by getHeaderData().
|
protected |
Color for header text (RGB array).
Definition at line 712 of file tcpdf.php.
Referenced by getHeaderData().
|
protected |
Title to be printed on default page header.
Definition at line 699 of file tcpdf.php.
Referenced by getHeaderData().
|
protected |
|
protected |
|
protected |
Current height of page in points.
Definition at line 276 of file tcpdf.php.
Referenced by setPageOrientation().
|
protected |
|
protected |
Default color for html links.
Definition at line 1192 of file tcpdf.php.
Referenced by getHtmlDomArray().
|
protected |
Default font style to add to html links.
Definition at line 1199 of file tcpdf.php.
Referenced by getHtmlDomArray().
|
protected |
|
protected |
|
protected |
The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
Definition at line 576 of file tcpdf.php.
Referenced by getImageRBX(), Image(), ImageEps(), write1DBarcode(), and write2DBarcode().
|
protected |
The right-bottom corner Y coordinate of last inserted image.
Definition at line 584 of file tcpdf.php.
Referenced by getImageRBY(), Image(), ImageEps(), write1DBarcode(), and write2DBarcode().
|
protected |
Adjusting factor to convert pixels to user units.
Definition at line 592 of file tcpdf.php.
Referenced by getImageScale().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Boolean flag set to true when the input text is unicode (require unicode fonts).
Definition at line 600 of file tcpdf.php.
Referenced by _putinfo(), and _putXMP().
|
protected |
|
protected |
|
protected |
|
protected |
Scale factor (number of points in user unit).
Definition at line 252 of file tcpdf.php.
Referenced by __construct(), _addfield(), _outellipticalarc(), _putannotsobjs(), _putcidfont0(), _putextgstates(), _putfonts(), _putpages(), _putresourcedict(), _putviewerpreferences(), _putxobjects(), AddSpotColor(), Annotation(), Button(), Close(), Footer(), getAllInternalPageNumberAliases(), getCellBorder(), getCellCode(), getCSSBorderWidth(), getScaleFactor(), getSignatureAppearanceArray(), Image(), ImageEps(), openHTMLTagHandler(), RadioButton(), replaceMissingChars(), Rotate(), Scale(), setColorArray(), SetFontSize(), setPageOrientation(), Skew(), Translate(), write1DBarcode(), and writeHTML().
|
protected |
|
protected |
Language templates.
Definition at line 663 of file tcpdf.php.
Referenced by _putannotsobjs(), _putbookmarks(), and Write().
|
protected |
|
protected |
|
protected |
Height of last cell printed.
Definition at line 356 of file tcpdf.php.
Referenced by getLastH(), getNumLines(), getStringHeight(), Ln(), setFooter(), setHeader(), and writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Line width in user unit.
Definition at line 362 of file tcpdf.php.
Referenced by adjustCellPadding(), Arrow(), getCellBorder(), and GetLineWidth().
|
protected |
|
protected |
|
protected |
HTML PARSER: array count list items on nested lists.
Definition at line 778 of file tcpdf.php.
Referenced by writeHTML().
|
protected |
HTML PARSER: indent amount for lists.
Definition at line 790 of file tcpdf.php.
Referenced by openHTMLTagHandler().
|
protected |
HTML PARSER: current list indententation level.
Definition at line 796 of file tcpdf.php.
Referenced by openHTMLTagHandler().
|
protected |
HTML PARSER: current list nesting level.
Definition at line 784 of file tcpdf.php.
Referenced by openHTMLTagHandler(), and writeHTML().
|
protected |
HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
Definition at line 772 of file tcpdf.php.
Referenced by writeHTML().
|
protected |
Symbol used for HTML unordered list items.
Definition at line 1107 of file tcpdf.php.
Referenced by openHTMLTagHandler().
|
protected |
Left margin.
Definition at line 294 of file tcpdf.php.
Referenced by __construct(), _beginpage(), AddPage(), fitBlock(), getCellCode(), getNumLines(), Image(), ImageEps(), MultiCell(), openHTMLTagHandler(), SetMargins(), setPageOrientation(), setTableHeader(), SetY(), Write(), write1DBarcode(), write2DBarcode(), and writeHTML().
|
protected |
|
protected |
Current object number.
Definition at line 198 of file tcpdf.php.
Referenced by _datastring(), _datestring(), _encrypt_data(), _enddoc(), _getannotsrefs(), _getobj(), _getrawstream(), _getstream(), _newobj(), _objectkey(), _putannotsobjs(), _putannotsrefs(), _putAPXObject(), _putbookmarks(), _putfonts(), _putpages(), _putshaders(), _putspotcolors(), _putstream(), _textstring(), addEmptySignatureAppearance(), addExtGState(), addJavascriptObject(), AddLink(), Button(), CoonsPatchMesh(), Gradient(), openHTMLTagHandler(), RadioButton(), setSignature(), and TextField().
|
protected |
|
protected |
|
protected |
Boolean flag to indicate if a new line is created.
Definition at line 1044 of file tcpdf.php.
Referenced by writeHTML().
|
protected |
Array of page numbers were a new page group was started (the page numbers are the keys of the array).
Definition at line 939 of file tcpdf.php.
Referenced by startPageGroup().
|
protected |
Number of colums.
Definition at line 1472 of file tcpdf.php.
Referenced by MultiCell().
|
protected |
|
protected |
|
protected |
Counts the number of pages.
Definition at line 1206 of file tcpdf.php.
Referenced by _putannotsobjs(), _putpages(), getNumPages(), startPage(), and writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Original left margin value.
Definition at line 638 of file tcpdf.php.
Referenced by Header(), setFooter(), setHeader(), and setPageOrientation().
|
protected |
Original right margin value.
Definition at line 645 of file tcpdf.php.
Referenced by Header(), setFooter(), setHeader(), and setPageOrientation().
|
protected |
|
protected |
Outlines for bookmark.
Definition at line 888 of file tcpdf.php.
Referenced by startPage().
|
protected |
Overprint mode array.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
Definition at line 1830 of file tcpdf.php.
Referenced by getOverprint().
|
protected |
Current page number.
Definition at line 192 of file tcpdf.php.
Referenced by _beginpage(), _getobj(), _out(), addEmptySignatureAppearance(), addHtmlLink(), Annotation(), Bookmark(), checkPageBreak(), endPage(), getPage(), getPageDimensions(), getSignatureAppearanceArray(), MultiCell(), openHTMLTagHandler(), PageNo(), RadioButton(), replaceRightShiftPageNumAliases(), setBookmark(), setContentMark(), setDestination(), setFooter(), SetLink(), setPage(), setPageFormat(), setPageMark(), setPageOrientation(), setSignatureAppearance(), setTableHeader(), startPage(), startPageGroup(), StartTransform(), Transform(), Write(), and writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Threshold used to trigger page breaks.
Definition at line 502 of file tcpdf.php.
Referenced by fitBlock().
|
protected |
|
protected |
Array containing page lengths in bytes.
Definition at line 1213 of file tcpdf.php.
Referenced by _putpages().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Right margin.
Definition at line 300 of file tcpdf.php.
Referenced by __construct(), _beginpage(), AddPage(), fitBlock(), getCellCode(), getCSSBorderMargin(), getCSSMargin(), getCSSPadding(), MultiCell(), openHTMLTagHandler(), SetMargins(), setPageOrientation(), setTableHeader(), SetY(), Write(), and writeHTML().
|
protected |
Boolean flag to indicate if the document language is Right-To-Left.
Definition at line 835 of file tcpdf.php.
Referenced by getRTL(), write1DBarcode(), write2DBarcode(), and writeHTML().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Store page number when startTransaction() is called.
|
protected |
Store Y position when startTransaction() is called.
|
protected |
|
protected |
Current stroke color.
Definition at line 1521 of file tcpdf.php.
Referenced by Cell(), and getHtmlDomArray().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Commands for text color.
Definition at line 484 of file tcpdf.php.
Referenced by setColor(), and setSpotColor().
|
protected |
Text indentation value (used for text-indent CSS attribute).
Definition at line 1437 of file tcpdf.php.
Referenced by writeHTML().
|
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.
Definition at line 1507 of file tcpdf.php.
Referenced by Text().
|
protected |
Text stroke width in doc units.
Definition at line 1514 of file tcpdf.php.
Referenced by getHtmlDomArray(), Text(), and writeHTML().
|
protected |
Table header content to be repeated on each new page.
Definition at line 1297 of file tcpdf.php.
Referenced by getHtmlDomArray(), setFooter(), setHeader(), and writeHTML().
|
protected |
Margins used for table header.
Definition at line 1304 of file tcpdf.php.
Referenced by setFooter(), and setHeader().
|
protected |
Document title.
Definition at line 538 of file tcpdf.php.
Referenced by _putbookmarks(), and SetTitle().
|
protected |
Top margin.
Definition at line 318 of file tcpdf.php.
Referenced by _beginpage(), checkPageBreak(), fitBlock(), MultiCell(), setPageOrientation(), and setTableHeader().
|
protected |
|
protected |
Boolean flag true when we are on TOC (Table Of Content) page.
Definition at line 1534 of file tcpdf.php.
Referenced by AddPage(), endPage(), and startPage().
|
protected |
|
protected |
Current key for transformation matrix.
Definition at line 1128 of file tcpdf.php.
Referenced by StartTransform(), StopTransform(), and Transform().
|
protected |
|
protected |
|
protected |
|
protected |
PDF viewer preferences.
Definition at line 981 of file tcpdf.php.
Referenced by _putviewerpreferences().
|
protected |
Current width of page in user unit.
Definition at line 282 of file tcpdf.php.
Referenced by _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outRect(), _putAPXObject(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), GetArrStringWidth(), getCellBorder(), getCellCode(), getFontBBox(), getNumLines(), getPageWidth(), getRawCharWidth(), getSignatureAppearanceArray(), getStringHeight(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), RoundedRect(), RoundedRectXY(), setDestination(), setPageOrientation(), setSignatureAppearance(), SetX(), TextField(), Write(), write1DBarcode(), write2DBarcode(), writeHTML(), and writeHTMLCell().
|
protected |
Current width of page in points.
Definition at line 270 of file tcpdf.php.
Referenced by setPageOrientation(), and writeHTML().
|
protected |
Current horizontal position in user unit for cell positioning.
Definition at line 344 of file tcpdf.php.
Referenced by _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outLine(), _outPoint(), _outRect(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), GetAbsX(), getCellBorder(), getCellCode(), getNumLines(), getSignatureAppearanceArray(), GetX(), Header(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MirrorH(), MirrorL(), MirrorP(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), registrationMark(), Rotate(), RoundedRect(), RoundedRectXY(), Scale(), ScaleX(), ScaleXY(), ScaleY(), SetAbsX(), SetAbsXY(), setBookmark(), setDestination(), setSignatureAppearance(), SetX(), SetXY(), Skew(), SkewX(), SkewY(), Text(), TextField(), Write(), write1DBarcode(), write2DBarcode(), writeHTML(), and writeHTMLCell().
|
protected |
|
protected |
Current XObject ID.
Definition at line 1576 of file tcpdf.php.
Referenced by _out(), addExtGState(), AddFont(), Annotation(), CoonsPatchMesh(), Gradient(), Image(), MultiCell(), setSpotColor(), StartTransform(), Transform(), and writeHTML().
|
protected |
Current vertical position in user unit for cell positioning.
Definition at line 350 of file tcpdf.php.
Referenced by _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outLine(), _outPoint(), _outRect(), addEmptySignatureAppearance(), AddSpotColor(), Annotation(), Bookmark(), Button(), Cell(), checkPageBreak(), Clip(), colorRegistrationBar(), CoonsPatchMesh(), cropMark(), fitBlock(), Footer(), getCellBorder(), getCellCode(), getSignatureAppearanceArray(), GetY(), Header(), Image(), ImageEps(), ImagePngAlpha(), LinearGradient(), Link(), ListBox(), MirrorL(), MirrorP(), MirrorV(), MultiCell(), openHTMLTagHandler(), RadialGradient(), RadioButton(), Rect(), registrationMark(), Rotate(), RoundedRect(), RoundedRectXY(), Scale(), ScaleX(), ScaleXY(), ScaleY(), SetAbsXY(), SetAbsY(), setBookmark(), setColorArray(), setDestination(), SetLink(), setSignatureAppearance(), setTableHeader(), SetXY(), SetY(), Skew(), SkewX(), SkewY(), Text(), TextField(), write1DBarcode(), write2DBarcode(), writeHTML(), and writeHTMLCell().
1.8.1.2 (using Doxyfile)