TCPDF Class Reference
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. More... | |
| __destruct () | |
| Default destructor. More... | |
| setPageUnit ($unit) | |
| Set the units of measure for the document. More... | |
| setPageOrientation ($orientation, $autopagebreak='', $bottommargin='') | |
| Set page orientation. More... | |
| setSpacesRE ($re='/[^\S\xa0]/') | |
| Set regular expression to detect withespaces or word separators. More... | |
| setRTL ($enable, $resetx=true) | |
| Enable or disable Right-To-Left language mode. More... | |
| getRTL () | |
| Return the RTL status. More... | |
| setTempRTL ($mode) | |
| Force temporary RTL language direction. More... | |
| isRTLTextDir () | |
| Return the current temporary RTL status. More... | |
| setLastH ($h) | |
| Set the last cell height. More... | |
| getCellHeight ($fontsize, $padding=TRUE) | |
| Return the cell height. More... | |
| resetLastH () | |
| Reset the last cell height. More... | |
| getLastH () | |
| Get the last cell height. More... | |
| setImageScale ($scale) | |
| Set the adjusting factor to convert pixels to user units. More... | |
| getImageScale () | |
| Returns the adjusting factor to convert pixels to user units. More... | |
| getPageDimensions ($pagenum='') | |
| Returns an array of page dimensions: More... | |
| getPageWidth ($pagenum='') | |
| Returns the page width in units. More... | |
| getPageHeight ($pagenum='') | |
| Returns the page height in units. More... | |
| getBreakMargin ($pagenum='') | |
| Returns the page break margin. More... | |
| getScaleFactor () | |
| Returns the scale factor (number of points in user unit). More... | |
| SetMargins ($left, $top, $right=-1, $keepmargins=false) | |
| Defines the left, top and right margins. More... | |
| SetLeftMargin ($margin) | |
| Defines the left margin. More... | |
| SetTopMargin ($margin) | |
| Defines the top margin. More... | |
| SetRightMargin ($margin) | |
| Defines the right margin. More... | |
| SetCellPadding ($pad) | |
| Set the same internal Cell padding for top, right, bottom, left-. More... | |
| setCellPaddings ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell paddings. More... | |
| getCellPaddings () | |
| Get the internal Cell padding array. More... | |
| setCellMargins ($left='', $top='', $right='', $bottom='') | |
| Set the internal Cell margins. More... | |
| getCellMargins () | |
| Get the internal Cell margin array. More... | |
| SetAutoPageBreak ($auto, $margin=0) | |
| Enables or disables the automatic page breaking mode. More... | |
| getAutoPageBreak () | |
| Return the auto-page-break mode (true or false). More... | |
| SetDisplayMode ($zoom, $layout='SinglePage', $mode='UseNone') | |
| Defines the way the document is to be displayed by the viewer. More... | |
| SetCompression ($compress=true) | |
| Activates or deactivates page compression. More... | |
| setSRGBmode ($mode=false) | |
| Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document. More... | |
| SetDocInfoUnicode ($unicode=true) | |
| Turn on/off Unicode mode for document information dictionary (meta tags). More... | |
| SetTitle ($title) | |
| Defines the title of the document. More... | |
| SetSubject ($subject) | |
| Defines the subject of the document. More... | |
| SetAuthor ($author) | |
| Defines the author of the document. More... | |
| SetKeywords ($keywords) | |
| Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. More... | |
| SetCreator ($creator) | |
| Defines the creator of the document. More... | |
| Error ($msg) | |
| Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true. More... | |
| Open () | |
| This method begins the generation of the PDF document. More... | |
| Close () | |
| Terminates the PDF document. More... | |
| setPage ($pnum, $resetmargins=false) | |
| Move pointer at the specified document page and update page dimensions. More... | |
| lastPage ($resetmargins=false) | |
| Reset pointer to the last document page. More... | |
| getPage () | |
| Get current document page number. More... | |
| getNumPages () | |
| Get the total number of insered pages. More... | |
| addTOCPage ($orientation='', $format='', $keepmargins=false) | |
| Adds a new TOC (Table Of Content) page to the document. More... | |
| endTOCPage () | |
| Terminate the current TOC (Table Of Content) page. More... | |
| AddPage ($orientation='', $format='', $keepmargins=false, $tocpage=false) | |
| Adds a new page to the document. More... | |
| endPage ($tocpage=false) | |
| Terminate the current page. More... | |
| startPage ($orientation='', $format='', $tocpage=false) | |
| Starts a new page to the document. More... | |
| setPageMark () | |
| Set start-writing mark on current page stream used to put borders and fills. More... | |
| setHeaderData ($ln='', $lw=0, $ht='', $hs='', $tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set header data. More... | |
| setFooterData ($tc=array(0, 0, 0), $lc=array(0, 0, 0)) | |
| Set footer data. More... | |
| getHeaderData () | |
| Returns header data: More... | |
| setHeaderMargin ($hm=10) | |
| Set header margin. More... | |
| getHeaderMargin () | |
| Returns header margin in user units. More... | |
| setFooterMargin ($fm=10) | |
| Set footer margin. More... | |
| getFooterMargin () | |
| Returns footer margin in user units. More... | |
| setPrintHeader ($val=true) | |
| Set a flag to print page header. More... | |
| setPrintFooter ($val=true) | |
| Set a flag to print page footer. More... | |
| getImageRBX () | |
| Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. More... | |
| getImageRBY () | |
| Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image. More... | |
| resetHeaderTemplate () | |
| Reset the xobject template used by Header() method. More... | |
| setHeaderTemplateAutoreset ($val=true) | |
| Set a flag to automatically reset the xobject template used by Header() method at each page. More... | |
| Header () | |
| This method is used to render the page header. More... | |
| Footer () | |
| This method is used to render the page footer. More... | |
| PageNo () | |
| Returns the current page number. More... | |
| getAllSpotColors () | |
| Returns the array of spot colors. More... | |
| AddSpotColor ($name, $c, $m, $y, $k) | |
| Defines a new spot color. More... | |
| setSpotColor ($type, $name, $tint=100) | |
| Set the spot color for the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawSpotColor ($name, $tint=100) | |
| Defines the spot color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillSpotColor ($name, $tint=100) | |
| Defines the spot color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextSpotColor ($name, $tint=100) | |
| Defines the spot color used for text. More... | |
| setColorArray ($type, $color, $ret=false) | |
| Set the color array for the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawColorArray ($color, $ret=false) | |
| Defines the color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillColorArray ($color, $ret=false) | |
| Defines the color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextColorArray ($color, $ret=false) | |
| Defines the color used for text. More... | |
| setColor ($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used by the specified type ('draw', 'fill', 'text'). More... | |
| SetDrawColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for all drawing operations (lines, rectangles and cell borders). More... | |
| SetFillColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for all filling operations (filled rectangles and cell backgrounds). More... | |
| SetTextColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') | |
| Defines the color used for text. More... | |
| GetStringWidth ($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
| Returns the length of a string in user unit. More... | |
| GetArrStringWidth ($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) | |
| Returns the string length of an array of chars in user unit or an array of characters widths. More... | |
| GetCharWidth ($char, $notlast=true) | |
| Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking). More... | |
| getRawCharWidth ($char) | |
| Returns the length of the char in user unit for the current font. More... | |
| GetNumChars ($s) | |
| Returns the numbero of characters in a string. More... | |
| AddFont ($family, $style='', $fontfile='', $subset='default') | |
| Imports a TrueType, Type1, core, or CID0 font and makes it available. More... | |
| SetFont ($family, $style='', $size=null, $fontfile='', $subset='default', $out=true) | |
| Sets the font used to print character strings. More... | |
| SetFontSize ($size, $out=true) | |
| Defines the size of the current font. More... | |
| getFontBBox () | |
| Returns the bounding box of the current font in user units. More... | |
| getAbsFontMeasure ($s) | |
| Convert a relative font measure into absolute value. More... | |
| getCharBBox ($char) | |
| Returns the glyph bounding box of the specified character in the current font in user units. More... | |
| getFontDescent ($font, $style='', $size=0) | |
| Return the font descent value. More... | |
| getFontAscent ($font, $style='', $size=0) | |
| Return the font ascent value. More... | |
| isCharDefined ($char, $font='', $style='') | |
| Return true in the character is present in the specified font. More... | |
| replaceMissingChars ($text, $font='', $style='', $subs=array()) | |
| Replace missing font characters on selected font with specified substitutions. More... | |
| SetDefaultMonospacedFont ($font) | |
| Defines the default monospaced font. More... | |
| AddLink () | |
| Creates a new internal link and returns its identifier. More... | |
| SetLink ($link, $y=0, $page=-1) | |
| Defines the page and position a link points to. More... | |
| Link ($x, $y, $w, $h, $link, $spaces=0) | |
| Puts a link on a rectangular area of the page. More... | |
| Annotation ($x, $y, $w, $h, $text, $opt=array('Subtype'=> 'Text'), $spaces=0) | |
| Puts a markup annotation on a rectangular area of the page. More... | |
| Text ($x, $y, $txt, $fstroke=false, $fclip=false, $ffill=true, $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M', $rtloff=false) | |
| Prints a text cell at the specified position. More... | |
| AcceptPageBreak () | |
| Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. More... | |
| Cell ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
| Prints a cell (rectangular area) with optional borders, background color and character string. More... | |
| MultiCell ($w, $h, $txt, $border=0, $align='J', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0, $valign='T', $fitcell=false) | |
| This method allows printing text with line breaks. More... | |
| getNumLines ($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
| This method return the estimated number of lines for print a simple text string using Multicell() method. More... | |
| getStringHeight ($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0) | |
| This method return the estimated height needed for printing a simple text string using the Multicell() method. More... | |
| Write ($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='') | |
| This method prints text from the current position. More... | |
| Image ($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false, $alt=false, $altimgs=array()) | |
| Puts an image in the page. More... | |
| Ln ($h='', $cell=false) | |
| Performs a line break. More... | |
| GetX () | |
| Returns the relative X value of current position. More... | |
| GetAbsX () | |
| Returns the absolute X value of current position. More... | |
| GetY () | |
| Returns the ordinate of the current position. More... | |
| SetX ($x, $rtloff=false) | |
| Defines the abscissa of the current position. More... | |
| SetY ($y, $resetx=true, $rtloff=false) | |
| Moves the current abscissa back to the left margin and sets the ordinate. More... | |
| SetXY ($x, $y, $rtloff=false) | |
| Defines the abscissa and ordinate of the current position. More... | |
| SetAbsX ($x) | |
| Set the absolute X coordinate of the current pointer. More... | |
| SetAbsY ($y) | |
| Set the absolute Y coordinate of the current pointer. More... | |
| SetAbsXY ($x, $y) | |
| Set the absolute X and Y coordinates of the current pointer. More... | |
| Output ($name='doc.pdf', $dest='I') | |
| Send the document to a given destination: string, local file or browser. More... | |
| _destroy ($destroyall=false, $preserve_objcopy=false) | |
| Unset all class variables except the following critical variables. More... | |
| setExtraXMP ($xmp) | |
| Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag. More... | |
| setDocCreationTimestamp ($time) | |
| Set the document creation timestamp. More... | |
| setDocModificationTimestamp ($time) | |
| Set the document modification timestamp. More... | |
| getDocCreationTimestamp () | |
| Returns document creation timestamp in seconds. More... | |
| getDocModificationTimestamp () | |
| Returns document modification timestamp in seconds. More... | |
| setHeaderFont ($font) | |
| Set header font. More... | |
| getHeaderFont () | |
| Get header font. More... | |
| setFooterFont ($font) | |
| Set footer font. More... | |
| getFooterFont () | |
| Get Footer font. More... | |
| setLanguageArray ($language) | |
| Set language array. More... | |
| getPDFData () | |
| Returns the PDF data. More... | |
| addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) | |
| Output anchor link. More... | |
| pixelsToUnits ($px) | |
| Converts pixels to User's Units. More... | |
| unhtmlentities ($text_to_convert) | |
| Reverse function for htmlentities. More... | |
| SetProtection ($permissions=array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass='', $owner_pass=null, $mode=0, $pubkeys=null) | |
| Set document protection Remark: the protection against modification is for people who have the full Acrobat product. More... | |
| StartTransform () | |
| Starts a 2D tranformation saving current graphic state. More... | |
| StopTransform () | |
| Stops a 2D tranformation restoring previous graphic state. More... | |
| ScaleX ($s_x, $x='', $y='') | |
| Horizontal Scaling. More... | |
| ScaleY ($s_y, $x='', $y='') | |
| Vertical Scaling. More... | |
| ScaleXY ($s, $x='', $y='') | |
| Vertical and horizontal proportional Scaling. More... | |
| Scale ($s_x, $s_y, $x='', $y='') | |
| Vertical and horizontal non-proportional Scaling. More... | |
| MirrorH ($x='') | |
| Horizontal Mirroring. More... | |
| MirrorV ($y='') | |
| Verical Mirroring. More... | |
| MirrorP ($x='', $y='') | |
| Point reflection mirroring. More... | |
| MirrorL ($angle=0, $x='', $y='') | |
| Reflection against a straight line through point (x, y) with the gradient angle (angle). More... | |
| TranslateX ($t_x) | |
| Translate graphic object horizontally. More... | |
| TranslateY ($t_y) | |
| Translate graphic object vertically. More... | |
| Translate ($t_x, $t_y) | |
| Translate graphic object horizontally and vertically. More... | |
| Rotate ($angle, $x='', $y='') | |
| Rotate object. More... | |
| SkewX ($angle_x, $x='', $y='') | |
| Skew horizontally. More... | |
| SkewY ($angle_y, $x='', $y='') | |
| Skew vertically. More... | |
| Skew ($angle_x, $angle_y, $x='', $y='') | |
| Skew. More... | |
| SetLineWidth ($width) | |
| Defines the line width. More... | |
| GetLineWidth () | |
| Returns the current the line width. More... | |
| SetLineStyle ($style, $ret=false) | |
| Set line style. More... | |
| Line ($x1, $y1, $x2, $y2, $style=array()) | |
| Draws a line between two points. More... | |
| Rect ($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rectangle. More... | |
| Curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a Bezier curve. More... | |
| Polycurve ($x0, $y0, $segments, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a poly-Bezier curve. More... | |
| Ellipse ($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws an ellipse. More... | |
| Circle ($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2) | |
| Draws a circle. More... | |
| PolyLine ($p, $style='', $line_style=array(), $fill_color=array()) | |
| Draws a polygonal line. More... | |
| Polygon ($p, $style='', $line_style=array(), $fill_color=array(), $closed=true) | |
| Draws a polygon. More... | |
| RegularPolygon ($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
| Draws a regular polygon. More... | |
| StarPolygon ($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) | |
| Draws a star polygon. More... | |
| RoundedRect ($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. More... | |
| RoundedRectXY ($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array()) | |
| Draws a rounded rectangle. More... | |
| Arrow ($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) | |
| Draws a grahic arrow. More... | |
| setDestination ($name, $y=-1, $page='', $x=-1) | |
| Add a Named Destination. More... | |
| getDestination () | |
| Return the Named Destination array. More... | |
| setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
| Adds a bookmark - alias for Bookmark(). More... | |
| Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='') | |
| Adds a bookmark. More... | |
| IncludeJS ($script) | |
| Adds a javascript. More... | |
| addJavascriptObject ($script, $onload=false) | |
| Adds a javascript object and return object ID. More... | |
| setFormDefaultProp ($prop=array()) | |
| Set default properties for form fields. More... | |
| getFormDefaultProp () | |
| Return the default properties for form fields. More... | |
| TextField ($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a text field. More... | |
| RadioButton ($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false) | |
| Creates a RadioButton field. More... | |
| ListBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a List-box field. More... | |
| ComboBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a Combo-box field. More... | |
| CheckBox ($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false) | |
| Creates a CheckBox field. More... | |
| Button ($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false) | |
| Creates a button field. More... | |
| setUserRights ( $enable=true, $document='/FullSave', $annots='/Create/Delete/Modify/Copy/Import/Export', $form='/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', $signature='/Modify', $ef='/Create/Delete/Modify/Import', $formex='') | |
| Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. More... | |
| setSignature ($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array(), $approval='') | |
| Enable document signature (requires the OpenSSL Library). More... | |
| 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) More... | |
| 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) More... | |
| setTimeStamp ($tsa_host='', $tsa_username='', $tsa_password='', $tsa_cert='') | |
| Enable document timestamping (requires the OpenSSL Library). More... | |
| startPageGroup ($page='') | |
| Create a new page group. More... | |
| setStartingPageNumber ($num=1) | |
| Set the starting page number. More... | |
| getAliasRightShift () | |
| Returns the string alias used right align page numbers. More... | |
| getAliasNbPages () | |
| Returns the string alias used for the total number of pages. More... | |
| getAliasNumPage () | |
| Returns the string alias used for the page number. More... | |
| getPageGroupAlias () | |
| Return the alias for the total number of pages in the current page group. More... | |
| getPageNumGroupAlias () | |
| Return the alias for the page number on the current page group. More... | |
| getGroupPageNo () | |
| Return the current page in the group. More... | |
| getGroupPageNoFormatted () | |
| Returns the current group page number formatted as a string. More... | |
| PageNoFormatted () | |
| Returns the current page number formatted as a string. More... | |
| startLayer ($name='', $print=true, $view=true, $lock=true) | |
| Start a new pdf layer. More... | |
| endLayer () | |
| End the current PDF layer. More... | |
| setVisibility ($v) | |
| Set the visibility of the successive elements. More... | |
| setOverprint ($stroking=true, $nonstroking='', $mode=0) | |
| Set overprint mode for stroking (OP) and non-stroking (op) painting operations. More... | |
| getOverprint () | |
| Get the overprint mode array (OP, op, OPM). More... | |
| setAlpha ($stroking=1, $bm='Normal', $nonstroking='', $ais=false) | |
| Set alpha for stroking (CA) and non-stroking (ca) operations. More... | |
| getAlpha () | |
| Get the alpha mode array (CA, ca, BM, AIS). More... | |
| setJPEGQuality ($quality) | |
| Set the default JPEG compression quality (1-100) More... | |
| setDefaultTableColumns ($cols=4) | |
| Set the default number of columns in a row for HTML tables. More... | |
| setCellHeightRatio ($h) | |
| Set the height of the cell (line height) respect the font height. More... | |
| getCellHeightRatio () | |
| return the height of cell repect font height. More... | |
| setPDFVersion ($version='1.7') | |
| Set the PDF version (check PDF reference for valid values). More... | |
| setViewerPreferences ($preferences) | |
| Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. More... | |
| colorRegistrationBar ($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A, R, G, B, C, M, Y, K') | |
| Paints color transition registration bars. More... | |
| cropMark ($x, $y, $w, $h, $type='T, R, B, L', $color=array(100, 100, 100, 100, 'All')) | |
| Paints crop marks. More... | |
| registrationMark ($x, $y, $r, $double=false, $cola=array(100, 100, 100, 100, 'All'), $colb=array(0, 0, 0, 0, 'None')) | |
| Paints a registration mark. More... | |
| registrationMarkCMYK ($x, $y, $r) | |
| Paints a CMYK registration mark. More... | |
| LinearGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0)) | |
| Paints a linear colour gradient. More... | |
| RadialGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0.5, 0.5, 0.5, 0.5, 1)) | |
| Paints a radial colour gradient. More... | |
| CoonsPatchMesh ($x, $y, $w, $h, $col1=array(), $col2=array(), $col3=array(), $col4=array(), $coords=array(0.00, 0.0, 0.33, 0.00, 0.67, 0.00, 1.00, 0.00, 1.00, 0.33, 1.00, 0.67, 1.00, 1.00, 0.67, 1.00, 0.33, 1.00, 0.00, 1.00, 0.00, 0.67, 0.00, 0.33), $coords_min=0, $coords_max=1, $antialias=false) | |
| Paints a coons patch mesh. More... | |
| Gradient ($type, $coords, $stops, $background=array(), $antialias=false) | |
| Output gradient. More... | |
| PieSector ($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) | |
| Draw the sector of a circle. More... | |
| PieSectorXY ($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) | |
| Draw the sector of an ellipse. More... | |
| ImageEps ($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false) | |
| Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. More... | |
| setBarcode ($bc='') | |
| Set document barcode. More... | |
| getBarcode () | |
| Get current barcode. More... | |
| write1DBarcode ($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='') | |
| Print a Linear Barcode. More... | |
| write2DBarcode ($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false) | |
| Print 2D Barcode. More... | |
| getMargins () | |
| Returns an array containing current margins: More... | |
| getOriginalMargins () | |
| Returns an array containing original margins: More... | |
| getFontSize () | |
| Returns the current font size. More... | |
| getFontSizePt () | |
| Returns the current font size in points unit. More... | |
| getFontFamily () | |
| Returns the current font family name. More... | |
| getFontStyle () | |
| Returns the current font style. More... | |
| fixHTMLCode ($html, $default_css='', $tagvs='', $tidy_options='') | |
| Cleanup HTML code (requires HTML Tidy library). More... | |
| getCSSPadding ($csspadding, $width=0) | |
| Get the internal Cell padding from CSS attribute. More... | |
| getCSSMargin ($cssmargin, $width=0) | |
| Get the internal Cell margin from CSS attribute. More... | |
| getCSSBorderMargin ($cssbspace, $width=0) | |
| Get the border-spacing from CSS attribute. More... | |
| getHTMLFontUnits ($val, $refsize=12, $parent_size=12, $defaultunit='pt') | |
| Convert HTML string containing font size value to points. More... | |
| serializeTCPDFtagParameters ($data) | |
| Serialize an array of parameters to be used with TCPDF tag in HTML code. More... | |
| writeHTMLCell ($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=false, $reseth=true, $align='', $autopadding=true) | |
| writeHTML ($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='') | |
| Allows to preserve some HTML formatting (limited support). More... | |
| setLIsymbol ($symbol='!') | |
| Set the default bullet to be used as LI bullet symbol. More... | |
| SetBooklet ($booklet=true, $inner=-1, $outer=-1) | |
| Set the booklet mode for double-sided pages. More... | |
| setHtmlVSpace ($tagvs) | |
| Set the vertical spaces for HTML tags. More... | |
| setListIndentWidth ($width) | |
| Set custom width for list indentation. More... | |
| setOpenCell ($isopen) | |
| Set the top/bottom cell sides to be open or closed when the cell cross the page. More... | |
| setHtmlLinksStyle ($color=array(0, 0, 255), $fontstyle='U') | |
| Set the color and font style for HTML links. More... | |
| getHTMLUnitToUnits ($htmlval, $refsize=1, $defaultunit='px', $points=false) | |
| Convert HTML string containing value and unit of measure to user's units or points. More... | |
| movePage ($frompage, $topage) | |
| Move a page to a previous position. More... | |
| deletePage ($page) | |
| Remove the specified page. More... | |
| copyPage ($page=0) | |
| Clone the specified page to a new page. More... | |
| addTOC ($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0, 0, 0)) | |
| Output a Table of Content Index (TOC). More... | |
| addHTMLTOC ($page='', $toc_name='TOC', $templates=array(), $correct_align=true, $style='', $color=array(0, 0, 0)) | |
| Output a Table Of Content Index (TOC) using HTML templates. More... | |
| startTransaction () | |
| Stores a copy of the current TCPDF object used for undo operation. More... | |
| commitTransaction () | |
| Delete the copy of the current TCPDF object used for undo operation. More... | |
| rollbackTransaction ($self=false) | |
| This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction(). More... | |
| setEqualColumns ($numcols=0, $width=0, $y='') | |
| Set multiple columns of the same size. More... | |
| resetColumns () | |
| Remove columns and reset page margins. More... | |
| setColumnsArray ($columns) | |
| Set columns array. More... | |
| selectColumn ($col='') | |
| Set position at a given column. More... | |
| getColumn () | |
| Return the current column number. More... | |
| getNumberOfColumns () | |
| Return the current number of columns. More... | |
| setTextRenderingMode ($stroke=0, $fill=true, $clip=false) | |
| Set Text rendering mode. More... | |
| setTextShadow ($params=array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=> 'Normal')) | |
| Set parameters for drop shadow effect for text. More... | |
| getTextShadow () | |
| Return the text shadow parameters array. More... | |
| hyphenateText ($text, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns text with soft hyphens. More... | |
| setRasterizeVectorImages ($mode) | |
| Enable/disable rasterization of vector images using ImageMagick library. More... | |
| setFontSubsetting ($enable=true) | |
| Enable or disable default option for font subsetting. More... | |
| getFontSubsetting () | |
| Return the default option for font subsetting. More... | |
| stringLeftTrim ($str, $replace='') | |
| Left trim the input string. More... | |
| stringRightTrim ($str, $replace='') | |
| Right trim the input string. More... | |
| stringTrim ($str, $replace='') | |
| Trim the input string. More... | |
| isUnicodeFont () | |
| Return true if the current font is unicode type. More... | |
| getFontFamilyName ($fontfamily) | |
| Return normalized font name. More... | |
| startTemplate ($w=0, $h=0, $group=false) | |
| Start a new XObject Template. More... | |
| endTemplate () | |
| End the current XObject Template started with startTemplate() and restore the previous graphic state. More... | |
| printTemplate ($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false) | |
| Print an XObject Template. More... | |
| setFontStretching ($perc=100) | |
| Set the percentage of character stretching. More... | |
| getFontStretching () | |
| Get the percentage of character stretching. More... | |
| setFontSpacing ($spacing=0) | |
| Set the amount to increase or decrease the space between characters in a text. More... | |
| getFontSpacing () | |
| Get the amount to increase or decrease the space between characters in a text. More... | |
| getPageRegions () | |
| Return an array of no-write page regions. More... | |
| setPageRegions ($regions=array()) | |
| Set no-write regions on page. More... | |
| addPageRegion ($region) | |
| Add a single no-write region on selected page. More... | |
| removePageRegion ($key) | |
| Remove a single no-write region. More... | |
| ImageSVG ($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false) | |
| Embedd a Scalable Vector Graphics (SVG) image. More... | |
Protected Member Functions | |
| setPageFormat ($format, $orientation='P') | |
| Change the format of the current page. More... | |
| adjustCellPadding ($brd=0) | |
| Adjust the internal Cell padding array to take account of the line width. More... | |
| setContentMark ($page=0) | |
| Set start-writing mark on selected page. More... | |
| setHeader () | |
| This method is used to render the page header. More... | |
| setFooter () | |
| This method is used to render the page footer. More... | |
| inPageBody () | |
| Check if we are on the page body (excluding page header and footer). More... | |
| setTableHeader () | |
| This method is used to render the table header on new page (if any). More... | |
| getFontsList () | |
| Fill the list of available fonts ($this->fontlist). More... | |
| _putEmbeddedFiles () | |
| Embedd the attached files. More... | |
| checkPageBreak ($h=0, $y='', $addpage=true) | |
| Add page if needed. More... | |
| getCellCode ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') | |
| Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. More... | |
| replaceChar ($oldchar, $newchar) | |
| Replace a char if is defined on the current font. More... | |
| getCellBorder ($x, $y, $w, $h, $brd) | |
| Returns the code to draw the cell border. More... | |
| getRemainingWidth () | |
| Returns the remaining width between the current position and margins. More... | |
| fitBlock ($w, $h, $x, $y, $fitonpage=false) | |
| Set the block dimensions accounting for page breaks and page/column fitting. More... | |
| 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 Imagick or GD library. More... | |
| getGDgamma ($img, $c) | |
| Get the GD-corrected PNG gamma value from alpha color. More... | |
| _dochecks () | |
| Check for locale-related bug. More... | |
| getInternalPageNumberAliases ($a='') | |
| Return an array containing variations for the basic page number alias. More... | |
| getAllInternalPageNumberAliases () | |
| Return an array containing all internal page aliases. More... | |
| replaceRightShiftPageNumAliases ($page, $aliases, $diff) | |
| Replace right shift page number aliases with spaces to correct right alignment. More... | |
| setPageBoxTypes ($boxes) | |
| Set page boxes to be included on page descriptions. More... | |
| _putpages () | |
| Output pages (and replace page number aliases). More... | |
| _getannotsrefs ($n) | |
| Get references to page annotations. More... | |
| _putannotsobjs () | |
| Output annotations objects for all pages. More... | |
| _putAPXObject ($w=0, $h=0, $stream='') | |
| Put appearance streams XObject used to define annotation's appearance states. More... | |
| _putfonts () | |
| Output fonts. More... | |
| _puttruetypeunicode ($font) | |
| Adds unicode fonts. More... | |
| _putcidfont0 ($font) | |
| Output CID-0 fonts. More... | |
| _putimages () | |
| Output images. More... | |
| _putxobjects () | |
| Output Form XObjects Templates. More... | |
| _putspotcolors () | |
| Output Spot Colors Resources. More... | |
| _getxobjectdict () | |
| Return XObjects Dictionary. More... | |
| _putresourcedict () | |
| Output Resources Dictionary. More... | |
| _putresources () | |
| Output Resources. More... | |
| _putinfo () | |
| Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference) More... | |
| _putXMP () | |
| Put XMP data object and return ID. More... | |
| _putcatalog () | |
| Output Catalog. More... | |
| _putviewerpreferences () | |
| Output viewer preferences. More... | |
| _putheader () | |
| Output PDF File Header (7.5.2). More... | |
| _enddoc () | |
| Output end of document (EOF). More... | |
| _beginpage ($orientation='', $format='') | |
| Initialize a new page. More... | |
| _endpage () | |
| Mark end of page. More... | |
| _newobj () | |
| Begin a new object and return the object number. More... | |
| _getobj ($objid='') | |
| Return the starting object string for the selected object ID. More... | |
| _dounderline ($x, $y, $txt) | |
| Underline text. More... | |
| _dounderlinew ($x, $y, $w) | |
| Underline for rectangular text area. More... | |
| _dolinethrough ($x, $y, $txt) | |
| Line through text. More... | |
| _dolinethroughw ($x, $y, $w) | |
| Line through for rectangular text area. More... | |
| _dooverline ($x, $y, $txt) | |
| Overline text. More... | |
| _dooverlinew ($x, $y, $w) | |
| Overline for rectangular text area. More... | |
| _datastring ($s, $n=0) | |
| Format a data string for meta information. More... | |
| _datestring ($n=0, $timestamp=0) | |
| Returns a formatted date for meta information. More... | |
| _textstring ($s, $n=0) | |
| Format a text string for meta information. More... | |
| _getrawstream ($s, $n=0) | |
| get raw output stream. More... | |
| _out ($s) | |
| Output a string to the document. More... | |
| _objectkey ($n) | |
| Compute encryption key depending on object number where the encrypted data is stored. More... | |
| _encrypt_data ($n, $s) | |
| Encrypt the input string. More... | |
| _putencryption () | |
| Put encryption on PDF document. More... | |
| _Uvalue () | |
| Compute U value (used for encryption) More... | |
| _UEvalue () | |
| Compute UE value (used for encryption) More... | |
| _Ovalue () | |
| Compute O value (used for encryption) More... | |
| _OEvalue () | |
| Compute OE value (used for encryption) More... | |
| _fixAES256Password ($password) | |
| Convert password for AES-256 encryption mode. More... | |
| _generateencryptionkey () | |
| Compute encryption key. More... | |
| Transform ($tm) | |
| Apply graphic transformations. More... | |
| _outPoint ($x, $y) | |
| Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. More... | |
| _outLine ($x, $y) | |
| Append a straight line segment from the current point to the point (x, y). More... | |
| _outRect ($x, $y, $w, $h, $op) | |
| Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space. More... | |
| _outCurve ($x1, $y1, $x2, $y2, $x3, $y3) | |
| Append a cubic Bezier curve to the current path. More... | |
| _outCurveV ($x2, $y2, $x3, $y3) | |
| Append a cubic Bezier curve to the current path. More... | |
| _outCurveY ($x1, $y1, $x3, $y3) | |
| Append a cubic Bezier curve to the current path. More... | |
| _outellipticalarc ($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false) | |
| Append an elliptical arc to the current path. More... | |
| _putdests () | |
| Insert Named Destinations. More... | |
| sortBookmarks () | |
| Sort bookmarks for page and key. More... | |
| _putbookmarks () | |
| Create a bookmark PDF string. More... | |
| _putjavascript () | |
| Create a javascript PDF string. More... | |
| _addfield ($type, $name, $x, $y, $w, $h, $prop) | |
| Adds a javascript form field. More... | |
| _putsignature () | |
| Add certification signature (DocMDP or UR3) You can set only one signature type. More... | |
| getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') | |
| Get the array that defines the signature appearance (page and rectangle coordinates). More... | |
| applyTSA ($signature) | |
| NOT YET IMPLEMENTED Request TSA for a timestamp. More... | |
| _putocg () | |
| Put pdf layers. More... | |
| addExtGState ($parms) | |
| Add transparency parameters to the current extgstate. More... | |
| setExtGState ($gs) | |
| Add an extgstate. More... | |
| _putextgstates () | |
| Put extgstates for object transparency. More... | |
| Clip ($x, $y, $w, $h) | |
| Set a rectangular clipping area. More... | |
| _putshaders () | |
| Output gradient shaders. More... | |
| getCSSBorderWidth ($width) | |
| Returns the border width from CSS property. More... | |
| getCSSBorderDashStyle ($style) | |
| Returns the border dash style from CSS property. More... | |
| getCSSBorderStyle ($cssborder) | |
| Returns the border style array from CSS border properties. More... | |
| getCSSFontSpacing ($spacing, $parent=0) | |
| Returns the letter-spacing value from CSS value. More... | |
| getCSSFontStretching ($stretch, $parent=100) | |
| Returns the percentage of font stretching from CSS value. More... | |
| getHtmlDomArray ($html) | |
| Returns the HTML DOM array. More... | |
| getSpaceString () | |
| Returns the string used to find spaces. More... | |
| getHashForTCPDFtagParams ($data) | |
| Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance. More... | |
| unserializeTCPDFtagParameters ($data) | |
| Unserialize parameters to be used with TCPDF tag in HTML code. More... | |
| openHTMLTagHandler ($dom, $key, $cell) | |
| Process opening tags. More... | |
| closeHTMLTagHandler ($dom, $key, $cell, $maxbottomliney=0) | |
| Process closing tags. More... | |
| addHTMLVertSpace ($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false) | |
| Add vertical spaces if needed. More... | |
| getBorderStartPosition () | |
| Return the starting coordinates to draw an html border. More... | |
| drawHTMLTagBorder ($tag, $xmax) | |
| Draw an HTML block border and fill. More... | |
| swapMargins ($reverse=true) | |
| Swap the left and right margins. More... | |
| putHtmlListBullet ($listdepth, $listtype='', $size=10) | |
| Output an HTML list bullet or ordered item symbol. More... | |
| getGraphicVars () | |
| Returns current graphic variables as array. More... | |
| setGraphicVars ($gvars, $extended=false) | |
| Set graphic variables. More... | |
| _outSaveGraphicsState () | |
| Outputs the "save graphics state" operator 'q'. More... | |
| _outRestoreGraphicsState () | |
| Outputs the "restore graphics state" operator 'Q'. More... | |
| setBuffer ($data) | |
| Set buffer content (always append data). More... | |
| replaceBuffer ($data) | |
| Replace the buffer content. More... | |
| getBuffer () | |
| Get buffer content. More... | |
| setPageBuffer ($page, $data, $append=false) | |
| Set page buffer content. More... | |
| getPageBuffer ($page) | |
| Get page buffer content. More... | |
| setImageBuffer ($image, $data) | |
| Set image buffer content. More... | |
| setImageSubBuffer ($image, $key, $data) | |
| Set image buffer content for a specified sub-key. More... | |
| getImageBuffer ($image) | |
| Get image buffer content. More... | |
| setFontBuffer ($font, $data) | |
| Set font buffer content. More... | |
| setFontSubBuffer ($font, $key, $data) | |
| Set font buffer content. More... | |
| getFontBuffer ($font) | |
| Get font buffer content. More... | |
| hyphenateWord ($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8) | |
| Returns an array of chars containing soft hyphens. More... | |
| checkPageRegions ($h, $x, $y) | |
| Check page for no-write regions and adapt current coordinates and page margins if necessary. More... | |
| convertSVGtMatrix ($tm) | |
| Convert SVG transformation matrix to PDF. More... | |
| SVGTransform ($tm) | |
| Apply SVG graphic transformation matrix. More... | |
| setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()) | |
| Apply the requested SVG styles (*** TO BE COMPLETED ***) More... | |
| SVGPath ($d, $style='') | |
| Draws an SVG path. More... | |
| removeTagNamespace ($name) | |
| Return the tag name without the namespace. More... | |
| startSVGElementHandler ($parser, $name, $attribs, $ctm=array()) | |
| Sets the opening SVG element handler function for the XML parser. More... | |
| endSVGElementHandler ($parser, $name) | |
| Sets the closing SVG element handler function for the XML parser. More... | |
| segSVGContentHandler ($parser, $data) | |
| Sets the character data handler function for the XML parser. More... | |
Protected Attributes | |
| $page | |
| Current page number. More... | |
| $n | |
| Current object number. More... | |
| $offsets = array() | |
| Array of object offsets. More... | |
| $pageobjects = array() | |
| Array of object IDs for each page. More... | |
| $buffer | |
| Buffer holding in-memory PDF. More... | |
| $pages = array() | |
| Array containing pages. More... | |
| $state | |
| Current document state. More... | |
| $compress | |
| Compression flag. More... | |
| $CurOrientation | |
| Current page orientation (P = Portrait, L = Landscape). More... | |
| $pagedim = array() | |
| Page dimensions. More... | |
| $k | |
| Scale factor (number of points in user unit). More... | |
| $fwPt | |
| Width of page format in points. More... | |
| $fhPt | |
| Height of page format in points. More... | |
| $wPt | |
| Current width of page in points. More... | |
| $hPt | |
| Current height of page in points. More... | |
| $w | |
| Current width of page in user unit. More... | |
| $h | |
| Current height of page in user unit. More... | |
| $lMargin | |
| Left margin. More... | |
| $rMargin | |
| Right margin. More... | |
| $clMargin | |
| Cell left margin (used by regions). More... | |
| $crMargin | |
| Cell right margin (used by regions). More... | |
| $tMargin | |
| Top margin. More... | |
| $bMargin | |
| Page break margin. More... | |
| $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). More... | |
| $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) | |
| Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left). More... | |
| $x | |
| Current horizontal position in user unit for cell positioning. More... | |
| $y | |
| Current vertical position in user unit for cell positioning. More... | |
| $lasth | |
| Height of last cell printed. More... | |
| $LineWidth | |
| Line width in user unit. More... | |
| $CoreFonts | |
| Array of standard font names. More... | |
| $fonts = array() | |
| Array of used fonts. More... | |
| $FontFiles = array() | |
| Array of font files. More... | |
| $diffs = array() | |
| Array of encoding differences. More... | |
| $images = array() | |
| Array of used images. More... | |
| $svg_tag_depth = 0 | |
| Depth of the svg tag, to keep track if the svg tag is a subtag or the root tag. More... | |
| $PageAnnots = array() | |
| Array of Annotations in pages. More... | |
| $links = array() | |
| Array of internal links. More... | |
| $FontFamily | |
| Current font family. More... | |
| $FontStyle | |
| Current font style. More... | |
| $FontAscent | |
| Current font ascent (distance between font top and baseline). More... | |
| $FontDescent | |
| Current font descent (distance between font bottom and baseline). More... | |
| $underline | |
| Underlining flag. More... | |
| $overline | |
| Overlining flag. More... | |
| $CurrentFont | |
| Current font info. More... | |
| $FontSizePt | |
| Current font size in points. More... | |
| $FontSize | |
| Current font size in user unit. More... | |
| $DrawColor | |
| Commands for drawing color. More... | |
| $FillColor | |
| Commands for filling color. More... | |
| $TextColor | |
| Commands for text color. More... | |
| $ColorFlag | |
| Indicates whether fill and text colors are different. More... | |
| $AutoPageBreak | |
| Automatic page breaking. More... | |
| $PageBreakTrigger | |
| Threshold used to trigger page breaks. More... | |
| $InHeader = false | |
| Flag set when processing page header. More... | |
| $InFooter = false | |
| Flag set when processing page footer. More... | |
| $ZoomMode | |
| Zoom display mode. More... | |
| $LayoutMode | |
| Layout display mode. More... | |
| $docinfounicode = true | |
| If true set the document information dictionary in Unicode. More... | |
| $title = '' | |
| Document title. More... | |
| $subject = '' | |
| Document subject. More... | |
| $author = '' | |
| Document author. More... | |
| $keywords = '' | |
| Document keywords. More... | |
| $creator = '' | |
| Document creator. More... | |
| $starting_page_number = 1 | |
| Starting page number. More... | |
| $img_rb_x | |
| The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image. More... | |
| $img_rb_y | |
| The right-bottom corner Y coordinate of last inserted image. More... | |
| $imgscale = 1 | |
| Adjusting factor to convert pixels to user units. More... | |
| $isunicode = false | |
| Boolean flag set to true when the input text is unicode (require unicode fonts). More... | |
| $PDFVersion = '1.7' | |
| PDF version. More... | |
| $header_xobjid = false | |
| ID of the stored default header template (-1 = not set). More... | |
| $header_xobj_autoreset = false | |
| If true reset the Header Xobject template at each page. More... | |
| $header_margin | |
| Minimum distance between header and top page margin. More... | |
| $footer_margin | |
| Minimum distance between footer and bottom page margin. More... | |
| $original_lMargin | |
| Original left margin value. More... | |
| $original_rMargin | |
| Original right margin value. More... | |
| $header_font | |
| Default font used on page header. More... | |
| $footer_font | |
| Default font used on page footer. More... | |
| $l | |
| Language templates. More... | |
| $barcode = false | |
| Barcode to print on page footer (only if set). More... | |
| $print_header = true | |
| Boolean flag to print/hide page header. More... | |
| $print_footer = true | |
| Boolean flag to print/hide page footer. More... | |
| $header_logo = '' | |
| Header image logo. More... | |
| $header_logo_width = 30 | |
| Width of header image logo in user units. More... | |
| $header_title = '' | |
| Title to be printed on default page header. More... | |
| $header_string = '' | |
| String to pring on page header after title. More... | |
| $header_text_color = array(0,0,0) | |
| Color for header text (RGB array). More... | |
| $header_line_color = array(0,0,0) | |
| Color for header line (RGB array). More... | |
| $footer_text_color = array(0,0,0) | |
| Color for footer text (RGB array). More... | |
| $footer_line_color = array(0,0,0) | |
| Color for footer line (RGB array). More... | |
| $txtshadow = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal') | |
| Text shadow data array. More... | |
| $default_table_columns = 4 | |
| Default number of columns for html table. More... | |
| $HREF = array() | |
| HTML PARSER: array to store current link and rendering styles. More... | |
| $fontlist = array() | |
| List of available fonts on filesystem. More... | |
| $fgcolor | |
| Current foreground color. More... | |
| $listordered = array() | |
| HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise. More... | |
| $listcount = array() | |
| HTML PARSER: array count list items on nested lists. More... | |
| $listnum = 0 | |
| HTML PARSER: current list nesting level. More... | |
| $listindent = 0 | |
| HTML PARSER: indent amount for lists. More... | |
| $listindentlevel = 0 | |
| HTML PARSER: current list indententation level. More... | |
| $bgcolor | |
| Current background color. More... | |
| $tempfontsize = 10 | |
| Temporary font size in points. More... | |
| $lispacer = '' | |
| Spacer string for LI tags. More... | |
| $encoding = 'UTF-8' | |
| Default encoding. More... | |
| $internal_encoding | |
| PHP internal encoding. More... | |
| $rtl = false | |
| Boolean flag to indicate if the document language is Right-To-Left. More... | |
| $tmprtl = false | |
| Boolean flag used to force RTL or LTR string direction. More... | |
| $encrypted | |
| IBoolean flag indicating whether document is protected. More... | |
| $encryptdata = array() | |
| Array containing encryption settings. More... | |
| $last_enc_key | |
| Last RC4 key encrypted (cached for optimisation). More... | |
| $last_enc_key_c | |
| Last RC4 computed key. More... | |
| $file_id | |
| File ID (used on document trailer). More... | |
| $outlines = array() | |
| Outlines for bookmark. More... | |
| $OutlineRoot | |
| Outline root for bookmark. More... | |
| $javascript = '' | |
| Javascript code. More... | |
| $n_js | |
| Javascript counter. More... | |
| $linethrough | |
| line through state More... | |
| $ur = array() | |
| Array with additional document-wide usage rights for the document. More... | |
| $dpi = 72 | |
| DPI (Dot Per Inch) Document Resolution (do not change). More... | |
| $newpagegroup = array() | |
| Array of page numbers were a new page group was started (the page numbers are the keys of the array). More... | |
| $pagegroups = array() | |
| Array that contains the number of pages in each page group. More... | |
| $currpagegroup = 0 | |
| Current page group number. More... | |
| $extgstates | |
| Array of transparency objects and parameters. More... | |
| $jpeg_quality | |
| Set the default JPEG compression quality (1-100). More... | |
| $cell_height_ratio = K_CELL_HEIGHT_RATIO | |
| Default cell height ratio. More... | |
| $viewer_preferences | |
| PDF viewer preferences. More... | |
| $PageMode | |
| A name object specifying how the document should be displayed when opened. More... | |
| $gradients = array() | |
| Array for storing gradient information. More... | |
| $intmrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). More... | |
| $bordermrk = array() | |
| Array used to store positions inside the pages buffer (keys are the page numbers). More... | |
| $emptypagemrk = array() | |
| Array used to store page positions to track empty pages (keys are the page numbers). More... | |
| $cntmrk = array() | |
| Array used to store content positions inside the pages buffer (keys are the page numbers). More... | |
| $footerpos = array() | |
| Array used to store footer positions of each page. More... | |
| $footerlen = array() | |
| Array used to store footer length of each page. More... | |
| $newline = true | |
| Boolean flag to indicate if a new line is created. More... | |
| $endlinex = 0 | |
| End position of the latest inserted line. More... | |
| $linestyleWidth = '' | |
| PDF string for width value of the last line. More... | |
| $linestyleCap = '0 J' | |
| PDF string for CAP value of the last line. More... | |
| $linestyleJoin = '0 j' | |
| PDF string for join value of the last line. More... | |
| $linestyleDash = '[] 0 d' | |
| PDF string for dash value of the last line. More... | |
| $openMarkedContent = false | |
| Boolean flag to indicate if marked-content sequence is open. More... | |
| $htmlvspace = 0 | |
| Count the latest inserted vertical spaces on HTML. More... | |
| $spot_colors = array() | |
| Array of Spot colors. More... | |
| $lisymbol = '' | |
| Symbol used for HTML unordered list items. More... | |
| $epsmarker = 'x#!#EPS#!#x' | |
| String used to mark the beginning and end of EPS image blocks. More... | |
| $transfmatrix = array() | |
| Array of transformation matrix. More... | |
| $transfmatrix_key = 0 | |
| Current key for transformation matrix. More... | |
| $booklet = false | |
| Booklet mode for double-sided pages. More... | |
| $feps = 0.005 | |
| Epsilon value used for float calculations. More... | |
| $tagvspaces = array() | |
| Array used for custom vertical spaces for HTML tags. More... | |
| $customlistindent = -1 | |
| HTML PARSER: custom indent amount for lists. More... | |
| $opencell = true | |
| Boolean flag to indicate if the border of the cell sides that cross the page should be removed. More... | |
| $embeddedfiles = array() | |
| Array of files to embedd. More... | |
| $premode = false | |
| Boolean flag to indicate if we are inside a PRE tag. More... | |
| $transfmrk = array() | |
| Array used to store positions of graphics transformation blocks inside the page buffer. More... | |
| $htmlLinkColorArray = array(0, 0, 255) | |
| Default color for html links. More... | |
| $htmlLinkFontStyle = 'U' | |
| Default font style to add to html links. More... | |
| $numpages = 0 | |
| Counts the number of pages. More... | |
| $pagelen = array() | |
| Array containing page lengths in bytes. More... | |
| $numimages = 0 | |
| Counts the number of pages. More... | |
| $imagekeys = array() | |
| Store the image keys. More... | |
| $bufferlen = 0 | |
| Length of the buffer in bytes. More... | |
| $numfonts = 0 | |
| Counts the number of fonts. More... | |
| $fontkeys = array() | |
| Store the font keys. More... | |
| $font_obj_ids = array() | |
| Store the font object IDs. More... | |
| $pageopen = array() | |
| Store the fage status (true when opened, false when closed). More... | |
| $default_monospaced_font = 'courier' | |
| Default monospace font. More... | |
| $objcopy | |
| Cloned copy of the current class object. More... | |
| $cache_file_length = array() | |
| Array used to store the lengths of cache files. More... | |
| $thead = '' | |
| Table header content to be repeated on each new page. More... | |
| $theadMargins = array() | |
| Margins used for table header. More... | |
| $sign = false | |
| Boolean flag to enable document digital signature. More... | |
| $signature_data = array() | |
| Digital signature data. More... | |
| $signature_max_length = 11742 | |
| Digital signature max length. More... | |
| $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0') | |
| Data for digital signature appearance. More... | |
| $empty_signature_appearance = array() | |
| Array of empty digital signature appearances. More... | |
| $tsa_timestamp = false | |
| Boolean flag to enable document timestamping with TSA. More... | |
| $tsa_data = array() | |
| Timestamping data. More... | |
| $re_spaces = '/[^\S\xa0]/' | |
| Regular expression used to find blank characters (required for word-wrapping). More... | |
| $re_space = array('p' => '[^\S\xa0]', 'm' => '') | |
| Array of $re_spaces parts. More... | |
| $sig_obj_id = 0 | |
| Digital signature object ID. More... | |
| $page_obj_id = array() | |
| ID of page objects. More... | |
| $form_obj_id = array() | |
| List of form annotations IDs. More... | |
| $default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128)) | |
| Deafult Javascript field properties. More... | |
| $js_objects = array() | |
| Javascript objects array. More... | |
| $form_action = '' | |
| Current form action (used during XHTML rendering). More... | |
| $form_enctype = 'application/x-www-form-urlencoded' | |
| Current form encryption type (used during XHTML rendering). More... | |
| $form_mode = 'post' | |
| Current method to submit forms. More... | |
| $annotation_fonts = array() | |
| List of fonts used on form fields (fontname => fontkey). More... | |
| $radiobutton_groups = array() | |
| List of radio buttons parent objects. More... | |
| $radio_groups = array() | |
| List of radio group objects IDs. More... | |
| $textindent = 0 | |
| Text indentation value (used for text-indent CSS attribute). More... | |
| $start_transaction_page = 0 | |
| Store page number when startTransaction() is called. More... | |
| $start_transaction_y = 0 | |
| Store Y position when startTransaction() is called. More... | |
| $inthead = false | |
| True when we are printing the thead section on a new page. More... | |
| $columns = array() | |
| Array of column measures (width, space, starting Y position). More... | |
| $num_columns = 1 | |
| Number of colums. More... | |
| $current_column = 0 | |
| Current column number. More... | |
| $column_start_page = 0 | |
| Starting page for columns. More... | |
| $maxselcol = array('page' => 0, 'column' => 0) | |
| Maximum page and column selected. More... | |
| $colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0)) | |
| Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding. More... | |
| $textrendermode = 0 | |
| Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping. More... | |
| $textstrokewidth = 0 | |
| Text stroke width in doc units. More... | |
| $strokecolor | |
| Current stroke color. More... | |
| $pdfunit = 'mm' | |
| Default unit of measure for document. More... | |
| $tocpage = false | |
| Boolean flag true when we are on TOC (Table Of Content) page. More... | |
| $rasterize_vector_images = false | |
| Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library. More... | |
| $font_subsetting = true | |
| Boolean flag: if true enables font subsetting by default. More... | |
| $default_graphic_vars = array() | |
| Array of default graphic settings. More... | |
| $xobjects = array() | |
| Array of XObjects. More... | |
| $inxobj = false | |
| Boolean value true when we are inside an XObject. More... | |
| $xobjid = '' | |
| Current XObject ID. More... | |
| $font_stretching = 100 | |
| Percentage of character stretching. More... | |
| $font_spacing = 0 | |
| Increases or decreases the space between characters in a text by the specified amount (tracking). More... | |
| $page_regions = array() | |
| Array of no-write regions. More... | |
| $check_page_regions = true | |
| Boolean value true when page region check is active. More... | |
| $pdflayers = array() | |
| Array of PDF layers data. More... | |
| $dests = array() | |
| A dictionary of names and corresponding destinations (Dests key on document Catalog). More... | |
| $n_dests | |
| Object ID for Named Destinations. More... | |
| $efnames = array() | |
| Embedded Files Names. More... | |
| $svgdir = '' | |
| Directory used for the last SVG image. More... | |
| $svgunit = 'px' | |
| Deafult unit of measure for SVG. More... | |
| $svggradients = array() | |
| Array of SVG gradients. More... | |
| $svggradientid = 0 | |
| ID of last SVG gradient. More... | |
| $svgdefsmode = false | |
| Boolean value true when in SVG defs group. More... | |
| $svgdefs = array() | |
| Array of SVG defs. More... | |
| $svgclipmode = false | |
| Boolean value true when in SVG clipPath tag. More... | |
| $svgclippaths = array() | |
| Array of SVG clipPath commands. More... | |
| $svgcliptm = array() | |
| Array of SVG clipPath tranformation matrix. More... | |
| $svgclipid = 0 | |
| ID of last SVG clipPath. More... | |
| $svgtext = '' | |
| SVG text. More... | |
| $svgtextmode = array() | |
| SVG text properties. More... | |
| $svgstyles | |
| Array of SVG properties. More... | |
| $force_srgb = false | |
| If true force sRGB color profile for all document. More... | |
| $pdfa_mode = false | |
| If true set the document to PDF/A mode. More... | |
| $doc_creation_timestamp | |
| Document creation date-time. More... | |
| $doc_modification_timestamp | |
| Document modification date-time. More... | |
| $custom_xmp = '' | |
| Custom XMP data. More... | |
| $overprint = array('OP' => false, 'op' => false, 'OPM' => 0) | |
| Overprint mode array. More... | |
| $alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => false) | |
| Alpha mode array. More... | |
| $page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox') | |
| Define the page boundaries boxes to be set on document. More... | |
| $tcpdflink = true | |
| If true print TCPDF meta link. More... | |
| $gdgammacache = array() | |
| Cache array for computed GD gamma values. More... | |
Detailed Description
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.
Constructor & Destructor Documentation
◆ __construct()
| 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).
IMPORTANT: Please note that this method sets the mb_internal_encoding to ASCII, so if you are using the mbstring module functions with TCPDF you need to correctly set/unset the mb_internal_encoding when needed.
- Parameters
-
$orientation (string) page orientation. Possible values are (case insensitive): - P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
$unit (string) User measure unit. Possible values are: - pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.$format (mixed) 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) DEPRECATED FEATURE $pdfa (boolean) If TRUE set the document to PDF/A mode.
- See also
- getPageSizeFromFormat(), setPageFormat()
Definition at line 1838 of file tcpdf.php.
1838 {
1839 /* Set internal character encoding to ASCII */
1840 if (function_exists('mb_internal_encoding') AND mb_internal_encoding()) {
1841 $this->internal_encoding = mb_internal_encoding();
1842 mb_internal_encoding('ASCII');
1843 }
1844 // set file ID for trailer
1845 $serformat = (is_array($format) ? json_encode($format) : $format);
1846 $this->file_id = md5(TCPDF_STATIC::getRandomSeed('TCPDF'.$orientation.$unit.$serformat.$encoding));
1847 $this->font_obj_ids = array();
1848 $this->page_obj_id = array();
1849 $this->form_obj_id = array();
1850 // set pdf/a mode
1851 $this->pdfa_mode = $pdfa;
1852 $this->force_srgb = false;
1853 // set language direction
1854 $this->rtl = false;
1855 $this->tmprtl = false;
1856 // some checks
1857 $this->_dochecks();
1858 // initialization of properties
1859 $this->isunicode = $unicode;
1860 $this->page = 0;
1861 $this->transfmrk[0] = array();
1862 $this->pagedim = array();
1863 $this->n = 2;
1864 $this->buffer = '';
1865 $this->pages = array();
1866 $this->state = 0;
1867 $this->fonts = array();
1868 $this->FontFiles = array();
1869 $this->diffs = array();
1870 $this->images = array();
1871 $this->links = array();
1872 $this->gradients = array();
1873 $this->InFooter = false;
1874 $this->lasth = 0;
1876 $this->FontStyle = '';
1877 $this->FontSizePt = 12;
1878 $this->underline = false;
1879 $this->overline = false;
1880 $this->linethrough = false;
1881 $this->DrawColor = '0 G';
1882 $this->FillColor = '0 g';
1883 $this->TextColor = '0 g';
1884 $this->ColorFlag = false;
1885 $this->pdflayers = array();
1886 // encryption values
1887 $this->encrypted = false;
1888 $this->last_enc_key = '';
1889 // standard Unicode fonts
1890 $this->CoreFonts = array(
1891 'courier'=>'Courier',
1892 'courierB'=>'Courier-Bold',
1893 'courierI'=>'Courier-Oblique',
1894 'courierBI'=>'Courier-BoldOblique',
1895 'helvetica'=>'Helvetica',
1896 'helveticaB'=>'Helvetica-Bold',
1897 'helveticaI'=>'Helvetica-Oblique',
1898 'helveticaBI'=>'Helvetica-BoldOblique',
1899 'times'=>'Times-Roman',
1900 'timesB'=>'Times-Bold',
1901 'timesI'=>'Times-Italic',
1902 'timesBI'=>'Times-BoldItalic',
1903 'symbol'=>'Symbol',
1904 'zapfdingbats'=>'ZapfDingbats'
1905 );
1906 // set scale factor
1907 $this->setPageUnit($unit);
1908 // set page format and orientation
1909 $this->setPageFormat($format, $orientation);
1910 // page margins (1 cm)
1911 $margin = 28.35 / $this->k;
1912 $this->SetMargins($margin, $margin);
1913 $this->clMargin = $this->lMargin;
1914 $this->crMargin = $this->rMargin;
1915 // internal cell padding
1916 $cpadding = $margin / 10;
1917 $this->setCellPaddings($cpadding, 0, $cpadding, 0);
1918 // cell margins
1919 $this->setCellMargins(0, 0, 0, 0);
1920 // line width (0.2 mm)
1921 $this->LineWidth = 0.57 / $this->k;
1923 $this->linestyleCap = '0 J';
1924 $this->linestyleJoin = '0 j';
1925 $this->linestyleDash = '[] 0 d';
1926 // automatic page break
1928 // full width display mode
1930 // compression
1931 $this->SetCompression();
1932 // set default PDF version number
1933 $this->setPDFVersion();
1934 $this->tcpdflink = true;
1935 $this->encoding = $encoding;
1936 $this->HREF = array();
1937 $this->getFontsList();
1938 $this->fgcolor = array('R' => 0, 'G' => 0, 'B' => 0);
1939 $this->strokecolor = array('R' => 0, 'G' => 0, 'B' => 0);
1940 $this->bgcolor = array('R' => 255, 'G' => 255, 'B' => 255);
1941 $this->extgstates = array();
1942 $this->setTextShadow();
1943 // signature
1944 $this->sign = false;
1945 $this->tsa_timestamp = false;
1946 $this->tsa_data = array();
1947 $this->signature_appearance = array('page' => 1, 'rect' => '0 0 0 0', 'name' => 'Signature');
1948 $this->empty_signature_appearance = array();
1949 // user's rights
1950 $this->ur['enabled'] = false;
1951 $this->ur['document'] = '/FullSave';
1952 $this->ur['annots'] = '/Create/Delete/Modify/Copy/Import/Export';
1953 $this->ur['form'] = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate';
1954 $this->ur['signature'] = '/Modify';
1955 $this->ur['ef'] = '/Create/Delete/Modify/Import';
1956 $this->ur['formex'] = '';
1957 // set default JPEG quality
1958 $this->jpeg_quality = 75;
1959 // initialize some settings
1961 // set default font
1962 $this->SetFont($this->FontFamily, $this->FontStyle, $this->FontSizePt);
1963 $this->setHeaderFont(array($this->FontFamily, $this->FontStyle, $this->FontSizePt));
1964 $this->setFooterFont(array($this->FontFamily, $this->FontStyle, $this->FontSizePt));
1965 // check if PCRE Unicode support is enabled
1966 if ($this->isunicode AND (@preg_match('/\pL/u', 'a') == 1)) {
1967 // PCRE unicode support is turned ON
1968 // \s : any whitespace character
1969 // \p{Z} : any separator
1970 // \p{Lo} : Unicode letter or ideograph that does not have lowercase and uppercase variants. Is used to chunk chinese words.
1971 // \xa0 : Unicode Character 'NO-BREAK SPACE' (U+00A0)
1972 //$this->setSpacesRE('/(?!\xa0)[\s\p{Z}\p{Lo}]/u');
1974 } else {
1975 // PCRE unicode support is turned OFF
1977 }
1978 $this->default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128));
1979 // set document creation and modification timestamp
1980 $this->doc_creation_timestamp = time();
1981 $this->doc_modification_timestamp = $this->doc_creation_timestamp;
1982 // get default graphic vars
1983 $this->default_graphic_vars = $this->getGraphicVars();
1984 $this->header_xobj_autoreset = false;
1985 $this->custom_xmp = '';
1986 // Call cleanup method after script execution finishes or exit() is called.
1987 // NOTE: This will not be executed if the process is killed with a SIGTERM or SIGKILL signal.
1988 register_shutdown_function(array($this, '_destroy'), true);
1989 }
static utf8Bidi($ta, $str='', $forcertl=false, $isunicode=true, &$currentfont)
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Definition: tcpdf_fonts.php:2088
static getRandomSeed($seed='')
Returns a string containing random data to be used as a seed for encryption methods.
Definition: tcpdf_static.php:407
setPDFVersion($version='1.7')
Set the PDF version (check PDF reference for valid values).
Definition: tcpdf.php:13993
SetAutoPageBreak($auto, $margin=0)
Enables or disables the automatic page breaking mode.
Definition: tcpdf.php:2790
setCellMargins($left='', $top='', $right='', $bottom='')
Set the internal Cell margins.
Definition: tcpdf.php:2682
setSpacesRE($re='/[^\S\xa0]/')
Set regular expression to detect withespaces or word separators.
Definition: tcpdf.php:2323
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.
Definition: tcpdf.php:21902
setPageFormat($format, $orientation='P')
Change the format of the current page.
Definition: tcpdf.php:2103
SetMargins($left, $top, $right=-1, $keepmargins=false)
Defines the left, top and right margins.
Definition: tcpdf.php:2561
setCellPaddings($left='', $top='', $right='', $bottom='')
Set the internal Cell paddings.
Definition: tcpdf.php:2646
SetDisplayMode($zoom, $layout='SinglePage', $mode='UseNone')
Defines the way the document is to be displayed by the viewer.
Definition: tcpdf.php:2814
SetFont($family, $style='', $size=null, $fontfile='', $subset='default', $out=true)
Sets the font used to print character strings.
Definition: tcpdf.php:4427
References $doc_creation_timestamp, $encoding, $k, $lMargin, $rMargin, _dochecks(), defined, getFontsList(), getGraphicVars(), TCPDF_STATIC\getRandomSeed(), PDF_FONT_NAME_MAIN, SetAutoPageBreak(), setCellMargins(), setCellPaddings(), SetCompression(), SetDisplayMode(), SetFont(), setFooterFont(), setHeaderFont(), SetMargins(), setPageFormat(), setPageUnit(), setPDFVersion(), setSpacesRE(), setTextShadow(), sprintf, and TCPDF_FONTS\utf8Bidi().
Here is the call graph for this function:
◆ __destruct()
| TCPDF::__destruct | ( | ) |
Default destructor.
- Since
- 1.53.0.TC016
Definition at line 1996 of file tcpdf.php.
1996 {
1997 // restore internal encoding
1998 if (isset($this->internal_encoding) AND !empty($this->internal_encoding)) {
1999 mb_internal_encoding($this->internal_encoding);
2000 }
2001 // cleanup
2003 }
_destroy($destroyall=false, $preserve_objcopy=false)
Unset all class variables except the following critical variables.
Definition: tcpdf.php:7756
References _destroy().
Here is the call graph for this function:
Member Function Documentation
◆ _addfield()
|
protected |
Adds a javascript form field.
- Parameters
-
$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.
- Since
- 2.1.002 (2008-02-12)
Definition at line 12580 of file tcpdf.php.
12580 {
12581 if ($this->rtl) {
12583 }
12584 // the followind avoid fields duplication after saving the document
12585 $this->javascript .= "if (getField('tcpdfdocsaved').value != 'saved') {";
12587 $this->javascript .= sprintf("f".$name."=this.addField('%s','%s',%u,[%F,%F,%F,%F]);", $name, $type, $this->PageNo()-1, $x*$k, ($this->h-$y)*$k+1, ($x+$w)*$k, ($this->h-$y-$h)*$k+1)."\n";
12588 $this->javascript .= 'f'.$name.'.textSize='.$this->FontSizePt.";\n";
12589 while (list($key, $val) = each($prop)) {
12590 if (strcmp(substr($key, -5), 'Color') == 0) {
12591 $val = TCPDF_COLORS::_JScolor($val);
12592 } else {
12593 $val = "'".$val."'";
12594 }
12595 $this->javascript .= 'f'.$name.'.'.$key.'='.$val.";\n";
12596 }
12597 if ($this->rtl) {
12598 $this->x -= $w;
12599 } else {
12600 $this->x += $w;
12601 }
12602 $this->javascript .= '}';
12603 }
References $h, $k, $w, $x, $y, TCPDF_COLORS\_JScolor(), and sprintf.
Referenced by Button(), ListBox(), RadioButton(), and TextField().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _beginpage()
|
protected |
Initialize a new page.
- Parameters
-
$orientation (string) page orientation. Possible values are (case insensitive): - P or PORTRAIT (default)
- L or LANDSCAPE
$format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
- See also
- getPageSizeFromFormat(), setPageFormat()
Definition at line 10009 of file tcpdf.php.
10009 {
10010 ++$this->page;
10011 $this->pageobjects[$this->page] = array();
10013 // initialize array for graphics tranformation positions inside a page buffer
10014 $this->transfmrk[$this->page] = array();
10015 $this->state = 2;
10017 if (isset($this->CurOrientation)) {
10018 $orientation = $this->CurOrientation;
10019 } elseif ($this->fwPt > $this->fhPt) {
10020 // landscape
10021 $orientation = 'L';
10022 } else {
10023 // portrait
10024 $orientation = 'P';
10025 }
10026 }
10028 $this->pagedim[$this->page] = $this->pagedim[($this->page - 1)];
10029 $this->setPageOrientation($orientation);
10030 } else {
10031 $this->setPageFormat($format, $orientation);
10032 }
10033 if ($this->rtl) {
10034 $this->x = $this->w - $this->rMargin;
10035 } else {
10036 $this->x = $this->lMargin;
10037 }
10038 $this->y = $this->tMargin;
10039 if (isset($this->newpagegroup[$this->page])) {
10040 // start a new group
10041 $this->currpagegroup = $this->newpagegroup[$this->page];
10042 $this->pagegroups[$this->currpagegroup] = 1;
10043 } elseif (isset($this->currpagegroup) AND ($this->currpagegroup > 0)) {
10044 ++$this->pagegroups[$this->currpagegroup];
10045 }
10046 }
setPageOrientation($orientation, $autopagebreak='', $bottommargin='')
Set page orientation.
Definition: tcpdf.php:2217
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:
◆ _datastring()
|
protected |
Format a data string for meta information.
- Parameters
-
$s (string) data string to escape. $n (int) object ID
- Returns
- string escaped string.
Definition at line 10168 of file tcpdf.php.
10168 {
10171 }
10174 }
References $n, _encrypt_data(), and TCPDF_STATIC\_escape().
Referenced by _datestring(), _putannotsobjs(), and _textstring().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _datestring()
|
protected |
Returns a formatted date for meta information.
- Parameters
-
$n (int) Object ID. $timestamp (int) Timestamp to convert.
- Returns
- string escaped date string.
- Since
- 4.6.028 (2009-08-25)
Definition at line 10230 of file tcpdf.php.
10230 {
10233 }
10235 }
References $doc_creation_timestamp, $n, $timestamp, _datastring(), and TCPDF_STATIC\getFormattedDate().
Here is the call graph for this function:
◆ _destroy()
| TCPDF::_destroy | ( | $destroyall = false, |
|
$preserve_objcopy = false |
|||
| ) |
Unset all class variables except the following critical variables.
- Parameters
-
$destroyall (boolean) if true destroys all class variables, otherwise preserves critical variables. $preserve_objcopy (boolean) if true preserves the objcopy variable
- Since
- 4.5.016 (2009-02-24)
Definition at line 7756 of file tcpdf.php.
7756 {
7757 if ($destroyall AND !$preserve_objcopy) {
7758 // remove all temporary files
7760 if (!empty($tmpfiles)) {
7761 array_map('unlink', $tmpfiles);
7762 }
7763 }
7764 $preserve = array(
7765 'file_id',
7766 'internal_encoding',
7767 'state',
7768 'bufferlen',
7769 'buffer',
7770 'cached_files',
7771 'sign',
7772 'signature_data',
7773 'signature_max_length',
7774 'byterange_string',
7775 'tsa_timestamp',
7776 'tsa_data'
7777 );
7778 foreach (array_keys(get_object_vars($this)) as $val) {
7779 if ($destroyall OR !in_array($val, $preserve)) {
7780 if ((!$preserve_objcopy OR ($val != 'objcopy')) AND ($val != 'file_id') AND isset($this->$val)) {
7781 unset($this->$val);
7782 }
7783 }
7784 }
7785 }
const K_PATH_CACHE
Cache directory for temporary files (full path).
Definition: tcpdf_config_alt.php:82
References K_PATH_CACHE.
Referenced by __destruct(), Close(), and Error().
Here is the caller graph for this function:
◆ _dochecks()
|
protected |
Check for locale-related bug.
Definition at line 7791 of file tcpdf.php.
7791 {
7792 //Check for locale-related bug
7793 if (1.1 == 1) {
7795 }
7796 //Check for decimal separator
7798 setlocale(LC_NUMERIC, 'C');
7799 }
7800 }
Error($msg)
Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR cons...
Definition: tcpdf.php:2921
References Error(), and sprintf.
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _dolinethrough()
|
protected |
Line through text.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $txt (string) text to linethrough
Definition at line 10116 of file tcpdf.php.
10116 {
10119 }
GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false)
Returns the length of a string in user unit.
Definition: tcpdf.php:4032
References $txt, $w, $x, $y, _dolinethroughw(), and GetStringWidth().
Here is the call graph for this function:
◆ _dolinethroughw()
|
protected |
Line through for rectangular text area.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $w (int) line length (width)
- Since
- 4.9.008 (2009-09-29)
Definition at line 10129 of file tcpdf.php.
10129 {
10131 return sprintf('%F %F %F %F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew + ($this->FontSizePt / 3)), $w * $this->k, $linew);
10132 }
References $FontSizePt, $w, $x, $y, and sprintf.
Referenced by _dolinethrough().
Here is the caller graph for this function:
◆ _dooverline()
|
protected |
Overline text.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $txt (string) text to overline
- Since
- 4.9.015 (2010-04-19)
Definition at line 10142 of file tcpdf.php.
10142 {
10145 }
References $txt, $w, $x, $y, _dooverlinew(), and GetStringWidth().
Here is the call graph for this function:
◆ _dooverlinew()
|
protected |
Overline for rectangular text area.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $w (int) width to overline
- Since
- 4.9.015 (2010-04-19)
Definition at line 10155 of file tcpdf.php.
10155 {
10157 return sprintf('%F %F %F %F re f', $x * $this->k, (($this->h - $y + $this->FontAscent) * $this->k) - $linew, $w * $this->k, $linew);
10158
10159 }
References $FontSizePt, $w, $x, $y, and sprintf.
Referenced by _dooverline().
Here is the caller graph for this function:
◆ _dounderline()
|
protected |
Underline text.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $txt (string) text to underline
Definition at line 10091 of file tcpdf.php.
10091 {
10094 }
References $txt, $w, $x, $y, _dounderlinew(), and GetStringWidth().
Here is the call graph for this function:
◆ _dounderlinew()
|
protected |
Underline for rectangular text area.
- Parameters
-
$x (int) X coordinate $y (int) Y coordinate $w (int) width to underline
- Since
- 4.8.008 (2009-09-29)
Definition at line 10104 of file tcpdf.php.
10104 {
10106 return sprintf('%F %F %F %F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew), $w * $this->k, $linew);
10107 }
References $FontSizePt, $w, $x, $y, and sprintf.
Referenced by _dounderline().
Here is the caller graph for this function:
◆ _encrypt_data()
|
protected |
Encrypt the input string.
- Parameters
-
$n (int) object number $s (string) data string to encrypt
- Returns
- encrypted string
- Since
- 5.0.005 (2010-05-11)
Definition at line 10462 of file tcpdf.php.
10462 {
10463 if (!$this->encrypted) {
10464 return $s;
10465 }
10466 switch ($this->encryptdata['mode']) {
10467 case 0: // RC4-40
10468 case 1: { // RC4-128
10469 $s = TCPDF_STATIC::_RC4($this->_objectkey($n), $s, $this->last_enc_key, $this->last_enc_key_c);
10470 break;
10471 }
10472 case 2: { // AES-128
10474 break;
10475 }
10476 case 3: { // AES-256
10478 break;
10479 }
10480 }
10481 return $s;
10482 }
static _AES($key, $text)
Returns the input text exrypted using AES algorithm and the specified key.
Definition: tcpdf_static.php:444
static _RC4($key, $text, &$last_enc_key, &$last_enc_key_c)
Returns the input text encrypted using RC4 algorithm and the specified key.
Definition: tcpdf_static.php:492
_objectkey($n)
Compute encryption key depending on object number where the encrypted data is stored.
Definition: tcpdf.php:10442
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:
◆ _enddoc()
|
protected |
Output end of document (EOF).
Definition at line 9918 of file tcpdf.php.
9918 {
9919 if (isset($this->CurrentFont['fontkey']) AND isset($this->CurrentFont['subsetchars'])) {
9920 // save subset chars of the previous font
9921 $this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
9922 }
9923 $this->state = 1;
9924 $this->_putheader();
9925 $this->_putpages();
9926 $this->_putresources();
9927 // empty signature fields
9928 if (!empty($this->empty_signature_appearance)) {
9929 foreach ($this->empty_signature_appearance as $key => $esa) {
9930 // widget annotation for empty signature
9938 $signame = $esa['name'].sprintf(' [%03d]', ($key + 1));
9944 }
9945 }
9946 // Signature
9947 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9948 // widget annotation for signature
9953 $out .= ' /P '.$this->page_obj_id[($this->signature_appearance['page'])].' 0 R'; // link to signature appearance page
9962 // signature
9963 $this->_putsignature();
9964 }
9965 // Info
9966 $objid_info = $this->_putinfo();
9967 // Catalog
9968 $objid_catalog = $this->_putcatalog();
9969 // Cross-ref
9970 $o = $this->bufferlen;
9971 // XREF section
9975 $freegen = ($this->n + 2);
9977 if (!isset($this->offsets[$i]) AND ($i > 1)) {
9979 ++$freegen;
9980 } else {
9982 }
9983 }
9984 // TRAILER
9990 if ($this->encrypted) {
9992 }
9997 $this->_out($o);
9999 $this->state = 3; // end-of-doc
10000 }
_putsignature()
Add certification signature (DocMDP or UR3) You can set only one signature type.
Definition: tcpdf.php:13289
_getobj($objid='')
Return the starting object string for the selected object ID.
Definition: tcpdf.php:10074
_putinfo()
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3....
Definition: tcpdf.php:9451
References $bufferlen, $n, $out, _getobj(), _out(), _putcatalog(), _putheader(), _putinfo(), _putpages(), _putresources(), _putsignature(), setFontSubBuffer(), and sprintf.
Referenced by Close().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _endpage()
|
protected |
Mark end of page.
Definition at line 10052 of file tcpdf.php.
10052 {
10054 $this->state = 1;
10055 }
References setVisibility().
Referenced by endPage().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _fixAES256Password()
|
protected |
Convert password for AES-256 encryption mode.
- Parameters
-
$password (string) password
- Returns
- string password
- Since
- 5.9.006 (2010-10-19)
Definition at line 10706 of file tcpdf.php.
10706 {
10707 $psw = ''; // password to be returned
10708 $psw_array = TCPDF_FONTS::utf8Bidi(TCPDF_FONTS::UTF8StringToArray($password, $this->isunicode, $this->CurrentFont), $password, $this->rtl, $this->isunicode, $this->CurrentFont);
10709 foreach ($psw_array as $c) {
10710 $psw .= TCPDF_FONTS::unichr($c, $this->isunicode);
10711 }
10712 return substr($psw, 0, 127);
10713 }
static unichr($c, $unicode=true)
Returns the unicode caracter specified by the value.
Definition: tcpdf_fonts.php:1666
static UTF8StringToArray($str, $isunicode=true, &$currentfont)
Converts UTF-8 strings to codepoints array.
Definition: tcpdf_fonts.php:1997
References TCPDF_FONTS\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:
◆ _generateencryptionkey()
|
protected |
Compute encryption key.
- Since
- 2.0.000 (2008-01-02)
Definition at line 10721 of file tcpdf.php.
10721 {
10722 $keybytelen = ($this->encryptdata['Length'] / 8);
10723 if (!$this->encryptdata['pubkey']) { // standard mode
10724 if ($this->encryptdata['mode'] == 3) { // AES-256
10725 // generate 256 bit random key
10726 $this->encryptdata['key'] = substr(hash('sha256', TCPDF_STATIC::getRandomSeed(), true), 0, $keybytelen);
10727 // truncate passwords
10728 $this->encryptdata['user_password'] = $this->_fixAES256Password($this->encryptdata['user_password']);
10729 $this->encryptdata['owner_password'] = $this->_fixAES256Password($this->encryptdata['owner_password']);
10730 // Compute U value
10732 // Compute UE value
10734 // Compute O value
10736 // Compute OE value
10738 // Compute P value
10739 $this->encryptdata['P'] = $this->encryptdata['protection'];
10740 // Computing the encryption dictionary's Perms (permissions) value
10741 $perms = TCPDF_STATIC::getEncPermissionsString($this->encryptdata['protection']); // bytes 0-3
10742 $perms .= chr(255).chr(255).chr(255).chr(255); // bytes 4-7
10743 if (isset($this->encryptdata['CF']['EncryptMetadata']) AND (!$this->encryptdata['CF']['EncryptMetadata'])) { // byte 8
10744 $perms .= 'F';
10745 } else {
10746 $perms .= 'T';
10747 }
10748 $perms .= 'adb'; // bytes 9-11
10749 $perms .= 'nick'; // bytes 12-15
10751 } else { // RC4-40, RC4-128, AES-128
10752 // Pad passwords
10753 $this->encryptdata['user_password'] = substr($this->encryptdata['user_password'].TCPDF_STATIC::$enc_padding, 0, 32);
10754 $this->encryptdata['owner_password'] = substr($this->encryptdata['owner_password'].TCPDF_STATIC::$enc_padding, 0, 32);
10755 // Compute O value
10757 // get default permissions (reverse byte order)
10759 // Compute encryption key
10760 $tmp = TCPDF_STATIC::_md5_16($this->encryptdata['user_password'].$this->encryptdata['O'].$permissions.$this->encryptdata['fileid']);
10761 if ($this->encryptdata['mode'] > 0) {
10762 for ($i = 0; $i < 50; ++$i) {
10763 $tmp = TCPDF_STATIC::_md5_16(substr($tmp, 0, $keybytelen));
10764 }
10765 }
10766 $this->encryptdata['key'] = substr($tmp, 0, $keybytelen);
10767 // Compute U value
10769 // Compute P value
10770 $this->encryptdata['P'] = $this->encryptdata['protection'];
10771 }
10772 } else { // Public-Key mode
10773 // random 20-byte seed
10775 $recipient_bytes = '';
10776 foreach ($this->encryptdata['pubkeys'] as $pubkey) {
10777 // for each public certificate
10778 if (isset($pubkey['p'])) {
10779 $pkprotection = TCPDF_STATIC::getUserPermissionCode($pubkey['p'], $this->encryptdata['mode']);
10780 } else {
10781 $pkprotection = $this->encryptdata['protection'];
10782 }
10783 // get default permissions (reverse byte order)
10784 $pkpermissions = TCPDF_STATIC::getEncPermissionsString($pkprotection);
10785 // envelope data
10786 $envelope = $seed.$pkpermissions;
10787 // write the envelope data to a temporary file
10790 if (!$f) {
10792 }
10793 $envelope_length = strlen($envelope);
10794 fwrite($f, $envelope, $envelope_length);
10795 fclose($f);
10797 if (!openssl_pkcs7_encrypt($tempkeyfile, $tempencfile, $pubkey['c'], array(), PKCS7_BINARY | PKCS7_DETACHED)) {
10799 }
10800 // read encryption signature
10801 $signature = file_get_contents($tempencfile, false, null, $envelope_length);
10802 // extract signature
10803 $signature = substr($signature, strpos($signature, 'Content-Disposition'));
10804 $tmparr = explode("\n\n", $signature);
10805 $signature = trim($tmparr[1]);
10806 unset($tmparr);
10807 // decode signature
10808 $signature = base64_decode($signature);
10809 // convert signature to hex
10810 $hexsignature = current(unpack('H*', $signature));
10811 // store signature on recipients array
10812 $this->encryptdata['Recipients'][] = $hexsignature;
10813 // The bytes of each item in the Recipients array of PKCS#7 objects in the order in which they appear in the array
10814 $recipient_bytes .= $signature;
10815 }
10816 // calculate encryption key
10817 if ($this->encryptdata['mode'] == 3) { // AES-256
10818 $this->encryptdata['key'] = substr(hash('sha256', $seed.$recipient_bytes, true), 0, $keybytelen);
10819 } else { // RC4-40, RC4-128, AES-128
10820 $this->encryptdata['key'] = substr(sha1($seed.$recipient_bytes, true), 0, $keybytelen);
10821 }
10822 }
10823 }
static fopenLocal($filename, $mode)
Wrapper to use fopen only with local files.
Definition: tcpdf_static.php:1848
static getUserPermissionCode($permissions, $mode=0)
Return the permission code used on encryption (P value).
Definition: tcpdf_static.php:536
static getEncPermissionsString($protection)
Convert encryption P value to a string of bytes, low-order byte first.
Definition: tcpdf_static.php:612
static getObjFilename($type='tmp', $file_id='')
Returns a temporary filename for caching object on filesystem.
Definition: tcpdf_static.php:295
static _AESnopad($key, $text)
Returns the input text exrypted using AES algorithm and the specified key.
Definition: tcpdf_static.php:469
static _md5_16($str)
Encrypts a string using MD5 and returns it's value as a binary string.
Definition: tcpdf_static.php:430
_fixAES256Password($password)
Convert password for AES-256 encryption mode.
Definition: tcpdf.php:10706
References TCPDF_STATIC\$enc_padding, TCPDF_STATIC\_AESnopad(), _fixAES256Password(), TCPDF_STATIC\_md5_16(), _OEvalue(), _Ovalue(), _UEvalue(), _Uvalue(), Error(), TCPDF_STATIC\fopenLocal(), 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:
◆ _getannotsrefs()
|
protected |
Get references to page annotations.
- Parameters
-
$n (int) page number
- Returns
- string
- Since
- 5.0.010 (2010-05-17)
Definition at line 8057 of file tcpdf.php.
8057 {
8058 if (!(isset($this->PageAnnots[$n]) OR ($this->sign AND isset($this->signature_data['cert_type'])))) {
8059 return '';
8060 }
8064 if (!in_array($val['n'], $this->radio_groups)) {
8066 }
8067 }
8068 // add radiobutton groups
8073 }
8074 }
8075 }
8076 }
8077 if ($this->sign AND ($n == $this->signature_appearance['page']) AND isset($this->signature_data['cert_type'])) {
8078 // set reference for signature object
8080 }
8081 if (!empty($this->empty_signature_appearance)) {
8082 foreach ($this->empty_signature_appearance as $esa) {
8084 // set reference for empty signature objects
8086 }
8087 }
8088 }
8091 }
References $data, $n, and $out.
Referenced by _putpages().
Here is the caller graph for this function:
◆ _getobj()
|
protected |
Return the starting object string for the selected object ID.
- Parameters
-
$objid (int) Object ID (leave empty to get a new ID).
- Returns
- string the starting object string
- Since
- 5.8.009 (2010-08-20)
Definition at line 10074 of file tcpdf.php.
10074 {
10075 if ($objid === '') {
10076 ++$this->n;
10077 $objid = $this->n;
10078 }
10079 $this->offsets[$objid] = $this->bufferlen;
10080 $this->pageobjects[$this->page][] = $objid;
10081 return $objid.' 0 obj';
10082 }
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:
◆ _getrawstream()
|
protected |
get raw output stream.
- Parameters
-
$s (string) string to output. $n (int) object reference for encryption mode
- Since
- 5.5.000 (2010-06-22)
Definition at line 10260 of file tcpdf.php.
10260 {
10262 // default to current object
10264 }
10266 }
References $n, and _encrypt_data().
Referenced by _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:
◆ _getxobjectdict()
|
protected |
Return XObjects Dictionary.
- Returns
- string XObjects dictionary
- Since
- 5.8.014 (2010-08-23)
Definition at line 9352 of file tcpdf.php.
9352 {
9354 foreach ($this->xobjects as $id => $objid) {
9356 }
9358 }
References $out.
Referenced by _putresourcedict().
Here is the caller graph for this function:
◆ _newobj()
|
protected |
Begin a new object and return the object number.
- Returns
- int object number
Definition at line 10062 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:
◆ _objectkey()
|
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.
- Parameters
-
$n (int) object number
- Returns
- int object key
- Since
- 2.0.000 (2008-01-02)
Definition at line 10442 of file tcpdf.php.
10442 {
10444 if ($this->encryptdata['mode'] == 2) { // AES-128
10445 // AES padding
10446 $objkey .= "\x73\x41\x6C\x54"; // sAlT
10447 }
10448 $objkey = substr(TCPDF_STATIC::_md5_16($objkey), 0, (($this->encryptdata['Length'] / 8) + 5));
10449 $objkey = substr($objkey, 0, 16);
10450 return $objkey;
10451 }
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:
◆ _OEvalue()
|
protected |
Compute OE value (used for encryption)
- Returns
- string OE value
- Since
- 5.9.006 (2010-10-19)
Definition at line 10693 of file tcpdf.php.
10693 {
10694 $hashkey = hash('sha256', $this->encryptdata['owner_password'].$this->encryptdata['OKS'].$this->encryptdata['U'], true);
10696 }
References TCPDF_STATIC\_AESnopad().
Referenced by _generateencryptionkey().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _out()
|
protected |
Output a string to the document.
- Parameters
-
$s (string) string to output.
Definition at line 10273 of file tcpdf.php.
10273 {
10274 if ($this->state == 2) {
10275 if ($this->inxobj) {
10276 // we are inside an XObject template
10278 } elseif ((!$this->InFooter) AND isset($this->footerlen[$this->page]) AND ($this->footerlen[$this->page] > 0)) {
10279 // puts data before page footer
10280 $pagebuff = $this->getPageBuffer($this->page);
10281 $page = substr($pagebuff, 0, -$this->footerlen[$this->page]);
10282 $footer = substr($pagebuff, -$this->footerlen[$this->page]);
10284 // update footer position
10286 } else {
10287 // set page data
10289 }
10290 } elseif ($this->state > 0) {
10291 // set general data
10293 }
10294 }
References $page, $xobjid, getPageBuffer(), setBuffer(), and setPageBuffer().
Referenced by _enddoc(), _newobj(), _outCurve(), _outCurveV(), _outCurveY(), _outLine(), _outPoint(), _outRect(), _putannotsobjs(), _putAPXObject(), _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putheader(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putresourcedict(), _putshaders(), _putsignature(), _putspotcolors(), _puttruetypeunicode(), _putXMP(), _putxobjects(), Cell(), Clip(), CoonsPatchMesh(), Curve(), Ellipse(), endLayer(), Gradient(), Image(), ImageEps(), Line(), PieSectorXY(), Polycurve(), Polygon(), RoundedRectXY(), setColor(), setExtGState(), SetFontSize(), setFooter(), SetLineStyle(), SetLineWidth(), setSpotColor(), setVisibility(), startLayer(), and Transform().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _outCurve()
|
protected |
Append a cubic Bezier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bezier control points. The new current point shall be (x3, y3).
- Parameters
-
$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.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11432 of file tcpdf.php.
11432 {
11433 if ($this->state == 2) {
11434 $this->_out(sprintf('%F %F %F %F %F %F c', ($x1 * $this->k), (($this->h - $y1) * $this->k), ($x2 * $this->k), (($this->h - $y2) * $this->k), ($x3 * $this->k), (($this->h - $y3) * $this->k)));
11435 }
11436 }
References _out(), and sprintf.
Referenced by _outellipticalarc(), Curve(), Polycurve(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _outCurveV()
|
protected |
Append a cubic Bezier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bezier control points. The new current point shall be (x3, y3).
- Parameters
-
$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.
- Since
- 4.9.019 (2010-04-26)
Definition at line 11448 of file tcpdf.php.
11448 {
11449 if ($this->state == 2) {
11450 $this->_out(sprintf('%F %F %F %F v', ($x2 * $this->k), (($this->h - $y2) * $this->k), ($x3 * $this->k), (($this->h - $y3) * $this->k)));
11451 }
11452 }
References _out(), and sprintf.
Here is the call graph for this function:
◆ _outCurveY()
|
protected |
Append a cubic Bezier curve to the current path.
The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bezier control points. The new current point shall be (x3, y3).
- Parameters
-
$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.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11464 of file tcpdf.php.
11464 {
11465 if ($this->state == 2) {
11466 $this->_out(sprintf('%F %F %F %F y', ($x1 * $this->k), (($this->h - $y1) * $this->k), ($x3 * $this->k), (($this->h - $y3) * $this->k)));
11467 }
11468 }
References _out(), and sprintf.
Here is the call graph for this function:
◆ _outellipticalarc()
|
protected |
Append an elliptical arc to the current path.
An ellipse is formed from n Bezier curves.
- Parameters
-
$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).
- Returns
- array bounding box coordinates (x min, y min, x max, y max)
- Since
- 4.9.019 (2010-04-26)
Definition at line 11693 of file tcpdf.php.
11693 {
11694 if (($rx <= 0) OR ($ry < 0)) {
11695 return;
11696 }
11698 if ($nc < 2) {
11699 $nc = 2;
11700 }
11701 $xmin = 2147483647;
11702 $ymin = 2147483647;
11703 $xmax = 0;
11704 $ymax = 0;
11705 if ($pie) {
11706 // center of the arc
11708 }
11709 $xang = deg2rad((float) $xang);
11710 $angs = deg2rad((float) $angs);
11711 $angf = deg2rad((float) $angf);
11712 if ($svg) {
11713 $as = $angs;
11714 $af = $angf;
11715 } else {
11716 $as = atan2((sin($angs) / $ry), (cos($angs) / $rx));
11717 $af = atan2((sin($angf) / $ry), (cos($angf) / $rx));
11718 }
11719 if ($as < 0) {
11720 $as += (2 * M_PI);
11721 }
11722 if ($af < 0) {
11723 $af += (2 * M_PI);
11724 }
11725 if ($ccw AND ($as > $af)) {
11726 // reverse rotation
11727 $as -= (2 * M_PI);
11728 } elseif (!$ccw AND ($as < $af)) {
11729 // reverse rotation
11730 $af -= (2 * M_PI);
11731 }
11732 $total_angle = ($af - $as);
11733 if ($nc < 2) {
11734 $nc = 2;
11735 }
11736 // total arcs to draw
11737 $nc *= (2 * abs($total_angle) / M_PI);
11738 $nc = round($nc) + 1;
11739 // angle of each arc
11740 $arcang = ($total_angle / $nc);
11741 // center point in PDF coordinates
11742 $x0 = $xc;
11743 $y0 = ($this->h - $yc);
11744 // starting angle
11745 $ang = $as;
11746 $alpha = sin($arcang) * ((sqrt(4 + (3 * pow(tan(($arcang) / 2), 2))) - 1) / 3);
11747 $cos_xang = cos($xang);
11748 $sin_xang = sin($xang);
11749 $cos_ang = cos($ang);
11750 $sin_ang = sin($ang);
11751 // first arc point
11752 $px1 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
11753 $py1 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
11754 // first Bezier control point
11755 $qx1 = ($alpha * ((-$rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
11756 $qy1 = ($alpha * ((-$rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
11757 if ($pie) {
11758 // line from center to arc starting point
11759 $this->_outLine($px1, $this->h - $py1);
11760 } elseif ($startpoint) {
11761 // arc starting point
11762 $this->_outPoint($px1, $this->h - $py1);
11763 }
11764 // draw arcs
11765 for ($i = 1; $i <= $nc; ++$i) {
11766 // starting angle
11767 $ang = $as + ($i * $arcang);
11768 if ($i == $nc) {
11769 $ang = $af;
11770 }
11771 $cos_ang = cos($ang);
11772 $sin_ang = sin($ang);
11773 // second arc point
11774 $px2 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
11775 $py2 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
11776 // second Bezier control point
11777 $qx2 = ($alpha * ((-$rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
11778 $qy2 = ($alpha * ((-$rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
11779 // draw arc
11780 $cx1 = ($px1 + $qx1);
11781 $cy1 = ($this->h - ($py1 + $qy1));
11782 $cx2 = ($px2 - $qx2);
11783 $cy2 = ($this->h - ($py2 - $qy2));
11784 $cx3 = $px2;
11785 $cy3 = ($this->h - $py2);
11786 $this->_outCurve($cx1, $cy1, $cx2, $cy2, $cx3, $cy3);
11787 // get bounding box coordinates
11788 $xmin = min($xmin, $cx1, $cx2, $cx3);
11789 $ymin = min($ymin, $cy1, $cy2, $cy3);
11790 $xmax = max($xmax, $cx1, $cx2, $cx3);
11791 $ymax = max($ymax, $cy1, $cy2, $cy3);
11792 // move to next point
11793 $px1 = $px2;
11794 $py1 = $py2;
11795 $qx1 = $qx2;
11796 $qy1 = $qy2;
11797 }
11798 if ($pie) {
11800 // get bounding box coordinates
11801 $xmin = min($xmin, $xc);
11802 $ymin = min($ymin, $yc);
11803 $xmax = max($xmax, $xc);
11804 $ymax = max($ymax, $yc);
11805 }
11806 return array($xmin, $ymin, $xmax, $ymax);
11807 }
_outCurve($x1, $y1, $x2, $y2, $x3, $y3)
Append a cubic Bezier curve to the current path.
Definition: tcpdf.php:11432
_outPoint($x, $y)
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line s...
Definition: tcpdf.php:11384
_outLine($x, $y)
Append a straight line segment from the current point to the point (x, y).
Definition: tcpdf.php:11398
References $alpha, $k, $xc, $yc, _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:
◆ _outLine()
|
protected |
Append a straight line segment from the current point to the point (x, y).
The new current point shall be (x, y).
- Parameters
-
$x (float) Abscissa of end point. $y (float) Ordinate of end point.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11398 of file tcpdf.php.
11398 {
11399 if ($this->state == 2) {
11401 }
11402 }
References $x, $y, _out(), and sprintf.
Referenced by _outellipticalarc(), Line(), Polygon(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _outPoint()
|
protected |
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
- Parameters
-
$x (float) Abscissa of point. $y (float) Ordinate of point.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11384 of file tcpdf.php.
11384 {
11385 if ($this->state == 2) {
11387 }
11388 }
References $x, $y, _out(), and sprintf.
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:
◆ _outRect()
|
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.
- Parameters
-
$x (float) Abscissa of upper-left corner. $y (float) Ordinate of upper-left corner. $w (float) Width. $h (float) Height. $op (string) options
- Since
- 2.1.000 (2008-01-08)
Definition at line 11414 of file tcpdf.php.
11414 {
11415 if ($this->state == 2) {
11416 $this->_out(sprintf('%F %F %F %F re %s', ($x * $this->k), (($this->h - $y) * $this->k), ($w * $this->k), (-$h * $this->k), $op));
11417 }
11418 }
References $h, $w, $x, $y, _out(), and sprintf.
Referenced by Rect().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _outRestoreGraphicsState()
|
protected |
Outputs the "restore graphics state" operator 'Q'.
Definition at line 20678 of file tcpdf.php.
Referenced by Close(), CoonsPatchMesh(), Gradient(), setFooter(), setHeader(), and StopTransform().
Here is the caller graph for this function:
◆ _outSaveGraphicsState()
|
protected |
Outputs the "save graphics state" operator 'q'.
Definition at line 20670 of file tcpdf.php.
Referenced by Close(), setFooter(), setHeader(), and StartTransform().
Here is the caller graph for this function:
◆ _Ovalue()
|
protected |
Compute O value (used for encryption)
- Returns
- string O value
- Since
- 2.0.000 (2008-01-02)
Definition at line 10655 of file tcpdf.php.
10655 {
10656 if ($this->encryptdata['mode'] < 3) { // RC4-40, RC4-128, AES-128
10658 if ($this->encryptdata['mode'] > 0) {
10659 for ($i = 0; $i < 50; ++$i) {
10660 $tmp = TCPDF_STATIC::_md5_16($tmp);
10661 }
10662 }
10663 $owner_key = substr($tmp, 0, ($this->encryptdata['Length'] / 8));
10664 $enc = TCPDF_STATIC::_RC4($owner_key, $this->encryptdata['user_password'], $this->last_enc_key, $this->last_enc_key_c);
10665 if ($this->encryptdata['mode'] > 0) {
10666 $len = strlen($owner_key);
10667 for ($i = 1; $i <= 19; ++$i) {
10668 $ek = '';
10669 for ($j = 0; $j < $len; ++$j) {
10670 $ek .= chr(ord($owner_key[$j]) ^ $i);
10671 }
10672 $enc = TCPDF_STATIC::_RC4($ek, $enc, $this->last_enc_key, $this->last_enc_key_c);
10673 }
10674 }
10675 return $enc;
10676 } elseif ($this->encryptdata['mode'] == 3) { // AES-256
10678 // Owner Validation Salt
10679 $this->encryptdata['OVS'] = substr($seed, 0, 8);
10680 // Owner Key Salt
10681 $this->encryptdata['OKS'] = substr($seed, 8, 16);
10682 return hash('sha256', $this->encryptdata['owner_password'].$this->encryptdata['OVS'].$this->encryptdata['U'], true).$this->encryptdata['OVS'].$this->encryptdata['OKS'];
10683 }
10684 }
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:
◆ _putannotsobjs()
|
protected |
Output annotations objects for all pages.
!!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.
- Since
- 4.0.018 (2008-08-06)
Definition at line 8101 of file tcpdf.php.
8101 {
8102 // reset object counter
8105 // set page annotations
8108 // create annotation object for grouping radiobuttons
8109 if (isset($this->radiobutton_groups[$n][$pl['txt']]) AND is_array($this->radiobutton_groups[$n][$pl['txt']])) {
8111 $annots = '<<';
8112 $annots .= ' /Type /Annot';
8113 $annots .= ' /Subtype /Widget';
8114 $annots .= ' /Rect [0 0 0 0]';
8116 // read only
8117 $annots .= ' /F 68';
8118 $annots .= ' /Ff 49153';
8119 } else {
8120 $annots .= ' /F 4'; // default print for PDF/A
8121 $annots .= ' /Ff 49152';
8122 }
8123 $annots .= ' /T '.$this->_datastring($pl['txt'], $radio_button_obj_id);
8124 if (isset($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) {
8125 $annots .= ' /TU '.$this->_datastring($pl['opt']['tu'], $radio_button_obj_id);
8126 }
8127 $annots .= ' /FT /Btn';
8128 $annots .= ' /Kids [';
8129 $defval = '';
8132 $annots .= ' '.$data['kid'].' 0 R';
8135 }
8136 }
8137 }
8138 $annots .= ' ]';
8139 if (!empty($defval)) {
8140 $annots .= ' /V /'.$defval;
8141 }
8142 $annots .= ' >>';
8144 $this->form_obj_id[] = $radio_button_obj_id;
8145 // store object id to be used on Parent entry of Kids
8147 }
8148 $formfield = false;
8149 $pl['opt'] = array_change_key_case($pl['opt'], CASE_LOWER);
8155 // create new annotation object
8156 $annots = '<</Type /Annot';
8157 $annots .= ' /Subtype /'.$pl['opt']['subtype'];
8158 $annots .= ' /Rect ['.$rect.']';
8159 $ft = array('Btn', 'Tx', 'Ch', 'Sig');
8160 if (isset($pl['opt']['ft']) AND in_array($pl['opt']['ft'], $ft)) {
8161 $annots .= ' /FT /'.$pl['opt']['ft'];
8162 $formfield = true;
8163 }
8164 $annots .= ' /Contents '.$this->_textstring($pl['txt'], $annot_obj_id);
8167 $annots .= ' /M '.$this->_datestring($annot_obj_id, $this->doc_modification_timestamp);
8168 if (isset($pl['opt']['f'])) {
8169 $fval = 0;
8170 if (is_array($pl['opt']['f'])) {
8171 foreach ($pl['opt']['f'] as $f) {
8172 switch (strtolower($f)) {
8173 case 'invisible': {
8174 $fval += 1 << 0;
8175 break;
8176 }
8177 case 'hidden': {
8178 $fval += 1 << 1;
8179 break;
8180 }
8181 case 'print': {
8182 $fval += 1 << 2;
8183 break;
8184 }
8185 case 'nozoom': {
8186 $fval += 1 << 3;
8187 break;
8188 }
8189 case 'norotate': {
8190 $fval += 1 << 4;
8191 break;
8192 }
8193 case 'noview': {
8194 $fval += 1 << 5;
8195 break;
8196 }
8197 case 'readonly': {
8198 $fval += 1 << 6;
8199 break;
8200 }
8201 case 'locked': {
8202 $fval += 1 << 8;
8203 break;
8204 }
8205 case 'togglenoview': {
8206 $fval += 1 << 9;
8207 break;
8208 }
8209 case 'lockedcontents': {
8210 $fval += 1 << 10;
8211 break;
8212 }
8213 default: {
8214 break;
8215 }
8216 }
8217 }
8218 } else {
8219 $fval = intval($pl['opt']['f']);
8220 }
8221 } else {
8222 $fval = 4;
8223 }
8224 if ($this->pdfa_mode) {
8225 // force print flag for PDF/A mode
8226 $fval |= 4;
8227 }
8228 $annots .= ' /F '.intval($fval);
8229 if (isset($pl['opt']['as']) AND is_string($pl['opt']['as'])) {
8230 $annots .= ' /AS /'.$pl['opt']['as'];
8231 }
8232 if (isset($pl['opt']['ap'])) {
8233 // appearance stream
8234 $annots .= ' /AP <<';
8235 if (is_array($pl['opt']['ap'])) {
8236 foreach ($pl['opt']['ap'] as $apmode => $apdef) {
8237 // $apmode can be: n = normal; r = rollover; d = down;
8238 $annots .= ' /'.strtoupper($apmode);
8239 if (is_array($apdef)) {
8240 $annots .= ' <<';
8241 foreach ($apdef as $apstate => $stream) {
8242 // reference to XObject that define the appearance for this mode-state
8244 $annots .= ' /'.$apstate.' '.$apsobjid.' 0 R';
8245 }
8246 $annots .= ' >>';
8247 } else {
8248 // reference to XObject that define the appearance for this mode
8250 $annots .= ' '.$apsobjid.' 0 R';
8251 }
8252 }
8253 } else {
8254 $annots .= $pl['opt']['ap'];
8255 }
8256 $annots .= ' >>';
8257 }
8258 if (isset($pl['opt']['bs']) AND (is_array($pl['opt']['bs']))) {
8259 $annots .= ' /BS <<';
8260 $annots .= ' /Type /Border';
8261 if (isset($pl['opt']['bs']['w'])) {
8262 $annots .= ' /W '.intval($pl['opt']['bs']['w']);
8263 }
8264 $bstyles = array('S', 'D', 'B', 'I', 'U');
8265 if (isset($pl['opt']['bs']['s']) AND in_array($pl['opt']['bs']['s'], $bstyles)) {
8266 $annots .= ' /S /'.$pl['opt']['bs']['s'];
8267 }
8268 if (isset($pl['opt']['bs']['d']) AND (is_array($pl['opt']['bs']['d']))) {
8269 $annots .= ' /D [';
8270 foreach ($pl['opt']['bs']['d'] as $cord) {
8271 $annots .= ' '.intval($cord);
8272 }
8273 $annots .= ']';
8274 }
8275 $annots .= ' >>';
8276 } else {
8277 $annots .= ' /Border [';
8278 if (isset($pl['opt']['border']) AND (count($pl['opt']['border']) >= 3)) {
8279 $annots .= intval($pl['opt']['border'][0]).' ';
8280 $annots .= intval($pl['opt']['border'][1]).' ';
8281 $annots .= intval($pl['opt']['border'][2]);
8282 if (isset($pl['opt']['border'][3]) AND is_array($pl['opt']['border'][3])) {
8283 $annots .= ' [';
8284 foreach ($pl['opt']['border'][3] as $dash) {
8285 $annots .= intval($dash).' ';
8286 }
8287 $annots .= ']';
8288 }
8289 } else {
8290 $annots .= '0 0 0';
8291 }
8292 $annots .= ']';
8293 }
8294 if (isset($pl['opt']['be']) AND (is_array($pl['opt']['be']))) {
8295 $annots .= ' /BE <<';
8296 $bstyles = array('S', 'C');
8297 if (isset($pl['opt']['be']['s']) AND in_array($pl['opt']['be']['s'], $bstyles)) {
8298 $annots .= ' /S /'.$pl['opt']['bs']['s'];
8299 } else {
8300 $annots .= ' /S /S';
8301 }
8302 if (isset($pl['opt']['be']['i']) AND ($pl['opt']['be']['i'] >= 0) AND ($pl['opt']['be']['i'] <= 2)) {
8303 $annots .= ' /I '.sprintf(' %F', $pl['opt']['be']['i']);
8304 }
8305 $annots .= '>>';
8306 }
8307 if (isset($pl['opt']['c']) AND (is_array($pl['opt']['c'])) AND !empty($pl['opt']['c'])) {
8308 $annots .= ' /C '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['c']);
8309 }
8310 //$annots .= ' /StructParent ';
8311 //$annots .= ' /OC ';
8312 $markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound');
8313 if (in_array(strtolower($pl['opt']['subtype']), $markups)) {
8314 // this is a markup type
8315 if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
8316 $annots .= ' /T '.$this->_textstring($pl['opt']['t'], $annot_obj_id);
8317 }
8318 //$annots .= ' /Popup ';
8319 if (isset($pl['opt']['ca'])) {
8320 $annots .= ' /CA '.sprintf('%F', floatval($pl['opt']['ca']));
8321 }
8322 if (isset($pl['opt']['rc'])) {
8323 $annots .= ' /RC '.$this->_textstring($pl['opt']['rc'], $annot_obj_id);
8324 }
8325 $annots .= ' /CreationDate '.$this->_datestring($annot_obj_id, $this->doc_creation_timestamp);
8326 //$annots .= ' /IRT ';
8327 if (isset($pl['opt']['subj'])) {
8328 $annots .= ' /Subj '.$this->_textstring($pl['opt']['subj'], $annot_obj_id);
8329 }
8330 //$annots .= ' /RT ';
8331 //$annots .= ' /IT ';
8332 //$annots .= ' /ExData ';
8333 }
8334 $lineendings = array('Square', 'Circle', 'Diamond', 'OpenArrow', 'ClosedArrow', 'None', 'Butt', 'ROpenArrow', 'RClosedArrow', 'Slash');
8335 // Annotation types
8336 switch (strtolower($pl['opt']['subtype'])) {
8337 case 'text': {
8338 if (isset($pl['opt']['open'])) {
8339 $annots .= ' /Open '. (strtolower($pl['opt']['open']) == 'true' ? 'true' : 'false');
8340 }
8341 $iconsapp = array('Comment', 'Help', 'Insert', 'Key', 'NewParagraph', 'Note', 'Paragraph');
8342 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8343 $annots .= ' /Name /'.$pl['opt']['name'];
8344 } else {
8345 $annots .= ' /Name /Note';
8346 }
8347 $statemodels = array('Marked', 'Review');
8348 if (isset($pl['opt']['statemodel']) AND in_array($pl['opt']['statemodel'], $statemodels)) {
8349 $annots .= ' /StateModel /'.$pl['opt']['statemodel'];
8350 } else {
8351 $pl['opt']['statemodel'] = 'Marked';
8352 $annots .= ' /StateModel /'.$pl['opt']['statemodel'];
8353 }
8354 if ($pl['opt']['statemodel'] == 'Marked') {
8355 $states = array('Accepted', 'Unmarked');
8356 } else {
8357 $states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None');
8358 }
8359 if (isset($pl['opt']['state']) AND in_array($pl['opt']['state'], $states)) {
8360 $annots .= ' /State /'.$pl['opt']['state'];
8361 } else {
8362 if ($pl['opt']['statemodel'] == 'Marked') {
8363 $annots .= ' /State /Unmarked';
8364 } else {
8365 $annots .= ' /State /None';
8366 }
8367 }
8368 break;
8369 }
8370 case 'link': {
8371 if (is_string($pl['txt'])) {
8372 if ($pl['txt'][0] == '#') {
8373 // internal destination
8374 $annots .= ' /Dest /'.TCPDF_STATIC::encodeNameObject(substr($pl['txt'], 1));
8375 } elseif ($pl['txt'][0] == '%') {
8376 // embedded PDF file
8378 $annots .= ' /A << /S /GoToE /D [0 /Fit] /NewWindow true /T << /R /C /P '.($n - 1).' /A '.$this->embeddedfiles[$filename]['a'].' >> >>';
8379 } elseif ($pl['txt'][0] == '*') {
8380 // embedded generic file
8382 $jsa = 'var D=event.target.doc;var MyData=D.dataObjects;for (var i in MyData) if (MyData[i].path=="'.$filename.'") D.exportDataObject( { cName : MyData[i].name, nLaunch : 2});';
8383 $annots .= ' /A << /S /JavaScript /JS '.$this->_textstring($jsa, $annot_obj_id).'>>';
8384 } else {
8385 $parsedUrl = parse_url($pl['txt']);
8386 if (empty($parsedUrl['scheme']) AND (strtolower(substr($parsedUrl['path'], -4)) == '.pdf')) {
8387 // relative link to a PDF file
8388 $dest = '[0 /Fit]'; // default page 0
8389 if (!empty($parsedUrl['fragment'])) {
8390 // check for named destination
8391 $tmp = explode('=', $parsedUrl['fragment']);
8392 $dest = '('.((count($tmp) == 2) ? $tmp[1] : $tmp[0]).')';
8393 }
8394 $annots .= ' /A <</S /GoToR /D '.$dest.' /F '.$this->_datastring($this->unhtmlentities($parsedUrl['path']), $annot_obj_id).' /NewWindow true>>';
8395 } else {
8396 // external URI link
8397 $annots .= ' /A <</S /URI /URI '.$this->_datastring($this->unhtmlentities($pl['txt']), $annot_obj_id).'>>';
8398 }
8399 }
8400 } elseif (isset($this->links[$pl['txt']])) {
8401 // internal link ID
8404 $annots .= sprintf(' /Dest [%u 0 R /XYZ 0 %F null]', $this->page_obj_id[($l['p'])], ($this->pagedim[$l['p']]['h'] - ($l['y'] * $this->k)));
8405 }
8406 }
8407 $hmodes = array('N', 'I', 'O', 'P');
8408 if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmodes)) {
8409 $annots .= ' /H /'.$pl['opt']['h'];
8410 } else {
8411 $annots .= ' /H /I';
8412 }
8413 //$annots .= ' /PA ';
8414 //$annots .= ' /Quadpoints ';
8415 break;
8416 }
8417 case 'freetext': {
8418 if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) {
8419 $annots .= ' /DA ('.$pl['opt']['da'].')';
8420 }
8421 if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) {
8422 $annots .= ' /Q '.intval($pl['opt']['q']);
8423 }
8424 if (isset($pl['opt']['rc'])) {
8425 $annots .= ' /RC '.$this->_textstring($pl['opt']['rc'], $annot_obj_id);
8426 }
8427 if (isset($pl['opt']['ds'])) {
8428 $annots .= ' /DS '.$this->_textstring($pl['opt']['ds'], $annot_obj_id);
8429 }
8430 if (isset($pl['opt']['cl']) AND is_array($pl['opt']['cl'])) {
8431 $annots .= ' /CL [';
8432 foreach ($pl['opt']['cl'] as $cl) {
8434 }
8435 $annots .= ']';
8436 }
8437 $tfit = array('FreeText', 'FreeTextCallout', 'FreeTextTypeWriter');
8438 if (isset($pl['opt']['it']) AND in_array($pl['opt']['it'], $tfit)) {
8439 $annots .= ' /IT /'.$pl['opt']['it'];
8440 }
8441 if (isset($pl['opt']['rd']) AND is_array($pl['opt']['rd'])) {
8447 }
8448 if (isset($pl['opt']['le']) AND in_array($pl['opt']['le'], $lineendings)) {
8449 $annots .= ' /LE /'.$pl['opt']['le'];
8450 }
8451 break;
8452 }
8453 case 'line': {
8454 break;
8455 }
8456 case 'square': {
8457 break;
8458 }
8459 case 'circle': {
8460 break;
8461 }
8462 case 'polygon': {
8463 break;
8464 }
8465 case 'polyline': {
8466 break;
8467 }
8468 case 'highlight': {
8469 break;
8470 }
8471 case 'underline': {
8472 break;
8473 }
8474 case 'squiggly': {
8475 break;
8476 }
8477 case 'strikeout': {
8478 break;
8479 }
8480 case 'stamp': {
8481 break;
8482 }
8483 case 'caret': {
8484 break;
8485 }
8486 case 'ink': {
8487 break;
8488 }
8489 case 'popup': {
8490 break;
8491 }
8492 case 'fileattachment': {
8493 if ($this->pdfa_mode) {
8494 // embedded files are not allowed in PDF/A mode
8495 break;
8496 }
8497 if (!isset($pl['opt']['fs'])) {
8498 break;
8499 }
8503 $iconsapp = array('Graph', 'Paperclip', 'PushPin', 'Tag');
8504 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8505 $annots .= ' /Name /'.$pl['opt']['name'];
8506 } else {
8507 $annots .= ' /Name /PushPin';
8508 }
8509 // index (zero-based) of the annotation in the Annots array of this page
8511 }
8512 break;
8513 }
8514 case 'sound': {
8515 if (!isset($pl['opt']['fs'])) {
8516 break;
8517 }
8520 // ... TO BE COMPLETED ...
8521 // /R /C /B /E /CO /CP
8523 $iconsapp = array('Speaker', 'Mic');
8524 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8525 $annots .= ' /Name /'.$pl['opt']['name'];
8526 } else {
8527 $annots .= ' /Name /Speaker';
8528 }
8529 }
8530 break;
8531 }
8532 case 'movie': {
8533 break;
8534 }
8535 case 'widget': {
8536 $hmode = array('N', 'I', 'O', 'P', 'T');
8537 if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmode)) {
8538 $annots .= ' /H /'.$pl['opt']['h'];
8539 }
8540 if (isset($pl['opt']['mk']) AND (is_array($pl['opt']['mk'])) AND !empty($pl['opt']['mk'])) {
8541 $annots .= ' /MK <<';
8542 if (isset($pl['opt']['mk']['r'])) {
8543 $annots .= ' /R '.$pl['opt']['mk']['r'];
8544 }
8545 if (isset($pl['opt']['mk']['bc']) AND (is_array($pl['opt']['mk']['bc']))) {
8546 $annots .= ' /BC '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bc']);
8547 }
8548 if (isset($pl['opt']['mk']['bg']) AND (is_array($pl['opt']['mk']['bg']))) {
8549 $annots .= ' /BG '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bg']);
8550 }
8551 if (isset($pl['opt']['mk']['ca'])) {
8552 $annots .= ' /CA '.$pl['opt']['mk']['ca'];
8553 }
8554 if (isset($pl['opt']['mk']['rc'])) {
8555 $annots .= ' /RC '.$pl['opt']['mk']['rc'];
8556 }
8557 if (isset($pl['opt']['mk']['ac'])) {
8558 $annots .= ' /AC '.$pl['opt']['mk']['ac'];
8559 }
8560 if (isset($pl['opt']['mk']['i'])) {
8563 $annots .= ' /I '.$info['n'].' 0 R';
8564 }
8565 }
8566 if (isset($pl['opt']['mk']['ri'])) {
8569 $annots .= ' /RI '.$info['n'].' 0 R';
8570 }
8571 }
8572 if (isset($pl['opt']['mk']['ix'])) {
8575 $annots .= ' /IX '.$info['n'].' 0 R';
8576 }
8577 }
8578 if (isset($pl['opt']['mk']['if']) AND (is_array($pl['opt']['mk']['if'])) AND !empty($pl['opt']['mk']['if'])) {
8579 $annots .= ' /IF <<';
8580 $if_sw = array('A', 'B', 'S', 'N');
8581 if (isset($pl['opt']['mk']['if']['sw']) AND in_array($pl['opt']['mk']['if']['sw'], $if_sw)) {
8582 $annots .= ' /SW /'.$pl['opt']['mk']['if']['sw'];
8583 }
8584 $if_s = array('A', 'P');
8585 if (isset($pl['opt']['mk']['if']['s']) AND in_array($pl['opt']['mk']['if']['s'], $if_s)) {
8586 $annots .= ' /S /'.$pl['opt']['mk']['if']['s'];
8587 }
8588 if (isset($pl['opt']['mk']['if']['a']) AND (is_array($pl['opt']['mk']['if']['a'])) AND !empty($pl['opt']['mk']['if']['a'])) {
8589 $annots .= sprintf(' /A [%F %F]', $pl['opt']['mk']['if']['a'][0], $pl['opt']['mk']['if']['a'][1]);
8590 }
8591 if (isset($pl['opt']['mk']['if']['fb']) AND ($pl['opt']['mk']['if']['fb'])) {
8592 $annots .= ' /FB true';
8593 }
8594 $annots .= '>>';
8595 }
8596 if (isset($pl['opt']['mk']['tp']) AND ($pl['opt']['mk']['tp'] >= 0) AND ($pl['opt']['mk']['tp'] <= 6)) {
8597 $annots .= ' /TP '.intval($pl['opt']['mk']['tp']);
8598 }
8599 $annots .= '>>';
8600 } // end MK
8601 // --- Entries for field dictionaries ---
8603 // set parent
8605 }
8606 if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
8607 $annots .= ' /T '.$this->_datastring($pl['opt']['t'], $annot_obj_id);
8608 }
8609 if (isset($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) {
8610 $annots .= ' /TU '.$this->_datastring($pl['opt']['tu'], $annot_obj_id);
8611 }
8612 if (isset($pl['opt']['tm']) AND is_string($pl['opt']['tm'])) {
8613 $annots .= ' /TM '.$this->_datastring($pl['opt']['tm'], $annot_obj_id);
8614 }
8615 if (isset($pl['opt']['ff'])) {
8616 if (is_array($pl['opt']['ff'])) {
8617 // array of bit settings
8618 $flag = 0;
8619 foreach($pl['opt']['ff'] as $val) {
8620 $flag += 1 << ($val - 1);
8621 }
8622 } else {
8623 $flag = intval($pl['opt']['ff']);
8624 }
8625 $annots .= ' /Ff '.$flag;
8626 }
8627 if (isset($pl['opt']['maxlen'])) {
8628 $annots .= ' /MaxLen '.intval($pl['opt']['maxlen']);
8629 }
8630 if (isset($pl['opt']['v'])) {
8631 $annots .= ' /V';
8632 if (is_array($pl['opt']['v'])) {
8633 foreach ($pl['opt']['v'] AS $optval) {
8634 if (is_float($optval)) {
8636 }
8637 $annots .= ' '.$optval;
8638 }
8639 } else {
8640 $annots .= ' '.$this->_textstring($pl['opt']['v'], $annot_obj_id);
8641 }
8642 }
8643 if (isset($pl['opt']['dv'])) {
8644 $annots .= ' /DV';
8645 if (is_array($pl['opt']['dv'])) {
8646 foreach ($pl['opt']['dv'] AS $optval) {
8647 if (is_float($optval)) {
8649 }
8650 $annots .= ' '.$optval;
8651 }
8652 } else {
8653 $annots .= ' '.$this->_textstring($pl['opt']['dv'], $annot_obj_id);
8654 }
8655 }
8656 if (isset($pl['opt']['rv'])) {
8657 $annots .= ' /RV';
8658 if (is_array($pl['opt']['rv'])) {
8659 foreach ($pl['opt']['rv'] AS $optval) {
8660 if (is_float($optval)) {
8662 }
8663 $annots .= ' '.$optval;
8664 }
8665 } else {
8666 $annots .= ' '.$this->_textstring($pl['opt']['rv'], $annot_obj_id);
8667 }
8668 }
8669 if (isset($pl['opt']['a']) AND !empty($pl['opt']['a'])) {
8670 $annots .= ' /A << '.$pl['opt']['a'].' >>';
8671 }
8672 if (isset($pl['opt']['aa']) AND !empty($pl['opt']['aa'])) {
8673 $annots .= ' /AA << '.$pl['opt']['aa'].' >>';
8674 }
8675 if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) {
8676 $annots .= ' /DA ('.$pl['opt']['da'].')';
8677 }
8678 if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) {
8679 $annots .= ' /Q '.intval($pl['opt']['q']);
8680 }
8681 if (isset($pl['opt']['opt']) AND (is_array($pl['opt']['opt'])) AND !empty($pl['opt']['opt'])) {
8682 $annots .= ' /Opt [';
8683 foreach($pl['opt']['opt'] AS $copt) {
8684 if (is_array($copt)) {
8685 $annots .= ' ['.$this->_textstring($copt[0], $annot_obj_id).' '.$this->_textstring($copt[1], $annot_obj_id).']';
8686 } else {
8687 $annots .= ' '.$this->_textstring($copt, $annot_obj_id);
8688 }
8689 }
8690 $annots .= ']';
8691 }
8692 if (isset($pl['opt']['ti'])) {
8693 $annots .= ' /TI '.intval($pl['opt']['ti']);
8694 }
8695 if (isset($pl['opt']['i']) AND (is_array($pl['opt']['i'])) AND !empty($pl['opt']['i'])) {
8696 $annots .= ' /I [';
8697 foreach($pl['opt']['i'] AS $copt) {
8698 $annots .= intval($copt).' ';
8699 }
8700 $annots .= ']';
8701 }
8702 break;
8703 }
8704 case 'screen': {
8705 break;
8706 }
8707 case 'printermark': {
8708 break;
8709 }
8710 case 'trapnet': {
8711 break;
8712 }
8713 case 'watermark': {
8714 break;
8715 }
8716 case '3d': {
8717 break;
8718 }
8719 default: {
8720 break;
8721 }
8722 }
8723 $annots .= '>>';
8724 // create new annotation object
8727 // store reference of form object
8728 $this->form_obj_id[] = $annot_obj_id;
8729 }
8730 }
8731 }
8732 } // end for each page
8733 }
_putAPXObject($w=0, $h=0, $stream='')
Put appearance streams XObject used to define annotation's appearance states.
Definition: tcpdf.php:8744
References $d, $data, $filename, $info, $k, $l, $n, $numpages, $r, $t, _datastring(), _getobj(), _out(), _putAPXObject(), _textstring(), getImageBuffer(), sprintf, and unhtmlentities().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putAPXObject()
|
protected |
Put appearance streams XObject used to define annotation's appearance states.
- Parameters
-
$w (int) annotation width $h (int) annotation height $stream (string) appearance stream
- Returns
- int object ID
- Since
- 4.8.001 (2009-09-09)
Definition at line 8744 of file tcpdf.php.
8744 {
8745 $stream = trim($stream);
8747 $this->xobjects['AX'.$this->n] = array('n' => $this->n);
8752 if ($this->compress) {
8753 $stream = gzcompress($stream);
8755 }
8760 $stream = $this->_getrawstream($stream);
8767 }
References $h, $n, $out, $w, _getobj(), _getrawstream(), _out(), and sprintf.
Referenced by _putannotsobjs().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putbookmarks()
|
protected |
Create a bookmark PDF string.
- Since
- 2.1.002 (2008-02-12)
Definition at line 12367 of file tcpdf.php.
12367 {
12368 $nb = count($this->outlines);
12369 if ($nb == 0) {
12370 return;
12371 }
12372 // sort bookmarks
12373 $this->sortBookmarks();
12374 $lru = array();
12375 $level = 0;
12376 foreach ($this->outlines as $i => $o) {
12377 if ($o['l'] > 0) {
12378 $parent = $lru[($o['l'] - 1)];
12379 //Set parent and last pointers
12380 $this->outlines[$i]['parent'] = $parent;
12381 $this->outlines[$parent]['last'] = $i;
12382 if ($o['l'] > $level) {
12383 //Level increasing: set first pointer
12384 $this->outlines[$parent]['first'] = $i;
12385 }
12386 } else {
12387 $this->outlines[$i]['parent'] = $nb;
12388 }
12389 if (($o['l'] <= $level) AND ($i > 0)) {
12390 //Set prev and next pointers
12391 $prev = $lru[$o['l']];
12392 $this->outlines[$prev]['next'] = $i;
12393 $this->outlines[$i]['prev'] = $prev;
12394 }
12395 $lru[$o['l']] = $i;
12396 $level = $o['l'];
12397 }
12398 //Outline items
12399 $n = $this->n + 1;
12400 $nltags = '/<br[\s]?\/>|<\/(blockquote|dd|dl|div|dt|h1|h2|h3|h4|h5|h6|hr|li|ol|p|pre|ul|tcpdf|table|tr|td)>/si';
12401 foreach ($this->outlines as $i => $o) {
12402 $oid = $this->_newobj();
12403 // covert HTML title to string
12411 if (isset($o['prev'])) {
12413 }
12414 if (isset($o['next'])) {
12416 }
12417 if (isset($o['first'])) {
12419 }
12420 if (isset($o['last'])) {
12422 }
12423 if (isset($o['u']) AND !empty($o['u'])) {
12424 // link
12425 if (is_string($o['u'])) {
12426 if ($o['u'][0] == '#') {
12427 // internal destination
12429 } elseif ($o['u'][0] == '%') {
12430 // embedded PDF file
12432 $out .= ' /A <</S /GoToE /D [0 /Fit] /NewWindow true /T << /R /C /P '.($o['p'] - 1).' /A '.$this->embeddedfiles[$filename]['a'].' >> >>';
12433 } elseif ($o['u'][0] == '*') {
12434 // embedded generic file
12436 $jsa = 'var D=event.target.doc;var MyData=D.dataObjects;for (var i in MyData) if (MyData[i].path=="'.$filename.'") D.exportDataObject( { cName : MyData[i].name, nLaunch : 2});';
12438 } else {
12439 // external URI link
12441 }
12442 } elseif (isset($this->links[$o['u']])) {
12443 // internal link ID
12446 $out .= sprintf(' /Dest [%u 0 R /XYZ 0 %F null]', $this->page_obj_id[($l['p'])], ($this->pagedim[$l['p']]['h'] - ($l['y'] * $this->k)));
12447 }
12448 }
12449 } elseif (isset($this->page_obj_id[($o['p'])])) {
12450 // link to a page
12451 $out .= ' '.sprintf('/Dest [%u 0 R /XYZ %F %F null]', $this->page_obj_id[($o['p'])], ($o['x'] * $this->k), ($this->pagedim[$o['p']]['h'] - ($o['y'] * $this->k)));
12452 }
12453 // set font style
12454 $style = 0;
12455 if (!empty($o['s'])) {
12456 // bold
12457 if (strpos($o['s'], 'B') !== false) {
12458 $style |= 2;
12459 }
12460 // oblique
12461 if (strpos($o['s'], 'I') !== false) {
12462 $style |= 1;
12463 }
12464 }
12466 // set bookmark color
12467 if (isset($o['c']) AND is_array($o['c']) AND (count($o['c']) == 3)) {
12468 $color = array_values($o['c']);
12470 } else {
12471 // black
12473 }
12478 }
12479 //Outline root
12480 $this->OutlineRoot = $this->_newobj();
12481 $this->_out('<< /Type /Outlines /First '.$n.' 0 R /Last '.($n + $lru[0]).' 0 R >>'."\n".'endobj');
12482 }
References $filename, $l, $n, $out, $style, $title, _newobj(), _out(), sortBookmarks(), sprintf, stringTrim(), and unhtmlentities().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putcatalog()
|
protected |
Output Catalog.
- Returns
- int object id
Definition at line 9650 of file tcpdf.php.
9650 {
9651 // put XMP
9652 $xmpobj = $this->_putXMP();
9653 // if required, add standard sRGB_IEC61966-2.1 blackscaled ICC colour profile
9654 if ($this->pdfa_mode OR $this->force_srgb) {
9655 $iccobj = $this->_newobj();
9656 $icc = file_get_contents(dirname(__FILE__).'/include/sRGB.icc');
9657 $filter = '';
9658 if ($this->compress) {
9659 $filter = ' /Filter /FlateDecode';
9660 $icc = gzcompress($icc);
9661 }
9662 $icc = $this->_getrawstream($icc);
9663 $this->_out('<</N 3 '.$filter.'/Length '.strlen($icc).'>> stream'."\n".$icc."\n".'endstream'."\n".'endobj');
9664 }
9665 // start catalog
9666 $oid = $this->_newobj();
9669 //$out .= ' /Extensions <<>>';
9671 //$out .= ' /PageLabels ' //...;
9673 if ((!$this->pdfa_mode) AND !empty($this->n_js)) {
9675 }
9676 if (!empty($this->efnames)) {
9678 foreach ($this->efnames AS $fn => $fref) {
9680 }
9682 }
9684 if (!empty($this->dests)) {
9686 }
9690 }
9693 }
9694 if (count($this->outlines) > 0) {
9697 }
9698 //$out .= ' /Threads []';
9699 if ($this->ZoomMode == 'fullpage') {
9701 } elseif ($this->ZoomMode == 'fullwidth') {
9703 } elseif ($this->ZoomMode == 'real') {
9705 } elseif (!is_string($this->ZoomMode)) {
9706 $out .= sprintf(' /OpenAction ['.$this->page_obj_id[1].' 0 R /XYZ null null %F]', ($this->ZoomMode / 100));
9707 }
9708 //$out .= ' /AA <<>>';
9709 //$out .= ' /URI <<>>';
9711 //$out .= ' /StructTreeRoot <<>>';
9712 //$out .= ' /MarkInfo <<>>';
9713 if (isset($this->l['a_meta_language'])) {
9715 }
9716 //$out .= ' /SpiderInfo <<>>';
9717 // set OutputIntent to sRGB IEC61966-2.1 if required
9718 if ($this->pdfa_mode OR $this->force_srgb) {
9728 }
9729 //$out .= ' /PieceInfo <<>>';
9730 if (!empty($this->pdflayers)) {
9731 $lyrobjs = '';
9732 $lyrobjs_off = '';
9733 $lyrobjs_lock = '';
9734 foreach ($this->pdflayers as $layer) {
9735 $layer_obj_ref = ' '.$layer['objid'].' 0 R';
9736 $lyrobjs .= $layer_obj_ref;
9737 if ($layer['view'] === false) {
9738 $lyrobjs_off .= $layer_obj_ref;
9739 }
9740 if ($layer['lock']) {
9741 $lyrobjs_lock .= $layer_obj_ref;
9742 }
9743 }
9758 //$out .= ' /RBGroups ['..']';
9759 //$out .= ' /Locked ['..']';
9762 }
9763 // AcroForm
9764 if (!empty($this->form_obj_id)
9765 OR ($this->sign AND isset($this->signature_data['cert_type']))
9766 OR !empty($this->empty_signature_appearance)) {
9768 $objrefs = '';
9769 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9770 // set reference for signature object
9771 $objrefs .= $this->sig_obj_id.' 0 R';
9772 }
9773 if (!empty($this->empty_signature_appearance)) {
9774 foreach ($this->empty_signature_appearance as $esa) {
9775 // set reference for empty signature objects
9776 $objrefs .= ' '.$esa['objid'].' 0 R';
9777 }
9778 }
9779 if (!empty($this->form_obj_id)) {
9780 foreach($this->form_obj_id as $objid) {
9781 $objrefs .= ' '.$objid.' 0 R';
9782 }
9783 }
9785 // It's better to turn off this value and set the appearance stream for each annotation (/AP) to avoid conflicts with signature fields.
9786 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
9788 }
9789 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9790 if ($this->signature_data['cert_type'] > 0) {
9792 } else {
9794 }
9795 }
9796 //$out .= ' /CO ';
9797 if (isset($this->annotation_fonts) AND !empty($this->annotation_fonts)) {
9800 foreach ($this->annotation_fonts as $fontkey => $fontid) {
9802 }
9804 }
9808 //$out .= ' /XFA ';
9810 // signatures
9811 if ($this->sign AND isset($this->signature_data['cert_type'])
9812 AND (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A'))) {
9813 if ($this->signature_data['cert_type'] > 0) {
9815 } else {
9817 }
9818 }
9819 }
9820 //$out .= ' /Legal <<>>';
9821 //$out .= ' /Requirements []';
9822 //$out .= ' /Collection <<>>';
9823 //$out .= ' /NeedsRendering true';
9827 return $oid;
9828 }
References $out, _getrawstream(), _newobj(), _out(), _putviewerpreferences(), _putXMP(), TCPDF_STATIC\empty_string(), getFontBuffer(), and sprintf.
Referenced by _enddoc().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putcidfont0()
|
protected |
Output CID-0 fonts.
A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
- Parameters
-
$font (array) font data
- Since
- 3.2.000 (2008-06-23)
Definition at line 9030 of file tcpdf.php.
9030 {
9031 $cidoffset = 0;
9032 if (!isset($font['cw'][1])) {
9033 $cidoffset = 31;
9034 }
9035 if (isset($font['cidinfo']['uni2cid'])) {
9036 // convert unicode to cid.
9037 $uni2cid = $font['cidinfo']['uni2cid'];
9038 $cw = array();
9039 foreach ($font['cw'] as $uni => $width) {
9040 if (isset($uni2cid[$uni])) {
9041 $cw[($uni2cid[$uni] + $cidoffset)] = $width;
9042 } elseif ($uni < 256) {
9043 $cw[$uni] = $width;
9044 } // else unknown character
9045 }
9046 $font = array_merge($font, array('cw' => $cw));
9047 }
9048 $name = $font['name'];
9049 $enc = $font['enc'];
9050 if ($enc) {
9051 $longname = $name.'-'.$enc;
9052 } else {
9053 $longname = $name;
9054 }
9060 if ($enc) {
9062 }
9067 $oid = $this->_newobj();
9071 $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry'], $oid);
9072 $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering'], $oid);
9073 $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement'];
9081 $this->_newobj();
9082 $s = '<</Type /FontDescriptor /FontName /'.$name;
9085 if (is_float($v)) {
9087 }
9088 $s .= ' /'.$k.' '.$v.'';
9089 }
9090 }
9091 $s .= '>>';
9092 $s .= "\n".'endobj';
9093 $this->_out($s);
9094 }
References $k, $out, _getobj(), _newobj(), _out(), and sprintf.
Here is the call graph for this function:
◆ _putdests()
|
protected |
Insert Named Destinations.
- Since
- 5.9.098 (2011-06-23)
Definition at line 12259 of file tcpdf.php.
12259 {
12260 if (empty($this->dests)) {
12261 return;
12262 }
12263 $this->n_dests = $this->_newobj();
12265 foreach($this->dests as $name => $o) {
12266 $out .= ' /'.$name.' '.sprintf('[%u 0 R /XYZ %F %F null]', $this->page_obj_id[($o['p'])], ($o['x'] * $this->k), ($this->pagedim[$o['p']]['h'] - ($o['y'] * $this->k)));
12267 }
12271 }
References $out, _newobj(), _out(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putEmbeddedFiles()
|
protected |
Embedd the attached files.
- Since
- 4.4.000 (2008-12-07)
- See also
- Annotation()
Definition at line 4835 of file tcpdf.php.
4835 {
4836 if ($this->pdfa_mode) {
4837 // embedded files are not allowed in PDF/A mode
4838 return;
4839 }
4840 reset($this->embeddedfiles);
4844 $rawsize = strlen($data);
4845 if ($rawsize > 0) {
4846 // update name tree
4848 // embedded file specification object
4850 $out .= '<</Type /Filespec /F '.$this->_datastring($filename, $filedata['f']).' /EF <</F '.$filedata['n'].' 0 R>> >>';
4853 // embedded file object
4854 $filter = '';
4855 if ($this->compress) {
4857 $filter = ' /Filter /FlateDecode';
4858 }
4861 $out .= '<< /Type /EmbeddedFile'.$filter.' /Length '.strlen($stream).' /Params <</Size '.$rawsize.'>> >>';
4865 }
4866 }
4867 }
4868 }
References $data, $filename, $out, _getobj(), _getrawstream(), _out(), and TCPDF_STATIC\fileGetContents().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putencryption()
|
protected |
Put encryption on PDF document.
- Since
- 2.0.000 (2008-01-02)
Definition at line 10490 of file tcpdf.php.
10490 {
10491 if (!$this->encrypted) {
10492 return;
10493 }
10496 if (!isset($this->encryptdata['Filter']) OR empty($this->encryptdata['Filter'])) {
10497 $this->encryptdata['Filter'] = 'Standard';
10498 }
10500 if (isset($this->encryptdata['SubFilter']) AND !empty($this->encryptdata['SubFilter'])) {
10502 }
10503 if (!isset($this->encryptdata['V']) OR empty($this->encryptdata['V'])) {
10504 $this->encryptdata['V'] = 1;
10505 }
10506 // V is a code specifying the algorithm to be used in encrypting and decrypting the document
10508 if (isset($this->encryptdata['Length']) AND !empty($this->encryptdata['Length'])) {
10509 // The length of the encryption key, in bits. The value shall be a multiple of 8, in the range 40 to 256
10511 } else {
10513 }
10514 if ($this->encryptdata['V'] >= 4) {
10515 if (!isset($this->encryptdata['StmF']) OR empty($this->encryptdata['StmF'])) {
10516 $this->encryptdata['StmF'] = 'Identity';
10517 }
10518 if (!isset($this->encryptdata['StrF']) OR empty($this->encryptdata['StrF'])) {
10519 // The name of the crypt filter that shall be used when decrypting all strings in the document.
10520 $this->encryptdata['StrF'] = 'Identity';
10521 }
10522 // A dictionary whose keys shall be crypt filter names and whose values shall be the corresponding crypt filter dictionaries.
10523 if (isset($this->encryptdata['CF']) AND !empty($this->encryptdata['CF'])) {
10527 if (isset($this->encryptdata['CF']['CFM']) AND !empty($this->encryptdata['CF']['CFM'])) {
10528 // The method used
10530 if ($this->encryptdata['pubkey']) {
10532 foreach ($this->encryptdata['Recipients'] as $rec) {
10534 }
10536 if (isset($this->encryptdata['CF']['EncryptMetadata']) AND (!$this->encryptdata['CF']['EncryptMetadata'])) {
10538 } else {
10540 }
10541 }
10542 } else {
10544 }
10545 if (isset($this->encryptdata['CF']['AuthEvent']) AND !empty($this->encryptdata['CF']['AuthEvent'])) {
10546 // The event to be used to trigger the authorization that is required to access encryption keys used by this filter.
10548 } else {
10550 }
10551 if (isset($this->encryptdata['CF']['Length']) AND !empty($this->encryptdata['CF']['Length'])) {
10552 // The bit length of the encryption key.
10554 }
10556 }
10557 // The name of the crypt filter that shall be used by default when decrypting streams.
10559 // The name of the crypt filter that shall be used when decrypting all strings in the document.
10561 if (isset($this->encryptdata['EFF']) AND !empty($this->encryptdata['EFF'])) {
10562 // The name of the crypt filter that shall be used when encrypting embedded file streams that do not have their own crypt filter specifier.
10564 }
10565 }
10566 // Additional encryption dictionary entries for the standard security handler
10567 if ($this->encryptdata['pubkey']) {
10568 if (($this->encryptdata['V'] < 4) AND isset($this->encryptdata['Recipients']) AND !empty($this->encryptdata['Recipients'])) {
10570 foreach ($this->encryptdata['Recipients'] as $rec) {
10572 }
10574 }
10575 } else {
10577 if ($this->encryptdata['V'] == 5) { // AES-256
10582 } elseif ($this->encryptdata['V'] == 4) { // AES-128
10584 } elseif ($this->encryptdata['V'] < 2) { // RC-40
10586 } else { // RC-128
10588 }
10592 if (isset($this->encryptdata['EncryptMetadata']) AND (!$this->encryptdata['EncryptMetadata'])) {
10594 } else {
10596 }
10597 }
10601 }
References $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putextgstates()
|
protected |
Put extgstates for object transparency.
- Since
- 3.0.000 (2008-03-27)
Definition at line 13841 of file tcpdf.php.
13841 {
13842 foreach ($this->extgstates as $i => $ext) {
13846 if (is_float($v)) {
13848 } elseif ($v === true) {
13849 $v = 'true';
13850 } elseif ($v === false) {
13851 $v = 'false';
13852 }
13854 }
13858 }
13859 }
References $k, $out, _newobj(), _out(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putfonts()
|
protected |
Output fonts.
Definition at line 8774 of file tcpdf.php.
8774 {
8775 $nf = $this->n;
8776 foreach ($this->diffs as $diff) {
8777 //Encodings
8778 $this->_newobj();
8779 $this->_out('<< /Type /Encoding /BaseEncoding /WinAnsiEncoding /Differences ['.$diff.'] >>'."\n".'endobj');
8780 }
8781 $mqr = TCPDF_STATIC::get_mqr();
8784 // search and get font file to embedd
8787 $font = file_get_contents($fontfile);
8790 $header = (ord($font[0]) == 128);
8792 // strip first binary header
8793 $font = substr($font, 6);
8794 }
8796 // strip second binary header
8798 }
8799 } elseif ($info['subset'] AND ((!$compressed) OR ($compressed AND function_exists('gzcompress')))) {
8800 if ($compressed) {
8801 // uncompress font
8802 $font = gzuncompress($font);
8803 }
8804 // merge subset characters
8805 $subsetchars = array(); // used chars
8807 $fontinfo = $this->getFontBuffer($fontkey);
8808 $subsetchars += $fontinfo['subsetchars'];
8809 }
8810 // rebuild a font subset
8811 $font = TCPDF_FONTS::_getTrueTypeFontSubset($font, $subsetchars);
8812 // calculate new font length
8814 if ($compressed) {
8815 // recompress font
8816 $font = gzcompress($font);
8817 }
8818 }
8819 $this->_newobj();
8821 $stream = $this->_getrawstream($font);
8823 if ($compressed) {
8825 }
8829 }
8834 }
8835 }
8836 TCPDF_STATIC::set_mqr($mqr);
8838 //Font objects
8839 $font = $this->getFontBuffer($k);
8840 $type = $font['type'];
8841 $name = $font['name'];
8842 if ($type == 'core') {
8843 // standard core font
8849 if ((strtolower($name) != 'symbol') AND (strtolower($name) != 'zapfdingbats')) {
8851 }
8853 // add default font for annotations
8855 }
8859 } elseif (($type == 'Type1') OR ($type == 'TrueType')) {
8860 // additional Type1 or TrueType font
8869 if ($font['enc']) {
8870 if (isset($font['diff'])) {
8872 } else {
8874 }
8875 }
8879 // Widths
8880 $this->_newobj();
8881 $s = '[';
8882 for ($i = 32; $i < 256; ++$i) {
8883 if (isset($font['cw'][$i])) {
8884 $s .= $font['cw'][$i].' ';
8885 } else {
8886 $s .= $font['dw'].' ';
8887 }
8888 }
8889 $s .= ']';
8890 $s .= "\n".'endobj';
8891 $this->_out($s);
8892 //Descriptor
8893 $this->_newobj();
8894 $s = '<</Type /FontDescriptor /FontName /'.$name;
8895 foreach ($font['desc'] as $fdk => $fdv) {
8896 if (is_float($fdv)) {
8898 }
8899 $s .= ' /'.$fdk.' '.$fdv.'';
8900 }
8902 $s .= ' /FontFile'.($type == 'Type1' ? '' : '2').' '.$this->FontFiles[$font['file']]['n'].' 0 R';
8903 }
8904 $s .= '>>';
8905 $s .= "\n".'endobj';
8906 $this->_out($s);
8907 } else {
8908 // additional types
8909 $mtd = '_put'.strtolower($type);
8910 if (!method_exists($this, $mtd)) {
8912 }
8913 $this->$mtd($font);
8914 }
8915 }
8916 }
static _getTrueTypeFontSubset($font, $subsetchars)
Returns a subset of the TrueType font data without the unused glyphs.
Definition: tcpdf_fonts.php:952
static set_mqr($mqr)
Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtim...
Definition: tcpdf_static.php:137
static get_mqr()
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtim...
Definition: tcpdf_static.php:153
if(!file_exists("$old.txt")) if( $old===$new) if(file_exists("$new.txt")) $file
Definition: rename-config.php:43
References $file, $header, $info, $k, $n, $out, _getobj(), _getrawstream(), TCPDF_FONTS\_getTrueTypeFontSubset(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), TCPDF_STATIC\get_mqr(), getFontBuffer(), TCPDF_FONTS\getFontFullPath(), TCPDF_STATIC\set_mqr(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putheader()
|
protected |
◆ _putimages()
|
protected |
Output images.
Definition at line 9100 of file tcpdf.php.
9100 {
9104 // set object for alternate images array
9106 $altoid = $this->_newobj();
9109 if (isset($this->xobjects['I'.$altimage[0]]['n'])) {
9112 if ($altimage[1] === true) {
9114 } else {
9116 }
9118 }
9119 }
9123 }
9124 // set image object
9125 $oid = $this->_newobj();
9126 $this->xobjects['I'.$info['i']] = array('n' => $oid);
9134 }
9135 // set color space
9136 $icc = false;
9138 // ICC Colour Space
9139 $icc = true;
9142 // Indexed Colour Space
9143 $out .= ' /ColorSpace [/Indexed /DeviceRGB '.((strlen($info['pal']) / 3) - 1).' '.($this->n + 1).' 0 R]';
9144 } else {
9145 // Device Colour Space
9147 }
9150 }
9152 if (isset($altoid) AND ($altoid > 0)) {
9153 // reference to alternate images dictionary
9155 }
9157 // external stream
9162 }
9165 } else {
9168 }
9171 }
9173 $trns = '';
9177 for ($i = 0; $i < $count_info; ++$i) {
9179 // this is not a binary type mask @TODO: create a SMask
9180 $trns = '';
9181 break;
9183 // store the first fully transparent value
9184 $trns .= $i.' '.$i.' ';
9185 }
9186 }
9187 } else {
9188 // grayscale or RGB
9189 for ($i = 0; $i < $count_info; ++$i) {
9192 }
9193 }
9194 }
9195 // Colour Key Masking
9196 if (!empty($trns)) {
9198 }
9199 }
9203 }
9206 if ($icc) {
9207 // ICC colour profile
9208 $this->_newobj();
9210 $icc = $this->_getrawstream($icc);
9211 $this->_out('<</N '.$info['ch'].' /Alternate /'.$info['cs'].' '.$filter.'/Length '.strlen($icc).'>> stream'."\n".$icc."\n".'endstream'."\n".'endobj');
9213 // colour palette
9214 $this->_newobj();
9216 $pal = $this->_getrawstream($pal);
9217 $this->_out('<<'.$filter.'/Length '.strlen($pal).'>> stream'."\n".$pal."\n".'endstream'."\n".'endobj');
9218 }
9219 }
9220 }
setImageSubBuffer($image, $key, $data)
Set image buffer content for a specified sub-key.
Definition: tcpdf.php:20775
References $compress, $file, $info, $out, _getrawstream(), _newobj(), _out(), getImageBuffer(), and setImageSubBuffer().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putinfo()
|
protected |
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
- Returns
- int object id
Definition at line 9451 of file tcpdf.php.
9451 {
9452 $oid = $this->_newobj();
9454 // store current isunicode value
9455 $prev_isunicode = $this->isunicode;
9456 if ($this->docinfounicode) {
9457 $this->isunicode = true;
9458 }
9460 // The document's title.
9462 }
9464 // The name of the person who created the document.
9466 }
9468 // The subject of the document.
9470 }
9472 // Keywords associated with the document.
9474 }
9476 // If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted.
9478 }
9479 // restore previous isunicode value
9480 $this->isunicode = $prev_isunicode;
9481 // default producer
9483 // The date and time the document was created, in human-readable form
9485 // The date and time the document was most recently modified, in human-readable form
9487 // A name object indicating whether the document has been modified to include trapping information
9492 return $oid;
9493 }
$isunicode
Boolean flag set to true when the input text is unicode (require unicode fonts).
Definition: tcpdf.php:550
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:
◆ _putjavascript()
|
protected |
Create a javascript PDF string.
- Since
- 2.1.002 (2008-02-12)
Definition at line 12522 of file tcpdf.php.
12522 {
12523 if ($this->pdfa_mode OR (empty($this->javascript) AND empty($this->js_objects))) {
12524 return;
12525 }
12526 if (strpos($this->javascript, 'this.addField') > 0) {
12527 if (!$this->ur['enabled']) {
12528 //$this->setUserRights();
12529 }
12530 // the following two lines are used to avoid form fields duplication after saving
12531 // The addField method only works when releasing user rights (UR3)
12532 $jsa = sprintf("ftcpdfdocsaved=this.addField('%s','%s',%d,[%F,%F,%F,%F]);", 'tcpdfdocsaved', 'text', 0, 0, 1, 0, 1);
12533 $jsb = "getField('tcpdfdocsaved').value='saved';";
12534 $this->javascript = $jsa."\n".$this->javascript."\n".$jsb;
12535 }
12536 // name tree for javascript
12537 $this->n_js = '<< /Names [';
12538 if (!empty($this->javascript)) {
12539 $this->n_js .= ' (EmbeddedJS) '.($this->n + 1).' 0 R';
12540 }
12541 if (!empty($this->js_objects)) {
12542 foreach ($this->js_objects as $key => $val) {
12543 if ($val['onload']) {
12544 $this->n_js .= ' (JS'.$key.') '.$key.' 0 R';
12545 }
12546 }
12547 }
12548 $this->n_js .= ' ] >>';
12549 // default Javascript object
12550 if (!empty($this->javascript)) {
12551 $obj_id = $this->_newobj();
12557 }
12558 // additional Javascript objects
12559 if (!empty($this->js_objects)) {
12560 foreach ($this->js_objects as $key => $val) {
12561 $out = $this->_getobj($key)."\n".' << /S /JavaScript /JS '.$this->_textstring($val['js'], $key).' >>'."\n".'endobj';
12563 }
12564 }
12565 }
References $out, _getobj(), _newobj(), _out(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putocg()
|
protected |
Put pdf layers.
- Since
- 3.0.000 (2008-03-27)
Definition at line 13697 of file tcpdf.php.
13697 {
13698 if (empty($this->pdflayers)) {
13699 return;
13700 }
13701 foreach ($this->pdflayers as $key => $layer) {
13706 if (isset($layer['print']) AND ($layer['print'] !== NULL)) {
13708 }
13713 }
13714 }
References $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putpages()
|
protected |
Output pages (and replace page number aliases).
Definition at line 7895 of file tcpdf.php.
7895 {
7897 // get internal aliases for page numbers
7898 $pnalias = $this->getAllInternalPageNumberAliases();
7899 $num_pages = $this->numpages;
7900 $ptpa = TCPDF_STATIC::formatPageNumber(($this->starting_page_number + $num_pages - 1));
7902 $ptp_num_chars = $this->GetNumChars($ptpa);
7903 $pagegroupnum = 0;
7904 $groupnum = 0;
7905 $ptgu = 1;
7906 $ptga = 1;
7907 $ptg_num_chars = 1;
7909 // get current page
7911 $pagelen = strlen($temppage);
7912 // set replacements for total pages number
7915 $pnp_num_chars = $this->GetNumChars($pnpa);
7916 $pdiff = 0; // difference used for right shift alignment of page numbers
7917 $gdiff = 0; // difference used for right shift alignment of page group numbers
7918 if (!empty($this->pagegroups)) {
7920 $pagegroupnum = 0;
7921 ++$groupnum;
7922 $ptga = TCPDF_STATIC::formatPageNumber($this->pagegroups[$groupnum]);
7924 $ptg_num_chars = $this->GetNumChars($ptga);
7925 }
7926 ++$pagegroupnum;
7927 $pnga = TCPDF_STATIC::formatPageNumber($pagegroupnum);
7929 $png_num_chars = $this->GetNumChars($pnga);
7930 // replace page numbers
7931 $replace = array();
7932 $replace[] = array($ptgu, $ptg_num_chars, 9, $pnalias[2]['u']);
7933 $replace[] = array($ptga, $ptg_num_chars, 7, $pnalias[2]['a']);
7934 $replace[] = array($pngu, $png_num_chars, 9, $pnalias[3]['u']);
7935 $replace[] = array($pnga, $png_num_chars, 7, $pnalias[3]['a']);
7936 list($temppage, $gdiff) = TCPDF_STATIC::replacePageNumAliases($temppage, $replace, $gdiff);
7937 }
7938 // replace page numbers
7939 $replace = array();
7940 $replace[] = array($ptpu, $ptp_num_chars, 9, $pnalias[0]['u']);
7941 $replace[] = array($ptpa, $ptp_num_chars, 7, $pnalias[0]['a']);
7942 $replace[] = array($pnpu, $pnp_num_chars, 9, $pnalias[1]['u']);
7943 $replace[] = array($pnpa, $pnp_num_chars, 7, $pnalias[1]['a']);
7944 list($temppage, $pdiff) = TCPDF_STATIC::replacePageNumAliases($temppage, $replace, $pdiff);
7945 // replace right shift alias
7946 $temppage = $this->replaceRightShiftPageNumAliases($temppage, $pnalias[4], max($pdiff, $gdiff));
7947 // replace EPS marker
7948 $temppage = str_replace($this->epsmarker, '', $temppage);
7949 //Page
7954 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
7956 }
7958 foreach ($this->page_boxes as $box) {
7960 $out .= sprintf(' [%F %F %F %F]', $this->pagedim[$n][$box]['llx'], $this->pagedim[$n][$box]['lly'], $this->pagedim[$n][$box]['urx'], $this->pagedim[$n][$box]['ury']);
7961 }
7962 if (isset($this->pagedim[$n]['BoxColorInfo']) AND !empty($this->pagedim[$n]['BoxColorInfo'])) {
7964 foreach ($this->page_boxes as $box) {
7972 }
7975 }
7978 }
7982 foreach ($dashes as $dash) {
7984 }
7986 }
7988 }
7989 }
7991 }
7994 if (!$this->pdfa_mode) {
7996 }
7998 // page transitions
8001 }
8006 }
8009 }
8012 }
8015 }
8018 }
8021 }
8024 }
8026 }
8032 //Page content
8033 $p = ($this->compress) ? gzcompress($temppage) : $temppage;
8034 $this->_newobj();
8035 $p = $this->_getrawstream($p);
8036 $this->_out('<<'.$filter.'/Length '.strlen($p).'>> stream'."\n".$p."\n".'endstream'."\n".'endobj');
8037 }
8038 //Pages root
8041 foreach($this->page_obj_id as $page_obj) {
8043 }
8047 }
static UTF8ToUTF16BE($str, $setbom=false, $isunicode=true, &$currentfont)
Converts UTF-8 strings to UTF16-BE.
Definition: tcpdf_fonts.php:2035
static replacePageNumAliases($page, $replace, $diff=0)
Replace page number aliases with number.
Definition: tcpdf_static.php:361
replaceRightShiftPageNumAliases($page, $aliases, $diff)
Replace right shift page number aliases with spaces to correct right alignment.
Definition: tcpdf.php:7847
getAllInternalPageNumberAliases()
Return an array containing all internal page aliases.
Definition: tcpdf.php:7829
References $compress, $k, $n, $numpages, $out, $pagelen, _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\formatPageNumber(), getAllInternalPageNumberAliases(), GetNumChars(), getPageBuffer(), TCPDF_STATIC\replacePageNumAliases(), replaceRightShiftPageNumAliases(), sprintf, and TCPDF_FONTS\UTF8ToUTF16BE().
Referenced by _enddoc().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putresourcedict()
|
protected |
Output Resources Dictionary.
Definition at line 9364 of file tcpdf.php.
9364 {
9368 foreach ($this->fontkeys as $fontkey) {
9369 $font = $this->getFontBuffer($fontkey);
9371 }
9376 // layers
9377 if (!empty($this->pdflayers)) {
9379 foreach ($this->pdflayers as $layer) {
9381 }
9383 }
9384 if (!$this->pdfa_mode) {
9385 // transparency
9386 if (isset($this->extgstates) AND !empty($this->extgstates)) {
9389 if (isset($extgstate['name'])) {
9391 } else {
9393 }
9395 }
9397 }
9398 if (isset($this->gradients) AND !empty($this->gradients)) {
9399 $gp = '';
9400 $gs = '';
9401 foreach ($this->gradients as $id => $grad) {
9402 // gradient patterns
9403 $gp .= ' /p'.$id.' '.$grad['pattern'].' 0 R';
9404 // gradient shadings
9405 $gs .= ' /Sh'.$id.' '.$grad['id'].' 0 R';
9406 }
9409 }
9410 }
9411 // spot colors
9412 if (isset($this->spot_colors) AND !empty($this->spot_colors)) {
9414 foreach ($this->spot_colors as $color) {
9416 }
9418 }
9422 }
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:
◆ _putresources()
|
protected |
Output Resources.
Definition at line 9428 of file tcpdf.php.
9428 {
9429 $this->_putextgstates();
9430 $this->_putocg();
9431 $this->_putfonts();
9432 $this->_putimages();
9433 $this->_putspotcolors();
9434 $this->_putshaders();
9435 $this->_putxobjects();
9436 $this->_putresourcedict();
9437 $this->_putdests();
9438 $this->_putEmbeddedFiles();
9439 $this->_putannotsobjs();
9440 $this->_putjavascript();
9441 $this->_putbookmarks();
9442 $this->_putencryption();
9443 }
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:
◆ _putshaders()
|
protected |
Output gradient shaders.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14577 of file tcpdf.php.
14577 {
14578 if ($this->pdfa_mode) {
14579 return;
14580 }
14581 $idt = count($this->gradients); //index for transparency gradients
14582 foreach ($this->gradients as $id => $grad) {
14583 if (($grad['type'] == 2) OR ($grad['type'] == 3)) {
14584 $fc = $this->_newobj();
14588 $functions = '';
14589 $bounds = '';
14590 $encode = '';
14591 $i = 1;
14592 $num_cols = count($grad['colors']);
14593 $lastcols = $num_cols - 1;
14594 for ($i = 1; $i < $num_cols; ++$i) {
14595 $functions .= ($fc + $i).' 0 R ';
14596 if ($i < $lastcols) {
14598 }
14599 $encode .= '0 1 ';
14600 }
14607 for ($i = 1; $i < $num_cols; ++$i) {
14608 $this->_newobj();
14618 }
14619 // set transparency functions
14620 if ($grad['transparency']) {
14621 $ft = $this->_newobj();
14625 $functions = '';
14626 $i = 1;
14627 $num_cols = count($grad['colors']);
14628 for ($i = 1; $i < $num_cols; ++$i) {
14629 $functions .= ($ft + $i).' 0 R ';
14630 }
14637 for ($i = 1; $i < $num_cols; ++$i) {
14638 $this->_newobj();
14648 }
14649 }
14650 }
14651 // set shading object
14652 $this->_newobj();
14654 if (isset($grad['colspace'])) {
14656 } else {
14658 }
14659 if (isset($grad['background']) AND !empty($grad['background'])) {
14661 }
14662 if (isset($grad['antialias']) AND ($grad['antialias'] === true)) {
14664 }
14665 if ($grad['type'] == 2) {
14666 $out .= ' '.sprintf('/Coords [%F %F %F %F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3]);
14671 } elseif ($grad['type'] == 3) {
14672 //x0, y0, r0, x1, y1, r1
14673 //at this this time radius of inner circle is 0
14674 $out .= ' '.sprintf('/Coords [%F %F 0 %F %F %F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3], $grad['coords'][4]);
14679 } elseif ($grad['type'] == 6) {
14688 }
14691 if ($grad['transparency']) {
14692 $shading_transparency = preg_replace('/\/ColorSpace \/[^\s]+/si', '/ColorSpace /DeviceGray', $out);
14693 $shading_transparency = preg_replace('/\/Function [0-9]+ /si', '/Function '.$ft.' ', $shading_transparency);
14694 }
14696 // set pattern object
14697 $this->_newobj();
14704 // set shading and pattern for transparency mask
14705 if ($grad['transparency']) {
14706 // luminosity pattern
14707 $idgs = $id + $idt;
14708 $this->_newobj();
14709 $this->_out($shading_transparency);
14711 $this->_newobj();
14718 // luminosity XObject
14719 $oid = $this->_newobj();
14720 $this->xobjects['LX'.$oid] = array('n' => $oid);
14721 $filter = '';
14722 $stream = 'q /a0 gs /Pattern cs /p'.$idgs.' scn 0 0 '.$this->wPt.' '.$this->hPt.' re f Q';
14723 if ($this->compress) {
14724 $filter = ' /Filter /FlateDecode';
14725 $stream = gzcompress($stream);
14726 }
14727 $stream = $this->_getrawstream($stream);
14741 // SMask
14742 $this->_newobj();
14745 // ExtGState
14746 $this->_newobj();
14749 $this->extgstates[] = array('n' => $this->n, 'name' => 'TGS'.$id);
14750 }
14751 }
14752 }
References $n, $out, _getrawstream(), _newobj(), _out(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putsignature()
|
protected |
Add certification signature (DocMDP or UR3) You can set only one signature type.
- Since
- 4.6.008 (2009-05-07)
Definition at line 13289 of file tcpdf.php.
13289 {
13290 if ((!$this->sign) OR (!isset($this->signature_data['cert_type']))) {
13291 return;
13292 }
13293 $sigobjid = ($this->sig_obj_id + 1);
13300 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
13303 if ($this->signature_data['cert_type'] > 0) {
13309 } else {
13316 }
13319 }
13322 }
13325 }
13328 }
13331 }
13332 }
13334 // optional digest data (values must be calculated and replaced later)
13335 //$out .= ' /Data ********** 0 R';
13336 //$out .= ' /DigestMethod/MD5';
13337 //$out .= ' /DigestLocation[********** 34]';
13338 //$out .= ' /DigestValue<********************************>';
13341 }
13342 if (isset($this->signature_data['info']['Name']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Name'])) {
13344 }
13345 if (isset($this->signature_data['info']['Location']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Location'])) {
13346 $out .= ' /Location '.$this->_textstring($this->signature_data['info']['Location'], $sigobjid);
13347 }
13348 if (isset($this->signature_data['info']['Reason']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Reason'])) {
13350 }
13351 if (isset($this->signature_data['info']['ContactInfo']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['ContactInfo'])) {
13352 $out .= ' /ContactInfo '.$this->_textstring($this->signature_data['info']['ContactInfo'], $sigobjid);
13353 }
13358 }
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:
◆ _putspotcolors()
|
protected |
Output Spot Colors Resources.
- Since
- 4.0.024 (2008-09-12)
Definition at line 9332 of file tcpdf.php.
9332 {
9333 foreach ($this->spot_colors as $name => $color) {
9334 $this->_newobj();
9339 $out .= ' '.sprintf('/C1 [%F %F %F %F] ', ($color['C'] / 100), ($color['M'] / 100), ($color['Y'] / 100), ($color['K'] / 100));
9343 }
9344 }
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:
◆ _puttruetypeunicode()
|
protected |
Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)
- Parameters
-
$font (array) font data
- Since
- 1.52.0.TC005 (2005-01-05)
Definition at line 8926 of file tcpdf.php.
8926 {
8927 $fontname = '';
8928 if ($font['subset']) {
8929 // change name for font subsetting
8931 $subtag = strtr($subtag, '0123456789', 'ABCDEFGHIJ');
8932 $fontname .= $subtag.'+';
8933 }
8934 $fontname .= $font['name'];
8935 // Type0 Font
8936 // A composite font composed of other fonts, organized hierarchically
8948 // ToUnicode map for Identity-H
8949 $stream = TCPDF_FONT_DATA::$uni_identity_h;
8950 // ToUnicode Object
8951 $this->_newobj();
8952 $stream = ($this->compress) ? gzcompress($stream) : $stream;
8954 $stream = $this->_getrawstream($stream);
8955 $this->_out('<<'.$filter.'/Length '.strlen($stream).'>> stream'."\n".$stream."\n".'endstream'."\n".'endobj');
8956 // CIDFontType2
8957 // A CIDFont whose glyph descriptions are based on TrueType font technology
8958 $oid = $this->_newobj();
8962 // A dictionary containing entries that define the character collection of the CIDFont.
8963 $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry'], $oid);
8964 $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering'], $oid);
8965 $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement'];
8972 }
8976 // Font descriptor
8977 // A font descriptor describing the CIDFont default metrics other than its glyph widths
8978 $this->_newobj();
8981 foreach ($font['desc'] as $key => $value) {
8982 if (is_float($value)) {
8984 }
8986 }
8987 $fontdir = false;
8989 // A stream containing a TrueType font
8991 $fontdir = $this->FontFiles[$font['file']]['fontdir'];
8992 }
8997 $this->_newobj();
8998 // Embed CIDToGIDMap
8999 // A specification of the mapping from CIDs to glyph indices
9000 // search and get CTG font file to embedd
9001 $ctgfile = strtolower($font['ctg']);
9002 // search and get ctg font file to embedd
9003 $fontfile = TCPDF_FONTS::getFontFullPath($ctgfile, $fontdir);
9006 }
9007 $stream = $this->_getrawstream(file_get_contents($fontfile));
9009 if (substr($fontfile, -2) == '.z') { // check file extension
9010 // Decompresses data encoded using the public-domain
9011 // zlib/deflate compression method, reproducing the
9012 // original text or binary data
9014 }
9019 }
9020 }
static $uni_identity_h
ToUnicode map for Identity-H stream static.
Definition: tcpdf_font_data.php:18441
References $compress, $out, TCPDF_FONT_DATA\$uni_identity_h, _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), TCPDF_FONTS\getFontFullPath(), and sprintf.
Here is the call graph for this function:
◆ _putviewerpreferences()
|
protected |
Output viewer preferences.
- Returns
- string for viewer preferences
- Since
- 3.1.000 (2008-06-09)
Definition at line 9837 of file tcpdf.php.
9837 {
9838 $vp = $this->viewer_preferences;
9840 if ($this->rtl) {
9842 } else {
9844 }
9845 if (isset($vp['HideToolbar']) AND ($vp['HideToolbar'])) {
9847 }
9848 if (isset($vp['HideMenubar']) AND ($vp['HideMenubar'])) {
9850 }
9851 if (isset($vp['HideWindowUI']) AND ($vp['HideWindowUI'])) {
9853 }
9854 if (isset($vp['FitWindow']) AND ($vp['FitWindow'])) {
9856 }
9857 if (isset($vp['CenterWindow']) AND ($vp['CenterWindow'])) {
9859 }
9860 if (isset($vp['DisplayDocTitle']) AND ($vp['DisplayDocTitle'])) {
9862 }
9863 if (isset($vp['NonFullScreenPageMode'])) {
9865 }
9866 if (isset($vp['ViewArea'])) {
9868 }
9869 if (isset($vp['ViewClip'])) {
9871 }
9872 if (isset($vp['PrintArea'])) {
9874 }
9875 if (isset($vp['PrintClip'])) {
9877 }
9878 if (isset($vp['PrintScaling'])) {
9880 }
9883 }
9884 if (isset($vp['PickTrayByPDFSize'])) {
9885 if ($vp['PickTrayByPDFSize']) {
9887 } else {
9889 }
9890 }
9891 if (isset($vp['PrintPageRange'])) {
9892 $PrintPageRangeNum = '';
9894 $PrintPageRangeNum .= ' '.($v - 1).'';
9895 }
9897 }
9898 if (isset($vp['NumCopies'])) {
9900 }
9903 }
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:
◆ _putXMP()
|
protected |
Put XMP data object and return ID.
- Returns
- (int) The object ID.
- Since
- 5.9.121 (2011-09-28)
Definition at line 9512 of file tcpdf.php.
9512 {
9513 $oid = $this->_newobj();
9514 // store current isunicode value
9515 $prev_isunicode = $this->isunicode;
9516 $this->isunicode = true;
9517 $prev_encrypted = $this->encrypted;
9518 $this->encrypted = false;
9519 // set XMP data
9520 $xmp = '<?xpacket begin="'.TCPDF_FONTS::unichr(0xfeff, $this->isunicode).'" id="W5M0MpCehiHzreSzNTczkc9d"?>'."\n";
9521 $xmp .= '<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.2.1-c043 52.372728, 2009/01/18-15:08:04">'."\n";
9522 $xmp .= "\t".'<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">'."\n";
9523 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">'."\n";
9524 $xmp .= "\t\t\t".'<dc:format>application/pdf</dc:format>'."\n";
9525 $xmp .= "\t\t\t".'<dc:title>'."\n";
9526 $xmp .= "\t\t\t\t".'<rdf:Alt>'."\n";
9527 $xmp .= "\t\t\t\t\t".'<rdf:li xml:lang="x-default">'.TCPDF_STATIC::_escapeXML($this->title).'</rdf:li>'."\n";
9528 $xmp .= "\t\t\t\t".'</rdf:Alt>'."\n";
9529 $xmp .= "\t\t\t".'</dc:title>'."\n";
9530 $xmp .= "\t\t\t".'<dc:creator>'."\n";
9531 $xmp .= "\t\t\t\t".'<rdf:Seq>'."\n";
9533 $xmp .= "\t\t\t\t".'</rdf:Seq>'."\n";
9534 $xmp .= "\t\t\t".'</dc:creator>'."\n";
9535 $xmp .= "\t\t\t".'<dc:description>'."\n";
9536 $xmp .= "\t\t\t\t".'<rdf:Alt>'."\n";
9537 $xmp .= "\t\t\t\t\t".'<rdf:li xml:lang="x-default">'.TCPDF_STATIC::_escapeXML($this->subject).'</rdf:li>'."\n";
9538 $xmp .= "\t\t\t\t".'</rdf:Alt>'."\n";
9539 $xmp .= "\t\t\t".'</dc:description>'."\n";
9540 $xmp .= "\t\t\t".'<dc:subject>'."\n";
9541 $xmp .= "\t\t\t\t".'<rdf:Bag>'."\n";
9543 $xmp .= "\t\t\t\t".'</rdf:Bag>'."\n";
9544 $xmp .= "\t\t\t".'</dc:subject>'."\n";
9545 $xmp .= "\t\t".'</rdf:Description>'."\n";
9546 // convert doc creation date format
9547 $dcdate = TCPDF_STATIC::getFormattedDate($this->doc_creation_timestamp);
9548 $doccreationdate = substr($dcdate, 0, 4).'-'.substr($dcdate, 4, 2).'-'.substr($dcdate, 6, 2);
9549 $doccreationdate .= 'T'.substr($dcdate, 8, 2).':'.substr($dcdate, 10, 2).':'.substr($dcdate, 12, 2);
9550 $doccreationdate .= substr($dcdate, 14, 3).':'.substr($dcdate, 18, 2);
9551 $doccreationdate = TCPDF_STATIC::_escapeXML($doccreationdate);
9552 // convert doc modification date format
9553 $dmdate = TCPDF_STATIC::getFormattedDate($this->doc_modification_timestamp);
9554 $docmoddate = substr($dmdate, 0, 4).'-'.substr($dmdate, 4, 2).'-'.substr($dmdate, 6, 2);
9555 $docmoddate .= 'T'.substr($dmdate, 8, 2).':'.substr($dmdate, 10, 2).':'.substr($dmdate, 12, 2);
9556 $docmoddate .= substr($dmdate, 14, 3).':'.substr($dmdate, 18, 2);
9557 $docmoddate = TCPDF_STATIC::_escapeXML($docmoddate);
9558 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:xmp="http://ns.adobe.com/xap/1.0/">'."\n";
9559 $xmp .= "\t\t\t".'<xmp:CreateDate>'.$doccreationdate.'</xmp:CreateDate>'."\n";
9560 $xmp .= "\t\t\t".'<xmp:CreatorTool>'.$this->creator.'</xmp:CreatorTool>'."\n";
9561 $xmp .= "\t\t\t".'<xmp:ModifyDate>'.$docmoddate.'</xmp:ModifyDate>'."\n";
9562 $xmp .= "\t\t\t".'<xmp:MetadataDate>'.$doccreationdate.'</xmp:MetadataDate>'."\n";
9563 $xmp .= "\t\t".'</rdf:Description>'."\n";
9564 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">'."\n";
9565 $xmp .= "\t\t\t".'<pdf:Keywords>'.TCPDF_STATIC::_escapeXML($this->keywords).'</pdf:Keywords>'."\n";
9566 $xmp .= "\t\t\t".'<pdf:Producer>'.TCPDF_STATIC::_escapeXML(TCPDF_STATIC::getTCPDFProducer()).'</pdf:Producer>'."\n";
9567 $xmp .= "\t\t".'</rdf:Description>'."\n";
9568 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/">'."\n";
9569 $uuid = 'uuid:'.substr($this->file_id, 0, 8).'-'.substr($this->file_id, 8, 4).'-'.substr($this->file_id, 12, 4).'-'.substr($this->file_id, 16, 4).'-'.substr($this->file_id, 20, 12);
9570 $xmp .= "\t\t\t".'<xmpMM:DocumentID>'.$uuid.'</xmpMM:DocumentID>'."\n";
9571 $xmp .= "\t\t\t".'<xmpMM:InstanceID>'.$uuid.'</xmpMM:InstanceID>'."\n";
9572 $xmp .= "\t\t".'</rdf:Description>'."\n";
9573 if ($this->pdfa_mode) {
9574 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:pdfaid="http://www.aiim.org/pdfa/ns/id/">'."\n";
9575 $xmp .= "\t\t\t".'<pdfaid:part>1</pdfaid:part>'."\n";
9576 $xmp .= "\t\t\t".'<pdfaid:conformance>B</pdfaid:conformance>'."\n";
9577 $xmp .= "\t\t".'</rdf:Description>'."\n";
9578 }
9579 // XMP extension schemas
9580 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:pdfaExtension="http://www.aiim.org/pdfa/ns/extension/" xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#" xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#">'."\n";
9581 $xmp .= "\t\t\t".'<pdfaExtension:schemas>'."\n";
9582 $xmp .= "\t\t\t\t".'<rdf:Bag>'."\n";
9583 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9584 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://ns.adobe.com/pdf/1.3/</pdfaSchema:namespaceURI>'."\n";
9585 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>pdf</pdfaSchema:prefix>'."\n";
9586 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>Adobe PDF Schema</pdfaSchema:schema>'."\n";
9587 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9588 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9589 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://ns.adobe.com/xap/1.0/mm/</pdfaSchema:namespaceURI>'."\n";
9590 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>xmpMM</pdfaSchema:prefix>'."\n";
9591 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>XMP Media Management Schema</pdfaSchema:schema>'."\n";
9592 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:property>'."\n";
9593 $xmp .= "\t\t\t\t\t\t\t".'<rdf:Seq>'."\n";
9594 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9595 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9596 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>UUID based identifier for specific incarnation of a document</pdfaProperty:description>'."\n";
9597 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>InstanceID</pdfaProperty:name>'."\n";
9598 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>URI</pdfaProperty:valueType>'."\n";
9599 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9600 $xmp .= "\t\t\t\t\t\t\t".'</rdf:Seq>'."\n";
9601 $xmp .= "\t\t\t\t\t\t".'</pdfaSchema:property>'."\n";
9602 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9603 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9604 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://www.aiim.org/pdfa/ns/id/</pdfaSchema:namespaceURI>'."\n";
9605 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>pdfaid</pdfaSchema:prefix>'."\n";
9606 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>PDF/A ID Schema</pdfaSchema:schema>'."\n";
9607 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:property>'."\n";
9608 $xmp .= "\t\t\t\t\t\t\t".'<rdf:Seq>'."\n";
9609 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9610 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9611 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Part of PDF/A standard</pdfaProperty:description>'."\n";
9612 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>part</pdfaProperty:name>'."\n";
9613 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Integer</pdfaProperty:valueType>'."\n";
9614 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9615 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9616 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9617 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Amendment of PDF/A standard</pdfaProperty:description>'."\n";
9618 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>amd</pdfaProperty:name>'."\n";
9619 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Text</pdfaProperty:valueType>'."\n";
9620 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9621 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9622 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9623 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Conformance level of PDF/A standard</pdfaProperty:description>'."\n";
9624 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>conformance</pdfaProperty:name>'."\n";
9625 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Text</pdfaProperty:valueType>'."\n";
9626 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9627 $xmp .= "\t\t\t\t\t\t\t".'</rdf:Seq>'."\n";
9628 $xmp .= "\t\t\t\t\t\t".'</pdfaSchema:property>'."\n";
9629 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9630 $xmp .= "\t\t\t\t".'</rdf:Bag>'."\n";
9631 $xmp .= "\t\t\t".'</pdfaExtension:schemas>'."\n";
9632 $xmp .= "\t\t".'</rdf:Description>'."\n";
9633 $xmp .= "\t".'</rdf:RDF>'."\n";
9634 $xmp .= $this->custom_xmp;
9635 $xmp .= '</x:xmpmeta>'."\n";
9636 $xmp .= '<?xpacket end="w"?>';
9637 $out = '<< /Type /Metadata /Subtype /XML /Length '.strlen($xmp).' >> stream'."\n".$xmp."\n".'endstream'."\n".'endobj';
9638 // restore previous isunicode value
9639 $this->isunicode = $prev_isunicode;
9640 $this->encrypted = $prev_encrypted;
9642 return $oid;
9643 }
static _escapeXML($str)
Escape some special characters (< > &) for XML output.
Definition: tcpdf_static.php:317
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:
◆ _putxobjects()
|
protected |
Output Form XObjects Templates.
- Since
- 5.8.017 (2010-08-24)
- See also
- startTemplate(), endTemplate(), printTemplate()
Definition at line 9229 of file tcpdf.php.
9229 {
9238 if ($this->compress) {
9239 $stream = gzcompress($stream);
9241 }
9242 $out .= sprintf(' /BBox [%F %F %F %F]', ($data['x'] * $this->k), (-$data['y'] * $this->k), (($data['w'] + $data['x']) * $this->k), (($data['h'] - $data['y']) * $this->k));
9246 if (!$this->pdfa_mode) {
9247 // transparency
9253 } else {
9255 }
9257 }
9259 }
9261 $gp = '';
9262 $gs = '';
9264 // gradient patterns
9265 $gp .= ' /p'.$id.' '.$this->gradients[$id]['pattern'].' 0 R';
9266 // gradient shadings
9267 $gs .= ' /Sh'.$id.' '.$this->gradients[$id]['id'].' 0 R';
9268 }
9271 }
9272 }
9273 // spot colors
9278 }
9280 }
9281 // fonts
9286 }
9288 }
9289 // images or nested xobjects
9294 }
9297 }
9299 }
9302 // set transparency group
9307 }
9310 }
9313 }
9314 }
9316 }
9323 }
9324 }
9325 }
References $data, $k, $out, _getobj(), _getrawstream(), _out(), and sprintf.
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _textstring()
|
protected |
Format a text string for meta information.
- Parameters
-
$s (string) string to escape. $n (int) object ID
- Returns
- string escaped string.
Definition at line 10244 of file tcpdf.php.
10244 {
10245 if ($this->isunicode) {
10246 //Convert string to UTF-16BE
10248 }
10250 }
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:
◆ _UEvalue()
|
protected |
Compute UE value (used for encryption)
- Returns
- string UE value
- Since
- 5.9.006 (2010-10-19)
Definition at line 10643 of file tcpdf.php.
10643 {
10644 $hashkey = hash('sha256', $this->encryptdata['user_password'].$this->encryptdata['UKS'], true);
10646 }
References TCPDF_STATIC\_AESnopad().
Referenced by _generateencryptionkey().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _Uvalue()
|
protected |
Compute U value (used for encryption)
- Returns
- string U value
- Since
- 2.0.000 (2008-01-02)
Definition at line 10610 of file tcpdf.php.
10610 {
10611 if ($this->encryptdata['mode'] == 0) { // RC4-40
10612 return TCPDF_STATIC::_RC4($this->encryptdata['key'], TCPDF_STATIC::$enc_padding, $this->last_enc_key, $this->last_enc_key_c);
10613 } elseif ($this->encryptdata['mode'] < 3) { // RC4-128, AES-128
10615 $enc = TCPDF_STATIC::_RC4($this->encryptdata['key'], $tmp, $this->last_enc_key, $this->last_enc_key_c);
10616 $len = strlen($tmp);
10617 for ($i = 1; $i <= 19; ++$i) {
10618 $ek = '';
10619 for ($j = 0; $j < $len; ++$j) {
10620 $ek .= chr(ord($this->encryptdata['key'][$j]) ^ $i);
10621 }
10622 $enc = TCPDF_STATIC::_RC4($ek, $enc, $this->last_enc_key, $this->last_enc_key_c);
10623 }
10624 $enc .= str_repeat("\x00", 16);
10625 return substr($enc, 0, 32);
10626 } elseif ($this->encryptdata['mode'] == 3) { // AES-256
10628 // User Validation Salt
10629 $this->encryptdata['UVS'] = substr($seed, 0, 8);
10630 // User Key Salt
10631 $this->encryptdata['UKS'] = substr($seed, 8, 16);
10632 return hash('sha256', $this->encryptdata['user_password'].$this->encryptdata['UVS'], true).$this->encryptdata['UVS'].$this->encryptdata['UKS'];
10633 }
10634 }
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:
◆ AcceptPageBreak()
| 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.
- Returns
- boolean
- Since
- 1.4
- See also
- SetAutoPageBreak()
Definition at line 4913 of file tcpdf.php.
4913 {
4914 if ($this->num_columns > 1) {
4915 // multi column mode
4916 if ($this->current_column < ($this->num_columns - 1)) {
4917 // go to next column
4918 $this->selectColumn($this->current_column + 1);
4919 } elseif ($this->AutoPageBreak) {
4920 // add a new page
4921 $this->AddPage();
4922 // set first column
4923 $this->selectColumn(0);
4924 }
4925 // avoid page breaking from checkPageBreak()
4926 return false;
4927 }
4929 }
AddPage($orientation='', $format='', $keepmargins=false, $tocpage=false)
Adds a new page to the document.
Definition: tcpdf.php:3102
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:
◆ addEmptySignatureAppearance()
| 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)
- Parameters
-
$x (float) Abscissa of the upper-left corner. $y (float) Ordinate of the upper-left corner. $w (float) Width of the signature area. $h (float) Height of the signature area. $page (int) option page number (if < 0 the current page is used). $name (string) Name of the signature.
- Since
- 5.9.101 (2011-07-06)
Definition at line 13467 of file tcpdf.php.
13467 {
13468 ++$this->n;
13469 $this->empty_signature_appearance[] = array('objid' => $this->n) + $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
13470 }
getSignatureAppearanceArray($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')
Get the array that defines the signature appearance (page and rectangle coordinates).
Definition: tcpdf.php:13485
References $h, $n, $page, $w, $x, $y, and getSignatureAppearanceArray().
Here is the call graph for this function:
◆ addExtGState()
|
protected |
Add transparency parameters to the current extgstate.
- Parameters
-
$parms (array) parameters
- Returns
- the number of extgstates
- Since
- 3.0.000 (2008-03-27)
Definition at line 13797 of file tcpdf.php.
13797 {
13798 if ($this->pdfa_mode) {
13799 // transparencies are not allowed in PDF/A mode
13800 return;
13801 }
13802 // check if this ExtGState already exist
13803 foreach ($this->extgstates as $i => $ext) {
13804 if ($ext['parms'] == $parms) {
13805 if ($this->inxobj) {
13806 // we are inside an XObject template
13808 }
13809 // return reference to existing ExtGState
13810 return $i;
13811 }
13812 }
13813 $n = (count($this->extgstates) + 1);
13815 if ($this->inxobj) {
13816 // we are inside an XObject template
13818 }
13820 }
Referenced by setAlpha(), and setOverprint().
Here is the caller graph for this function:
◆ AddFont()
| 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.
- Parameters
-
$family (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. $style (string) Font style. Possible values are (case insensitive): - empty string: regular (default)
- B: bold
- I: italic
- BI or IB: bold italic
$fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
- Returns
- array containing the font data, or false in case of error.
- Parameters
-
$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.
- Since
- 1.5
- See also
- SetFont(), setFontSubsetting()
Definition at line 4171 of file tcpdf.php.
4171 {
4172 if ($subset === 'default') {
4173 $subset = $this->font_subsetting;
4174 }
4175 if ($this->pdfa_mode) {
4176 $subset = false;
4177 }
4180 $family = $this->FontFamily;
4181 } else {
4183 }
4184 }
4185 // move embedded styles on $style
4186 if (substr($family, -1) == 'I') {
4188 $family = substr($family, 0, -1);
4189 }
4190 if (substr($family, -1) == 'B') {
4192 $family = substr($family, 0, -1);
4193 }
4194 // normalize family name
4195 $family = strtolower($family);
4196 if ((!$this->isunicode) AND ($family == 'arial')) {
4197 $family = 'helvetica';
4198 }
4199 if (($family == 'symbol') OR ($family == 'zapfdingbats')) {
4201 }
4202 if ($this->pdfa_mode AND (isset($this->CoreFonts[$family]))) {
4203 // all fonts must be embedded
4204 $family = 'pdfa'.$family;
4205 }
4206 $tempstyle = strtoupper($style);
4208 // underline
4209 if (strpos($tempstyle, 'U') !== false) {
4210 $this->underline = true;
4211 } else {
4212 $this->underline = false;
4213 }
4214 // line-through (deleted)
4215 if (strpos($tempstyle, 'D') !== false) {
4216 $this->linethrough = true;
4217 } else {
4218 $this->linethrough = false;
4219 }
4220 // overline
4221 if (strpos($tempstyle, 'O') !== false) {
4222 $this->overline = true;
4223 } else {
4224 $this->overline = false;
4225 }
4226 // bold
4227 if (strpos($tempstyle, 'B') !== false) {
4229 }
4230 // oblique
4231 if (strpos($tempstyle, 'I') !== false) {
4233 }
4234 $bistyle = $style;
4235 $fontkey = $family.$style;
4236 $font_style = $style.($this->underline ? 'U' : '').($this->linethrough ? 'D' : '').($this->overline ? 'O' : '');
4237 $fontdata = array('fontkey' => $fontkey, 'family' => $family, 'style' => $font_style);
4238 // check if the font has been already added
4239 $fb = $this->getFontBuffer($fontkey);
4240 if ($fb !== false) {
4241 if ($this->inxobj) {
4242 // we are inside an XObject template
4244 }
4245 return $fontdata;
4246 }
4247 // get specified font directory (if any)
4248 $fontdir = false;
4250 $fontdir = dirname($fontfile);
4252 $fontdir = '';
4253 } else {
4254 $fontdir .= '/';
4255 }
4256 }
4257 // true when the font style variation is missing
4258 $missing_style = false;
4259 // search and include font file
4261 // build a standard filenames for specified font
4263 $fontfile = TCPDF_FONTS::getFontFullPath($tmp_fontfile, $fontdir);
4265 $missing_style = true;
4266 // try to remove the style part
4267 $tmp_fontfile = str_replace(' ', '', $family).'.php';
4268 $fontfile = TCPDF_FONTS::getFontFullPath($tmp_fontfile, $fontdir);
4269 }
4270 }
4271 // include font file
4273 include($fontfile);
4274 } else {
4276 }
4277 // check font parameters
4278 if ((!isset($type)) OR (!isset($cw))) {
4280 }
4281 // SET default parameters
4284 }
4286 $enc = '';
4287 }
4289 $cidinfo = array('Registry'=>'Adobe', 'Ordering'=>'Identity', 'Supplement'=>0);
4290 $cidinfo['uni2cid'] = array();
4291 }
4293 $ctg = '';
4294 }
4296 $desc = array();
4297 }
4299 $up = -100;
4300 }
4302 $ut = 50;
4303 }
4305 $cw = array();
4306 }
4308 // set default width
4309 if (isset($desc['MissingWidth']) AND ($desc['MissingWidth'] > 0)) {
4310 $dw = $desc['MissingWidth'];
4311 } elseif (isset($cw[32])) {
4312 $dw = $cw[32];
4313 } else {
4314 $dw = 600;
4315 }
4316 }
4317 ++$this->numfonts;
4318 if ($type == 'core') {
4319 $name = $this->CoreFonts[$fontkey];
4320 $subset = false;
4321 } elseif (($type == 'TrueType') OR ($type == 'Type1')) {
4322 $subset = false;
4323 } elseif ($type == 'TrueTypeUnicode') {
4324 $enc = 'Identity-H';
4325 } elseif ($type == 'cidfont0') {
4326 if ($this->pdfa_mode) {
4328 }
4329 } else {
4331 }
4332 // set name if unset
4333 if (!isset($name) OR empty($name)) {
4334 $name = $fontkey;
4335 }
4336 // create artificial font style variations if missing (only works with non-embedded fonts)
4337 if (($type != 'core') AND $missing_style) {
4338 // style variations
4340 $name .= $styles[$bistyle];
4341 // artificial bold
4342 if (strpos($bistyle, 'B') !== false) {
4343 if (isset($desc['StemV'])) {
4344 // from normal to bold
4345 $desc['StemV'] = round($desc['StemV'] * 1.75);
4346 } else {
4347 // bold
4348 $desc['StemV'] = 123;
4349 }
4350 }
4351 // artificial italic
4352 if (strpos($bistyle, 'I') !== false) {
4353 if (isset($desc['ItalicAngle'])) {
4354 $desc['ItalicAngle'] -= 11;
4355 } else {
4356 $desc['ItalicAngle'] = -11;
4357 }
4358 if (isset($desc['Flags'])) {
4359 $desc['Flags'] |= 64; //bit 7
4360 } else {
4361 $desc['Flags'] = 64;
4362 }
4363 }
4364 }
4365 // check if the array of characters bounding boxes is defined
4366 if (!isset($cbbox)) {
4367 $cbbox = array();
4368 }
4369 // initialize subsetchars
4370 $subsetchars = array_fill(0, 255, true);
4371 $this->setFontBuffer($fontkey, array('fontkey' => $fontkey, 'i' => $this->numfonts, 'type' => $type, 'name' => $name, 'desc' => $desc, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'cbbox' => $cbbox, 'dw' => $dw, 'enc' => $enc, 'cidinfo' => $cidinfo, 'file' => $file, 'ctg' => $ctg, 'subset' => $subset, 'subsetchars' => $subsetchars));
4372 if ($this->inxobj) {
4373 // we are inside an XObject template
4375 }
4376 if (isset($diff) AND (!empty($diff))) {
4377 //Search existing encodings
4378 $d = 0;
4379 $nb = count($this->diffs);
4380 for ($i=1; $i <= $nb; ++$i) {
4381 if ($this->diffs[$i] == $diff) {
4382 $d = $i;
4383 break;
4384 }
4385 }
4387 $d = $nb + 1;
4388 $this->diffs[$d] = $diff;
4389 }
4391 }
4394 if ((strcasecmp($type,'TrueType') == 0) OR (strcasecmp($type, 'TrueTypeUnicode') == 0)) {
4395 $this->FontFiles[$file] = array('length1' => $originalsize, 'fontdir' => $fontdir, 'subset' => $subset, 'fontkeys' => array($fontkey));
4396 } elseif ($type != 'core') {
4397 $this->FontFiles[$file] = array('length1' => $size1, 'length2' => $size2, 'fontdir' => $fontdir, 'subset' => $subset, 'fontkeys' => array($fontkey));
4398 }
4399 } else {
4400 // update fontkeys that are sharing this font file
4404 }
4405 }
4406 }
4407 return $fontdata;
4408 }
References $d, $file, $font_subsetting, $FontFamily, $numfonts, $style, $styles, $xobjid, TCPDF_STATIC\empty_string(), Error(), getFontBuffer(), TCPDF_FONTS\getFontFullPath(), 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:
◆ addHtmlLink()
| TCPDF::addHtmlLink | ( | $url, | |
| $name, | |||
$fill = false, |
|||
$firstline = false, |
|||
$color = '', |
|||
$style = -1, |
|||
$firstblock = false |
|||
| ) |
Output anchor link.
- Parameters
-
$url (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>) $name (string) link name $fill (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.
- Returns
- the number of cells used or the remaining text if $firstline = true;
Definition at line 10374 of file tcpdf.php.
10374 {
10376 // convert url to internal link
10378 if (isset($lnkdata[0]) ) {
10379 $page = substr($lnkdata[0], 1);
10380 if (isset($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
10381 $lnky = floatval($lnkdata[1]);
10382 } else {
10383 $lnky = 0;
10384 }
10387 }
10388 }
10389 // store current settings
10390 $prevcolor = $this->fgcolor;
10391 $prevstyle = $this->FontStyle;
10392 if (empty($color)) {
10393 $this->SetTextColorArray($this->htmlLinkColorArray);
10394 } else {
10395 $this->SetTextColorArray($color);
10396 }
10399 } else {
10401 }
10402 $ret = $this->Write($this->lasth, $name, $url, $fill, '', false, 0, $firstline, $firstblock, 0);
10403 // restore settings
10405 $this->SetTextColorArray($prevcolor);
10407 }
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.
Definition: tcpdf.php:6272
SetLink($link, $y=0, $page=-1)
Defines the page and position a link points to.
Definition: tcpdf.php:4699
References $fgcolor, $FontStyle, $page, $ret, $style, $url, 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:
◆ addHTMLTOC()
| 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.
- Parameters
-
$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).
- Since
- 5.0.001 (2010-05-06)
- See also
- addTOCPage(), endTOCPage(), addTOC()
Definition at line 21499 of file tcpdf.php.
21499 {
21500 $filler = ' ';
21501 $prev_htmlLinkColorArray = $this->htmlLinkColorArray;
21502 $prev_htmlLinkFontStyle = $this->htmlLinkFontStyle;
21503 // set new style for link
21504 $this->htmlLinkColorArray = array();
21505 $this->htmlLinkFontStyle = '';
21506 $page_first = $this->getPage();
21507 $page_fill_start = false;
21508 $page_fill_end = false;
21509 // get the font type used for numbers in each template
21510 $current_font = $this->FontFamily;
21513 foreach ($dom as $key => $value) {
21514 if ($value['value'] == '#TOC_PAGE_NUMBER#') {
21517 }
21518 }
21519 }
21520 $this->SetFont($current_font);
21521 $maxpage = 0; //used for pages on attached documents
21522 foreach ($this->outlines as $key => $outline) {
21523 // get HTML template
21526 $pagenum = $outline['p'];
21527 } else {
21528 // placemark to be replaced with the correct number
21529 $pagenum = '{#'.($outline['p']).'}';
21530 if ($templates['F'.$outline['l']]) {
21531 $pagenum = '{'.$pagenum.'}';
21532 }
21533 $maxpage = max($maxpage, $outline['p']);
21534 }
21535 // replace templates with current values
21538 // add link to page
21540 // write bookmark entry
21542 }
21543 // restore link styles
21544 $this->htmlLinkColorArray = $prev_htmlLinkColorArray;
21545 $this->htmlLinkFontStyle = $prev_htmlLinkFontStyle;
21546 // move TOC page and replace numbers
21547 $page_last = $this->getPage();
21548 $numpages = ($page_last - $page_first + 1);
21549 // account for booklet mode
21550 if ($this->booklet) {
21551 // check if a blank page is required before TOC
21552 $page_fill_start = ((($page_first % 2) == 0) XOR (($page % 2) == 0));
21553 $page_fill_end = (!((($numpages % 2) == 0) XOR ($page_fill_start)));
21554 if ($page_fill_start) {
21555 // add a page at the end (to be moved before TOC)
21556 $this->addPage();
21557 ++$page_last;
21558 ++$numpages;
21559 }
21560 if ($page_fill_end) {
21561 // add a page at the end
21562 $this->addPage();
21563 ++$page_last;
21564 ++$numpages;
21565 }
21566 }
21567 $maxpage = max($maxpage, $page_last);
21569 for ($p = $page_first; $p <= $page_last; ++$p) {
21570 // get page data
21571 $temppage = $this->getPageBuffer($p);
21573 // update page numbers
21574 $a = '{#'.$n.'}';
21575 // get page number aliases
21576 $pnalias = $this->getInternalPageNumberAliases($a);
21577 // calculate replacement number
21580 } else {
21581 $np = $n;
21582 }
21583 $na = TCPDF_STATIC::formatTOCPageNumber(($this->starting_page_number + $np - 1));
21585 // replace aliases with numbers
21586 foreach ($pnalias['u'] as $u) {
21587 if ($correct_align) {
21588 $sfill = str_repeat($filler, (strlen($u) - strlen($nu.' ')));
21589 if ($this->rtl) {
21590 $nr = $nu.TCPDF_FONTS::UTF8ToUTF16BE(' '.$sfill, false, $this->isunicode, $this->CurrentFont);
21591 } else {
21592 $nr = TCPDF_FONTS::UTF8ToUTF16BE($sfill.' ', false, $this->isunicode, $this->CurrentFont).$nu;
21593 }
21594 } else {
21595 $nr = $nu;
21596 }
21597 $temppage = str_replace($u, $nr, $temppage);
21598 }
21599 foreach ($pnalias['a'] as $a) {
21600 if ($correct_align) {
21601 $sfill = str_repeat($filler, (strlen($a) - strlen($na.' ')));
21602 if ($this->rtl) {
21603 $nr = $na.' '.$sfill;
21604 } else {
21605 $nr = $sfill.' '.$na;
21606 }
21607 } else {
21608 $nr = $na;
21609 }
21610 $temppage = str_replace($a, $nr, $temppage);
21611 }
21612 }
21613 // save changes
21614 $this->setPageBuffer($p, $temppage);
21615 }
21616 // move pages
21618 if ($page_fill_start) {
21619 $this->movePage($page_last, $page_first);
21620 }
21623 }
21624 }
21625 }
static formatTOCPageNumber($num)
Format the page numbers on the Table Of Content.
Definition: tcpdf_static.php:1031
Bookmark($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='')
Adds a bookmark.
Definition: tcpdf.php:12302
writeHTML($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='')
Allows to preserve some HTML formatting (limited support).
Definition: tcpdf.php:17120
getInternalPageNumberAliases($a='')
Return an array containing variations for the basic page number alias.
Definition: tcpdf.php:7808
References $html, $n, $row, $style, TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber(), and TCPDF_FONTS\UTF8ToUTF16BE().
Here is the call graph for this function:
◆ addHTMLVertSpace()
|
protected |
Add vertical spaces if needed.
- Parameters
-
$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 19906 of file tcpdf.php.
19906 {
19907 if ($firsttag) {
19908 $this->Ln(0, $cell);
19909 $this->htmlvspace = 0;
19910 return;
19911 }
19912 if ($lasttag) {
19913 $this->Ln($hbz, $cell);
19914 $this->htmlvspace = 0;
19915 return;
19916 }
19917 if ($hb < $this->htmlvspace) {
19918 $hd = 0;
19919 } else {
19920 $hd = $hb - $this->htmlvspace;
19921 $this->htmlvspace = $hb;
19922 }
19923 $this->Ln(($hbz + $hd), $cell);
19924 }
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:
◆ addJavascriptObject()
| TCPDF::addJavascriptObject | ( | $script, | |
$onload = false |
|||
| ) |
Adds a javascript object and return object ID.
- Parameters
-
$script (string) Javascript code $onload (boolean) if true executes this object when opening the document
- Returns
- int internal object ID
- Since
- 4.8.000 (2009-09-07)
Definition at line 12506 of file tcpdf.php.
12506 {
12507 if ($this->pdfa_mode) {
12508 // javascript is not allowed in PDF/A mode
12509 return false;
12510 }
12511 ++$this->n;
12514 }
References $n.
Referenced by Button().
Here is the caller graph for this function:
◆ AddLink()
| 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().
- Since
- 1.5
Definition at line 4683 of file tcpdf.php.
References $n.
Referenced by addHtmlLink(), and openHTMLTagHandler().
Here is the caller graph for this function:
◆ AddPage()
| 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.
- Parameters
-
$orientation (string) page orientation. Possible values are (case insensitive): - P or PORTRAIT (default)
- L or LANDSCAPE
$format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). $keepmargins (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).
- Since
- 1.0
- See also
- startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
Definition at line 3102 of file tcpdf.php.
3102 {
3103 if ($this->inxobj) {
3104 // we are inside an XObject template
3105 return;
3106 }
3107 if (!isset($this->original_lMargin) OR $keepmargins) {
3108 $this->original_lMargin = $this->lMargin;
3109 }
3110 if (!isset($this->original_rMargin) OR $keepmargins) {
3111 $this->original_rMargin = $this->rMargin;
3112 }
3113 // terminate previous page
3114 $this->endPage();
3115 // start new page
3117 }
startPage($orientation='', $format='', $tocpage=false)
Starts a new page to the document.
Definition: tcpdf.php:3152
References $lMargin, $rMargin, $tocpage, endPage(), and startPage().
Referenced by AcceptPageBreak(), addTOCPage(), checkPageBreak(), Close(), and MC_TCPDF\PrintChapter().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ addPageRegion()
| 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.
- Parameters
-
$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).
- Since
- 5.9.003 (2010-10-13)
- See also
- setPageRegions(), getPageRegions()
Definition at line 22547 of file tcpdf.php.
22547 {
22548 if (!isset($region['page']) OR empty($region['page'])) {
22550 }
22551 if (isset($region['xt']) AND isset($region['xb']) AND ($region['xt'] > 0) AND ($region['xb'] > 0)
22552 AND isset($region['yt']) AND isset($region['yb']) AND ($region['yt'] >= 0) AND ($region['yt'] < $region['yb'])
22553 AND isset($region['side']) AND (($region['side'] == 'L') OR ($region['side'] == 'R'))) {
22554 $this->page_regions[] = $region;
22555 }
22556 }
◆ AddSpotColor()
| 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.
- Parameters
-
$name (string) Full name of the spot color. $c (float) Cyan color for CMYK. Value between 0 and 100. $m (float) Magenta color for CMYK. Value between 0 and 100. $y (float) Yellow color for CMYK. Value between 0 and 100. $k (float) Key (Black) color for CMYK. Value between 0 and 100.
- Since
- 4.0.024 (2008-09-12)
Definition at line 3716 of file tcpdf.php.
3716 {
3717 if (!isset($this->spot_colors[$name])) {
3718 $i = (1 + count($this->spot_colors));
3719 $this->spot_colors[$name] = array('C' => $c, 'M' => $m, 'Y' => $y, 'K' => $k, 'name' => $name, 'i' => $i);
3720 }
3721 }
Referenced by ImageEps(), and setColor().
Here is the caller graph for this function:
◆ addTOC()
| 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.
- Parameters
-
$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).
- Since
- 4.5.000 (2009-01-02)
- See also
- addTOCPage(), endTOCPage(), addHTMLTOC()
Definition at line 21289 of file tcpdf.php.
21289 {
21290 $fontsize = $this->FontSizePt;
21291 $fontfamily = $this->FontFamily;
21292 $fontstyle = $this->FontStyle;
21294 $spacer = $this->GetStringWidth(chr(32)) * 4;
21295 $lmargin = $this->lMargin;
21296 $rmargin = $this->rMargin;
21297 $x_start = $this->GetX();
21298 $page_first = $this->page;
21299 $current_page = $this->page;
21300 $page_fill_start = false;
21301 $page_fill_end = false;
21304 $numbersfont = $this->default_monospaced_font;
21305 }
21307 $filler = ' ';
21308 }
21310 $gap = ' ';
21311 } else {
21312 $gap = '';
21314 $page = 1;
21315 }
21316 }
21317 $this->SetFont($numbersfont, $fontstyle, $fontsize);
21319 $maxpage = 0; //used for pages on attached documents
21320 foreach ($this->outlines as $key => $outline) {
21321 // check for extra pages (used for attachments)
21322 if (($this->page > $page_first) AND ($outline['p'] >= $this->numpages)) {
21323 $outline['p'] += ($this->page - $page_first);
21324 }
21325 if ($this->rtl) {
21326 $aligntext = 'R';
21327 $alignnum = 'L';
21328 } else {
21329 $aligntext = 'L';
21330 $alignnum = 'R';
21331 }
21332 if ($outline['l'] == 0) {
21334 } else {
21336 }
21338 // check for page break
21340 // set margins and X position
21342 $this->lMargin = $lmargin;
21343 $this->rMargin = $rmargin;
21344 } else {
21346 if ($this->rtl) {
21348 } else {
21350 }
21351 }
21352 $lmargin = $this->lMargin;
21353 $rmargin = $this->rMargin;
21354 $current_page = $this->page;
21356 }
21357 $this->SetX($x_start);
21358 $indent = ($spacer * $outline['l']);
21359 if ($this->rtl) {
21360 $this->x -= $indent;
21361 $this->rMargin = $this->w - $this->x;
21362 } else {
21363 $this->x += $indent;
21364 $this->lMargin = $this->x;
21365 }
21366 $link = $this->AddLink();
21368 // write the text
21369 if ($this->rtl) {
21371 } else {
21373 }
21375 if ($this->rtl) {
21376 $tw = $this->x - $this->lMargin;
21377 } else {
21378 $tw = $this->w - $this->rMargin - $this->x;
21379 }
21380 $this->SetFont($numbersfont, $fontstyle, $fontsize);
21382 $pagenum = $outline['p'];
21383 } else {
21384 // placemark to be replaced with the correct number
21385 $pagenum = '{#'.($outline['p']).'}';
21387 $pagenum = '{'.$pagenum.'}';
21388 }
21389 $maxpage = max($maxpage, $outline['p']);
21390 }
21391 $fw = ($tw - $this->GetStringWidth($pagenum.$filler));
21392 $wfiller = $this->GetStringWidth($filler);
21393 if ($wfiller > 0) {
21394 $numfills = floor($fw / $wfiller);
21395 } else {
21396 $numfills = 0;
21397 }
21398 if ($numfills > 0) {
21399 $rowfill = str_repeat($filler, $numfills);
21400 } else {
21401 $rowfill = '';
21402 }
21403 if ($this->rtl) {
21404 $pagenum = $pagenum.$gap.$rowfill;
21405 } else {
21406 $pagenum = $rowfill.$gap.$pagenum;
21407 }
21408 // write the number
21409 $this->Cell($tw, 0, $pagenum, 0, 1, $alignnum, 0, $link, 0);
21410 }
21411 $page_last = $this->getPage();
21412 $numpages = ($page_last - $page_first + 1);
21413 // account for booklet mode
21414 if ($this->booklet) {
21415 // check if a blank page is required before TOC
21416 $page_fill_start = ((($page_first % 2) == 0) XOR (($page % 2) == 0));
21417 $page_fill_end = (!((($numpages % 2) == 0) XOR ($page_fill_start)));
21418 if ($page_fill_start) {
21419 // add a page at the end (to be moved before TOC)
21420 $this->addPage();
21421 ++$page_last;
21422 ++$numpages;
21423 }
21424 if ($page_fill_end) {
21425 // add a page at the end
21426 $this->addPage();
21427 ++$page_last;
21428 ++$numpages;
21429 }
21430 }
21431 $maxpage = max($maxpage, $page_last);
21433 for ($p = $page_first; $p <= $page_last; ++$p) {
21434 // get page data
21435 $temppage = $this->getPageBuffer($p);
21437 // update page numbers
21438 $a = '{#'.$n.'}';
21439 // get page number aliases
21440 $pnalias = $this->getInternalPageNumberAliases($a);
21441 // calculate replacement number
21444 } else {
21445 $np = $n;
21446 }
21447 $na = TCPDF_STATIC::formatTOCPageNumber(($this->starting_page_number + $np - 1));
21449 // replace aliases with numbers
21450 foreach ($pnalias['u'] as $u) {
21451 $sfill = str_repeat($filler, max(0, (strlen($u) - strlen($nu.' '))));
21452 if ($this->rtl) {
21453 $nr = $nu.TCPDF_FONTS::UTF8ToUTF16BE(' '.$sfill, false, $this->isunicode, $this->CurrentFont);
21454 } else {
21455 $nr = TCPDF_FONTS::UTF8ToUTF16BE($sfill.' ', false, $this->isunicode, $this->CurrentFont).$nu;
21456 }
21457 $temppage = str_replace($u, $nr, $temppage);
21458 }
21459 foreach ($pnalias['a'] as $a) {
21460 $sfill = str_repeat($filler, max(0, (strlen($a) - strlen($na.' '))));
21461 if ($this->rtl) {
21462 $nr = $na.' '.$sfill;
21463 } else {
21464 $nr = $sfill.' '.$na;
21465 }
21466 $temppage = str_replace($a, $nr, $temppage);
21467 }
21468 }
21469 // save changes
21470 $this->setPageBuffer($p, $temppage);
21471 }
21472 // move pages
21474 if ($page_fill_start) {
21475 $this->movePage($page_last, $page_first);
21476 }
21479 }
21480 }
21481 }
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.
Definition: tcpdf.php:4994
References $n, $style, $txt, $w, $x, TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber(), and TCPDF_FONTS\UTF8ToUTF16BE().
Here is the call graph for this function:
◆ addTOCPage()
| TCPDF::addTOCPage | ( | $orientation = '', |
|
$format = '', |
|||
$keepmargins = false |
|||
| ) |
Adds a new TOC (Table Of Content) page to the document.
- Parameters
-
$orientation (string) page orientation. $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). $keepmargins (boolean) if true overwrites the default page margins with the current margins
- Since
- 5.0.001 (2010-05-06)
- See also
- AddPage(), startPage(), endPage(), endTOCPage()
Definition at line 3077 of file tcpdf.php.
References AddPage().
Here is the call graph for this function:
◆ adjustCellPadding()
|
protected |
Adjust the internal Cell padding array to take account of the line width.
- Parameters
-
$brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- Returns
- array of adjustments
- Since
- 5.9.000 (2010-10-03)
Definition at line 2715 of file tcpdf.php.
2715 {
2716 if (empty($brd)) {
2717 return;
2718 }
2719 if (is_string($brd)) {
2720 // convert string to array
2721 $slen = strlen($brd);
2722 $newbrd = array();
2723 for ($i = 0; $i < $slen; ++$i) {
2724 $newbrd[$brd[$i]] = true;
2725 }
2726 $brd = $newbrd;
2727 } elseif (($brd === 1) OR ($brd === true) OR (is_numeric($brd) AND (intval($brd) > 0))) {
2728 $brd = array('LRTB' => true);
2729 }
2730 if (!is_array($brd)) {
2731 return;
2732 }
2733 // store current cell padding
2734 $cp = $this->cell_padding;
2735 // select border mode
2736 if (isset($brd['mode'])) {
2737 $mode = $brd['mode'];
2738 unset($brd['mode']);
2739 } else {
2740 $mode = 'normal';
2741 }
2742 // process borders
2744 $line_width = $this->LineWidth;
2746 // get border width
2748 }
2749 $adj = 0; // line width inside the cell
2750 switch ($mode) {
2751 case 'ext': {
2752 $adj = 0;
2753 break;
2754 }
2755 case 'int': {
2756 $adj = $line_width;
2757 break;
2758 }
2759 case 'normal':
2760 default: {
2761 $adj = ($line_width / 2);
2762 break;
2763 }
2764 }
2765 // correct internal cell padding if required to avoid overlap between text and lines
2767 $this->cell_padding['T'] = $adj;
2768 }
2770 $this->cell_padding['R'] = $adj;
2771 }
2773 $this->cell_padding['B'] = $adj;
2774 }
2776 $this->cell_padding['L'] = $adj;
2777 }
2778 }
2779 return array('T' => ($this->cell_padding['T'] - $cp['T']), 'R' => ($this->cell_padding['R'] - $cp['R']), 'B' => ($this->cell_padding['B'] - $cp['B']), 'L' => ($this->cell_padding['L'] - $cp['L']));
2780 }
$cell_padding
Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definition: tcpdf.php:281
References $border, $cell_padding, $LineWidth, and $style.
Referenced by Cell(), getCellCode(), getNumLines(), getStringHeight(), and MultiCell().
Here is the caller graph for this function:
◆ Annotation()
| 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 !!!!
- Parameters
-
$x (float) Abscissa of the upper-left corner of the rectangle $y (float) Ordinate of the upper-left corner of the rectangle $w (float) Width of the rectangle $h (float) Height of the rectangle $text (string) annotation text or alternate content $opt (array) array of options (see section 8.4 of PDF reference 1.7). $spaces (int) number of spaces on the text to link
- Since
- 4.0.018 (2008-08-06)
Definition at line 4745 of file tcpdf.php.
4745 {
4746 if ($this->inxobj) {
4747 // store parameters for later use on template
4748 $this->xobjects[$this->xobjid]['annotations'][] = array('x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'text' => $text, 'opt' => $opt, 'spaces' => $spaces);
4749 return;
4750 }
4753 }
4756 }
4757 // check page for no-write regions and adapt page margins if necessary
4759 // recalculate coordinates to account for graphic transformations
4760 if (isset($this->transfmatrix) AND !empty($this->transfmatrix)) {
4761 for ($i=$this->transfmatrix_key; $i > 0; --$i) {
4762 $maxid = count($this->transfmatrix[$i]) - 1;
4763 for ($j=$maxid; $j >= 0; --$j) {
4764 $ctm = $this->transfmatrix[$i][$j];
4765 if (isset($ctm['a'])) {
4770 // top left
4771 $xt = $x;
4772 $yt = $y;
4773 $x1 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
4774 $y1 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
4775 // top right
4777 $yt = $y;
4778 $x2 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
4779 $y2 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
4780 // bottom left
4781 $xt = $x;
4783 $x3 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
4784 $y3 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
4785 // bottom right
4788 $x4 = ($ctm['a'] * $xt) + ($ctm['c'] * $yt) + $ctm['e'];
4789 $y4 = ($ctm['b'] * $xt) + ($ctm['d'] * $yt) + $ctm['f'];
4790 // new coordinates (rectangle area)
4791 $x = min($x1, $x2, $x3, $x4);
4792 $y = max($y1, $y2, $y3, $y4);
4797 }
4798 }
4799 }
4800 }
4801 if ($this->page <= 0) {
4802 $page = 1;
4803 } else {
4805 }
4807 $this->PageAnnots[$page] = array();
4808 }
4809 $this->PageAnnots[$page][] = array('n' => ++$this->n, 'x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'txt' => $text, 'opt' => $opt, 'numspaces' => $spaces);
4810 if (!$this->pdfa_mode) {
4811 if ((($opt['Subtype'] == 'FileAttachment') OR ($opt['Subtype'] == 'Sound')) AND (!TCPDF_STATIC::empty_string($opt['FS']))
4813 AND (!isset($this->embeddedfiles[basename($opt['FS'])]))) {
4814 $this->embeddedfiles[basename($opt['FS'])] = array('f' => ++$this->n, 'n' => ++$this->n, 'file' => $opt['FS']);
4815 }
4816 }
4817 // Add widgets annotation's icons
4818 if (isset($opt['mk']['i']) AND @file_exists($opt['mk']['i'])) {
4819 $this->Image($opt['mk']['i'], '', '', 10, 10, '', '', '', false, 300, '', false, false, 0, false, true);
4820 }
4821 if (isset($opt['mk']['ri']) AND @file_exists($opt['mk']['ri'])) {
4822 $this->Image($opt['mk']['ri'], '', '', 0, 0, '', '', '', false, 300, '', false, false, 0, false, true);
4823 }
4824 if (isset($opt['mk']['ix']) AND @file_exists($opt['mk']['ix'])) {
4825 $this->Image($opt['mk']['ix'], '', '', 0, 0, '', '', '', false, 300, '', false, false, 0, false, true);
4826 }
4827 }
checkPageRegions($h, $x, $y)
Check page for no-write regions and adapt current coordinates and page margins if necessary.
Definition: tcpdf.php:22584
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.
Definition: tcpdf.php:6828
References $h, $k, $page, $text, $w, $x, $xobjid, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Image(), and TCPDF_STATIC\isValidURL().
Referenced by Button(), Link(), RadioButton(), and TextField().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ applyTSA()
|
protected |
NOT YET IMPLEMENTED Request TSA for a timestamp.
- Parameters
-
$signature (string) Digital signature as binary string
- Returns
- (string) Timestamped digital signature
- Since
- 6.0.090 (2014-06-16)
Definition at line 13545 of file tcpdf.php.
13545 {
13546 if (!$this->tsa_timestamp) {
13547 return $signature;
13548 }
13549 //@TODO: implement this feature
13550 return $signature;
13551 }
Referenced by Output().
Here is the caller graph for this function:
◆ Arrow()
| TCPDF::Arrow | ( | $x0, | |
| $y0, | |||
| $x1, | |||
| $y1, | |||
$head_style = 0, |
|||
$arm_size = 5, |
|||
$arm_angle = 15 |
|||
| ) |
Draws a grahic arrow.
- Parameters
-
$x0 (float) Abscissa of first point. $y0 (float) Ordinate of first point. $x1 (float) Abscissa of second point. $y1 (float) Ordinate of second point. $head_style (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead) $arm_size (float) length of arrowhead arms $arm_angle (int) angle between an arm and the shaft
- Since
- 4.6.018 (2009-07-10)
Definition at line 12141 of file tcpdf.php.
12141 {
12142 // getting arrow direction angle
12143 // 0 deg angle is when both arms go along X axis. angle grows clockwise.
12144 $dir_angle = atan2(($y0 - $y1), ($x0 - $x1));
12145 if ($dir_angle < 0) {
12146 $dir_angle += (2 * M_PI);
12147 }
12148 $arm_angle = deg2rad($arm_angle);
12149 $sx1 = $x1;
12150 $sy1 = $y1;
12151 if ($head_style > 0) {
12152 // calculate the stopping point for the arrow shaft
12153 $sx1 = $x1 + (($arm_size - $this->LineWidth) * cos($dir_angle));
12154 $sy1 = $y1 + (($arm_size - $this->LineWidth) * sin($dir_angle));
12155 }
12156 // main arrow line / shaft
12157 $this->Line($x0, $y0, $sx1, $sy1);
12158 // left arrowhead arm tip
12159 $x2L = $x1 + ($arm_size * cos($dir_angle + $arm_angle));
12160 $y2L = $y1 + ($arm_size * sin($dir_angle + $arm_angle));
12161 // right arrowhead arm tip
12162 $x2R = $x1 + ($arm_size * cos($dir_angle - $arm_angle));
12163 $y2R = $y1 + ($arm_size * sin($dir_angle - $arm_angle));
12164 $mode = 'D';
12165 $style = array();
12166 switch ($head_style) {
12167 case 0: {
12168 // draw only arrowhead arms
12169 $mode = 'D';
12170 $style = array(1, 1, 0);
12171 break;
12172 }
12173 case 1: {
12174 // draw closed arrowhead, but no fill
12175 $mode = 'D';
12176 break;
12177 }
12178 case 2: {
12179 // closed and filled arrowhead
12180 $mode = 'DF';
12181 break;
12182 }
12183 case 3: {
12184 // filled arrowhead
12185 $mode = 'F';
12186 break;
12187 }
12188 }
12190 }
Polygon($p, $style='', $line_style=array(), $fill_color=array(), $closed=true)
Draws a polygon.
Definition: tcpdf.php:11861
References $LineWidth, $style, Line(), and Polygon().
Here is the call graph for this function:
◆ Bookmark()
| TCPDF::Bookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0), |
|||
$x = -1, |
|||
$link = '' |
|||
| ) |
Adds a bookmark.
- Parameters
-
$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|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages. $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. $color (array) 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).
- Since
- 2.1.002 (2008-02-12)
Definition at line 12302 of file tcpdf.php.
12302 {
12303 if ($level < 0) {
12304 $level = 0;
12305 }
12306 if (isset($this->outlines[0])) {
12307 $lastoutline = end($this->outlines);
12308 $maxlevel = $lastoutline['l'] + 1;
12309 } else {
12310 $maxlevel = 0;
12311 }
12312 if ($level > $maxlevel) {
12313 $level = $maxlevel;
12314 }
12317 } elseif ($y < 0) {
12318 $y = 0;
12319 } elseif ($y > $this->h) {
12321 }
12324 } elseif ($x < 0) {
12325 $x = 0;
12326 } elseif ($x > $this->w) {
12328 }
12329 $fixed = false;
12332 // this page number will not be changed when moving/add/deleting pages
12333 $fixed = true;
12334 }
12338 return;
12339 }
12340 }
12341 $this->outlines[] = array('t' => $txt, 'l' => $level, 'x' => $x, 'y' => $y, 'p' => $page, 'f' => $fixed, 's' => strtoupper($style), 'c' => $color, 'u' => $link);
12342 }
References $h, $page, $style, $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:
◆ Button()
| TCPDF::Button | ( | $name, | |
| $w, | |||
| $h, | |||
| $caption, | |||
| $action, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a button field.
- Parameters
-
$name (string) field name $w (int) width $h (int) height $caption (string) caption. $action (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008. $prop (array) 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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 13122 of file tcpdf.php.
13122 {
13125 }
13128 }
13129 // check page for no-write regions and adapt page margins if necessary
13133 $this->javascript .= 'f'.$name.".buttonSetCaption('".addslashes($caption)."');\n";
13134 $this->javascript .= 'f'.$name.".setAction('MouseUp','".addslashes($action)."');\n";
13135 $this->javascript .= 'f'.$name.".highlight='push';\n";
13136 $this->javascript .= 'f'.$name.".print=false;\n";
13137 return;
13138 }
13139 // get default style
13140 $prop = array_merge($this->getFormDefaultProp(), $prop);
13141 $prop['Pushbutton'] = 'true';
13142 $prop['highlight'] = 'push';
13143 $prop['display'] = 'display.noPrint';
13144 // get annotation data
13145 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
13146 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
13147 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
13148 $popt['da'] = $fontstyle;
13149 // build appearance stream
13150 $popt['ap'] = array();
13151 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
13154 $border = array(
13155 'L' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(231)),
13156 'R' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(51)),
13157 'T' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(231)),
13158 'B' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(51)));
13159 $this->SetFillColor(204);
13161 $this->endTemplate();
13162 --$this->n;
13163 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
13164 unset($this->xobjects[$tmpid]);
13165 $popt['ap']['n'] .= 'Q EMC';
13166 // set additional default options
13167 if (!isset($popt['mk'])) {
13168 $popt['mk'] = array();
13169 }
13170 $ann_obj_id = ($this->n + 1);
13171 if (!empty($action) AND !is_array($action)) {
13172 $ann_obj_id = ($this->n + 2);
13173 }
13177 // merge options
13178 $opt = array_merge($popt, $opt);
13179 // set remaining annotation data
13180 $opt['Subtype'] = 'Widget';
13181 $opt['ft'] = 'Btn';
13182 $opt['t'] = $caption;
13183 $opt['v'] = $name;
13184 if (!empty($action)) {
13185 if (is_array($action)) {
13186 // form action options as on section 12.7.5 of PDF32000_2008.
13187 $opt['aa'] = '/D <<';
13188 $bmode = array('SubmitForm', 'ResetForm', 'ImportData');
13189 foreach ($action AS $key => $val) {
13190 if (($key == 'S') AND in_array($val, $bmode)) {
13191 $opt['aa'] .= ' /S /'.$val;
13192 } elseif (($key == 'F') AND (!empty($val))) {
13193 $opt['aa'] .= ' /F '.$this->_datastring($val, $ann_obj_id);
13194 } elseif (($key == 'Fields') AND is_array($val) AND !empty($val)) {
13195 $opt['aa'] .= ' /Fields [';
13196 foreach ($val AS $field) {
13197 $opt['aa'] .= ' '.$this->_textstring($field, $ann_obj_id);
13198 }
13199 $opt['aa'] .= ']';
13200 } elseif (($key == 'Flags')) {
13201 $ff = 0;
13202 if (is_array($val)) {
13203 foreach ($val AS $flag) {
13204 switch ($flag) {
13205 case 'Include/Exclude': {
13206 $ff += 1 << 0;
13207 break;
13208 }
13209 case 'IncludeNoValueFields': {
13210 $ff += 1 << 1;
13211 break;
13212 }
13213 case 'ExportFormat': {
13214 $ff += 1 << 2;
13215 break;
13216 }
13217 case 'GetMethod': {
13218 $ff += 1 << 3;
13219 break;
13220 }
13221 case 'SubmitCoordinates': {
13222 $ff += 1 << 4;
13223 break;
13224 }
13225 case 'XFDF': {
13226 $ff += 1 << 5;
13227 break;
13228 }
13229 case 'IncludeAppendSaves': {
13230 $ff += 1 << 6;
13231 break;
13232 }
13233 case 'IncludeAnnotations': {
13234 $ff += 1 << 7;
13235 break;
13236 }
13237 case 'SubmitPDF': {
13238 $ff += 1 << 8;
13239 break;
13240 }
13241 case 'CanonicalFormat': {
13242 $ff += 1 << 9;
13243 break;
13244 }
13245 case 'ExclNonUserAnnots': {
13246 $ff += 1 << 10;
13247 break;
13248 }
13249 case 'ExclFKey': {
13250 $ff += 1 << 11;
13251 break;
13252 }
13253 case 'EmbedForm': {
13254 $ff += 1 << 13;
13255 break;
13256 }
13257 }
13258 }
13259 } else {
13260 $ff = intval($val);
13261 }
13262 $opt['aa'] .= ' /Flags '.$ff;
13263 }
13264 }
13265 $opt['aa'] .= ' >>';
13266 } else {
13267 // Javascript action or raw action command
13268 $js_obj_id = $this->addJavascriptObject($action);
13269 $opt['aa'] = '/D '.$js_obj_id.' 0 R';
13270 }
13271 }
13273 if ($this->rtl) {
13274 $this->x -= $w;
13275 } else {
13276 $this->x += $w;
13277 }
13278 }
static getAnnotOptFromJSProp($prop, &$spot_colors, $rtl=false)
Convert JavaScript form fields properties array to Annotation Properties array.
Definition: tcpdf_static.php:653
endTemplate()
End the current XObject Template started with startTemplate() and restore the previous graphic state.
Definition: tcpdf.php:22305
_addfield($type, $name, $x, $y, $w, $h, $prop)
Adds a javascript form field.
Definition: tcpdf.php:12580
Annotation($x, $y, $w, $h, $text, $opt=array('Subtype'=> 'Text'), $spaces=0)
Puts a markup annotation on a rectangular area of the page.
Definition: tcpdf.php:4745
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).
Definition: tcpdf.php:3999
addJavascriptObject($script, $onload=false)
Adds a javascript object and return object ID.
Definition: tcpdf.php:12506
References $border, $h, $js, $k, $n, $w, $x, $y, _addfield(), _textstring(), addJavascriptObject(), Annotation(), Cell(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), SetFillColor(), sprintf, and startTemplate().
Referenced by openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Cell()
| 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.
- Parameters
-
$w (float) Cell width. If 0, the cell extends up to the right margin. $h (float) Cell height. Default value: 0. $txt (string) String to print. Default value: empty string. $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$ln (int) Indicates where the current position should go after the call. Possible values are: - 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
$align (string) Allows to center or align the text. Possible values are: - L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
$fill (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: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
$ignore_min_height (boolean) if true ignore automatic minimum height value. $calign (string) cell vertical alignment relative to the specified Y value. Possible values are: - T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
$valign (string) text vertical alignment inside the cell. Possible values are: - T : top
- C : center
- B : bottom
- Since
- 1.0
- See also
- SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()
Definition at line 4994 of file tcpdf.php.
4994 {
4995 $prev_cell_margin = $this->cell_margin;
4996 $prev_cell_padding = $this->cell_padding;
4998 if (!$ignore_min_height) {
4999 $min_cell_height = $this->getCellHeight($this->FontSize);
5001 $h = $min_cell_height;
5002 }
5003 }
5005 // apply text shadow if enabled
5006 if ($this->txtshadow['enabled']) {
5007 // save data
5010 $bc = $this->bgcolor;
5011 $fc = $this->fgcolor;
5012 $sc = $this->strokecolor;
5014 // print shadow
5015 $this->x += $this->txtshadow['depth_w'];
5016 $this->y += $this->txtshadow['depth_h'];
5022 }
5023 if ($this->state == 2) {
5024 $this->_out($this->getCellCode($w, $h, $txt, $border, $ln, $align, $fill, $link, $stretch, true, $calign, $valign));
5025 }
5026 //restore data
5027 $this->x = $x;
5028 $this->y = $y;
5029 $this->SetFillColorArray($bc);
5030 $this->SetTextColorArray($fc);
5031 $this->SetDrawColorArray($sc);
5034 }
5035 }
5036 if ($this->state == 2) {
5037 $this->_out($this->getCellCode($w, $h, $txt, $border, $ln, $align, $fill, $link, $stretch, true, $calign, $valign));
5038 }
5039 $this->cell_padding = $prev_cell_padding;
5040 $this->cell_margin = $prev_cell_margin;
5041 }
setAlpha($stroking=1, $bm='Normal', $nonstroking='', $ais=false)
Set alpha for stroking (CA) and non-stroking (ca) operations.
Definition: tcpdf.php:13909
adjustCellPadding($brd=0)
Adjust the internal Cell padding array to take account of the line width.
Definition: tcpdf.php:2715
$cell_margin
Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
Definition: tcpdf.php:288
SetFillColorArray($color, $ret=false)
Defines the color used for all filling operations (filled rectangles and cell backgrounds).
Definition: tcpdf.php:3862
SetDrawColorArray($color, $ret=false)
Defines the color used for all drawing operations (lines, rectangles and cell borders).
Definition: tcpdf.php:3848
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,...
Definition: tcpdf.php:5063
References $alpha, $bgcolor, $border, $cell_margin, $cell_padding, $fgcolor, $h, $strokecolor, $txt, $w, $x, $y, _out(), adjustCellPadding(), checkPageBreak(), getCellCode(), getCellHeight(), setAlpha(), SetDrawColorArray(), SetFillColorArray(), and SetTextColorArray().
Referenced by Button(), MC_TCPDF\ChapterTitle(), Close(), MYPDF\ColoredTable(), MYPDF\Footer(), Footer(), MYPDF\Header(), Header(), Image(), ImageEps(), Text(), Write(), and write1DBarcode().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ CheckBox()
| TCPDF::CheckBox | ( | $name, | |
| $w, | |||
$checked = false, |
|||
$prop = array(), |
|||
$opt = array(), |
|||
$onvalue = 'Yes', |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a CheckBox field.
- Parameters
-
$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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 13042 of file tcpdf.php.
13042 {
13045 }
13048 }
13049 // check page for no-write regions and adapt page margins if necessary
13053 return;
13054 }
13055 if (!isset($prop['value'])) {
13056 $prop['value'] = array('Yes');
13057 }
13058 // get default style
13059 $prop = array_merge($this->getFormDefaultProp(), $prop);
13060 $prop['borderStyle'] = 'inset';
13061 // get annotation data
13062 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
13063 // set additional default options
13064 $font = 'zapfdingbats';
13065 if ($this->pdfa_mode) {
13066 // all fonts must be embedded
13067 $font = 'pdfa'.$font;
13068 }
13069 $this->AddFont($font);
13070 $tmpfont = $this->getFontBuffer($font);
13071 $this->annotation_fonts[$tmpfont['fontkey']] = $tmpfont['i'];
13073 $popt['da'] = $fontstyle;
13074 // build appearance stream
13075 $popt['ap'] = array();
13076 $popt['ap']['n'] = array();
13078 $fy = (($w - ((($tmpfont['desc']['Ascent'] - $tmpfont['desc']['Descent']) * $this->FontSizePt / 1000) / $this->k)) * $this->k);
13079 $popt['ap']['n']['Yes'] = sprintf('q %s BT /F%d %F Tf %F %F Td ('.chr(110).') Tj ET Q', $this->TextColor, $tmpfont['i'], $this->FontSizePt, $fx, $fy);
13080 $popt['ap']['n']['Off'] = sprintf('q %s BT /F%d %F Tf %F %F Td ('.chr(111).') Tj ET Q', $this->TextColor, $tmpfont['i'], $this->FontSizePt, $fx, $fy);
13081 // merge options
13082 $opt = array_merge($popt, $opt);
13083 // set remaining annotation data
13084 $opt['Subtype'] = 'Widget';
13085 $opt['ft'] = 'Btn';
13086 $opt['t'] = $name;
13088 $onvalue = 'Yes';
13089 }
13090 $opt['opt'] = array($onvalue);
13091 if ($checked) {
13092 $opt['v'] = array('/Yes');
13093 $opt['as'] = 'Yes';
13094 } else {
13095 $opt['v'] = array('/Off');
13096 $opt['as'] = 'Off';
13097 }
13099 if ($this->rtl) {
13100 $this->x -= $w;
13101 } else {
13102 $this->x += $w;
13103 }
13104 }
AddFont($family, $style='', $fontfile='', $subset='default')
Imports a TrueType, Type1, core, or CID0 font and makes it available.
Definition: tcpdf.php:4171
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:
◆ checkPageBreak()
|
protected |
Add page if needed.
- Parameters
-
$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
- Returns
- boolean true in case of page break, false otherwise.
- Since
- 3.2.000 (2008-07-01)
Definition at line 4940 of file tcpdf.php.
4940 {
4943 }
4944 $current_page = $this->page;
4945 if ((($y + $h) > $this->PageBreakTrigger) AND ($this->inPageBody()) AND ($this->AcceptPageBreak())) {
4946 if ($addpage) {
4947 //Automatic page break
4949 $this->AddPage($this->CurOrientation);
4950 $this->y = $this->tMargin;
4951 $oldpage = $this->page - 1;
4952 if ($this->rtl) {
4953 if ($this->pagedim[$this->page]['orm'] != $this->pagedim[$oldpage]['orm']) {
4955 } else {
4956 $this->x = $x;
4957 }
4958 } else {
4959 if ($this->pagedim[$this->page]['olm'] != $this->pagedim[$oldpage]['olm']) {
4961 } else {
4962 $this->x = $x;
4963 }
4964 }
4965 }
4966 return true;
4967 }
4968 if ($current_page != $this->page) {
4969 // account for columns mode
4970 return true;
4971 }
4972 return false;
4973 }
inPageBody()
Check if we are on the page body (excluding page header and footer).
Definition: tcpdf.php:3613
AcceptPageBreak()
Whenever a page break condition is met, the method is called, and the break is issued or not dependin...
Definition: tcpdf.php:4913
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:
◆ checkPageRegions()
|
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.
- Parameters
-
$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
- Returns
- array($x, $y)
- Since
- 5.9.003 (2010-10-13)
Definition at line 22584 of file tcpdf.php.
22584 {
22585 // set default values
22588 }
22591 }
22592 if (!$this->check_page_regions OR empty($this->page_regions)) {
22593 // no page regions defined
22595 }
22598 }
22599 // check for page break
22601 // the content will be printed on a new page
22604 }
22605 if ($this->num_columns > 1) {
22606 if ($this->rtl) {
22607 $this->lMargin = ($this->columns[$this->current_column]['x'] - $this->columns[$this->current_column]['w']);
22608 } else {
22609 $this->rMargin = ($this->w - $this->columns[$this->current_column]['x'] - $this->columns[$this->current_column]['w']);
22610 }
22611 } else {
22612 if ($this->rtl) {
22613 $this->lMargin = max($this->clMargin, $this->original_lMargin);
22614 } else {
22615 $this->rMargin = max($this->crMargin, $this->original_rMargin);
22616 }
22617 }
22618 // adjust coordinates and page margins
22619 foreach ($this->page_regions as $regid => $regdata) {
22620 if ($regdata['page'] == $this->page) {
22621 // check region boundaries
22623 // Y is inside the region
22624 $minv = ($regdata['xb'] - $regdata['xt']) / ($regdata['yb'] - $regdata['yt']); // inverse of angular coefficient
22627 $xt = (($yt - $regdata['yt']) * $minv) + $regdata['xt'];
22628 $xb = (($yb - $regdata['yt']) * $minv) + $regdata['xt'];
22629 if ($regdata['side'] == 'L') { // left side
22630 $new_margin = max($xt, $xb);
22631 if ($this->lMargin < $new_margin) {
22632 if ($this->rtl) {
22633 // adjust left page margin
22634 $this->lMargin = max(0, $new_margin);
22635 }
22637 // adjust x position
22638 $x = $new_margin;
22639 if ($new_margin > ($this->w - $this->rMargin)) {
22640 // adjust y position
22642 }
22643 }
22644 }
22645 } elseif ($regdata['side'] == 'R') { // right side
22646 $new_margin = min($xt, $xb);
22647 if (($this->w - $this->rMargin) > $new_margin) {
22648 if (!$this->rtl) {
22649 // adjust right page margin
22650 $this->rMargin = max(0, ($this->w - $new_margin));
22651 }
22653 // adjust x position
22654 $x = $new_margin;
22655 if ($new_margin > $this->lMargin) {
22656 // adjust y position
22658 }
22659 }
22660 }
22661 }
22662 }
22663 }
22664 }
22666 }
Referenced by Annotation(), Button(), getCellCode(), getRemainingWidth(), Image(), ImageEps(), ListBox(), MultiCell(), RadioButton(), TextField(), Write(), write1DBarcode(), and write2DBarcode().
Here is the caller graph for this function:
◆ Circle()
| 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.
- Parameters
-
$x0 (float) Abscissa of center point. $y0 (float) Ordinate of center point. $r (float) Radius. $angstr (float) Angle start of draw line. Default value: 0. $angend (float) 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.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11824 of file tcpdf.php.
11824 {
11826 }
Ellipse($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2)
Draws an ellipse.
Definition: tcpdf.php:11652
References $r, $style, and Ellipse().
Referenced by registrationMark(), registrationMarkCMYK(), RegularPolygon(), and StarPolygon().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Clip()
|
protected |
Set a rectangular clipping area.
- Parameters
-
$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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14443 of file tcpdf.php.
14443 {
14444 if ($this->state != 2) {
14445 return;
14446 }
14447 if ($this->rtl) {
14449 }
14450 //save current Graphic State
14451 $s = 'q';
14452 //set clipping area
14453 $s .= sprintf(' %F %F %F %F re W n', $x*$this->k, ($this->h-$y)*$this->k, $w*$this->k, -$h*$this->k);
14454 //set up transformation matrix for gradient
14455 $s .= sprintf(' %F 0 0 %F %F %F cm', $w*$this->k, $h*$this->k, $x*$this->k, ($this->h-($y+$h))*$this->k);
14456 $this->_out($s);
14457 }
References $h, $w, $x, $y, _out(), and sprintf.
Referenced by CoonsPatchMesh(), LinearGradient(), and RadialGradient().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Close()
| 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.
- Since
- 1.0
Definition at line 2951 of file tcpdf.php.
2951 {
2952 if ($this->state == 3) {
2953 return;
2954 }
2955 if ($this->page == 0) {
2956 $this->AddPage();
2957 }
2958 $this->endLayer();
2959 if ($this->tcpdflink) {
2960 // save current graphic settings
2961 $gvars = $this->getGraphicVars();
2962 $this->setEqualColumns();
2963 $this->lastpage(true);
2965 $this->x = 0;
2966 $this->y = $this->h - (1 / $this->k);
2967 $this->lMargin = 0;
2968 $this->_outSaveGraphicsState();
2972 $msg = "\x50\x6f\x77\x65\x72\x65\x64\x20\x62\x79\x20\x54\x43\x50\x44\x46\x20\x28\x77\x77\x77\x2e\x74\x63\x70\x64\x66\x2e\x6f\x72\x67\x29";
2973 $lnk = "\x68\x74\x74\x70\x3a\x2f\x2f\x77\x77\x77\x2e\x74\x63\x70\x64\x66\x2e\x6f\x72\x67";
2975 $this->_outRestoreGraphicsState();
2976 // restore graphic settings
2977 $this->setGraphicVars($gvars);
2978 }
2979 // close page
2980 $this->endPage();
2981 // close document
2982 $this->_enddoc();
2983 // unset all class variables (except critical ones)
2985 }
setTextRenderingMode($stroke=0, $fill=true, $clip=false)
Set Text rendering mode.
Definition: tcpdf.php:21847
setEqualColumns($numcols=0, $width=0, $y='')
Set multiple columns of the same size.
Definition: tcpdf.php:21687
_outRestoreGraphicsState()
Outputs the "restore graphics state" operator 'Q'.
Definition: tcpdf.php:20678
References $k, _destroy(), _enddoc(), _outRestoreGraphicsState(), _outSaveGraphicsState(), AddPage(), Cell(), defined, endLayer(), endPage(), getGraphicVars(), PDF_FONT_NAME_MAIN, 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:
◆ closeHTMLTagHandler()
|
protected |
Process closing tags.
- Parameters
-
$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
- Returns
- $dom array
Definition at line 19359 of file tcpdf.php.
19359 {
19360 $tag = $dom[$key];
19361 $parent = $dom[($dom[$key]['parent'])];
19362 $lasttag = ((!isset($dom[($key + 1)])) OR ((!isset($dom[($key + 2)])) AND ($dom[($key + 1)]['value'] == 'marker')));
19363 $in_table_head = false;
19364 // maximum x position (used to draw borders)
19365 if ($this->rtl) {
19366 $xmax = $this->w;
19367 } else {
19368 $xmax = 0;
19369 }
19370 if ($tag['block']) {
19371 $hbz = 0; // distance from y to line bottom
19372 $hb = 0; // vertical space between block tags
19373 // calculate vertical space for block tags
19374 if (isset($this->tagvspaces[$tag['value']][1]['h']) AND ($this->tagvspaces[$tag['value']][1]['h'] >= 0)) {
19375 $pre_h = $this->tagvspaces[$tag['value']][1]['h'];
19376 } elseif (isset($parent['fontsize'])) {
19378 } else {
19379 $pre_h = $this->getCellHeight($this->FontSize);
19380 }
19381 if (isset($this->tagvspaces[$tag['value']][1]['n'])) {
19382 $cn = $this->tagvspaces[$tag['value']][1]['n'];
19383 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
19384 $cn = 0.6;
19385 } else {
19386 $cn = 1;
19387 }
19388 if ((!isset($this->tagvspaces[$tag['value']])) AND ($tag['value'] == 'div')) {
19389 $hb = 0;
19390 } else {
19391 $hb = ($cn * $pre_h);
19392 }
19393 if ($maxbottomliney > $this->PageBreakTrigger) {
19394 $hbz = $this->getCellHeight($this->FontSize);
19395 } elseif ($this->y < $maxbottomliney) {
19396 $hbz = ($maxbottomliney - $this->y);
19397 }
19398 }
19399 // Closing tag
19400 switch($tag['value']) {
19401 case 'tr': {
19402 $table_el = $dom[($dom[$key]['parent'])]['parent'];
19403 if (!isset($parent['endy'])) {
19404 $dom[($dom[$key]['parent'])]['endy'] = $this->y;
19406 }
19407 if (!isset($parent['endpage'])) {
19408 $dom[($dom[$key]['parent'])]['endpage'] = $this->page;
19410 }
19411 if (!isset($parent['endcolumn'])) {
19412 $dom[($dom[$key]['parent'])]['endcolumn'] = $this->current_column;
19414 }
19415 // update row-spanned cells
19416 if (isset($dom[$table_el]['rowspans'])) {
19420 if (($dom[$table_el]['rowspans'][$k]['endpage'] == $parent['endpage']) AND ($dom[$table_el]['rowspans'][$k]['endcolumn'] == $parent['endcolumn'])) {
19421 $dom[($dom[$key]['parent'])]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $parent['endy']);
19422 } elseif (($dom[$table_el]['rowspans'][$k]['endpage'] > $parent['endpage']) OR ($dom[$table_el]['rowspans'][$k]['endcolumn'] > $parent['endcolumn'])) {
19426 }
19427 }
19428 }
19429 // report new endy and endpage to the rowspanned cells
19432 $dom[$table_el]['rowspans'][$k]['endpage'] = max($dom[$table_el]['rowspans'][$k]['endpage'], $dom[($dom[$key]['parent'])]['endpage']);
19434 $dom[$table_el]['rowspans'][$k]['endcolumn'] = max($dom[$table_el]['rowspans'][$k]['endcolumn'], $dom[($dom[$key]['parent'])]['endcolumn']);
19436 $dom[$table_el]['rowspans'][$k]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $dom[($dom[$key]['parent'])]['endy']);
19438 }
19439 }
19440 // update remaining rowspanned cells
19446 }
19447 }
19448 }
19449 $prev_page = $this->page;
19451 if ($this->num_columns > 1) {
19452 if (($prev_page < $this->page)
19453 AND ((($this->current_column == 0) AND ($dom[($dom[$key]['parent'])]['endcolumn'] == ($this->num_columns - 1)))
19454 OR ($this->current_column == $dom[($dom[$key]['parent'])]['endcolumn']))) {
19455 // page jump
19456 $this->selectColumn(0);
19457 $dom[($dom[$key]['parent'])]['endcolumn'] = 0;
19458 $dom[($dom[$key]['parent'])]['endy'] = $this->y;
19459 } else {
19461 $this->y = $dom[($dom[$key]['parent'])]['endy'];
19462 }
19463 } else {
19464 $this->y = $dom[($dom[$key]['parent'])]['endy'];
19465 }
19466 if (isset($dom[$table_el]['attribute']['cellspacing'])) {
19468 } elseif (isset($dom[$table_el]['border-spacing'])) {
19469 $this->y += $dom[$table_el]['border-spacing']['V'];
19470 }
19471 $this->Ln(0, $cell);
19472 if ($this->current_column == $parent['startcolumn']) {
19473 $this->x = $parent['startx'];
19474 }
19475 // account for booklet mode
19476 if ($this->page > $parent['startpage']) {
19477 if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$parent['startpage']]['orm'])) {
19478 $this->x -= ($this->pagedim[$this->page]['orm'] - $this->pagedim[$parent['startpage']]['orm']);
19479 } elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$parent['startpage']]['olm'])) {
19480 $this->x += ($this->pagedim[$this->page]['olm'] - $this->pagedim[$parent['startpage']]['olm']);
19481 }
19482 }
19483 break;
19484 }
19485 case 'tablehead':
19486 // closing tag used for the thead part
19487 $in_table_head = true;
19488 $this->inthead = false;
19489 case 'table': {
19490 $table_el = $parent;
19491 // set default border
19492 if (isset($table_el['attribute']['border']) AND ($table_el['attribute']['border'] > 0)) {
19493 // set default border
19494 $border = array('LTRB' => array('width' => $this->getCSSBorderWidth($table_el['attribute']['border']), 'cap'=>'square', 'join'=>'miter', 'dash'=> 0, 'color'=>array(0,0,0)));
19495 } else {
19496 $border = 0;
19497 }
19498 $default_border = $border;
19499 // fix bottom line alignment of last line before page break
19500 foreach ($dom[($dom[$key]['parent'])]['trids'] as $j => $trkey) {
19501 // update row-spanned cells
19502 if (isset($dom[($dom[$key]['parent'])]['rowspans'])) {
19504 if (isset($prevtrkey) AND ($trwsp['trid'] == $prevtrkey) AND ($trwsp['mrowspan'] > 0)) {
19506 }
19509 }
19510 }
19511 }
19512 if (isset($prevtrkey) AND ($dom[$trkey]['startpage'] > $dom[$prevtrkey]['endpage'])) {
19513 $pgendy = $this->pagedim[$dom[$prevtrkey]['endpage']]['hk'] - $this->pagedim[$dom[$prevtrkey]['endpage']]['bm'];
19514 $dom[$prevtrkey]['endy'] = $pgendy;
19515 // update row-spanned cells
19516 if (isset($dom[($dom[$key]['parent'])]['rowspans'])) {
19518 if (($trwsp['trid'] == $prevtrkey) AND ($trwsp['mrowspan'] >= 0) AND ($trwsp['endpage'] == $dom[$prevtrkey]['endpage'])) {
19521 }
19522 }
19523 }
19524 }
19525 $prevtrkey = $trkey;
19526 $table_el = $dom[($dom[$key]['parent'])];
19527 }
19528 // for each row
19529 if (count($table_el['trids']) > 0) {
19530 unset($xmax);
19531 }
19532 foreach ($table_el['trids'] as $j => $trkey) {
19533 $parent = $dom[$trkey];
19534 if (!isset($xmax)) {
19535 $xmax = $parent['cellpos'][(count($parent['cellpos']) - 1)]['endx'];
19536 }
19537 // for each cell on the row
19539 if (isset($cellpos['rowspanid']) AND ($cellpos['rowspanid'] >= 0)) {
19540 $cellpos['startx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['startx'];
19541 $cellpos['endx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['endx'];
19542 $endy = $table_el['rowspans'][($cellpos['rowspanid'])]['endy'];
19543 $startpage = $table_el['rowspans'][($cellpos['rowspanid'])]['startpage'];
19544 $endpage = $table_el['rowspans'][($cellpos['rowspanid'])]['endpage'];
19545 $startcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['startcolumn'];
19546 $endcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['endcolumn'];
19547 } else {
19548 $endy = $parent['endy'];
19549 $startpage = $parent['startpage'];
19550 $endpage = $parent['endpage'];
19551 $startcolumn = $parent['startcolumn'];
19552 $endcolumn = $parent['endcolumn'];
19553 }
19554 if ($this->num_columns == 0) {
19555 $this->num_columns = 1;
19556 }
19557 if (isset($cellpos['border'])) {
19559 }
19560 if (isset($cellpos['bgcolor']) AND ($cellpos['bgcolor']) !== false) {
19562 $fill = true;
19563 } else {
19564 $fill = false;
19565 }
19570 // get border modes
19574 // design borders around HTML cells.
19576 $ccode = '';
19578 if ($this->num_columns < 2) {
19579 // single-column mode
19580 $this->x = $x;
19581 $this->y = $this->tMargin;
19582 }
19583 // account for margin changes
19587 } elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
19589 }
19590 }
19591 if ($startpage == $endpage) { // single page
19592 $deltacol = 0;
19593 $deltath = 0;
19596 if ($startcolumn == $endcolumn) { // single column
19597 $cborder = $border;
19599 $this->y = $y;
19600 $this->x = $x;
19602 $cborder = $border_start;
19603 $this->y = $starty;
19604 $this->x = $x;
19606 if ($this->rtl) {
19607 $deltacol = $this->x + $this->rMargin - $this->w;
19608 } else {
19609 $deltacol = $this->x - $this->lMargin;
19610 }
19612 $cborder = $border_end;
19615 }
19616 $this->x += $deltacol;
19618 } else { // middle column
19619 $cborder = $border_middle;
19622 }
19623 $this->x += $deltacol;
19625 }
19627 } // end for each column
19629 $deltacol = 0;
19630 $deltath = 0;
19634 $cborder = $border_start;
19635 $this->y = $starty;
19636 $this->x = $x;
19638 if ($this->rtl) {
19639 $deltacol = $this->x + $this->rMargin - $this->w;
19640 } else {
19641 $deltacol = $this->x - $this->lMargin;
19642 }
19643 } else { // middle column
19644 $cborder = $border_middle;
19647 }
19648 $this->x += $deltacol;
19650 }
19652 } // end for each column
19654 $deltacol = 0;
19655 $deltath = 0;
19659 $cborder = $border_end;
19662 }
19663 $this->x += $deltacol;
19665 } else { // middle column
19666 $cborder = $border_middle;
19669 }
19670 $this->x += $deltacol;
19672 }
19674 } // end for each column
19675 } else { // middle page
19676 $deltacol = 0;
19677 $deltath = 0;
19680 $cborder = $border_middle;
19683 }
19684 $this->x += $deltacol;
19687 } // end for each column
19688 }
19689 if (!empty($cborder) OR !empty($fill)) {
19690 $offsetlen = strlen($ccode);
19691 // draw border and fill
19692 if ($this->inxobj) {
19693 // we are inside an XObject template
19694 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
19695 $pagemarkkey = key($this->xobjects[$this->xobjid]['transfmrk']);
19698 } else {
19701 }
19703 $pstart = substr($pagebuff, 0, $pagemark);
19704 $pend = substr($pagebuff, $pagemark);
19706 } else {
19707 // draw border and fill
19708 if (end($this->transfmrk[$this->page]) !== false) {
19709 $pagemarkkey = key($this->transfmrk[$this->page]);
19710 $pagemark = $this->transfmrk[$this->page][$pagemarkkey];
19711 } elseif ($this->InFooter) {
19712 $pagemark = $this->footerpos[$this->page];
19713 } else {
19714 $pagemark = $this->intmrk[$this->page];
19715 }
19716 $pagebuff = $this->getPageBuffer($this->page);
19717 $pstart = substr($pagebuff, 0, $pagemark);
19718 $pend = substr($pagebuff, $pagemark);
19719 $this->setPageBuffer($this->page, $pstart.$ccode.$pend);
19720 }
19721 }
19722 } // end for each page
19723 // restore default border
19724 $border = $default_border;
19725 } // end for each cell on the row
19726 if (isset($table_el['attribute']['cellspacing'])) {
19728 } elseif (isset($table_el['border-spacing'])) {
19729 $this->y += $table_el['border-spacing']['V'];
19730 }
19731 $this->Ln(0, $cell);
19732 $this->x = $parent['startx'];
19733 if ($endpage > $startpage) {
19734 if (($this->rtl) AND ($this->pagedim[$endpage]['orm'] != $this->pagedim[$startpage]['orm'])) {
19735 $this->x += ($this->pagedim[$endpage]['orm'] - $this->pagedim[$startpage]['orm']);
19736 } elseif ((!$this->rtl) AND ($this->pagedim[$endpage]['olm'] != $this->pagedim[$startpage]['olm'])) {
19737 $this->x += ($this->pagedim[$endpage]['olm'] - $this->pagedim[$startpage]['olm']);
19738 }
19739 }
19740 }
19741 if (!$in_table_head) { // we are not inside a thead section
19742 $this->cell_padding = $table_el['old_cell_padding'];
19743 // reset row height
19744 $this->resetLastH();
19745 if (($this->page == ($this->numpages - 1)) AND ($this->pageopen[$this->numpages])) {
19747 if (($plendiff > 0) AND ($plendiff < 60)) {
19748 $pagediff = substr($this->getPageBuffer($this->numpages), $this->emptypagemrk[$this->numpages], $plendiff);
19749 if (substr($pagediff, 0, 5) == 'BT /F') {
19750 // the difference is only a font setting
19751 $plendiff = 0;
19752 }
19753 }
19754 if ($plendiff == 0) {
19755 // remove last blank page
19756 $this->deletePage($this->numpages);
19757 }
19758 }
19759 if (isset($this->theadMargins['top'])) {
19760 // restore top margin
19761 $this->tMargin = $this->theadMargins['top'];
19762 }
19763 if (!isset($table_el['attribute']['nested']) OR ($table_el['attribute']['nested'] != 'true')) {
19764 // reset main table header
19765 $this->thead = '';
19766 $this->theadMargins = array();
19768 }
19769 }
19770 $parent = $table_el;
19771 break;
19772 }
19773 case 'a': {
19774 $this->HREF = '';
19775 break;
19776 }
19777 case 'sup': {
19779 break;
19780 }
19781 case 'sub': {
19783 break;
19784 }
19785 case 'div': {
19787 break;
19788 }
19789 case 'blockquote': {
19790 if ($this->rtl) {
19791 $this->rMargin -= $this->listindent;
19792 } else {
19793 $this->lMargin -= $this->listindent;
19794 }
19795 --$this->listindentlevel;
19797 break;
19798 }
19799 case 'p': {
19801 break;
19802 }
19803 case 'pre': {
19805 $this->premode = false;
19806 break;
19807 }
19808 case 'dl': {
19809 --$this->listnum;
19810 if ($this->listnum <= 0) {
19811 $this->listnum = 0;
19813 } else {
19815 }
19816 $this->resetLastH();
19817 break;
19818 }
19819 case 'dt': {
19820 $this->lispacer = '';
19822 break;
19823 }
19824 case 'dd': {
19825 $this->lispacer = '';
19826 if ($this->rtl) {
19827 $this->rMargin -= $this->listindent;
19828 } else {
19829 $this->lMargin -= $this->listindent;
19830 }
19831 --$this->listindentlevel;
19833 break;
19834 }
19835 case 'ul':
19836 case 'ol': {
19837 --$this->listnum;
19838 $this->lispacer = '';
19839 if ($this->rtl) {
19840 $this->rMargin -= $this->listindent;
19841 } else {
19842 $this->lMargin -= $this->listindent;
19843 }
19844 --$this->listindentlevel;
19845 if ($this->listnum <= 0) {
19846 $this->listnum = 0;
19848 } else {
19850 }
19851 $this->resetLastH();
19852 break;
19853 }
19854 case 'li': {
19855 $this->lispacer = '';
19857 break;
19858 }
19859 case 'h1':
19860 case 'h2':
19861 case 'h3':
19862 case 'h4':
19863 case 'h5':
19864 case 'h6': {
19866 break;
19867 }
19868 // Form fields (since 4.8.000 - 2009-09-07)
19869 case 'form': {
19870 $this->form_action = '';
19871 $this->form_enctype = 'application/x-www-form-urlencoded';
19872 break;
19873 }
19874 default : {
19875 break;
19876 }
19877 }
19878 // draw border and background (if any)
19879 $this->drawHTMLTagBorder($parent, $xmax);
19880 if (isset($dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'])) {
19881 $pba = $dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'];
19882 // check for pagebreak
19883 if (($pba == 'true') OR ($pba == 'left') OR ($pba == 'right')) {
19884 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19885 $this->checkPageBreak($this->PageBreakTrigger + 1);
19886 }
19887 if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
19888 OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
19889 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19890 $this->checkPageBreak($this->PageBreakTrigger + 1);
19891 }
19892 }
19893 $this->tmprtl = false;
19894 return $dom;
19895 }
static getBorderMode($brd, $position='start', $opencell=true)
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
Definition: tcpdf_static.php:211
SetXY($x, $y, $rtloff=false)
Defines the abscissa and ordinate of the current position.
Definition: tcpdf.php:7507
getHTMLUnitToUnits($htmlval, $refsize=1, $defaultunit='px', $points=false)
Convert HTML string containing value and unit of measure to user's units or points.
Definition: tcpdf.php:20259
addHTMLVertSpace($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false)
Add vertical spaces if needed.
Definition: tcpdf.php:19906
setPage($pnum, $resetmargins=false)
Move pointer at the specified document page and update page dimensions.
Definition: tcpdf.php:2995
References $column.
Referenced by writeHTML().
Here is the caller graph for this function:
◆ colorRegistrationBar()
| TCPDF::colorRegistrationBar | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$transition = true, |
|||
$vertical = false, |
|||
$colors = 'A, |
|||
| R | , | ||
| G | , | ||
| B | , | ||
| C | , | ||
| M | , | ||
| Y | , | ||
| K' | |||
| ) |
Paints color transition registration bars.
- Parameters
-
$x (float) abscissa of the top left corner of the rectangle. $y (float) ordinate of the top left corner of the rectangle. $w (float) width of the rectangle. $h (float) height of the rectangle. $transition (boolean) if true prints tcolor transitions to white. $vertical (boolean) if true prints bar vertically. $colors (string) colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.
- Since
- 4.9.000 (2010-03-26)
Definition at line 14028 of file tcpdf.php.
14028 {
14029 if (strpos($colors, 'ALLSPOT') !== false) {
14030 // expand spot colors
14032 foreach ($this->spot_colors as $spot_color_name => $v) {
14034 }
14038 } else {
14039 $colors = str_replace('ALLSPOT', 'NONE', $colors);
14040 }
14041 }
14042 $bars = explode(',', $colors);
14043 $numbars = count($bars); // number of bars to print
14044 if ($numbars <= 0) {
14045 return;
14046 }
14047 // set bar measures
14048 if ($vertical) {
14049 $coords = array(0, 0, 0, 1);
14052 $xd = $wb; // delta x
14053 $yd = 0; // delta y
14054 } else {
14055 $coords = array(1, 0, 0, 0);
14058 $xd = 0; // delta x
14059 $yd = $hb; // delta y
14060 }
14061 $xb = $x;
14062 $yb = $y;
14063 foreach ($bars as $col) {
14064 switch ($col) {
14065 // set transition colors
14066 case 'A': { // BLACK (GRAYSCALE)
14067 $col_a = array(255);
14068 $col_b = array(0);
14069 break;
14070 }
14071 case 'W': { // WHITE (GRAYSCALE)
14072 $col_a = array(0);
14073 $col_b = array(255);
14074 break;
14075 }
14076 case 'R': { // RED (RGB)
14077 $col_a = array(255,255,255);
14078 $col_b = array(255,0,0);
14079 break;
14080 }
14081 case 'G': { // GREEN (RGB)
14082 $col_a = array(255,255,255);
14083 $col_b = array(0,255,0);
14084 break;
14085 }
14086 case 'B': { // BLUE (RGB)
14087 $col_a = array(255,255,255);
14088 $col_b = array(0,0,255);
14089 break;
14090 }
14091 case 'C': { // CYAN (CMYK)
14092 $col_a = array(0,0,0,0);
14093 $col_b = array(100,0,0,0);
14094 break;
14095 }
14096 case 'M': { // MAGENTA (CMYK)
14097 $col_a = array(0,0,0,0);
14098 $col_b = array(0,100,0,0);
14099 break;
14100 }
14101 case 'Y': { // YELLOW (CMYK)
14102 $col_a = array(0,0,0,0);
14103 $col_b = array(0,0,100,0);
14104 break;
14105 }
14106 case 'K': { // KEY - BLACK (CMYK)
14107 $col_a = array(0,0,0,0);
14108 $col_b = array(0,0,0,100);
14109 break;
14110 }
14111 case 'RGB': { // BLACK REGISTRATION (RGB)
14112 $col_a = array(255,255,255);
14113 $col_b = array(0,0,0);
14114 break;
14115 }
14116 case 'CMYK': { // BLACK REGISTRATION (CMYK)
14117 $col_a = array(0,0,0,0);
14118 $col_b = array(100,100,100,100);
14119 break;
14120 }
14121 case 'ALL': { // SPOT COLOR REGISTRATION
14122 $col_a = array(0,0,0,0,'None');
14123 $col_b = array(100,100,100,100,'All');
14124 break;
14125 }
14126 case 'NONE': { // SKIP THIS COLOR
14127 $col_a = array(0,0,0,0,'None');
14128 $col_b = array(0,0,0,0,'None');
14129 break;
14130 }
14131 default: { // SPECIFIC SPOT COLOR NAME
14132 $col_a = array(0,0,0,0,'None');
14133 $col_b = TCPDF_COLORS::getSpotColor($col, $this->spot_colors);
14134 if ($col_b === false) {
14135 // in case of error defaults to the registration color
14136 $col_b = array(100,100,100,100,'All');
14137 }
14138 break;
14139 }
14140 }
14141 if ($col != 'NONE') {
14142 if ($transition) {
14143 // color gradient
14145 } else {
14146 $this->SetFillColorArray($col_b);
14147 // colored rectangle
14149 }
14150 $xb += $xd;
14151 $yb += $yd;
14152 }
14153 }
14154 }
LinearGradient($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0))
Paints a linear colour gradient.
Definition: tcpdf.php:14310
Rect($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array())
Draws a rectangle.
Definition: tcpdf.php:11511
References $coords, $h, $spot_colors, $w, $x, $y, TCPDF_COLORS\getSpotColor(), LinearGradient(), Rect(), and SetFillColorArray().
Here is the call graph for this function:
◆ ComboBox()
| TCPDF::ComboBox | ( | $name, | |
| $w, | |||
| $h, | |||
| $values, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a Combo-box field.
- Parameters
-
$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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 12955 of file tcpdf.php.
12955 {
12958 }
12961 }
12962 // check page for no-write regions and adapt page margins if necessary
12966 $s = '';
12967 foreach ($values as $value) {
12968 if (is_array($value)) {
12969 $s .= ',[\''.addslashes($value[1]).'\',\''.addslashes($value[0]).'\']';
12970 } else {
12971 $s .= ',[\''.addslashes($value).'\',\''.addslashes($value).'\']';
12972 }
12973 }
12974 $this->javascript .= 'f'.$name.'.setItems('.substr($s, 1).');'."\n";
12975 return;
12976 }
12977 // get default style
12978 $prop = array_merge($this->getFormDefaultProp(), $prop);
12979 $prop['Combo'] = true;
12980 // get annotation data
12981 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12982 // set additional default options
12983 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12984 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12985 $popt['da'] = $fontstyle;
12986 // build appearance stream
12987 $popt['ap'] = array();
12988 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12989 $text = '';
12990 foreach($values as $item) {
12991 if (is_array($item)) {
12992 $text .= $item[1]."\n";
12993 } else {
12994 $text .= $item."\n";
12995 }
12996 }
12997 $tmpid = $this->startTemplate($w, $h, false);
12998 $this->MultiCell($w, $h, $text, 0, '', false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
12999 $this->endTemplate();
13000 --$this->n;
13001 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
13002 unset($this->xobjects[$tmpid]);
13003 $popt['ap']['n'] .= 'Q EMC';
13004 // merge options
13005 $opt = array_merge($popt, $opt);
13006 // set remaining annotation data
13007 $opt['Subtype'] = 'Widget';
13008 $opt['ft'] = 'Ch';
13009 $opt['t'] = $name;
13010 $opt['opt'] = $values;
13011 unset($opt['mk']['ca']);
13012 unset($opt['mk']['rc']);
13013 unset($opt['mk']['ac']);
13014 unset($opt['mk']['i']);
13015 unset($opt['mk']['ri']);
13016 unset($opt['mk']['ix']);
13017 unset($opt['mk']['if']);
13018 unset($opt['mk']['tp']);
13019 $this->Annotation($x, $y, $w, $h, $name, $opt, 0);
13020 if ($this->rtl) {
13021 $this->x -= $w;
13022 } else {
13023 $this->x += $w;
13024 }
13025 }
◆ commitTransaction()
| TCPDF::commitTransaction | ( | ) |
◆ convertSVGtMatrix()
|
protected |
Convert SVG transformation matrix to PDF.
- Parameters
-
$tm (array) original SVG transformation matrix
- Returns
- array transformation matrix
- Since
- 5.0.000 (2010-05-02)
◆ CoonsPatchMesh()
| 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.
- Parameters
-
$x (float) abscissa of the top left corner of the rectangle. $y (float) ordinate of the top left corner of the rectangle. $w (float) width of the rectangle. $h (float) height of the rectangle. $col1 (array) 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) - for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).
- for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches
$coords_min (array) 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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14351 of file tcpdf.php.
14351 {
14352 if ($this->pdfa_mode OR ($this->state != 2)) {
14353 return;
14354 }
14356 $n = count($this->gradients) + 1;
14357 $this->gradients[$n] = array();
14363 //check the coords array if it is the simple array or the multi patch array
14365 //simple array -> convert to multi patch array
14366 if (!isset($col1[1])) {
14367 $col1[1] = $col1[2] = $col1[0];
14368 }
14369 if (!isset($col2[1])) {
14370 $col2[1] = $col2[2] = $col2[0];
14371 }
14372 if (!isset($col3[1])) {
14373 $col3[1] = $col3[2] = $col3[0];
14374 }
14375 if (!isset($col4[1])) {
14376 $col4[1] = $col4[2] = $col4[0];
14377 }
14392 } else {
14393 //multi patch array
14395 }
14396 $bpcd = 65535; //16 bits per coordinate
14397 //build the data stream
14399 $count_patch = count($patch_array);
14400 for ($i=0; $i < $count_patch; ++$i) {
14401 $this->gradients[$n]['stream'] .= chr($patch_array[$i]['f']); //start with the edge flag as 8 bit
14403 for ($j=0; $j < $count_points; ++$j) {
14404 //each point as 16 bit
14405 $patch_array[$i]['points'][$j] = (($patch_array[$i]['points'][$j] - $coords_min) / ($coords_max - $coords_min)) * $bpcd;
14408 }
14411 }
14414 }
14416 for ($j=0; $j < $count_cols; ++$j) {
14417 //each color component as 8 bit
14421 }
14422 }
14423 //paint the gradient
14425 //restore previous Graphic State
14426 $this->_outRestoreGraphicsState();
14427 if ($this->inxobj) {
14428 // we are inside an XObject template
14430 }
14431 }
References $coords, $coords_max, $coords_min, $h, $n, $patch_array, $w, $x, $xobjid, $y, _out(), _outRestoreGraphicsState(), and Clip().
Here is the call graph for this function:
◆ copyPage()
| TCPDF::copyPage | ( | $page = 0 | ) |
Clone the specified page to a new page.
- Parameters
-
$page (int) number of page to copy (0 = current page)
- Returns
- true in case of success, false in case of error.
- Since
- 4.9.015 (2010-04-20)
Definition at line 21212 of file tcpdf.php.
21212 {
21214 // default value
21216 }
21218 return false;
21219 }
21220 // close the last page
21221 $this->endPage();
21222 // copy all page-related states
21223 ++$this->numpages;
21224 $this->page = $this->numpages;
21235 }
21238 }
21241 }
21244 }
21246 // start a new group
21248 $this->currpagegroup = $this->newpagegroup[$this->page];
21249 $this->pagegroups[$this->currpagegroup] = 1;
21250 } elseif (isset($this->currpagegroup) AND ($this->currpagegroup > 0)) {
21251 ++$this->pagegroups[$this->currpagegroup];
21252 }
21253 // copy outlines
21254 $tmpoutlines = $this->outlines;
21255 foreach ($tmpoutlines as $key => $outline) {
21257 $this->outlines[] = array('t' => $outline['t'], 'l' => $outline['l'], 'x' => $outline['x'], 'y' => $outline['y'], 'p' => $this->page, 'f' => $outline['f'], 's' => $outline['s'], 'c' => $outline['c']);
21258 }
21259 }
21260 // copy links
21261 $tmplinks = $this->links;
21262 foreach ($tmplinks as $key => $link) {
21264 $this->links[] = array('p' => $this->page, 'y' => $link['y'], 'f' => $link['f']);
21265 }
21266 }
21267 // return to last page
21269 return true;
21270 }
$newpagegroup
Array of page numbers were a new page group was started (the page numbers are the keys of the array).
Definition: tcpdf.php:889
◆ cropMark()
| TCPDF::cropMark | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$type = 'T, |
|||
| R | , | ||
| B | , | ||
| L' | , | ||
$color = array(100,100,100,100,'All') |
|||
| ) |
Paints crop marks.
- Parameters
-
$x (float) abscissa of the crop mark center. $y (float) ordinate of the crop mark center. $w (float) width of the crop mark. $h (float) height of the crop mark. $type (string) 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 spot registration color).
- Since
- 4.9.000 (2010-03-26)
Definition at line 14168 of file tcpdf.php.
14168 {
14169 $this->SetLineStyle(array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $color));
14170 $type = strtoupper($type);
14171 $type = preg_replace('/[^A-Z\-\,]*/', '', $type);
14172 // split type in single components
14173 $type = str_replace('-', ',', $type);
14174 $type = str_replace('TL', 'T,L', $type);
14175 $type = str_replace('TR', 'T,R', $type);
14176 $type = str_replace('BL', 'F,L', $type);
14177 $type = str_replace('BR', 'F,R', $type);
14178 $type = str_replace('A', 'T,L', $type);
14179 $type = str_replace('B', 'T,R', $type);
14180 $type = str_replace('T,RO', 'BO', $type);
14181 $type = str_replace('C', 'F,L', $type);
14182 $type = str_replace('D', 'F,R', $type);
14183 $crops = explode(',', strtoupper($type));
14184 // remove duplicates
14185 $crops = array_unique($crops);
14188 foreach ($crops as $crop) {
14189 switch ($crop) {
14190 case 'T':
14191 case 'TOP': {
14192 $x1 = $x;
14194 $x2 = $x;
14195 $y2 = ($y - $dh);
14196 break;
14197 }
14198 case 'F':
14199 case 'BOTTOM': {
14200 $x1 = $x;
14201 $y1 = ($y + $dh);
14202 $x2 = $x;
14204 break;
14205 }
14206 case 'L':
14207 case 'LEFT': {
14209 $y1 = $y;
14210 $x2 = ($x - $dw);
14211 $y2 = $y;
14212 break;
14213 }
14214 case 'R':
14215 case 'RIGHT': {
14216 $x1 = ($x + $dw);
14217 $y1 = $y;
14219 $y2 = $y;
14220 break;
14221 }
14222 }
14223 $this->Line($x1, $y1, $x2, $y2);
14224 }
14225 }
References $h, $w, $x, $y, Line(), and SetLineStyle().
Here is the call graph for this function:
◆ Curve()
| 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.
- Parameters
-
$x0 (float) Abscissa of start point. $y0 (float) Ordinate of start point. $x1 (float) Abscissa of control point 1. $y1 (float) Ordinate of control point 1. $x2 (float) Abscissa of control point 2. $y2 (float) Ordinate of control point 2. $x3 (float) Abscissa of end point. $y3 (float) Ordinate of end point. $style (string) Style of rendering. See the getPathPaintOperator() function for more information. $line_style (array) 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).
- See also
- SetLineStyle()
- Since
- 2.1.000 (2008-01-08)
Definition at line 11582 of file tcpdf.php.
11582 {
11583 if ($this->state != 2) {
11584 return;
11585 }
11587 $this->SetFillColorArray($fill_color);
11588 }
11590 if ($line_style) {
11591 $this->SetLineStyle($line_style);
11592 }
11593 $this->_outPoint($x0, $y0);
11594 $this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
11595 $this->_out($op);
11596 }
static getPathPaintOperator($style, $default='S')
Get the Path-Painting Operators.
Definition: tcpdf_static.php:1568
References $style, _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Here is the call graph for this function:
◆ deletePage()
| TCPDF::deletePage | ( | $page | ) |
Remove the specified page.
- Parameters
-
$page (int) page to remove
- Returns
- true in case of success, false in case of error.
- Since
- 4.6.004 (2009-04-23)
Definition at line 21022 of file tcpdf.php.
21022 {
21024 return false;
21025 }
21026 // delete current page
21027 unset($this->pages[$page]);
21028 unset($this->pagedim[$page]);
21029 unset($this->pagelen[$page]);
21030 unset($this->intmrk[$page]);
21031 unset($this->bordermrk[$page]);
21032 unset($this->cntmrk[$page]);
21034 if (isset($this->offsets[$oid])){
21035 unset($this->offsets[$oid]);
21036 }
21037 }
21038 unset($this->pageobjects[$page]);
21040 unset($this->footerpos[$page]);
21041 }
21043 unset($this->footerlen[$page]);
21044 }
21046 unset($this->transfmrk[$page]);
21047 }
21049 unset($this->PageAnnots[$page]);
21050 }
21051 if (isset($this->newpagegroup) AND !empty($this->newpagegroup)) {
21053 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $page)) {
21054 --$this->pagegroups[$this->newpagegroup[$i]];
21055 break;
21056 }
21057 }
21058 }
21060 unset($this->pageopen[$page]);
21061 }
21062 if ($page < $this->numpages) {
21063 // update remaining pages
21065 $j = $i + 1;
21066 // shift pages
21068 $this->pagedim[$i] = $this->pagedim[$j];
21069 $this->pagelen[$i] = $this->pagelen[$j];
21070 $this->intmrk[$i] = $this->intmrk[$j];
21071 $this->bordermrk[$i] = $this->bordermrk[$j];
21072 $this->cntmrk[$i] = $this->cntmrk[$j];
21073 $this->pageobjects[$i] = $this->pageobjects[$j];
21074 if (isset($this->footerpos[$j])) {
21075 $this->footerpos[$i] = $this->footerpos[$j];
21076 } elseif (isset($this->footerpos[$i])) {
21077 unset($this->footerpos[$i]);
21078 }
21079 if (isset($this->footerlen[$j])) {
21080 $this->footerlen[$i] = $this->footerlen[$j];
21081 } elseif (isset($this->footerlen[$i])) {
21082 unset($this->footerlen[$i]);
21083 }
21084 if (isset($this->transfmrk[$j])) {
21085 $this->transfmrk[$i] = $this->transfmrk[$j];
21086 } elseif (isset($this->transfmrk[$i])) {
21087 unset($this->transfmrk[$i]);
21088 }
21089 if (isset($this->PageAnnots[$j])) {
21090 $this->PageAnnots[$i] = $this->PageAnnots[$j];
21091 } elseif (isset($this->PageAnnots[$i])) {
21092 unset($this->PageAnnots[$i]);
21093 }
21094 if (isset($this->newpagegroup[$j])) {
21095 $this->newpagegroup[$i] = $this->newpagegroup[$j];
21096 unset($this->newpagegroup[$j]);
21097 }
21098 if ($this->currpagegroup == $j) {
21099 $this->currpagegroup = $i;
21100 }
21101 if (isset($this->pageopen[$j])) {
21102 $this->pageopen[$i] = $this->pageopen[$j];
21103 } elseif (isset($this->pageopen[$i])) {
21104 unset($this->pageopen[$i]);
21105 }
21106 }
21107 // remove last page
21108 unset($this->pages[$this->numpages]);
21109 unset($this->pagedim[$this->numpages]);
21110 unset($this->pagelen[$this->numpages]);
21111 unset($this->intmrk[$this->numpages]);
21112 unset($this->bordermrk[$this->numpages]);
21113 unset($this->cntmrk[$this->numpages]);
21114 foreach ($this->pageobjects[$this->numpages] as $oid) {
21115 if (isset($this->offsets[$oid])){
21116 unset($this->offsets[$oid]);
21117 }
21118 }
21119 unset($this->pageobjects[$this->numpages]);
21120 if (isset($this->footerpos[$this->numpages])) {
21121 unset($this->footerpos[$this->numpages]);
21122 }
21123 if (isset($this->footerlen[$this->numpages])) {
21124 unset($this->footerlen[$this->numpages]);
21125 }
21126 if (isset($this->transfmrk[$this->numpages])) {
21127 unset($this->transfmrk[$this->numpages]);
21128 }
21129 if (isset($this->PageAnnots[$this->numpages])) {
21130 unset($this->PageAnnots[$this->numpages]);
21131 }
21132 if (isset($this->newpagegroup[$this->numpages])) {
21133 unset($this->newpagegroup[$this->numpages]);
21134 }
21135 if ($this->currpagegroup == $this->numpages) {
21136 $this->currpagegroup = ($this->numpages - 1);
21137 }
21138 if (isset($this->pagegroups[$this->numpages])) {
21139 unset($this->pagegroups[$this->numpages]);
21140 }
21141 if (isset($this->pageopen[$this->numpages])) {
21142 unset($this->pageopen[$this->numpages]);
21143 }
21144 }
21145 --$this->numpages;
21146 $this->page = $this->numpages;
21147 // adjust outlines
21148 $tmpoutlines = $this->outlines;
21149 foreach ($tmpoutlines as $key => $outline) {
21150 if (!$outline['f']) {
21152 $this->outlines[$key]['p'] = $outline['p'] - 1;
21154 unset($this->outlines[$key]);
21155 }
21156 }
21157 }
21158 // adjust dests
21159 $tmpdests = $this->dests;
21160 foreach ($tmpdests as $key => $dest) {
21161 if (!$dest['f']) {
21163 $this->dests[$key]['p'] = $dest['p'] - 1;
21165 unset($this->dests[$key]);
21166 }
21167 }
21168 }
21169 // adjust links
21170 $tmplinks = $this->links;
21171 foreach ($tmplinks as $key => $link) {
21172 if (!$link['f']) {
21174 $this->links[$key]['p'] = $link['p'] - 1;
21176 unset($this->links[$key]);
21177 }
21178 }
21179 }
21180 // adjust javascript
21181 $jpage = $page;
21182 if (preg_match_all('/this\.addField\(\'([^\']*)\',\'([^\']*)\',([0-9]+)/', $this->javascript, $pamatch) > 0) {
21183 foreach($pamatch[0] as $pk => $pmatch) {
21184 $pagenum = intval($pamatch[3][$pk]) + 1;
21185 if ($pagenum >= $jpage) {
21186 $newpage = ($pagenum - 1);
21187 } elseif ($pagenum == $jpage) {
21188 $newpage = 1;
21189 } else {
21190 $newpage = $pagenum;
21191 }
21192 --$newpage;
21193 $newjs = "this.addField(\'".$pamatch[1][$pk]."\',\'".$pamatch[2][$pk]."\',".$newpage;
21194 $this->javascript = str_replace($pmatch, $newjs, $this->javascript);
21195 }
21196 unset($pamatch);
21197 }
21198 // return to last page
21199 if ($this->numpages > 0) {
21201 }
21202 return true;
21203 }
$dests
A dictionary of names and corresponding destinations (Dests key on document Catalog).
Definition: tcpdf.php:1575
◆ drawHTMLTagBorder()
|
protected |
Draw an HTML block border and fill.
- Parameters
-
$tag (array) array of tag properties. $xmax (int) end X coordinate for border.
- Since
- 5.7.000 (2010-08-03)
Definition at line 19948 of file tcpdf.php.
19948 {
19949 if (!isset($tag['borderposition'])) {
19950 // nothing to draw
19951 return;
19952 }
19953 $prev_x = $this->x;
19954 $prev_y = $this->y;
19955 $prev_lasth = $this->lasth;
19956 $border = 0;
19957 $fill = false;
19958 $this->lasth = 0;
19959 if (isset($tag['border']) AND !empty($tag['border'])) {
19960 // get border style
19963 // border for table header
19965 }
19966 }
19967 if (isset($tag['bgcolor']) AND ($tag['bgcolor'] !== false)) {
19968 // get background color
19969 $old_bgcolor = $this->bgcolor;
19971 $fill = true;
19972 }
19974 // nothing to draw
19975 return;
19976 }
19977 if (isset($tag['attribute']['cellspacing'])) {
19979 $cellspacing = array('H' => $clsp, 'V' => $clsp);
19980 } elseif (isset($tag['border-spacing'])) {
19981 $cellspacing = $tag['border-spacing'];
19982 } else {
19983 $cellspacing = array('H' => 0, 'V' => 0);
19984 }
19986 // draw the border externally respect the sqare edge.
19988 }
19989 if ($this->rtl) {
19990 if ($xmax >= $tag['borderposition']['x']) {
19991 $xmax = $tag['borderposition']['xmax'];
19992 }
19994 } else {
19995 if ($xmax <= $tag['borderposition']['x']) {
19996 $xmax = $tag['borderposition']['xmax'];
19997 }
19999 }
20001 return;
20002 }
20004 $startpage = $tag['borderposition']['page'];
20005 $startcolumn = $tag['borderposition']['column'];
20008 $endpage = $this->page;
20010 $currentY = $this->y;
20011 $this->x = $x;
20012 // get latest column
20013 $endcolumn = $this->current_column;
20014 if ($this->num_columns == 0) {
20015 $this->num_columns = 1;
20016 }
20017 // get border modes
20021 // temporary disable page regions
20022 $temp_page_regions = $this->page_regions;
20023 $this->page_regions = array();
20024 // design borders around HTML cells.
20026 $ccode = '';
20028 if ($this->num_columns < 2) {
20029 // single-column mode
20030 $this->x = $x;
20031 $this->y = $this->tMargin;
20032 }
20033 // account for margin changes
20037 } elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
20039 }
20040 }
20041 if ($startpage == $endpage) {
20042 // single page
20045 if ($startcolumn == $endcolumn) { // single column
20046 $cborder = $border;
20048 $this->y = $starty;
20050 $cborder = $border_start;
20051 $this->y = $starty;
20054 $cborder = $border_end;
20056 } else { // middle column
20057 $cborder = $border_middle;
20059 }
20061 } // end for each column
20066 $cborder = $border_start;
20067 $this->y = $starty;
20069 } else { // middle column
20070 $cborder = $border_middle;
20072 }
20074 } // end for each column
20079 // end column
20080 $cborder = $border_end;
20082 } else {
20083 // middle column
20084 $cborder = $border_middle;
20086 }
20088 } // end for each column
20089 } else { // middle page
20092 $cborder = $border_middle;
20095 } // end for each column
20096 }
20097 if ($cborder OR $fill) {
20098 $offsetlen = strlen($ccode);
20099 // draw border and fill
20100 if ($this->inxobj) {
20101 // we are inside an XObject template
20102 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
20103 $pagemarkkey = key($this->xobjects[$this->xobjid]['transfmrk']);
20106 } else {
20109 }
20111 $pstart = substr($pagebuff, 0, $pagemark);
20112 $pend = substr($pagebuff, $pagemark);
20114 } else {
20115 if (end($this->transfmrk[$this->page]) !== false) {
20116 $pagemarkkey = key($this->transfmrk[$this->page]);
20117 $pagemark = $this->transfmrk[$this->page][$pagemarkkey];
20118 } elseif ($this->InFooter) {
20119 $pagemark = $this->footerpos[$this->page];
20120 } else {
20121 $pagemark = $this->intmrk[$this->page];
20122 }
20123 $pagebuff = $this->getPageBuffer($this->page);
20124 $pstart = substr($pagebuff, 0, $pagemark);
20125 $pend = substr($pagebuff, $pagemark);
20126 $this->setPageBuffer($this->page, $pstart.$ccode.$pend);
20127 $this->bordermrk[$this->page] += $offsetlen;
20128 $this->cntmrk[$this->page] += $offsetlen;
20129 }
20130 }
20131 } // end for each page
20132 // restore page regions
20133 $this->page_regions = $temp_page_regions;
20134 if (isset($old_bgcolor)) {
20135 // restore background color
20136 $this->SetFillColorArray($old_bgcolor);
20137 }
20138 // restore pointer position
20139 $this->x = $prev_x;
20140 $this->y = $prev_y;
20141 $this->lasth = $prev_lasth;
20142 }
References $bMargin, $border, $column, $h, $starty, $w, $x, $y, TCPDF_STATIC\empty_string(), and TCPDF_STATIC\getBorderMode().
Here is the call graph for this function:
◆ Ellipse()
| 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.
- Parameters
-
$x0 (float) Abscissa of center point. $y0 (float) Ordinate of center point. $rx (float) Horizontal radius. $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0. $angle (float) Angle oriented (anti-clockwise). Default value: 0. $astart (float) Angle start of draw line. Default value: 0. $afinish (float) 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.
- Since
- 2.1.000 (2008-01-08)
Definition at line 11652 of file tcpdf.php.
11652 {
11653 if ($this->state != 2) {
11654 return;
11655 }
11657 $ry = $rx;
11658 }
11660 $this->SetFillColorArray($fill_color);
11661 }
11663 if ($op == 'f') {
11664 $line_style = array();
11665 }
11666 if ($line_style) {
11667 $this->SetLineStyle($line_style);
11668 }
11669 $this->_outellipticalarc($x0, $y0, $rx, $ry, $angle, $astart, $afinish, false, $nc, true, true, false);
11670 $this->_out($op);
11671 }
_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.
Definition: tcpdf.php:11693
References $angle, $style, _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:
◆ endLayer()
| TCPDF::endLayer | ( | ) |
End the current PDF layer.
- Since
- 5.9.102 (2011-07-13)
Definition at line 13745 of file tcpdf.php.
13745 {
13746 if ($this->state != 2) {
13747 return;
13748 }
13749 if ($this->openMarkedContent) {
13750 // close existing open marked-content layer
13752 $this->openMarkedContent = false;
13753 }
13754 }
References _out().
Referenced by Close(), and setVisibility().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ endPage()
| TCPDF::endPage | ( | $tocpage = false | ) |
Terminate the current page.
- Parameters
-
$tocpage (boolean) if true set the tocpage state to false (end the page used to display Table Of Content).
- Since
- 4.2.010 (2008-11-14)
- See also
- AddPage(), startPage(), addTOCPage(), endTOCPage()
Definition at line 3126 of file tcpdf.php.
3126 {
3127 // check if page is already closed
3128 if (($this->page == 0) OR ($this->numpages > $this->page) OR (!$this->pageopen[$this->page])) {
3129 return;
3130 }
3131 // print page footer
3132 $this->setFooter();
3133 // close page
3134 $this->_endpage();
3135 // mark page as closed
3138 $this->tocpage = false;
3139 }
3140 }
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:
◆ endSVGElementHandler()
|
protected |
Sets the closing SVG element handler function for the XML parser.
- Parameters
-
$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.
- Since
- 5.0.000 (2010-05-02)
Definition at line 24384 of file tcpdf.php.
24384 {
24385 $name = $this->removeTagNamespace($name);
24386 if ($this->svgdefsmode AND !in_array($name, array('defs', 'clipPath', 'linearGradient', 'radialGradient', 'stop'))) {;
24387 if (end($this->svgdefs) !== FALSE) {
24388 $last_svgdefs_id = key($this->svgdefs);
24389 if (isset($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'])) {
24390 foreach($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'] as $child_element) {
24391 if (isset($child_element['attribs']['id']) AND ($child_element['name'] == $name)) {
24392 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$child_element['attribs']['id'].'_CLOSE'] = array('name' => $name, 'attribs' => array('closing_tag' => TRUE, 'content' => $this->svgtext));
24393 return;
24394 }
24395 }
24396 if ($this->svgdefs[$last_svgdefs_id]['name'] == $name) {
24397 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$last_svgdefs_id.'_CLOSE'] = array('name' => $name, 'attribs' => array('closing_tag' => TRUE, 'content' => $this->svgtext));
24398 return;
24399 }
24400 }
24401 }
24402 return;
24403 }
24404 switch($name) {
24405 case 'defs': {
24406 $this->svgdefsmode = false;
24407 break;
24408 }
24409 // clipPath
24410 case 'clipPath': {
24411 $this->svgclipmode = false;
24412 break;
24413 }
24414 case 'svg': {
24415 if (--$this->svg_tag_depth <= 0) {
24416 break;
24417 }
24418 }
24419 case 'g': {
24420 // ungroup: remove last style from array
24421 array_pop($this->svgstyles);
24422 $this->StopTransform();
24423 break;
24424 }
24425 case 'text':
24426 case 'tspan': {
24427 if ($this->svgtextmode['invisible']) {
24428 // This implementation must be fixed to following the rule:
24429 // If the 'visibility' property is set to hidden on a 'tspan', 'tref' or 'altGlyph' element, then the text is invisible but still takes up space in text layout calculations.
24430 break;
24431 }
24432 // print text
24434 //$text = $this->stringTrim($text);
24436 if ($this->svgtextmode['text-anchor'] != 'start') {
24437 // check if string is RTL text
24438 if ($this->svgtextmode['text-anchor'] == 'end') {
24439 if ($this->svgtextmode['rtl']) {
24440 $this->x += $textlen;
24441 } else {
24442 $this->x -= $textlen;
24443 }
24444 } elseif ($this->svgtextmode['text-anchor'] == 'middle') {
24445 if ($this->svgtextmode['rtl']) {
24446 $this->x += ($textlen / 2);
24447 } else {
24448 $this->x -= ($textlen / 2);
24449 }
24450 }
24451 }
24455 if ($name == 'text') {
24456 // store current coordinates
24457 $tmpx = $this->x;
24458 $tmpy = $this->y;
24459 }
24460 // print the text
24462 if ($name == 'text') {
24463 // restore coordinates
24464 $this->x = $tmpx;
24465 $this->y = $tmpy;
24466 }
24467 // restore previous rendering mode
24468 $this->textrendermode = $textrendermode;
24469 $this->textstrokewidth = $textstrokewidth;
24470 $this->svgtext = '';
24471 $this->StopTransform();
24472 if (!$this->svgdefsmode) {
24473 array_pop($this->svgstyles);
24474 }
24475 break;
24476 }
24477 default: {
24478 break;
24479 }
24480 }
24481 }
StopTransform()
Stops a 2D tranformation restoring previous graphic state.
Definition: tcpdf.php:10968
$textrendermode
Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor...
Definition: tcpdf.php:1464
◆ endTemplate()
| 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.
- Returns
- int the XObject Template ID in case of success or false in case of error.
- Since
- 5.8.017 (2010-08-24)
- See also
- startTemplate(), printTemplate()
Definition at line 22305 of file tcpdf.php.
22305 {
22306 if (!$this->inxobj) {
22307 // we are not inside a template
22308 return false;
22309 }
22310 $this->inxobj = false;
22311 // restore previous graphic state
22314 }
Referenced by Button(), Header(), and TextField().
Here is the caller graph for this function:
◆ endTOCPage()
| TCPDF::endTOCPage | ( | ) |
Terminate the current TOC (Table Of Content) page.
- Since
- 5.0.001 (2010-05-06)
- See also
- AddPage(), startPage(), endPage(), addTOCPage()
Definition at line 3087 of file tcpdf.php.
References endPage().
Here is the call graph for this function:
◆ Error()
| TCPDF::Error | ( | $msg | ) |
Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
- Parameters
-
$msg (string) The error message
- Since
- 1.0
Definition at line 2921 of file tcpdf.php.
2921 {
2922 // unset all class variables
2925 die('<strong>TCPDF ERROR: </strong>'.$msg);
2926 } else {
2927 throw new Exception('TCPDF ERROR: '.$msg);
2928 }
2929 }
const K_TCPDF_THROW_EXCEPTION_ERROR
If true and PHP version is greater than 5, then the Error() method throw new exception instead of ter...
Definition: tcpdf_config.php:218
References _destroy(), defined, and K_TCPDF_THROW_EXCEPTION_ERROR.
Referenced by _dochecks(), _generateencryptionkey(), _putfonts(), _puttruetypeunicode(), AddFont(), Image(), ImageEps(), ImagePngAlpha(), TCPDF_IMPORT\importPDF(), openHTMLTagHandler(), Output(), Scale(), SetDisplayMode(), setPage(), setPageUnit(), SetProtection(), setSignature(), setSpotColor(), setTimeStamp(), setVisibility(), Skew(), unserializeTCPDFtagParameters(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ fitBlock()
|
protected |
Set the block dimensions accounting for page breaks and page/column fitting.
- Parameters
-
$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.
- Returns
- array($w, $h, $x, $y)
- Since
- 5.5.009 (2010-07-05)
Definition at line 6723 of file tcpdf.php.
6723 {
6725 // set maximum width
6728 $w = 1;
6729 }
6730 }
6732 // set maximum height
6735 $h = 1;
6736 }
6737 }
6738 // resize the block to be vertically contained on a single page or single column
6739 if ($fitonpage OR $this->AutoPageBreak) {
6744 }
6745 // resize the block to be horizontally contained on a single page or single column
6746 if ($fitonpage) {
6747 $maxw = ($this->w - $this->lMargin - $this->rMargin);
6749 $w = $maxw;
6751 }
6752 }
6753 }
6754 // Check whether we need a new page or new column first as this does not fit
6755 $prev_x = $this->x;
6756 $prev_y = $this->y;
6759 if ($this->rtl) {
6761 } else {
6762 $x += ($this->x - $prev_x);
6763 }
6764 $this->newline = true;
6765 }
6766 // resize the block to be contained on the remaining available page or column space
6767 if ($fitonpage) {
6768 // tcpdf-patch: begin
6769 // 2016-06-02 mbecker will create a pull request to make this patch
6771 {
6773 }
6774 else
6775 {
6776 $ratio_wh = 1;
6777 }
6778 // tcpdf-patch: end
6782 }
6789 }
6790 }
6792 }
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:
◆ fixHTMLCode()
| TCPDF::fixHTMLCode | ( | $html, | |
$default_css = '', |
|||
$tagvs = '', |
|||
$tidy_options = '' |
|||
| ) |
Cleanup HTML code (requires HTML Tidy library).
- Parameters
-
$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
- Returns
- string XHTML code cleaned up
- Since
- 5.9.017 (2010-11-16)
- See also
- setHtmlVSpace()
Definition at line 15832 of file tcpdf.php.
15832 {
15833 return TCPDF_STATIC::fixHTMLCode($html, $default_css, $tagvs, $tidy_options, $this->tagvspaces);
15834 }
static fixHTMLCode($html, $default_css='', $tagvs='', $tidy_options='', &$tagvspaces)
Cleanup HTML code (requires HTML Tidy library).
Definition: tcpdf_static.php:1139
References $html, and TCPDF_STATIC\fixHTMLCode().
Here is the call graph for this function:
◆ Footer()
| 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.
Reimplemented in MYPDF, and TOC_TCPDF.
Definition at line 3469 of file tcpdf.php.
3469 {
3470 $cur_y = $this->y;
3471 $this->SetTextColorArray($this->footer_text_color);
3472 //set style for cell border
3473 $line_width = (0.85 / $this->k);
3474 $this->SetLineStyle(array('width' => $line_width, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $this->footer_line_color));
3475 //print document barcode
3478 $this->Ln($line_width);
3479 $barcode_width = round(($this->w - $this->original_lMargin - $this->original_rMargin) / 3);
3480 $style = array(
3481 'position' => $this->rtl?'R':'L',
3482 'align' => $this->rtl?'R':'L',
3483 'stretch' => false,
3484 'fitwidth' => true,
3485 'cellfitalign' => '',
3486 'border' => false,
3487 'padding' => 0,
3488 'fgcolor' => array(0,0,0),
3489 'bgcolor' => false,
3490 'text' => false
3491 );
3492 $this->write1DBarcode($barcode, 'C128', '', $cur_y + $line_width, '', (($this->footer_margin / 3) - $line_width), 0.3, $style, '');
3493 }
3494 $w_page = isset($this->l['w_page']) ? $this->l['w_page'].' ' : '';
3495 if (empty($this->pagegroups)) {
3497 } else {
3499 }
3500 $this->SetY($cur_y);
3501 //Print page number
3503 $this->SetX($this->original_rMargin);
3505 } else {
3506 $this->SetX($this->original_lMargin);
3508 }
3509 }
getAliasNbPages()
Returns the string alias used for the total number of pages.
Definition: tcpdf.php:13610
write1DBarcode($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='')
Print a Linear Barcode.
Definition: tcpdf.php:15197
getAliasRightShift()
Returns the string alias used right align page numbers.
Definition: tcpdf.php:13584
SetY($y, $resetx=true, $rtloff=false)
Moves the current abscissa back to the left margin and sets the ordinate.
Definition: tcpdf.php:7474
getPageGroupAlias()
Return the alias for the total number of pages in the current page group.
Definition: tcpdf.php:13640
References $barcode, $k, $style, $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:
◆ getAbsFontMeasure()
| TCPDF::getAbsFontMeasure | ( | $s | ) |
Convert a relative font measure into absolute value.
- Parameters
-
$s (int) Font measure.
- Returns
- float Absolute measure.
- Since
- 5.9.186 (2012-09-13)
Definition at line 4534 of file tcpdf.php.
4534 {
4535 return ($s * $this->FontSize / 1000);
4536 }
Referenced by getFontBBox(), getRawCharWidth(), and RadioButton().
Here is the caller graph for this function:
◆ GetAbsX()
| TCPDF::GetAbsX | ( | ) |
◆ getAliasNbPages()
| 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.
- Returns
- string
- Since
- 4.0.018 (2008-08-08)
Definition at line 13610 of file tcpdf.php.
13610 {
13612 return '{'.TCPDF_STATIC::$alias_tot_pages.'}';
13613 }
13615 }
References TCPDF_STATIC\$alias_tot_pages, and isUnicodeFont().
Referenced by MYPDF\Footer(), and Footer().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getAliasNumPage()
| 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.
- Returns
- string
- Since
- 4.5.000 (2009-01-02)
Definition at line 13625 of file tcpdf.php.
13625 {
13627 return '{'.TCPDF_STATIC::$alias_num_page.'}';
13628 }
13630 }
References TCPDF_STATIC\$alias_num_page, and isUnicodeFont().
Referenced by MYPDF\Footer().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getAliasRightShift()
| 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.
- Returns
- string
- Since
- 5.9.099 (2011-06-27)
Definition at line 13584 of file tcpdf.php.
13584 {
13585 // calculate aproximatively the ratio between widths of aliases and replacements.
13586 $ref = '{'.TCPDF_STATIC::$alias_right_shift.'}{'.TCPDF_STATIC::$alias_tot_pages.'}{'.TCPDF_STATIC::$alias_num_page.'}';
13588 $wrep = $this->GetStringWidth($rep);
13589 if ($wrep > 0) {
13590 $wdiff = max(1, ($this->GetStringWidth($ref) / $wrep));
13591 } else {
13592 $wdiff = 1;
13593 }
13597 $alias = '{'.$alias;
13598 }
13599 return $alias;
13600 }
static $alias_right_shift
String alias for right shift compensation used to correctly align page numbers on the right.
Definition: tcpdf_static.php:88
References TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, GetNumChars(), GetStringWidth(), isUnicodeFont(), and sprintf.
Referenced by Footer().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getAllInternalPageNumberAliases()
|
protected |
Return an array containing all internal page aliases.
- Returns
- array of page number aliases
Definition at line 7829 of file tcpdf.php.
7829 {
7830 $basic_alias = array(TCPDF_STATIC::$alias_tot_pages, TCPDF_STATIC::$alias_num_page, TCPDF_STATIC::$alias_group_tot_pages, TCPDF_STATIC::$alias_group_num_page, TCPDF_STATIC::$alias_right_shift);
7831 $pnalias = array();
7834 }
7835 return $pnalias;
7836 }
static $alias_group_tot_pages
String alias for total number of pages in a single group.
Definition: tcpdf_static.php:76
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:
◆ getAllSpotColors()
| TCPDF::getAllSpotColors | ( | ) |
Returns the array of spot colors.
- Returns
- (array) Spot colors array.
- Since
- 6.0.038 (2013-09-30)
Definition at line 3699 of file tcpdf.php.
References $spot_colors.
◆ getAlpha()
| TCPDF::getAlpha | ( | ) |
◆ GetArrStringWidth()
| 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.
- Parameters
-
$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): - empty string: regular
- B: bold
- I: italic
- U: underline
- D: line through
- O: overline
$fontsize (float) Font size in points. The default value is the current size. $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
- Returns
- mixed int total string length or array of characted widths
- Since
- 2.4.000 (2008-03-06)
Definition at line 4048 of file tcpdf.php.
4048 {
4049 // store current values
4051 $prev_FontFamily = $this->FontFamily;
4052 $prev_FontStyle = $this->FontStyle;
4053 $prev_FontSizePt = $this->FontSizePt;
4055 }
4056 // convert UTF-8 array to Latin1 if required
4058 $sa = TCPDF_FONTS::UTF8ArrToLatin1Arr($sa);
4059 }
4061 $wa = array(); // array of characters widths
4062 foreach ($sa as $ck => $char) {
4063 // character width
4064 $cw = $this->GetCharWidth($char, isset($sa[($ck + 1)]));
4065 $wa[] = $cw;
4066 $w += $cw;
4067 }
4068 // restore previous values
4071 }
4072 if ($getarray) {
4073 return $wa;
4074 }
4076 }
static UTF8ArrToLatin1Arr($unicode)
Converts UTF-8 characters array to array of Latin1 characters array
Definition: tcpdf_fonts.php:1839
GetCharWidth($char, $notlast=true)
Returns the length of the char in user unit for the current font considering current stretching and s...
Definition: tcpdf.php:4087
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:
◆ getAutoPageBreak()
| TCPDF::getAutoPageBreak | ( | ) |
Return the auto-page-break mode (true or false).
- Returns
- boolean auto-page-break mode
- Since
- 5.9.088
Definition at line 2802 of file tcpdf.php.
References $AutoPageBreak.
◆ getBarcode()
| TCPDF::getBarcode | ( | ) |
◆ getBorderStartPosition()
|
protected |
Return the starting coordinates to draw an html border.
- Returns
- array containing top-left border coordinates
- Since
- 5.7.000 (2010-08-03)
Definition at line 19932 of file tcpdf.php.
19932 {
19933 if ($this->rtl) {
19934 $xmax = $this->lMargin;
19935 } else {
19936 $xmax = $this->w - $this->rMargin;
19937 }
19938 return array('page' => $this->page, 'column' => $this->current_column, 'x' => $this->x, 'y' => $this->y, 'xmax' => $xmax);
19939 }
◆ getBreakMargin()
| TCPDF::getBreakMargin | ( | $pagenum = '' | ) |
Returns the page break margin.
- Parameters
-
$pagenum (int) page number (empty = current page)
- Returns
- int page break margin.
- Since
- 1.5.2
- See also
- getPageDimensions()
Definition at line 2533 of file tcpdf.php.
2533 {
2534 if (empty($pagenum)) {
2536 }
2537 return $this->pagedim[$pagenum]['bm'];
2538 }
References $bMargin.
Referenced by MYPDF\Header().
Here is the caller graph for this function:
◆ getBuffer()
|
protected |
◆ getCellBorder()
|
protected |
Returns the code to draw the cell border.
- Parameters
-
$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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- Returns
- string containing cell border code
- See also
- SetLineStyle()
- Since
- 5.7.000 (2010-08-02)
Definition at line 5554 of file tcpdf.php.
5554 {
5555 $s = ''; // string to be returned
5556 if (empty($brd)) {
5557 return $s;
5558 }
5559 if ($brd == 1) {
5560 $brd = array('LRTB' => true);
5561 }
5562 // calculate coordinates for border
5564 if ($this->rtl) {
5567 } else {
5570 }
5573 $xeT = $xeL;
5574 $xeB = $xeR;
5575 $yeR = $yeT;
5576 $yeB = $yeL;
5577 if (is_string($brd)) {
5578 // convert string to array
5579 $slen = strlen($brd);
5580 $newbrd = array();
5581 for ($i = 0; $i < $slen; ++$i) {
5582 $newbrd[$brd[$i]] = array('cap' => 'square', 'join' => 'miter');
5583 }
5584 $brd = $newbrd;
5585 }
5586 if (isset($brd['mode'])) {
5587 $mode = $brd['mode'];
5588 unset($brd['mode']);
5589 } else {
5590 $mode = 'normal';
5591 }
5594 // apply border style
5595 $prev_style = $this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor.' ';
5597 }
5598 switch ($mode) {
5599 case 'ext': {
5600 $off = (($this->LineWidth / 2) * $k);
5601 $xL = $xeL - $off;
5602 $xR = $xeR + $off;
5603 $yT = $yeT + $off;
5604 $yL = $yeL - $off;
5605 $xT = $xL;
5606 $xB = $xR;
5607 $yR = $yT;
5608 $yB = $yL;
5611 break;
5612 }
5613 case 'int': {
5614 $off = ($this->LineWidth / 2) * $k;
5615 $xL = $xeL + $off;
5616 $xR = $xeR - $off;
5617 $yT = $yeT - $off;
5618 $yL = $yeL + $off;
5619 $xT = $xL;
5620 $xB = $xR;
5621 $yR = $yT;
5622 $yB = $yL;
5625 break;
5626 }
5627 case 'normal':
5628 default: {
5629 $xL = $xeL;
5630 $xT = $xeT;
5631 $xB = $xeB;
5632 $xR = $xeR;
5633 $yL = $yeL;
5634 $yT = $yeT;
5635 $yB = $yeB;
5636 $yR = $yeR;
5637 break;
5638 }
5639 }
5640 // draw borders by case
5643 } elseif (strlen($border) == 3) {
5649 $s .= 'S ';
5655 $s .= 'S ';
5661 $s .= 'S ';
5667 $s .= 'S ';
5668 }
5669 } elseif (strlen($border) == 2) {
5674 $s .= 'S ';
5679 $s .= 'S ';
5684 $s .= 'S ';
5689 $s .= 'S ';
5693 $s .= 'S ';
5696 $s .= 'S ';
5700 $s .= 'S ';
5703 $s .= 'S ';
5704 }
5705 } else { // strlen($border) == 1
5709 $s .= 'S ';
5713 $s .= 'S ';
5717 $s .= 'S ';
5721 $s .= 'S ';
5722 }
5723 }
5725 // reset border style to previous value
5726 $s .= "\n".$this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor."\n";
5727 }
5728 }
5729 return $s;
5730 }
References $border, $h, $k, $LineWidth, $style, $w, $x, $y, SetLineStyle(), and sprintf.
Referenced by getCellCode().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getCellCode()
|
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.
- Parameters
-
$w (float) Cell width. If 0, the cell extends up to the right margin. $h (float) Cell height. Default value: 0. $txt (string) String to print. Default value: empty string. $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$ln (int) Indicates where the current position should go after the call. Possible values are: - 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
$align (string) Allows to center or align the text. Possible values are: - L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
$fill (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: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
$ignore_min_height (boolean) if true ignore automatic minimum height value. $calign (string) cell vertical alignment relative to the specified Y value. Possible values are: - T : cell top
- C : center
- B : cell bottom
- A : font top
- L : font baseline
- D : font bottom
$valign (string) text vertical alignment inside the cell. Possible values are: - T : top
- M : middle
- B : bottom
- Returns
- string containing cell code
- Since
- 1.0
- See also
- Cell()
Definition at line 5063 of file tcpdf.php.
5063 {
5064 // replace 'NO-BREAK SPACE' (U+00A0) character with a simple space
5066 $prev_cell_margin = $this->cell_margin;
5067 $prev_cell_padding = $this->cell_padding;
5069 $rs = ''; //string to be returned
5071 if (!$ignore_min_height) {
5072 $min_cell_height = $this->getCellHeight($this->FontSize);
5074 $h = $min_cell_height;
5075 }
5076 }
5078 // check page for no-write regions and adapt page margins if necessary
5080 if ($this->rtl) {
5082 } else {
5084 }
5086 $prev_font_stretching = $this->font_stretching;
5087 $prev_font_spacing = $this->font_spacing;
5088 // cell vertical alignment
5089 switch ($calign) {
5090 case 'A': {
5091 // font top
5092 switch ($valign) {
5093 case 'T': {
5094 // top
5096 break;
5097 }
5098 case 'B': {
5099 // bottom
5101 break;
5102 }
5103 default:
5104 case 'C':
5105 case 'M': {
5106 // center
5108 break;
5109 }
5110 }
5111 break;
5112 }
5113 case 'L': {
5114 // font baseline
5115 switch ($valign) {
5116 case 'T': {
5117 // top
5119 break;
5120 }
5121 case 'B': {
5122 // bottom
5124 break;
5125 }
5126 default:
5127 case 'C':
5128 case 'M': {
5129 // center
5131 break;
5132 }
5133 }
5134 break;
5135 }
5136 case 'D': {
5137 // font bottom
5138 switch ($valign) {
5139 case 'T': {
5140 // top
5142 break;
5143 }
5144 case 'B': {
5145 // bottom
5147 break;
5148 }
5149 default:
5150 case 'C':
5151 case 'M': {
5152 // center
5154 break;
5155 }
5156 }
5157 break;
5158 }
5159 case 'B': {
5160 // cell bottom
5162 break;
5163 }
5164 case 'C':
5165 case 'M': {
5166 // cell center
5168 break;
5169 }
5170 default:
5171 case 'T': {
5172 // cell top
5173 break;
5174 }
5175 }
5176 // text vertical alignment
5177 switch ($valign) {
5178 case 'T': {
5179 // top
5181 break;
5182 }
5183 case 'B': {
5184 // bottom
5186 break;
5187 }
5188 default:
5189 case 'C':
5190 case 'M': {
5191 // center
5193 break;
5194 }
5195 }
5196 $basefonty = $yt + $this->FontAscent;
5198 if ($this->rtl) {
5200 } else {
5202 }
5203 }
5204 $s = '';
5205 // fill and borders
5207 // full border
5208 $border = 1;
5209 }
5211 if ($fill) {
5213 } else {
5214 $op = 'S';
5215 }
5216 if ($this->rtl) {
5218 } else {
5220 }
5222 }
5223 // draw borders
5226 $txt2 = $txt;
5227 if ($this->isunicode) {
5228 if (($this->CurrentFont['type'] == 'core') OR ($this->CurrentFont['type'] == 'TrueType') OR ($this->CurrentFont['type'] == 'Type1')) {
5229 $txt2 = TCPDF_FONTS::UTF8ToLatin1($txt2, $this->isunicode, $this->CurrentFont);
5230 } else {
5231 $unicode = TCPDF_FONTS::UTF8StringToArray($txt, $this->isunicode, $this->CurrentFont); // array of UTF-8 unicode values
5232 $unicode = TCPDF_FONTS::utf8Bidi($unicode, '', $this->tmprtl, $this->isunicode, $this->CurrentFont);
5233 // replace thai chars (if any)
5235 // number of chars
5236 $numchars = count($unicode);
5237 // po pla, for far, for fan
5238 $longtail = array(0x0e1b, 0x0e1d, 0x0e1f);
5239 // do chada, to patak
5240 $lowtail = array(0x0e0e, 0x0e0f);
5241 // mai hun arkad, sara i, sara ii, sara ue, sara uee
5242 $upvowel = array(0x0e31, 0x0e34, 0x0e35, 0x0e36, 0x0e37);
5243 // mai ek, mai tho, mai tri, mai chattawa, karan
5244 $tonemark = array(0x0e48, 0x0e49, 0x0e4a, 0x0e4b, 0x0e4c);
5245 // sara u, sara uu, pinthu
5246 $lowvowel = array(0x0e38, 0x0e39, 0x0e3a);
5247 $output = array();
5248 for ($i = 0; $i < $numchars; $i++) {
5249 if (($unicode[$i] >= 0x0e00) && ($unicode[$i] <= 0x0e5b)) {
5250 $ch0 = $unicode[$i];
5251 $ch1 = ($i > 0) ? $unicode[($i - 1)] : 0;
5252 $ch2 = ($i > 1) ? $unicode[($i - 2)] : 0;
5253 $chn = ($i < ($numchars - 1)) ? $unicode[($i + 1)] : 0;
5254 if (in_array($ch0, $tonemark)) {
5255 if ($chn == 0x0e33) {
5256 // sara um
5257 if (in_array($ch1, $longtail)) {
5258 // tonemark at upper left
5260 } else {
5261 // tonemark at upper right (normal position)
5262 $output[] = $ch0;
5263 }
5264 } elseif (in_array($ch1, $longtail) OR (in_array($ch2, $longtail) AND in_array($ch1, $lowvowel))) {
5265 // tonemark at lower left
5267 } elseif (in_array($ch1, $upvowel)) {
5268 if (in_array($ch2, $longtail)) {
5269 // tonemark at upper left
5271 } else {
5272 // tonemark at upper right (normal position)
5273 $output[] = $ch0;
5274 }
5275 } else {
5276 // tonemark at lower right
5278 }
5279 } elseif (($ch0 == 0x0e33) AND (in_array($ch1, $longtail) OR (in_array($ch2, $longtail) AND in_array($ch1, $tonemark)))) {
5280 // add lower left nikhahit and sara aa
5282 $output[] = 0xf711;
5283 $this->CurrentFont['subsetchars'][0xf711] = true;
5284 $output[] = 0x0e32;
5285 $this->CurrentFont['subsetchars'][0x0e32] = true;
5286 } else {
5287 $output[] = $ch0;
5288 }
5289 } elseif (in_array($ch1, $longtail)) {
5290 if ($ch0 == 0x0e31) {
5291 // lower left mai hun arkad
5293 } elseif (in_array($ch0, $upvowel)) {
5294 // lower left
5296 } elseif ($ch0 == 0x0e47) {
5297 // lower left mai tai koo
5299 } else {
5300 // normal character
5301 $output[] = $ch0;
5302 }
5303 } elseif (in_array($ch1, $lowtail) AND in_array($ch0, $lowvowel)) {
5304 // lower vowel
5306 } elseif (($ch0 == 0x0e0d) AND in_array($chn, $lowvowel)) {
5307 // yo ying without lower part
5309 } elseif (($ch0 == 0x0e10) AND in_array($chn, $lowvowel)) {
5310 // tho santan without lower part
5312 } else {
5313 $output[] = $ch0;
5314 }
5315 } else {
5316 // non-thai character
5317 $output[] = $unicode[$i];
5318 }
5319 }
5320 $unicode = $output;
5321 // update font subsetchars
5322 $this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
5323 } // end of K_THAI_TOPCHARS
5325 }
5326 }
5327 $txt2 = TCPDF_STATIC::_escape($txt2);
5328 // get current text width (considering general font stretching and spacing)
5330 $width = $txwidth;
5331 // check for stretch mode
5332 if ($stretch > 0) {
5333 // calculate ratio between cell width and text width
5334 if ($width <= 0) {
5335 $ratio = 1;
5336 } else {
5338 }
5339 // check if stretching is required
5340 if (($ratio < 1) OR (($ratio > 1) AND (($stretch % 2) == 0))) {
5341 // the text will be stretched to fit cell width
5342 if ($stretch > 2) {
5343 // set new character spacing
5344 $this->font_spacing += ($w - $this->cell_padding['L'] - $this->cell_padding['R'] - $width) / (max(($this->GetNumChars($txt) - 1), 1) * ($this->font_stretching / 100));
5345 } else {
5346 // set new horizontal stretching
5347 $this->font_stretching *= $ratio;
5348 }
5349 // recalculate text width (the text fills the entire cell)
5351 // reset alignment
5352 $align = '';
5353 }
5354 }
5355 if ($this->font_stretching != 100) {
5356 // apply font stretching
5358 }
5359 if ($this->font_spacing != 0) {
5360 // increase/decrease font spacing
5362 }
5363 if ($this->ColorFlag AND ($this->textrendermode < 4)) {
5364 $s .= 'q '.$this->TextColor.' ';
5365 }
5366 // rendering mode
5367 $s .= sprintf('BT %d Tr %F w ET ', $this->textrendermode, ($this->textstrokewidth * $this->k));
5368 // count number of spaces
5369 $ns = substr_count($txt, chr(32));
5370 // Justification
5371 $spacewidth = 0;
5372 if (($align == 'J') AND ($ns > 0)) {
5374 // get string width without spaces
5376 // calculate average space width
5377 $spacewidth = -1000 * ($w - $width - $this->cell_padding['L'] - $this->cell_padding['R']) / ($ns?$ns:1) / ($this->FontSize?$this->FontSize:1);
5378 if ($this->font_stretching != 100) {
5379 // word spacing is affected by stretching
5380 $spacewidth /= ($this->font_stretching / 100);
5381 }
5382 // set word position to be used with TJ operator
5384 $unicode_justification = true;
5385 } else {
5386 // get string width
5387 $width = $txwidth;
5388 // new space width
5389 $spacewidth = (($w - $width - $this->cell_padding['L'] - $this->cell_padding['R']) / ($ns?$ns:1)) * $this->k;
5390 if ($this->font_stretching != 100) {
5391 // word spacing (Tw) is affected by stretching
5392 $spacewidth /= ($this->font_stretching / 100);
5393 }
5394 // set word spacing
5396 }
5398 }
5399 // replace carriage return characters
5400 $txt2 = str_replace("\r", ' ', $txt2);
5401 switch ($align) {
5402 case 'C': {
5403 $dx = ($w - $width) / 2;
5404 break;
5405 }
5406 case 'R': {
5407 if ($this->rtl) {
5408 $dx = $this->cell_padding['R'];
5409 } else {
5411 }
5412 break;
5413 }
5414 case 'L': {
5415 if ($this->rtl) {
5417 } else {
5418 $dx = $this->cell_padding['L'];
5419 }
5420 break;
5421 }
5422 case 'J':
5423 default: {
5424 if ($this->rtl) {
5425 $dx = $this->cell_padding['R'];
5426 } else {
5427 $dx = $this->cell_padding['L'];
5428 }
5429 break;
5430 }
5431 }
5432 if ($this->rtl) {
5433 $xdx = $x - $dx - $width;
5434 } else {
5435 $xdx = $x + $dx;
5436 }
5437 $xdk = $xdx * $k;
5438 // print text
5440 if (isset($uniblock)) {
5441 // print overlapping characters as separate string
5442 $xshift = 0; // horizontal shift
5445 foreach ($uniblock as $uk => $uniarr) {
5446 if (($uk % 2) == 0) {
5447 // x space to skip
5448 if ($spacewidth != 0) {
5449 // justification shift
5450 $xshift += (count(array_keys($uniarr, 32)) * $spw);
5451 }
5453 } else {
5454 // character to print
5456 $topchr = TCPDF_STATIC::_escape($topchr);
5458 }
5459 }
5460 }
5461 if ($this->underline) {
5462 $s .= ' '.$this->_dounderlinew($xdx, $basefonty, $width);
5463 }
5464 if ($this->linethrough) {
5465 $s .= ' '.$this->_dolinethroughw($xdx, $basefonty, $width);
5466 }
5467 if ($this->overline) {
5468 $s .= ' '.$this->_dooverlinew($xdx, $basefonty, $width);
5469 }
5470 if ($this->ColorFlag AND ($this->textrendermode < 4)) {
5471 $s .= ' Q';
5472 }
5473 if ($link) {
5474 $this->Link($xdx, $yt, $width, ($this->FontAscent + $this->FontDescent), $link, $ns);
5475 }
5476 }
5477 // output cell
5478 if ($s) {
5479 // output cell
5480 $rs .= $s;
5481 if ($this->font_spacing != 0) {
5482 // reset font spacing mode
5483 $rs .= ' BT 0 Tc ET';
5484 }
5485 if ($this->font_stretching != 100) {
5486 // reset font stretching mode
5487 $rs .= ' BT 100 Tz ET';
5488 }
5489 }
5490 // reset word spacing
5492 $rs .= ' BT 0 Tw ET';
5493 }
5494 // reset stretching and spacing
5495 $this->font_stretching = $prev_font_stretching;
5496 $this->font_spacing = $prev_font_spacing;
5497 $this->lasth = $h;
5498 if ($ln > 0) {
5499 //Go to the beginning of the next line
5501 if ($ln == 1) {
5502 if ($this->rtl) {
5503 $this->x = $this->w - $this->rMargin;
5504 } else {
5505 $this->x = $this->lMargin;
5506 }
5507 }
5508 } else {
5509 // go left or right by case
5510 if ($this->rtl) {
5512 } else {
5514 }
5515 }
5516 $gstyles = ''.$this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor.' '.$this->FillColor."\n";
5517 $rs = $gstyles.$rs;
5518 $this->cell_padding = $prev_cell_padding;
5519 $this->cell_margin = $prev_cell_margin;
5520 return $rs;
5521 }
static UTF8ToLatin1($str, $isunicode=true, &$currentfont)
Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.
Definition: tcpdf_fonts.php:2019
static arrUTF8ToUTF16BE($unicode, $setbom=false)
Converts array of UTF-8 characters to UTF16-BE string.
Definition: tcpdf_fonts.php:1744
static removeSHY($txt='', $unicode=true)
Removes SHY characters from text.
Definition: tcpdf_static.php:193
getCellBorder($x, $y, $w, $h, $brd)
Returns the code to draw the cell border.
Definition: tcpdf.php:5554
$font_spacing
Increases or decreases the space between characters in a text by the specified amount (tracking).
Definition: tcpdf.php:1547
isCharDefined($char, $font='', $style='')
Return true in the character is present in the specified font.
Definition: tcpdf.php:4608
$FontDescent
Current font descent (distance between font bottom and baseline).
Definition: tcpdf.php:386
replaceChar($oldchar, $newchar)
Replace a char if is defined on the current font.
Definition: tcpdf.php:5531
Link($x, $y, $w, $h, $link, $spaces=0)
Puts a link on a rectangular area of the page.
Definition: tcpdf.php:4728
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.
Definition: tcpdf.php:4048
if(!is_dir( $entity_dir)) exit("Fatal Error ([A-Za-z0-9]+)\s+" &#(? foreach( $entity_files as $file) $output
Definition: generate-entity-file.php:67
const K_THAI_TOPCHARS
Set to true to enable the special procedure used to avoid the overlappind of symbols on Thai language...
Definition: tcpdf_config.php:207
References $border, $cell_margin, $cell_padding, $font_spacing, $font_stretching, $FontAscent, $FontDescent, $FontSize, $h, $k, $lMargin, $output, $rMargin, $txt, $w, $x, $y, TCPDF_STATIC\_escape(), adjustCellPadding(), TCPDF_FONTS\arrUTF8ToUTF16BE(), checkPageRegions(), defined, TCPDF_STATIC\empty_string(), GetArrStringWidth(), getCellBorder(), getCellHeight(), GetNumChars(), GetStringWidth(), isCharDefined(), isUnicodeFont(), K_THAI_TOPCHARS, Link(), TCPDF_STATIC\removeSHY(), replaceChar(), setFontSubBuffer(), sprintf, 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:
◆ getCellHeight()
| TCPDF::getCellHeight | ( | $fontsize, | |
$padding = TRUE |
|||
| ) |
Return the cell height.
- Parameters
-
$fontsize (int) Font size in internal units $padding (boolean) If true add cell padding
Definition at line 2427 of file tcpdf.php.
2427 {
2428 $height = ($fontsize * $this->cell_height_ratio);
2429 if ($padding) {
2430 $height += ($this->cell_padding['T'] + $this->cell_padding['B']);
2431 }
2432 return round($height, 6);
2433 }
References $cell_height_ratio.
Referenced by Cell(), getCellCode(), getStringHeight(), Header(), openHTMLTagHandler(), resetLastH(), Write(), write1DBarcode(), and writeHTML().
Here is the caller graph for this function:
◆ getCellHeightRatio()
| TCPDF::getCellHeightRatio | ( | ) |
return the height of cell repect font height.
- Since
- 4.0.012 (2008-07-24)
Definition at line 13983 of file tcpdf.php.
References $cell_height_ratio.
◆ getCellMargins()
| TCPDF::getCellMargins | ( | ) |
Get the internal Cell margin array.
- Returns
- array of margin values
- Since
- 5.9.000 (2010-10-03)
- See also
- setCellMargins()
Definition at line 2704 of file tcpdf.php.
References $cell_margin.
◆ getCellPaddings()
| TCPDF::getCellPaddings | ( | ) |
Get the internal Cell padding array.
- Returns
- array of padding values
- Since
- 5.9.000 (2010-10-03)
- See also
- setCellPaddings(), SetCellPadding()
Definition at line 2668 of file tcpdf.php.
References $cell_padding.
◆ getCharBBox()
| TCPDF::getCharBBox | ( | $char | ) |
Returns the glyph bounding box of the specified character in the current font in user units.
- Parameters
-
$char (int) Input character code.
- Returns
- mixed array(xMin, yMin, xMax, yMax) or FALSE if not defined.
- Since
- 5.9.186 (2012-09-13)
Definition at line 4544 of file tcpdf.php.
4544 {
4545 $c = intval($char);
4546 if (isset($this->CurrentFont['cw'][$c])) {
4547 // glyph is defined ... use zero width & height for glyphs without outlines
4548 $result = array(0,0,0,0);
4549 if (isset($this->CurrentFont['cbbox'][$c])) {
4551 }
4553 }
4554 return false;
4555 }
References $result.
◆ GetCharWidth()
| TCPDF::GetCharWidth | ( | $char, | |
$notlast = true |
|||
| ) |
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
- Parameters
-
$char (int) The char code whose length is to be returned $notlast (boolean) If false ignore the font-spacing.
- Returns
- float char width
- Since
- 2.4.000 (2008-03-06)
Definition at line 4087 of file tcpdf.php.
4087 {
4088 // get raw width
4089 $chw = $this->getRawCharWidth($char);
4090 if (($this->font_spacing < 0) OR (($this->font_spacing > 0) AND $notlast)) {
4091 // increase/decrease font spacing
4092 $chw += $this->font_spacing;
4093 }
4094 if ($this->font_stretching != 100) {
4095 // fixed stretching mode
4096 $chw *= ($this->font_stretching / 100);
4097 }
4098 return $chw;
4099 }
getRawCharWidth($char)
Returns the length of the char in user unit for the current font.
Definition: tcpdf.php:4109
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:
◆ getColumn()
| TCPDF::getColumn | ( | ) |
Return the current column number.
- Returns
- int current column number
- Since
- 5.5.011 (2010-07-08)
◆ getCSSBorderDashStyle()
|
protected |
Returns the border dash style from CSS property.
- Parameters
-
$style (string) border style to convert
- Returns
- int sash style (return -1 in case of none or hidden border)
- Since
- 5.7.000 (2010-08-02)
Definition at line 15863 of file tcpdf.php.
15863 {
15865 case 'none':
15866 case 'hidden': {
15867 $dash = -1;
15868 break;
15869 }
15870 case 'dotted': {
15871 $dash = 1;
15872 break;
15873 }
15874 case 'dashed': {
15875 $dash = 3;
15876 break;
15877 }
15878 case 'double':
15879 case 'groove':
15880 case 'ridge':
15881 case 'inset':
15882 case 'outset':
15883 case 'solid':
15884 default: {
15885 $dash = 0;
15886 break;
15887 }
15888 }
15889 return $dash;
15890 }
References $style.
Referenced by getCSSBorderStyle(), and getHtmlDomArray().
Here is the caller graph for this function:
◆ getCSSBorderMargin()
| TCPDF::getCSSBorderMargin | ( | $cssbspace, | |
$width = 0 |
|||
| ) |
Get the border-spacing from CSS attribute.
- Parameters
-
$cssbspace (string) border-spacing CSS properties $width (float) width of the containing element
- Returns
- array of border spacings
- Since
- 5.9.010 (2010-10-27)
Definition at line 16058 of file tcpdf.php.
16058 {
16060 $border_spacing = array(); // value to be returned
16062 case 2: {
16065 break;
16066 }
16067 case 1: {
16070 break;
16071 }
16072 default: {
16073 return array('H' => 0, 'V' => 0);
16074 }
16075 }
16076 if ($width == 0) {
16077 $width = $this->w - $this->lMargin - $this->rMargin;
16078 }
16081 return $border_spacing;
16082 }
References $rMargin, $space, and getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getCSSBorderStyle()
|
protected |
Returns the border style array from CSS border properties.
- Parameters
-
$cssborder (string) border properties
- Returns
- array containing border properties
- Since
- 5.7.000 (2010-08-02)
Definition at line 15899 of file tcpdf.php.
15899 {
15900 $bprop = preg_split('/[\s]+/', trim($cssborder));
15902 switch (count($bprop)) {
15903 case 3: {
15904 $width = $bprop[0];
15905 $style = $bprop[1];
15906 $color = $bprop[2];
15907 break;
15908 }
15909 case 2: {
15910 $width = 'medium';
15911 $style = $bprop[0];
15912 $color = $bprop[1];
15913 break;
15914 }
15915 case 1: {
15916 $width = 'medium';
15917 $style = $bprop[0];
15918 $color = 'black';
15919 break;
15920 }
15921 default: {
15922 $width = 'medium';
15924 $color = 'black';
15925 break;
15926 }
15927 }
15929 return array();
15930 }
15935 return array();
15936 }
15940 }
static convertHTMLColorToDec($hcolor, &$spotc, $defcol=array('R'=>128, 'G'=>128, 'B'=>128))
Returns an array (RGB or CMYK) from an html color name, or a six-digit (i.e.
Definition: tcpdf_colors.php:273
getCSSBorderDashStyle($style)
Returns the border dash style from CSS property.
Definition: tcpdf.php:15863
References $border, $style, 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:
◆ getCSSBorderWidth()
|
protected |
Returns the border width from CSS property.
- Parameters
-
$width (string) border width
- Returns
- int with in user units
- Since
- 5.7.000 (2010-08-02)
Definition at line 15843 of file tcpdf.php.
15843 {
15844 if ($width == 'thin') {
15845 $width = (2 / $this->k);
15846 } elseif ($width == 'medium') {
15847 $width = (4 / $this->k);
15848 } elseif ($width == 'thick') {
15849 $width = (6 / $this->k);
15850 } else {
15852 }
15853 return $width;
15854 }
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:
◆ getCSSFontSpacing()
|
protected |
Returns the letter-spacing value from CSS value.
- Parameters
-
$spacing (string) letter-spacing value $parent (float) font spacing (tracking) value of the parent element
- Returns
- float quantity to increases or decreases the space between characters in a text.
- Since
- 5.9.000 (2010-10-02)
Definition at line 16092 of file tcpdf.php.
16092 {
16093 $val = 0; // value to be returned
16094 $spacing = trim($spacing);
16095 switch ($spacing) {
16096 case 'normal': {
16097 $val = 0;
16098 break;
16099 }
16100 case 'inherit': {
16101 if ($parent == 'normal') {
16102 $val = 0;
16103 } else {
16104 $val = $parent;
16105 }
16106 break;
16107 }
16108 default: {
16110 }
16111 }
16112 return $val;
16113 }
References getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getCSSFontStretching()
|
protected |
Returns the percentage of font stretching from CSS value.
- Parameters
-
$stretch (string) stretch mode $parent (float) stretch value of the parent element
- Returns
- float font stretching percentage
- Since
- 5.9.000 (2010-10-02)
Definition at line 16123 of file tcpdf.php.
16123 {
16124 $val = 100; // value to be returned
16125 $stretch = trim($stretch);
16126 switch ($stretch) {
16127 case 'ultra-condensed': {
16128 $val = 40;
16129 break;
16130 }
16131 case 'extra-condensed': {
16132 $val = 55;
16133 break;
16134 }
16135 case 'condensed': {
16136 $val = 70;
16137 break;
16138 }
16139 case 'semi-condensed': {
16140 $val = 85;
16141 break;
16142 }
16143 case 'normal': {
16144 $val = 100;
16145 break;
16146 }
16147 case 'semi-expanded': {
16148 $val = 115;
16149 break;
16150 }
16151 case 'expanded': {
16152 $val = 130;
16153 break;
16154 }
16155 case 'extra-expanded': {
16156 $val = 145;
16157 break;
16158 }
16159 case 'ultra-expanded': {
16160 $val = 160;
16161 break;
16162 }
16163 case 'wider': {
16164 $val = ($parent + 10);
16165 break;
16166 }
16167 case 'narrower': {
16168 $val = ($parent - 10);
16169 break;
16170 }
16171 case 'inherit': {
16172 if ($parent == 'normal') {
16173 $val = 100;
16174 } else {
16175 $val = $parent;
16176 }
16177 break;
16178 }
16179 default: {
16181 }
16182 }
16183 return $val;
16184 }
References getHTMLUnitToUnits().
Referenced by getHtmlDomArray().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getCSSMargin()
| TCPDF::getCSSMargin | ( | $cssmargin, | |
$width = 0 |
|||
| ) |
Get the internal Cell margin from CSS attribute.
- Parameters
-
$cssmargin (string) margin properties $width (float) width of the containing element
- Returns
- array of cell margins
- Since
- 5.9.000 (2010-10-04)
Definition at line 16004 of file tcpdf.php.
16004 {
16005 $margin = preg_split('/[\s]+/', trim($cssmargin));
16007 switch (count($margin)) {
16008 case 4: {
16013 break;
16014 }
16015 case 3: {
16020 break;
16021 }
16022 case 2: {
16027 break;
16028 }
16029 case 1: {
16034 break;
16035 }
16036 default: {
16038 }
16039 }
16040 if ($width == 0) {
16041 $width = $this->w - $this->lMargin - $this->rMargin;
16042 }
16043 $cell_margin['T'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['T']), $width, 'px', false);
16044 $cell_margin['R'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['R']), $width, 'px', false);
16045 $cell_margin['B'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['B']), $width, 'px', false);
16046 $cell_margin['L'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['L']), $width, 'px', false);
16048 }
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:
◆ getCSSPadding()
| TCPDF::getCSSPadding | ( | $csspadding, | |
$width = 0 |
|||
| ) |
Get the internal Cell padding from CSS attribute.
- Parameters
-
$csspadding (string) padding properties $width (float) width of the containing element
- Returns
- array of cell paddings
- Since
- 5.9.000 (2010-10-04)
Definition at line 15950 of file tcpdf.php.
15950 {
15951 $padding = preg_split('/[\s]+/', trim($csspadding));
15953 switch (count($padding)) {
15954 case 4: {
15959 break;
15960 }
15961 case 3: {
15966 break;
15967 }
15968 case 2: {
15973 break;
15974 }
15975 case 1: {
15980 break;
15981 }
15982 default: {
15984 }
15985 }
15986 if ($width == 0) {
15987 $width = $this->w - $this->lMargin - $this->rMargin;
15988 }
15994 }
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:
◆ getDestination()
| TCPDF::getDestination | ( | ) |
◆ getDocCreationTimestamp()
| TCPDF::getDocCreationTimestamp | ( | ) |
Returns document creation timestamp in seconds.
- Returns
- (int) Creation timestamp in seconds.
- Since
- 5.9.152 (2012-03-23)
Definition at line 10208 of file tcpdf.php.
References $doc_creation_timestamp.
◆ getDocModificationTimestamp()
| TCPDF::getDocModificationTimestamp | ( | ) |
Returns document modification timestamp in seconds.
- Returns
- (int) Modfication timestamp in seconds.
- Since
- 5.9.152 (2012-03-23)
Definition at line 10218 of file tcpdf.php.
10218 {
10220 }
References $doc_modification_timestamp.
◆ getFontAscent()
| TCPDF::getFontAscent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
Return the font ascent value.
- Parameters
-
$font (string) font name $style (string) font style $size (float) The size (in points)
- Returns
- int font ascent
- Since
- 4.9.003 (2010-03-30)
Definition at line 4588 of file tcpdf.php.
4588 {
4591 if (isset($fontinfo['desc']['Ascent']) AND ($fontinfo['desc']['Ascent'] > 0)) {
4593 } else {
4594 $ascent = 1.219 * 0.76 * $size;
4595 }
4596 return ($ascent / $this->k);
4597 }
References $size, $style, AddFont(), and getFontBuffer().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getFontBBox()
| TCPDF::getFontBBox | ( | ) |
Returns the bounding box of the current font in user units.
- Returns
- array
- Since
- 5.9.152 (2012-03-23)
Definition at line 4495 of file tcpdf.php.
4495 {
4496 $fbbox = array();
4497 if (isset($this->CurrentFont['desc']['FontBBox'])) {
4498 $tmpbbox = explode(' ', substr($this->CurrentFont['desc']['FontBBox'], 1, -1));
4499 $fbbox = array_map(array($this,'getAbsFontMeasure'), $tmpbbox);
4500 } else {
4501 // Find max width
4502 if (isset($this->CurrentFont['desc']['MaxWidth'])) {
4504 } else {
4505 $maxw = 0;
4506 if (isset($this->CurrentFont['desc']['MissingWidth'])) {
4507 $maxw = max($maxw, $this->CurrentFont['desc']['MissingWidth']);
4508 }
4509 if (isset($this->CurrentFont['desc']['AvgWidth'])) {
4510 $maxw = max($maxw, $this->CurrentFont['desc']['AvgWidth']);
4511 }
4512 if (isset($this->CurrentFont['dw'])) {
4513 $maxw = max($maxw, $this->CurrentFont['dw']);
4514 }
4516 $maxw = max($maxw, $w);
4517 }
4518 if ($maxw == 0) {
4519 $maxw = 600;
4520 }
4521 $maxw = $this->getAbsFontMeasure($maxw);
4522 }
4523 $fbbox = array(0, (0 - $this->FontDescent), $maxw, $this->FontAscent);
4524 }
4525 return $fbbox;
4526 }
References $w, and getAbsFontMeasure().
Here is the call graph for this function:
◆ getFontBuffer()
|
protected |
Get font buffer content.
- Parameters
-
$font (string) font key
- Returns
- string font buffer content or false in case of error
- Since
- 4.5.000 (2009-01-02)
Definition at line 20836 of file tcpdf.php.
20836 {
20837 if (isset($this->fonts[$font])) {
20838 return $this->fonts[$font];
20839 }
20840 return false;
20841 }
Referenced by _putcatalog(), _putfonts(), _putresourcedict(), AddFont(), getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars(), and SetFont().
Here is the caller graph for this function:
◆ getFontDescent()
| TCPDF::getFontDescent | ( | $font, | |
$style = '', |
|||
$size = 0 |
|||
| ) |
Return the font descent value.
- Parameters
-
$font (string) font name $style (string) font style $size (float) The size (in points)
- Returns
- int font descent
- Since
- 4.9.003 (2010-03-30)
Definition at line 4567 of file tcpdf.php.
4567 {
4570 if (isset($fontinfo['desc']['Descent']) AND ($fontinfo['desc']['Descent'] <= 0)) {
4572 } else {
4573 $descent = (1.219 * 0.24 * $size);
4574 }
4575 return ($descent / $this->k);
4576 }
References $size, $style, AddFont(), and getFontBuffer().
Referenced by openHTMLTagHandler(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getFontFamily()
| TCPDF::getFontFamily | ( | ) |
Returns the current font family name.
- Returns
- string current font family name
- Since
- 4.3.008 (2008-12-05)
Definition at line 15806 of file tcpdf.php.
References $FontFamily.
◆ getFontFamilyName()
| TCPDF::getFontFamilyName | ( | $fontfamily | ) |
Return normalized font name.
- Parameters
-
$fontfamily (string) property string containing font family names
- Returns
- string normalized font name
- Since
- 5.8.004 (2010-08-17)
Definition at line 22196 of file tcpdf.php.
22196 {
22197 // remove spaces and symbols
22198 $fontfamily = preg_replace('/[^a-z0-9_\,]/', '', strtolower($fontfamily));
22199 // extract all font names
22200 $fontslist = preg_split('/[,]/', $fontfamily);
22201 // find first valid font name
22202 foreach ($fontslist as $font) {
22203 // replace font variations
22204 $font = preg_replace('/regular$/', '', $font);
22205 $font = preg_replace('/italic$/', 'I', $font);
22206 $font = preg_replace('/oblique$/', 'I', $font);
22207 $font = preg_replace('/bold([I]?)$/', 'B\\1', $font);
22208 // replace common family names and core fonts
22209 $pattern = array();
22210 $replacement = array();
22211 $pattern[] = '/^serif|^cursive|^fantasy|^timesnewroman/';
22212 $replacement[] = 'times';
22213 $pattern[] = '/^sansserif/';
22214 $replacement[] = 'helvetica';
22215 $pattern[] = '/^monospace/';
22216 $replacement[] = 'courier';
22217 $font = preg_replace($pattern, $replacement, $font);
22218 if (in_array(strtolower($font), $this->fontlist) OR in_array($font, $this->fontkeys)) {
22219 return $font;
22220 }
22221 }
22222 // return current font as default
22223 return $this->CurrentFont['fontkey'];
22224 }
Referenced by getHtmlDomArray().
Here is the caller graph for this function:
◆ getFontSize()
| TCPDF::getFontSize | ( | ) |
◆ getFontSizePt()
| TCPDF::getFontSizePt | ( | ) |
Returns the current font size in points unit.
- Returns
- current font size in points unit
- Since
- 3.2.000 (2008-06-23)
Definition at line 15796 of file tcpdf.php.
References $FontSizePt.
◆ getFontsList()
|
protected |
Fill the list of available fonts ($this->fontlist).
- Since
- 4.0.013 (2008-07-28)
Definition at line 4147 of file tcpdf.php.
4147 {
4152 }
4153 }
4154 closedir($fontsdir);
4155 }
4156 }
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:
◆ getFontSpacing()
| TCPDF::getFontSpacing | ( | ) |
Get the amount to increase or decrease the space between characters in a text.
- Returns
- int font spacing (tracking) value
- Since
- 5.9.000 (2010-09-29)
◆ getFontStretching()
| TCPDF::getFontStretching | ( | ) |
Get the percentage of character stretching.
- Returns
- float stretching value
- Since
- 5.9.000 (2010-09-29)
◆ getFontStyle()
| TCPDF::getFontStyle | ( | ) |
Returns the current font style.
- Returns
- string current font style
- Since
- 4.3.008 (2008-12-05)
Definition at line 15816 of file tcpdf.php.
References $FontStyle.
◆ getFontSubsetting()
| TCPDF::getFontSubsetting | ( | ) |
Return the default option for font subsetting.
- Returns
- boolean default font subsetting state.
- Since
- 5.3.002 (2010-06-07)
◆ getFooterFont()
| TCPDF::getFooterFont | ( | ) |
Get Footer font.
- Returns
- array() Array describing the basic font parameters: (family, style, size).
- Since
- 4.0.012 (2008-07-24)
Definition at line 10332 of file tcpdf.php.
10332 {
10334 }
References $footer_font.
◆ getFooterMargin()
| TCPDF::getFooterMargin | ( | ) |
Returns footer margin in user units.
- Returns
- float
- Since
- 4.0.012 (2008-07-24)
Definition at line 3331 of file tcpdf.php.
3331 {
3333 }
References $footer_margin.
◆ getFormDefaultProp()
| TCPDF::getFormDefaultProp | ( | ) |
Return the default properties for form fields.
- Returns
- array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
- Since
- 4.8.000 (2009-09-06)
Definition at line 12627 of file tcpdf.php.
References $default_form_prop.
Referenced by Button(), RadioButton(), and TextField().
Here is the caller graph for this function:
◆ getGDgamma()
|
protected |
Get the GD-corrected PNG gamma value from alpha color.
- Parameters
-
$img (int) GD image Resource ID. $c (int) alpha color
- Since
- 4.3.007 (2008-12-04)
Definition at line 7342 of file tcpdf.php.
7342 {
7343 if (!isset($this->gdgammacache['#'.$c])) {
7344 $colors = imagecolorsforindex($img, $c);
7345 // GD alpha is only 7 bit (0 -> 127)
7346 $this->gdgammacache['#'.$c] = (((127 - $colors['alpha']) / 127) * 255);
7347 // correct gamma
7348 $this->gdgammacache['#'.$c] = (pow(($this->gdgammacache['#'.$c] / 255), 2.2) * 255);
7349 // store the latest values on cache to improve performances
7350 if (count($this->gdgammacache) > 8) {
7351 // remove one element from the cache array
7352 array_shift($this->gdgammacache);
7353 }
7354 }
7355 return $this->gdgammacache['#'.$c];
7356 }
References $img.
Referenced by ImagePngAlpha().
Here is the caller graph for this function:
◆ getGraphicVars()
|
protected |
Returns current graphic variables as array.
- Returns
- array of graphic variables
- Since
- 4.2.010 (2008-11-14)
Definition at line 20545 of file tcpdf.php.
20545 {
20546 $grapvars = array(
20547 'FontFamily' => $this->FontFamily,
20548 'FontStyle' => $this->FontStyle,
20549 'FontSizePt' => $this->FontSizePt,
20550 'rMargin' => $this->rMargin,
20551 'lMargin' => $this->lMargin,
20552 'cell_padding' => $this->cell_padding,
20553 'cell_margin' => $this->cell_margin,
20554 'LineWidth' => $this->LineWidth,
20555 'linestyleWidth' => $this->linestyleWidth,
20556 'linestyleCap' => $this->linestyleCap,
20557 'linestyleJoin' => $this->linestyleJoin,
20558 'linestyleDash' => $this->linestyleDash,
20559 'textrendermode' => $this->textrendermode,
20560 'textstrokewidth' => $this->textstrokewidth,
20561 'DrawColor' => $this->DrawColor,
20562 'FillColor' => $this->FillColor,
20563 'TextColor' => $this->TextColor,
20564 'ColorFlag' => $this->ColorFlag,
20565 'bgcolor' => $this->bgcolor,
20566 'fgcolor' => $this->fgcolor,
20567 'htmlvspace' => $this->htmlvspace,
20568 'listindent' => $this->listindent,
20569 'listindentlevel' => $this->listindentlevel,
20570 'listnum' => $this->listnum,
20571 'listordered' => $this->listordered,
20572 'listcount' => $this->listcount,
20573 'lispacer' => $this->lispacer,
20574 'cell_height_ratio' => $this->cell_height_ratio,
20575 'font_stretching' => $this->font_stretching,
20576 'font_spacing' => $this->font_spacing,
20577 'alpha' => $this->alpha,
20578 // extended
20579 'lasth' => $this->lasth,
20580 'tMargin' => $this->tMargin,
20581 'bMargin' => $this->bMargin,
20582 'AutoPageBreak' => $this->AutoPageBreak,
20583 'PageBreakTrigger' => $this->PageBreakTrigger,
20584 'x' => $this->x,
20585 'y' => $this->y,
20586 'w' => $this->w,
20587 'h' => $this->h,
20588 'wPt' => $this->wPt,
20589 'hPt' => $this->hPt,
20590 'fwPt' => $this->fwPt,
20591 'fhPt' => $this->fhPt,
20592 'page' => $this->page,
20593 'current_column' => $this->current_column,
20594 'num_columns' => $this->num_columns
20595 );
20596 return $grapvars;
20597 }
Referenced by __construct(), Close(), openHTMLTagHandler(), setFooter(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the caller graph for this function:
◆ getGroupPageNo()
| TCPDF::getGroupPageNo | ( | ) |
Return the current page in the group.
- Returns
- current page in the group
- Since
- 3.0.000 (2008-03-27)
Definition at line 13668 of file tcpdf.php.
References $currpagegroup.
Referenced by getGroupPageNoFormatted().
Here is the caller graph for this function:
◆ getGroupPageNoFormatted()
| TCPDF::getGroupPageNoFormatted | ( | ) |
Returns the current group page number formatted as a string.
- Since
- 4.3.003 (2008-11-18)
- See also
- PaneNo(), formatPageNumber()
Definition at line 13678 of file tcpdf.php.
References TCPDF_STATIC\formatPageNumber(), and getGroupPageNo().
Here is the call graph for this function:
◆ getHashForTCPDFtagParams()
|
protected |
Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance.
- Parameters
-
$data (string) serialized data
- Returns
- string static
Definition at line 17051 of file tcpdf.php.
References $data.
Referenced by serializeTCPDFtagParameters(), and unserializeTCPDFtagParameters().
Here is the caller graph for this function:
◆ getHeaderData()
| TCPDF::getHeaderData | ( | ) |
Returns header data:
- $ret['logo'] = logo image
- $ret['logo_width'] = width of the image logo in user units
- $ret['title'] = header title
- $ret['string'] = header description string
- Returns
- array()
- Since
- 4.0.012 (2008-07-24)
Definition at line 3284 of file tcpdf.php.
3284 {
3285 $ret = array();
3293 }
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:
◆ getHeaderFont()
| TCPDF::getHeaderFont | ( | ) |
Get header font.
- Returns
- array() Array describing the basic font parameters: (family, style, size).
- Since
- 4.0.012 (2008-07-24)
Definition at line 10312 of file tcpdf.php.
10312 {
10314 }
References $header_font.
Referenced by Header().
Here is the caller graph for this function:
◆ getHeaderMargin()
| TCPDF::getHeaderMargin | ( | ) |
Returns header margin in user units.
- Returns
- float
- Since
- 4.0.012 (2008-07-24)
Definition at line 3311 of file tcpdf.php.
3311 {
3313 }
References $header_margin.
◆ getHtmlDomArray()
|
protected |
Returns the HTML DOM array.
- Parameters
-
$html (string) html code
- Returns
- array
- Since
- 3.2.000 (2008-06-20)
Definition at line 16249 of file tcpdf.php.
16249 {
16250 // array of CSS styles ( selector => properties).
16251 $css = array();
16252 // get CSS array defined at previous call
16253 $matches = array();
16255 if (isset($matches[1][0])) {
16257 }
16259 }
16260 // extract external CSS files
16261 $matches = array();
16263 foreach ($matches[1] as $key => $link) {
16264 $type = array();
16265 if (preg_match('/type[\s]*=[\s]*"text\/css"/', $link, $type)) {
16266 $type = array();
16267 preg_match('/media[\s]*=[\s]*"([^"]*)"/', $link, $type);
16268 // get 'all' and 'print' media, other media types are discarded
16269 // (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
16270 if (empty($type) OR (isset($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
16271 $type = array();
16272 if (preg_match('/href[\s]*=[\s]*"([^"]*)"/', $link, $type) > 0) {
16273 // read CSS data file
16274 $cssdata = TCPDF_STATIC::fileGetContents(trim($type[1]));
16275 if (($cssdata !== FALSE) AND (strlen($cssdata) > 0)) {
16276 $css = array_merge($css, TCPDF_STATIC::extractCSSproperties($cssdata));
16277 }
16278 }
16279 }
16280 }
16281 }
16282 }
16283 // extract style tags
16284 $matches = array();
16286 foreach ($matches[1] as $key => $media) {
16287 $type = array();
16288 preg_match('/media[\s]*=[\s]*"([^"]*)"/', $media, $type);
16289 // get 'all' and 'print' media, other media types are discarded
16290 // (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
16291 if (empty($type) OR (isset($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
16292 $cssdata = $matches[2][$key];
16293 $css = array_merge($css, TCPDF_STATIC::extractCSSproperties($cssdata));
16294 }
16295 }
16296 }
16297 // create a special tag to contain the CSS array (used for table content)
16298 $csstagarray = '<cssarray>'.htmlentities(json_encode($css)).'</cssarray>';
16299 // remove head and style blocks
16302 // define block tags
16303 $blocktags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table','tr','td');
16304 // define self-closing tags
16305 $selfclosingtags = array('area','base','basefont','br','hr','input','img','link','meta');
16306 // remove all unsupported tags (the line below lists all supported tags)
16307 $html = strip_tags($html, '<marker/><a><b><blockquote><body><br><br/><dd><del><div><dl><dt><em><font><form><h1><h2><h3><h4><h5><h6><hr><hr/><i><img><input><label><li><ol><option><p><pre><s><select><small><span><strike><strong><sub><sup><table><tablehead><tcpdf><td><textarea><th><thead><tr><tt><u><ul>');
16308 //replace some blank characters
16310 $html = preg_replace('/<(table|tr|td|th|tcpdf|blockquote|dd|div|dl|dt|form|h1|h2|h3|h4|h5|h6|br|hr|li|ol|ul|p)([^>]*)>[\n\r\t]+/', '<\\1\\2>', $html);
16312 $repTable = array("\t" => ' ', "\0" => ' ', "\x0B" => ' ', "\\" => "\\\\");
16314 $offset = 0;
16316 $html_a = substr($html, 0, $offset);
16317 $html_b = substr($html, $offset, ($pos - $offset + 6));
16318 while (preg_match("'<xre([^>]*)>(.*?)\n(.*?)</pre>'si", $html_b)) {
16319 // preserve newlines on <pre> tag
16320 $html_b = preg_replace("'<xre([^>]*)>(.*?)\n(.*?)</pre>'si", "<xre\\1>\\2<br />\\3</pre>", $html_b);
16321 }
16322 while (preg_match("'<xre([^>]*)>(.*?)".$this->re_space['p']."(.*?)</pre>'".$this->re_space['m'], $html_b)) {
16323 // preserve spaces on <pre> tag
16324 $html_b = preg_replace("'<xre([^>]*)>(.*?)".$this->re_space['p']."(.*?)</pre>'".$this->re_space['m'], "<xre\\1>\\2 \\3</pre>", $html_b);
16325 }
16327 $offset = strlen($html_a.$html_b);
16328 }
16329 $offset = 0;
16330 while (($offset < strlen($html)) AND ($pos = strpos($html, '</textarea>', $offset)) !== false) {
16331 $html_a = substr($html, 0, $offset);
16332 $html_b = substr($html, $offset, ($pos - $offset + 11));
16333 while (preg_match("'<textarea([^>]*)>(.*?)\n(.*?)</textarea>'si", $html_b)) {
16334 // preserve newlines on <textarea> tag
16335 $html_b = preg_replace("'<textarea([^>]*)>(.*?)\n(.*?)</textarea>'si", "<textarea\\1>\\2<TBR>\\3</textarea>", $html_b);
16336 $html_b = preg_replace("'<textarea([^>]*)>(.*?)[\"](.*?)</textarea>'si", "<textarea\\1>\\2''\\3</textarea>", $html_b);
16337 }
16339 $offset = strlen($html_a.$html_b);
16340 }
16343 $offset = 0;
16344 while (($offset < strlen($html)) AND ($pos = strpos($html, '</option>', $offset)) !== false) {
16345 $html_a = substr($html, 0, $offset);
16346 $html_b = substr($html, $offset, ($pos - $offset + 9));
16347 while (preg_match("'<option([^>]*)>(.*?)</option>'si", $html_b)) {
16348 $html_b = preg_replace("'<option([\s]+)value=\"([^\"]*)\"([^>]*)>(.*?)</option>'si", "\\2#!TaB!#\\4#!NwL!#", $html_b);
16349 $html_b = preg_replace("'<option([^>]*)>(.*?)</option>'si", "\\2#!NwL!#", $html_b);
16350 }
16352 $offset = strlen($html_a.$html_b);
16353 }
16357 }
16359 // restore textarea newlines
16361 // remove extra spaces from code
16363 $html = preg_replace('/'.$this->re_space['p'].'+<\/(td|th|li|dt|dd)>/'.$this->re_space['m'], '</\\1>', $html);
16365 $html = preg_replace('/'.$this->re_space['p'].'+<(ul|ol|dl|br)/'.$this->re_space['m'], '<\\1', $html);
16366 $html = preg_replace('/<\/(table|tr|td|th|blockquote|dd|dt|dl|div|dt|h1|h2|h3|h4|h5|h6|hr|li|ol|ul|p)>[\s]+</', '</\\1><', $html);
16369 $html = preg_replace('/'.$this->re_space['p'].'+<img/'.$this->re_space['m'], chr(32).'<img', $html);
16371 $html = preg_replace('/<img([^>]*)>/xi', '<img\\1><span><marker style="font-size:0"/></span>', $html);
16373 $html = preg_replace('/<textarea([^>]*)>([^<]*)<\/textarea>/xi', '<textarea\\1 value="\\2" />', $html);
16375 $html = preg_replace('/<li([^>]*)>'.$this->re_space['p'].'*<img/'.$this->re_space['m'], '<li\\1><font size="1"> </font><img', $html);
16380 $html = preg_replace('/'.$this->re_space['p'].'+/'.$this->re_space['m'], chr(32), $html); // replace multiple spaces with a single space
16381 // trim string
16383 // fix br tag after li
16385 // fix first image tag alignment
16387 // pattern for generic tag
16388 $tagpattern = '/(<[^>]+>)/';
16389 // explodes the string
16391 // count elements
16392 $maxel = count($a);
16393 $elkey = 0;
16394 $key = 0;
16395 // create an array of elements
16396 $dom = array();
16397 $dom[$key] = array();
16398 // set inheritable properties fot the first void element
16399 // possible inheritable properties are: azimuth, border-collapse, border-spacing, caption-side, color, cursor, direction, empty-cells, font, font-family, font-stretch, font-size, font-size-adjust, font-style, font-variant, font-weight, letter-spacing, line-height, list-style, list-style-image, list-style-position, list-style-type, orphans, page, page-break-inside, quotes, speak, speak-header, text-align, text-indent, text-transform, volume, white-space, widows, word-spacing
16400 $dom[$key]['tag'] = false;
16401 $dom[$key]['block'] = false;
16402 $dom[$key]['value'] = '';
16403 $dom[$key]['parent'] = 0;
16404 $dom[$key]['hide'] = false;
16411 $dom[$key]['fill'] = (($this->textrendermode % 2) == 0);
16412 $dom[$key]['clip'] = ($this->textrendermode > 3);
16414 $dom[$key]['bgcolor'] = false;
16417 $dom[$key]['align'] = '';
16418 $dom[$key]['listtype'] = '';
16419 $dom[$key]['text-indent'] = 0;
16420 $dom[$key]['text-transform'] = '';
16421 $dom[$key]['border'] = array();
16422 $dom[$key]['dir'] = $this->rtl?'rtl':'ltr';
16424 ++$key;
16425 $level = array();
16426 array_push($level, 0); // root
16427 while ($elkey < $maxel) {
16428 $dom[$key] = array();
16429 $element = $a[$elkey];
16430 $dom[$key]['elkey'] = $elkey;
16431 if (preg_match($tagpattern, $element)) {
16432 // html tag
16433 $element = substr($element, 1, -1);
16434 // get tag name
16435 preg_match('/[\/]?([a-zA-Z0-9]*)/', $element, $tag);
16436 $tagname = strtolower($tag[1]);
16437 // check if we are inside a table header
16438 if ($tagname == 'thead') {
16439 if ($element[0] == '/') {
16441 } else {
16443 }
16444 ++$elkey;
16445 continue;
16446 }
16447 $dom[$key]['tag'] = true;
16448 $dom[$key]['value'] = $tagname;
16449 if (in_array($dom[$key]['value'], $blocktags)) {
16450 $dom[$key]['block'] = true;
16451 } else {
16452 $dom[$key]['block'] = false;
16453 }
16454 if ($element[0] == '/') {
16455 // *** closing html tag
16456 $dom[$key]['opening'] = false;
16457 $dom[$key]['parent'] = end($level);
16458 array_pop($level);
16459 $dom[$key]['hide'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['hide'];
16460 $dom[$key]['fontname'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontname'];
16461 $dom[$key]['fontstyle'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontstyle'];
16462 $dom[$key]['fontsize'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontsize'];
16463 $dom[$key]['font-stretch'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['font-stretch'];
16464 $dom[$key]['letter-spacing'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['letter-spacing'];
16465 $dom[$key]['stroke'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['stroke'];
16466 $dom[$key]['fill'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fill'];
16467 $dom[$key]['clip'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['clip'];
16468 $dom[$key]['line-height'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['line-height'];
16469 $dom[$key]['bgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['bgcolor'];
16470 $dom[$key]['fgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fgcolor'];
16471 $dom[$key]['strokecolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['strokecolor'];
16472 $dom[$key]['align'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['align'];
16473 $dom[$key]['text-transform'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['text-transform'];
16474 $dom[$key]['dir'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['dir'];
16475 if (isset($dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'])) {
16476 $dom[$key]['listtype'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'];
16477 }
16478 // set the number of columns in table tag
16479 if (($dom[$key]['value'] == 'tr') AND (!isset($dom[($dom[($dom[$key]['parent'])]['parent'])]['cols']))) {
16480 $dom[($dom[($dom[$key]['parent'])]['parent'])]['cols'] = $dom[($dom[$key]['parent'])]['cols'];
16481 }
16482 if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
16483 $dom[($dom[$key]['parent'])]['content'] = $csstagarray;
16484 for ($i = ($dom[$key]['parent'] + 1); $i < $key; ++$i) {
16485 $dom[($dom[$key]['parent'])]['content'] .= stripslashes($a[$dom[$i]['elkey']]);
16486 }
16487 $key = $i;
16488 // mark nested tables
16489 $dom[($dom[$key]['parent'])]['content'] = str_replace('<table', '<table nested="true"', $dom[($dom[$key]['parent'])]['content']);
16490 // remove thead sections from nested tables
16491 $dom[($dom[$key]['parent'])]['content'] = str_replace('<thead>', '', $dom[($dom[$key]['parent'])]['content']);
16492 $dom[($dom[$key]['parent'])]['content'] = str_replace('</thead>', '', $dom[($dom[$key]['parent'])]['content']);
16493 }
16494 // store header rows on a new table
16495 if (($dom[$key]['value'] == 'tr') AND ($dom[($dom[$key]['parent'])]['thead'] === true)) {
16497 $dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] = $csstagarray.$a[$dom[($dom[($dom[$key]['parent'])]['parent'])]['elkey']];
16498 }
16499 for ($i = $dom[$key]['parent']; $i <= $key; ++$i) {
16500 $dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] .= $a[$dom[$i]['elkey']];
16501 }
16502 if (!isset($dom[($dom[$key]['parent'])]['attribute'])) {
16503 $dom[($dom[$key]['parent'])]['attribute'] = array();
16504 }
16505 // header elements must be always contained in a single page
16506 $dom[($dom[$key]['parent'])]['attribute']['nobr'] = 'true';
16507 }
16508 if (($dom[$key]['value'] == 'table') AND (!TCPDF_STATIC::empty_string($dom[($dom[$key]['parent'])]['thead']))) {
16509 // remove the nobr attributes from the table header
16510 $dom[($dom[$key]['parent'])]['thead'] = str_replace(' nobr="true"', '', $dom[($dom[$key]['parent'])]['thead']);
16511 $dom[($dom[$key]['parent'])]['thead'] .= '</tablehead>';
16512 }
16513 } else {
16514 // *** opening or self-closing html tag
16515 $dom[$key]['opening'] = true;
16516 $dom[$key]['parent'] = end($level);
16517 if ((substr($element, -1, 1) == '/') OR (in_array($dom[$key]['value'], $selfclosingtags))) {
16518 // self-closing tag
16519 $dom[$key]['self'] = true;
16520 } else {
16521 // opening tag
16522 array_push($level, $key);
16523 $dom[$key]['self'] = false;
16524 }
16525 // copy some values from parent
16526 $parentkey = 0;
16527 if ($key > 0) {
16528 $parentkey = $dom[$key]['parent'];
16529 $dom[$key]['hide'] = $dom[$parentkey]['hide'];
16530 $dom[$key]['fontname'] = $dom[$parentkey]['fontname'];
16531 $dom[$key]['fontstyle'] = $dom[$parentkey]['fontstyle'];
16532 $dom[$key]['fontsize'] = $dom[$parentkey]['fontsize'];
16533 $dom[$key]['font-stretch'] = $dom[$parentkey]['font-stretch'];
16534 $dom[$key]['letter-spacing'] = $dom[$parentkey]['letter-spacing'];
16535 $dom[$key]['stroke'] = $dom[$parentkey]['stroke'];
16536 $dom[$key]['fill'] = $dom[$parentkey]['fill'];
16537 $dom[$key]['clip'] = $dom[$parentkey]['clip'];
16538 $dom[$key]['line-height'] = $dom[$parentkey]['line-height'];
16539 $dom[$key]['bgcolor'] = $dom[$parentkey]['bgcolor'];
16540 $dom[$key]['fgcolor'] = $dom[$parentkey]['fgcolor'];
16541 $dom[$key]['strokecolor'] = $dom[$parentkey]['strokecolor'];
16542 $dom[$key]['align'] = $dom[$parentkey]['align'];
16543 $dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
16544 $dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
16545 $dom[$key]['text-transform'] = $dom[$parentkey]['text-transform'];
16546 $dom[$key]['border'] = array();
16547 $dom[$key]['dir'] = $dom[$parentkey]['dir'];
16548 }
16549 // get attributes
16550 preg_match_all('/([^=\s]*)[\s]*=[\s]*"([^"]*)"/', $element, $attr_array, PREG_PATTERN_ORDER);
16551 $dom[$key]['attribute'] = array(); // reset attribute array
16552 while (list($id, $name) = each($attr_array[1])) {
16553 $dom[$key]['attribute'][strtolower($name)] = $attr_array[2][$id];
16554 }
16555 if (!empty($css)) {
16556 // merge CSS style to current style
16557 list($dom[$key]['csssel'], $dom[$key]['cssdata']) = TCPDF_STATIC::getCSSdataArray($dom, $key, $css);
16558 $dom[$key]['attribute']['style'] = TCPDF_STATIC::getTagStyleFromCSSarray($dom[$key]['cssdata']);
16559 }
16560 // split style attributes
16561 if (isset($dom[$key]['attribute']['style']) AND !empty($dom[$key]['attribute']['style'])) {
16562 // get style attributes
16563 preg_match_all('/([^;:\s]*):([^;]*)/', $dom[$key]['attribute']['style'], $style_array, PREG_PATTERN_ORDER);
16564 $dom[$key]['style'] = array(); // reset style attribute array
16565 while (list($id, $name) = each($style_array[1])) {
16566 // in case of duplicate attribute the last replace the previous
16567 $dom[$key]['style'][strtolower($name)] = trim($style_array[2][$id]);
16568 }
16569 // --- get some style attributes ---
16570 // text direction
16571 if (isset($dom[$key]['style']['direction'])) {
16572 $dom[$key]['dir'] = $dom[$key]['style']['direction'];
16573 }
16574 // display
16575 if (isset($dom[$key]['style']['display'])) {
16576 $dom[$key]['hide'] = (trim(strtolower($dom[$key]['style']['display'])) == 'none');
16577 }
16578 // font family
16579 if (isset($dom[$key]['style']['font-family'])) {
16581 }
16582 // list-style-type
16583 if (isset($dom[$key]['style']['list-style-type'])) {
16584 $dom[$key]['listtype'] = trim(strtolower($dom[$key]['style']['list-style-type']));
16585 if ($dom[$key]['listtype'] == 'inherit') {
16586 $dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
16587 }
16588 }
16589 // text-indent
16590 if (isset($dom[$key]['style']['text-indent'])) {
16592 if ($dom[$key]['text-indent'] == 'inherit') {
16593 $dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
16594 }
16595 }
16596 // text-transform
16597 if (isset($dom[$key]['style']['text-transform'])) {
16598 $dom[$key]['text-transform'] = $dom[$key]['style']['text-transform'];
16599 }
16600 // font size
16601 if (isset($dom[$key]['style']['font-size'])) {
16602 $fsize = trim($dom[$key]['style']['font-size']);
16603 $dom[$key]['fontsize'] = $this->getHTMLFontUnits($fsize, $dom[0]['fontsize'], $dom[$parentkey]['fontsize'], 'pt');
16604 }
16605 // font-stretch
16606 if (isset($dom[$key]['style']['font-stretch'])) {
16607 $dom[$key]['font-stretch'] = $this->getCSSFontStretching($dom[$key]['style']['font-stretch'], $dom[$parentkey]['font-stretch']);
16608 }
16609 // letter-spacing
16610 if (isset($dom[$key]['style']['letter-spacing'])) {
16611 $dom[$key]['letter-spacing'] = $this->getCSSFontSpacing($dom[$key]['style']['letter-spacing'], $dom[$parentkey]['letter-spacing']);
16612 }
16613 // line-height (internally is the cell height ratio)
16614 if (isset($dom[$key]['style']['line-height'])) {
16615 $lineheight = trim($dom[$key]['style']['line-height']);
16616 switch ($lineheight) {
16617 // A normal line height. This is default
16618 case 'normal': {
16619 $dom[$key]['line-height'] = $dom[0]['line-height'];
16620 break;
16621 }
16622 case 'inherit': {
16623 $dom[$key]['line-height'] = $dom[$parentkey]['line-height'];
16624 }
16625 default: {
16626 if (is_numeric($lineheight)) {
16627 // convert to percentage of font height
16628 $lineheight = ($lineheight * 100).'%';
16629 }
16631 if (substr($lineheight, -1) !== '%') {
16632 if ($dom[$key]['fontsize'] <= 0) {
16633 $dom[$key]['line-height'] = 1;
16634 } else {
16635 $dom[$key]['line-height'] = (($dom[$key]['line-height'] - $this->cell_padding['T'] - $this->cell_padding['B']) / $dom[$key]['fontsize']);
16636 }
16637 }
16638 }
16639 }
16640 }
16641 // font style
16642 if (isset($dom[$key]['style']['font-weight'])) {
16643 if (strtolower($dom[$key]['style']['font-weight'][0]) == 'n') {
16644 if (strpos($dom[$key]['fontstyle'], 'B') !== false) {
16645 $dom[$key]['fontstyle'] = str_replace('B', '', $dom[$key]['fontstyle']);
16646 }
16647 } elseif (strtolower($dom[$key]['style']['font-weight'][0]) == 'b') {
16648 $dom[$key]['fontstyle'] .= 'B';
16649 }
16650 }
16651 if (isset($dom[$key]['style']['font-style']) AND (strtolower($dom[$key]['style']['font-style'][0]) == 'i')) {
16652 $dom[$key]['fontstyle'] .= 'I';
16653 }
16654 // font color
16655 if (isset($dom[$key]['style']['color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['style']['color']))) {
16656 $dom[$key]['fgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['color'], $this->spot_colors);
16657 } elseif ($dom[$key]['value'] == 'a') {
16659 }
16660 // background color
16661 if (isset($dom[$key]['style']['background-color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['style']['background-color']))) {
16662 $dom[$key]['bgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['background-color'], $this->spot_colors);
16663 }
16664 // text-decoration
16665 if (isset($dom[$key]['style']['text-decoration'])) {
16666 $decors = explode(' ', strtolower($dom[$key]['style']['text-decoration']));
16667 foreach ($decors as $dec) {
16668 $dec = trim($dec);
16670 if ($dec[0] == 'u') {
16671 // underline
16672 $dom[$key]['fontstyle'] .= 'U';
16673 } elseif ($dec[0] == 'l') {
16674 // line-through
16675 $dom[$key]['fontstyle'] .= 'D';
16676 } elseif ($dec[0] == 'o') {
16677 // overline
16678 $dom[$key]['fontstyle'] .= 'O';
16679 }
16680 }
16681 }
16682 } elseif ($dom[$key]['value'] == 'a') {
16684 }
16685 // check for width attribute
16686 if (isset($dom[$key]['style']['width'])) {
16687 $dom[$key]['width'] = $dom[$key]['style']['width'];
16688 }
16689 // check for height attribute
16690 if (isset($dom[$key]['style']['height'])) {
16691 $dom[$key]['height'] = $dom[$key]['style']['height'];
16692 }
16693 // check for text alignment
16694 if (isset($dom[$key]['style']['text-align'])) {
16695 $dom[$key]['align'] = strtoupper($dom[$key]['style']['text-align'][0]);
16696 }
16697 // check for CSS border properties
16698 if (isset($dom[$key]['style']['border'])) {
16700 if (!empty($borderstyle)) {
16701 $dom[$key]['border']['LTRB'] = $borderstyle;
16702 }
16703 }
16704 if (isset($dom[$key]['style']['border-color'])) {
16705 $brd_colors = preg_split('/[\s]+/', trim($dom[$key]['style']['border-color']));
16706 if (isset($brd_colors[3])) {
16707 $dom[$key]['border']['L']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[3], $this->spot_colors);
16708 }
16709 if (isset($brd_colors[1])) {
16710 $dom[$key]['border']['R']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[1], $this->spot_colors);
16711 }
16712 if (isset($brd_colors[0])) {
16713 $dom[$key]['border']['T']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[0], $this->spot_colors);
16714 }
16715 if (isset($brd_colors[2])) {
16716 $dom[$key]['border']['B']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[2], $this->spot_colors);
16717 }
16718 }
16719 if (isset($dom[$key]['style']['border-width'])) {
16720 $brd_widths = preg_split('/[\s]+/', trim($dom[$key]['style']['border-width']));
16721 if (isset($brd_widths[3])) {
16723 }
16724 if (isset($brd_widths[1])) {
16726 }
16727 if (isset($brd_widths[0])) {
16729 }
16730 if (isset($brd_widths[2])) {
16732 }
16733 }
16734 if (isset($dom[$key]['style']['border-style'])) {
16735 $brd_styles = preg_split('/[\s]+/', trim($dom[$key]['style']['border-style']));
16736 if (isset($brd_styles[3]) AND ($brd_styles[3]!='none')) {
16737 $dom[$key]['border']['L']['cap'] = 'square';
16738 $dom[$key]['border']['L']['join'] = 'miter';
16740 if ($dom[$key]['border']['L']['dash'] < 0) {
16741 $dom[$key]['border']['L'] = array();
16742 }
16743 }
16744 if (isset($brd_styles[1])) {
16745 $dom[$key]['border']['R']['cap'] = 'square';
16746 $dom[$key]['border']['R']['join'] = 'miter';
16748 if ($dom[$key]['border']['R']['dash'] < 0) {
16749 $dom[$key]['border']['R'] = array();
16750 }
16751 }
16752 if (isset($brd_styles[0])) {
16753 $dom[$key]['border']['T']['cap'] = 'square';
16754 $dom[$key]['border']['T']['join'] = 'miter';
16756 if ($dom[$key]['border']['T']['dash'] < 0) {
16757 $dom[$key]['border']['T'] = array();
16758 }
16759 }
16760 if (isset($brd_styles[2])) {
16761 $dom[$key]['border']['B']['cap'] = 'square';
16762 $dom[$key]['border']['B']['join'] = 'miter';
16764 if ($dom[$key]['border']['B']['dash'] < 0) {
16765 $dom[$key]['border']['B'] = array();
16766 }
16767 }
16768 }
16769 $cellside = array('L' => 'left', 'R' => 'right', 'T' => 'top', 'B' => 'bottom');
16770 foreach ($cellside as $bsk => $bsv) {
16771 if (isset($dom[$key]['style']['border-'.$bsv])) {
16773 if (!empty($borderstyle)) {
16774 $dom[$key]['border'][$bsk] = $borderstyle;
16775 }
16776 }
16777 if (isset($dom[$key]['style']['border-'.$bsv.'-color'])) {
16778 $dom[$key]['border'][$bsk]['color'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['border-'.$bsv.'-color'], $this->spot_colors);
16779 }
16780 if (isset($dom[$key]['style']['border-'.$bsv.'-width'])) {
16781 $dom[$key]['border'][$bsk]['width'] = $this->getCSSBorderWidth($dom[$key]['style']['border-'.$bsv.'-width']);
16782 }
16783 if (isset($dom[$key]['style']['border-'.$bsv.'-style'])) {
16784 $dom[$key]['border'][$bsk]['dash'] = $this->getCSSBorderDashStyle($dom[$key]['style']['border-'.$bsv.'-style']);
16785 if ($dom[$key]['border'][$bsk]['dash'] < 0) {
16786 $dom[$key]['border'][$bsk] = array();
16787 }
16788 }
16789 }
16790 // check for CSS padding properties
16791 if (isset($dom[$key]['style']['padding'])) {
16793 } else {
16795 }
16796 foreach ($cellside as $psk => $psv) {
16797 if (isset($dom[$key]['style']['padding-'.$psv])) {
16798 $dom[$key]['padding'][$psk] = $this->getHTMLUnitToUnits($dom[$key]['style']['padding-'.$psv], 0, 'px', false);
16799 }
16800 }
16801 // check for CSS margin properties
16802 if (isset($dom[$key]['style']['margin'])) {
16804 } else {
16806 }
16807 foreach ($cellside as $psk => $psv) {
16808 if (isset($dom[$key]['style']['margin-'.$psv])) {
16809 $dom[$key]['margin'][$psk] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $dom[$key]['style']['margin-'.$psv]), 0, 'px', false);
16810 }
16811 }
16812 // check for CSS border-spacing properties
16813 if (isset($dom[$key]['style']['border-spacing'])) {
16814 $dom[$key]['border-spacing'] = $this->getCSSBorderMargin($dom[$key]['style']['border-spacing']);
16815 }
16816 // page-break-inside
16817 if (isset($dom[$key]['style']['page-break-inside']) AND ($dom[$key]['style']['page-break-inside'] == 'avoid')) {
16818 $dom[$key]['attribute']['nobr'] = 'true';
16819 }
16820 // page-break-before
16821 if (isset($dom[$key]['style']['page-break-before'])) {
16822 if ($dom[$key]['style']['page-break-before'] == 'always') {
16823 $dom[$key]['attribute']['pagebreak'] = 'true';
16824 } elseif ($dom[$key]['style']['page-break-before'] == 'left') {
16825 $dom[$key]['attribute']['pagebreak'] = 'left';
16826 } elseif ($dom[$key]['style']['page-break-before'] == 'right') {
16827 $dom[$key]['attribute']['pagebreak'] = 'right';
16828 }
16829 }
16830 // page-break-after
16831 if (isset($dom[$key]['style']['page-break-after'])) {
16832 if ($dom[$key]['style']['page-break-after'] == 'always') {
16833 $dom[$key]['attribute']['pagebreakafter'] = 'true';
16834 } elseif ($dom[$key]['style']['page-break-after'] == 'left') {
16835 $dom[$key]['attribute']['pagebreakafter'] = 'left';
16836 } elseif ($dom[$key]['style']['page-break-after'] == 'right') {
16837 $dom[$key]['attribute']['pagebreakafter'] = 'right';
16838 }
16839 }
16840 }
16841 if (isset($dom[$key]['attribute']['display'])) {
16842 $dom[$key]['hide'] = (trim(strtolower($dom[$key]['attribute']['display'])) == 'none');
16843 }
16844 if (isset($dom[$key]['attribute']['border']) AND ($dom[$key]['attribute']['border'] != 0)) {
16846 if (!empty($borderstyle)) {
16847 $dom[$key]['border']['LTRB'] = $borderstyle;
16848 }
16849 }
16850 // check for font tag
16851 if ($dom[$key]['value'] == 'font') {
16852 // font family
16853 if (isset($dom[$key]['attribute']['face'])) {
16855 }
16856 // font size
16857 if (isset($dom[$key]['attribute']['size'])) {
16858 if ($key > 0) {
16859 if ($dom[$key]['attribute']['size'][0] == '+') {
16860 $dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] + intval(substr($dom[$key]['attribute']['size'], 1));
16861 } elseif ($dom[$key]['attribute']['size'][0] == '-') {
16862 $dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] - intval(substr($dom[$key]['attribute']['size'], 1));
16863 } else {
16864 $dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
16865 }
16866 } else {
16867 $dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
16868 }
16869 }
16870 }
16871 // force natural alignment for lists
16872 if ((($dom[$key]['value'] == 'ul') OR ($dom[$key]['value'] == 'ol') OR ($dom[$key]['value'] == 'dl'))
16873 AND (!isset($dom[$key]['align']) OR TCPDF_STATIC::empty_string($dom[$key]['align']) OR ($dom[$key]['align'] != 'J'))) {
16874 if ($this->rtl) {
16875 $dom[$key]['align'] = 'R';
16876 } else {
16877 $dom[$key]['align'] = 'L';
16878 }
16879 }
16880 if (($dom[$key]['value'] == 'small') OR ($dom[$key]['value'] == 'sup') OR ($dom[$key]['value'] == 'sub')) {
16881 if (!isset($dom[$key]['attribute']['size']) AND !isset($dom[$key]['style']['font-size'])) {
16883 }
16884 }
16885 if (($dom[$key]['value'] == 'strong') OR ($dom[$key]['value'] == 'b')) {
16886 $dom[$key]['fontstyle'] .= 'B';
16887 }
16888 if (($dom[$key]['value'] == 'em') OR ($dom[$key]['value'] == 'i')) {
16889 $dom[$key]['fontstyle'] .= 'I';
16890 }
16891 if ($dom[$key]['value'] == 'u') {
16892 $dom[$key]['fontstyle'] .= 'U';
16893 }
16894 if (($dom[$key]['value'] == 'del') OR ($dom[$key]['value'] == 's') OR ($dom[$key]['value'] == 'strike')) {
16895 $dom[$key]['fontstyle'] .= 'D';
16896 }
16897 if (!isset($dom[$key]['style']['text-decoration']) AND ($dom[$key]['value'] == 'a')) {
16899 }
16900 if (($dom[$key]['value'] == 'pre') OR ($dom[$key]['value'] == 'tt')) {
16902 }
16903 if (!empty($dom[$key]['value']) AND ($dom[$key]['value'][0] == 'h') AND (intval($dom[$key]['value']{1}) > 0) AND (intval($dom[$key]['value']{1}) < 7)) {
16904 // headings h1, h2, h3, h4, h5, h6
16905 if (!isset($dom[$key]['attribute']['size']) AND !isset($dom[$key]['style']['font-size'])) {
16906 $headsize = (4 - intval($dom[$key]['value']{1})) * 2;
16907 $dom[$key]['fontsize'] = $dom[0]['fontsize'] + $headsize;
16908 }
16909 if (!isset($dom[$key]['style']['font-weight'])) {
16910 $dom[$key]['fontstyle'] .= 'B';
16911 }
16912 }
16913 if (($dom[$key]['value'] == 'table')) {
16914 $dom[$key]['rows'] = 0; // number of rows
16915 $dom[$key]['trids'] = array(); // IDs of TR elements
16916 $dom[$key]['thead'] = ''; // table header rows
16917 }
16918 if (($dom[$key]['value'] == 'tr')) {
16919 $dom[$key]['cols'] = 0;
16921 $dom[$key]['thead'] = true;
16922 // rows on thead block are printed as a separate table
16923 } else {
16924 $dom[$key]['thead'] = false;
16925 // store the number of rows on table element
16926 ++$dom[($dom[$key]['parent'])]['rows'];
16927 // store the TR elements IDs on table element
16928 array_push($dom[($dom[$key]['parent'])]['trids'], $key);
16929 }
16930 }
16931 if (($dom[$key]['value'] == 'th') OR ($dom[$key]['value'] == 'td')) {
16932 if (isset($dom[$key]['attribute']['colspan'])) {
16933 $colspan = intval($dom[$key]['attribute']['colspan']);
16934 } else {
16935 $colspan = 1;
16936 }
16937 $dom[$key]['attribute']['colspan'] = $colspan;
16938 $dom[($dom[$key]['parent'])]['cols'] += $colspan;
16939 }
16940 // text direction
16941 if (isset($dom[$key]['attribute']['dir'])) {
16942 $dom[$key]['dir'] = $dom[$key]['attribute']['dir'];
16943 }
16944 // set foreground color attribute
16945 if (isset($dom[$key]['attribute']['color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['color']))) {
16946 $dom[$key]['fgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['color'], $this->spot_colors);
16947 } elseif (!isset($dom[$key]['style']['color']) AND ($dom[$key]['value'] == 'a')) {
16949 }
16950 // set background color attribute
16951 if (isset($dom[$key]['attribute']['bgcolor']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['bgcolor']))) {
16952 $dom[$key]['bgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['bgcolor'], $this->spot_colors);
16953 }
16954 // set stroke color attribute
16955 if (isset($dom[$key]['attribute']['strokecolor']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['strokecolor']))) {
16956 $dom[$key]['strokecolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['strokecolor'], $this->spot_colors);
16957 }
16958 // check for width attribute
16959 if (isset($dom[$key]['attribute']['width'])) {
16960 $dom[$key]['width'] = $dom[$key]['attribute']['width'];
16961 }
16962 // check for height attribute
16963 if (isset($dom[$key]['attribute']['height'])) {
16964 $dom[$key]['height'] = $dom[$key]['attribute']['height'];
16965 }
16966 // check for text alignment
16967 if (isset($dom[$key]['attribute']['align']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['align'])) AND ($dom[$key]['value'] !== 'img')) {
16968 $dom[$key]['align'] = strtoupper($dom[$key]['attribute']['align'][0]);
16969 }
16970 // check for text rendering mode (the following attributes do not exist in HTML)
16971 if (isset($dom[$key]['attribute']['stroke'])) {
16972 // font stroke width
16973 $dom[$key]['stroke'] = $this->getHTMLUnitToUnits($dom[$key]['attribute']['stroke'], $dom[$key]['fontsize'], 'pt', true);
16974 }
16975 if (isset($dom[$key]['attribute']['fill'])) {
16976 // font fill
16977 if ($dom[$key]['attribute']['fill'] == 'true') {
16978 $dom[$key]['fill'] = true;
16979 } else {
16980 $dom[$key]['fill'] = false;
16981 }
16982 }
16983 if (isset($dom[$key]['attribute']['clip'])) {
16984 // clipping mode
16985 if ($dom[$key]['attribute']['clip'] == 'true') {
16986 $dom[$key]['clip'] = true;
16987 } else {
16988 $dom[$key]['clip'] = false;
16989 }
16990 }
16991 } // end opening tag
16992 } else {
16993 // text
16994 $dom[$key]['tag'] = false;
16995 $dom[$key]['block'] = false;
16996 $dom[$key]['parent'] = end($level);
16997 $dom[$key]['dir'] = $dom[$dom[$key]['parent']]['dir'];
16998 if (!empty($dom[$dom[$key]['parent']]['text-transform'])) {
16999 // text-transform for unicode requires mb_convert_case (Multibyte String Functions)
17000 if (function_exists('mb_convert_case')) {
17001 $ttm = array('capitalize' => MB_CASE_TITLE, 'uppercase' => MB_CASE_UPPER, 'lowercase' => MB_CASE_LOWER);
17002 if (isset($ttm[$dom[$dom[$key]['parent']]['text-transform']])) {
17003 $element = mb_convert_case($element, $ttm[$dom[$dom[$key]['parent']]['text-transform']], $this->encoding);
17004 }
17005 } elseif (!$this->isunicode) {
17006 switch ($dom[$dom[$key]['parent']]['text-transform']) {
17007 case 'capitalize': {
17008 $element = ucwords(strtolower($element));
17009 break;
17010 }
17011 case 'uppercase': {
17012 $element = strtoupper($element);
17013 break;
17014 }
17015 case 'lowercase': {
17016 $element = strtolower($element);
17017 break;
17018 }
17019 }
17020 }
17021 }
17023 }
17024 ++$elkey;
17025 ++$key;
17026 }
17027 return $dom;
17028 }
static getCSSdataArray($dom, $key, $css)
Returns the styles array that apply for the selected HTML tag.
Definition: tcpdf_static.php:1365
static extractCSSproperties($cssdata)
Extracts the CSS properties from a CSS string.
Definition: tcpdf_static.php:1043
static getTagStyleFromCSSarray($css)
Compact CSS data array into single string.
Definition: tcpdf_static.php:1410
getCSSFontStretching($stretch, $parent=100)
Returns the percentage of font stretching from CSS value.
Definition: tcpdf.php:16123
getCSSBorderStyle($cssborder)
Returns the border style array from CSS border properties.
Definition: tcpdf.php:15899
getCSSFontSpacing($spacing, $parent=0)
Returns the letter-spacing value from CSS value.
Definition: tcpdf.php:16092
getCSSMargin($cssmargin, $width=0)
Get the internal Cell margin from CSS attribute.
Definition: tcpdf.php:16004
getCSSBorderMargin($cssbspace, $width=0)
Get the border-spacing from CSS attribute.
Definition: tcpdf.php:16058
getHTMLFontUnits($val, $refsize=12, $parent_size=12, $defaultunit='pt')
Convert HTML string containing font size value to points.
Definition: tcpdf.php:16195
getCSSPadding($csspadding, $width=0)
Get the internal Cell padding from CSS attribute.
Definition: tcpdf.php:15950
echo;exit;}function LogoutNotification($SessionID) { global $ilDB; $q="SELECT session_id, data FROM usr_session WHERE expires > (\w+)\|/" PREG_SPLIT_NO_EMPTY PREG_SPLIT_DELIM_CAPTURE
Definition: shib_logout.php:174
References $cell_height_ratio, $cell_margin, $cell_padding, $default_monospaced_font, $fgcolor, $font_spacing, $font_stretching, $FontFamily, $FontSizePt, $FontStyle, $html, $htmlLinkColorArray, $htmlLinkFontStyle, $strokecolor, $textstrokewidth, $thead, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\extractCSSproperties(), TCPDF_STATIC\fileGetContents(), getCSSBorderDashStyle(), getCSSBorderMargin(), getCSSBorderStyle(), getCSSBorderWidth(), TCPDF_STATIC\getCSSdataArray(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getFontFamilyName(), getHTMLFontUnits(), getHTMLUnitToUnits(), TCPDF_STATIC\getTagStyleFromCSSarray(), K_SMALL_RATIO, PREG_SPLIT_DELIM_CAPTURE, stringTrim(), and unhtmlentities().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getHTMLFontUnits()
| TCPDF::getHTMLFontUnits | ( | $val, | |
$refsize = 12, |
|||
$parent_size = 12, |
|||
$defaultunit = 'pt' |
|||
| ) |
Convert HTML string containing font size value to points.
- Parameters
-
$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).
- Returns
- float value in points
Definition at line 16195 of file tcpdf.php.
16195 {
16196 $refsize = TCPDF_FONTS::getFontRefSize($refsize);
16197 $parent_size = TCPDF_FONTS::getFontRefSize($parent_size, $refsize);
16198 switch ($val) {
16199 case 'xx-small': {
16200 $size = ($refsize - 4);
16201 break;
16202 }
16203 case 'x-small': {
16204 $size = ($refsize - 3);
16205 break;
16206 }
16207 case 'small': {
16208 $size = ($refsize - 2);
16209 break;
16210 }
16211 case 'medium': {
16212 $size = $refsize;
16213 break;
16214 }
16215 case 'large': {
16216 $size = ($refsize + 2);
16217 break;
16218 }
16219 case 'x-large': {
16220 $size = ($refsize + 4);
16221 break;
16222 }
16223 case 'xx-large': {
16224 $size = ($refsize + 6);
16225 break;
16226 }
16227 case 'smaller': {
16228 $size = ($parent_size - 3);
16229 break;
16230 }
16231 case 'larger': {
16232 $size = ($parent_size + 3);
16233 break;
16234 }
16235 default: {
16237 }
16238 }
16240 }
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:
◆ getHTMLUnitToUnits()
| TCPDF::getHTMLUnitToUnits | ( | $htmlval, | |
$refsize = 1, |
|||
$defaultunit = 'px', |
|||
$points = false |
|||
| ) |
Convert HTML string containing value and unit of measure to user's units or points.
- Parameters
-
$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.
- Returns
- float value in user's unit or point if $points=true
- Since
- 4.4.004 (2008-12-10)
Definition at line 20259 of file tcpdf.php.
20259 {
20260 $supportedunits = array('%', 'em', 'ex', 'px', 'in', 'cm', 'mm', 'pc', 'pt');
20261 $retval = 0;
20262 $value = 0;
20263 $unit = 'px';
20264 if ($points) {
20265 $k = 1;
20266 } else {
20268 }
20269 if (in_array($defaultunit, $supportedunits)) {
20270 $unit = $defaultunit;
20271 }
20272 if (is_numeric($htmlval)) {
20273 $value = floatval($htmlval);
20274 } elseif (preg_match('/([0-9\.\-\+]+)/', $htmlval, $mnum)) {
20275 $value = floatval($mnum[1]);
20276 if (preg_match('/([a-z%]+)/', $htmlval, $munit)) {
20277 if (in_array($munit[1], $supportedunits)) {
20278 $unit = $munit[1];
20279 }
20280 }
20281 }
20282 switch ($unit) {
20283 // percentage
20284 case '%': {
20285 $retval = (($value * $refsize) / 100);
20286 break;
20287 }
20288 // relative-size
20289 case 'em': {
20290 $retval = ($value * $refsize);
20291 break;
20292 }
20293 // height of lower case 'x' (about half the font-size)
20294 case 'ex': {
20295 $retval = ($value * ($refsize / 2));
20296 break;
20297 }
20298 // absolute-size
20299 case 'in': {
20301 break;
20302 }
20303 // centimeters
20304 case 'cm': {
20306 break;
20307 }
20308 // millimeters
20309 case 'mm': {
20311 break;
20312 }
20313 // one pica is 12 points
20314 case 'pc': {
20315 $retval = (($value * 12) / $k);
20316 break;
20317 }
20318 // points
20319 case 'pt': {
20320 $retval = ($value / $k);
20321 break;
20322 }
20323 // pixels
20324 case 'px': {
20325 $retval = $this->pixelsToUnits($value);
20326 if ($points) {
20327 $retval *= $this->k;
20328 }
20329 break;
20330 }
20331 }
20332 return $retval;
20333 }
Referenced by getCSSBorderMargin(), getCSSBorderWidth(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getHtmlDomArray(), getHTMLFontUnits(), Image(), openHTMLTagHandler(), and writeHTML().
Here is the caller graph for this function:
◆ getImageBuffer()
|
protected |
Get image buffer content.
- Parameters
-
$image (string) image key
- Returns
- string image buffer content or false in case of error
- Since
- 4.5.000 (2008-12-31)
Definition at line 20789 of file tcpdf.php.
20789 {
20790 if (isset($this->images[$image])) {
20791 return $this->images[$image];
20792 }
20793 return false;
20794 }
Referenced by _putannotsobjs(), _putimages(), and Image().
Here is the caller graph for this function:
◆ getImageRBX()
| TCPDF::getImageRBX | ( | ) |
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
- Returns
- float
Definition at line 3357 of file tcpdf.php.
3357 {
3359 }
$img_rb_x
The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
Definition: tcpdf.php:526
References $img_rb_x.
◆ getImageRBY()
| TCPDF::getImageRBY | ( | ) |
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image.
- Returns
- float
Definition at line 3366 of file tcpdf.php.
3366 {
3368 }
References $img_rb_y.
Referenced by Header().
Here is the caller graph for this function:
◆ getImageScale()
| TCPDF::getImageScale | ( | ) |
◆ getInternalPageNumberAliases()
|
protected |
Return an array containing variations for the basic page number alias.
- Parameters
-
$a (string) Base alias.
- Returns
- array of page number aliases
Definition at line 7808 of file tcpdf.php.
7808 {
7809 $alias = array();
7810 // build array of Unicode + ASCII variants (the order is important)
7811 $alias = array('u' => array(), 'a' => array());
7812 $u = '{'.$a.'}';
7814 if ($this->isunicode) {
7815 $alias['u'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::UTF8ToLatin1($u, $this->isunicode, $this->CurrentFont));
7816 $alias['u'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::utf8StrRev($u, false, $this->tmprtl, $this->isunicode, $this->CurrentFont));
7817 $alias['a'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::UTF8ToLatin1($a, $this->isunicode, $this->CurrentFont));
7818 $alias['a'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::utf8StrRev($a, false, $this->tmprtl, $this->isunicode, $this->CurrentFont));
7819 }
7821 return $alias;
7822 }
static utf8StrRev($str, $setbom=false, $forcertl=false, $isunicode=true, &$currentfont)
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
Definition: tcpdf_fonts.php:2055
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:
◆ getLastH()
| TCPDF::getLastH | ( | ) |
◆ GetLineWidth()
| TCPDF::GetLineWidth | ( | ) |
Returns the current the line width.
- Returns
- int Line width
- Since
- 2.1.000 (2008-01-07)
- See also
- Line(), SetLineWidth()
Definition at line 11295 of file tcpdf.php.
References $LineWidth.
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:
◆ getMargins()
| TCPDF::getMargins | ( | ) |
Returns an array containing current margins:
- $ret['left'] = left margin
- $ret['right'] = right margin
- $ret['top'] = top margin
- $ret['bottom'] = bottom margin
- $ret['header'] = header margin
- $ret['footer'] = footer margin
- $ret['cell'] = cell padding array
- $ret['padding_left'] = cell left padding
- $ret['padding_top'] = cell top padding
- $ret['padding_right'] = cell right padding
- $ret['padding_bottom'] = cell bottom padding
- Returns
- array containing all margins measures
- Since
- 3.2.000 (2008-06-23)
Definition at line 15745 of file tcpdf.php.
15745 {
15746 $ret = array(
15747 'left' => $this->lMargin,
15748 'right' => $this->rMargin,
15749 'top' => $this->tMargin,
15750 'bottom' => $this->bMargin,
15751 'header' => $this->header_margin,
15752 'footer' => $this->footer_margin,
15753 'cell' => $this->cell_padding,
15754 'padding_left' => $this->cell_padding['L'],
15755 'padding_top' => $this->cell_padding['T'],
15756 'padding_right' => $this->cell_padding['R'],
15757 'padding_bottom' => $this->cell_padding['B']
15758 );
15760 }
References $ret.
◆ getNumberOfColumns()
| TCPDF::getNumberOfColumns | ( | ) |
Return the current number of columns.
- Returns
- int number of columns
- Since
- 5.8.018 (2010-08-25)
◆ GetNumChars()
| TCPDF::GetNumChars | ( | $s | ) |
Returns the numbero of characters in a string.
- Parameters
-
$s (string) The input string.
- Returns
- int number of characters
- Since
- 2.0.0001 (2008-01-07)
Definition at line 4135 of file tcpdf.php.
4135 {
4138 }
4139 return strlen($s);
4140 }
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:
◆ getNumLines()
| 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.
- Parameters
-
$txt (string) String for calculating his height $w (float) Width of cells. If 0, they extend up to the right margin of the page. $reseth (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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- Returns
- float Return the minimal height needed for multicell method for printing the $txt param.
- Since
- 4.5.011
Definition at line 6120 of file tcpdf.php.
6120 {
6122 return 0;
6123 }
6125 // empty string
6126 return 1;
6127 }
6128 // adjust internal padding
6129 $prev_cell_padding = $this->cell_padding;
6130 $prev_lasth = $this->lasth;
6131 if (is_array($cellpadding)) {
6132 $this->cell_padding = $cellpadding;
6133 }
6136 if ($this->rtl) {
6138 } else {
6140 }
6141 }
6143 if ($reseth) {
6144 // reset row height
6145 $this->resetLastH();
6146 }
6147 $lines = 1;
6148 $sum = 0;
6149 $chars = TCPDF_FONTS::utf8Bidi(TCPDF_FONTS::UTF8StringToArray($txt, $this->isunicode, $this->CurrentFont), $txt, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6151 $length = count($chars);
6152 $lastSeparator = -1;
6153 for ($i = 0; $i < $length; ++$i) {
6154 $c = $chars[$i];
6155 $charWidth = $charsWidth[$i];
6156 if (($c != 160)
6157 AND (($c == 173)
6158 OR preg_match($this->re_spaces, TCPDF_FONTS::unichr($c, $this->isunicode))
6159 OR (($c == 45)
6160 AND ($i > 0) AND ($i < ($length - 1))
6161 AND @preg_match('/[\p{L}]/'.$this->re_space['m'], TCPDF_FONTS::unichr($chars[($i - 1)], $this->isunicode))
6162 AND @preg_match('/[\p{L}]/'.$this->re_space['m'], TCPDF_FONTS::unichr($chars[($i + 1)], $this->isunicode))
6163 )
6164 )
6165 ) {
6166 $lastSeparator = $i;
6167 }
6168 if ((($sum + $charWidth) > $wmax) OR ($c == 10)) {
6169 ++$lines;
6170 if ($c == 10) {
6171 $lastSeparator = -1;
6172 $sum = 0;
6173 } elseif ($lastSeparator != -1) {
6174 $i = $lastSeparator;
6175 $lastSeparator = -1;
6176 $sum = 0;
6177 } else {
6178 $sum = $charWidth;
6179 }
6180 } else {
6181 $sum += $charWidth;
6182 }
6183 }
6184 if ($chars[($length - 1)] == 10) {
6185 --$lines;
6186 }
6187 $this->cell_padding = $prev_cell_padding;
6188 $this->lasth = $prev_lasth;
6189 return $lines;
6190 }
References $border, $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:
◆ getNumPages()
| TCPDF::getNumPages | ( | ) |
Get the total number of insered pages.
- Returns
- int number of pages
- Since
- 2.1.000 (2008-01-07)
Definition at line 3064 of file tcpdf.php.
References $numpages.
Referenced by lastPage().
Here is the caller graph for this function:
◆ getOriginalMargins()
| TCPDF::getOriginalMargins | ( | ) |
Returns an array containing original margins:
- $ret['left'] = left margin
- $ret['right'] = right margin
- Returns
- array containing all margins measures
- Since
- 4.0.012 (2008-07-24)
Definition at line 15772 of file tcpdf.php.
15772 {
15773 $ret = array(
15774 'left' => $this->original_lMargin,
15775 'right' => $this->original_rMargin
15776 );
15778 }
References $ret.
◆ getOverprint()
| TCPDF::getOverprint | ( | ) |
Get the overprint mode array (OP, op, OPM).
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
- Returns
- array.
- Since
- 5.9.152 (2012-03-23)
Definition at line 13896 of file tcpdf.php.
13896 {
13898 }
References $overprint.
◆ getPage()
| TCPDF::getPage | ( | ) |
Get current document page number.
- Returns
- int page number
- Since
- 2.1.000 (2008-01-07)
- See also
- setPage(), lastpage(), getNumPages()
Definition at line 3053 of file tcpdf.php.
References $page.
Referenced by MYPDF\MultiRow().
Here is the caller graph for this function:
◆ getPageBuffer()
|
protected |
Get page buffer content.
- Parameters
-
$page (int) page number
- Returns
- string page buffer content or false in case of error
- Since
- 4.5.000 (2008-12-31)
Definition at line 20742 of file tcpdf.php.
20742 {
20745 }
20746 return false;
20747 }
Referenced by _out(), _putpages(), MultiCell(), and writeHTML().
Here is the caller graph for this function:
◆ getPageDimensions()
| TCPDF::getPageDimensions | ( | $pagenum = '' | ) |
Returns an array of page dimensions:
- $this->pagedim[$this->page]['w'] = page width in points
- $this->pagedim[$this->page]['h'] = height in points
- $this->pagedim[$this->page]['wk'] = page width in user units
- $this->pagedim[$this->page]['hk'] = page height in user units
- $this->pagedim[$this->page]['tm'] = top margin
- $this->pagedim[$this->page]['bm'] = bottom margin
- $this->pagedim[$this->page]['lm'] = left margin
- $this->pagedim[$this->page]['rm'] = right margin
- $this->pagedim[$this->page]['pb'] = auto page break
- $this->pagedim[$this->page]['or'] = page orientation
- $this->pagedim[$this->page]['olm'] = original left margin
- $this->pagedim[$this->page]['orm'] = original right margin
- $this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
- $this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.
-
$this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation
- $this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.
- $this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade
- $this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.
- $this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.
- $this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.
- $this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.
- $this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
- $this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
-
$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed
- $this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points
-
$this->pagedim[$this->page]['CropBox'] : the visible region of default user space
- $this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points
-
$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment
- $this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points
-
$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming
- $this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points
-
$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content
- $this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points
- $this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points
- $this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points
- Parameters
-
$pagenum (int) page number (empty = current page)
- Returns
- array of page dimensions.
- Since
- 4.5.027 (2009-03-16)
Definition at line 2485 of file tcpdf.php.
2485 {
2486 if (empty($pagenum)) {
2487 $pagenum = $this->page;
2488 }
2489 return $this->pagedim[$pagenum];
2490 }
References $page.
◆ getPageGroupAlias()
| 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.
- Returns
- alias of the current page group
- Since
- 3.0.000 (2008-03-27)
Definition at line 13640 of file tcpdf.php.
13640 {
13642 return '{'.TCPDF_STATIC::$alias_group_tot_pages.'}';
13643 }
13645 }
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:
◆ getPageHeight()
| TCPDF::getPageHeight | ( | $pagenum = '' | ) |
Returns the page height in units.
- Parameters
-
$pagenum (int) page number (empty = current page)
- Returns
- int page height.
- Since
- 1.5.2
- See also
- getPageDimensions()
Definition at line 2517 of file tcpdf.php.
2517 {
2518 if (empty($pagenum)) {
2520 }
2521 return $this->pagedim[$pagenum]['h'];
2522 }
References $h.
◆ getPageNumGroupAlias()
| 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).
- Returns
- alias of the current page group
- Since
- 4.5.000 (2009-01-02)
Definition at line 13655 of file tcpdf.php.
13655 {
13657 return '{'.TCPDF_STATIC::$alias_group_num_page.'}';
13658 }
13660 }
References TCPDF_STATIC\$alias_group_num_page, and isUnicodeFont().
Here is the call graph for this function:
◆ getPageRegions()
| TCPDF::getPageRegions | ( | ) |
Return an array of no-write page regions.
- Returns
- array of no-write page regions
- Since
- 5.9.003 (2010-10-13)
- See also
- setPageRegions(), addPageRegion()
◆ getPageWidth()
| TCPDF::getPageWidth | ( | $pagenum = '' | ) |
Returns the page width in units.
- Parameters
-
$pagenum (int) page number (empty = current page)
- Returns
- int page width.
- Since
- 1.5.2
- See also
- getPageDimensions()
Definition at line 2501 of file tcpdf.php.
2501 {
2502 if (empty($pagenum)) {
2504 }
2505 return $this->pagedim[$pagenum]['w'];
2506 }
References $w.
◆ getPDFData()
| TCPDF::getPDFData | ( | ) |
◆ getRawCharWidth()
| TCPDF::getRawCharWidth | ( | $char | ) |
Returns the length of the char in user unit for the current font.
- Parameters
-
$char (int) The char code whose length is to be returned
- Returns
- float char width
- Since
- 5.9.000 (2010-09-28)
Definition at line 4109 of file tcpdf.php.
4109 {
4110 if ($char == 173) {
4111 // SHY character will not be printed
4112 return (0);
4113 }
4114 if (isset($this->CurrentFont['cw'][$char])) {
4116 } elseif (isset($this->CurrentFont['dw'])) {
4117 // default width
4119 } elseif (isset($this->CurrentFont['cw'][32])) {
4120 // default width
4122 } else {
4123 $w = 600;
4124 }
4126 }
References $w, and getAbsFontMeasure().
Referenced by GetCharWidth().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getRemainingWidth()
|
protected |
Returns the remaining width between the current position and margins.
- Returns
- int Return the remaining width
Definition at line 6703 of file tcpdf.php.
6703 {
6704 list($this->x, $this->y) = $this->checkPageRegions(0, $this->x, $this->y);
6705 if ($this->rtl) {
6706 return ($this->x - $this->lMargin);
6707 } else {
6708 return ($this->w - $this->rMargin - $this->x);
6709 }
6710 }
References checkPageRegions().
Referenced by Write().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getRTL()
| TCPDF::getRTL | ( | ) |
Return the RTL status.
- Returns
- boolean
- Since
- 4.0.012 (2008-07-24)
Definition at line 2364 of file tcpdf.php.
2364 {
2366 }
References $rtl.
Referenced by Footer(), and Header().
Here is the caller graph for this function:
◆ getScaleFactor()
| TCPDF::getScaleFactor | ( | ) |
◆ getSignatureAppearanceArray()
|
protected |
Get the array that defines the signature appearance (page and rectangle coordinates).
- Parameters
-
$x (float) Abscissa of the upper-left corner. $y (float) Ordinate of the upper-left corner. $w (float) Width of the signature area. $h (float) Height of the signature area. $page (int) option page number (if < 0 the current page is used). $name (string) Name of the signature.
- Returns
- (array) Array defining page and rectangle coordinates of signature appearance.
- Since
- 5.9.101 (2011-07-06)
Definition at line 13485 of file tcpdf.php.
13485 {
13486 $sigapp = array();
13489 } else {
13491 }
13492 if (empty($name)) {
13493 $sigapp['name'] = 'Signature';
13494 } else {
13495 $sigapp['name'] = $name;
13496 }
13502 return $sigapp;
13503 }
References $d, $h, $k, $page, $w, $x, $y, and sprintf.
Referenced by addEmptySignatureAppearance(), and setSignatureAppearance().
Here is the caller graph for this function:
◆ getSpaceString()
|
protected |
Returns the string used to find spaces.
- Returns
- string
- Since
- 4.8.024 (2010-01-15)
Definition at line 17037 of file tcpdf.php.
17037 {
17038 $spacestr = chr(32);
17040 $spacestr = chr(0).chr(32);
17041 }
17042 return $spacestr;
17043 }
References isUnicodeFont().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getStringHeight()
| 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:
- Precondition
- // store current object $pdf->startTransaction(); // store starting values $start_y = $pdf->GetY(); $start_page = $pdf->getPage(); // call your printing functions with your parameters // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - $pdf->MultiCell($w=0, $h=0, $txt, $border=1, $align='L', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0); // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // get the new Y $end_y = $pdf->GetY(); $end_page = $pdf->getPage(); // calculate height $height = 0; if ($end_page == $start_page) { $height = $end_y - $start_y; } else { for ($page=$start_page; $page <= $end_page; ++$page) { $this->setPage($page); if ($page == $start_page) { // first page $height = $this->h - $start_y - $this->bMargin; } elseif ($page == $end_page) { // last page $height = $end_y - $this->tMargin; } else { $height = $this->h - $this->tMargin - $this->bMargin; } } } // restore previous object $pdf = $pdf->rollbackTransaction();
- Parameters
-
$w (float) Width of cells. If 0, they extend up to the right margin of the page. $txt (string) String for calculating his height $reseth (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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
- Returns
- float Return the minimal height needed for multicell method for printing the $txt param.
Definition at line 6239 of file tcpdf.php.
6239 {
6240 // adjust internal padding
6241 $prev_cell_padding = $this->cell_padding;
6242 $prev_lasth = $this->lasth;
6243 if (is_array($cellpadding)) {
6244 $this->cell_padding = $cellpadding;
6245 }
6248 $height = $this->getCellHeight(($lines * $this->FontSize), $autopadding);
6249 $this->cell_padding = $prev_cell_padding;
6250 $this->lasth = $prev_lasth;
6251 return $height;
6252 }
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() met...
Definition: tcpdf.php:6120
References $border, $cell_padding, $lasth, $txt, $w, adjustCellPadding(), getCellHeight(), and getNumLines().
Referenced by MultiCell().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ GetStringWidth()
| TCPDF::GetStringWidth | ( | $s, | |
$fontname = '', |
|||
$fontstyle = '', |
|||
$fontsize = 0, |
|||
$getarray = false |
|||
| ) |
Returns the length of a string in user unit.
A font must be selected.
- Parameters
-
$s (string) The string whose length is to be computed $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained. $fontstyle (string) Font style. Possible values are (case insensitive): - empty string: regular
- B: bold
- I: italic
- U: underline
- D: line-through
- O: overline
$fontsize (float) Font size in points. The default value is the current size. $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
- Returns
- mixed int total string length or array of characted widths
- Since
- 1.2
Definition at line 4032 of file tcpdf.php.
4032 {
4033 return $this->GetArrStringWidth(TCPDF_FONTS::utf8Bidi(TCPDF_FONTS::UTF8StringToArray($s, $this->isunicode, $this->CurrentFont), $s, $this->tmprtl, $this->isunicode, $this->CurrentFont), $fontname, $fontstyle, $fontsize, $getarray);
4034 }
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:
◆ getTextShadow()
| TCPDF::getTextShadow | ( | ) |
◆ GetX()
| 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.
- Returns
- float
- Since
- 1.2
Definition at line 7401 of file tcpdf.php.
7401 {
7402 //Get x position
7403 if ($this->rtl) {
7404 return ($this->w - $this->x);
7405 } else {
7407 }
7408 }
References $x.
Referenced by Bookmark(), MultiCell(), MYPDF\MultiRow(), openHTMLTagHandler(), and setDestination().
Here is the caller graph for this function:
◆ GetY()
| TCPDF::GetY | ( | ) |
Returns the ordinate of the current position.
- Returns
- float
- Since
- 1.0
Definition at line 7428 of file tcpdf.php.
References $y.
Referenced by Bookmark(), MultiCell(), MYPDF\MultiRow(), openHTMLTagHandler(), and setDestination().
Here is the caller graph for this function:
◆ Gradient()
| TCPDF::Gradient | ( | $type, | |
| $coords, | |||
| $stops, | |||
$background = array(), |
|||
$antialias = false |
|||
| ) |
Output gradient.
- Parameters
-
$type (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported) $coords (array) 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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14470 of file tcpdf.php.
14470 {
14471 if ($this->pdfa_mode OR ($this->state != 2)) {
14472 return;
14473 }
14474 $n = count($this->gradients) + 1;
14475 $this->gradients[$n] = array();
14481 // color space
14482 $numcolspace = count($stops[0]['color']);
14483 $bcolor = array_values($background);
14484 switch($numcolspace) {
14485 case 5: // SPOT
14486 case 4: { // CMYK
14488 if (!empty($background)) {
14489 $this->gradients[$n]['background'] = sprintf('%F %F %F %F', $bcolor[0]/100, $bcolor[1]/100, $bcolor[2]/100, $bcolor[3]/100);
14490 }
14491 break;
14492 }
14493 case 3: { // RGB
14495 if (!empty($background)) {
14496 $this->gradients[$n]['background'] = sprintf('%F %F %F', $bcolor[0]/255, $bcolor[1]/255, $bcolor[2]/255);
14497 }
14498 break;
14499 }
14500 case 1: { // GRAY SCALE
14502 if (!empty($background)) {
14504 }
14505 break;
14506 }
14507 }
14508 $num_stops = count($stops);
14509 $last_stop_id = $num_stops - 1;
14510 foreach ($stops as $key => $stop) {
14512 // offset represents a location along the gradient vector
14513 if (isset($stop['offset'])) {
14515 } else {
14516 if ($key == 0) {
14518 } elseif ($key == $last_stop_id) {
14520 } else {
14521 $offsetstep = (1 - $this->gradients[$n]['colors'][($key - 1)]['offset']) / ($num_stops - $key);
14522 $this->gradients[$n]['colors'][$key]['offset'] = $this->gradients[$n]['colors'][($key - 1)]['offset'] + $offsetstep;
14523 }
14524 }
14525 if (isset($stop['opacity'])) {
14527 if ((!$this->pdfa_mode) AND ($stop['opacity'] < 1)) {
14529 }
14530 } else {
14532 }
14533 // exponent for the exponential interpolation function
14534 if (isset($stop['exponent'])) {
14536 } else {
14538 }
14539 // set colors
14540 $color = array_values($stop['color']);
14541 switch($numcolspace) {
14542 case 5: // SPOT
14543 case 4: { // CMYK
14544 $this->gradients[$n]['colors'][$key]['color'] = sprintf('%F %F %F %F', $color[0]/100, $color[1]/100, $color[2]/100, $color[3]/100);
14545 break;
14546 }
14547 case 3: { // RGB
14548 $this->gradients[$n]['colors'][$key]['color'] = sprintf('%F %F %F', $color[0]/255, $color[1]/255, $color[2]/255);
14549 break;
14550 }
14551 case 1: { // GRAY SCALE
14553 break;
14554 }
14555 }
14556 }
14558 // paint luminosity gradient
14560 }
14561 //paint the gradient
14563 //restore previous Graphic State
14564 $this->_outRestoreGraphicsState();
14565 if ($this->inxobj) {
14566 // we are inside an XObject template
14568 }
14569 }
References $coords, $n, $xobjid, _out(), _outRestoreGraphicsState(), and sprintf.
Referenced by LinearGradient(), and RadialGradient().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Header()
| 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.
Reimplemented in MYPDF, MYPDF, and TOC_TCPDF.
Definition at line 3392 of file tcpdf.php.
3392 {
3393 if ($this->header_xobjid === false) {
3394 // start a new XObject Template
3395 $this->header_xobjid = $this->startTemplate($this->w, $this->tMargin);
3396 $headerfont = $this->getHeaderFont();
3397 $headerdata = $this->getHeaderData();
3398 $this->y = $this->header_margin;
3399 if ($this->rtl) {
3400 $this->x = $this->w - $this->original_rMargin;
3401 } else {
3402 $this->x = $this->original_lMargin;
3403 }
3406 if (($imgtype == 'eps') OR ($imgtype == 'ai')) {
3408 } elseif ($imgtype == 'svg') {
3410 } else {
3412 }
3413 $imgy = $this->getImageRBY();
3414 } else {
3415 $imgy = $this->y;
3416 }
3417 $cell_height = $this->getCellHeight($headerfont[2] / $this->k);
3418 // set starting margin for text data cell
3420 $header_x = $this->original_rMargin + ($headerdata['logo_width'] * 1.1);
3421 } else {
3422 $header_x = $this->original_lMargin + ($headerdata['logo_width'] * 1.1);
3423 }
3424 $cw = $this->w - $this->original_lMargin - $this->original_rMargin - ($headerdata['logo_width'] * 1.1);
3425 $this->SetTextColorArray($this->header_text_color);
3426 // header title
3428 $this->SetX($header_x);
3430 // header string
3431 $this->SetFont($headerfont[0], $headerfont[1], $headerfont[2]);
3432 $this->SetX($header_x);
3433 $this->MultiCell($cw, $cell_height, $headerdata['string'], 0, '', 0, 1, '', '', true, 0, false, true, 0, 'T', false);
3434 // print an ending header line
3435 $this->SetLineStyle(array('width' => 0.85 / $this->k, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $headerdata['line_color']));
3436 $this->SetY((2.835 / $this->k) + max($imgy, $this->y));
3437 if ($this->rtl) {
3438 $this->SetX($this->original_rMargin);
3439 } else {
3440 $this->SetX($this->original_lMargin);
3441 }
3442 $this->Cell(($this->w - $this->original_lMargin - $this->original_rMargin), 0, '', 'T', 0, 'C');
3443 $this->endTemplate();
3444 }
3445 // print header template
3446 $x = 0;
3447 $dx = 0;
3448 if (!$this->header_xobj_autoreset AND $this->booklet AND (($this->page % 2) == 0)) {
3449 // adjust margins for booklet mode
3450 $dx = ($this->original_lMargin - $this->original_rMargin);
3451 }
3452 if ($this->rtl) {
3453 $x = $this->w + $dx;
3454 } else {
3455 $x = 0 + $dx;
3456 }
3458 if ($this->header_xobj_autoreset) {
3459 // reset header xobject template at each page
3460 $this->header_xobjid = false;
3461 }
3462 }
static getImageFileType($imgfile, $iminfo=array())
Return the image type given the file name or array returned by getimagesize() function.
Definition: tcpdf_images.php:71
getImageRBY()
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image.
Definition: tcpdf.php:3366
printTemplate($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false)
Print an XObject Template.
Definition: tcpdf.php:22334
ImageSVG($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false)
Embedd a Scalable Vector Graphics (SVG) image.
Definition: tcpdf.php:22687
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.
Definition: tcpdf.php:5757
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.
Definition: tcpdf.php:14834
References $header_margin, $original_lMargin, $original_rMargin, $x, $y, Cell(), endTemplate(), getCellHeight(), getHeaderData(), getHeaderFont(), TCPDF_IMAGES\getImageFileType(), getImageRBY(), getRTL(), Image(), ImageEps(), ImageSVG(), K_BLANK_IMAGE, K_PATH_IMAGES, 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:
◆ hyphenateText()
| TCPDF::hyphenateText | ( | $text, | |
| $patterns, | |||
$dictionary = array(), |
|||
$leftmin = 1, |
|||
$rightmin = 2, |
|||
$charmin = 1, |
|||
$charmax = 8 |
|||
| ) |
Returns text with soft hyphens.
- Parameters
-
$text (string) text to process $patterns (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/ $dictionary (array) Array of words to be returned without applying the hyphenation algorithm. $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 algorithm. $charmax (int) Maximum length of broken piece of word.
- Returns
- array text with soft hyphens
- Since
- 4.9.012 (2010-04-12)
Definition at line 22042 of file tcpdf.php.
22042 {
22044 $word = array(); // last word
22045 $txtarr = array(); // text to be returned
22046 $intag = false; // true if we are inside an HTML tag
22047 $skip = false; // true to skip hyphenation
22048 if (!is_array($patterns)) {
22049 $patterns = TCPDF_STATIC::getHyphenPatternsFromTEX($patterns);
22050 }
22051 // get array of characters
22053 // for each char
22054 foreach ($unichars as $char) {
22056 // letter character
22057 $word[] = $char;
22058 } else {
22059 // other type of character
22061 // hypenate the word
22062 $txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
22063 $word = array();
22064 }
22065 $txtarr[] = $char;
22066 if (chr($char) == '<') {
22067 // we are inside an HTML tag
22068 $intag = true;
22069 } elseif ($intag AND (chr($char) == '>')) {
22070 // end of HTML tag
22071 $intag = false;
22072 // check for style tag
22073 $expected = array(115, 116, 121, 108, 101); // = 'style'
22074 $current = array_slice($txtarr, -6, 5); // last 5 chars
22075 $compare = array_diff($expected, $current);
22076 if (empty($compare)) {
22077 // check if it is a closing tag
22078 $expected = array(47); // = '/'
22079 $current = array_slice($txtarr, -7, 1);
22080 $compare = array_diff($expected, $current);
22081 if (empty($compare)) {
22082 // closing style tag
22083 $skip = false;
22084 } else {
22085 // opening style tag
22086 $skip = true;
22087 }
22088 }
22089 }
22090 }
22091 }
22093 // hypenate the word
22094 $txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
22095 }
22096 // convert char array to string and return
22098 }
static UTF8ArrSubString($strarr, $start='', $end='', $unicode=true)
Extract a slice of the $strarr array and return it as string.
Definition: tcpdf_fonts.php:1794
static getHyphenPatternsFromTEX($file)
Returns an array of hyphenation patterns.
Definition: tcpdf_static.php:1522
hyphenateWord($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8)
Returns an array of chars containing soft hyphens.
Definition: tcpdf.php:21962
References $text, 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:
◆ hyphenateWord()
|
protected |
Returns an array of chars containing soft hyphens.
- Parameters
-
$word (array) array of chars $patterns (array) Array of hypenation patterns. $dictionary (array) Array of words to be returned without applying the hyphenation algorithm. $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 algorithm. $charmax (int) Maximum length of broken piece of word.
- Returns
- array text with soft hyphens
- Since
- 4.9.012 (2010-04-12)
Definition at line 21962 of file tcpdf.php.
21962 {
21963 $hyphenword = array(); // hyphens positions
21964 $numchars = count($word);
21965 if ($numchars <= $charmin) {
21966 return $word;
21967 }
21969 // some words will be returned as-is
21970 $pattern = '/^([a-zA-Z0-9_\.\-]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/';
21971 if (preg_match($pattern, $word_string) > 0) {
21972 // email
21973 return $word;
21974 }
21975 $pattern = '/(([a-zA-Z0-9\-]+\.)?)((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/';
21976 if (preg_match($pattern, $word_string) > 0) {
21977 // URL
21978 return $word;
21979 }
21980 if (isset($dictionary[$word_string])) {
21981 return TCPDF_FONTS::UTF8StringToArray($dictionary[$word_string], $this->isunicode, $this->CurrentFont);
21982 }
21983 // surround word with '_' characters
21984 $tmpword = array_merge(array(46), $word, array(46));
21985 $tmpnumchars = $numchars + 2;
21986 $maxpos = $tmpnumchars - 1;
21987 for ($pos = 0; $pos < $maxpos; ++$pos) {
21988 $imax = min(($tmpnumchars - $pos), $charmax);
21989 for ($i = 1; $i <= $imax; ++$i) {
21990 $subword = strtolower(TCPDF_FONTS::UTF8ArrSubString($tmpword, $pos, ($pos + $i), $this->isunicode));
21991 if (isset($patterns[$subword])) {
21992 $pattern = TCPDF_FONTS::UTF8StringToArray($patterns[$subword], $this->isunicode, $this->CurrentFont);
21993 $pattern_length = count($pattern);
21994 $digits = 1;
21995 for ($j = 0; $j < $pattern_length; ++$j) {
21996 // check if $pattern[$j] is a number = hyphenation level (only numbers from 1 to 5 are valid)
21997 if (($pattern[$j] >= 48) AND ($pattern[$j] <= 57)) {
21998 if ($j == 0) {
21999 $zero = $pos - 1;
22000 } else {
22001 $zero = $pos + $j - $digits;
22002 }
22003 // get hyphenation level
22004 $level = ($pattern[$j] - 48);
22005 // if two levels from two different patterns match at the same point, the higher one is selected.
22006 if (!isset($hyphenword[$zero]) OR ($hyphenword[$zero] < $level)) {
22007 $hyphenword[$zero] = $level;
22008 }
22009 ++$digits;
22010 }
22011 }
22012 }
22013 }
22014 }
22015 $inserted = 0;
22016 $maxpos = $numchars - $rightmin;
22017 for ($i = $leftmin; $i <= $maxpos; ++$i) {
22018 // only odd levels indicate allowed hyphenation points
22019 if (isset($hyphenword[$i]) AND (($hyphenword[$i] % 2) != 0)) {
22020 // 173 = soft hyphen character
22021 array_splice($word, $i + $inserted, 0, 173);
22022 ++$inserted;
22023 }
22024 }
22025 return $word;
22026 }
References TCPDF_FONTS\UTF8ArrSubString(), and TCPDF_FONTS\UTF8StringToArray().
Here is the call graph for this function:
◆ Image()
| 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:
- explicit width and height (expressed in user unit)
- one explicit dimension, the other being calculated automatically in order to keep the original proportions
- no explicit dimension, in which case the image is put at 72 dpi
Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
- Parameters
-
$file (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg'). $x (float) 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: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$resize (mixed) 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: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$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.
- Returns
- image information
- Since
- 1.1
Definition at line 6828 of file tcpdf.php.
6828 {
6829 if ($this->state != 2) {
6830 return;
6831 }
6834 }
6837 }
6838 // check page for no-write regions and adapt page margins if necessary
6840 $exurl = ''; // external streams
6841 $imsize = FALSE;
6842 // check if we are passing an image as file or string
6844 // image from string
6846 } else { // image file
6848 // image as external stream
6850 $exurl = $file;
6851 }
6852 // check if is a local file
6854 // try to encode spaces on filename
6856 if (@file_exists($tfile)) {
6857 $file = $tfile;
6858 }
6859 }
6862 // get existing image data
6867 }
6868 }
6869 }
6871 // copy image to cache
6872 $original_file = $file;
6875 if (!$fp) {
6877 }
6878 fwrite($fp, $imgdata);
6879 fclose($fp);
6880 unset($imgdata);
6881 $imsize = @getimagesize($file);
6882 if ($imsize === FALSE) {
6883 unlink($file);
6884 $file = $original_file;
6885 }
6886 }
6887 if ($imsize === FALSE) {
6889 // get measures from specified data
6892 $imsize = array($pw, $ph);
6893 } else {
6895 }
6896 }
6897 // file hash
6898 $filehash = md5($file);
6899 // get original image width and height in pixels
6900 list($pixw, $pixh) = $imsize;
6901 // calculate image width and height on document
6903 // convert image size to document unit
6906 } elseif ($w <= 0) {
6908 } elseif ($h <= 0) {
6911 if (strlen($fitbox) !== 2) {
6912 // set default alignment
6913 $fitbox = '--';
6914 }
6915 // scale image dimensions proportionally to fit within the ($w, $h) box
6917 // store current height
6918 $oldh = $h;
6919 // calculate new height
6921 // height difference
6922 $hdiff = ($oldh - $h);
6923 // vertical alignment
6924 switch (strtoupper($fitbox[1])) {
6925 case 'T': {
6926 break;
6927 }
6928 case 'M': {
6929 $y += ($hdiff / 2);
6930 break;
6931 }
6932 case 'B': {
6933 $y += $hdiff;
6934 break;
6935 }
6936 }
6937 } else {
6938 // store current width
6939 $oldw = $w;
6940 // calculate new width
6942 // width difference
6943 $wdiff = ($oldw - $w);
6944 // horizontal alignment
6945 switch (strtoupper($fitbox[0])) {
6946 case 'L': {
6947 if ($this->rtl) {
6948 $x -= $wdiff;
6949 }
6950 break;
6951 }
6952 case 'C': {
6953 if ($this->rtl) {
6954 $x -= ($wdiff / 2);
6955 } else {
6956 $x += ($wdiff / 2);
6957 }
6958 break;
6959 }
6960 case 'R': {
6961 if (!$this->rtl) {
6962 $x += $wdiff;
6963 }
6964 break;
6965 }
6966 }
6967 }
6968 }
6969 // fit the image on available space
6971 // calculate new minimum dimensions in pixels
6974 // check if resize is necessary (resize is used only to reduce the image)
6975 $newsize = ($neww * $newh);
6976 $pixsize = ($pixw * $pixh);
6977 if (intval($resize) == 2) {
6978 $resize = true;
6979 } elseif ($newsize >= $pixsize) {
6980 $resize = false;
6981 }
6982 // check if image has been already added on document
6983 $newimage = true;
6985 $newimage = false;
6986 // get existing image data
6989 // check if the newer image is larger
6991 if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
6992 $newimage = true;
6993 }
6994 }
6995 } elseif (($ismask === false) AND ($imgmask === false) AND (strpos($file, '__tcpdf_'.$this->file_id.'_imgmask_') === FALSE)) {
6996 // create temp image file (without alpha channel)
6998 // create temp alpha file
7000 // check for cached images
7001 if (in_array($tempfile_plain, $this->imagekeys)) {
7002 // get existing image data
7004 // check if the newer image is larger
7006 if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
7007 $newimage = true;
7008 } else {
7009 $newimage = false;
7010 // embed mask image
7011 $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false);
7012 // embed image, masked with previously embedded mask
7013 return $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask);
7014 }
7015 }
7016 }
7017 if ($newimage) {
7018 //First use of image, get info
7019 $type = strtolower($type);
7020 if ($type == '') {
7022 } elseif ($type == 'jpg') {
7023 $type = 'jpeg';
7024 }
7025 $mqr = TCPDF_STATIC::get_mqr();
7027 // Specific image handlers (defined on TCPDF_IMAGES CLASS)
7028 $mtd = '_parse'.$type;
7029 // GD image handler function
7030 $gdfunction = 'imagecreatefrom'.$type;
7032 if ((method_exists('TCPDF_IMAGES', $mtd)) AND (!($resize AND (function_exists($gdfunction) OR extension_loaded('imagick'))))) {
7033 // TCPDF image functions
7035 if (($ismask === false) AND ($imgmask === false) AND (strpos($file, '__tcpdf_'.$this->file_id.'_imgmask_') === FALSE)
7037 return $this->ImagePngAlpha($file, $x, $y, $pixw, $pixh, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign, $filehash);
7038 }
7039 }
7041 try {
7042 // GD library
7045 if ($resize) {
7046 $imgr = imagecreatetruecolor($neww, $newh);
7047 if (($type == 'gif') OR ($type == 'png')) {
7049 }
7050 imagecopyresampled($imgr, $img, 0, 0, 0, 0, $neww, $newh, $pixw, $pixh);
7051 $img = $imgr;
7052 }
7053 if (($type == 'gif') OR ($type == 'png')) {
7055 } else {
7056 $info = TCPDF_IMAGES::_toJPEG($img, $this->jpeg_quality, TCPDF_STATIC::getObjFilename('img', $this->file_id));
7057 }
7058 }
7059 } catch(Exception $e) {
7061 }
7062 }
7064 try {
7065 // ImageMagick library
7067 if ($type == 'svg') {
7069 // image from string
7070 $svgimg = substr($file, 1);
7071 } else {
7072 // get SVG file content
7074 }
7075 if ($svgimg !== FALSE) {
7076 // get width and height
7077 $regs = array();
7078 if (preg_match('/<svg([^>]*)>/si', $svgimg, $regs)) {
7079 $svgtag = $regs[1];
7080 $tmp = array();
7081 if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
7084 $svgtag = preg_replace('/[\s]+width[\s]*=[\s]*"[^"]*"/si', ' width="'.$owu.'"', $svgtag, 1);
7085 } else {
7086 $ow = $w;
7087 }
7088 $tmp = array();
7089 if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
7092 $svgtag = preg_replace('/[\s]+height[\s]*=[\s]*"[^"]*"/si', ' height="'.$ohu.'"', $svgtag, 1);
7093 } else {
7094 $oh = $h;
7095 }
7096 $tmp = array();
7097 if (!preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $svgtag, $tmp)) {
7098 $vbw = ($ow * $this->imgscale * $this->k);
7099 $vbh = ($oh * $this->imgscale * $this->k);
7101 $svgtag = $vbox.$svgtag;
7102 }
7103 $svgimg = preg_replace('/<svg([^>]*)>/si', '<svg'.$svgtag.'>', $svgimg, 1);
7104 }
7105 $img->readImageBlob($svgimg);
7106 }
7107 } else {
7109 }
7110 if ($resize) {
7112 }
7113 $img->setCompressionQuality($this->jpeg_quality);
7116 $img->writeImage($tempname);
7118 unlink($tempname);
7119 $img->destroy();
7120 } catch(Exception $e) {
7122 }
7123 }
7125 // unable to process image
7126 return;
7127 }
7128 TCPDF_STATIC::set_mqr($mqr);
7129 if ($ismask) {
7130 // force grayscale
7132 }
7133 if ($imgmask !== false) {
7135 }
7136 if (!empty($exurl)) {
7138 }
7139 // array of alternative images
7141 // add image to document
7143 }
7144 // set alignment
7146 // set alignment
7147 if ($this->rtl) {
7148 if ($palign == 'L') {
7149 $ximg = $this->lMargin;
7150 } elseif ($palign == 'C') {
7151 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
7152 } elseif ($palign == 'R') {
7153 $ximg = $this->w - $this->rMargin - $w;
7154 } else {
7156 }
7157 $this->img_rb_x = $ximg;
7158 } else {
7159 if ($palign == 'L') {
7160 $ximg = $this->lMargin;
7161 } elseif ($palign == 'C') {
7162 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
7163 } elseif ($palign == 'R') {
7164 $ximg = $this->w - $this->rMargin - $w;
7165 } else {
7166 $ximg = $x;
7167 }
7168 $this->img_rb_x = $ximg + $w;
7169 }
7170 if ($ismask OR $hidden) {
7171 // image is not displayed
7173 }
7174 $xkimg = $ximg * $this->k;
7175 if (!$alt) {
7176 // only non-alternative immages will be set
7177 $this->_out(sprintf('q %F 0 0 %F %F %F cm /I%u Do Q', ($w * $this->k), ($h * $this->k), $xkimg, (($this->h - ($y + $h)) * $this->k), $info['i']));
7178 }
7180 $bx = $this->x;
7181 $by = $this->y;
7182 $this->x = $ximg;
7183 if ($this->rtl) {
7184 $this->x += $w;
7185 }
7186 $this->y = $y;
7188 $this->x = $bx;
7189 $this->y = $by;
7190 }
7191 if ($link) {
7193 }
7194 // set pointer to align the next text/objects
7195 switch($align) {
7196 case 'T': {
7197 $this->y = $y;
7198 $this->x = $this->img_rb_x;
7199 break;
7200 }
7201 case 'M': {
7203 $this->x = $this->img_rb_x;
7204 break;
7205 }
7206 case 'B': {
7207 $this->y = $this->img_rb_y;
7208 $this->x = $this->img_rb_x;
7209 break;
7210 }
7211 case 'N': {
7212 $this->SetY($this->img_rb_y);
7213 break;
7214 }
7215 default:{
7216 break;
7217 }
7218 }
7219 $this->endlinex = $this->img_rb_x;
7220 if ($this->inxobj) {
7221 // we are inside an XObject template
7223 }
7225 }
static setGDImageTransparency($new_image, $image)
Set the transparency for the given GD image.
Definition: tcpdf_images.php:99
static _toPNG($image, $tempfile)
Convert the loaded image to a PNG and then return a structure for the PDF creator.
Definition: tcpdf_images.php:124
static _parsejpeg($file)
Extract info from a JPEG file without using the GD library.
Definition: tcpdf_images.php:162
static _toJPEG($image, $quality, $tempfile)
Convert the loaded image to a JPEG and then return a structure for the PDF creator.
Definition: tcpdf_images.php:147
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 Imagick or GD library.
Definition: tcpdf.php:7248
fitBlock($w, $h, $x, $y, $fitonpage=false)
Set the block dimensions accounting for page breaks and page/column fitting.
Definition: tcpdf.php:6723
References $border, $dpi, $file, $h, $img, $img_rb_x, $img_rb_y, $imgdata, $info, $k, $lMargin, $w, $x, $xobjid, $y, _out(), TCPDF_IMAGES\_parsejpeg(), TCPDF_IMAGES\_toJPEG(), TCPDF_IMAGES\_toPNG(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), TCPDF_STATIC\fopenLocal(), TCPDF_STATIC\get_mqr(), getHTMLUnitToUnits(), getImageBuffer(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getObjFilename(), Image(), ImagePngAlpha(), K_PATH_CACHE, Link(), pixelsToUnits(), TCPDF_STATIC\set_mqr(), TCPDF_IMAGES\setGDImageTransparency(), setImageBuffer(), SetY(), and sprintf.
Referenced by Annotation(), MYPDF\Header(), Header(), Image(), ImageEps(), ImagePngAlpha(), and openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ ImageEps()
| 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).
- Parameters
-
$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: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$palign (string) Allows to center or align the image on the current line. Possible values are: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$border (mixed) Indicates if borders must be drawn around the cell. The value can be a number: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$fitonpage (boolean) if true the image is resized to not exceed page dimensions. $fixoutvals (boolean) if true remove values outside the bounding box.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14834 of file tcpdf.php.
14834 {
14835 if ($this->state != 2) {
14836 return;
14837 }
14839 // convert EPS to raster image using GD or ImageMagick libraries
14840 return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
14841 }
14844 }
14847 }
14848 // check page for no-write regions and adapt page margins if necessary
14853 } else { // EPS/AI file
14855 }
14858 }
14859 $regs = array();
14860 // EPS/AI compatibility check (only checks files created by Adobe Illustrator!)
14862 if (count($regs) > 1) {
14864 if (strpos($version_str, 'Adobe Illustrator') !== false) {
14865 $versexp = explode(' ', $version_str);
14866 $version = (float)array_pop($versexp);
14869 }
14870 }
14871 }
14872 // strip binary bytes in front of PS-header
14876 }
14877 // find BoundingBox params
14879 if (count($regs) > 1) {
14880 list($x1, $y1, $x2, $y2) = explode(' ', trim($regs[1]));
14881 } else {
14883 }
14887 }
14890 }
14893 if ($end===false) {
14895 }
14896 if ($end) {
14898 }
14899 // calculate image width and height on document
14903 } elseif ($w <= 0) {
14905 } elseif ($h <= 0) {
14907 }
14908 // fit the image on available space
14910 if ($this->rasterize_vector_images) {
14911 // convert EPS to raster image using GD or ImageMagick libraries
14912 return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
14913 }
14914 // set scaling factors
14917 // set alignment
14919 // set alignment
14920 if ($this->rtl) {
14921 if ($palign == 'L') {
14922 $ximg = $this->lMargin;
14923 } elseif ($palign == 'C') {
14924 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
14925 } elseif ($palign == 'R') {
14926 $ximg = $this->w - $this->rMargin - $w;
14927 } else {
14929 }
14930 $this->img_rb_x = $ximg;
14931 } else {
14932 if ($palign == 'L') {
14933 $ximg = $this->lMargin;
14934 } elseif ($palign == 'C') {
14935 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
14936 } elseif ($palign == 'R') {
14937 $ximg = $this->w - $this->rMargin - $w;
14938 } else {
14939 $ximg = $x;
14940 }
14941 $this->img_rb_x = $ximg + $w;
14942 }
14943 if ($useBoundingBox) {
14944 $dx = $ximg * $k - $x1;
14946 } else {
14947 $dx = $ximg * $k;
14949 }
14950 // save the current graphic state
14952 // translate
14953 $this->_out(sprintf('%F %F %F %F %F %F cm', 1, 0, 0, 1, $dx, $dy + ($this->hPt - (2 * $y * $k) - ($y2 - $y1))));
14954 // scale
14955 if (isset($scale_x)) {
14956 $this->_out(sprintf('%F %F %F %F %F %F cm', $scale_x, 0, 0, $scale_y, $x1 * (1 - $scale_x), $y2 * (1 - $scale_y)));
14957 }
14958 // handle pc/unix/mac line endings
14960 $u=0;
14961 $cnt = count($lines);
14962 for ($i=0; $i < $cnt; ++$i) {
14963 $line = $lines[$i];
14964 if (($line == '') OR ($line[0] == '%')) {
14965 continue;
14966 }
14967 $len = strlen($line);
14968 // check for spot color names
14969 $color_name = '';
14970 if (strcasecmp('x', substr(trim($line), -1)) == 0) {
14971 if (preg_match('/\([^\)]*\)/', $line, $matches) > 0) {
14972 // extract spot color name
14973 $color_name = $matches[0];
14974 // remove color name from string
14975 $line = str_replace(' '.$color_name, '', $line);
14976 // remove pharentesis from color name
14977 $color_name = substr($color_name, 1, -1);
14978 }
14979 }
14980 $chunks = explode(' ', $line);
14981 $cmd = trim(array_pop($chunks));
14982 // RGB
14984 $b = array_pop($chunks);
14985 $g = array_pop($chunks);
14986 $r = array_pop($chunks);
14987 $this->_out(''.$r.' '.$g.' '.$b.' '.($cmd=='Xa'?'rg':'RG')); //substr($line, 0, -2).'rg' -> in EPS (AI8): c m y k r g b rg!
14988 continue;
14989 }
14990 $skip = false;
14991 if ($fixoutvals) {
14992 // check for values outside the bounding box
14994 case 'm':
14995 case 'l':
14996 case 'L': {
14997 // skip values outside bounding box
14998 foreach ($chunks as $key => $val) {
14999 if ((($key % 2) == 0) AND (($val < $x1) OR ($val > $x2))) {
15000 $skip = true;
15001 } elseif ((($key % 2) != 0) AND (($val < $y1) OR ($val > $y2))) {
15002 $skip = true;
15003 }
15004 }
15005 }
15006 }
15007 }
15009 case 'm':
15010 case 'l':
15011 case 'v':
15012 case 'y':
15013 case 'c':
15014 case 'k':
15015 case 'K':
15016 case 'g':
15017 case 'G':
15018 case 's':
15019 case 'S':
15020 case 'J':
15021 case 'j':
15022 case 'w':
15023 case 'M':
15024 case 'd':
15025 case 'n': {
15026 if ($skip) {
15027 break;
15028 }
15029 $this->_out($line);
15030 break;
15031 }
15032 case 'x': {// custom fill color
15033 if (empty($color_name)) {
15034 // CMYK color
15035 list($col_c, $col_m, $col_y, $col_k) = $chunks;
15037 } else {
15038 // Spot Color (CMYK + tint)
15039 list($col_c, $col_m, $col_y, $col_k, $col_t) = $chunks;
15040 $this->AddSpotColor($color_name, ($col_c * 100), ($col_m * 100), ($col_y * 100), ($col_k * 100));
15042 $this->_out($color_cmd);
15043 }
15044 break;
15045 }
15046 case 'X': { // custom stroke color
15047 if (empty($color_name)) {
15048 // CMYK color
15049 list($col_c, $col_m, $col_y, $col_k) = $chunks;
15051 } else {
15052 // Spot Color (CMYK + tint)
15053 list($col_c, $col_m, $col_y, $col_k, $col_t) = $chunks;
15054 $this->AddSpotColor($color_name, ($col_c * 100), ($col_m * 100), ($col_y * 100), ($col_k * 100));
15056 $this->_out($color_cmd);
15057 }
15058 break;
15059 }
15060 case 'Y':
15061 case 'N':
15062 case 'V':
15063 case 'L':
15064 case 'C': {
15065 if ($skip) {
15066 break;
15067 }
15068 $line[($len - 1)] = strtolower($cmd);
15069 $this->_out($line);
15070 break;
15071 }
15072 case 'b':
15073 case 'B': {
15075 break;
15076 }
15077 case 'f':
15078 case 'F': {
15079 if ($u > 0) {
15080 $isU = false;
15081 $max = min(($i + 5), $cnt);
15082 for ($j = ($i + 1); $j < $max; ++$j) {
15083 $isU = ($isU OR (($lines[$j] == 'U') OR ($lines[$j] == '*U')));
15084 }
15085 if ($isU) {
15087 }
15088 } else {
15090 }
15091 break;
15092 }
15093 case '*u': {
15094 ++$u;
15095 break;
15096 }
15097 case '*U': {
15098 --$u;
15099 break;
15100 }
15101 }
15102 }
15103 // restore previous graphic state
15106 $bx = $this->x;
15107 $by = $this->y;
15108 $this->x = $ximg;
15109 if ($this->rtl) {
15110 $this->x += $w;
15111 }
15112 $this->y = $y;
15114 $this->x = $bx;
15115 $this->y = $by;
15116 }
15117 if ($link) {
15119 }
15120 // set pointer to align the next text/objects
15121 switch($align) {
15122 case 'T':{
15123 $this->y = $y;
15124 $this->x = $this->img_rb_x;
15125 break;
15126 }
15127 case 'M':{
15129 $this->x = $this->img_rb_x;
15130 break;
15131 }
15132 case 'B':{
15133 $this->y = $this->img_rb_y;
15134 $this->x = $this->img_rb_x;
15135 break;
15136 }
15137 case 'N':{
15138 $this->SetY($this->img_rb_y);
15139 break;
15140 }
15141 default:{
15142 break;
15143 }
15144 }
15145 $this->endlinex = $this->img_rb_x;
15146 }
References $border, $cmd, $data, $file, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $r, $start, $version, $w, $x, $y, _out(), AddSpotColor(), Cell(), checkPageRegions(), e(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), Image(), Link(), SetY(), and sprintf.
Referenced by Header(), and openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ ImagePngAlpha()
|
protected |
Extract info from a PNG image with alpha channel using the Imagick or GD library.
- Parameters
-
$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: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$resize (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: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$filehash (string) File hash used to build unique file names.
- Since
- 4.3.007 (2008-12-04)
- See also
- Image()
Definition at line 7248 of file tcpdf.php.
7248 {
7249 // create temp images
7250 if (empty($filehash)) {
7251 $filehash = md5($file);
7252 }
7253 // create temp image file (without alpha channel)
7255 // create temp alpha file
7257 $parsed = false;
7258 $parse_error = '';
7259 // ImageMagick extension
7260 if (($parsed === false) AND extension_loaded('imagick')) {
7261 try {
7262 // ImageMagick library
7265 // clone image object
7267 // extract alpha channel
7268 if (method_exists($img, 'setImageAlphaChannel') AND defined('Imagick::ALPHACHANNEL_EXTRACT')) {
7269 $img->setImageAlphaChannel(Imagick::ALPHACHANNEL_EXTRACT);
7270 } else {
7271 $img->separateImageChannel(8); // 8 = (imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE);
7273 }
7275 $img->writeImage($tempfile_alpha);
7276 // remove alpha channel
7277 if (method_exists($imga, 'setImageMatte')) {
7278 $imga->setImageMatte(false);
7279 } else {
7280 $imga->separateImageChannel(39); // 39 = (imagick::CHANNEL_ALL & ~(imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE));
7281 }
7282 $imga->setImageFormat('png');
7283 $imga->writeImage($tempfile_plain);
7284 $parsed = true;
7285 } catch (Exception $e) {
7286 // Imagemagick fails, try with GD
7287 $parse_error = 'Imagick library error: '.$e->getMessage();
7288 }
7289 }
7290 // GD extension
7291 if (($parsed === false) AND function_exists('imagecreatefrompng')) {
7292 try {
7293 // generate images
7295 $imgalpha = imagecreate($wpx, $hpx);
7296 // generate gray scale palette (0 -> 255)
7297 for ($c = 0; $c < 256; ++$c) {
7298 ImageColorAllocate($imgalpha, $c, $c, $c);
7299 }
7300 // extract alpha channel
7301 for ($xpx = 0; $xpx < $wpx; ++$xpx) {
7302 for ($ypx = 0; $ypx < $hpx; ++$ypx) {
7303 $color = imagecolorat($img, $xpx, $ypx);
7304 // get and correct gamma color
7306 imagesetpixel($imgalpha, $xpx, $ypx, $alpha);
7307 }
7308 }
7309 imagepng($imgalpha, $tempfile_alpha);
7310 imagedestroy($imgalpha);
7311 // extract image without alpha channel
7312 $imgplain = imagecreatetruecolor($wpx, $hpx);
7313 imagecopy($imgplain, $img, 0, 0, 0, 0, $wpx, $hpx);
7314 imagepng($imgplain, $tempfile_plain);
7315 imagedestroy($imgplain);
7316 $parsed = true;
7317 } catch (Exception $e) {
7318 // GD fails
7319 $parse_error = 'GD library error: '.$e->getMessage();
7320 }
7321 }
7322 if ($parsed === false) {
7323 if (empty($parse_error)) {
7324 $this->Error('TCPDF requires the Imagick or GD extension to handle PNG images with alpha channel.');
7325 } else {
7326 $this->Error($parse_error);
7327 }
7328 }
7329 // embed mask image
7330 $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false);
7331 // embed image, masked with previously embedded mask
7332 $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask);
7333 }
getGDgamma($img, $c)
Get the GD-corrected PNG gamma value from alpha color.
Definition: tcpdf.php:7342
References $alpha, $dpi, $file, $h, $img, $w, $x, $y, defined, Error(), getGDgamma(), Image(), K_PATH_CACHE, and TCPDF_STATIC\objclone().
Referenced by Image().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ ImageSVG()
| 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.
- Parameters
-
$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: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$palign (string) Allows to center or align the image on the current line. Possible values are: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$border (mixed) Indicates if borders must be drawn around the cell. The value can be a number: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$fitonpage (boolean) if true the image is resized to not exceed page dimensions.
- Since
- 5.0.000 (2010-05-02)
Definition at line 22687 of file tcpdf.php.
22687 {
22688 if ($this->state != 2) {
22689 return;
22690 }
22691 // reset SVG vars
22692 $this->svggradients = array();
22693 $this->svggradientid = 0;
22694 $this->svgdefsmode = false;
22695 $this->svgdefs = array();
22696 $this->svgclipmode = false;
22697 $this->svgclippaths = array();
22698 $this->svgcliptm = array();
22699 $this->svgclipid = 0;
22700 $this->svgtext = '';
22701 $this->svgtextmode = array();
22703 // convert SVG to raster image using GD or ImageMagick libraries
22704 return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
22705 }
22707 $this->svgdir = '';
22708 $svgdata = substr($file, 1);
22709 } else { // SVG file
22710 $this->svgdir = dirname($file);
22712 }
22713 if ($svgdata === FALSE) {
22715 }
22718 }
22721 }
22722 // check page for no-write regions and adapt page margins if necessary
22725 $ox = 0;
22726 $oy = 0;
22727 $ow = $w;
22728 $oh = $h;
22729 $aspect_ratio_align = 'xMidYMid';
22730 $aspect_ratio_ms = 'meet';
22731 $regs = array();
22732 // get original image width and height
22733 preg_match('/<svg([^>]*)>/si', $svgdata, $regs);
22734 if (isset($regs[1]) AND !empty($regs[1])) {
22735 $tmp = array();
22736 if (preg_match('/[\s]+x[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22738 }
22739 $tmp = array();
22740 if (preg_match('/[\s]+y[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22742 }
22743 $tmp = array();
22744 if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22746 }
22747 $tmp = array();
22748 if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22750 }
22751 $tmp = array();
22752 $view_box = array();
22753 if (preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.\-]+)[\s]+([0-9\.\-]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $regs[1], $tmp)) {
22754 if (count($tmp) == 5) {
22755 array_shift($tmp);
22756 foreach ($tmp as $key => $val) {
22758 }
22759 $ox = $view_box[0];
22760 $oy = $view_box[1];
22761 }
22762 // get aspect ratio
22763 $tmp = array();
22764 if (preg_match('/[\s]+preserveAspectRatio[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22765 $aspect_ratio = preg_split('/[\s]+/si', $tmp[1]);
22766 switch (count($aspect_ratio)) {
22767 case 3: {
22768 $aspect_ratio_align = $aspect_ratio[1];
22769 $aspect_ratio_ms = $aspect_ratio[2];
22770 break;
22771 }
22772 case 2: {
22773 $aspect_ratio_align = $aspect_ratio[0];
22774 $aspect_ratio_ms = $aspect_ratio[1];
22775 break;
22776 }
22777 case 1: {
22778 $aspect_ratio_align = $aspect_ratio[0];
22779 $aspect_ratio_ms = 'meet';
22780 break;
22781 }
22782 }
22783 }
22784 }
22785 }
22786 if ($ow <= 0) {
22787 $ow = 1;
22788 }
22789 if ($oh <= 0) {
22790 $oh = 1;
22791 }
22792 // calculate image width and height on document
22794 // convert image size to document unit
22795 $w = $ow;
22796 $h = $oh;
22797 } elseif ($w <= 0) {
22799 } elseif ($h <= 0) {
22801 }
22802 // fit the image on available space
22804 if ($this->rasterize_vector_images) {
22805 // convert SVG to raster image using GD or ImageMagick libraries
22806 return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
22807 }
22808 // set alignment
22810 // set alignment
22811 if ($this->rtl) {
22812 if ($palign == 'L') {
22813 $ximg = $this->lMargin;
22814 } elseif ($palign == 'C') {
22815 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22816 } elseif ($palign == 'R') {
22817 $ximg = $this->w - $this->rMargin - $w;
22818 } else {
22820 }
22821 $this->img_rb_x = $ximg;
22822 } else {
22823 if ($palign == 'L') {
22824 $ximg = $this->lMargin;
22825 } elseif ($palign == 'C') {
22826 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22827 } elseif ($palign == 'R') {
22828 $ximg = $this->w - $this->rMargin - $w;
22829 } else {
22830 $ximg = $x;
22831 }
22832 $this->img_rb_x = $ximg + $w;
22833 }
22834 // store current graphic vars
22835 $gvars = $this->getGraphicVars();
22836 // store SVG position and scale factors
22837 $svgoffset_x = ($ximg - $ox) * $this->k;
22838 $svgoffset_y = -($y - $oy) * $this->k;
22839 if (isset($view_box[2]) AND ($view_box[2] > 0) AND ($view_box[3] > 0)) {
22840 $ow = $view_box[2];
22841 $oh = $view_box[3];
22842 } else {
22843 if ($ow <= 0) {
22844 $ow = $w;
22845 }
22846 if ($oh <= 0) {
22847 $oh = $h;
22848 }
22849 }
22850 $svgscale_x = $w / $ow;
22851 $svgscale_y = $h / $oh;
22852 // scaling and alignment
22853 if ($aspect_ratio_align != 'none') {
22854 // store current scaling values
22855 $svgscale_old_x = $svgscale_x;
22856 $svgscale_old_y = $svgscale_y;
22857 // force uniform scaling
22858 if ($aspect_ratio_ms == 'slice') {
22859 // the entire viewport is covered by the viewBox
22860 if ($svgscale_x > $svgscale_y) {
22861 $svgscale_y = $svgscale_x;
22862 } elseif ($svgscale_x < $svgscale_y) {
22863 $svgscale_x = $svgscale_y;
22864 }
22865 } else { // meet
22866 // the entire viewBox is visible within the viewport
22867 if ($svgscale_x < $svgscale_y) {
22868 $svgscale_y = $svgscale_x;
22869 } elseif ($svgscale_x > $svgscale_y) {
22870 $svgscale_x = $svgscale_y;
22871 }
22872 }
22873 // correct X alignment
22874 switch (substr($aspect_ratio_align, 1, 3)) {
22875 case 'Min': {
22876 // do nothing
22877 break;
22878 }
22879 case 'Max': {
22881 break;
22882 }
22883 default:
22884 case 'Mid': {
22886 break;
22887 }
22888 }
22889 // correct Y alignment
22890 switch (substr($aspect_ratio_align, 5)) {
22891 case 'Min': {
22892 // do nothing
22893 break;
22894 }
22895 case 'Max': {
22897 break;
22898 }
22899 default:
22900 case 'Mid': {
22902 break;
22903 }
22904 }
22905 }
22906 // store current page break mode
22907 $page_break_mode = $this->AutoPageBreak;
22908 $page_break_margin = $this->getBreakMargin();
22910 $this->SetCellPadding(0);
22912 // save the current graphic state
22914 // set initial clipping mask
22916 // scale and translate
22917 $e = $ox * $this->k * (1 - $svgscale_x);
22918 $f = ($this->h - $oy) * $this->k * (1 - $svgscale_y);
22919 $this->_out(sprintf('%F %F %F %F %F %F cm', $svgscale_x, 0, 0, $svgscale_y, ($e + $svgoffset_x), ($f + $svgoffset_y)));
22920 // creates a new XML parser to be used by the other XML functions
22921 $this->parser = xml_parser_create('UTF-8');
22922 // the following function allows to use parser inside object
22923 xml_set_object($this->parser, $this);
22924 // disable case-folding for this XML parser
22925 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
22926 // sets the element handler functions for the XML parser
22927 xml_set_element_handler($this->parser, 'startSVGElementHandler', 'endSVGElementHandler');
22928 // sets the character data handler function for the XML parser
22929 xml_set_character_data_handler($this->parser, 'segSVGContentHandler');
22930 // start parsing an XML document
22931 if (!xml_parse($this->parser, $svgdata)) {
22932 $error_message = sprintf('SVG Error: %s at line %d', xml_error_string(xml_get_error_code($this->parser)), xml_get_current_line_number($this->parser));
22933 $this->Error($error_message);
22934 }
22935 // free this XML parser
22936 xml_parser_free($this->parser);
22937 // restore previous graphic state
22939 // restore graphic vars
22940 $this->setGraphicVars($gvars);
22941 $this->lasth = $gvars['lasth'];
22943 $bx = $this->x;
22944 $by = $this->y;
22945 $this->x = $ximg;
22946 if ($this->rtl) {
22947 $this->x += $w;
22948 }
22949 $this->y = $y;
22951 $this->x = $bx;
22952 $this->y = $by;
22953 }
22954 if ($link) {
22956 }
22957 // set pointer to align the next text/objects
22958 switch($align) {
22959 case 'T':{
22960 $this->y = $y;
22961 $this->x = $this->img_rb_x;
22962 break;
22963 }
22964 case 'M':{
22966 $this->x = $this->img_rb_x;
22967 break;
22968 }
22969 case 'B':{
22970 $this->y = $this->img_rb_y;
22971 $this->x = $this->img_rb_x;
22972 break;
22973 }
22974 case 'N':{
22975 $this->SetY($this->img_rb_y);
22976 break;
22977 }
22978 default:{
22979 // restore pointer to starting position
22980 $this->x = $gvars['x'];
22981 $this->y = $gvars['y'];
22982 $this->page = $gvars['page'];
22983 $this->current_column = $gvars['current_column'];
22984 $this->tMargin = $gvars['tMargin'];
22985 $this->bMargin = $gvars['bMargin'];
22986 $this->w = $gvars['w'];
22987 $this->h = $gvars['h'];
22988 $this->wPt = $gvars['wPt'];
22989 $this->hPt = $gvars['hPt'];
22990 $this->fwPt = $gvars['fwPt'];
22991 $this->fhPt = $gvars['fhPt'];
22992 break;
22993 }
22994 }
22995 $this->endlinex = $this->img_rb_x;
22996 // restore page break
22997 $this->SetAutoPageBreak($page_break_mode, $page_break_margin);
22998 $this->cell_padding = $cell_padding;
22999 }
SetCellPadding($pad)
Set the same internal Cell padding for top, right, bottom, left-.
Definition: tcpdf.php:2627
References $border, $file, $h, $w, $x, $y, TCPDF_STATIC\fileGetContents(), and sprintf.
Referenced by Header(), and openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ IncludeJS()
| TCPDF::IncludeJS | ( | $script | ) |
◆ inPageBody()
|
protected |
Check if we are on the page body (excluding page header and footer).
- Returns
- true if we are not in page header nor in page footer, false otherwise.
- Since
- 5.9.091 (2011-06-15)
Definition at line 3613 of file tcpdf.php.
3613 {
3614 return (($this->InHeader === false) AND ($this->InFooter === false));
3615 }
Referenced by checkPageBreak(), MultiCell(), Write(), and writeHTML().
Here is the caller graph for this function:
◆ isCharDefined()
| TCPDF::isCharDefined | ( | $char, | |
$font = '', |
|||
$style = '' |
|||
| ) |
Return true in the character is present in the specified font.
- Parameters
-
$char (mixed) Character to check (integer value or string) $font (string) Font name (family name). $style (string) Font style.
- Returns
- (boolean) true if the char is defined, false otherwise.
- Since
- 5.9.153 (2012-03-28)
Definition at line 4608 of file tcpdf.php.
4608 {
4609 if (is_string($char)) {
4610 // get character code
4611 $char = TCPDF_FONTS::UTF8StringToArray($char, $this->isunicode, $this->CurrentFont);
4612 $char = $char[0];
4613 }
4616 return (isset($this->CurrentFont['cw'][intval($char)]));
4617 }
4618 $font = $this->FontFamily;
4619 }
4622 return (isset($fontinfo['cw'][intval($char)]));
4623 }
References $FontFamily, $style, 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:
◆ isRTLTextDir()
| TCPDF::isRTLTextDir | ( | ) |
Return the current temporary RTL status.
- Returns
- boolean
- Since
- 4.8.014 (2009-11-04)
Definition at line 2406 of file tcpdf.php.
2406 {
2407 return ($this->rtl OR ($this->tmprtl == 'R'));
2408 }
Referenced by Write(), and writeHTML().
Here is the caller graph for this function:
◆ isUnicodeFont()
| TCPDF::isUnicodeFont | ( | ) |
Return true if the current font is unicode type.
- Returns
- true for unicode font, false otherwise.
- Since
- 5.8.002 (2010-08-14)
Definition at line 22184 of file tcpdf.php.
22184 {
22185 return (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0'));
22186 }
Referenced by getAliasNbPages(), getAliasNumPage(), getAliasRightShift(), GetArrStringWidth(), getCellCode(), GetNumChars(), getPageGroupAlias(), getPageNumGroupAlias(), getSpaceString(), Write(), and writeHTML().
Here is the caller graph for this function:
◆ lastPage()
| TCPDF::lastPage | ( | $resetmargins = false | ) |
Reset pointer to the last document page.
- Parameters
-
$resetmargins (boolean) if true reset left, right, top margins and Y position.
- Since
- 2.0.000 (2008-01-04)
- See also
- setPage(), getPage(), getNumPages()
Definition at line 3042 of file tcpdf.php.
3042 {
3044 }
References getNumPages(), and setPage().
Here is the call graph for this function:
◆ Line()
| TCPDF::Line | ( | $x1, | |
| $y1, | |||
| $x2, | |||
| $y2, | |||
$style = array() |
|||
| ) |
Draws a line between two points.
- Parameters
-
$x1 (float) Abscissa of first point. $y1 (float) Ordinate of first point. $x2 (float) Abscissa of second point. $y2 (float) Ordinate of second point. $style (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array).
- Since
- 1.0
- See also
- SetLineWidth(), SetDrawColor(), SetLineStyle()
Definition at line 11481 of file tcpdf.php.
11481 {
11482 if ($this->state != 2) {
11483 return;
11484 }
11487 }
11488 $this->_outPoint($x1, $y1);
11489 $this->_outLine($x2, $y2);
11491 }
References $style, _out(), _outLine(), _outPoint(), and SetLineStyle().
Referenced by Arrow(), cropMark(), openHTMLTagHandler(), Rect(), and registrationMarkCMYK().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ LinearGradient()
| TCPDF::LinearGradient | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$col1 = array(), |
|||
$col2 = array(), |
|||
$coords = array(0,0,1,0) |
|||
| ) |
Paints a linear colour gradient.
- Parameters
-
$x (float) abscissa of the top left corner of the rectangle. $y (float) ordinate of the top left corner of the rectangle. $w (float) width of the rectangle. $h (float) height of the rectangle. $col1 (array) 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).
- Since
- 3.1.000 (2008-06-09)
Definition at line 14310 of file tcpdf.php.
14310 {
14312 $this->Gradient(2, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
14313 }
Gradient($type, $coords, $stops, $background=array(), $antialias=false)
Output gradient.
Definition: tcpdf.php:14470
References $coords, $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:
◆ Link()
| 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.
- Parameters
-
$x (float) Abscissa of the upper-left corner of the rectangle $y (float) Ordinate of the upper-left corner of the rectangle $w (float) Width of the rectangle $h (float) Height of the rectangle $link (mixed) URL or identifier returned by AddLink() $spaces (int) number of spaces on the text to link
- Since
- 1.5
- See also
- AddLink(), Annotation(), Cell(), Write(), Image()
Definition at line 4728 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:
◆ ListBox()
| TCPDF::ListBox | ( | $name, | |
| $w, | |||
| $h, | |||
| $values, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a List-box field.
- Parameters
-
$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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 12869 of file tcpdf.php.
12869 {
12872 }
12875 }
12876 // check page for no-write regions and adapt page margins if necessary
12880 $s = '';
12881 foreach ($values as $value) {
12882 if (is_array($value)) {
12883 $s .= ',[\''.addslashes($value[1]).'\',\''.addslashes($value[0]).'\']';
12884 } else {
12885 $s .= ',[\''.addslashes($value).'\',\''.addslashes($value).'\']';
12886 }
12887 }
12888 $this->javascript .= 'f'.$name.'.setItems('.substr($s, 1).');'."\n";
12889 return;
12890 }
12891 // get default style
12892 $prop = array_merge($this->getFormDefaultProp(), $prop);
12893 // get annotation data
12894 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12895 // set additional default values
12896 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12897 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12898 $popt['da'] = $fontstyle;
12899 // build appearance stream
12900 $popt['ap'] = array();
12901 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12902 $text = '';
12903 foreach($values as $item) {
12904 if (is_array($item)) {
12905 $text .= $item[1]."\n";
12906 } else {
12907 $text .= $item."\n";
12908 }
12909 }
12910 $tmpid = $this->startTemplate($w, $h, false);
12911 $this->MultiCell($w, $h, $text, 0, '', false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
12912 $this->endTemplate();
12913 --$this->n;
12914 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
12915 unset($this->xobjects[$tmpid]);
12916 $popt['ap']['n'] .= 'Q EMC';
12917 // merge options
12918 $opt = array_merge($popt, $opt);
12919 // set remaining annotation data
12920 $opt['Subtype'] = 'Widget';
12921 $opt['ft'] = 'Ch';
12922 $opt['t'] = $name;
12923 $opt['opt'] = $values;
12924 unset($opt['mk']['ca']);
12925 unset($opt['mk']['rc']);
12926 unset($opt['mk']['ac']);
12927 unset($opt['mk']['i']);
12928 unset($opt['mk']['ri']);
12929 unset($opt['mk']['ix']);
12930 unset($opt['mk']['if']);
12931 unset($opt['mk']['tp']);
12932 $this->Annotation($x, $y, $w, $h, $name, $opt, 0);
12933 if ($this->rtl) {
12934 $this->x -= $w;
12935 } else {
12936 $this->x += $w;
12937 }
12938 }
References $h, $js, $w, $x, $y, _addfield(), and checkPageRegions().
Here is the call graph for this function:
◆ Ln()
| 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.
- Parameters
-
$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
- Since
- 1.0
- See also
- Cell()
Definition at line 7367 of file tcpdf.php.
7367 {
7368 if (($this->num_columns > 1) AND ($this->y == $this->columns[$this->current_column]['y']) AND isset($this->columns[$this->current_column]['x']) AND ($this->x == $this->columns[$this->current_column]['x'])) {
7369 // revove vertical space from the top of the column
7370 return;
7371 }
7372 if ($cell) {
7373 if ($this->rtl) {
7374 $cellpadding = $this->cell_padding['R'];
7375 } else {
7376 $cellpadding = $this->cell_padding['L'];
7377 }
7378 } else {
7379 $cellpadding = 0;
7380 }
7381 if ($this->rtl) {
7382 $this->x = $this->w - $this->rMargin - $cellpadding;
7383 } else {
7384 $this->x = $this->lMargin + $cellpadding;
7385 }
7388 }
7389 $this->y += $h;
7390 $this->newline = true;
7391 }
Referenced by MC_TCPDF\ChapterBody(), MC_TCPDF\ChapterTitle(), MYPDF\ColoredTable(), Footer(), setRTL(), and writeHTML().
Here is the caller graph for this function:
◆ MirrorH()
| TCPDF::MirrorH | ( | $x = '' | ) |
Horizontal Mirroring.
- Parameters
-
$x (int) abscissa of the point. Default is current x position
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11066 of file tcpdf.php.
11066 {
11068 }
Scale($s_x, $s_y, $x='', $y='')
Vertical and horizontal non-proportional Scaling.
Definition: tcpdf.php:11033
Here is the call graph for this function:
◆ MirrorL()
| TCPDF::MirrorL | ( | $angle = 0, |
|
$x = '', |
|||
$y = '' |
|||
| ) |
Reflection against a straight line through point (x, y) with the gradient angle (angle).
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11102 of file tcpdf.php.
11102 {
11105 }
References $angle, $x, $y, Rotate(), and Scale().
Here is the call graph for this function:
◆ MirrorP()
| TCPDF::MirrorP | ( | $x = '', |
|
$y = '' |
|||
| ) |
Point reflection mirroring.
- Parameters
-
$x (int) abscissa of the point. Default is current x position $y (int) ordinate of the point. Default is current y position
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11089 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:
◆ MirrorV()
| TCPDF::MirrorV | ( | $y = '' | ) |
Verical Mirroring.
- Parameters
-
$y (int) ordinate of the point. Default is current y position
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11077 of file tcpdf.php.
Here is the call graph for this function:
◆ movePage()
| TCPDF::movePage | ( | $frompage, | |
| $topage | |||
| ) |
Move a page to a previous position.
- Parameters
-
$frompage (int) number of the source page $topage (int) number of the destination page (must be less than $frompage)
- Returns
- true in case of success, false in case of error.
- Since
- 4.5.000 (2009-01-02)
Definition at line 20851 of file tcpdf.php.
20851 {
20852 if (($frompage > $this->numpages) OR ($frompage <= $topage)) {
20853 return false;
20854 }
20855 if ($frompage == $this->page) {
20856 // close the page before moving it
20857 $this->endPage();
20858 }
20859 // move all page-related states
20860 $tmppage = $this->getPageBuffer($frompage);
20861 $tmppagedim = $this->pagedim[$frompage];
20862 $tmppagelen = $this->pagelen[$frompage];
20863 $tmpintmrk = $this->intmrk[$frompage];
20864 $tmpbordermrk = $this->bordermrk[$frompage];
20865 $tmpcntmrk = $this->cntmrk[$frompage];
20866 $tmppageobjects = $this->pageobjects[$frompage];
20867 if (isset($this->footerpos[$frompage])) {
20868 $tmpfooterpos = $this->footerpos[$frompage];
20869 }
20870 if (isset($this->footerlen[$frompage])) {
20871 $tmpfooterlen = $this->footerlen[$frompage];
20872 }
20873 if (isset($this->transfmrk[$frompage])) {
20874 $tmptransfmrk = $this->transfmrk[$frompage];
20875 }
20876 if (isset($this->PageAnnots[$frompage])) {
20877 $tmpannots = $this->PageAnnots[$frompage];
20878 }
20879 if (isset($this->newpagegroup) AND !empty($this->newpagegroup)) {
20880 for ($i = $frompage; $i > $topage; --$i) {
20881 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $frompage)) {
20882 --$this->pagegroups[$this->newpagegroup[$i]];
20883 break;
20884 }
20885 }
20886 for ($i = $topage; $i > 0; --$i) {
20887 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $topage)) {
20888 ++$this->pagegroups[$this->newpagegroup[$i]];
20889 break;
20890 }
20891 }
20892 }
20893 for ($i = $frompage; $i > $topage; --$i) {
20894 $j = $i - 1;
20895 // shift pages down
20897 $this->pagedim[$i] = $this->pagedim[$j];
20898 $this->pagelen[$i] = $this->pagelen[$j];
20899 $this->intmrk[$i] = $this->intmrk[$j];
20900 $this->bordermrk[$i] = $this->bordermrk[$j];
20901 $this->cntmrk[$i] = $this->cntmrk[$j];
20902 $this->pageobjects[$i] = $this->pageobjects[$j];
20903 if (isset($this->footerpos[$j])) {
20904 $this->footerpos[$i] = $this->footerpos[$j];
20905 } elseif (isset($this->footerpos[$i])) {
20906 unset($this->footerpos[$i]);
20907 }
20908 if (isset($this->footerlen[$j])) {
20909 $this->footerlen[$i] = $this->footerlen[$j];
20910 } elseif (isset($this->footerlen[$i])) {
20911 unset($this->footerlen[$i]);
20912 }
20913 if (isset($this->transfmrk[$j])) {
20914 $this->transfmrk[$i] = $this->transfmrk[$j];
20915 } elseif (isset($this->transfmrk[$i])) {
20916 unset($this->transfmrk[$i]);
20917 }
20918 if (isset($this->PageAnnots[$j])) {
20919 $this->PageAnnots[$i] = $this->PageAnnots[$j];
20920 } elseif (isset($this->PageAnnots[$i])) {
20921 unset($this->PageAnnots[$i]);
20922 }
20923 if (isset($this->newpagegroup[$j])) {
20924 $this->newpagegroup[$i] = $this->newpagegroup[$j];
20925 unset($this->newpagegroup[$j]);
20926 }
20927 if ($this->currpagegroup == $j) {
20928 $this->currpagegroup = $i;
20929 }
20930 }
20931 $this->setPageBuffer($topage, $tmppage);
20932 $this->pagedim[$topage] = $tmppagedim;
20933 $this->pagelen[$topage] = $tmppagelen;
20934 $this->intmrk[$topage] = $tmpintmrk;
20935 $this->bordermrk[$topage] = $tmpbordermrk;
20936 $this->cntmrk[$topage] = $tmpcntmrk;
20937 $this->pageobjects[$topage] = $tmppageobjects;
20938 if (isset($tmpfooterpos)) {
20939 $this->footerpos[$topage] = $tmpfooterpos;
20940 } elseif (isset($this->footerpos[$topage])) {
20941 unset($this->footerpos[$topage]);
20942 }
20943 if (isset($tmpfooterlen)) {
20944 $this->footerlen[$topage] = $tmpfooterlen;
20945 } elseif (isset($this->footerlen[$topage])) {
20946 unset($this->footerlen[$topage]);
20947 }
20948 if (isset($tmptransfmrk)) {
20949 $this->transfmrk[$topage] = $tmptransfmrk;
20950 } elseif (isset($this->transfmrk[$topage])) {
20951 unset($this->transfmrk[$topage]);
20952 }
20953 if (isset($tmpannots)) {
20954 $this->PageAnnots[$topage] = $tmpannots;
20955 } elseif (isset($this->PageAnnots[$topage])) {
20956 unset($this->PageAnnots[$topage]);
20957 }
20958 // adjust outlines
20959 $tmpoutlines = $this->outlines;
20960 foreach ($tmpoutlines as $key => $outline) {
20961 if (!$outline['f']) {
20962 if (($outline['p'] >= $topage) AND ($outline['p'] < $frompage)) {
20963 $this->outlines[$key]['p'] = ($outline['p'] + 1);
20964 } elseif ($outline['p'] == $frompage) {
20965 $this->outlines[$key]['p'] = $topage;
20966 }
20967 }
20968 }
20969 // adjust dests
20970 $tmpdests = $this->dests;
20971 foreach ($tmpdests as $key => $dest) {
20972 if (!$dest['f']) {
20973 if (($dest['p'] >= $topage) AND ($dest['p'] < $frompage)) {
20974 $this->dests[$key]['p'] = ($dest['p'] + 1);
20975 } elseif ($dest['p'] == $frompage) {
20976 $this->dests[$key]['p'] = $topage;
20977 }
20978 }
20979 }
20980 // adjust links
20981 $tmplinks = $this->links;
20982 foreach ($tmplinks as $key => $link) {
20983 if (!$link['f']) {
20984 if (($link['p'] >= $topage) AND ($link['p'] < $frompage)) {
20985 $this->links[$key]['p'] = ($link['p'] + 1);
20986 } elseif ($link['p'] == $frompage) {
20987 $this->links[$key]['p'] = $topage;
20988 }
20989 }
20990 }
20991 // adjust javascript
20992 $jfrompage = $frompage;
20993 $jtopage = $topage;
20994 if (preg_match_all('/this\.addField\(\'([^\']*)\',\'([^\']*)\',([0-9]+)/', $this->javascript, $pamatch) > 0) {
20995 foreach($pamatch[0] as $pk => $pmatch) {
20996 $pagenum = intval($pamatch[3][$pk]) + 1;
20997 if (($pagenum >= $jtopage) AND ($pagenum < $jfrompage)) {
20998 $newpage = ($pagenum + 1);
20999 } elseif ($pagenum == $jfrompage) {
21000 $newpage = $jtopage;
21001 } else {
21002 $newpage = $pagenum;
21003 }
21004 --$newpage;
21005 $newjs = "this.addField(\'".$pamatch[1][$pk]."\',\'".$pamatch[2][$pk]."\',".$newpage;
21006 $this->javascript = str_replace($pmatch, $newjs, $this->javascript);
21007 }
21008 unset($pamatch);
21009 }
21010 // return to last page
21012 return true;
21013 }
◆ MultiCell()
| 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.
- Parameters
-
$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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$align (string) Allows to center or align the text. Possible values are: - L or empty string: left align
- C: center
- R: right align
- J: justification (default value when $ishtml=false)
$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: - 0: to the right
- 1: to the beginning of the next line [DEFAULT]
- 2: below
$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: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
$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: - T: TOP
- M: middle
- B: bottom
$fitcell (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). $maxh must be greater than 0 and equal to $h.
- Returns
- int Return the number of cells or 1 for html mode.
- Since
- 1.3
- See also
- SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()
Definition at line 5757 of file tcpdf.php.
5757 {
5758 $prev_cell_margin = $this->cell_margin;
5759 $prev_cell_padding = $this->cell_padding;
5760 // adjust internal padding
5762 $mc_padding = $this->cell_padding;
5763 $mc_margin = $this->cell_margin;
5764 $this->cell_padding['T'] = 0;
5765 $this->cell_padding['B'] = 0;
5766 $this->setCellMargins(0, 0, 0, 0);
5768 // reset row height
5769 $this->resetLastH();
5770 }
5773 } else {
5775 }
5776 $resth = 0;
5777 if (($h > 0) AND $this->inPageBody() AND (($y + $h + $mc_margin['T'] + $mc_margin['B']) > $this->PageBreakTrigger)) {
5778 // spit cell in more pages/columns
5779 $newh = ($this->PageBreakTrigger - $y);
5781 $h = $newh;
5782 }
5783 // get current page number
5784 $startpage = $this->page;
5785 // get current column
5786 $startcolumn = $this->current_column;
5789 } else {
5791 }
5792 // check page for no-write regions and adapt page margins if necessary
5794 // apply margins
5796 if ($this->rtl) {
5798 } else {
5800 }
5801 $this->x = $ox;
5802 $this->y = $oy;
5803 // set width
5805 if ($this->rtl) {
5807 } else {
5809 }
5810 }
5811 // store original margin values
5814 if ($this->rtl) {
5815 $this->rMargin = ($this->w - $this->x);
5816 $this->lMargin = ($this->x - $w);
5817 } else {
5818 $this->lMargin = ($this->x);
5819 $this->rMargin = ($this->w - $this->x - $w);
5820 }
5821 $this->clMargin = $this->lMargin;
5822 $this->crMargin = $this->rMargin;
5823 if ($autopadding) {
5824 // add top padding
5825 $this->y += $mc_padding['T'];
5826 }
5827 if ($ishtml) { // ******* Write HTML text
5829 $nl = 1;
5830 } else { // ******* Write simple text
5831 $prev_FontSizePt = $this->FontSizePt;
5832 if ($fitcell) {
5833 // ajust height values
5834 $tobottom = ($this->h - $this->y - $this->bMargin - $this->cell_padding['T'] - $this->cell_padding['B']);
5836 }
5837 // vertical alignment
5838 if ($maxh > 0) {
5839 // get text height
5841 if ($fitcell AND ($text_height > $maxh) AND ($this->FontSizePt > 1)) {
5842 // try to reduce font size to fit text on cell (use a quick search algorithm)
5843 $fmin = 1;
5844 $fmax = $this->FontSizePt;
5846 $maxit = (2 * min(100, max(10, intval($fmax)))); // max number of iterations
5847 while ($maxit >= 0) {
5848 $fmid = (($fmax + $fmin) / 2);
5850 $this->resetLastH();
5852 $diff = ($maxh - $text_height);
5853 if ($diff >= 0) {
5854 if ($diff <= $diff_epsilon) {
5855 break;
5856 }
5857 $fmin = $fmid;
5858 } else {
5859 $fmax = $fmid;
5860 }
5861 --$maxit;
5862 }
5863 if ($maxit < 0) {
5864 // premature exit, we get the minimum font value to fit the cell
5865 $this->SetFontSize($fmin);
5866 $this->resetLastH();
5868 } else {
5869 $this->SetFontSize($fmid);
5870 $this->resetLastH();
5871 }
5872 }
5873 if ($text_height < $maxh) {
5874 if ($valign == 'M') {
5875 // text vertically centered
5876 $this->y += (($maxh - $text_height) / 2);
5877 } elseif ($valign == 'B') {
5878 // text vertically aligned on bottom
5879 $this->y += ($maxh - $text_height);
5880 }
5881 }
5882 }
5883 $nl = $this->Write($this->lasth, $txt, '', 0, $align, true, $stretch, false, true, $maxh, 0, $mc_margin);
5884 if ($fitcell) {
5885 // restore font size
5886 $this->SetFontSize($prev_FontSizePt);
5887 }
5888 }
5889 if ($autopadding) {
5890 // add bottom padding
5891 $this->y += $mc_padding['B'];
5892 }
5893 // Get end-of-text Y position
5894 $currentY = $this->y;
5895 // get latest page number
5896 $endpage = $this->page;
5897 if ($resth > 0) {
5898 $skip = ($endpage - $startpage);
5899 $tmpresth = $resth;
5900 while ($tmpresth > 0) {
5901 if ($skip <= 0) {
5902 // add a page (or trig AcceptPageBreak() for multicolumn mode)
5903 $this->checkPageBreak($this->PageBreakTrigger + 1);
5904 }
5905 if ($this->num_columns > 1) {
5906 $tmpresth -= ($this->h - $this->y - $this->bMargin);
5907 } else {
5908 $tmpresth -= ($this->h - $this->tMargin - $this->bMargin);
5909 }
5910 --$skip;
5911 }
5912 $currentY = $this->y;
5913 $endpage = $this->page;
5914 }
5915 // get latest column
5916 $endcolumn = $this->current_column;
5917 if ($this->num_columns == 0) {
5918 $this->num_columns = 1;
5919 }
5920 // disable page regions check
5922 $this->check_page_regions = false;
5923 // get border modes
5927 // design borders around HTML cells.
5929 $ccode = '';
5931 if ($this->num_columns < 2) {
5932 // single-column mode
5934 $this->y = $this->tMargin;
5935 }
5936 // account for margin changes
5940 } elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
5942 }
5943 }
5944 if ($startpage == $endpage) {
5945 // single page
5948 if ($this->rtl) {
5949 $this->x -= $mc_margin['R'];
5950 } else {
5951 $this->x += $mc_margin['L'];
5952 }
5953 if ($startcolumn == $endcolumn) { // single column
5954 $cborder = $border;
5956 $this->y = $oy;
5958 $cborder = $border_start;
5959 $this->y = $oy;
5962 $cborder = $border_end;
5965 $h = $resth;
5966 }
5967 } else { // middle column
5968 $cborder = $border_middle;
5970 $resth -= $h;
5971 }
5973 } // end for each column
5977 if ($this->rtl) {
5978 $this->x -= $mc_margin['R'];
5979 } else {
5980 $this->x += $mc_margin['L'];
5981 }
5983 $cborder = $border_start;
5984 $this->y = $oy;
5986 } else { // middle column
5987 $cborder = $border_middle;
5989 $resth -= $h;
5990 }
5992 } // end for each column
5996 if ($this->rtl) {
5997 $this->x -= $mc_margin['R'];
5998 } else {
5999 $this->x += $mc_margin['L'];
6000 }
6002 // end column
6003 $cborder = $border_end;
6006 $h = $resth;
6007 }
6008 } else {
6009 // middle column
6010 $cborder = $border_middle;
6012 $resth -= $h;
6013 }
6015 } // end for each column
6016 } else { // middle page
6019 if ($this->rtl) {
6020 $this->x -= $mc_margin['R'];
6021 } else {
6022 $this->x += $mc_margin['L'];
6023 }
6024 $cborder = $border_middle;
6026 $resth -= $h;
6028 } // end for each column
6029 }
6030 if ($cborder OR $fill) {
6031 $offsetlen = strlen($ccode);
6032 // draw border and fill
6033 if ($this->inxobj) {
6034 // we are inside an XObject template
6035 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
6036 $pagemarkkey = key($this->xobjects[$this->xobjid]['transfmrk']);
6039 } else {
6042 }
6044 $pstart = substr($pagebuff, 0, $pagemark);
6045 $pend = substr($pagebuff, $pagemark);
6047 } else {
6048 if (end($this->transfmrk[$this->page]) !== false) {
6049 $pagemarkkey = key($this->transfmrk[$this->page]);
6050 $pagemark = $this->transfmrk[$this->page][$pagemarkkey];
6051 $this->transfmrk[$this->page][$pagemarkkey] += $offsetlen;
6052 } elseif ($this->InFooter) {
6053 $pagemark = $this->footerpos[$this->page];
6054 $this->footerpos[$this->page] += $offsetlen;
6055 } else {
6056 $pagemark = $this->intmrk[$this->page];
6057 $this->intmrk[$this->page] += $offsetlen;
6058 }
6059 $pagebuff = $this->getPageBuffer($this->page);
6060 $pstart = substr($pagebuff, 0, $pagemark);
6061 $pend = substr($pagebuff, $pagemark);
6062 $this->setPageBuffer($this->page, $pstart.$ccode.$pend);
6063 }
6064 }
6065 } // end for each page
6066 // restore page regions check
6067 $this->check_page_regions = $check_page_regions;
6068 // Get end-of-cell Y position
6069 $currentY = $this->GetY();
6070 // restore previous values
6071 if ($this->num_columns > 1) {
6072 $this->selectColumn();
6073 } else {
6074 // restore original margins
6075 $this->lMargin = $lMargin;
6076 $this->rMargin = $rMargin;
6077 if ($this->page > $startpage) {
6078 // check for margin variations between pages (i.e. booklet mode)
6081 if (($dl != 0) OR ($dr != 0)) {
6082 $this->lMargin += $dl;
6083 $this->rMargin += $dr;
6084 }
6085 }
6086 }
6087 if ($ln > 0) {
6088 //Go to the beginning of the next line
6090 if ($ln == 2) {
6092 }
6093 } else {
6094 // go left or right by case
6095 $this->setPage($startpage);
6096 $this->y = $y;
6098 }
6099 $this->setContentMark();
6100 $this->cell_padding = $prev_cell_padding;
6101 $this->cell_margin = $prev_cell_margin;
6102 $this->clMargin = $this->lMargin;
6103 $this->crMargin = $this->rMargin;
6104 return $nl;
6105 }
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(...
Definition: tcpdf.php:6239
References $bMargin, $border, $cell_margin, $cell_padding, $check_page_regions, $column, $current_column, $FontSizePt, $h, $k, $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(), MYPDF\MultiRow(), TextField(), writeHTML(), and writeHTMLCell().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Open()
| 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
- Since
- 1.0
Definition at line 2939 of file tcpdf.php.
2939 {
2940 $this->state = 1;
2941 }
Referenced by startPage().
Here is the caller graph for this function:
◆ openHTMLTagHandler()
|
protected |
Process opening tags.
- Parameters
-
$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).
- Returns
- $dom array
Definition at line 18689 of file tcpdf.php.
18689 {
18690 $tag = $dom[$key];
18691 $parent = $dom[($dom[$key]['parent'])];
18692 $firsttag = ($key == 1);
18693 // check for text direction attribute
18694 if (isset($tag['dir'])) {
18696 } else {
18697 $this->tmprtl = false;
18698 }
18699 if ($tag['block']) {
18700 $hbz = 0; // distance from y to line bottom
18701 $hb = 0; // vertical space between block tags
18702 // calculate vertical space for block tags
18703 if (isset($this->tagvspaces[$tag['value']][0]['h']) AND ($this->tagvspaces[$tag['value']][0]['h'] >= 0)) {
18704 $cur_h = $this->tagvspaces[$tag['value']][0]['h'];
18705 } elseif (isset($tag['fontsize'])) {
18707 } else {
18708 $cur_h = $this->getCellHeight($this->FontSize);
18709 }
18710 if (isset($this->tagvspaces[$tag['value']][0]['n'])) {
18711 $on = $this->tagvspaces[$tag['value']][0]['n'];
18712 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
18713 $on = 0.6;
18714 } else {
18715 $on = 1;
18716 }
18717 if ((!isset($this->tagvspaces[$tag['value']])) AND (in_array($tag['value'], array('div', 'dt', 'dd', 'li', 'br', 'hr')))) {
18718 $hb = 0;
18719 } else {
18720 $hb = ($on * $cur_h);
18721 }
18722 if (($this->htmlvspace <= 0) AND ($on > 0)) {
18723 if (isset($parent['fontsize'])) {
18725 } else {
18726 $hbz = $this->getCellHeight($this->FontSize);
18727 }
18728 }
18729 if (isset($dom[($key - 1)]) AND ($dom[($key - 1)]['value'] == 'table')) {
18730 // fix vertical space after table
18731 $hbz = 0;
18732 }
18733 // closing vertical space
18734 $hbc = 0;
18735 if (isset($this->tagvspaces[$tag['value']][1]['h']) AND ($this->tagvspaces[$tag['value']][1]['h'] >= 0)) {
18736 $pre_h = $this->tagvspaces[$tag['value']][1]['h'];
18737 } elseif (isset($parent['fontsize'])) {
18739 } else {
18740 $pre_h = $this->getCellHeight($this->FontSize);
18741 }
18742 if (isset($this->tagvspaces[$tag['value']][1]['n'])) {
18743 $cn = $this->tagvspaces[$tag['value']][1]['n'];
18744 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
18745 $cn = 0.6;
18746 } else {
18747 $cn = 1;
18748 }
18749 if (isset($this->tagvspaces[$tag['value']][1])) {
18750 $hbc = ($cn * $pre_h);
18751 }
18752 }
18753 // Opening tag
18754 switch($tag['value']) {
18755 case 'table': {
18756 $cp = 0;
18757 $cs = 0;
18758 $dom[$key]['rowspans'] = array();
18759 if (!isset($dom[$key]['attribute']['nested']) OR ($dom[$key]['attribute']['nested'] != 'true')) {
18760 $this->htmlvspace = 0;
18761 // set table header
18763 // set table header
18764 $this->thead = $dom[$key]['thead'];
18765 if (!isset($this->theadMargins) OR (empty($this->theadMargins))) {
18766 $this->theadMargins = array();
18771 $this->theadMargins['cell'] = $cell;
18773 }
18774 }
18775 }
18776 // store current margins and page
18778 if (isset($tag['attribute']['cellpadding'])) {
18780 $this->SetCellPadding($pad);
18781 } elseif (isset($tag['padding'])) {
18782 $this->cell_padding = $tag['padding'];
18783 }
18784 if (isset($tag['attribute']['cellspacing'])) {
18786 } elseif (isset($tag['border-spacing'])) {
18787 $cs = $tag['border-spacing']['V'];
18788 }
18789 $prev_y = $this->y;
18790 if ($this->checkPageBreak(((2 * $cp) + (2 * $cs) + $this->lasth), '', false) OR ($this->y < $prev_y)) {
18791 $this->inthead = true;
18792 // add a page (or trig AcceptPageBreak() for multicolumn mode)
18793 $this->checkPageBreak($this->PageBreakTrigger + 1);
18794 }
18795 break;
18796 }
18797 case 'tr': {
18798 // array of columns positions
18799 $dom[$key]['cellpos'] = array();
18800 break;
18801 }
18802 case 'hr': {
18803 if ((isset($tag['height'])) AND ($tag['height'] != '')) {
18805 } else {
18806 $hrHeight = $this->GetLineWidth();
18807 }
18808 $this->addHTMLVertSpace($hbz, max($hb, ($hrHeight / 2)), $cell, $firsttag);
18811 $wtmp = $this->w - $this->lMargin - $this->rMargin;
18812 if ($cell) {
18813 $wtmp -= ($this->cell_padding['L'] + $this->cell_padding['R']);
18814 }
18815 if ((isset($tag['width'])) AND ($tag['width'] != '')) {
18817 } else {
18818 $hrWidth = $wtmp;
18819 }
18820 $prevlinewidth = $this->GetLineWidth();
18821 $this->SetLineWidth($hrHeight);
18823 $this->SetLineWidth($prevlinewidth);
18824 $this->addHTMLVertSpace(max($hbc, ($hrHeight / 2)), 0, $cell, !isset($dom[($key + 1)]));
18825 break;
18826 }
18827 case 'a': {
18828 if (array_key_exists('href', $tag['attribute'])) {
18829 $this->HREF['url'] = $tag['attribute']['href'];
18830 }
18831 break;
18832 }
18833 case 'img': {
18834 if (!empty($tag['attribute']['src'])) {
18835 if ($tag['attribute']['src'][0] === '@') {
18836 // data stream
18837 $tag['attribute']['src'] = '@'.base64_decode(substr($tag['attribute']['src'], 1));
18838 $type = '';
18839 } else {
18840 // get image type
18842 }
18843 if (!isset($tag['width'])) {
18844 $tag['width'] = 0;
18845 }
18846 if (!isset($tag['height'])) {
18847 $tag['height'] = 0;
18848 }
18849 //if (!isset($tag['attribute']['align'])) {
18850 // the only alignment supported is "bottom"
18851 // further development is required for other modes.
18852 $tag['attribute']['align'] = 'bottom';
18853 //}
18854 switch($tag['attribute']['align']) {
18855 case 'top': {
18856 $align = 'T';
18857 break;
18858 }
18859 case 'middle': {
18860 $align = 'M';
18861 break;
18862 }
18863 case 'bottom': {
18864 $align = 'B';
18865 break;
18866 }
18867 default: {
18868 $align = 'B';
18869 break;
18870 }
18871 }
18872 $prevy = $this->y;
18873 $xpos = $this->x;
18874 $imglink = '';
18876 $imglink = $this->HREF['url'];
18877 if ($imglink[0] == '#') {
18878 // convert url to internal link
18879 $lnkdata = explode(',', $imglink);
18880 if (isset($lnkdata[0])) {
18881 $page = intval(substr($lnkdata[0], 1));
18884 }
18885 if (isset($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
18886 $lnky = floatval($lnkdata[1]);
18887 } else {
18888 $lnky = 0;
18889 }
18890 $imglink = $this->AddLink();
18892 }
18893 }
18894 }
18895 $border = 0;
18896 if (isset($tag['border']) AND !empty($tag['border'])) {
18897 // currently only support 1 (frame) or a combination of 'LTRB'
18899 }
18900 $iw = '';
18901 if (isset($tag['width'])) {
18903 }
18904 $ih = '';
18905 if (isset($tag['height'])) {
18907 }
18908 if (($type == 'eps') OR ($type == 'ai')) {
18909 $this->ImageEps($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, true, $align, '', $border, true);
18910 } elseif ($type == 'svg') {
18911 $this->ImageSVG($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, $align, '', $border, true);
18912 } else {
18913 $this->Image($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, '', $imglink, $align, false, 300, '', false, false, $border, false, false, true);
18914 }
18915 switch($align) {
18916 case 'T': {
18917 $this->y = $prevy;
18918 break;
18919 }
18920 case 'M': {
18921 $this->y = (($this->img_rb_y + $prevy - ($this->getCellHeight($tag['fontsize'] / $this->k))) / 2);
18922 break;
18923 }
18924 case 'B': {
18925 $this->y = $this->img_rb_y - ($this->getCellHeight($tag['fontsize'] / $this->k) - ($this->getFontDescent($tag['fontname'], $tag['fontstyle'], $tag['fontsize']) * $this->cell_height_ratio));
18926 break;
18927 }
18928 }
18929 }
18930 break;
18931 }
18932 case 'dl': {
18933 ++$this->listnum;
18934 if ($this->listnum == 1) {
18935 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18936 } else {
18937 $this->addHTMLVertSpace(0, 0, $cell, $firsttag);
18938 }
18939 break;
18940 }
18941 case 'dt': {
18942 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18943 break;
18944 }
18945 case 'dd': {
18946 if ($this->rtl) {
18947 $this->rMargin += $this->listindent;
18948 } else {
18949 $this->lMargin += $this->listindent;
18950 }
18951 ++$this->listindentlevel;
18952 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18953 break;
18954 }
18955 case 'ul':
18956 case 'ol': {
18957 ++$this->listnum;
18958 if ($tag['value'] == 'ol') {
18960 } else {
18962 }
18963 if (isset($tag['attribute']['start'])) {
18965 } else {
18966 $this->listcount[$this->listnum] = 0;
18967 }
18968 if ($this->rtl) {
18969 $this->rMargin += $this->listindent;
18970 $this->x -= $this->listindent;
18971 } else {
18972 $this->lMargin += $this->listindent;
18973 $this->x += $this->listindent;
18974 }
18975 ++$this->listindentlevel;
18976 if ($this->listnum == 1) {
18977 if ($key > 1) {
18978 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18979 }
18980 } else {
18981 $this->addHTMLVertSpace(0, 0, $cell, $firsttag);
18982 }
18983 break;
18984 }
18985 case 'li': {
18986 if ($key > 2) {
18987 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18988 }
18989 if ($this->listordered[$this->listnum]) {
18990 // ordered item
18991 if (isset($parent['attribute']['type']) AND !TCPDF_STATIC::empty_string($parent['attribute']['type'])) {
18992 $this->lispacer = $parent['attribute']['type'];
18994 $this->lispacer = $parent['listtype'];
18995 } elseif (isset($this->lisymbol) AND !TCPDF_STATIC::empty_string($this->lisymbol)) {
18996 $this->lispacer = $this->lisymbol;
18997 } else {
18998 $this->lispacer = '#';
18999 }
19000 ++$this->listcount[$this->listnum];
19001 if (isset($tag['attribute']['value'])) {
19003 }
19004 } else {
19005 // unordered item
19006 if (isset($parent['attribute']['type']) AND !TCPDF_STATIC::empty_string($parent['attribute']['type'])) {
19007 $this->lispacer = $parent['attribute']['type'];
19009 $this->lispacer = $parent['listtype'];
19010 } elseif (isset($this->lisymbol) AND !TCPDF_STATIC::empty_string($this->lisymbol)) {
19011 $this->lispacer = $this->lisymbol;
19012 } else {
19013 $this->lispacer = '!';
19014 }
19015 }
19016 break;
19017 }
19018 case 'blockquote': {
19019 if ($this->rtl) {
19020 $this->rMargin += $this->listindent;
19021 } else {
19022 $this->lMargin += $this->listindent;
19023 }
19024 ++$this->listindentlevel;
19025 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19026 break;
19027 }
19028 case 'br': {
19029 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19030 break;
19031 }
19032 case 'div': {
19033 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19034 break;
19035 }
19036 case 'p': {
19037 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19038 break;
19039 }
19040 case 'pre': {
19041 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19042 $this->premode = true;
19043 break;
19044 }
19045 case 'sup': {
19047 break;
19048 }
19049 case 'sub': {
19051 break;
19052 }
19053 case 'h1':
19054 case 'h2':
19055 case 'h3':
19056 case 'h4':
19057 case 'h5':
19058 case 'h6': {
19059 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19060 break;
19061 }
19062 // Form fields (since 4.8.000 - 2009-09-07)
19063 case 'form': {
19064 if (isset($tag['attribute']['action'])) {
19065 $this->form_action = $tag['attribute']['action'];
19066 } else {
19068 }
19069 if (isset($tag['attribute']['enctype'])) {
19070 $this->form_enctype = $tag['attribute']['enctype'];
19071 } else {
19072 $this->form_enctype = 'application/x-www-form-urlencoded';
19073 }
19074 if (isset($tag['attribute']['method'])) {
19075 $this->form_mode = $tag['attribute']['method'];
19076 } else {
19077 $this->form_mode = 'post';
19078 }
19079 break;
19080 }
19081 case 'input': {
19082 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19083 $name = $tag['attribute']['name'];
19084 } else {
19085 break;
19086 }
19087 $prop = array();
19088 $opt = array();
19089 if (isset($tag['attribute']['readonly']) AND !TCPDF_STATIC::empty_string($tag['attribute']['readonly'])) {
19090 $prop['readonly'] = true;
19091 }
19092 if (isset($tag['attribute']['value']) AND !TCPDF_STATIC::empty_string($tag['attribute']['value'])) {
19093 $value = $tag['attribute']['value'];
19094 }
19095 if (isset($tag['attribute']['maxlength']) AND !TCPDF_STATIC::empty_string($tag['attribute']['maxlength'])) {
19096 $opt['maxlen'] = intval($tag['attribute']['maxlength']);
19097 }
19099 if (isset($tag['attribute']['size']) AND !TCPDF_STATIC::empty_string($tag['attribute']['size'])) {
19101 } else {
19103 }
19104 if (isset($tag['attribute']['checked']) AND (($tag['attribute']['checked'] == 'checked') OR ($tag['attribute']['checked'] == 'true'))) {
19105 $checked = true;
19106 } else {
19107 $checked = false;
19108 }
19109 if (isset($tag['align'])) {
19110 switch ($tag['align']) {
19111 case 'C': {
19112 $opt['q'] = 1;
19113 break;
19114 }
19115 case 'R': {
19116 $opt['q'] = 2;
19117 break;
19118 }
19119 case 'L':
19120 default: {
19121 break;
19122 }
19123 }
19124 }
19125 switch ($tag['attribute']['type']) {
19126 case 'text': {
19127 if (isset($value)) {
19128 $opt['v'] = $value;
19129 }
19131 break;
19132 }
19133 case 'password': {
19134 if (isset($value)) {
19135 $opt['v'] = $value;
19136 }
19137 $prop['password'] = 'true';
19139 break;
19140 }
19141 case 'checkbox': {
19142 if (!isset($value)) {
19143 break;
19144 }
19146 break;
19147 }
19148 case 'radio': {
19149 if (!isset($value)) {
19150 break;
19151 }
19153 break;
19154 }
19155 case 'submit': {
19156 if (!isset($value)) {
19157 $value = 'submit';
19158 }
19160 $h *= 1.6;
19161 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19162 $action = array();
19163 $action['S'] = 'SubmitForm';
19165 if ($this->form_enctype != 'FDF') {
19166 $action['Flags'] = array('ExportFormat');
19167 }
19168 if ($this->form_mode == 'get') {
19169 $action['Flags'] = array('GetMethod');
19170 }
19172 break;
19173 }
19174 case 'reset': {
19175 if (!isset($value)) {
19176 $value = 'reset';
19177 }
19179 $h *= 1.6;
19180 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19182 break;
19183 }
19184 case 'file': {
19185 $prop['fileSelect'] = 'true';
19187 if (!isset($value)) {
19188 $value = '*';
19189 }
19191 $h *= 1.2;
19192 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19193 $jsaction = 'var f=this.getField(\''.$name.'\'); f.browseForFileToSubmit();';
19194 $this->Button('FB_'.$name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19195 break;
19196 }
19197 case 'hidden': {
19198 if (isset($value)) {
19199 $opt['v'] = $value;
19200 }
19201 $opt['f'] = array('invisible', 'hidden');
19202 $this->TextField($name, 0, 0, $prop, $opt, '', '', false);
19203 break;
19204 }
19205 case 'image': {
19206 // THIS TYPE MUST BE FIXED
19207 if (isset($tag['attribute']['src']) AND !TCPDF_STATIC::empty_string($tag['attribute']['src'])) {
19208 $img = $tag['attribute']['src'];
19209 } else {
19210 break;
19211 }
19212 $value = 'img';
19213 //$opt['mk'] = array('i'=>$img, 'tp'=>1, 'if'=>array('sw'=>'A', 's'=>'A', 'fb'=>false));
19214 if (isset($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
19215 $jsaction = $tag['attribute']['onclick'];
19216 } else {
19217 $jsaction = '';
19218 }
19219 $this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19220 break;
19221 }
19222 case 'button': {
19223 if (!isset($value)) {
19224 $value = ' ';
19225 }
19226 $w = $this->GetStringWidth($value) * 1.5;
19227 $h *= 1.6;
19228 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19229 if (isset($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
19230 $jsaction = $tag['attribute']['onclick'];
19231 } else {
19232 $jsaction = '';
19233 }
19234 $this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19235 break;
19236 }
19237 }
19238 break;
19239 }
19241 $prop = array();
19242 $opt = array();
19243 if (isset($tag['attribute']['readonly']) AND !TCPDF_STATIC::empty_string($tag['attribute']['readonly'])) {
19244 $prop['readonly'] = true;
19245 }
19246 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19247 $name = $tag['attribute']['name'];
19248 } else {
19249 break;
19250 }
19251 if (isset($tag['attribute']['value']) AND !TCPDF_STATIC::empty_string($tag['attribute']['value'])) {
19252 $opt['v'] = $tag['attribute']['value'];
19253 }
19254 if (isset($tag['attribute']['cols']) AND !TCPDF_STATIC::empty_string($tag['attribute']['cols'])) {
19255 $w = intval($tag['attribute']['cols']) * $this->GetStringWidth(chr(32)) * 2;
19256 } else {
19257 $w = 40;
19258 }
19259 if (isset($tag['attribute']['rows']) AND !TCPDF_STATIC::empty_string($tag['attribute']['rows'])) {
19260 $h = intval($tag['attribute']['rows']) * $this->getCellHeight($this->FontSize);
19261 } else {
19262 $h = 10;
19263 }
19264 $prop['multiline'] = 'true';
19265 $this->TextField($name, $w, $h, $prop, $opt, '', '', false);
19266 break;
19267 }
19269 $h = $this->getCellHeight($this->FontSize);
19270 if (isset($tag['attribute']['size']) AND !TCPDF_STATIC::empty_string($tag['attribute']['size'])) {
19272 }
19273 $prop = array();
19274 $opt = array();
19275 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19276 $name = $tag['attribute']['name'];
19277 } else {
19278 break;
19279 }
19280 $w = 0;
19281 if (isset($tag['attribute']['opt']) AND !TCPDF_STATIC::empty_string($tag['attribute']['opt'])) {
19282 $options = explode('#!NwL!#', $tag['attribute']['opt']);
19283 $values = array();
19284 foreach ($options as $val) {
19285 if (strpos($val, '#!TaB!#') !== false) {
19286 $opts = explode('#!TaB!#', $val);
19287 $values[] = $opts;
19288 $w = max($w, $this->GetStringWidth($opts[1]));
19289 } else {
19290 $values[] = $val;
19291 $w = max($w, $this->GetStringWidth($val));
19292 }
19293 }
19294 } else {
19295 break;
19296 }
19297 $w *= 2;
19298 if (isset($tag['attribute']['multiple']) AND ($tag['attribute']['multiple']='multiple')) {
19299 $prop['multipleSelection'] = 'true';
19300 $this->ListBox($name, $w, $h, $values, $prop, $opt, '', '', false);
19301 } else {
19302 $this->ComboBox($name, $w, $h, $values, $prop, $opt, '', '', false);
19303 }
19304 break;
19305 }
19306 case 'tcpdf': {
19308 // Special tag used to call TCPDF methods
19309 if (isset($tag['attribute']['method'])) {
19310 $tcpdf_method = $tag['attribute']['method'];
19311 if (method_exists($this, $tcpdf_method)) {
19312 if (isset($tag['attribute']['params']) AND (!empty($tag['attribute']['params']))) {
19313 $params = $this->unserializeTCPDFtagParameters($tag['attribute']['params']);
19314 call_user_func_array(array($this, $tcpdf_method), $params);
19315 } else {
19316 $this->$tcpdf_method();
19317 }
19318 $this->newline = true;
19319 }
19320 }
19321 }
19322 break;
19323 }
19324 default: {
19325 break;
19326 }
19327 }
19328 // define tags that support borders and background colors
19329 $bordertags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table');
19330 if (in_array($tag['value'], $bordertags)) {
19331 // set border
19332 $dom[$key]['borderposition'] = $this->getBorderStartPosition();
19333 }
19334 if ($dom[$key]['self'] AND isset($dom[$key]['attribute']['pagebreakafter'])) {
19335 $pba = $dom[$key]['attribute']['pagebreakafter'];
19336 // check for pagebreak
19338 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19339 $this->checkPageBreak($this->PageBreakTrigger + 1);
19340 }
19341 if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
19342 OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
19343 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19344 $this->checkPageBreak($this->PageBreakTrigger + 1);
19345 }
19346 }
19347 return $dom;
19348 }
TextField($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false)
Creates a text field.
Definition: tcpdf.php:12645
RadioButton($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false)
Creates a RadioButton field.
Definition: tcpdf.php:12766
CheckBox($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false)
Creates a CheckBox field.
Definition: tcpdf.php:13042
Button($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false)
Creates a button field.
Definition: tcpdf.php:13122
const K_TCPDF_CALLS_IN_HTML
If true allows to call TCPDF methods using HTML syntax IMPORTANT: For security reason,...
Definition: tcpdf_config.php:213
References $border, $cell_height_ratio, $cell_padding, $form_action, $h, $k, $listindent, $listindentlevel, $listnum, $lisymbol, $lMargin, $page, $rMargin, $w, $x, $y, addHTMLVertSpace(), AddLink(), Button(), CheckBox(), checkPageBreak(), TCPDF_STATIC\empty_string(), Error(), getCellHeight(), getFontDescent(), getGraphicVars(), getHTMLUnitToUnits(), TCPDF_IMAGES\getImageFileType(), GetLineWidth(), GetStringWidth(), GetX(), GetY(), Image(), ImageEps(), ImageSVG(), K_TCPDF_CALLS_IN_HTML, left, Line(), p, RadioButton(), select, SetCellPadding(), SetLineWidth(), SetLink(), setTempRTL(), SetXY(), size, textarea, and TextField().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Output()
| 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.
- Parameters
-
$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: - I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.
- D: send to the browser and force a file download with the name given by name.
- F: save to a local server file with the name given by name.
- S: return the document as a string (name is ignored).
- FI: equivalent to F + I option
- FD: equivalent to F + D option
- E: return the document as base64 mime multi-part email attachment (RFC 2045)
- Returns
- string
- Since
- 1.0
- See also
- Close()
Definition at line 7558 of file tcpdf.php.
7558 {
7559 //Output PDF to some destination
7560 //Finish document if necessary
7561 if ($this->state < 3) {
7562 $this->Close();
7563 }
7564 //Normalize parameters
7565 if (is_bool($dest)) {
7566 $dest = $dest ? 'D' : 'F';
7567 }
7568 $dest = strtoupper($dest);
7569 if ($dest[0] != 'F') {
7570 $name = preg_replace('/[\s]+/', '_', $name);
7571 $name = preg_replace('/[^a-zA-Z0-9_\.-]/', '', $name);
7572 }
7573 if ($this->sign) {
7574 // *** apply digital signature to the document ***
7575 // get the document content
7576 $pdfdoc = $this->getBuffer();
7577 // remove last newline
7578 $pdfdoc = substr($pdfdoc, 0, -1);
7579 // remove filler space
7580 $byterange_string_len = strlen(TCPDF_STATIC::$byterange_string);
7581 // define the ByteRange
7582 $byte_range = array();
7583 $byte_range[0] = 0;
7584 $byte_range[1] = strpos($pdfdoc, TCPDF_STATIC::$byterange_string) + $byterange_string_len + 10;
7585 $byte_range[2] = $byte_range[1] + $this->signature_max_length + 2;
7586 $byte_range[3] = strlen($pdfdoc) - $byte_range[2];
7587 $pdfdoc = substr($pdfdoc, 0, $byte_range[1]).substr($pdfdoc, $byte_range[2]);
7588 // replace the ByteRange
7589 $byterange = sprintf('/ByteRange[0 %u %u %u]', $byte_range[1], $byte_range[2], $byte_range[3]);
7590 $byterange .= str_repeat(' ', ($byterange_string_len - strlen($byterange)));
7591 $pdfdoc = str_replace(TCPDF_STATIC::$byterange_string, $byterange, $pdfdoc);
7592 // write the document to a temporary folder
7595 if (!$f) {
7597 }
7598 $pdfdoc_length = strlen($pdfdoc);
7599 fwrite($f, $pdfdoc, $pdfdoc_length);
7600 fclose($f);
7601 // get digital signature via openssl library
7603 if (empty($this->signature_data['extracerts'])) {
7604 openssl_pkcs7_sign($tempdoc, $tempsign, $this->signature_data['signcert'], array($this->signature_data['privkey'], $this->signature_data['password']), array(), PKCS7_BINARY | PKCS7_DETACHED);
7605 } else {
7606 openssl_pkcs7_sign($tempdoc, $tempsign, $this->signature_data['signcert'], array($this->signature_data['privkey'], $this->signature_data['password']), array(), PKCS7_BINARY | PKCS7_DETACHED, $this->signature_data['extracerts']);
7607 }
7608 // read signature
7609 $signature = file_get_contents($tempsign);
7610 // extract signature
7611 $signature = substr($signature, $pdfdoc_length);
7612 $signature = substr($signature, (strpos($signature, "%%EOF\n\n------") + 13));
7613 $tmparr = explode("\n\n", $signature);
7614 $signature = $tmparr[1];
7615 // decode signature
7616 $signature = base64_decode(trim($signature));
7617 // add TSA timestamp to signature
7618 $signature = $this->applyTSA($signature);
7619 // convert signature to hex
7620 $signature = current(unpack('H*', $signature));
7621 $signature = str_pad($signature, $this->signature_max_length, '0');
7622 // Add signature to the document
7623 $this->buffer = substr($pdfdoc, 0, $byte_range[1]).'<'.$signature.'>'.substr($pdfdoc, $byte_range[1]);
7624 $this->bufferlen = strlen($this->buffer);
7625 }
7626 switch($dest) {
7627 case 'I': {
7628 // Send PDF to the standard output
7629 if (ob_get_contents()) {
7631 }
7632 if (php_sapi_name() != 'cli') {
7633 // send output to a browser
7634 header('Content-Type: application/pdf');
7635 if (headers_sent()) {
7637 }
7638 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7639 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7640 header('Pragma: public');
7641 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7642 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7643 header('Content-Disposition: inline; filename="'.basename($name).'"');
7645 } else {
7646 echo $this->getBuffer();
7647 }
7648 break;
7649 }
7650 case 'D': {
7651 // download PDF as file
7652 if (ob_get_contents()) {
7654 }
7655 header('Content-Description: File Transfer');
7656 if (headers_sent()) {
7658 }
7659 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7660 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7661 header('Pragma: public');
7662 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7663 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7664 // force download dialog
7665 if (strpos(php_sapi_name(), 'cgi') === false) {
7666 header('Content-Type: application/force-download');
7667 header('Content-Type: application/octet-stream', false);
7668 header('Content-Type: application/download', false);
7669 header('Content-Type: application/pdf', false);
7670 } else {
7671 header('Content-Type: application/pdf');
7672 }
7673 // use the Content-Disposition header to supply a recommended filename
7674 header('Content-Disposition: attachment; filename="'.basename($name).'"');
7675 header('Content-Transfer-Encoding: binary');
7677 break;
7678 }
7679 case 'F':
7680 case 'FI':
7681 case 'FD': {
7682 // save PDF to a local file
7684 if (!$f) {
7686 }
7687 fwrite($f, $this->getBuffer(), $this->bufferlen);
7688 fclose($f);
7689 if ($dest == 'FI') {
7690 // send headers to browser
7691 header('Content-Type: application/pdf');
7692 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7693 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7694 header('Pragma: public');
7695 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7696 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7697 header('Content-Disposition: inline; filename="'.basename($name).'"');
7698 TCPDF_STATIC::sendOutputData(file_get_contents($name), filesize($name));
7699 } elseif ($dest == 'FD') {
7700 // send headers to browser
7701 if (ob_get_contents()) {
7703 }
7704 header('Content-Description: File Transfer');
7705 if (headers_sent()) {
7707 }
7708 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7709 header('Pragma: public');
7710 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7711 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7712 // force download dialog
7713 if (strpos(php_sapi_name(), 'cgi') === false) {
7714 header('Content-Type: application/force-download');
7715 header('Content-Type: application/octet-stream', false);
7716 header('Content-Type: application/download', false);
7717 header('Content-Type: application/pdf', false);
7718 } else {
7719 header('Content-Type: application/pdf');
7720 }
7721 // use the Content-Disposition header to supply a recommended filename
7722 header('Content-Disposition: attachment; filename="'.basename($name).'"');
7723 header('Content-Transfer-Encoding: binary');
7724 TCPDF_STATIC::sendOutputData(file_get_contents($name), filesize($name));
7725 }
7726 break;
7727 }
7728 case 'E': {
7729 // return PDF as base64 mime multi-part email attachment (RFC 2045)
7730 $retval = 'Content-Type: application/pdf;'."\r\n";
7731 $retval .= ' name="'.$name.'"'."\r\n";
7732 $retval .= 'Content-Transfer-Encoding: base64'."\r\n";
7733 $retval .= 'Content-Disposition: attachment;'."\r\n";
7734 $retval .= ' filename="'.$name.'"'."\r\n\r\n";
7736 return $retval;
7737 }
7738 case 'S': {
7739 // returns PDF as a string
7741 }
7742 default: {
7744 }
7745 }
7746 return '';
7747 }
static sendOutputData($data, $length)
Output input data and compress it if possible.
Definition: tcpdf_static.php:345
static $byterange_string
ByteRange placemark used during digital signature process.
Definition: tcpdf_static.php:101
References TCPDF_STATIC\$byterange_string, applyTSA(), Close(), Error(), TCPDF_STATIC\fopenLocal(), getBuffer(), TCPDF_STATIC\getObjFilename(), TCPDF_STATIC\sendOutputData(), and sprintf.
Here is the call graph for this function:
◆ PageNo()
| TCPDF::PageNo | ( | ) |
Returns the current page number.
- Returns
- int page number
- Since
- 1.0
- See also
- getAliasNbPages()
Definition at line 3689 of file tcpdf.php.
References $page.
Referenced by Bookmark(), PageNoFormatted(), and setDestination().
Here is the caller graph for this function:
◆ PageNoFormatted()
| TCPDF::PageNoFormatted | ( | ) |
Returns the current page number formatted as a string.
- Since
- 4.2.005 (2008-11-06)
- See also
- PaneNo(), formatPageNumber()
Definition at line 13688 of file tcpdf.php.
References TCPDF_STATIC\formatPageNumber(), and PageNo().
Here is the call graph for this function:
◆ PieSector()
| 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.
- Parameters
-
$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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14769 of file tcpdf.php.
14769 {
14771 }
PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2)
Draw the sector of an ellipse.
Definition: tcpdf.php:14790
References $r, $style, $xc, $yc, and PieSectorXY().
Referenced by registrationMark(), and registrationMarkCMYK().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ PieSectorXY()
| 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.
- Parameters
-
$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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14790 of file tcpdf.php.
14790 {
14791 if ($this->state != 2) {
14792 return;
14793 }
14794 if ($this->rtl) {
14796 }
14798 if ($op == 'f') {
14799 $line_style = array();
14800 }
14801 if ($cw) {
14802 $d = $b;
14803 $b = (360 - $a + $o);
14804 $a = (360 - $d + $o);
14805 } else {
14806 $b += $o;
14807 $a += $o;
14808 }
14810 $this->_out($op);
14811 }
References $d, $style, $xc, $yc, _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:
◆ pixelsToUnits()
| TCPDF::pixelsToUnits | ( | $px | ) |
Converts pixels to User's Units.
- Parameters
-
$px (int) pixels
- Returns
- float value in user's unit
- See also
- setImageScale(), getImageScale()
Definition at line 10416 of file tcpdf.php.
10416 {
10418 }
References $px.
Referenced by Image().
Here is the caller graph for this function:
◆ Polycurve()
| 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.
- Parameters
-
$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).
- See also
- SetLineStyle()
- Since
- 3.0008 (2008-05-12)
Definition at line 11612 of file tcpdf.php.
11612 {
11613 if ($this->state != 2) {
11614 return;
11615 }
11617 $this->SetFillColorArray($fill_color);
11618 }
11620 if ($op == 'f') {
11621 $line_style = array();
11622 }
11623 if ($line_style) {
11624 $this->SetLineStyle($line_style);
11625 }
11626 $this->_outPoint($x0, $y0);
11627 foreach ($segments as $segment) {
11628 list($x1, $y1, $x2, $y2, $x3, $y3) = $segment;
11629 $this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
11630 }
11631 $this->_out($op);
11632 }
References $style, _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray(), and SetLineStyle().
Here is the call graph for this function:
◆ Polygon()
| TCPDF::Polygon | ( | $p, | |
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array(), |
|||
$closed = true |
|||
| ) |
Draws a polygon.
- Parameters
-
$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: - all: Line style of all lines. Array like for SetLineStyle().
- 0 to ($np - 1): Line style of each line. Array like for SetLineStyle().
$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
- Since
- 2.1.000 (2008-01-08)
Definition at line 11861 of file tcpdf.php.
11861 {
11862 if ($this->state != 2) {
11863 return;
11864 }
11865 $nc = count($p); // number of coordinates
11866 $np = $nc / 2; // number of points
11867 if ($closed) {
11868 // close polygon by adding the first 2 points at the end (one line)
11869 for ($i = 0; $i < 4; ++$i) {
11870 $p[$nc + $i] = $p[$i];
11871 }
11872 // copy style for the last added line
11873 if (isset($line_style[0])) {
11874 $line_style[$np] = $line_style[0];
11875 }
11876 $nc += 4;
11877 }
11879 $this->SetFillColorArray($fill_color);
11880 }
11882 if ($op == 'f') {
11883 $line_style = array();
11884 }
11885 $draw = true;
11886 if ($line_style) {
11887 if (isset($line_style['all'])) {
11889 } else {
11890 $draw = false;
11891 if ($op == 'B') {
11892 // draw fill
11893 $op = 'f';
11894 $this->_outPoint($p[0], $p[1]);
11895 for ($i = 2; $i < $nc; $i = $i + 2) {
11896 $this->_outLine($p[$i], $p[$i + 1]);
11897 }
11898 $this->_out($op);
11899 }
11900 // draw outline
11901 $this->_outPoint($p[0], $p[1]);
11902 for ($i = 2; $i < $nc; $i = $i + 2) {
11903 $line_num = ($i / 2) - 1;
11904 if (isset($line_style[$line_num])) {
11905 if ($line_style[$line_num] != 0) {
11906 if (is_array($line_style[$line_num])) {
11908 $this->SetLineStyle($line_style[$line_num]);
11909 $this->_outPoint($p[$i - 2], $p[$i - 1]);
11910 $this->_outLine($p[$i], $p[$i + 1]);
11912 $this->_outPoint($p[$i], $p[$i + 1]);
11913 } else {
11914 $this->_outLine($p[$i], $p[$i + 1]);
11915 }
11916 }
11917 } else {
11918 $this->_outLine($p[$i], $p[$i + 1]);
11919 }
11920 }
11921 $this->_out($op);
11922 }
11923 }
11924 if ($draw) {
11925 $this->_outPoint($p[0], $p[1]);
11926 for ($i = 2; $i < $nc; $i = $i + 2) {
11927 $this->_outLine($p[$i], $p[$i + 1]);
11928 }
11929 $this->_out($op);
11930 }
11931 }
References $style, _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:
◆ PolyLine()
| TCPDF::PolyLine | ( | $p, | |
$style = '', |
|||
$line_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a polygonal line.
- Parameters
-
$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: - all: Line style of all lines. Array like for SetLineStyle().
- 0 to ($np - 1): Line style of each line. Array like for SetLineStyle().
$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).
- Since
- 4.8.003 (2009-09-15)
Definition at line 11842 of file tcpdf.php.
References $style, and Polygon().
Here is the call graph for this function:
◆ printTemplate()
| 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.
- Parameters
-
$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: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$palign (string) Allows to center or align the template on the current line. Possible values are: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$fitonpage (boolean) If true the template is resized to not exceed page dimensions.
- Since
- 5.8.017 (2010-08-24)
- See also
- startTemplate(), endTemplate()
Definition at line 22334 of file tcpdf.php.
22334 {
22335 if ($this->state != 2) {
22336 return;
22337 }
22338 if (!isset($this->xobjects[$id])) {
22340 }
22341 if ($this->inxobj) {
22342 if ($id == $this->xobjid) {
22343 // close current template
22344 $this->endTemplate();
22345 } else {
22346 // use the template as resource for the template currently opened
22348 }
22349 }
22350 // set default values
22353 }
22356 }
22357 // check page for no-write regions and adapt page margins if necessary
22359 $ow = $this->xobjects[$id]['w'];
22360 if ($ow <= 0) {
22361 $ow = 1;
22362 }
22363 $oh = $this->xobjects[$id]['h'];
22364 if ($oh <= 0) {
22365 $oh = 1;
22366 }
22367 // calculate template width and height on document
22369 $w = $ow;
22370 $h = $oh;
22371 } elseif ($w <= 0) {
22373 } elseif ($h <= 0) {
22375 }
22376 // fit the template on available space
22378 // set page alignment
22380 // set alignment
22381 if ($this->rtl) {
22382 if ($palign == 'L') {
22383 $xt = $this->lMargin;
22384 } elseif ($palign == 'C') {
22385 $xt = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22386 } elseif ($palign == 'R') {
22387 $xt = $this->w - $this->rMargin - $w;
22388 } else {
22390 }
22391 $rb_x = $xt;
22392 } else {
22393 if ($palign == 'L') {
22394 $xt = $this->lMargin;
22395 } elseif ($palign == 'C') {
22396 $xt = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22397 } elseif ($palign == 'R') {
22398 $xt = $this->w - $this->rMargin - $w;
22399 } else {
22400 $xt = $x;
22401 }
22402 $rb_x = $xt + $w;
22403 }
22404 // print XObject Template + Transformation matrix
22405 $this->StartTransform();
22406 // translate and scale
22407 $sx = ($w / $ow);
22408 $sy = ($h / $oh);
22409 $tm = array();
22410 $tm[0] = $sx;
22411 $tm[1] = 0;
22412 $tm[2] = 0;
22413 $tm[3] = $sy;
22414 $tm[4] = $xt * $this->k;
22416 $this->Transform($tm);
22417 // set object
22419 $this->StopTransform();
22420 // add annotations
22421 if (!empty($this->xobjects[$id]['annotations'])) {
22422 foreach ($this->xobjects[$id]['annotations'] as $annot) {
22423 // transform original coordinates
22424 $coordlt = TCPDF_STATIC::getTransformationMatrixProduct($tm, array(1, 0, 0, 1, ($annot['x'] * $this->k), (-$annot['y'] * $this->k)));
22425 $ax = ($coordlt[4] / $this->k);
22427 $coordrb = TCPDF_STATIC::getTransformationMatrixProduct($tm, array(1, 0, 0, 1, (($annot['x'] + $annot['w']) * $this->k), ((-$annot['y'] - $annot['h']) * $this->k)));
22428 $aw = ($coordrb[4] / $this->k) - $ax;
22431 }
22432 }
22433 // set pointer to align the next text/objects
22434 switch($align) {
22435 case 'T': {
22436 $this->y = $y;
22437 $this->x = $rb_x;
22438 break;
22439 }
22440 case 'M': {
22442 $this->x = $rb_x;
22443 break;
22444 }
22445 case 'B': {
22446 $this->y = $rb_y;
22447 $this->x = $rb_x;
22448 break;
22449 }
22450 case 'N': {
22451 $this->SetY($rb_y);
22452 break;
22453 }
22454 default:{
22455 break;
22456 }
22457 }
22458 }
static getTransformationMatrixProduct($ta, $tb)
Get the product of two SVG tranformation matrices.
Definition: tcpdf_static.php:1647
References $h, $w, $x, $y, and TCPDF_STATIC\getTransformationMatrixProduct().
Referenced by Header().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ putHtmlListBullet()
|
protected |
Output an HTML list bullet or ordered item symbol.
- Parameters
-
$listdepth (int) list nesting level $listtype (string) type of list $size (float) current font size
- Since
- 4.4.004 (2008-12-10)
Definition at line 20343 of file tcpdf.php.
20343 {
20344 if ($this->state != 2) {
20345 return;
20346 }
20348 $fill = '';
20350 $color = $this->fgcolor;
20352 $width = 0;
20353 $textitem = '';
20354 $tmpx = $this->x;
20356 if ($listtype == '^') {
20357 // special symbol used for avoid justification of rect bullet
20358 $this->lispacer = '';
20359 return;
20360 } elseif ($listtype == '!') {
20361 // set default list type for unordered list
20362 $deftypes = array('disc', 'circle', 'square');
20363 $listtype = $deftypes[($listdepth - 1) % 3];
20364 } elseif ($listtype == '#') {
20365 // set default list type for ordered list
20366 $listtype = 'decimal';
20367 } elseif (substr($listtype, 0, 4) == 'img|') {
20368 // custom image type ('img|type|width|height|image.ext')
20370 $listtype = 'img';
20371 }
20372 switch ($listtype) {
20373 // unordered types
20374 case 'none': {
20375 break;
20376 }
20377 case 'disc': {
20379 $lspace += (2 * $r);
20380 if ($this->rtl) {
20381 $this->x += $lspace;
20382 } else {
20383 $this->x -= $lspace;
20384 }
20385 $this->Circle(($this->x + $r), ($this->y + ($this->lasth / 2)), $r, 0, 360, 'F', array(), $color, 8);
20386 break;
20387 }
20388 case 'circle': {
20390 $lspace += (2 * $r);
20391 if ($this->rtl) {
20392 $this->x += $lspace;
20393 } else {
20394 $this->x -= $lspace;
20395 }
20396 $prev_line_style = $this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor;
20397 $new_line_style = array('width' => ($r / 3), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'phase' => 0, 'color'=>$color);
20398 $this->Circle(($this->x + $r), ($this->y + ($this->lasth / 2)), ($r * (1 - (1/6))), 0, 360, 'D', $new_line_style, array(), 8);
20400 break;
20401 }
20402 case 'square': {
20404 $lspace += $l;
20405 if ($this->rtl) {;
20406 $this->x += $lspace;
20407 } else {
20408 $this->x -= $lspace;
20409 }
20411 break;
20412 }
20413 case 'img': {
20414 // 1=>type, 2=>width, 3=>height, 4=>image.ext
20415 $lspace += $img[2];
20416 if ($this->rtl) {;
20417 $this->x += $lspace;
20418 } else {
20419 $this->x -= $lspace;
20420 }
20421 $imgtype = strtolower($img[1]);
20422 $prev_y = $this->y;
20423 switch ($imgtype) {
20424 case 'svg': {
20425 $this->ImageSVG($img[4], $this->x, ($this->y + (($this->lasth - $img[3]) / 2)), $img[2], $img[3], '', 'T', '', 0, false);
20426 break;
20427 }
20428 case 'ai':
20429 case 'eps': {
20430 $this->ImageEps($img[4], $this->x, ($this->y + (($this->lasth - $img[3]) / 2)), $img[2], $img[3], '', true, 'T', '', 0, false);
20431 break;
20432 }
20433 default: {
20434 $this->Image($img[4], $this->x, ($this->y + (($this->lasth - $img[3]) / 2)), $img[2], $img[3], $img[1], '', 'T', false, 300, '', false, false, 0, false, false, false);
20435 break;
20436 }
20437 }
20438 $this->y = $prev_y;
20439 break;
20440 }
20441 // ordered types
20442 // $this->listcount[$this->listnum];
20443 // $textitem
20444 case '1':
20445 case 'decimal': {
20446 $textitem = $this->listcount[$this->listnum];
20447 break;
20448 }
20449 case 'decimal-leading-zero': {
20451 break;
20452 }
20453 case 'i':
20454 case 'lower-roman': {
20455 $textitem = strtolower(TCPDF_STATIC::intToRoman($this->listcount[$this->listnum]));
20456 break;
20457 }
20458 case 'I':
20459 case 'upper-roman': {
20460 $textitem = TCPDF_STATIC::intToRoman($this->listcount[$this->listnum]);
20461 break;
20462 }
20463 case 'a':
20464 case 'lower-alpha':
20465 case 'lower-latin': {
20466 $textitem = chr(97 + $this->listcount[$this->listnum] - 1);
20467 break;
20468 }
20469 case 'A':
20470 case 'upper-alpha':
20471 case 'upper-latin': {
20472 $textitem = chr(65 + $this->listcount[$this->listnum] - 1);
20473 break;
20474 }
20475 case 'lower-greek': {
20476 $textitem = TCPDF_FONTS::unichr((945 + $this->listcount[$this->listnum] - 1), $this->isunicode);
20477 break;
20478 }
20479 /*
20480 // Types to be implemented (special handling)
20481 case 'hebrew': {
20482 break;
20483 }
20484 case 'armenian': {
20485 break;
20486 }
20487 case 'georgian': {
20488 break;
20489 }
20490 case 'cjk-ideographic': {
20491 break;
20492 }
20493 case 'hiragana': {
20494 break;
20495 }
20496 case 'katakana': {
20497 break;
20498 }
20499 case 'hiragana-iroha': {
20500 break;
20501 }
20502 case 'katakana-iroha': {
20503 break;
20504 }
20505 */
20506 default: {
20507 $textitem = $this->listcount[$this->listnum];
20508 }
20509 }
20511 // Check whether we need a new page or new column
20512 $prev_y = $this->y;
20515 $tmpx = $this->x;
20516 }
20517 // print ordered item
20518 if ($this->rtl) {
20519 $textitem = '.'.$textitem;
20520 } else {
20521 $textitem = $textitem.'.';
20522 }
20523 $lspace += $this->GetStringWidth($textitem);
20524 if ($this->rtl) {
20525 $this->x += $lspace;
20526 } else {
20527 $this->x -= $lspace;
20528 }
20530 }
20531 $this->x = $tmpx;
20532 $this->lispacer = '^';
20533 // restore colors
20536 $this->SettextColorArray($color);
20537 }
static intToRoman($number)
Returns the Roman representation of an integer number.
Definition: tcpdf_static.php:1441
Circle($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2)
Draws a circle.
Definition: tcpdf.php:11824
References $h, $img, $l, $r, $size, $x, $y, TCPDF_STATIC\empty_string(), TCPDF_STATIC\intToRoman(), sprintf, and TCPDF_FONTS\unichr().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ RadialGradient()
| 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.
- Parameters
-
$x (float) abscissa of the top left corner of the rectangle. $y (float) ordinate of the top left corner of the rectangle. $w (float) width of the rectangle. $h (float) height of the rectangle. $col1 (array) 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.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14328 of file tcpdf.php.
14328 {
14330 $this->Gradient(3, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
14331 }
References $coords, $h, $w, $x, $y, Clip(), and Gradient().
Here is the call graph for this function:
◆ RadioButton()
| TCPDF::RadioButton | ( | $name, | |
| $w, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$onvalue = 'On', |
|||
$checked = false, |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a RadioButton field.
- Parameters
-
$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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 12766 of file tcpdf.php.
12766 {
12769 }
12772 }
12773 // check page for no-write regions and adapt page margins if necessary
12777 return;
12778 }
12780 $onvalue = 'On';
12781 }
12782 if ($checked) {
12783 $defval = $onvalue;
12784 } else {
12785 $defval = 'Off';
12786 }
12787 // set font
12788 $font = 'zapfdingbats';
12789 if ($this->pdfa_mode) {
12790 // all fonts must be embedded
12791 $font = 'pdfa'.$font;
12792 }
12793 $this->AddFont($font);
12794 $tmpfont = $this->getFontBuffer($font);
12795 // set data for parent group
12796 if (!isset($this->radiobutton_groups[$this->page])) {
12797 $this->radiobutton_groups[$this->page] = array();
12798 }
12799 if (!isset($this->radiobutton_groups[$this->page][$name])) {
12800 $this->radiobutton_groups[$this->page][$name] = array();
12801 ++$this->n;
12803 $this->radio_groups[] = $this->n;
12804 }
12805 $kid = ($this->n + 1);
12806 // save object ID to be added on Kids entry on parent object
12808 // get default style
12809 $prop = array_merge($this->getFormDefaultProp(), $prop);
12810 $prop['NoToggleToOff'] = 'true';
12811 $prop['Radio'] = 'true';
12812 $prop['borderStyle'] = 'inset';
12813 // get annotation data
12814 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12815 // set additional default options
12816 $this->annotation_fonts[$tmpfont['fontkey']] = $tmpfont['i'];
12818 $popt['da'] = $fontstyle;
12819 // build appearance stream
12820 $popt['ap'] = array();
12821 $popt['ap']['n'] = array();
12823 $fy = (($w - ((($tmpfont['desc']['Ascent'] - $tmpfont['desc']['Descent']) * $this->FontSizePt / 1000) / $this->k)) * $this->k);
12824 $popt['ap']['n'][$onvalue] = sprintf('q %s BT /F%d %F Tf %F %F Td ('.chr(108).') Tj ET Q', $this->TextColor, $tmpfont['i'], $this->FontSizePt, $fx, $fy);
12825 $popt['ap']['n']['Off'] = sprintf('q %s BT /F%d %F Tf %F %F Td ('.chr(109).') Tj ET Q', $this->TextColor, $tmpfont['i'], $this->FontSizePt, $fx, $fy);
12826 if (!isset($popt['mk'])) {
12827 $popt['mk'] = array();
12828 }
12829 $popt['mk']['ca'] = '(l)';
12830 // merge options
12831 $opt = array_merge($popt, $opt);
12832 // set remaining annotation data
12833 $opt['Subtype'] = 'Widget';
12834 $opt['ft'] = 'Btn';
12835 if ($checked) {
12836 $opt['v'] = array('/'.$onvalue);
12837 $opt['as'] = $onvalue;
12838 } else {
12839 $opt['as'] = 'Off';
12840 }
12841 // store readonly flag
12842 if (!isset($this->radiobutton_groups[$this->page][$name]['#readonly#'])) {
12844 }
12847 if ($this->rtl) {
12848 $this->x -= $w;
12849 } else {
12850 $this->x += $w;
12851 }
12852 }
References $js, $k, $n, $page, $w, $x, $y, _addfield(), AddFont(), Annotation(), checkPageRegions(), TCPDF_STATIC\empty_string(), getAbsFontMeasure(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFontBuffer(), getFormDefaultProp(), and sprintf.
Referenced by openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Rect()
| TCPDF::Rect | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rectangle.
- Parameters
-
$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: - all: Line style of all borders. Array like for SetLineStyle().
- L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for SetLineStyle().
$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).
- Since
- 1.0
- See also
- SetLineStyle()
Definition at line 11511 of file tcpdf.php.
11511 {
11512 if ($this->state != 2) {
11513 return;
11514 }
11517 }
11519 // set background color
11520 $this->SetFillColorArray($fill_color);
11521 }
11524 //set global style for border
11526 $border_style = array();
11527 } else {
11528 // remove stroke operator from style
11529 $opnostroke = array('S' => '', 'D' => '', 's' => '', 'd' => '', 'B' => 'F', 'FD' => 'F', 'DF' => 'F', 'B*' => 'F*', 'F*D' => 'F*', 'DF*' => 'F*', 'b' => 'f', 'fd' => 'f', 'df' => 'f', 'b*' => 'f*', 'f*d' => 'f*', 'df*' => 'f*' );
11532 }
11533 }
11534 }
11538 }
11540 $border_style2 = array();
11542 $length = strlen($line);
11543 for ($i = 0; $i < $length; ++$i) {
11544 $border_style2[$line[$i]] = $value;
11545 }
11546 }
11547 $border_style = $border_style2;
11550 }
11553 }
11556 }
11559 }
11560 }
11561 }
_outRect($x, $y, $w, $h, $op)
Append a rectangle to the current path as a complete subpath, with lower-left corner (x,...
Definition: tcpdf.php:11414
References $border_style, $h, $style, $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:
◆ registrationMark()
| TCPDF::registrationMark | ( | $x, | |
| $y, | |||
| $r, | |||
$double = false, |
|||
$cola = array(100,100,100,100,'All'), |
|||
$colb = array(0,0,0,0,'None') |
|||
| ) |
Paints a registration mark.
- Parameters
-
$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 spot registration color 'All'). $colb (array) second crop mark color (default spot registration color 'None').
- Since
- 4.9.000 (2010-03-26)
Definition at line 14239 of file tcpdf.php.
14239 {
14240 $line_style = array('width' => max((0.5 / $this->k),($r / 30)), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $cola);
14241 $this->SetFillColorArray($cola);
14245 if ($double) {
14246 $ri = $r * 0.5;
14247 $this->SetFillColorArray($colb);
14250 $this->SetFillColorArray($cola);
14254 }
14255 }
PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90)
Draw the sector of a circle.
Definition: tcpdf.php:14769
References $r, $x, $y, Circle(), PieSector(), and SetFillColorArray().
Here is the call graph for this function:
◆ registrationMarkCMYK()
| TCPDF::registrationMarkCMYK | ( | $x, | |
| $y, | |||
| $r | |||
| ) |
Paints a CMYK registration mark.
- Parameters
-
$x (float) abscissa of the registration mark center. $y (float) ordinate of the registration mark center. $r (float) radius of the crop mark.
- Since
- 6.0.038 (2013-09-30)
Definition at line 14266 of file tcpdf.php.
14266 {
14267 // line width
14268 $lw = max((0.5 / $this->k),($r / 8));
14269 // internal radius
14270 $ri = ($r * 0.6);
14271 // external radius
14272 $re = ($r * 1.3);
14273 // Cyan
14274 $this->SetFillColorArray(array(100,0,0,0));
14276 // Magenta
14277 $this->SetFillColorArray(array(0,100,0,0));
14279 // Yellow
14280 $this->SetFillColorArray(array(0,0,100,0));
14282 // Key - black
14283 $this->SetFillColorArray(array(0,0,0,100));
14285 // registration color
14286 $line_style = array('width' => $lw, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(100,100,100,100,'All'));
14288 // external circle
14290 // cross lines
14295 }
References $r, $x, $y, Circle(), Line(), PieSector(), and SetFillColorArray().
Here is the call graph for this function:
◆ RegularPolygon()
| 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.
- Parameters
-
$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: - all: Line style of all sides. Array like for SetLineStyle().
- 0 to ($ns - 1): Line style of each side. Array like for SetLineStyle().
$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: - D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
- CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).
- CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).
$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).
- Since
- 2.1.000 (2008-01-08)
Definition at line 11962 of file tcpdf.php.
11962 {
11963 if (3 > $ns) {
11964 $ns = 3;
11965 }
11966 if ($draw_circle) {
11967 $this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
11968 }
11969 $p = array();
11970 for ($i = 0; $i < $ns; ++$i) {
11971 $a = $angle + ($i * 360 / $ns);
11972 $a_rad = deg2rad((float) $a);
11973 $p[] = $x0 + ($r * sin($a_rad));
11974 $p[] = $y0 + ($r * cos($a_rad));
11975 }
11977 }
References $angle, $r, $style, Circle(), and Polygon().
Here is the call graph for this function:
◆ removePageRegion()
| TCPDF::removePageRegion | ( | $key | ) |
Remove a single no-write region.
- Parameters
-
$key (int) region key
- Since
- 5.9.003 (2010-10-13)
- See also
- setPageRegions(), getPageRegions()
Definition at line 22566 of file tcpdf.php.
22566 {
22567 if (isset($this->page_regions[$key])) {
22568 unset($this->page_regions[$key]);
22569 }
22570 }
◆ removeTagNamespace()
|
protected |
◆ replaceBuffer()
|
protected |
◆ replaceChar()
|
protected |
Replace a char if is defined on the current font.
- Parameters
-
$oldchar (int) Integer code (unicode) of the character to replace. $newchar (int) Integer code (unicode) of the new character.
- Returns
- int the replaced char or the old char in case the new char i not defined
- Since
- 5.9.167 (2012-06-22)
Definition at line 5531 of file tcpdf.php.
5531 {
5533 // add the new char on the subset list
5534 $this->CurrentFont['subsetchars'][$newchar] = true;
5535 // return the new character
5536 return $newchar;
5537 }
5538 // return the old char
5539 return $oldchar;
5540 }
References isCharDefined().
Referenced by getCellCode().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ replaceMissingChars()
| TCPDF::replaceMissingChars | ( | $text, | |
$font = '', |
|||
$style = '', |
|||
$subs = array() |
|||
| ) |
Replace missing font characters on selected font with specified substitutions.
- Parameters
-
$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.
- Returns
- (string) Processed text.
- Since
- 5.9.153 (2012-03-28)
Definition at line 4635 of file tcpdf.php.
4635 {
4636 if (empty($subs)) {
4638 }
4640 $font = $this->FontFamily;
4641 }
4646 if (!isset($fontinfo['cw'][$chr])) {
4647 // this character is missing on the selected font
4648 if (isset($subs[$chr])) {
4649 // we have available substitutions
4650 if (is_array($subs[$chr])) {
4651 foreach($subs[$chr] as $s) {
4652 if (isset($fontinfo['cw'][$s])) {
4653 $uniarr[$k] = $s;
4654 break;
4655 }
4656 }
4657 } elseif (isset($fontinfo['cw'][$subs[$chr]])) {
4658 $uniarr[$k] = $subs[$chr];
4659 }
4660 }
4661 }
4662 }
4663 return TCPDF_FONTS::UniArrSubString(TCPDF_FONTS::UTF8ArrayToUniArray($uniarr, $this->isunicode));
4664 }
static UniArrSubString($uniarr, $start='', $end='')
Extract a slice of the $uniarr array and return it as string.
Definition: tcpdf_fonts.php:1817
static UTF8ArrayToUniArray($ta, $isunicode=true)
Convert an array of UTF8 values to array of unicode characters.
Definition: tcpdf_fonts.php:1778
References $FontFamily, $k, $style, $text, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\UTF8ArrayToUniArray(), and TCPDF_FONTS\UTF8StringToArray().
Here is the call graph for this function:
◆ replaceRightShiftPageNumAliases()
|
protected |
Replace right shift page number aliases with spaces to correct right alignment.
This works perfectly only when using monospaced fonts.
- Parameters
-
$page (string) Page content. $aliases (array) Array of page aliases. $diff (int) initial difference to add.
- Returns
- replaced page content.
Definition at line 7847 of file tcpdf.php.
7847 {
7848 foreach ($aliases as $type => $alias) {
7849 foreach ($alias as $a) {
7850 // find position of compensation factor
7851 $startnum = (strpos($a, ':') + 1);
7852 $a = substr($a, 0, $startnum);
7854 // end of alias
7856 // string to be replaced
7857 $aa = substr($page, $pos, ($endnum - $pos + 1));
7858 // get compensation factor
7859 $ratio = substr($page, ($pos + $startnum), ($endnum - $pos - $startnum));
7860 $ratio = preg_replace('/[^0-9\.]/', '', $ratio);
7861 $ratio = floatval($ratio);
7862 if ($type == 'u') {
7863 $chrdiff = floor(($diff + 12) * $ratio);
7864 $shift = str_repeat(' ', $chrdiff);
7866 } else {
7867 $chrdiff = floor(($diff + 11) * $ratio);
7868 $shift = str_repeat(' ', $chrdiff);
7869 }
7871 }
7872 }
7873 }
7875 }
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:
◆ resetColumns()
| TCPDF::resetColumns | ( | ) |
Remove columns and reset page margins.
- Since
- 5.9.072 (2011-04-26)
Definition at line 21719 of file tcpdf.php.
21719 {
21720 $this->lMargin = $this->original_lMargin;
21721 $this->rMargin = $this->original_rMargin;
21722 $this->setEqualColumns();
21723 }
Referenced by MC_TCPDF\PrintChapter().
Here is the caller graph for this function:
◆ resetHeaderTemplate()
| TCPDF::resetHeaderTemplate | ( | ) |
◆ resetLastH()
| TCPDF::resetLastH | ( | ) |
Reset the last cell height.
- Since
- 5.9.000 (2010-10-03)
Definition at line 2440 of file tcpdf.php.
References getCellHeight().
Referenced by getNumLines(), MultiCell(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ rollbackTransaction()
| TCPDF::rollbackTransaction | ( | $self = false | ) |
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
- Parameters
-
$self (boolean) if true restores current class object to previous state without the need of reassignment via the returned value.
- Returns
- TCPDF object.
- Since
- 4.5.029 (2009-03-19)
Definition at line 21663 of file tcpdf.php.
21663 {
21664 if (isset($this->objcopy)) {
21666 if ($self) {
21667 $objvars = get_object_vars($this->objcopy);
21668 foreach ($objvars as $key => $value) {
21669 $this->$key = $value;
21670 }
21671 }
21673 }
21674 return $this;
21675 }
Referenced by writeHTML().
Here is the caller graph for this function:
◆ Rotate()
| TCPDF::Rotate | ( | $angle, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Rotate object.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11159 of file tcpdf.php.
11159 {
11162 }
11165 }
11168 //calculate elements of transformation matrix
11169 $tm = array();
11170 $tm[0] = cos(deg2rad($angle));
11171 $tm[1] = sin(deg2rad($angle));
11172 $tm[2] = -$tm[1];
11173 $tm[3] = $tm[0];
11176 //rotate the coordinate system around ($x,$y)
11177 $this->Transform($tm);
11178 }
References $angle, $k, $x, $y, and Transform().
Referenced by MirrorL().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ RoundedRect()
| TCPDF::RoundedRect | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $r, | |||
$round_corner = '1111', |
|||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rounded rectangle.
- Parameters
-
$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).
- Since
- 2.1.000 (2008-01-08)
Definition at line 12052 of file tcpdf.php.
12052 {
12053 $this->RoundedRectXY($x, $y, $w, $h, $r, $r, $round_corner, $style, $border_style, $fill_color);
12054 }
RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array())
Draws a rounded rectangle.
Definition: tcpdf.php:12071
References $border_style, $h, $r, $style, $w, $x, $y, and RoundedRectXY().
Here is the call graph for this function:
◆ RoundedRectXY()
| TCPDF::RoundedRectXY | ( | $x, | |
| $y, | |||
| $w, | |||
| $h, | |||
| $rx, | |||
| $ry, | |||
$round_corner = '1111', |
|||
$style = '', |
|||
$border_style = array(), |
|||
$fill_color = array() |
|||
| ) |
Draws a rounded rectangle.
- Parameters
-
$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).
- Since
- 4.9.019 (2010-04-22)
Definition at line 12071 of file tcpdf.php.
12071 {
12072 if ($this->state != 2) {
12073 return;
12074 }
12075 if (($round_corner == '0000') OR (($rx == $ry) AND ($rx == 0))) {
12076 // Not rounded
12078 return;
12079 }
12080 // Rounded
12082 $this->SetFillColorArray($fill_color);
12083 }
12085 if ($op == 'f') {
12086 $border_style = array();
12087 }
12090 }
12091 $MyArc = 4 / 3 * (sqrt(2) - 1);
12096 if ($round_corner[0]) {
12097 $this->_outCurve($xc + ($rx * $MyArc), $yc - $ry, $xc + $rx, $yc - ($ry * $MyArc), $xc + $rx, $yc);
12098 } else {
12100 }
12104 if ($round_corner[1]) {
12105 $this->_outCurve($xc + $rx, $yc + ($ry * $MyArc), $xc + ($rx * $MyArc), $yc + $ry, $xc, $yc + $ry);
12106 } else {
12108 }
12112 if ($round_corner[2]) {
12113 $this->_outCurve($xc - ($rx * $MyArc), $yc + $ry, $xc - $rx, $yc + ($ry * $MyArc), $xc - $rx, $yc);
12114 } else {
12116 }
12120 if ($round_corner[3]) {
12121 $this->_outCurve($xc - $rx, $yc - ($ry * $MyArc), $xc - ($rx * $MyArc), $yc - $ry, $xc, $yc - $ry);
12122 } else {
12125 }
12126 $this->_out($op);
12127 }
References $border_style, $h, $style, $w, $x, $xc, $y, $yc, _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:
◆ Scale()
| TCPDF::Scale | ( | $s_x, | |
| $s_y, | |||
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical and horizontal non-proportional Scaling.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11033 of file tcpdf.php.
11033 {
11036 }
11039 }
11040 if (($s_x == 0) OR ($s_y == 0)) {
11042 }
11045 //calculate elements of transformation matrix
11046 $s_x /= 100;
11047 $s_y /= 100;
11048 $tm = array();
11049 $tm[0] = $s_x;
11050 $tm[1] = 0;
11051 $tm[2] = 0;
11052 $tm[3] = $s_y;
11053 $tm[4] = $x * (1 - $s_x);
11054 $tm[5] = $y * (1 - $s_y);
11055 //scale the coordinate system
11056 $this->Transform($tm);
11057 }
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:
◆ ScaleX()
| TCPDF::ScaleX | ( | $s_x, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Horizontal Scaling.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 10993 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:
◆ ScaleXY()
| TCPDF::ScaleXY | ( | $s, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical and horizontal proportional Scaling.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11019 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:
◆ ScaleY()
| TCPDF::ScaleY | ( | $s_y, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Vertical Scaling.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11006 of file tcpdf.php.
References $x, $y, and Scale().
Here is the call graph for this function:
◆ segSVGContentHandler()
|
protected |
Sets the character data handler function for the XML parser.
- Parameters
-
$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.
- Since
- 5.0.000 (2010-05-02)
Definition at line 24491 of file tcpdf.php.
References $data.
◆ selectColumn()
| TCPDF::selectColumn | ( | $col = '' | ) |
Set position at a given column.
- Parameters
-
$col (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column.
- Since
- 4.9.001 (2010-03-28)
Definition at line 21746 of file tcpdf.php.
21746 {
21747 if (is_string($col)) {
21748 $col = $this->current_column;
21749 } elseif ($col >= $this->num_columns) {
21750 $col = 0;
21751 }
21752 $xshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
21753 $enable_thead = false;
21754 if ($this->num_columns > 1) {
21755 if ($col != $this->current_column) {
21756 // move Y pointer at the top of the column
21757 if ($this->column_start_page == $this->page) {
21758 $this->y = $this->columns[$col]['y'];
21759 } else {
21760 $this->y = $this->tMargin;
21761 }
21762 // Avoid to write table headers more than once
21763 if (($this->page > $this->maxselcol['page']) OR (($this->page == $this->maxselcol['page']) AND ($col > $this->maxselcol['column']))) {
21764 $enable_thead = true;
21766 $this->maxselcol['column'] = $col;
21767 }
21768 }
21769 $xshift = $this->colxshift;
21770 // set X position of the current column by case
21772 // calculate column X position
21773 $colpos = 0;
21774 for ($i = 0; $i < $col; ++$i) {
21775 $colpos += ($this->columns[$i]['w'] + $this->columns[$i]['s']);
21776 }
21777 if ($this->rtl) {
21778 $x = $this->w - $this->original_rMargin - $colpos;
21782 } else {
21783 $x = $this->original_lMargin + $colpos;
21787 }
21789 }
21790 $this->current_column = $col;
21791 // fix for HTML mode
21792 $this->newline = true;
21793 // print HTML table header (if any)
21795 if ($enable_thead) {
21796 // print table header
21798 $this->y += $xshift['s']['V'];
21799 // store end of header position
21800 if (!isset($this->columns[$col]['th'])) {
21801 $this->columns[$col]['th'] = array();
21802 }
21804 $this->lasth = 0;
21805 } elseif (isset($this->columns[$col]['th']['\''.$this->page.'\''])) {
21806 $this->y = $this->columns[$col]['th']['\''.$this->page.'\''];
21807 }
21808 }
21809 // account for an html table cell over multiple columns
21810 if ($this->rtl) {
21811 $this->rMargin += $xshift['x'];
21812 $this->x -= ($xshift['x'] + $xshift['p']['R']);
21813 } else {
21814 $this->lMargin += $xshift['x'];
21815 $this->x += $xshift['x'] + $xshift['p']['L'];
21816 }
21817 }
$colxshift
Array of: X difference between table cell x start and starting page margin, cellspacing,...
Definition: tcpdf.php:1457
References $x, $y, and TCPDF_STATIC\empty_string().
Referenced by AcceptPageBreak(), MC_TCPDF\ChapterBody(), MultiCell(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ serializeTCPDFtagParameters()
| TCPDF::serializeTCPDFtagParameters | ( | $data | ) |
Serialize an array of parameters to be used with TCPDF tag in HTML code.
- Parameters
-
$data (array) parameters array
- Returns
- string containing serialized data static
Definition at line 17061 of file tcpdf.php.
17061 {
17062 $encoded = urlencode(json_encode($data));
17064 }
getHashForTCPDFtagParams($data)
Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance...
Definition: tcpdf.php:17051
References $data, and getHashForTCPDFtagParams().
Here is the call graph for this function:
◆ SetAbsX()
| TCPDF::SetAbsX | ( | $x | ) |
Set the absolute X coordinate of the current pointer.
- Parameters
-
$x (float) The value of the abscissa in user units.
- Since
- 5.9.186 (2012-09-13)
- See also
- setAbsX(), setAbsY(), SetAbsXY()
Definition at line 7519 of file tcpdf.php.
References $x.
Referenced by SetAbsXY().
Here is the caller graph for this function:
◆ SetAbsXY()
| TCPDF::SetAbsXY | ( | $x, | |
| $y | |||
| ) |
Set the absolute X and Y coordinates of the current pointer.
- Parameters
-
$x (float) The value of the abscissa in user units. $y (float) (float) The value of the ordinate in user units.
- Since
- 5.9.186 (2012-09-13)
- See also
- setAbsX(), setAbsY(), SetAbsXY()
Definition at line 7542 of file tcpdf.php.
7542 {
7545 }
References $x, $y, SetAbsX(), and SetAbsY().
Here is the call graph for this function:
◆ SetAbsY()
| TCPDF::SetAbsY | ( | $y | ) |
Set the absolute Y coordinate of the current pointer.
- Parameters
-
$y (float) (float) The value of the ordinate in user units.
- Since
- 5.9.186 (2012-09-13)
- See also
- setAbsX(), setAbsY(), SetAbsXY()
Definition at line 7530 of file tcpdf.php.
References $y.
Referenced by SetAbsXY().
Here is the caller graph for this function:
◆ setAlpha()
| TCPDF::setAlpha | ( | $stroking = 1, |
|
$bm = 'Normal', |
|||
$nonstroking = '', |
|||
$ais = false |
|||
| ) |
Set alpha for stroking (CA) and non-stroking (ca) operations.
- Parameters
-
$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)
- Since
- 3.0.000 (2008-03-27)
Definition at line 13909 of file tcpdf.php.
13909 {
13910 if ($this->pdfa_mode) {
13911 // transparency is not allowed in PDF/A mode
13912 return;
13913 }
13914 $stroking = floatval($stroking);
13916 // default value if not set
13917 $nonstroking = $stroking;
13918 } else {
13919 $nonstroking = floatval($nonstroking);
13920 }
13921 if ($bm[0] == '/') {
13922 // remove trailing slash
13923 $bm = substr($bm, 1);
13924 }
13925 if (!in_array($bm, array('Normal', 'Multiply', 'Screen', 'Overlay', 'Darken', 'Lighten', 'ColorDodge', 'ColorBurn', 'HardLight', 'SoftLight', 'Difference', 'Exclusion', 'Hue', 'Saturation', 'Color', 'Luminosity'))) {
13926 $bm = 'Normal';
13927 }
13928 $ais = $ais ? true : false;
13929 $this->alpha = array('CA' => $stroking, 'ca' => $nonstroking, 'BM' => '/'.$bm, 'AIS' => $ais);
13930 $gs = $this->addExtGState($this->alpha);
13931 $this->setExtGState($gs);
13932 }
addExtGState($parms)
Add transparency parameters to the current extgstate.
Definition: tcpdf.php:13797
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:
◆ SetAuthor()
| TCPDF::SetAuthor | ( | $author | ) |
Defines the author of the document.
- Parameters
-
$author (string) The name of the author.
- Since
- 1.2
- See also
- SetCreator(), SetKeywords(), SetSubject(), SetTitle()
Definition at line 2889 of file tcpdf.php.
References $author.
◆ SetAutoPageBreak()
| 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.
- Parameters
-
$auto (boolean) Boolean indicating if mode should be on or off. $margin (float) Distance from the bottom of the page.
- Since
- 1.0
- See also
- Cell(), MultiCell(), AcceptPageBreak()
Definition at line 2790 of file tcpdf.php.
2790 {
2791 $this->AutoPageBreak = $auto ? true : false;
2792 $this->bMargin = $margin;
2793 $this->PageBreakTrigger = $this->h - $margin;
2794 }
Referenced by __construct(), Close(), MYPDF\Header(), setPage(), and setPageOrientation().
Here is the caller graph for this function:
◆ setBarcode()
| TCPDF::setBarcode | ( | $bc = '' | ) |
◆ SetBooklet()
| TCPDF::SetBooklet | ( | $booklet = true, |
|
$inner = -1, |
|||
$outer = -1 |
|||
| ) |
Set the booklet mode for double-sided pages.
- Parameters
-
$booklet (boolean) true set the booklet mode on, false otherwise. $inner (float) Inner page margin. $outer (float) Outer page margin.
- Since
- 4.2.000 (2008-10-29)
Definition at line 20173 of file tcpdf.php.
20173 {
20174 $this->booklet = $booklet;
20175 if ($inner >= 0) {
20176 $this->lMargin = $inner;
20177 }
20178 if ($outer >= 0) {
20179 $this->rMargin = $outer;
20180 }
20181 }
◆ setBookmark()
| TCPDF::setBookmark | ( | $txt, | |
$level = 0, |
|||
$y = -1, |
|||
$page = '', |
|||
$style = '', |
|||
$color = array(0,0,0), |
|||
$x = -1, |
|||
$link = '' |
|||
| ) |
Adds a bookmark - alias for Bookmark().
- Parameters
-
$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|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages. $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. $color (array) 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 12285 of file tcpdf.php.
References $page, $style, $txt, $x, $y, and Bookmark().
Here is the call graph for this function:
◆ setBuffer()
|
protected |
◆ setCellHeightRatio()
| TCPDF::setCellHeightRatio | ( | $h | ) |
◆ setCellMargins()
| TCPDF::setCellMargins | ( | $left = '', |
|
$top = '', |
|||
$right = '', |
|||
$bottom = '' |
|||
| ) |
Set the internal Cell margins.
- Parameters
-
$left (float) left margin $top (float) top margin $right (float) right margin $bottom (float) bottom margin
- Since
- 5.9.000 (2010-10-03)
- See also
- getCellMargins()
Definition at line 2682 of file tcpdf.php.
2682 {
2683 if (($left !== '') AND ($left >= 0)) {
2684 $this->cell_margin['L'] = $left;
2685 }
2686 if (($top !== '') AND ($top >= 0)) {
2687 $this->cell_margin['T'] = $top;
2688 }
2689 if (($right !== '') AND ($right >= 0)) {
2690 $this->cell_margin['R'] = $right;
2691 }
2692 if (($bottom !== '') AND ($bottom >= 0)) {
2693 $this->cell_margin['B'] = $bottom;
2694 }
2695 }
Referenced by __construct(), and MultiCell().
Here is the caller graph for this function:
◆ SetCellPadding()
| TCPDF::SetCellPadding | ( | $pad | ) |
Set the same internal Cell padding for top, right, bottom, left-.
- Parameters
-
$pad (float) internal padding.
- Since
- 2.1.000 (2008-01-09)
- See also
- getCellPaddings(), setCellPaddings()
Definition at line 2627 of file tcpdf.php.
2627 {
2628 if ($pad >= 0) {
2629 $this->cell_padding['L'] = $pad;
2630 $this->cell_padding['T'] = $pad;
2631 $this->cell_padding['R'] = $pad;
2632 $this->cell_padding['B'] = $pad;
2633 }
2634 }
Referenced by openHTMLTagHandler(), setFooter(), setHeader(), Write(), and write1DBarcode().
Here is the caller graph for this function:
◆ setCellPaddings()
| TCPDF::setCellPaddings | ( | $left = '', |
|
$top = '', |
|||
$right = '', |
|||
$bottom = '' |
|||
| ) |
Set the internal Cell paddings.
- Parameters
-
$left (float) left padding $top (float) top padding $right (float) right padding $bottom (float) bottom padding
- Since
- 5.9.000 (2010-10-03)
- See also
- getCellPaddings(), SetCellPadding()
Definition at line 2646 of file tcpdf.php.
2646 {
2647 if (($left !== '') AND ($left >= 0)) {
2648 $this->cell_padding['L'] = $left;
2649 }
2650 if (($top !== '') AND ($top >= 0)) {
2651 $this->cell_padding['T'] = $top;
2652 }
2653 if (($right !== '') AND ($right >= 0)) {
2654 $this->cell_padding['R'] = $right;
2655 }
2656 if (($bottom !== '') AND ($bottom >= 0)) {
2657 $this->cell_padding['B'] = $bottom;
2658 }
2659 }
Referenced by __construct().
Here is the caller graph for this function:
◆ setColor()
| 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').
- Parameters
-
$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)
- Returns
- (string) The PDF command or empty string.
- Since
- 5.9.125 (2011-10-03)
Definition at line 3892 of file tcpdf.php.
3892 {
3893 // set default values
3894 if (!is_numeric($col1)) {
3895 $col1 = 0;
3896 }
3897 if (!is_numeric($col2)) {
3898 $col2 = -1;
3899 }
3900 if (!is_numeric($col3)) {
3901 $col3 = -1;
3902 }
3903 if (!is_numeric($col4)) {
3904 $col4 = -1;
3905 }
3906 // set color by case
3907 $suffix = '';
3908 if (($col2 == -1) AND ($col3 == -1) AND ($col4 == -1)) {
3909 // Grey scale
3910 $col1 = max(0, min(255, $col1));
3911 $intcolor = array('G' => $col1);
3913 $suffix = 'g';
3914 } elseif ($col4 == -1) {
3915 // RGB
3916 $col1 = max(0, min(255, $col1));
3917 $col2 = max(0, min(255, $col2));
3918 $col3 = max(0, min(255, $col3));
3919 $intcolor = array('R' => $col1, 'G' => $col2, 'B' => $col3);
3921 $suffix = 'rg';
3922 } else {
3923 $col1 = max(0, min(100, $col1));
3924 $col2 = max(0, min(100, $col2));
3925 $col3 = max(0, min(100, $col3));
3926 $col4 = max(0, min(100, $col4));
3927 if (empty($name)) {
3928 // CMYK
3929 $intcolor = array('C' => $col1, 'M' => $col2, 'Y' => $col3, 'K' => $col4);
3930 $pdfcolor = sprintf('%F %F %F %F ', ($col1 / 100), ($col2 / 100), ($col3 / 100), ($col4 / 100));
3931 $suffix = 'k';
3932 } else {
3933 // SPOT COLOR
3934 $intcolor = array('C' => $col1, 'M' => $col2, 'Y' => $col3, 'K' => $col4, 'name' => $name);
3935 $this->AddSpotColor($name, $col1, $col2, $col3, $col4);
3936 $pdfcolor = $this->setSpotColor($type, $name, 100);
3937 }
3938 }
3939 switch ($type) {
3940 case 'draw': {
3941 $pdfcolor .= strtoupper($suffix);
3942 $this->DrawColor = $pdfcolor;
3943 $this->strokecolor = $intcolor;
3944 break;
3945 }
3946 case 'fill': {
3947 $pdfcolor .= $suffix;
3948 $this->FillColor = $pdfcolor;
3949 $this->bgcolor = $intcolor;
3950 break;
3951 }
3952 case 'text': {
3953 $pdfcolor .= $suffix;
3954 $this->TextColor = $pdfcolor;
3955 $this->fgcolor = $intcolor;
3956 break;
3957 }
3958 }
3959 $this->ColorFlag = ($this->FillColor != $this->TextColor);
3960 if (($type != 'text') AND ($this->state == 2)) {
3962 $this->_out($pdfcolor);
3963 }
3964 return $pdfcolor;
3965 }
3966 return '';
3967 }
setSpotColor($type, $name, $tint=100)
Set the spot color for the specified type ('draw', 'fill', 'text').
Definition: tcpdf.php:3732
References $ret, $TextColor, _out(), AddSpotColor(), setSpotColor(), and sprintf.
Referenced by setColorArray(), SetDrawColor(), SetFillColor(), and SetTextColor().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setColorArray()
| 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.
- Parameters
-
$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.
- Returns
- (string) The PDF command or empty string.
- Since
- 3.1.000 (2008-06-11)
Definition at line 3817 of file tcpdf.php.
3817 {
3818 if (is_array($color)) {
3819 $color = array_values($color);
3820 // component: grey, RGB red or CMYK cyan
3821 $c = isset($color[0]) ? $color[0] : -1;
3822 // component: RGB green or CMYK magenta
3823 $m = isset($color[1]) ? $color[1] : -1;
3824 // component: RGB blue or CMYK yellow
3825 $y = isset($color[2]) ? $color[2] : -1;
3826 // component: CMYK black
3827 $k = isset($color[3]) ? $color[3] : -1;
3828 // color name
3829 $name = isset($color[4]) ? $color[4] : '';
3830 if ($c >= 0) {
3832 }
3833 }
3834 return '';
3835 }
setColor($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')
Defines the color used by the specified type ('draw', 'fill', 'text').
Definition: tcpdf.php:3892
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:
◆ setColumnsArray()
| 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).
- Parameters
-
$columns (array)
- Since
- 4.9.001 (2010-03-28)
Definition at line 21732 of file tcpdf.php.
21732 {
21733 $this->columns = $columns;
21734 $this->num_columns = count($columns);
21735 $this->current_column = 0;
21736 $this->column_start_page = $this->page;
21737 $this->selectColumn(0);
21738 }
References $columns.
◆ SetCompression()
| 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.
- Parameters
-
$compress (boolean) Boolean indicating if compression must be enabled.
- Since
- 1.4
Definition at line 2831 of file tcpdf.php.
2831 {
2832 if (function_exists('gzcompress')) {
2834 } else {
2835 $this->compress = false;
2836 }
2837 }
References $compress.
Referenced by __construct().
Here is the caller graph for this function:
◆ setContentMark()
|
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.
- Parameters
-
$page (int) page number (default is the current page)
- Since
- 4.6.021 (2009-07-20)
Definition at line 3236 of file tcpdf.php.
3236 {
3239 }
3242 } else {
3244 }
3245 }
References $page.
Referenced by MultiCell(), and setPageMark().
Here is the caller graph for this function:
◆ SetCreator()
| TCPDF::SetCreator | ( | $creator | ) |
Defines the creator of the document.
This is typically the name of the application that generates the PDF.
- Parameters
-
$creator (string) The name of the creator.
- Since
- 1.2
- See also
- SetAuthor(), SetKeywords(), SetSubject(), SetTitle()
Definition at line 2911 of file tcpdf.php.
References $creator.
◆ SetDefaultMonospacedFont()
| TCPDF::SetDefaultMonospacedFont | ( | $font | ) |
◆ setDefaultTableColumns()
| TCPDF::setDefaultTableColumns | ( | $cols = 4 | ) |
◆ setDestination()
| TCPDF::setDestination | ( | $name, | |
$y = -1, |
|||
$page = '', |
|||
$x = -1 |
|||
| ) |
Add a Named Destination.
NOTE: destination names are unique, so only last entry will be saved.
- Parameters
-
$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|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages. $x (float) X position in user units of the destiantion on the selected page (default = -1 = current position;).
- Returns
- (string) Stripped named destination identifier or false in case of error.
- Since
- 5.9.097 (2011-06-23)
Definition at line 12206 of file tcpdf.php.
12206 {
12207 // remove unsupported characters
12208 $name = TCPDF_STATIC::encodeNameObject($name);
12210 return false;
12211 }
12214 } elseif ($y < 0) {
12215 $y = 0;
12216 } elseif ($y > $this->h) {
12218 }
12221 } elseif ($x < 0) {
12222 $x = 0;
12223 } elseif ($x > $this->w) {
12225 }
12226 $fixed = false;
12229 // this page number will not be changed when moving/add/deleting pages
12230 $fixed = true;
12231 }
12235 return;
12236 }
12237 }
12239 return $name;
12240 }
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:
◆ SetDisplayMode()
| TCPDF::SetDisplayMode | ( | $zoom, | |
$layout = 'SinglePage', |
|||
$mode = 'UseNone' |
|||
| ) |
Defines the way the document is to be displayed by the viewer.
- Parameters
-
$zoom (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. - fullpage: displays the entire page on screen
- fullwidth: uses maximum width of window
- real: uses real size (equivalent to 100% zoom)
- default: uses viewer default mode
$layout (string) The page layout. Possible values are: - SinglePage Display one page at a time
- OneColumn Display the pages in one column
- TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left
- TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right
- TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
- TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right
$mode (string) A name object specifying how the document should be displayed when opened: - UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible
- UseOC (PDF 1.5) Optional content group panel visible
- UseAttachments (PDF 1.6) Attachments panel visible
- Since
- 1.2
Definition at line 2814 of file tcpdf.php.
2814 {
2815 if (($zoom == 'fullpage') OR ($zoom == 'fullwidth') OR ($zoom == 'real') OR ($zoom == 'default') OR (!is_string($zoom))) {
2816 $this->ZoomMode = $zoom;
2817 } else {
2819 }
2821 $this->PageMode = TCPDF_STATIC::getPageMode($mode);
2822 }
static getPageMode($mode='UseNone')
Get the canonical page layout mode.
Definition: tcpdf_static.php:2568
static getPageLayoutMode($layout='SinglePage')
Get the canonical page layout mode.
Definition: tcpdf_static.php:2525
References $layout, 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:
◆ setDocCreationTimestamp()
| TCPDF::setDocCreationTimestamp | ( | $time | ) |
Set the document creation timestamp.
- Parameters
-
$time (mixed) Document creation timestamp in seconds or date-time string.
- Since
- 5.9.152 (2012-03-23)
Definition at line 10182 of file tcpdf.php.
10182 {
10183 if (is_string($time)) {
10184 $time = TCPDF_STATIC::getTimestamp($time);
10185 }
10186 $this->doc_creation_timestamp = intval($time);
10187 }
static getTimestamp($date)
Returns timestamp in seconds from formatted date-time.
Definition: tcpdf_static.php:380
References TCPDF_STATIC\getTimestamp().
Here is the call graph for this function:
◆ SetDocInfoUnicode()
| 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.
- Parameters
-
$unicode (boolean) if true set the meta information in Unicode
- Since
- 5.9.027 (2010-12-01)
Definition at line 2856 of file tcpdf.php.
2856 {
2857 $this->docinfounicode = $unicode ? true : false;
2858 }
◆ setDocModificationTimestamp()
| TCPDF::setDocModificationTimestamp | ( | $time | ) |
Set the document modification timestamp.
- Parameters
-
$time (mixed) Document modification timestamp in seconds or date-time string.
- Since
- 5.9.152 (2012-03-23)
Definition at line 10195 of file tcpdf.php.
10195 {
10196 if (is_string($time)) {
10197 $time = TCPDF_STATIC::getTimestamp($time);
10198 }
10199 $this->doc_modification_timestamp = intval($time);
10200 }
References TCPDF_STATIC\getTimestamp().
Here is the call graph for this function:
◆ SetDrawColor()
| 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.
- Parameters
-
$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)
- Returns
- string the PDF command
- Since
- 1.3
- See also
- SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()
Definition at line 3982 of file tcpdf.php.
References $ret, and setColor().
Referenced by MYPDF\ColoredTable().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetDrawColorArray()
| 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.
- Parameters
-
$color (array) Array of colors (1, 3 or 4 values). $ret (boolean) If true do not send the PDF command.
- Returns
- string the PDF command
- Since
- 3.1.000 (2008-06-11)
- See also
- SetDrawColor()
Definition at line 3848 of file tcpdf.php.
3848 {
3850 }
setColorArray($type, $color, $ret=false)
Set the color array for the specified type ('draw', 'fill', 'text').
Definition: tcpdf.php:3817
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:
◆ SetDrawSpotColor()
| TCPDF::SetDrawSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
- Parameters
-
$name (string) Name of the spot color. $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- Since
- 4.0.024 (2008-09-12)
Definition at line 3778 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:
◆ setEqualColumns()
| TCPDF::setEqualColumns | ( | $numcols = 0, |
|
$width = 0, |
|||
$y = '' |
|||
| ) |
Set multiple columns of the same size.
- Parameters
-
$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)
- Since
- 4.9.001 (2010-03-28)
Definition at line 21687 of file tcpdf.php.
21687 {
21688 $this->columns = array();
21689 if ($numcols < 2) {
21690 $numcols = 0;
21691 $this->columns = array();
21692 } else {
21693 // maximum column width
21694 $maxwidth = ($this->w - $this->original_lMargin - $this->original_rMargin) / $numcols;
21695 if (($width == 0) OR ($width > $maxwidth)) {
21696 $width = $maxwidth;
21697 }
21700 }
21701 // space between columns
21702 $space = (($this->w - $this->original_lMargin - $this->original_rMargin - ($numcols * $width)) / ($numcols - 1));
21703 // fill the columns array (with, space, starting Y position)
21704 for ($i = 0; $i < $numcols; ++$i) {
21706 }
21707 }
21708 $this->num_columns = $numcols;
21709 $this->current_column = 0;
21710 $this->column_start_page = $this->page;
21711 $this->selectColumn(0);
21712 }
References $space, $y, and TCPDF_STATIC\empty_string().
Referenced by Close(), and MC_TCPDF\PrintChapter().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setExtGState()
|
protected |
Add an extgstate.
- Parameters
-
$gs (array) extgstate
- Since
- 3.0.000 (2008-03-27)
Definition at line 13828 of file tcpdf.php.
13828 {
13829 if ($this->pdfa_mode OR ($this->state != 2)) {
13830 // transparency is not allowed in PDF/A mode
13831 return;
13832 }
13834 }
References _out(), and sprintf.
Referenced by setAlpha(), and setOverprint().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setExtraXMP()
| 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!
- Parameters
-
$xmp (string) Custom XMP data.
- Since
- 5.9.128 (2011-10-06)
Definition at line 9502 of file tcpdf.php.
9502 {
9503 $this->custom_xmp = $xmp;
9504 }
◆ SetFillColor()
| 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.
- Parameters
-
$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).
- Returns
- (string) The PDF command.
- Since
- 1.3
- See also
- SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()
Definition at line 3999 of file tcpdf.php.
References $ret, and setColor().
Referenced by Button(), MC_TCPDF\ChapterTitle(), and MYPDF\ColoredTable().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetFillColorArray()
| 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.
- Parameters
-
$color (array) Array of colors (1, 3 or 4 values). $ret (boolean) If true do not send the PDF command.
- Since
- 3.1.000 (2008-6-11)
- See also
- SetFillColor()
Definition at line 3862 of file tcpdf.php.
References $ret, and setColorArray().
Referenced by Cell(), colorRegistrationBar(), Curve(), Ellipse(), Polycurve(), Polygon(), Rect(), registrationMark(), registrationMarkCMYK(), RoundedRectXY(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetFillSpotColor()
| TCPDF::SetFillSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
- Parameters
-
$name (string) Name of the spot color. $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- Since
- 4.0.024 (2008-09-12)
Definition at line 3790 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:
◆ SetFont()
| 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:
- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant
- Parameters
-
$family (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive): - times (Times-Roman)
- timesb (Times-Bold)
- timesi (Times-Italic)
- timesbi (Times-BoldItalic)
- helvetica (Helvetica)
- helveticab (Helvetica-Bold)
- helveticai (Helvetica-Oblique)
- helveticabi (Helvetica-BoldOblique)
- courier (Courier)
- courierb (Courier-Bold)
- courieri (Courier-Oblique)
- courierbi (Courier-BoldOblique)
- symbol (Symbol)
- zapfdingbats (ZapfDingbats)
$style (string) Font style. Possible values are (case insensitive): - empty string: regular
- B: bold
- I: italic
- U: underline
- D: line through
- O: overline
$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.
- Since
- 1.0
- See also
- AddFont(), SetFontSize()
Definition at line 4427 of file tcpdf.php.
4427 {
4428 //Select a font; size given in points
4431 }
4433 $size = 0;
4434 }
4435 // try to add font (if not already added)
4437 $this->FontFamily = $fontdata['family'];
4438 $this->FontStyle = $fontdata['style'];
4439 if (isset($this->CurrentFont['fontkey']) AND isset($this->CurrentFont['subsetchars'])) {
4440 // save subset chars of the previous font
4441 $this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
4442 }
4445 }
References $FontSizePt, $out, $size, $style, AddFont(), getFontBuffer(), SetFontSize(), and setFontSubBuffer().
Referenced by __construct(), addHtmlLink(), MC_TCPDF\ChapterBody(), MC_TCPDF\ChapterTitle(), Close(), MYPDF\ColoredTable(), MYPDF\Footer(), GetArrStringWidth(), MYPDF\Header(), Header(), setFooter(), setHeader(), write1DBarcode(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setFontBuffer()
|
protected |
Set font buffer content.
- Parameters
-
$font (string) font key $data (array) font data
- Since
- 4.5.000 (2009-01-02)
Definition at line 20803 of file tcpdf.php.
20803 {
20804 $this->fonts[$font] = $data;
20805 if (!in_array($font, $this->fontkeys)) {
20806 $this->fontkeys[] = $font;
20807 // store object ID for current font
20808 ++$this->n;
20809 $this->font_obj_ids[$font] = $this->n;
20811 }
20812 }
Referenced by AddFont().
Here is the caller graph for this function:
◆ SetFontSize()
| TCPDF::SetFontSize | ( | $size, | |
$out = true |
|||
| ) |
Defines the size of the current font.
- Parameters
-
$size (float) The font size in points. $out (boolean) if true output the font size command, otherwise only set the font properties.
- Since
- 1.0
- See also
- SetFont()
Definition at line 4455 of file tcpdf.php.
4455 {
4456 // font size in points
4457 $this->FontSizePt = $size;
4458 // font size in user units
4460 // calculate some font metrics
4461 if (isset($this->CurrentFont['desc']['FontBBox'])) {
4462 $bbox = explode(' ', substr($this->CurrentFont['desc']['FontBBox'], 1, -1));
4463 $font_height = ((intval($bbox[3]) - intval($bbox[1])) * $size / 1000);
4464 } else {
4465 $font_height = $size * 1.219;
4466 }
4467 if (isset($this->CurrentFont['desc']['Ascent']) AND ($this->CurrentFont['desc']['Ascent'] > 0)) {
4469 }
4470 if (isset($this->CurrentFont['desc']['Descent']) AND ($this->CurrentFont['desc']['Descent'] <= 0)) {
4472 }
4473 if (!isset($font_ascent) AND !isset($font_descent)) {
4474 // core font
4475 $font_ascent = 0.76 * $font_height;
4476 $font_descent = $font_height - $font_ascent;
4477 } elseif (!isset($font_descent)) {
4478 $font_descent = $font_height - $font_ascent;
4479 } elseif (!isset($font_ascent)) {
4480 $font_ascent = $font_height - $font_descent;
4481 }
4482 $this->FontAscent = ($font_ascent / $this->k);
4483 $this->FontDescent = ($font_descent / $this->k);
4486 }
4487 }
References $k, $out, $size, _out(), and sprintf.
Referenced by MultiCell(), and SetFont().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setFontSpacing()
| TCPDF::setFontSpacing | ( | $spacing = 0 | ) |
Set the amount to increase or decrease the space between characters in a text.
- Parameters
-
$spacing (float) amount to increase or decrease the space between characters in a text (0 = default spacing)
- Since
- 5.9.000 (2010-09-29)
Definition at line 22489 of file tcpdf.php.
22489 {
22490 $this->font_spacing = $spacing;
22491 }
Referenced by writeHTML().
Here is the caller graph for this function:
◆ setFontStretching()
| TCPDF::setFontStretching | ( | $perc = 100 | ) |
Set the percentage of character stretching.
- Parameters
-
$perc (int) percentage of stretching (100 = no stretching)
- Since
- 5.9.000 (2010-09-29)
Definition at line 22467 of file tcpdf.php.
22467 {
22468 $this->font_stretching = $perc;
22469 }
Referenced by writeHTML().
Here is the caller graph for this function:
◆ setFontSubBuffer()
|
protected |
Set font buffer content.
- Parameters
-
$font (string) font key $key (string) font sub-key $data (array) font data
- Since
- 4.5.000 (2009-01-02)
Definition at line 20822 of file tcpdf.php.
20822 {
20823 if (!isset($this->fonts[$font])) {
20824 $this->setFontBuffer($font, array());
20825 }
20826 $this->fonts[$font][$key] = $data;
20827 }
References $data.
Referenced by _enddoc(), AddFont(), getCellCode(), and SetFont().
Here is the caller graph for this function:
◆ setFontSubsetting()
| TCPDF::setFontSubsetting | ( | $enable = true | ) |
Enable or disable default option for font subsetting.
- Parameters
-
$enable (boolean) if true enable font subsetting by default.
- Since
- 5.3.002 (2010-06-07)
Definition at line 22117 of file tcpdf.php.
22117 {
22118 if ($this->pdfa_mode) {
22119 $this->font_subsetting = false;
22120 } else {
22121 $this->font_subsetting = $enable ? true : false;
22122 }
22123 }
◆ setFooter()
|
protected |
This method is used to render the page footer.
- Since
- 4.0.012 (2008-07-24)
Definition at line 3557 of file tcpdf.php.
3557 {
3558 if ($this->state != 2) {
3559 return;
3560 }
3561 $this->InFooter = true;
3562 // save current graphic settings
3563 $gvars = $this->getGraphicVars();
3564 // mark this point
3567 if ($this->print_footer) {
3568 $this->setGraphicVars($this->default_graphic_vars);
3569 $this->current_column = 0;
3570 $this->num_columns = 1;
3571 $temp_thead = $this->thead;
3572 $temp_theadMargins = $this->theadMargins;
3574 $this->_outSaveGraphicsState();
3575 $this->rMargin = $this->original_rMargin;
3576 $this->lMargin = $this->original_lMargin;
3577 $this->SetCellPadding(0);
3578 //set current position
3579 $footer_y = $this->h - $this->footer_margin;
3580 if ($this->rtl) {
3581 $this->SetXY($this->original_rMargin, $footer_y);
3582 } else {
3583 $this->SetXY($this->original_lMargin, $footer_y);
3584 }
3585 $this->SetFont($this->footer_font[0], $this->footer_font[1], $this->footer_font[2]);
3586 $this->Footer();
3587 //restore position
3588 if ($this->rtl) {
3589 $this->SetXY($this->original_rMargin, $this->tMargin);
3590 } else {
3591 $this->SetXY($this->original_lMargin, $this->tMargin);
3592 }
3593 $this->_outRestoreGraphicsState();
3594 $this->lasth = $lasth;
3595 $this->thead = $temp_thead;
3596 $this->theadMargins = $temp_theadMargins;
3597 }
3598 // restore graphic settings
3599 $this->setGraphicVars($gvars);
3600 $this->current_column = $gvars['current_column'];
3601 $this->num_columns = $gvars['num_columns'];
3602 // calculate footer length
3603 $this->footerlen[$this->page] = $this->pagelen[$this->page] - $this->footerpos[$this->page] + 1;
3604 $this->InFooter = false;
3605 }
References $footer_margin, $lasth, $original_lMargin, $original_rMargin, $page, $thead, $theadMargins, _out(), _outRestoreGraphicsState(), _outSaveGraphicsState(), 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:
◆ setFooterData()
| TCPDF::setFooterData | ( | $tc = array(0,0,0), |
|
$lc = array(0,0,0) |
|||
| ) |
◆ setFooterFont()
| TCPDF::setFooterFont | ( | $font | ) |
Set footer font.
- Parameters
-
$font (array) Array describing the basic font parameters: (family, style, size).
- Since
- 1.1
Definition at line 10322 of file tcpdf.php.
10322 {
10323 $this->footer_font = $font;
10324 }
Referenced by __construct().
Here is the caller graph for this function:
◆ setFooterMargin()
| TCPDF::setFooterMargin | ( | $fm = 10 | ) |
◆ setFormDefaultProp()
| TCPDF::setFormDefaultProp | ( | $prop = array() | ) |
◆ setGraphicVars()
|
protected |
Set graphic variables.
- Parameters
-
$gvars (array) array of graphic variablesto restore $extended (boolean) if true restore extended graphic variables
- Since
- 4.2.010 (2008-11-14)
Definition at line 20606 of file tcpdf.php.
20606 {
20607 if ($this->state != 2) {
20608 return;
20609 }
20610 $this->FontFamily = $gvars['FontFamily'];
20611 $this->FontStyle = $gvars['FontStyle'];
20612 $this->FontSizePt = $gvars['FontSizePt'];
20613 $this->rMargin = $gvars['rMargin'];
20614 $this->lMargin = $gvars['lMargin'];
20615 $this->cell_padding = $gvars['cell_padding'];
20616 $this->cell_margin = $gvars['cell_margin'];
20617 $this->LineWidth = $gvars['LineWidth'];
20618 $this->linestyleWidth = $gvars['linestyleWidth'];
20619 $this->linestyleCap = $gvars['linestyleCap'];
20620 $this->linestyleJoin = $gvars['linestyleJoin'];
20621 $this->linestyleDash = $gvars['linestyleDash'];
20622 $this->textrendermode = $gvars['textrendermode'];
20623 $this->textstrokewidth = $gvars['textstrokewidth'];
20624 $this->DrawColor = $gvars['DrawColor'];
20625 $this->FillColor = $gvars['FillColor'];
20626 $this->TextColor = $gvars['TextColor'];
20627 $this->ColorFlag = $gvars['ColorFlag'];
20628 $this->bgcolor = $gvars['bgcolor'];
20629 $this->fgcolor = $gvars['fgcolor'];
20630 $this->htmlvspace = $gvars['htmlvspace'];
20631 $this->listindent = $gvars['listindent'];
20632 $this->listindentlevel = $gvars['listindentlevel'];
20633 $this->listnum = $gvars['listnum'];
20634 $this->listordered = $gvars['listordered'];
20635 $this->listcount = $gvars['listcount'];
20636 $this->lispacer = $gvars['lispacer'];
20637 $this->cell_height_ratio = $gvars['cell_height_ratio'];
20638 $this->font_stretching = $gvars['font_stretching'];
20639 $this->font_spacing = $gvars['font_spacing'];
20640 $this->alpha = $gvars['alpha'];
20641 if ($extended) {
20642 // restore extended values
20643 $this->lasth = $gvars['lasth'];
20644 $this->tMargin = $gvars['tMargin'];
20645 $this->bMargin = $gvars['bMargin'];
20646 $this->AutoPageBreak = $gvars['AutoPageBreak'];
20647 $this->PageBreakTrigger = $gvars['PageBreakTrigger'];
20648 $this->x = $gvars['x'];
20649 $this->y = $gvars['y'];
20650 $this->w = $gvars['w'];
20651 $this->h = $gvars['h'];
20652 $this->wPt = $gvars['wPt'];
20653 $this->hPt = $gvars['hPt'];
20654 $this->fwPt = $gvars['fwPt'];
20655 $this->fhPt = $gvars['fhPt'];
20656 $this->page = $gvars['page'];
20657 $this->current_column = $gvars['current_column'];
20658 $this->num_columns = $gvars['num_columns'];
20659 }
20660 $this->_out(''.$this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor.' '.$this->FillColor.'');
20662 $this->SetFont($this->FontFamily, $this->FontStyle, $this->FontSizePt);
20663 }
20664 }
References TCPDF_STATIC\empty_string().
Referenced by Close(), setFooter(), setHeader(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setHeader()
|
protected |
This method is used to render the page header.
- Since
- 4.0.012 (2008-07-24)
Definition at line 3516 of file tcpdf.php.
3516 {
3517 if (!$this->print_header OR ($this->state != 2)) {
3518 return;
3519 }
3520 $this->InHeader = true;
3521 $this->setGraphicVars($this->default_graphic_vars);
3522 $temp_thead = $this->thead;
3523 $temp_theadMargins = $this->theadMargins;
3526 $this->_outSaveGraphicsState();
3527 $this->rMargin = $this->original_rMargin;
3528 $this->lMargin = $this->original_lMargin;
3529 $this->SetCellPadding(0);
3530 //set current position
3531 if ($this->rtl) {
3532 $this->SetXY($this->original_rMargin, $this->header_margin);
3533 } else {
3534 $this->SetXY($this->original_lMargin, $this->header_margin);
3535 }
3536 $this->SetFont($this->header_font[0], $this->header_font[1], $this->header_font[2]);
3537 $this->Header();
3538 //restore position
3539 if ($this->rtl) {
3540 $this->SetXY($this->original_rMargin, $this->tMargin);
3541 } else {
3542 $this->SetXY($this->original_lMargin, $this->tMargin);
3543 }
3544 $this->_outRestoreGraphicsState();
3545 $this->lasth = $lasth;
3546 $this->thead = $temp_thead;
3547 $this->theadMargins = $temp_theadMargins;
3548 $this->newline = $newline;
3549 $this->InHeader = false;
3550 }
References $lasth, $newline, $original_lMargin, $original_rMargin, $thead, $theadMargins, _outRestoreGraphicsState(), _outSaveGraphicsState(), 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:
◆ setHeaderData()
| TCPDF::setHeaderData | ( | $ln = '', |
|
$lw = 0, |
|||
$ht = '', |
|||
$hs = '', |
|||
$tc = array(0,0,0), |
|||
$lc = array(0,0,0) |
|||
| ) |
Set header data.
- Parameters
-
$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 3257 of file tcpdf.php.
3257 {
3258 $this->header_logo = $ln;
3259 $this->header_logo_width = $lw;
3260 $this->header_title = $ht;
3261 $this->header_string = $hs;
3262 $this->header_text_color = $tc;
3263 $this->header_line_color = $lc;
3264 }
◆ setHeaderFont()
| TCPDF::setHeaderFont | ( | $font | ) |
Set header font.
- Parameters
-
$font (array) Array describing the basic font parameters: (family, style, size).
- Since
- 1.1
Definition at line 10302 of file tcpdf.php.
10302 {
10303 $this->header_font = $font;
10304 }
Referenced by __construct().
Here is the caller graph for this function:
◆ setHeaderMargin()
| TCPDF::setHeaderMargin | ( | $hm = 10 | ) |
◆ setHeaderTemplateAutoreset()
| TCPDF::setHeaderTemplateAutoreset | ( | $val = true | ) |
Set a flag to automatically reset the xobject template used by Header() method at each page.
- Parameters
-
$val (boolean) set to true to reset Header xobject template at each page, false otherwise.
Definition at line 3383 of file tcpdf.php.
3383 {
3384 $this->header_xobj_autoreset = $val ? true : false;
3385 }
◆ setHtmlLinksStyle()
| TCPDF::setHtmlLinksStyle | ( | $color = array(0,0,255), |
|
$fontstyle = 'U' |
|||
| ) |
Set the color and font style for HTML links.
- Parameters
-
$color (array) RGB array of colors $fontstyle (string) additional font styles to add
- Since
- 4.4.003 (2008-12-09)
Definition at line 20244 of file tcpdf.php.
20244 {
20245 $this->htmlLinkColorArray = $color;
20246 $this->htmlLinkFontStyle = $fontstyle;
20247 }
◆ setHtmlVSpace()
| 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.
- Parameters
-
$tagvs (array) array of tags and relative vertical spaces.
- Since
- 4.2.001 (2008-10-30)
Definition at line 20213 of file tcpdf.php.
20213 {
20214 $this->tagvspaces = $tagvs;
20215 }
◆ setImageBuffer()
|
protected |
Set image buffer content.
- Parameters
-
$image (string) image key $data (array) image data
- Returns
- int image index number
- Since
- 4.5.000 (2008-12-31)
Definition at line 20757 of file tcpdf.php.
20757 {
20759 $this->imagekeys[$this->numimages] = $image;
20761 ++$this->numimages;
20762 }
20763 $this->images[$image] = $data;
20765 }
References $data.
Referenced by Image().
Here is the caller graph for this function:
◆ setImageScale()
| TCPDF::setImageScale | ( | $scale | ) |
◆ setImageSubBuffer()
|
protected |
Set image buffer content for a specified sub-key.
- Parameters
-
$image (string) image key $key (string) image sub-key $data (array) image data
- Since
- 4.5.000 (2008-12-31)
Definition at line 20775 of file tcpdf.php.
20775 {
20776 if (!isset($this->images[$image])) {
20777 $this->setImageBuffer($image, array());
20778 }
20779 $this->images[$image][$key] = $data;
20780 }
References $data.
Referenced by _putimages().
Here is the caller graph for this function:
◆ setJPEGQuality()
| TCPDF::setJPEGQuality | ( | $quality | ) |
Set the default JPEG compression quality (1-100)
- Parameters
-
$quality (int) JPEG quality, integer between 1 and 100
- Since
- 3.0.000 (2008-03-27)
Definition at line 13951 of file tcpdf.php.
13951 {
13952 if (($quality < 1) OR ($quality > 100)) {
13953 $quality = 75;
13954 }
13955 $this->jpeg_quality = intval($quality);
13956 }
◆ SetKeywords()
| TCPDF::SetKeywords | ( | $keywords | ) |
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
- Parameters
-
$keywords (string) The list of keywords.
- Since
- 1.2
- See also
- SetAuthor(), SetCreator(), SetSubject(), SetTitle()
Definition at line 2900 of file tcpdf.php.
References $keywords.
◆ setLanguageArray()
| TCPDF::setLanguageArray | ( | $language | ) |
Set language array.
- Parameters
-
$language (array)
- Since
- 1.1
Definition at line 10342 of file tcpdf.php.
10342 {
10343 $this->l = $language;
10344 if (isset($this->l['a_meta_dir'])) {
10345 $this->rtl = $this->l['a_meta_dir']=='rtl' ? true : false;
10346 } else {
10347 $this->rtl = false;
10348 }
10349 }
◆ setLastH()
| TCPDF::setLastH | ( | $h | ) |
◆ SetLeftMargin()
| 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.
- Parameters
-
$margin (float) The margin.
- Since
- 1.4
Definition at line 2583 of file tcpdf.php.
2583 {
2584 //Set left margin
2585 $this->lMargin = $margin;
2586 if (($this->page > 0) AND ($this->x < $margin)) {
2587 $this->x = $margin;
2588 }
2589 }
◆ SetLineStyle()
| TCPDF::SetLineStyle | ( | $style, | |
$ret = false |
|||
| ) |
Set line style.
- Parameters
-
$style (array) Line style. Array with keys among the following: - width (float): Width of the line in user units.
- cap (string): Type of cap to put on the line. Possible values are: butt, round, square. The difference between "square" and "butt" is that "square" projects a flat end past the end of the line.
- join (string): Type of join. Possible values are: miter, round, bevel.
- dash (mixed): Dash pattern. Is 0 (without dash) or string with series of length values, which are the lengths of the on and off dashes. For example: "2" represents 2 on, 2 off, 2 on, 2 off, ...; "2,1" is 2 on, 1 off, 2 on, 1 off, ...
- phase (integer): Modifier on the dash pattern which is used to shift the point at which the pattern starts.
- color (array): Draw color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName).
$ret (boolean) if true do not send the command.
- Returns
- string the PDF command
- Since
- 2.1.000 (2008-01-08)
Definition at line 11322 of file tcpdf.php.
11322 {
11323 $s = ''; // string to be returned
11325 return;
11326 }
11330 $s .= $this->linestyleWidth.' ';
11331 }
11333 $ca = array('butt' => 0, 'round'=> 1, 'square' => 2);
11336 $s .= $this->linestyleCap.' ';
11337 }
11338 }
11340 $ja = array('miter' => 0, 'round' => 1, 'bevel' => 2);
11343 $s .= $this->linestyleJoin.' ';
11344 }
11345 }
11347 $dash_string = '';
11351 } else {
11353 }
11354 $dash_string = '';
11356 if ($i) {
11357 $dash_string .= ' ';
11358 }
11360 }
11361 }
11364 }
11366 $s .= $this->linestyleDash.' ';
11367 }
11370 }
11372 $this->_out($s);
11373 }
11374 return $s;
11375 }
References $ret, $style, $tab, _out(), SetDrawColorArray(), and sprintf.
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:
◆ SetLineWidth()
| 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.
- Parameters
-
$width (float) The width.
- Since
- 1.0
- See also
- Line(), Rect(), Cell(), MultiCell()
Definition at line 11279 of file tcpdf.php.
11279 {
11280 //Set line width
11281 $this->LineWidth = $width;
11283 if ($this->state == 2) {
11284 $this->_out($this->linestyleWidth);
11285 }
11286 }
References _out(), and sprintf.
Referenced by MYPDF\ColoredTable(), and openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetLink()
| TCPDF::SetLink | ( | $link, | |
$y = 0, |
|||
$page = -1 |
|||
| ) |
Defines the page and position a link points to.
- Parameters
-
$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 (default value). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
- Since
- 1.5
- See also
- AddLink()
Definition at line 4699 of file tcpdf.php.
4699 {
4700 $fixed = false;
4703 // this page number will not be changed when moving/add/deleting pages
4704 $fixed = true;
4705 }
4708 }
4711 }
4713 }
Referenced by addHtmlLink(), and openHTMLTagHandler().
Here is the caller graph for this function:
◆ setListIndentWidth()
| TCPDF::setListIndentWidth | ( | $width | ) |
◆ setLIsymbol()
| TCPDF::setLIsymbol | ( | $symbol = '!' | ) |
Set the default bullet to be used as LI bullet symbol.
- Parameters
-
$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')
- Since
- 4.0.028 (2008-09-26)
Definition at line 20150 of file tcpdf.php.
20150 {
20151 // check for custom image symbol
20152 if (substr($symbol, 0, 4) == 'img|') {
20153 $this->lisymbol = $symbol;
20154 return;
20155 }
20156 $symbol = strtolower($symbol);
20157 $valid_symbols = array('!', '#', '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');
20158 if (in_array($symbol, $valid_symbols)) {
20159 $this->lisymbol = $symbol;
20160 } else {
20161 $this->lisymbol = '';
20162 }
20163 }
◆ SetMargins()
| TCPDF::SetMargins | ( | $left, | |
| $top, | |||
$right = -1, |
|||
$keepmargins = false |
|||
| ) |
Defines the left, top and right margins.
- Parameters
-
$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
- Since
- 1.0
Definition at line 2561 of file tcpdf.php.
2561 {
2562 //Set left, top and right margins
2563 $this->lMargin = $left;
2564 $this->tMargin = $top;
2565 if ($right == -1) {
2566 $right = $left;
2567 }
2568 $this->rMargin = $right;
2569 if ($keepmargins) {
2570 // overwrite original values
2571 $this->original_lMargin = $this->lMargin;
2572 $this->original_rMargin = $this->rMargin;
2573 }
2574 }
References $lMargin, and $rMargin.
Referenced by __construct().
Here is the caller graph for this function:
◆ setOpenCell()
| TCPDF::setOpenCell | ( | $isopen | ) |
Set the top/bottom cell sides to be open or closed when the cell cross the page.
- Parameters
-
$isopen (boolean) if true keeps the top/bottom border open for the cell sides that cross the page.
- Since
- 4.2.010 (2008-11-14)
Definition at line 20233 of file tcpdf.php.
20233 {
20234 $this->opencell = $isopen;
20235 }
◆ setOverprint()
| 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).
- Parameters
-
$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).
- Since
- 5.9.152 (2012-03-23)
Definition at line 13870 of file tcpdf.php.
13870 {
13871 if ($this->state != 2) {
13872 return;
13873 }
13874 $stroking = $stroking ? true : false;
13876 // default value if not set
13877 $nonstroking = $stroking;
13878 } else {
13879 $nonstroking = $nonstroking ? true : false;
13880 }
13881 if (($mode != 0) AND ($mode != 1)) {
13882 $mode = 0;
13883 }
13884 $this->overprint = array('OP' => $stroking, 'op' => $nonstroking, 'OPM' => $mode);
13885 $gs = $this->addExtGState($this->overprint);
13886 $this->setExtGState($gs);
13887 }
References addExtGState(), TCPDF_STATIC\empty_string(), and setExtGState().
Here is the call graph for this function:
◆ setPage()
| TCPDF::setPage | ( | $pnum, | |
$resetmargins = false |
|||
| ) |
Move pointer at the specified document page and update page dimensions.
- Parameters
-
$pnum (int) page number (1 ... numpages) $resetmargins (boolean) if true reset left, right, top margins and Y position.
- Since
- 2.1.000 (2008-01-07)
- See also
- getPage(), lastpage(), getNumPages()
Definition at line 2995 of file tcpdf.php.
2995 {
2996 if (($pnum == $this->page) AND ($this->state == 2)) {
2997 return;
2998 }
2999 if (($pnum > 0) AND ($pnum <= $this->numpages)) {
3000 $this->state = 2;
3001 // save current graphic settings
3002 //$gvars = $this->getGraphicVars();
3003 $oldpage = $this->page;
3004 $this->page = $pnum;
3015 $this->SetAutoPageBreak($this->AutoPageBreak, $this->bMargin);
3016 // restore graphic settings
3017 //$this->setGraphicVars($gvars);
3018 if ($resetmargins) {
3021 $this->SetY($this->tMargin);
3022 } else {
3023 // account for booklet mode
3024 if ($this->pagedim[$this->page]['olm'] != $this->pagedim[$oldpage]['olm']) {
3026 $this->lMargin += $deltam;
3027 $this->rMargin -= $deltam;
3028 }
3029 }
3030 } else {
3032 }
3033 }
References $page, Error(), SetAutoPageBreak(), and SetY().
Referenced by lastPage(), MultiCell(), MYPDF\MultiRow(), startPage(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setPageBoxTypes()
|
protected |
Set page boxes to be included on page descriptions.
- Parameters
-
$boxes (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox').
Definition at line 7882 of file tcpdf.php.
7882 {
7883 $this->page_boxes = array();
7884 foreach ($boxes as $box) {
7886 $this->page_boxes[] = $box;
7887 }
7888 }
7889 }
References TCPDF_STATIC\$pageboxes.
◆ setPageBuffer()
|
protected |
Set page buffer content.
- Parameters
-
$page (int) page number $data (string) page data $append (boolean) if true append data, false replace.
- Since
- 4.5.000 (2008-12-31)
Definition at line 20722 of file tcpdf.php.
20722 {
20723 if ($append) {
20725 } else {
20727 }
20730 } else {
20732 }
20733 }
References $data.
Referenced by _beginpage(), _out(), MultiCell(), and writeHTML().
Here is the caller graph for this function:
◆ setPageFormat()
|
protected |
Change the format of the current page.
- Parameters
-
$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 numbers (width, height) or an array containing the following measures and options: - ['format'] = page format name (one of the above);
- ['Rotate'] : The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
- ['PZ'] : The page's preferred zoom (magnification) factor.
- ['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed:
- ['MediaBox']['llx'] : lower-left x coordinate
- ['MediaBox']['lly'] : lower-left y coordinate
- ['MediaBox']['urx'] : upper-right x coordinate
- ['MediaBox']['ury'] : upper-right y coordinate
- ['CropBox'] : the visible region of default user space:
- ['CropBox']['llx'] : lower-left x coordinate
- ['CropBox']['lly'] : lower-left y coordinate
- ['CropBox']['urx'] : upper-right x coordinate
- ['CropBox']['ury'] : upper-right y coordinate
- ['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment:
- ['BleedBox']['llx'] : lower-left x coordinate
- ['BleedBox']['lly'] : lower-left y coordinate
- ['BleedBox']['urx'] : upper-right x coordinate
- ['BleedBox']['ury'] : upper-right y coordinate
- ['TrimBox'] : the intended dimensions of the finished page after trimming:
- ['TrimBox']['llx'] : lower-left x coordinate
- ['TrimBox']['lly'] : lower-left y coordinate
- ['TrimBox']['urx'] : upper-right x coordinate
- ['TrimBox']['ury'] : upper-right y coordinate
- ['ArtBox'] : the extent of the page's meaningful content:
- ['ArtBox']['llx'] : lower-left x coordinate
- ['ArtBox']['lly'] : lower-left y coordinate
- ['ArtBox']['urx'] : upper-right x coordinate
- ['ArtBox']['ury'] : upper-right y coordinate
- ['BoxColorInfo'] :specify the colours and other visual characteristics that should be used in displaying guidelines on the screen for each of the possible page boundaries other than the MediaBox:
- ['BoxColorInfo'][BOXTYPE]['C'] : an array of three numbers in the range 0-255, representing the components in the DeviceRGB colour space.
- ['BoxColorInfo'][BOXTYPE]['W'] : the guideline width in default user units
- ['BoxColorInfo'][BOXTYPE]['S'] : the guideline style: S = Solid; D = Dashed
- ['BoxColorInfo'][BOXTYPE]['D'] : dash array defining a pattern of dashes and gaps to be used in drawing dashed guidelines
- ['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation
- ['trans']['Dur'] : The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.
- ['trans']['S'] : transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade
- ['trans']['D'] : The duration of the transition effect, in seconds.
- ['trans']['Dm'] : (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.
- ['trans']['M'] : (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.
- ['trans']['Di'] : (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.
- ['trans']['SS'] : (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.
- ['trans']['B'] : (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.
$orientation (string) page orientation. Possible values are (case insensitive): - P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
- Since
- 3.0.015 (2008-06-06)
- See also
- getPageSizeFromFormat()
Definition at line 2103 of file tcpdf.php.
2103 {
2104 if (!empty($format) AND isset($this->pagedim[$this->page])) {
2105 // remove inherited values
2106 unset($this->pagedim[$this->page]);
2107 }
2108 if (is_string($format)) {
2109 // get page measures from format name
2110 $pf = TCPDF_STATIC::getPageSizeFromFormat($format);
2111 $this->fwPt = $pf[0];
2112 $this->fhPt = $pf[1];
2113 } else {
2114 // the boundaries of the physical medium on which the page shall be displayed or printed
2115 if (isset($format['MediaBox'])) {
2116 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'MediaBox', $format['MediaBox']['llx'], $format['MediaBox']['lly'], $format['MediaBox']['urx'], $format['MediaBox']['ury'], false, $this->k, $this->pagedim);
2117 $this->fwPt = (($format['MediaBox']['urx'] - $format['MediaBox']['llx']) * $this->k);
2118 $this->fhPt = (($format['MediaBox']['ury'] - $format['MediaBox']['lly']) * $this->k);
2119 } else {
2120 if (isset($format[0]) AND is_numeric($format[0]) AND isset($format[1]) AND is_numeric($format[1])) {
2121 $pf = array(($format[0] * $this->k), ($format[1] * $this->k));
2122 } else {
2123 if (!isset($format['format'])) {
2124 // default value
2125 $format['format'] = 'A4';
2126 }
2128 }
2129 $this->fwPt = $pf[0];
2130 $this->fhPt = $pf[1];
2131 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'MediaBox', 0, 0, $this->fwPt, $this->fhPt, true, $this->k, $this->pagedim);
2132 }
2133 // the visible region of default user space
2134 if (isset($format['CropBox'])) {
2135 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'CropBox', $format['CropBox']['llx'], $format['CropBox']['lly'], $format['CropBox']['urx'], $format['CropBox']['ury'], false, $this->k, $this->pagedim);
2136 }
2137 // the region to which the contents of the page shall be clipped when output in a production environment
2138 if (isset($format['BleedBox'])) {
2139 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'BleedBox', $format['BleedBox']['llx'], $format['BleedBox']['lly'], $format['BleedBox']['urx'], $format['BleedBox']['ury'], false, $this->k, $this->pagedim);
2140 }
2141 // the intended dimensions of the finished page after trimming
2142 if (isset($format['TrimBox'])) {
2143 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'TrimBox', $format['TrimBox']['llx'], $format['TrimBox']['lly'], $format['TrimBox']['urx'], $format['TrimBox']['ury'], false, $this->k, $this->pagedim);
2144 }
2145 // the page's meaningful content (including potential white space)
2146 if (isset($format['ArtBox'])) {
2147 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'ArtBox', $format['ArtBox']['llx'], $format['ArtBox']['lly'], $format['ArtBox']['urx'], $format['ArtBox']['ury'], false, $this->k, $this->pagedim);
2148 }
2149 // specify the colours and other visual characteristics that should be used in displaying guidelines on the screen for the various page boundaries
2150 if (isset($format['BoxColorInfo'])) {
2152 }
2153 if (isset($format['Rotate']) AND (($format['Rotate'] % 90) == 0)) {
2154 // The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
2156 }
2157 if (isset($format['PZ'])) {
2158 // The page's preferred zoom (magnification) factor
2160 }
2161 if (isset($format['trans'])) {
2162 // The style and duration of the visual transition to use when moving from another page to the given page during a presentation
2163 if (isset($format['trans']['Dur'])) {
2164 // The page's display duration
2166 }
2167 $stansition_styles = array('Split', 'Blinds', 'Box', 'Wipe', 'Dissolve', 'Glitter', 'R', 'Fly', 'Push', 'Cover', 'Uncover', 'Fade');
2168 if (isset($format['trans']['S']) AND in_array($format['trans']['S'], $stansition_styles)) {
2169 // The transition style that shall be used when moving to this page from another during a presentation
2171 $valid_effect = array('Split', 'Blinds');
2172 $valid_vals = array('H', 'V');
2173 if (isset($format['trans']['Dm']) AND in_array($format['trans']['S'], $valid_effect) AND in_array($format['trans']['Dm'], $valid_vals)) {
2175 }
2176 $valid_effect = array('Split', 'Box', 'Fly');
2177 $valid_vals = array('I', 'O');
2178 if (isset($format['trans']['M']) AND in_array($format['trans']['S'], $valid_effect) AND in_array($format['trans']['M'], $valid_vals)) {
2180 }
2181 $valid_effect = array('Wipe', 'Glitter', 'Fly', 'Cover', 'Uncover', 'Push');
2182 if (isset($format['trans']['Di']) AND in_array($format['trans']['S'], $valid_effect)) {
2183 if (((($format['trans']['Di'] == 90) OR ($format['trans']['Di'] == 180)) AND ($format['trans']['S'] == 'Wipe'))
2184 OR (($format['trans']['Di'] == 315) AND ($format['trans']['S'] == 'Glitter'))
2185 OR (($format['trans']['Di'] == 0) OR ($format['trans']['Di'] == 270))) {
2187 }
2188 }
2189 if (isset($format['trans']['SS']) AND ($format['trans']['S'] == 'Fly')) {
2191 }
2192 if (isset($format['trans']['B']) AND ($format['trans']['B'] === true) AND ($format['trans']['S'] == 'Fly')) {
2194 }
2195 } else {
2197 }
2198 if (isset($format['trans']['D'])) {
2199 // The duration of the transition effect, in seconds
2201 } else {
2203 }
2204 }
2205 }
2206 $this->setPageOrientation($orientation);
2207 }
static setPageBoxes($page, $type, $llx, $lly, $urx, $ury, $points=false, $k, $pagedim=array())
Set page boundaries.
Definition: tcpdf_static.php:2478
static getPageSizeFromFormat($format)
Get page dimensions from format name.
Definition: tcpdf_static.php:2456
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:
◆ setPageMark()
| 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.
- Since
- 4.0.016 (2008-07-30)
Definition at line 3223 of file tcpdf.php.
References $page, and setContentMark().
Referenced by MYPDF\Header(), and startPage().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setPageOrientation()
| TCPDF::setPageOrientation | ( | $orientation, | |
$autopagebreak = '', |
|||
$bottommargin = '' |
|||
| ) |
Set page orientation.
- Parameters
-
$orientation (string) page orientation. Possible values are (case insensitive): - P or Portrait (default)
- L or Landscape
- '' (empty string) for automatic orientation
$autopagebreak (boolean) Boolean indicating if auto-page-break mode should be on or off. $bottommargin (float) bottom margin of the page.
- Since
- 3.0.015 (2008-06-06)
Definition at line 2217 of file tcpdf.php.
2217 {
2218 if (!isset($this->pagedim[$this->page]['MediaBox'])) {
2219 // the boundaries of the physical medium on which the page shall be displayed or printed
2220 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'MediaBox', 0, 0, $this->fwPt, $this->fhPt, true, $this->k, $this->pagedim);
2221 }
2222 if (!isset($this->pagedim[$this->page]['CropBox'])) {
2223 // the visible region of default user space
2224 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'CropBox', $this->pagedim[$this->page]['MediaBox']['llx'], $this->pagedim[$this->page]['MediaBox']['lly'], $this->pagedim[$this->page]['MediaBox']['urx'], $this->pagedim[$this->page]['MediaBox']['ury'], true, $this->k, $this->pagedim);
2225 }
2226 if (!isset($this->pagedim[$this->page]['BleedBox'])) {
2227 // the region to which the contents of the page shall be clipped when output in a production environment
2228 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'BleedBox', $this->pagedim[$this->page]['CropBox']['llx'], $this->pagedim[$this->page]['CropBox']['lly'], $this->pagedim[$this->page]['CropBox']['urx'], $this->pagedim[$this->page]['CropBox']['ury'], true, $this->k, $this->pagedim);
2229 }
2230 if (!isset($this->pagedim[$this->page]['TrimBox'])) {
2231 // the intended dimensions of the finished page after trimming
2232 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'TrimBox', $this->pagedim[$this->page]['CropBox']['llx'], $this->pagedim[$this->page]['CropBox']['lly'], $this->pagedim[$this->page]['CropBox']['urx'], $this->pagedim[$this->page]['CropBox']['ury'], true, $this->k, $this->pagedim);
2233 }
2234 if (!isset($this->pagedim[$this->page]['ArtBox'])) {
2235 // the page's meaningful content (including potential white space)
2236 $this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'ArtBox', $this->pagedim[$this->page]['CropBox']['llx'], $this->pagedim[$this->page]['CropBox']['lly'], $this->pagedim[$this->page]['CropBox']['urx'], $this->pagedim[$this->page]['CropBox']['ury'], true, $this->k, $this->pagedim);
2237 }
2238 if (!isset($this->pagedim[$this->page]['Rotate'])) {
2239 // The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.
2241 }
2242 if (!isset($this->pagedim[$this->page]['PZ'])) {
2243 // The page's preferred zoom (magnification) factor
2245 }
2246 if ($this->fwPt > $this->fhPt) {
2247 // landscape
2248 $default_orientation = 'L';
2249 } else {
2250 // portrait
2251 $default_orientation = 'P';
2252 }
2253 $valid_orientations = array('P', 'L');
2254 if (empty($orientation)) {
2255 $orientation = $default_orientation;
2256 } else {
2257 $orientation = strtoupper($orientation[0]);
2258 }
2259 if (in_array($orientation, $valid_orientations) AND ($orientation != $default_orientation)) {
2260 $this->CurOrientation = $orientation;
2261 $this->wPt = $this->fhPt;
2262 $this->hPt = $this->fwPt;
2263 } else {
2264 $this->CurOrientation = $default_orientation;
2265 $this->wPt = $this->fwPt;
2266 $this->hPt = $this->fhPt;
2267 }
2268 if ((abs($this->pagedim[$this->page]['MediaBox']['urx'] - $this->hPt) < $this->feps) AND (abs($this->pagedim[$this->page]['MediaBox']['ury'] - $this->wPt) < $this->feps)){
2269 // swap X and Y coordinates (change page orientation)
2270 $this->pagedim = TCPDF_STATIC::swapPageBoxCoordinates($this->page, $this->pagedim);
2271 }
2272 $this->w = ($this->wPt / $this->k);
2273 $this->h = ($this->hPt / $this->k);
2275 if (isset($this->AutoPageBreak)) {
2276 $autopagebreak = $this->AutoPageBreak;
2277 } else {
2278 $autopagebreak = true;
2279 }
2280 }
2282 if (isset($this->bMargin)) {
2283 $bottommargin = $this->bMargin;
2284 } else {
2285 // default value = 2 cm
2286 $bottommargin = 2 * 28.35 / $this->k;
2287 }
2288 }
2289 $this->SetAutoPageBreak($autopagebreak, $bottommargin);
2290 // store page dimensions
2303 }
static swapPageBoxCoordinates($page, $pagedim)
Swap X and Y coordinates of page boxes (change page boxes orientation).
Definition: tcpdf_static.php:2504
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:
◆ setPageRegions()
| 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.
- Parameters
-
$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.
- Since
- 5.9.003 (2010-10-13)
- See also
- addPageRegion(), getPageRegions()
Definition at line 22527 of file tcpdf.php.
22527 {
22528 // empty current regions array
22529 $this->page_regions = array();
22530 // add regions
22532 $this->addPageRegion($data);
22533 }
22534 }
◆ setPageUnit()
| TCPDF::setPageUnit | ( | $unit | ) |
Set the units of measure for the document.
- Parameters
-
$unit (string) User measure unit. Possible values are: - pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
- Since
- 3.0.015 (2008-06-06)
Definition at line 2011 of file tcpdf.php.
2011 {
2012 $unit = strtolower($unit);
2013 //Set scale factor
2014 switch ($unit) {
2015 // points
2016 case 'px':
2017 case 'pt': {
2018 $this->k = 1;
2019 break;
2020 }
2021 // millimeters
2022 case 'mm': {
2023 $this->k = $this->dpi / 25.4;
2024 break;
2025 }
2026 // centimeters
2027 case 'cm': {
2028 $this->k = $this->dpi / 2.54;
2029 break;
2030 }
2031 // inches
2032 case 'in': {
2033 $this->k = $this->dpi;
2034 break;
2035 }
2036 // unsupported unit
2037 default : {
2039 break;
2040 }
2041 }
2042 $this->pdfunit = $unit;
2043 if (isset($this->CurOrientation)) {
2044 $this->setPageOrientation($this->CurOrientation);
2045 }
2046 }
References $dpi, Error(), and setPageOrientation().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setPDFVersion()
| TCPDF::setPDFVersion | ( | $version = '1.7' | ) |
Set the PDF version (check PDF reference for valid values).
- Parameters
-
$version (string) PDF document version.
- Since
- 3.1.000 (2008-06-09)
Definition at line 13993 of file tcpdf.php.
13993 {
13994 if ($this->pdfa_mode) {
13995 // PDF/A mode
13996 $this->PDFVersion = '1.4';
13997 } else {
13998 $this->PDFVersion = $version;
13999 }
14000 }
References $version.
Referenced by __construct().
Here is the caller graph for this function:
◆ setPrintFooter()
| TCPDF::setPrintFooter | ( | $val = true | ) |
◆ setPrintHeader()
| TCPDF::setPrintHeader | ( | $val = true | ) |
◆ SetProtection()
| 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.
- Parameters
-
$permissions (Array) the set of permissions (specify the ones you want to block): - print : Print the document;
- modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';
- copy : Copy or otherwise extract text and graphics from the document;
- annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);
- fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;
- extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);
- assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;
- print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.
- owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.
$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')))
- Since
- 2.0.000 (2008-01-02)
Definition at line 10839 of file tcpdf.php.
10839 {
10840 if ($this->pdfa_mode) {
10841 // encryption is not allowed in PDF/A mode
10842 return;
10843 }
10845 if (($pubkeys !== null) AND (is_array($pubkeys))) {
10846 // public-key mode
10847 $this->encryptdata['pubkeys'] = $pubkeys;
10848 if ($mode == 0) {
10849 // public-Key Security requires at least 128 bit
10850 $mode = 1;
10851 }
10852 if (!function_exists('openssl_pkcs7_encrypt')) {
10854 }
10855 // Set Public-Key filter (available are: Entrust.PPKEF, Adobe.PPKLite, Adobe.PubSec)
10856 $this->encryptdata['pubkey'] = true;
10857 $this->encryptdata['Filter'] = 'Adobe.PubSec';
10858 $this->encryptdata['StmF'] = 'DefaultCryptFilter';
10859 $this->encryptdata['StrF'] = 'DefaultCryptFilter';
10860 } else {
10861 // standard mode (password mode)
10862 $this->encryptdata['pubkey'] = false;
10863 $this->encryptdata['Filter'] = 'Standard';
10864 $this->encryptdata['StmF'] = 'StdCF';
10865 $this->encryptdata['StrF'] = 'StdCF';
10866 }
10867 if ($mode > 1) { // AES
10868 if (!extension_loaded('openssl') && !extension_loaded('mcrypt')) {
10869 $this->Error('AES encryption requires openssl or mcrypt extension (http://www.php.net/manual/en/mcrypt.requirements.php).');
10870 }
10871 if (extension_loaded('openssl') && !in_array('aes-256-cbc', openssl_get_cipher_methods())) {
10873 }
10874 if (extension_loaded('mcrypt') && mcrypt_get_cipher_name(MCRYPT_RIJNDAEL_128) === false) {
10876 }
10877 if (($mode == 3) AND !function_exists('hash')) {
10878 // the Hash extension requires no external libraries and is enabled by default as of PHP 5.1.2.
10879 $this->Error('AES 256 encryption requires HASH Message Digest Framework (http://www.php.net/manual/en/book.hash.php).');
10880 }
10881 }
10882 if ($owner_pass === null) {
10883 $owner_pass = md5(TCPDF_STATIC::getRandomSeed());
10884 }
10885 $this->encryptdata['user_password'] = $user_pass;
10886 $this->encryptdata['owner_password'] = $owner_pass;
10887 $this->encryptdata['mode'] = $mode;
10888 switch ($mode) {
10889 case 0: { // RC4 40 bit
10890 $this->encryptdata['V'] = 1;
10891 $this->encryptdata['Length'] = 40;
10892 $this->encryptdata['CF']['CFM'] = 'V2';
10893 break;
10894 }
10895 case 1: { // RC4 128 bit
10896 $this->encryptdata['V'] = 2;
10897 $this->encryptdata['Length'] = 128;
10898 $this->encryptdata['CF']['CFM'] = 'V2';
10899 if ($this->encryptdata['pubkey']) {
10900 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s4';
10901 $this->encryptdata['Recipients'] = array();
10902 }
10903 break;
10904 }
10905 case 2: { // AES 128 bit
10906 $this->encryptdata['V'] = 4;
10907 $this->encryptdata['Length'] = 128;
10908 $this->encryptdata['CF']['CFM'] = 'AESV2';
10909 $this->encryptdata['CF']['Length'] = 128;
10910 if ($this->encryptdata['pubkey']) {
10911 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s5';
10912 $this->encryptdata['Recipients'] = array();
10913 }
10914 break;
10915 }
10916 case 3: { // AES 256 bit
10917 $this->encryptdata['V'] = 5;
10918 $this->encryptdata['Length'] = 256;
10919 $this->encryptdata['CF']['CFM'] = 'AESV3';
10920 $this->encryptdata['CF']['Length'] = 256;
10921 if ($this->encryptdata['pubkey']) {
10922 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s5';
10923 $this->encryptdata['Recipients'] = array();
10924 }
10925 break;
10926 }
10927 }
10928 $this->encrypted = true;
10930 $this->_generateencryptionkey();
10931 }
static convertHexStringToString($bs)
Convert hexadecimal string to string.
Definition: tcpdf_static.php:573
References _generateencryptionkey(), TCPDF_STATIC\convertHexStringToString(), Error(), TCPDF_STATIC\getRandomSeed(), and TCPDF_STATIC\getUserPermissionCode().
Here is the call graph for this function:
◆ setRasterizeVectorImages()
| TCPDF::setRasterizeVectorImages | ( | $mode | ) |
◆ SetRightMargin()
| TCPDF::SetRightMargin | ( | $margin | ) |
Defines the right margin.
The method can be called before creating the first page.
- Parameters
-
$margin (float) The margin.
- Since
- 1.5
Definition at line 2613 of file tcpdf.php.
2613 {
2614 $this->rMargin = $margin;
2615 if (($this->page > 0) AND ($this->x > ($this->w - $margin))) {
2616 $this->x = $this->w - $margin;
2617 }
2618 }
◆ setRTL()
| TCPDF::setRTL | ( | $enable, | |
$resetx = true |
|||
| ) |
Enable or disable Right-To-Left language mode.
- Parameters
-
$enable (Boolean) if true enable Right-To-Left language mode. $resetx (Boolean) if true reset the X position on direction change.
- Since
- 2.0.000 (2008-01-03)
Definition at line 2348 of file tcpdf.php.
2348 {
2349 $enable = $enable ? true : false;
2350 $resetx = ($resetx AND ($enable != $this->rtl));
2351 $this->rtl = $enable;
2352 $this->tmprtl = false;
2353 if ($resetx) {
2354 $this->Ln(0);
2355 }
2356 }
References Ln().
Here is the call graph for this function:
◆ setSignature()
| TCPDF::setSignature | ( | $signing_cert = '', |
|
$private_key = '', |
|||
$private_key_password = '', |
|||
$extracerts = '', |
|||
$cert_type = 2, |
|||
$info = array(), |
|||
$approval = '' |
|||
| ) |
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
- Parameters
-
$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. $approval (string) Enable approval signature eg. for PDF incremental update
- Since
- 4.6.005 (2009-04-24)
Definition at line 13414 of file tcpdf.php.
13414 {
13415 // to create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
13416 // to export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
13417 // to convert pfx certificate to pem: openssl
13418 // OpenSSL> pkcs12 -in <cert.pfx> -out <cert.crt> -nodes
13419 $this->sign = true;
13420 ++$this->n;
13423 $this->signature_data = array();
13424 if (strlen($signing_cert) == 0) {
13426 }
13427 if (strlen($private_key) == 0) {
13428 $private_key = $signing_cert;
13429 }
13430 $this->signature_data['signcert'] = $signing_cert;
13431 $this->signature_data['privkey'] = $private_key;
13432 $this->signature_data['password'] = $private_key_password;
13433 $this->signature_data['extracerts'] = $extracerts;
13434 $this->signature_data['cert_type'] = $cert_type;
13436 $this->signature_data['approval'] = $approval;
13437 }
References $info, $n, and Error().
Referenced by setUserRights().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setSignatureAppearance()
| 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)
- Parameters
-
$x (float) Abscissa of the upper-left corner. $y (float) Ordinate of the upper-left corner. $w (float) Width of the signature area. $h (float) Height of the signature area. $page (int) option page number (if < 0 the current page is used). $name (string) Name of the signature.
- Since
- 5.3.011 (2010-06-17)
Definition at line 13451 of file tcpdf.php.
13451 {
13452 $this->signature_appearance = $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
13453 }
References $h, $page, $w, $x, $y, and getSignatureAppearanceArray().
Here is the call graph for this function:
◆ setSpacesRE()
| 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: "/(?!\xa0)[\s\p{Z}]/u"
Unicode and PCRE unicode support in Chinese mode: "/(?!\xa0)[\s\p{Z}\p{Lo}]/u"
if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
\s : any whitespace character
- Parameters
-
$re (string) regular expression (leave empty for default).
- Since
- 4.6.016 (2009-06-15)
Definition at line 2323 of file tcpdf.php.
2323 {
2324 $this->re_spaces = $re;
2325 $re_parts = explode('/', $re);
2326 // get pattern parts
2327 $this->re_space = array();
2328 if (isset($re_parts[1]) AND !empty($re_parts[1])) {
2329 $this->re_space['p'] = $re_parts[1];
2330 } else {
2331 $this->re_space['p'] = '[\s]';
2332 }
2333 // set pattern modifiers
2334 if (isset($re_parts[2]) AND !empty($re_parts[2])) {
2335 $this->re_space['m'] = $re_parts[2];
2336 } else {
2337 $this->re_space['m'] = '';
2338 }
2339 }
Referenced by __construct().
Here is the caller graph for this function:
◆ setSpotColor()
| TCPDF::setSpotColor | ( | $type, | |
| $name, | |||
$tint = 100 |
|||
| ) |
Set the spot color for the specified type ('draw', 'fill', 'text').
- Parameters
-
$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).
- Returns
- (string) PDF color command.
- Since
- 5.9.125 (2011-10-03)
Definition at line 3732 of file tcpdf.php.
3732 {
3733 $spotcolor = TCPDF_COLORS::getSpotColor($name, $this->spot_colors);
3734 if ($spotcolor === false) {
3735 $this->Error('Undefined spot color: '.$name.', you must add it using the AddSpotColor() method.');
3736 }
3737 $tint = (max(0, min(100, $tint)) / 100);
3739 switch ($type) {
3740 case 'draw': {
3742 $this->DrawColor = $pdfcolor;
3743 $this->strokecolor = $spotcolor;
3744 break;
3745 }
3746 case 'fill': {
3748 $this->FillColor = $pdfcolor;
3749 $this->bgcolor = $spotcolor;
3750 break;
3751 }
3752 case 'text': {
3754 $this->TextColor = $pdfcolor;
3755 $this->fgcolor = $spotcolor;
3756 break;
3757 }
3758 }
3759 $this->ColorFlag = ($this->FillColor != $this->TextColor);
3760 if ($this->state == 2) {
3761 $this->_out($pdfcolor);
3762 }
3763 if ($this->inxobj) {
3764 // we are inside an XObject template
3766 }
3767 return $pdfcolor;
3768 }
References $TextColor, $xobjid, _out(), Error(), TCPDF_COLORS\getSpotColor(), and sprintf.
Referenced by setColor(), SetDrawSpotColor(), SetFillSpotColor(), and SetTextSpotColor().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setSRGBmode()
| TCPDF::setSRGBmode | ( | $mode = false | ) |
◆ setStartingPageNumber()
| TCPDF::setStartingPageNumber | ( | $num = 1 | ) |
◆ SetSubject()
| TCPDF::SetSubject | ( | $subject | ) |
Defines the subject of the document.
- Parameters
-
$subject (string) The subject.
- Since
- 1.2
- See also
- SetAuthor(), SetCreator(), SetKeywords(), SetTitle()
Definition at line 2878 of file tcpdf.php.
References $subject.
◆ setSVGStyles()
|
protected |
Apply the requested SVG styles (*** TO BE COMPLETED ***)
- Parameters
-
$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
- Returns
- object style
- Since
- 5.0.000 (2010-05-02)
Definition at line 23047 of file tcpdf.php.
23047 {
23048 if ($this->state != 2) {
23049 return;
23050 }
23051 $objstyle = '';
23053 if (!isset($svgstyle['opacity'])) {
23054 return $objstyle;
23055 }
23056 // clip-path
23057 $regs = array();
23058 if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['clip-path'], $regs)) {
23059 $clip_path = $this->svgclippaths[$regs[1]];
23060 foreach ($clip_path as $cp) {
23062 }
23063 }
23064 // opacity
23065 if ($svgstyle['opacity'] != 1) {
23067 }
23068 // color
23070 $this->SetFillColorArray($fill_color);
23071 // text color
23072 $text_color = TCPDF_COLORS::convertHTMLColorToDec($svgstyle['text-color'], $this->spot_colors);
23073 $this->SetTextColorArray($text_color);
23074 // clip
23075 if (preg_match('/rect\(([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)\)/si', $svgstyle['clip'], $regs)) {
23080 $cx = $x + $left;
23081 $cy = $y + $top;
23082 $cw = $w - $left - $right;
23083 $ch = $h - $top - $bottom;
23084 if ($svgstyle['clip-rule'] == 'evenodd') {
23085 $clip_rule = 'CNZ';
23086 } else {
23087 $clip_rule = 'CEO';
23088 }
23089 $this->Rect($cx, $cy, $cw, $ch, $clip_rule, array(), array());
23090 }
23091 // fill
23092 $regs = array();
23093 if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['fill'], $regs)) {
23094 // gradient
23095 $gradient = $this->svggradients[$regs[1]];
23096 if (isset($gradient['xref'])) {
23097 // reference to another gradient definition
23098 $newgradient = $this->svggradients[$gradient['xref']];
23099 $newgradient['coords'] = $gradient['coords'];
23100 $newgradient['mode'] = $gradient['mode'];
23101 $newgradient['type'] = $gradient['type'];
23102 $newgradient['gradientUnits'] = $gradient['gradientUnits'];
23103 if (isset($gradient['gradientTransform'])) {
23104 $newgradient['gradientTransform'] = $gradient['gradientTransform'];
23105 }
23106 $gradient = $newgradient;
23107 }
23108 //save current Graphic State
23109 $this->_outSaveGraphicsState();
23110 //set clipping area
23111 if (!empty($clip_function) AND method_exists($this, $clip_function)) {
23112 $bbox = call_user_func_array(array($this, $clip_function), $clip_params);
23113 if ((!isset($gradient['type']) OR ($gradient['type'] != 3)) AND is_array($bbox) AND (count($bbox) == 4)) {
23115 }
23116 }
23117 if ($gradient['mode'] == 'measure') {
23118 if (!isset($gradient['coords'][4])) {
23119 $gradient['coords'][4] = 0.5;
23120 }
23121 if (isset($gradient['gradientTransform']) AND !empty($gradient['gradientTransform'])) {
23122 $gtm = $gradient['gradientTransform'];
23123 // apply transformation matrix
23124 $xa = ($gtm[0] * $gradient['coords'][0]) + ($gtm[2] * $gradient['coords'][1]) + $gtm[4];
23125 $ya = ($gtm[1] * $gradient['coords'][0]) + ($gtm[3] * $gradient['coords'][1]) + $gtm[5];
23126 $xb = ($gtm[0] * $gradient['coords'][2]) + ($gtm[2] * $gradient['coords'][3]) + $gtm[4];
23127 $yb = ($gtm[1] * $gradient['coords'][2]) + ($gtm[3] * $gradient['coords'][3]) + $gtm[5];
23128 $r = sqrt(pow(($gtm[0] * $gradient['coords'][4]), 2) + pow(($gtm[1] * $gradient['coords'][4]), 2));
23129 $gradient['coords'][0] = $xa;
23130 $gradient['coords'][1] = $ya;
23131 $gradient['coords'][2] = $xb;
23132 $gradient['coords'][3] = $yb;
23134 }
23135 // convert SVG coordinates to user units
23136 $gradient['coords'][0] = $this->getHTMLUnitToUnits($gradient['coords'][0], 0, $this->svgunit, false);
23137 $gradient['coords'][1] = $this->getHTMLUnitToUnits($gradient['coords'][1], 0, $this->svgunit, false);
23138 $gradient['coords'][2] = $this->getHTMLUnitToUnits($gradient['coords'][2], 0, $this->svgunit, false);
23139 $gradient['coords'][3] = $this->getHTMLUnitToUnits($gradient['coords'][3], 0, $this->svgunit, false);
23140 $gradient['coords'][4] = $this->getHTMLUnitToUnits($gradient['coords'][4], 0, $this->svgunit, false);
23142 $w = $minlen;
23143 }
23145 $h = $minlen;
23146 }
23147 // shift units
23148 if ($gradient['gradientUnits'] == 'objectBoundingBox') {
23149 // convert to SVG coordinate system
23154 }
23155 // calculate percentages
23161 } elseif ($gradient['mode'] == 'percentage') {
23162 foreach($gradient['coords'] as $key => $val) {
23163 $gradient['coords'][$key] = (intval($val) / 100);
23164 if ($val < 0) {
23165 $gradient['coords'][$key] = 0;
23166 } elseif ($val > 1) {
23167 $gradient['coords'][$key] = 1;
23168 }
23169 }
23170 }
23171 if (($gradient['type'] == 2) AND ($gradient['coords'][0] == $gradient['coords'][2]) AND ($gradient['coords'][1] == $gradient['coords'][3])) {
23172 // single color (no shading)
23173 $gradient['coords'][0] = 1;
23174 $gradient['coords'][1] = 0;
23175 $gradient['coords'][2] = 0.999;
23176 $gradient['coords'][3] = 0;
23177 }
23178 // swap Y coordinates
23179 $tmp = $gradient['coords'][1];
23180 $gradient['coords'][1] = $gradient['coords'][3];
23181 $gradient['coords'][3] = $tmp;
23182 // set transformation map for gradient
23183 $cy = ($this->h - $y);
23184 if ($gradient['type'] == 3) {
23185 // circular gradient
23188 } else {
23189 $cy -= $h;
23190 }
23191 $this->_out(sprintf('%F 0 0 %F %F %F cm', ($w * $this->k), ($h * $this->k), ($x * $this->k), ($cy * $this->k)));
23192 if (count($gradient['stops']) > 1) {
23194 }
23195 } elseif ($svgstyle['fill'] != 'none') {
23197 if ($svgstyle['fill-opacity'] != 1) {
23199 }
23200 $this->SetFillColorArray($fill_color);
23201 if ($svgstyle['fill-rule'] == 'evenodd') {
23202 $objstyle .= 'F*';
23203 } else {
23204 $objstyle .= 'F';
23205 }
23206 }
23207 // stroke
23208 if ($svgstyle['stroke'] != 'none') {
23209 if ($svgstyle['stroke-opacity'] != 1) {
23211 } elseif (preg_match('/rgba\(\d+%?,\s*\d+%?,\s*\d+%?,\s*(\d+(?:\.\d+)?)\)/i', $svgstyle['stroke'], $rgba_matches)) {
23213 }
23214 $stroke_style = array(
23217 'cap' => $svgstyle['stroke-linecap'],
23218 'join' => $svgstyle['stroke-linejoin']
23219 );
23220 if (isset($svgstyle['stroke-dasharray']) AND !empty($svgstyle['stroke-dasharray']) AND ($svgstyle['stroke-dasharray'] != 'none')) {
23221 $stroke_style['dash'] = $svgstyle['stroke-dasharray'];
23222 }
23223 $this->SetLineStyle($stroke_style);
23224 $objstyle .= 'D';
23225 }
23226 // font
23227 $regs = array();
23228 if (!empty($svgstyle['font'])) {
23229 if (preg_match('/font-family[\s]*:[\s]*([^\;\"]*)/si', $svgstyle['font'], $regs)) {
23230 $font_family = $this->getFontFamilyName($regs[1]);
23231 } else {
23232 $font_family = $svgstyle['font-family'];
23233 }
23234 if (preg_match('/font-size[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23235 $font_size = trim($regs[1]);
23236 } else {
23237 $font_size = $svgstyle['font-size'];
23238 }
23239 if (preg_match('/font-style[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23240 $font_style = trim($regs[1]);
23241 } else {
23242 $font_style = $svgstyle['font-style'];
23243 }
23244 if (preg_match('/font-weight[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23245 $font_weight = trim($regs[1]);
23246 } else {
23247 $font_weight = $svgstyle['font-weight'];
23248 }
23249 if (preg_match('/font-stretch[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23250 $font_stretch = trim($regs[1]);
23251 } else {
23252 $font_stretch = $svgstyle['font-stretch'];
23253 }
23254 if (preg_match('/letter-spacing[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23255 $font_spacing = trim($regs[1]);
23256 } else {
23258 }
23259 } else {
23261 $font_size = $svgstyle['font-size'];
23262 $font_style = $svgstyle['font-style'];
23263 $font_weight = $svgstyle['font-weight'];
23264 $font_stretch = $svgstyle['font-stretch'];
23266 }
23267 $font_size = $this->getHTMLFontUnits($font_size, $this->svgstyles[0]['font-size'], $prevsvgstyle['font-size'], $this->svgunit);
23270 switch ($font_style) {
23271 case 'italic': {
23272 $font_style = 'I';
23273 break;
23274 }
23275 case 'oblique': {
23276 $font_style = 'I';
23277 break;
23278 }
23279 default:
23280 case 'normal': {
23281 $font_style = '';
23282 break;
23283 }
23284 }
23285 switch ($font_weight) {
23286 case 'bold':
23287 case 'bolder': {
23288 $font_style .= 'B';
23289 break;
23290 }
23291 case 'normal': {
23292 if ((substr($font_family, -1) == 'I') AND (substr($font_family, -2, 1) == 'B')) {
23293 $font_family = substr($font_family, 0, -2).'I';
23294 } elseif (substr($font_family, -1) == 'B') {
23295 $font_family = substr($font_family, 0, -1);
23296 }
23297 break;
23298 }
23299 }
23300 switch ($svgstyle['text-decoration']) {
23301 case 'underline': {
23302 $font_style .= 'U';
23303 break;
23304 }
23305 case 'overline': {
23306 $font_style .= 'O';
23307 break;
23308 }
23309 case 'line-through': {
23310 $font_style .= 'D';
23311 break;
23312 }
23313 default:
23314 case 'none': {
23315 break;
23316 }
23317 }
23318 $this->SetFont($font_family, $font_style, $font_size);
23319 $this->setFontStretching($font_stretch);
23321 return $objstyle;
23322 }
startSVGElementHandler($parser, $name, $attribs, $ctm=array())
Sets the opening SVG element handler function for the XML parser.
Definition: tcpdf.php:23717
setFontSpacing($spacing=0)
Set the amount to increase or decrease the space between characters in a text.
Definition: tcpdf.php:22489
References $h, $r, $w, $x, $y, TCPDF_COLORS\convertHTMLColorToDec(), and sprintf.
Here is the call graph for this function:
◆ setTableHeader()
|
protected |
This method is used to render the table header on new page (if any).
- Since
- 4.5.030 (2009-03-25)
Definition at line 3622 of file tcpdf.php.
3622 {
3623 if ($this->num_columns > 1) {
3624 // multi column mode
3625 return;
3626 }
3627 if (isset($this->theadMargins['top'])) {
3628 // restore the original top-margin
3629 $this->tMargin = $this->theadMargins['top'];
3631 $this->y = $this->tMargin;
3632 }
3634 // set margins
3635 $prev_lMargin = $this->lMargin;
3636 $prev_rMargin = $this->rMargin;
3637 $prev_cell_padding = $this->cell_padding;
3638 $this->lMargin = $this->theadMargins['lmargin'] + ($this->pagedim[$this->page]['olm'] - $this->pagedim[$this->theadMargins['page']]['olm']);
3639 $this->rMargin = $this->theadMargins['rmargin'] + ($this->pagedim[$this->page]['orm'] - $this->pagedim[$this->theadMargins['page']]['orm']);
3640 $this->cell_padding = $this->theadMargins['cell_padding'];
3641 if ($this->rtl) {
3642 $this->x = $this->w - $this->rMargin;
3643 } else {
3644 $this->x = $this->lMargin;
3645 }
3646 // account for special "cell" mode
3647 if ($this->theadMargins['cell']) {
3648 if ($this->rtl) {
3649 $this->x -= $this->cell_padding['R'];
3650 } else {
3651 $this->x += $this->cell_padding['L'];
3652 }
3653 }
3654 $gvars = $this->getGraphicVars();
3655 if (!empty($this->theadMargins['gvars'])) {
3656 // set the correct graphic style
3658 $this->rMargin = $gvars['rMargin'];
3659 $this->lMargin = $gvars['lMargin'];
3660 }
3661 // print table header
3663 $this->setGraphicVars($gvars);
3664 // set new top margin to skip the table headers
3665 if (!isset($this->theadMargins['top'])) {
3667 }
3668 // store end of header position
3669 if (!isset($this->columns[0]['th'])) {
3670 $this->columns[0]['th'] = array();
3671 }
3673 $this->tMargin = $this->y;
3675 $this->lasth = 0;
3676 $this->lMargin = $prev_lMargin;
3677 $this->rMargin = $prev_rMargin;
3678 $this->cell_padding = $prev_cell_padding;
3679 }
3680 }
References $cell_padding, $lMargin, $page, $rMargin, $tMargin, $y, TCPDF_STATIC\empty_string(), getGraphicVars(), setGraphicVars(), and writeHTML().
Referenced by startPage().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setTempRTL()
| TCPDF::setTempRTL | ( | $mode | ) |
Force temporary RTL language direction.
- Parameters
-
$mode (mixed) can be false, 'L' for LTR or 'R' for RTL
- Since
- 2.1.000 (2008-01-09)
Definition at line 2374 of file tcpdf.php.
2374 {
2375 $newmode = false;
2376 switch (strtoupper($mode)) {
2377 case 'LTR':
2378 case 'L': {
2379 if ($this->rtl) {
2380 $newmode = 'L';
2381 }
2382 break;
2383 }
2384 case 'RTL':
2385 case 'R': {
2386 if (!$this->rtl) {
2387 $newmode = 'R';
2388 }
2389 break;
2390 }
2391 case false:
2392 default: {
2393 $newmode = false;
2394 break;
2395 }
2396 }
2397 $this->tmprtl = $newmode;
2398 }
Referenced by openHTMLTagHandler().
Here is the caller graph for this function:
◆ SetTextColor()
| 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.
- Parameters
-
$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).
- Returns
- (string) Empty string.
- Since
- 1.3
- See also
- SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
Definition at line 4016 of file tcpdf.php.
References $ret, and setColor().
Referenced by MC_TCPDF\ChapterBody(), and MYPDF\ColoredTable().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetTextColorArray()
| 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.
- Parameters
-
$color (array) Array of colors (1, 3 or 4 values). $ret (boolean) If true do not send the PDF command.
- Since
- 3.1.000 (2008-6-11)
- See also
- SetFillColor()
Definition at line 3875 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:
◆ setTextRenderingMode()
| TCPDF::setTextRenderingMode | ( | $stroke = 0, |
|
$fill = true, |
|||
$clip = false |
|||
| ) |
Set Text rendering mode.
- Parameters
-
$stroke (int) outline size in user units (0 = disable). $fill (boolean) if true fills the text (default). $clip (boolean) if true activate clipping mode
- Since
- 4.9.008 (2009-04-02)
Definition at line 21847 of file tcpdf.php.
21847 {
21848 // Ref.: PDF 32000-1:2008 - 9.3.6 Text Rendering Mode
21849 // convert text rendering parameters
21850 if ($stroke < 0) {
21851 $stroke = 0;
21852 }
21853 if ($fill === true) {
21854 if ($stroke > 0) {
21855 if ($clip === true) {
21856 // Fill, then stroke text and add to path for clipping
21857 $textrendermode = 6;
21858 } else {
21859 // Fill, then stroke text
21860 $textrendermode = 2;
21861 }
21862 $textstrokewidth = $stroke;
21863 } else {
21864 if ($clip === true) {
21865 // Fill text and add to path for clipping
21866 $textrendermode = 4;
21867 } else {
21868 // Fill text
21869 $textrendermode = 0;
21870 }
21871 }
21872 } else {
21873 if ($stroke > 0) {
21874 if ($clip === true) {
21875 // Stroke text and add to path for clipping
21876 $textrendermode = 5;
21877 } else {
21878 // Stroke text
21879 $textrendermode = 1;
21880 }
21881 $textstrokewidth = $stroke;
21882 } else {
21883 if ($clip === true) {
21884 // Add text to path for clipping
21885 $textrendermode = 7;
21886 } else {
21887 // Neither fill nor stroke text (invisible)
21888 $textrendermode = 3;
21889 }
21890 }
21891 }
21892 $this->textrendermode = $textrendermode;
21893 $this->textstrokewidth = $stroke;
21894 }
Referenced by Close(), Text(), and writeHTML().
Here is the caller graph for this function:
◆ setTextShadow()
| 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.
- Parameters
-
$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.
- Since
- 5.9.174 (2012-07-25)
Definition at line 21902 of file tcpdf.php.
21902 {
21905 } else {
21906 $this->txtshadow['enabled'] = false;
21907 }
21910 } else {
21911 $this->txtshadow['depth_w'] = 0;
21912 }
21915 } else {
21916 $this->txtshadow['depth_h'] = 0;
21917 }
21918 if (isset($params['color']) AND ($params['color'] !== false) AND is_array($params['color'])) {
21920 } else {
21922 }
21925 } else {
21926 $this->txtshadow['opacity'] = 1;
21927 }
21928 if (isset($params['blend_mode']) AND in_array($params['blend_mode'], array('Normal', 'Multiply', 'Screen', 'Overlay', 'Darken', 'Lighten', 'ColorDodge', 'ColorBurn', 'HardLight', 'SoftLight', 'Difference', 'Exclusion', 'Hue', 'Saturation', 'Color', 'Luminosity'))) {
21930 } else {
21931 $this->txtshadow['blend_mode'] = 'Normal';
21932 }
21933 if ((($this->txtshadow['depth_w'] == 0) AND ($this->txtshadow['depth_h'] == 0)) OR ($this->txtshadow['opacity'] == 0)) {
21934 $this->txtshadow['enabled'] = false;
21935 }
21936 }
References $params.
Referenced by __construct().
Here is the caller graph for this function:
◆ SetTextSpotColor()
| TCPDF::SetTextSpotColor | ( | $name, | |
$tint = 100 |
|||
| ) |
Defines the spot color used for text.
- Parameters
-
$name (string) Name of the spot color. $tint (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
- Since
- 4.0.024 (2008-09-12)
Definition at line 3802 of file tcpdf.php.
References setSpotColor().
Here is the call graph for this function:
◆ setTimeStamp()
| TCPDF::setTimeStamp | ( | $tsa_host = '', |
|
$tsa_username = '', |
|||
$tsa_password = '', |
|||
$tsa_cert = '' |
|||
| ) |
Enable document timestamping (requires the OpenSSL Library).
The trusted timestamping improve document security that means that no one should be able to change the document once it has been recorded. Use with digital signature only!
- Parameters
-
$tsa_host (string) Time Stamping Authority (TSA) server (prefixed with 'https://') $tsa_username (string) Specifies the username for TSA authorization (optional) OR specifies the TSA authorization PEM file (see: example_66.php, optional) $tsa_password (string) Specifies the password for TSA authorization (optional) $tsa_cert (string) Specifies the location of TSA certificate for authorization (optional for cURL)
- Since
- 6.0.090 (2014-06-16)
Definition at line 13517 of file tcpdf.php.
13517 {
13518 $this->tsa_data = array();
13519 if (!function_exists('curl_init')) {
13521 }
13522 if (strlen($tsa_host) == 0) {
13524 }
13525 $this->tsa_data['tsa_host'] = $tsa_host;
13526 if (is_file($tsa_username)) {
13527 $this->tsa_data['tsa_auth'] = $tsa_username;
13528 } else {
13529 $this->tsa_data['tsa_username'] = $tsa_username;
13530 }
13531 $this->tsa_data['tsa_password'] = $tsa_password;
13532 $this->tsa_data['tsa_cert'] = $tsa_cert;
13533 $this->tsa_timestamp = true;
13534 }
References Error().
Here is the call graph for this function:
◆ SetTitle()
| TCPDF::SetTitle | ( | $title | ) |
Defines the title of the document.
- Parameters
-
$title (string) The title.
- Since
- 1.2
- See also
- SetAuthor(), SetCreator(), SetKeywords(), SetSubject()
Definition at line 2867 of file tcpdf.php.
References $title.
◆ SetTopMargin()
| TCPDF::SetTopMargin | ( | $margin | ) |
Defines the top margin.
The method can be called before creating the first page.
- Parameters
-
$margin (float) The margin.
- Since
- 1.5
Definition at line 2598 of file tcpdf.php.
2598 {
2599 //Set top margin
2600 $this->tMargin = $margin;
2601 if (($this->page > 0) AND ($this->y < $margin)) {
2602 $this->y = $margin;
2603 }
2604 }
◆ setUserRights()
| 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
- Parameters
-
$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.
- Since
- 2.9.000 (2008-03-26)
Definition at line 13377 of file tcpdf.php.
13384 {
13385 $this->ur['enabled'] = $enable;
13386 $this->ur['document'] = $document;
13387 $this->ur['annots'] = $annots;
13388 $this->ur['form'] = $form;
13389 $this->ur['signature'] = $signature;
13390 $this->ur['ef'] = $ef;
13391 $this->ur['formex'] = $formex;
13392 if (!$this->sign) {
13394 }
13395 }
setSignature($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array(), $approval='')
Enable document signature (requires the OpenSSL Library).
Definition: tcpdf.php:13414
References setSignature().
Here is the call graph for this function:
◆ setViewerPreferences()
| 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").
- HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.
- HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.
- HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.
- FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.
- CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.
- DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.
-
NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:
- UseNone Neither document outline nor thumbnail images visible
- UseOutlines Document outline visible
- UseThumbs Thumbnail images visible
- UseOC Optional content group panel visible
-
ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
-
ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
-
PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
-
PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:
- MediaBox
- CropBox (default)
- BleedBox
- TrimBox
- ArtBox
-
PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are:
- None, which indicates that the print dialog should reflect no page scaling
- AppDefault (default), which indicates that applications should use the current print scaling
-
Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:
- Simplex - Print single-sided
- DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet
- DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet
- PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.
- PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application
- NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1
- Parameters
-
$preferences (array) array of options.
- Since
- 3.1.000 (2008-06-09)
Definition at line 14011 of file tcpdf.php.
14011 {
14012 $this->viewer_preferences = $preferences;
14013 }
if(@file_exists(dirname(__FILE__).'/lang/eng.php')) $preferences
Definition: example_029.php:70
References $preferences.
◆ setVisibility()
| 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.
- Parameters
-
$v (string) visibility mode. Legal values are: all, print, screen or view.
- Since
- 3.0.000 (2008-03-27)
Definition at line 13764 of file tcpdf.php.
13764 {
13765 if ($this->state != 2) {
13766 return;
13767 }
13768 $this->endLayer();
13769 switch($v) {
13770 case 'print': {
13772 break;
13773 }
13774 case 'view':
13775 case 'screen': {
13777 break;
13778 }
13779 case 'all': {
13781 break;
13782 }
13783 default: {
13785 break;
13786 }
13787 }
13788 }
startLayer($name='', $print=true, $view=true, $lock=true)
Start a new pdf layer.
Definition: tcpdf.php:13725
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:
◆ SetX()
| 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).
- Parameters
-
$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.
- Since
- 1.2
Definition at line 7441 of file tcpdf.php.
7441 {
7443 if (!$rtloff AND $this->rtl) {
7445 $this->x = $this->w - $x;
7446 } else {
7447 $this->x = abs($x);
7448 }
7449 } else {
7451 $this->x = $x;
7452 } else {
7453 $this->x = $this->w + $x;
7454 }
7455 }
7456 if ($this->x < 0) {
7457 $this->x = 0;
7458 }
7459 if ($this->x > $this->w) {
7460 $this->x = $this->w;
7461 }
7462 }
Referenced by Footer(), Header(), MultiCell(), and SetXY().
Here is the caller graph for this function:
◆ SetXY()
| 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.
- Parameters
-
$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.
- Since
- 1.2
Definition at line 7507 of file tcpdf.php.
References $x, $y, SetX(), and SetY().
Referenced by MYPDF\MultiRow(), openHTMLTagHandler(), setFooter(), setHeader(), and Text().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetY()
| 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.
- Parameters
-
$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.
- Since
- 1.0
Definition at line 7474 of file tcpdf.php.
7474 {
7476 if ($resetx) {
7477 //reset x
7478 if (!$rtloff AND $this->rtl) {
7479 $this->x = $this->w - $this->rMargin;
7480 } else {
7481 $this->x = $this->lMargin;
7482 }
7483 }
7485 $this->y = $y;
7486 } else {
7487 $this->y = $this->h + $y;
7488 }
7489 if ($this->y < 0) {
7490 $this->y = 0;
7491 }
7492 if ($this->y > $this->h) {
7493 $this->y = $this->h;
7494 }
7495 }
References $h, $lMargin, $rMargin, and $y.
Referenced by MYPDF\Footer(), Footer(), Header(), Image(), ImageEps(), MultiCell(), setPage(), SetXY(), startPage(), write1DBarcode(), and write2DBarcode().
Here is the caller graph for this function:
◆ Skew()
| TCPDF::Skew | ( | $angle_x, | |
| $angle_y, | |||
$x = '', |
|||
$y = '' |
|||
| ) |
Skew.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11216 of file tcpdf.php.
11216 {
11219 }
11222 }
11223 if (($angle_x <= -90) OR ($angle_x >= 90) OR ($angle_y <= -90) OR ($angle_y >= 90)) {
11225 }
11228 //calculate elements of transformation matrix
11229 $tm = array();
11230 $tm[0] = 1;
11231 $tm[1] = tan(deg2rad($angle_y));
11232 $tm[2] = tan(deg2rad($angle_x));
11233 $tm[3] = 1;
11234 $tm[4] = -$tm[2] * $y;
11235 $tm[5] = -$tm[1] * $x;
11236 //skew the coordinate system
11237 $this->Transform($tm);
11238 }
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:
◆ SkewX()
| TCPDF::SkewX | ( | $angle_x, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Skew horizontally.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11189 of file tcpdf.php.
11189 {
11191 }
References $x, $y, and Skew().
Here is the call graph for this function:
◆ SkewY()
| TCPDF::SkewY | ( | $angle_y, | |
$x = '', |
|||
$y = '' |
|||
| ) |
Skew vertically.
- Parameters
-
$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
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11202 of file tcpdf.php.
References $x, $y, and Skew().
Here is the call graph for this function:
◆ sortBookmarks()
|
protected |
Sort bookmarks for page and key.
- Since
- 5.9.119 (2011-09-19)
Definition at line 12349 of file tcpdf.php.
12349 {
12350 // get sorting columns
12351 $outline_p = array();
12352 $outline_y = array();
12355 $outline_k[$key] = $key;
12356 }
12357 // sort outlines by page and original position
12358 array_multisort($outline_p, SORT_NUMERIC, SORT_ASC, $outline_k, SORT_NUMERIC, SORT_ASC, $this->outlines);
12359 }
References $row.
Referenced by _putbookmarks().
Here is the caller graph for this function:
◆ StarPolygon()
| 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.
- Parameters
-
$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: - all: Line style of all sides. Array like for SetLineStyle().
- 0 to (n - 1): Line style of each side. Array like for SetLineStyle().
$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: - D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
- CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).
- CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).
$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).
- Since
- 2.1.000 (2008-01-08)
Definition at line 12010 of file tcpdf.php.
12010 {
12011 if ($nv < 2) {
12012 $nv = 2;
12013 }
12014 if ($draw_circle) {
12015 $this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
12016 }
12017 $p2 = array();
12018 $visited = array();
12019 for ($i = 0; $i < $nv; ++$i) {
12020 $a = $angle + ($i * 360 / $nv);
12021 $a_rad = deg2rad((float) $a);
12022 $p2[] = $x0 + ($r * sin($a_rad));
12023 $p2[] = $y0 + ($r * cos($a_rad));
12024 $visited[] = false;
12025 }
12026 $p = array();
12027 $i = 0;
12028 do {
12029 $p[] = $p2[$i * 2];
12030 $p[] = $p2[($i * 2) + 1];
12031 $visited[$i] = true;
12032 $i += $ng;
12033 $i %= $nv;
12034 } while (!$visited[$i]);
12036 }
References $angle, $r, $style, Circle(), and Polygon().
Here is the call graph for this function:
◆ startLayer()
| TCPDF::startLayer | ( | $name = '', |
|
$print = true, |
|||
$view = true, |
|||
$lock = true |
|||
| ) |
Start a new pdf layer.
- Parameters
-
$name (string) Layer name (only a-z letters and numbers). Leave empty for automatic name. $print (boolean|null) Set to TRUE to print this layer, FALSE to not print and NULL to not set this option $view (boolean) Set to true to view this layer. $lock (boolean) If true lock the layer
- Since
- 5.9.102 (2011-07-13)
Definition at line 13725 of file tcpdf.php.
13725 {
13726 if ($this->state != 2) {
13727 return;
13728 }
13730 if (empty($name)) {
13731 $name = $layer;
13732 } else {
13733 $name = preg_replace('/[^a-zA-Z0-9_\-]/', '', $name);
13734 }
13735 $this->pdflayers[] = array('layer' => $layer, 'name' => $name, 'print' => $print, 'view' => $view, 'lock' => $lock);
13736 $this->openMarkedContent = true;
13738 }
References _out(), and sprintf.
Referenced by setVisibility().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ startPage()
| 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.
- Parameters
-
$orientation (string) page orientation. Possible values are (case insensitive): - P or PORTRAIT (default)
- L or LANDSCAPE
$format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). $tocpage (boolean) if true the page is designated to contain the Table-Of-Content.
- Since
- 4.2.010 (2008-11-14)
- See also
- AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
Definition at line 3152 of file tcpdf.php.
3152 {
3154 $this->tocpage = true;
3155 }
3156 // move page numbers of documents to be attached
3157 if ($this->tocpage) {
3158 // move reference to unexistent pages (used for page attachments)
3159 // adjust outlines
3160 $tmpoutlines = $this->outlines;
3161 foreach ($tmpoutlines as $key => $outline) {
3162 if (!$outline['f'] AND ($outline['p'] > $this->numpages)) {
3163 $this->outlines[$key]['p'] = ($outline['p'] + 1);
3164 }
3165 }
3166 // adjust dests
3167 $tmpdests = $this->dests;
3168 foreach ($tmpdests as $key => $dest) {
3169 if (!$dest['f'] AND ($dest['p'] > $this->numpages)) {
3170 $this->dests[$key]['p'] = ($dest['p'] + 1);
3171 }
3172 }
3173 // adjust links
3174 $tmplinks = $this->links;
3175 foreach ($tmplinks as $key => $link) {
3176 if (!$link['f'] AND ($link['p'] > $this->numpages)) {
3177 $this->links[$key]['p'] = ($link['p'] + 1);
3178 }
3179 }
3180 }
3181 if ($this->numpages > $this->page) {
3182 // this page has been already added
3183 $this->setPage($this->page + 1);
3184 $this->SetY($this->tMargin);
3185 return;
3186 }
3187 // start a new page
3188 if ($this->state == 0) {
3189 $this->Open();
3190 }
3191 ++$this->numpages;
3192 $this->swapMargins($this->booklet);
3193 // save current graphic settings
3194 $gvars = $this->getGraphicVars();
3195 // start new page
3196 $this->_beginpage($orientation, $format);
3197 // mark page as open
3199 // restore graphic settings
3200 $this->setGraphicVars($gvars);
3201 // mark this point
3202 $this->setPageMark();
3203 // print page header
3204 $this->setHeader();
3205 // restore graphic settings
3206 $this->setGraphicVars($gvars);
3207 // mark this point
3208 $this->setPageMark();
3209 // print table header (if any)
3210 $this->setTableHeader();
3211 // set mark for empty page check
3213 }
setPageMark()
Set start-writing mark on current page stream used to put borders and fills.
Definition: tcpdf.php:3223
setTableHeader()
This method is used to render the table header on new page (if any).
Definition: tcpdf.php:3622
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:
◆ startPageGroup()
| TCPDF::startPageGroup | ( | $page = '' | ) |
Create a new page group.
NOTE: call this function before calling AddPage()
- Parameters
-
$page (int) starting group page (leave empty for next page).
- Since
- 3.0.000 (2008-03-27)
Definition at line 13560 of file tcpdf.php.
References $newpagegroup, and $page.
◆ startSVGElementHandler()
|
protected |
Sets the opening SVG element handler function for the XML parser.
(*** TO BE COMPLETED ***)
- Parameters
-
$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).
- Since
- 5.0.000 (2010-05-02)
Definition at line 23717 of file tcpdf.php.
23717 {
23718 $name = $this->removeTagNamespace($name);
23719 // check if we are in clip mode
23720 if ($this->svgclipmode) {
23721 $this->svgclippaths[$this->svgclipid][] = array('name' => $name, 'attribs' => $attribs, 'tm' => $this->svgcliptm[$this->svgclipid]);
23722 return;
23723 }
23724 if ($this->svgdefsmode AND !in_array($name, array('clipPath', 'linearGradient', 'radialGradient', 'stop'))) {
23725 if (isset($attribs['id'])) {
23726 $attribs['child_elements'] = array();
23727 $this->svgdefs[$attribs['id']] = array('name' => $name, 'attribs' => $attribs);
23728 return;
23729 }
23730 if (end($this->svgdefs) !== FALSE) {
23731 $last_svgdefs_id = key($this->svgdefs);
23732 if (isset($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'])) {
23733 $attribs['id'] = 'DF_'.(count($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements']) + 1);
23734 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$attribs['id']] = array('name' => $name, 'attribs' => $attribs);
23735 return;
23736 }
23737 }
23738 return;
23739 }
23740 $clipping = false;
23742 // set clipping mode
23743 $clipping = true;
23744 }
23745 // get styling properties
23746 $prev_svgstyle = $this->svgstyles[max(0,(count($this->svgstyles) - 1))]; // previous style
23747 $svgstyle = $this->svgstyles[0]; // set default style
23748 if ($clipping AND !isset($attribs['fill']) AND (!isset($attribs['style']) OR (!preg_match('/[;\"\s]{1}fill[\s]*:[\s]*([^;\"]*)/si', $attribs['style'], $attrval)))) {
23749 // default fill attribute for clipping
23750 $attribs['fill'] = 'none';
23751 }
23752 if (isset($attribs['style']) AND !TCPDF_STATIC::empty_string($attribs['style']) AND ($attribs['style'][0] != ';')) {
23753 // fix style for regular expression
23754 $attribs['style'] = ';'.$attribs['style'];
23755 }
23756 foreach ($prev_svgstyle as $key => $val) {
23758 // inherit previous value
23759 $svgstyle[$key] = $val;
23760 }
23762 // specific attribute settings
23763 if ($attribs[$key] == 'inherit') {
23764 $svgstyle[$key] = $val;
23765 } else {
23766 $svgstyle[$key] = $attribs[$key];
23767 }
23769 // CSS style syntax
23770 $attrval = array();
23771 if (preg_match('/[;\"\s]{1}'.$key.'[\s]*:[\s]*([^;\"]*)/si', $attribs['style'], $attrval) AND isset($attrval[1])) {
23772 if ($attrval[1] == 'inherit') {
23773 $svgstyle[$key] = $val;
23774 } else {
23775 $svgstyle[$key] = $attrval[1];
23776 }
23777 }
23778 }
23779 }
23780 // transformation matrix
23781 if (!empty($ctm)) {
23782 $tm = $ctm;
23783 } else {
23784 $tm = array(1,0,0,1,0,0);
23785 }
23786 if (isset($attribs['transform']) AND !empty($attribs['transform'])) {
23787 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, TCPDF_STATIC::getSVGTransformMatrix($attribs['transform']));
23788 }
23789 $svgstyle['transfmatrix'] = $tm;
23790 $invisible = false;
23791 if (($svgstyle['visibility'] == 'hidden') OR ($svgstyle['visibility'] == 'collapse') OR ($svgstyle['display'] == 'none')) {
23792 // the current graphics element is invisible (nothing is painted)
23793 $invisible = true;
23794 }
23795 // process tag
23796 switch($name) {
23797 case 'defs': {
23798 $this->svgdefsmode = true;
23799 break;
23800 }
23801 // clipPath
23802 case 'clipPath': {
23803 if ($invisible) {
23804 break;
23805 }
23806 $this->svgclipmode = true;
23807 if (!isset($attribs['id'])) {
23808 $attribs['id'] = 'CP_'.(count($this->svgcliptm) + 1);
23809 }
23810 $this->svgclipid = $attribs['id'];
23811 $this->svgclippaths[$this->svgclipid] = array();
23812 $this->svgcliptm[$this->svgclipid] = $tm;
23813 break;
23814 }
23815 case 'svg': {
23816 // start of SVG object
23817 if(++$this->svg_tag_depth <= 1) {
23818 break;
23819 }
23820 // inner SVG
23821 array_push($this->svgstyles, $svgstyle);
23822 $this->StartTransform();
23823 $svgX = (isset($attribs['x'])?$attribs['x']:0);
23824 $svgY = (isset($attribs['y'])?$attribs['y']:0);
23825 $svgW = (isset($attribs['width'])?$attribs['width']:0);
23826 $svgH = (isset($attribs['height'])?$attribs['height']:0);
23827 // set x, y position using transform matrix
23828 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, array( 1, 0, 0, 1, $svgX, $svgY));
23829 $this->SVGTransform($tm);
23830 // set clipping for width and height
23831 $x = 0;
23832 $y = 0;
23833 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):$this->w);
23834 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):$this->h);
23835 // draw clipping rect
23837 // parse viewbox, calculate extra transformation matrix
23838 if (isset($attribs['viewBox'])) {
23839 $tmp = array();
23840 preg_match_all("/[0-9]+/", $attribs['viewBox'], $tmp);
23841 $tmp = $tmp[0];
23842 if (sizeof($tmp) == 4) {
23843 $vx = $tmp[0];
23844 $vy = $tmp[1];
23845 $vw = $tmp[2];
23846 $vh = $tmp[3];
23847 // get aspect ratio
23848 $tmp = array();
23849 $aspectX = 'xMid';
23850 $aspectY = 'YMid';
23851 $fit = 'meet';
23852 if (isset($attribs['preserveAspectRatio'])) {
23853 if($attribs['preserveAspectRatio'] == 'none') {
23854 $fit = 'none';
23855 } else {
23856 preg_match_all('/[a-zA-Z]+/', $attribs['preserveAspectRatio'], $tmp);
23857 $tmp = $tmp[0];
23858 if ((sizeof($tmp) == 2) AND (strlen($tmp[0]) == 8) AND (in_array($tmp[1], array('meet', 'slice', 'none')))) {
23859 $aspectX = substr($tmp[0], 0, 4);
23860 $aspectY = substr($tmp[0], 4, 4);
23861 $fit = $tmp[1];
23862 }
23863 }
23864 }
23865 $wr = ($svgW / $vw);
23866 $hr = ($svgH / $vh);
23867 $ax = $ay = 0;
23868 if ((($fit == 'meet') AND ($hr < $wr)) OR (($fit == 'slice') AND ($hr > $wr))) {
23869 if ($aspectX == 'xMax') {
23870 $ax = (($vw * ($wr / $hr)) - $vw);
23871 }
23872 if ($aspectX == 'xMid') {
23873 $ax = ((($vw * ($wr / $hr)) - $vw) / 2);
23874 }
23875 $wr = $hr;
23876 } elseif ((($fit == 'meet') AND ($hr > $wr)) OR (($fit == 'slice') AND ($hr < $wr))) {
23877 if ($aspectY == 'YMax') {
23878 $ay = (($vh * ($hr / $wr)) - $vh);
23879 }
23880 if ($aspectY == 'YMid') {
23881 $ay = ((($vh * ($hr / $wr)) - $vh) / 2);
23882 }
23883 $hr = $wr;
23884 }
23885 $newtm = array($wr, 0, 0, $hr, (($wr * ($ax - $vx)) - $svgX), (($hr * ($ay - $vy)) - $svgY));
23886 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, $newtm);
23887 $this->SVGTransform($tm);
23888 }
23889 }
23890 $this->setSVGStyles($svgstyle, $prev_svgstyle);
23891 break;
23892 }
23893 case 'g': {
23894 // group together related graphics elements
23895 array_push($this->svgstyles, $svgstyle);
23896 $this->StartTransform();
23902 $this->SVGTransform($tm);
23903 $this->setSVGStyles($svgstyle, $prev_svgstyle);
23904 break;
23905 }
23906 case 'linearGradient': {
23907 if ($this->pdfa_mode) {
23908 break;
23909 }
23910 if (!isset($attribs['id'])) {
23911 $attribs['id'] = 'GR_'.(count($this->svggradients) + 1);
23912 }
23913 $this->svggradientid = $attribs['id'];
23914 $this->svggradients[$this->svggradientid] = array();
23917 if (isset($attribs['gradientUnits'])) {
23919 } else {
23921 }
23922 //$attribs['spreadMethod']
23923 if (((!isset($attribs['x1'])) AND (!isset($attribs['y1'])) AND (!isset($attribs['x2'])) AND (!isset($attribs['y2'])))
23924 OR ((isset($attribs['x1']) AND (substr($attribs['x1'], -1) == '%'))
23925 OR (isset($attribs['y1']) AND (substr($attribs['y1'], -1) == '%'))
23926 OR (isset($attribs['x2']) AND (substr($attribs['x2'], -1) == '%'))
23927 OR (isset($attribs['y2']) AND (substr($attribs['y2'], -1) == '%')))) {
23929 } else {
23931 }
23932 $x1 = (isset($attribs['x1'])?$attribs['x1']:'0');
23933 $y1 = (isset($attribs['y1'])?$attribs['y1']:'0');
23934 $x2 = (isset($attribs['x2'])?$attribs['x2']:'100');
23935 $y2 = (isset($attribs['y2'])?$attribs['y2']:'0');
23936 if (isset($attribs['gradientTransform'])) {
23937 $this->svggradients[$this->svggradientid]['gradientTransform'] = TCPDF_STATIC::getSVGTransformMatrix($attribs['gradientTransform']);
23938 }
23940 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
23941 // gradient is defined on another place
23943 }
23944 break;
23945 }
23946 case 'radialGradient': {
23947 if ($this->pdfa_mode) {
23948 break;
23949 }
23950 if (!isset($attribs['id'])) {
23951 $attribs['id'] = 'GR_'.(count($this->svggradients) + 1);
23952 }
23953 $this->svggradientid = $attribs['id'];
23954 $this->svggradients[$this->svggradientid] = array();
23957 if (isset($attribs['gradientUnits'])) {
23959 } else {
23961 }
23962 //$attribs['spreadMethod']
23963 if (((!isset($attribs['cx'])) AND (!isset($attribs['cy'])))
23964 OR ((isset($attribs['cx']) AND (substr($attribs['cx'], -1) == '%'))
23965 OR (isset($attribs['cy']) AND (substr($attribs['cy'], -1) == '%')))) {
23967 } elseif (isset($attribs['r']) AND is_numeric($attribs['r']) AND ($attribs['r']) <= 1) {
23969 } else {
23971 }
23972 $cx = (isset($attribs['cx']) ? $attribs['cx'] : 0.5);
23973 $cy = (isset($attribs['cy']) ? $attribs['cy'] : 0.5);
23974 $fx = (isset($attribs['fx']) ? $attribs['fx'] : $cx);
23975 $fy = (isset($attribs['fy']) ? $attribs['fy'] : $cy);
23977 if (isset($attribs['gradientTransform'])) {
23978 $this->svggradients[$this->svggradientid]['gradientTransform'] = TCPDF_STATIC::getSVGTransformMatrix($attribs['gradientTransform']);
23979 }
23981 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
23982 // gradient is defined on another place
23984 }
23985 break;
23986 }
23987 case 'stop': {
23988 // gradient stops
23989 if (substr($attribs['offset'], -1) == '%') {
23990 $offset = floatval(substr($attribs['offset'], -1)) / 100;
23991 } else {
23992 $offset = floatval($attribs['offset']);
23993 if ($offset > 1) {
23994 $offset /= 100;
23995 }
23996 }
23997 $stop_color = isset($svgstyle['stop-color'])?TCPDF_COLORS::convertHTMLColorToDec($svgstyle['stop-color'], $this->spot_colors):'black';
23998 $opacity = isset($svgstyle['stop-opacity'])?$svgstyle['stop-opacity']:1;
23999 $this->svggradients[$this->svggradientid]['stops'][] = array('offset' => $offset, 'color' => $stop_color, 'opacity' => $opacity);
24000 break;
24001 }
24002 // paths
24003 case 'path': {
24004 if ($invisible) {
24005 break;
24006 }
24007 if (isset($attribs['d'])) {
24015 if ($clipping) {
24016 $this->SVGTransform($tm);
24018 } else {
24019 $this->StartTransform();
24020 $this->SVGTransform($tm);
24021 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'SVGPath', array($d, 'CNZ'));
24022 if (!empty($obstyle)) {
24024 }
24025 $this->StopTransform();
24026 }
24027 }
24028 }
24029 break;
24030 }
24031 // shapes
24032 case 'rect': {
24033 if ($invisible) {
24034 break;
24035 }
24036 $x = (isset($attribs['x'])?$this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false):0);
24037 $y = (isset($attribs['y'])?$this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false):0);
24038 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):0);
24039 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):0);
24040 $rx = (isset($attribs['rx'])?$this->getHTMLUnitToUnits($attribs['rx'], 0, $this->svgunit, false):0);
24041 $ry = (isset($attribs['ry'])?$this->getHTMLUnitToUnits($attribs['ry'], 0, $this->svgunit, false):$rx);
24042 if ($clipping) {
24043 $this->SVGTransform($tm);
24045 } else {
24046 $this->StartTransform();
24047 $this->SVGTransform($tm);
24048 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'RoundedRectXY', array($x, $y, $w, $h, $rx, $ry, '1111', 'CNZ'));
24049 if (!empty($obstyle)) {
24051 }
24052 $this->StopTransform();
24053 }
24054 break;
24055 }
24056 case 'circle': {
24057 if ($invisible) {
24058 break;
24059 }
24060 $r = (isset($attribs['r']) ? $this->getHTMLUnitToUnits($attribs['r'], 0, $this->svgunit, false) : 0);
24061 $cx = (isset($attribs['cx']) ? $this->getHTMLUnitToUnits($attribs['cx'], 0, $this->svgunit, false) : (isset($attribs['x']) ? $this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false) : 0));
24062 $cy = (isset($attribs['cy']) ? $this->getHTMLUnitToUnits($attribs['cy'], 0, $this->svgunit, false) : (isset($attribs['y']) ? $this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false) : 0));
24067 if ($clipping) {
24068 $this->SVGTransform($tm);
24070 } else {
24071 $this->StartTransform();
24072 $this->SVGTransform($tm);
24073 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Circle', array($cx, $cy, $r, 0, 360, 'CNZ'));
24074 if (!empty($obstyle)) {
24076 }
24077 $this->StopTransform();
24078 }
24079 break;
24080 }
24081 case 'ellipse': {
24082 if ($invisible) {
24083 break;
24084 }
24085 $rx = (isset($attribs['rx']) ? $this->getHTMLUnitToUnits($attribs['rx'], 0, $this->svgunit, false) : 0);
24086 $ry = (isset($attribs['ry']) ? $this->getHTMLUnitToUnits($attribs['ry'], 0, $this->svgunit, false) : 0);
24087 $cx = (isset($attribs['cx']) ? $this->getHTMLUnitToUnits($attribs['cx'], 0, $this->svgunit, false) : (isset($attribs['x']) ? $this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false) : 0));
24088 $cy = (isset($attribs['cy']) ? $this->getHTMLUnitToUnits($attribs['cy'], 0, $this->svgunit, false) : (isset($attribs['y']) ? $this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false) : 0));
24089 $x = ($cx - $rx);
24090 $y = ($cy - $ry);
24091 $w = (2 * $rx);
24092 $h = (2 * $ry);
24093 if ($clipping) {
24094 $this->SVGTransform($tm);
24096 } else {
24097 $this->StartTransform();
24098 $this->SVGTransform($tm);
24099 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Ellipse', array($cx, $cy, $rx, $ry, 0, 0, 360, 'CNZ'));
24100 if (!empty($obstyle)) {
24101 $this->Ellipse($cx, $cy, $rx, $ry, 0, 0, 360, $obstyle, array(), array(), 8);
24102 }
24103 $this->StopTransform();
24104 }
24105 break;
24106 }
24107 case 'line': {
24108 if ($invisible) {
24109 break;
24110 }
24111 $x1 = (isset($attribs['x1'])?$this->getHTMLUnitToUnits($attribs['x1'], 0, $this->svgunit, false):0);
24112 $y1 = (isset($attribs['y1'])?$this->getHTMLUnitToUnits($attribs['y1'], 0, $this->svgunit, false):0);
24113 $x2 = (isset($attribs['x2'])?$this->getHTMLUnitToUnits($attribs['x2'], 0, $this->svgunit, false):0);
24114 $y2 = (isset($attribs['y2'])?$this->getHTMLUnitToUnits($attribs['y2'], 0, $this->svgunit, false):0);
24115 $x = $x1;
24116 $y = $y1;
24117 $w = abs($x2 - $x1);
24118 $h = abs($y2 - $y1);
24119 if (!$clipping) {
24120 $this->StartTransform();
24121 $this->SVGTransform($tm);
24122 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Line', array($x1, $y1, $x2, $y2));
24123 $this->Line($x1, $y1, $x2, $y2);
24124 $this->StopTransform();
24125 }
24126 break;
24127 }
24128 case 'polyline':
24129 case 'polygon': {
24130 if ($invisible) {
24131 break;
24132 }
24133 $points = (isset($attribs['points'])?$attribs['points']:'0 0');
24134 $points = trim($points);
24135 // note that point may use a complex syntax not covered here
24136 $points = preg_split('/[\,\s]+/si', $points);
24137 if (count($points) < 4) {
24138 break;
24139 }
24140 $p = array();
24141 $xmin = 2147483647;
24142 $xmax = 0;
24143 $ymin = 2147483647;
24144 $ymax = 0;
24145 foreach ($points as $key => $val) {
24147 if (($key % 2) == 0) {
24148 // X coordinate
24149 $xmin = min($xmin, $p[$key]);
24150 $xmax = max($xmax, $p[$key]);
24151 } else {
24152 // Y coordinate
24153 $ymin = min($ymin, $p[$key]);
24154 $ymax = max($ymax, $p[$key]);
24155 }
24156 }
24157 $x = $xmin;
24158 $y = $ymin;
24159 $w = ($xmax - $xmin);
24160 $h = ($ymax - $ymin);
24161 if ($name == 'polyline') {
24162 $this->StartTransform();
24163 $this->SVGTransform($tm);
24164 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'PolyLine', array($p, 'CNZ'));
24165 if (!empty($obstyle)) {
24166 $this->PolyLine($p, $obstyle, array(), array());
24167 }
24168 $this->StopTransform();
24169 } else { // polygon
24170 if ($clipping) {
24171 $this->SVGTransform($tm);
24173 } else {
24174 $this->StartTransform();
24175 $this->SVGTransform($tm);
24176 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Polygon', array($p, 'CNZ'));
24177 if (!empty($obstyle)) {
24179 }
24180 $this->StopTransform();
24181 }
24182 }
24183 break;
24184 }
24185 // image
24186 case 'image': {
24187 if ($invisible) {
24188 break;
24189 }
24190 if (!isset($attribs['xlink:href']) OR empty($attribs['xlink:href'])) {
24191 break;
24192 }
24193 $x = (isset($attribs['x'])?$this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false):0);
24194 $y = (isset($attribs['y'])?$this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false):0);
24195 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):0);
24196 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):0);
24198 if (!$clipping) {
24199 $this->StartTransform();
24200 $this->SVGTransform($tm);
24203 // embedded image encoded as base64
24205 } else {
24206 // fix image path
24207 if (!TCPDF_STATIC::empty_string($this->svgdir) AND (($img[0] == '.') OR (basename($img) == $img))) {
24208 // replace relative path with full server path
24210 }
24211 if (($img[0] == '/') AND !empty($_SERVER['DOCUMENT_ROOT']) AND ($_SERVER['DOCUMENT_ROOT'] != '/')) {
24213 if (($findroot === false) OR ($findroot > 1)) {
24216 } else {
24218 }
24219 }
24220 }
24222 $testscrtype = @parse_url($img);
24223 if (!isset($testscrtype['query']) OR empty($testscrtype['query'])) {
24224 // convert URL to server path
24226 }
24227 }
24228 // get image type
24230 if (($imgtype == 'eps') OR ($imgtype == 'ai')) {
24232 } elseif ($imgtype == 'svg') {
24233 // store SVG vars
24245 // restore SVG vars
24246 $this->svggradients = $svggradients;
24247 $this->svggradientid = $svggradientid;
24248 $this->svgdefsmode = $svgdefsmode;
24249 $this->svgdefs = $svgdefs;
24250 $this->svgclipmode = $svgclipmode;
24251 $this->svgclippaths = $svgclippaths;
24252 $this->svgcliptm = $svgcliptm;
24253 $this->svgclipid = $svgclipid;
24254 $this->svgtext = $svgtext;
24255 $this->svgtextmode = $svgtextmode;
24256 } else {
24258 }
24259 $this->StopTransform();
24260 }
24261 break;
24262 }
24263 // text
24264 case 'text':
24265 case 'tspan': {
24266 if (isset($this->svgtextmode['text-anchor']) AND !empty($this->svgtext)) {
24267 // @TODO: unsupported feature
24268 }
24269 // only basic support - advanced features must be implemented
24270 $this->svgtextmode['invisible'] = $invisible;
24271 if ($invisible) {
24272 break;
24273 }
24274 array_push($this->svgstyles, $svgstyle);
24275 if (isset($attribs['x'])) {
24277 } elseif ($name == 'tspan') {
24279 } else {
24280 $x = 0;
24281 }
24282 if (isset($attribs['dx'])) {
24284 }
24285 if (isset($attribs['y'])) {
24287 } elseif ($name == 'tspan') {
24289 } else {
24290 $y = 0;
24291 }
24292 if (isset($attribs['dy'])) {
24294 }
24295 $svgstyle['text-color'] = $svgstyle['fill'];
24296 $this->svgtext = '';
24297 if (isset($svgstyle['text-anchor'])) {
24298 $this->svgtextmode['text-anchor'] = $svgstyle['text-anchor'];
24299 } else {
24300 $this->svgtextmode['text-anchor'] = 'start';
24301 }
24302 if (isset($svgstyle['direction'])) {
24303 if ($svgstyle['direction'] == 'rtl') {
24304 $this->svgtextmode['rtl'] = true;
24305 } else {
24306 $this->svgtextmode['rtl'] = false;
24307 }
24308 } else {
24309 $this->svgtextmode['rtl'] = false;
24310 }
24311 if (isset($svgstyle['stroke']) AND ($svgstyle['stroke'] != 'none') AND isset($svgstyle['stroke-width']) AND ($svgstyle['stroke-width'] > 0)) {
24312 $this->svgtextmode['stroke'] = $this->getHTMLUnitToUnits($svgstyle['stroke-width'], 0, $this->svgunit, false);
24313 } else {
24314 $this->svgtextmode['stroke'] = false;
24315 }
24316 $this->StartTransform();
24317 $this->SVGTransform($tm);
24319 $this->x = $x;
24320 $this->y = $y;
24321 break;
24322 }
24323 // use
24324 case 'use': {
24325 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
24326 $svgdefid = substr($attribs['xlink:href'], 1);
24327 if (isset($this->svgdefs[$svgdefid])) {
24328 $use = $this->svgdefs[$svgdefid];
24329 if (isset($attribs['xlink:href'])) {
24330 unset($attribs['xlink:href']);
24331 }
24332 if (isset($attribs['id'])) {
24333 unset($attribs['id']);
24334 }
24335 if (isset($use['attribs']['x']) AND isset($attribs['x'])) {
24336 $attribs['x'] += $use['attribs']['x'];
24337 }
24338 if (isset($use['attribs']['y']) AND isset($attribs['y'])) {
24339 $attribs['y'] += $use['attribs']['y'];
24340 }
24341 if (empty($attribs['style'])) {
24342 $attribs['style'] = '';
24343 }
24344 if (!empty($use['attribs']['style'])) {
24345 // merge styles
24346 $attribs['style'] = str_replace(';;',';',';'.$use['attribs']['style'].$attribs['style']);
24347 }
24348 $attribs = array_merge($use['attribs'], $attribs);
24350 return;
24351 }
24352 }
24353 break;
24354 }
24355 default: {
24356 break;
24357 }
24358 } // end of switch
24359 // process child elements
24360 if (!empty($attribs['child_elements'])) {
24361 $child_elements = $attribs['child_elements'];
24362 unset($attribs['child_elements']);
24363 foreach($child_elements as $child_element) {
24364 if (empty($child_element['attribs']['closing_tag'])) {
24365 $this->startSVGElementHandler('child-tag', $child_element['name'], $child_element['attribs']);
24366 } else {
24367 if (isset($child_element['attribs']['content'])) {
24368 $this->svgtext = $child_element['attribs']['content'];
24369 }
24371 }
24372 }
24373 }
24374 }
static getSVGTransformMatrix($attribute)
Get the tranformation matrix from SVG transform attribute.
Definition: tcpdf_static.php:1666
endSVGElementHandler($parser, $name)
Sets the closing SVG element handler function for the XML parser.
Definition: tcpdf.php:24384
PolyLine($p, $style='', $line_style=array(), $fill_color=array())
Draws a polygonal line.
Definition: tcpdf.php:11842
setSVGStyles($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array())
Apply the requested SVG styles (*** TO BE COMPLETED ***)
Definition: tcpdf.php:23047
if((!isset($_SERVER['DOCUMENT_ROOT'])) OR(empty($_SERVER['DOCUMENT_ROOT']))) $_SERVER['DOCUMENT_ROOT']
Definition: tcpdf_autoconfig.php:54
References $_SERVER, $d, $h, $img, $parser, $r, TCPDF_IMAGES\$svginheritprop, $w, $x, $y, 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:
◆ startTemplate()
| 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.
- Parameters
-
$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).
- Returns
- int the XObject Template ID in case of success or false in case of error.
- Since
- 5.8.017 (2010-08-24)
- See also
- endTemplate(), printTemplate()
Definition at line 22240 of file tcpdf.php.
22240 {
22241 if ($this->inxobj) {
22242 // we are already inside an XObject template
22243 return false;
22244 }
22245 $this->inxobj = true;
22246 ++$this->n;
22247 // XObject ID
22248 $this->xobjid = 'XT'.$this->n;
22249 // object ID
22251 // store current graphic state
22253 // initialize data
22264 // set new environment
22265 $this->num_columns = 1;
22266 $this->current_column = 0;
22270 }
22273 }
22278 $this->w = $w;
22279 $this->h = $h;
22280 $this->wPt = $this->w * $this->k;
22281 $this->hPt = $this->h * $this->k;
22282 $this->fwPt = $this->wPt;
22283 $this->fhPt = $this->hPt;
22284 $this->x = 0;
22285 $this->y = 0;
22286 $this->lMargin = 0;
22287 $this->rMargin = 0;
22288 $this->tMargin = 0;
22289 $this->bMargin = 0;
22290 // set group mode
22293 }
References $bMargin, $h, $n, and $w.
Referenced by Button(), Header(), and TextField().
Here is the caller graph for this function:
◆ startTransaction()
| TCPDF::startTransaction | ( | ) |
Stores a copy of the current TCPDF object used for undo operation.
- Since
- 4.5.029 (2009-03-19)
Definition at line 21632 of file tcpdf.php.
21632 {
21633 if (isset($this->objcopy)) {
21634 // remove previous copy
21635 $this->commitTransaction();
21636 }
21637 // record current page number and Y position
21638 $this->start_transaction_page = $this->page;
21639 $this->start_transaction_y = $this->y;
21640 // clone current object
21641 $this->objcopy = TCPDF_STATIC::objclone($this);
21642 }
commitTransaction()
Delete the copy of the current TCPDF object used for undo operation.
Definition: tcpdf.php:21649
References $y, and TCPDF_STATIC\objclone().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ StartTransform()
| 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.
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 10945 of file tcpdf.php.
10945 {
10946 if ($this->state != 2) {
10947 return;
10948 }
10949 $this->_outSaveGraphicsState();
10950 if ($this->inxobj) {
10951 // we are inside an XObject template
10952 $this->xobjects[$this->xobjid]['transfmrk'][] = strlen($this->xobjects[$this->xobjid]['outdata']);
10953 } else {
10955 }
10956 ++$this->transfmatrix_key;
10957 $this->transfmatrix[$this->transfmatrix_key] = array();
10958 }
References $page, $transfmatrix_key, $xobjid, and _outSaveGraphicsState().
Here is the call graph for this function:
◆ StopTransform()
| 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.
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 10968 of file tcpdf.php.
10968 {
10969 if ($this->state != 2) {
10970 return;
10971 }
10972 $this->_outRestoreGraphicsState();
10973 if (isset($this->transfmatrix[$this->transfmatrix_key])) {
10974 array_pop($this->transfmatrix[$this->transfmatrix_key]);
10975 --$this->transfmatrix_key;
10976 }
10977 if ($this->inxobj) {
10978 // we are inside an XObject template
10979 array_pop($this->xobjects[$this->xobjid]['transfmrk']);
10980 } else {
10981 array_pop($this->transfmrk[$this->page]);
10982 }
10983 }
References $transfmatrix_key, and _outRestoreGraphicsState().
Here is the call graph for this function:
◆ stringLeftTrim()
| TCPDF::stringLeftTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Left trim the input string.
- Parameters
-
$str (string) string to trim $replace (string) string that replace spaces.
- Returns
- left trimmed string
- Since
- 5.8.000 (2010-08-11)
Definition at line 22145 of file tcpdf.php.
22145 {
22146 return preg_replace('/^'.$this->re_space['p'].'+/'.$this->re_space['m'], $replace, $str);
22147 }
Referenced by writeHTML().
Here is the caller graph for this function:
◆ stringRightTrim()
| TCPDF::stringRightTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Right trim the input string.
- Parameters
-
$str (string) string to trim $replace (string) string that replace spaces.
- Returns
- right trimmed string
- Since
- 5.8.000 (2010-08-11)
Definition at line 22158 of file tcpdf.php.
22158 {
22159 return preg_replace('/'.$this->re_space['p'].'+$/'.$this->re_space['m'], $replace, $str);
22160 }
Referenced by Write(), and writeHTML().
Here is the caller graph for this function:
◆ stringTrim()
| TCPDF::stringTrim | ( | $str, | |
$replace = '' |
|||
| ) |
Trim the input string.
- Parameters
-
$str (string) string to trim $replace (string) string that replace spaces.
- Returns
- trimmed string
- Since
- 5.8.000 (2010-08-11)
Definition at line 22171 of file tcpdf.php.
22171 {
22172 $str = $this->stringLeftTrim($str, $replace);
22173 $str = $this->stringRightTrim($str, $replace);
22174 return $str;
22175 }
Referenced by _putbookmarks(), getHtmlDomArray(), and Write().
Here is the caller graph for this function:
◆ SVGPath()
|
protected |
Draws an SVG path.
- Parameters
-
$d (string) attribute d of the path SVG element $style (string) Style of rendering. Possible values are: - D or empty string: Draw (default).
- F: Fill.
- F*: Fill using the even-odd rule to determine which regions lie inside the clipping path.
- DF or FD: Draw and fill.
- DF* or FD*: Draw and fill using the even-odd rule to determine which regions lie inside the clipping path.
- CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).
- CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).
- Returns
- array of container box measures (x, y, w, h)
- Since
- 5.0.000 (2010-05-02)
Definition at line 23342 of file tcpdf.php.
23342 {
23343 if ($this->state != 2) {
23344 return;
23345 }
23346 // set fill/stroke style
23348 if (empty($op)) {
23349 return;
23350 }
23351 $paths = array();
23354 $x = 0;
23355 $y = 0;
23356 $x1 = 0;
23357 $y1 = 0;
23358 $x2 = 0;
23359 $y2 = 0;
23360 $xmin = 2147483647;
23361 $xmax = 0;
23362 $ymin = 2147483647;
23363 $ymax = 0;
23364 $relcoord = false;
23366 $firstcmd = true; // used to print first point
23367 // draw curve pieces
23368 foreach ($paths as $key => $val) {
23369 // get curve type
23370 $cmd = trim($val[1]);
23372 // use relative coordinated instead of absolute
23373 $relcoord = true;
23374 $xoffset = $x;
23375 $yoffset = $y;
23376 } else {
23377 $relcoord = false;
23378 $xoffset = 0;
23379 $yoffset = 0;
23380 }
23381 $params = array();
23382 if (isset($val[2])) {
23383 // get curve parameters
23384 $rawparams = preg_split('/([\,\s]+)/si', trim($val[2]));
23385 $params = array();
23386 foreach ($rawparams as $ck => $cp) {
23389 // approximate little values to zero
23390 $params[$ck] = 0;
23391 }
23392 }
23393 }
23394 // store current origin point
23395 $x0 = $x;
23396 $y0 = $y;
23398 case 'M': { // moveto
23400 if (($ck % 2) == 0) {
23401 $x = $cp + $xoffset;
23402 } else {
23403 $y = $cp + $yoffset;
23405 if ($ck == 1) {
23407 $firstcmd = false;
23408 } else {
23410 }
23411 $x0 = $x;
23412 $y0 = $y;
23413 }
23414 $xmin = min($xmin, $x);
23415 $ymin = min($ymin, $y);
23416 $xmax = max($xmax, $x);
23417 $ymax = max($ymax, $y);
23418 if ($relcoord) {
23419 $xoffset = $x;
23420 $yoffset = $y;
23421 }
23422 }
23423 }
23424 break;
23425 }
23426 case 'L': { // lineto
23428 if (($ck % 2) == 0) {
23429 $x = $cp + $xoffset;
23430 } else {
23431 $y = $cp + $yoffset;
23434 $x0 = $x;
23435 $y0 = $y;
23436 }
23437 $xmin = min($xmin, $x);
23438 $ymin = min($ymin, $y);
23439 $xmax = max($xmax, $x);
23440 $ymax = max($ymax, $y);
23441 if ($relcoord) {
23442 $xoffset = $x;
23443 $yoffset = $y;
23444 }
23445 }
23446 }
23447 break;
23448 }
23449 case 'H': { // horizontal lineto
23451 $x = $cp + $xoffset;
23454 $x0 = $x;
23455 $y0 = $y;
23456 }
23457 $xmin = min($xmin, $x);
23458 $xmax = max($xmax, $x);
23459 if ($relcoord) {
23460 $xoffset = $x;
23461 }
23462 }
23463 break;
23464 }
23465 case 'V': { // vertical lineto
23467 $y = $cp + $yoffset;
23470 $x0 = $x;
23471 $y0 = $y;
23472 }
23473 $ymin = min($ymin, $y);
23474 $ymax = max($ymax, $y);
23475 if ($relcoord) {
23476 $yoffset = $y;
23477 }
23478 }
23479 break;
23480 }
23481 case 'C': { // curveto
23483 $params[$ck] = $cp;
23484 if ((($ck + 1) % 6) == 0) {
23485 $x1 = $params[($ck - 5)] + $xoffset;
23486 $y1 = $params[($ck - 4)] + $yoffset;
23487 $x2 = $params[($ck - 3)] + $xoffset;
23488 $y2 = $params[($ck - 2)] + $yoffset;
23492 $xmin = min($xmin, $x, $x1, $x2);
23493 $ymin = min($ymin, $y, $y1, $y2);
23494 $xmax = max($xmax, $x, $x1, $x2);
23495 $ymax = max($ymax, $y, $y1, $y2);
23496 if ($relcoord) {
23497 $xoffset = $x;
23498 $yoffset = $y;
23499 }
23500 }
23501 }
23502 break;
23503 }
23504 case 'S': { // shorthand/smooth curveto
23506 $params[$ck] = $cp;
23507 if ((($ck + 1) % 4) == 0) {
23508 if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'C') OR (strtoupper($paths[($key - 1)][1]) == 'S'))) {
23509 $x1 = (2 * $x) - $x2;
23510 $y1 = (2 * $y) - $y2;
23511 } else {
23512 $x1 = $x;
23513 $y1 = $y;
23514 }
23515 $x2 = $params[($ck - 3)] + $xoffset;
23516 $y2 = $params[($ck - 2)] + $yoffset;
23520 $xmin = min($xmin, $x, $x1, $x2);
23521 $ymin = min($ymin, $y, $y1, $y2);
23522 $xmax = max($xmax, $x, $x1, $x2);
23523 $ymax = max($ymax, $y, $y1, $y2);
23524 if ($relcoord) {
23525 $xoffset = $x;
23526 $yoffset = $y;
23527 }
23528 }
23529 }
23530 break;
23531 }
23532 case 'Q': { // quadratic Bezier curveto
23534 $params[$ck] = $cp;
23535 if ((($ck + 1) % 4) == 0) {
23536 // convert quadratic points to cubic points
23537 $x1 = $params[($ck - 3)] + $xoffset;
23538 $y1 = $params[($ck - 2)] + $yoffset;
23539 $xa = ($x + (2 * $x1)) / 3;
23540 $ya = ($y + (2 * $y1)) / 3;
23543 $xb = ($x + (2 * $x1)) / 3;
23544 $yb = ($y + (2 * $y1)) / 3;
23546 $xmin = min($xmin, $x, $xa, $xb);
23547 $ymin = min($ymin, $y, $ya, $yb);
23548 $xmax = max($xmax, $x, $xa, $xb);
23549 $ymax = max($ymax, $y, $ya, $yb);
23550 if ($relcoord) {
23551 $xoffset = $x;
23552 $yoffset = $y;
23553 }
23554 }
23555 }
23556 break;
23557 }
23558 case 'T': { // shorthand/smooth quadratic Bezier curveto
23560 $params[$ck] = $cp;
23561 if (($ck % 2) != 0) {
23562 if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'Q') OR (strtoupper($paths[($key - 1)][1]) == 'T'))) {
23563 $x1 = (2 * $x) - $x1;
23564 $y1 = (2 * $y) - $y1;
23565 } else {
23566 $x1 = $x;
23567 $y1 = $y;
23568 }
23569 // convert quadratic points to cubic points
23570 $xa = ($x + (2 * $x1)) / 3;
23571 $ya = ($y + (2 * $y1)) / 3;
23574 $xb = ($x + (2 * $x1)) / 3;
23575 $yb = ($y + (2 * $y1)) / 3;
23577 $xmin = min($xmin, $x, $xa, $xb);
23578 $ymin = min($ymin, $y, $ya, $yb);
23579 $xmax = max($xmax, $x, $xa, $xb);
23580 $ymax = max($ymax, $y, $ya, $yb);
23581 if ($relcoord) {
23582 $xoffset = $x;
23583 $yoffset = $y;
23584 }
23585 }
23586 }
23587 break;
23588 }
23589 case 'A': { // elliptical arc
23591 $params[$ck] = $cp;
23592 if ((($ck + 1) % 7) == 0) {
23593 $x0 = $x;
23594 $y0 = $y;
23595 $rx = abs($params[($ck - 6)]);
23596 $ry = abs($params[($ck - 5)]);
23597 $ang = -$rawparams[($ck - 4)];
23598 $angle = deg2rad($ang);
23599 $fa = $rawparams[($ck - 3)]; // large-arc-flag
23600 $fs = $rawparams[($ck - 2)]; // sweep-flag
23604 // endpoints are almost identical
23605 $xmin = min($xmin, $x);
23606 $ymin = min($ymin, $y);
23607 $xmax = max($xmax, $x);
23608 $ymax = max($ymax, $y);
23609 } else {
23610 $cos_ang = cos($angle);
23611 $sin_ang = sin($angle);
23612 $a = (($x0 - $x) / 2);
23613 $b = (($y0 - $y) / 2);
23614 $xa = ($a * $cos_ang) - ($b * $sin_ang);
23615 $ya = ($a * $sin_ang) + ($b * $cos_ang);
23616 $rx2 = $rx * $rx;
23617 $ry2 = $ry * $ry;
23618 $xa2 = $xa * $xa;
23619 $ya2 = $ya * $ya;
23620 $delta = ($xa2 / $rx2) + ($ya2 / $ry2);
23621 if ($delta > 1) {
23622 $rx *= sqrt($delta);
23623 $ry *= sqrt($delta);
23624 $rx2 = $rx * $rx;
23625 $ry2 = $ry * $ry;
23626 }
23627 $numerator = (($rx2 * $ry2) - ($rx2 * $ya2) - ($ry2 * $xa2));
23628 if ($numerator < 0) {
23629 $root = 0;
23630 } else {
23631 $root = sqrt($numerator / (($rx2 * $ya2) + ($ry2 * $xa2)));
23632 }
23633 if ($fa == $fs){
23634 $root *= -1;
23635 }
23636 $cax = $root * (($rx * $ya) / $ry);
23637 $cay = -$root * (($ry * $xa) / $rx);
23638 // coordinates of ellipse center
23639 $cx = ($cax * $cos_ang) - ($cay * $sin_ang) + (($x0 + $x) / 2);
23640 $cy = ($cax * $sin_ang) + ($cay * $cos_ang) + (($y0 + $y) / 2);
23641 // get angles
23642 $angs = TCPDF_STATIC::getVectorsAngle(1, 0, (($xa - $cax) / $rx), (($cay - $ya) / $ry));
23643 $dang = TCPDF_STATIC::getVectorsAngle((($xa - $cax) / $rx), (($ya - $cay) / $ry), ((-$xa - $cax) / $rx), ((-$ya - $cay) / $ry));
23644 if (($fs == 0) AND ($dang > 0)) {
23645 $dang -= (2 * M_PI);
23646 } elseif (($fs == 1) AND ($dang < 0)) {
23647 $dang += (2 * M_PI);
23648 }
23649 $angf = $angs - $dang;
23650 if ((($fs == 0) AND ($angs > $angf)) OR (($fs == 1) AND ($angs < $angf))) {
23651 // reverse angles
23652 $tmp = $angs;
23653 $angs = $angf;
23654 $angf = $tmp;
23655 }
23656 $angs = round(rad2deg($angs), 6);
23657 $angf = round(rad2deg($angf), 6);
23658 // covent angles to positive values
23659 if (($angs < 0) AND ($angf < 0)) {
23660 $angs += 360;
23661 $angf += 360;
23662 }
23663 $pie = false;
23664 if (($key == 0) AND (isset($paths[($key + 1)][1])) AND (trim($paths[($key + 1)][1]) == 'z')) {
23665 $pie = true;
23666 }
23667 list($axmin, $aymin, $axmax, $aymax) = $this->_outellipticalarc($cx, $cy, $rx, $ry, $ang, $angs, $angf, $pie, 2, false, ($fs == 0), true);
23668 $xmin = min($xmin, $x, $axmin);
23669 $ymin = min($ymin, $y, $aymin);
23670 $xmax = max($xmax, $x, $axmax);
23671 $ymax = max($ymax, $y, $aymax);
23672 }
23673 if ($relcoord) {
23674 $xoffset = $x;
23675 $yoffset = $y;
23676 }
23677 }
23678 }
23679 break;
23680 }
23681 case 'Z': {
23683 break;
23684 }
23685 }
23686 $firstcmd = false;
23687 } // end foreach
23688 if (!empty($op)) {
23689 $this->_out($op);
23690 }
23691 return array($xmin, $ymin, ($xmax - $xmin), ($ymax - $ymin));
23692 }
static getVectorsAngle($x1, $y1, $x2, $y2)
Returns the angle in radiants between two vectors.
Definition: tcpdf_static.php:1763
References $angle, $cmd, $d, $params, $style, $x, $y, TCPDF_STATIC\getPathPaintOperator(), and TCPDF_STATIC\getVectorsAngle().
Here is the call graph for this function:
◆ SVGTransform()
|
protected |
Apply SVG graphic transformation matrix.
- Parameters
-
$tm (array) original SVG transformation matrix
- Since
- 5.0.000 (2010-05-02)
Definition at line 23028 of file tcpdf.php.
23028 {
23030 }
◆ swapMargins()
|
protected |
Swap the left and right margins.
- Parameters
-
$reverse (boolean) if true swap left and right margins.
- Since
- 4.2.000 (2008-10-29)
Definition at line 20189 of file tcpdf.php.
20189 {
20190 if ($reverse) {
20191 // swap left and right margins
20192 $mtemp = $this->original_lMargin;
20193 $this->original_lMargin = $this->original_rMargin;
20194 $this->original_rMargin = $mtemp;
20195 $deltam = $this->original_lMargin - $this->original_rMargin;
20196 $this->lMargin += $deltam;
20197 $this->rMargin -= $deltam;
20198 }
20199 }
Referenced by startPage().
Here is the caller graph for this function:
◆ Text()
| 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.
- Parameters
-
$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: - 0: no border (default)
- 1: frame
- L: left
- T: top
- R: right
- B: bottom
$ln (int) Indicates where the current position should go after the call. Possible values are: - 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
$align (string) Allows to center or align the text. Possible values are: - L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
$fill (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: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
$ignore_min_height (boolean) if true ignore automatic minimum height value. $calign (string) cell vertical alignment relative to the specified Y value. Possible values are: - T : cell top
- A : font top
- L : font baseline
- D : font bottom
- B : cell bottom
$valign (string) text vertical alignment inside the cell. Possible values are: - T : top
- C : center
- B : bottom
$rtloff (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position.
- Since
- 1.0
- See also
- Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()
Definition at line 4893 of file tcpdf.php.
4893 {
4896 $this->setTextRenderingMode($fstroke, $ffill, $fclip);
4898 $this->Cell(0, 0, $txt, $border, $ln, $align, $fill, $link, $stretch, $ignore_min_height, $calign, $valign);
4899 // restore previous rendering mode
4900 $this->textrendermode = $textrendermode;
4901 $this->textstrokewidth = $textstrokewidth;
4902 }
References $border, $textrendermode, $textstrokewidth, $txt, $x, $y, Cell(), setTextRenderingMode(), and SetXY().
Here is the call graph for this function:
◆ TextField()
| TCPDF::TextField | ( | $name, | |
| $w, | |||
| $h, | |||
$prop = array(), |
|||
$opt = array(), |
|||
$x = '', |
|||
$y = '', |
|||
$js = false |
|||
| ) |
Creates a text field.
- Parameters
-
$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).
- Since
- 4.8.000 (2009-09-07)
Definition at line 12645 of file tcpdf.php.
12645 {
12648 }
12651 }
12652 // check page for no-write regions and adapt page margins if necessary
12656 return;
12657 }
12658 // get default style
12659 $prop = array_merge($this->getFormDefaultProp(), $prop);
12660 // get annotation data
12661 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12662 // set default appearance stream
12663 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12664 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12665 $popt['da'] = $fontstyle;
12666 // build appearance stream
12667 $popt['ap'] = array();
12668 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12670 if (isset($prop['value']) AND !empty($prop['value'])) {
12672 } elseif (isset($opt['v']) AND !empty($opt['v'])) {
12674 }
12676 $align = '';
12677 if (isset($popt['q'])) {
12678 switch ($popt['q']) {
12679 case 0: {
12680 $align = 'L';
12681 break;
12682 }
12683 case 1: {
12684 $align = 'C';
12685 break;
12686 }
12687 case 2: {
12688 $align = 'R';
12689 break;
12690 }
12691 default: {
12692 $align = '';
12693 break;
12694 }
12695 }
12696 }
12697 $this->MultiCell($w, $h, $text, 0, $align, false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
12698 $this->endTemplate();
12699 --$this->n;
12700 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
12701 unset($this->xobjects[$tmpid]);
12702 $popt['ap']['n'] .= 'Q EMC';
12703 // merge options
12704 $opt = array_merge($popt, $opt);
12705 // remove some conflicting options
12706 unset($opt['bs']);
12707 // set remaining annotation data
12708 $opt['Subtype'] = 'Widget';
12709 $opt['ft'] = 'Tx';
12710 $opt['t'] = $name;
12711 // Additional annotation's parameters (check _putannotsobj() method):
12712 //$opt['f']
12713 //$opt['as']
12714 //$opt['bs']
12715 //$opt['be']
12716 //$opt['c']
12717 //$opt['border']
12718 //$opt['h']
12719 //$opt['mk'];
12720 //$opt['mk']['r']
12721 //$opt['mk']['bc'];
12722 //$opt['mk']['bg'];
12723 unset($opt['mk']['ca']);
12724 unset($opt['mk']['rc']);
12725 unset($opt['mk']['ac']);
12726 unset($opt['mk']['i']);
12727 unset($opt['mk']['ri']);
12728 unset($opt['mk']['ix']);
12729 unset($opt['mk']['if']);
12730 //$opt['mk']['if']['sw'];
12731 //$opt['mk']['if']['s'];
12732 //$opt['mk']['if']['a'];
12733 //$opt['mk']['if']['fb'];
12734 unset($opt['mk']['tp']);
12735 //$opt['tu']
12736 //$opt['tm']
12737 //$opt['ff']
12738 //$opt['v']
12739 //$opt['dv']
12740 //$opt['a']
12741 //$opt['aa']
12742 //$opt['q']
12744 if ($this->rtl) {
12745 $this->x -= $w;
12746 } else {
12747 $this->x += $w;
12748 }
12749 }
References $h, $js, $n, $text, $w, $x, $y, _addfield(), Annotation(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), MultiCell(), sprintf, and startTemplate().
Referenced by openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Transform()
|
protected |
Apply graphic transformations.
- Parameters
-
$tm (array) transformation matrix
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11247 of file tcpdf.php.
11247 {
11248 if ($this->state != 2) {
11249 return;
11250 }
11252 // add tranformation matrix
11253 $this->transfmatrix[$this->transfmatrix_key][] = array('a' => $tm[0], 'b' => $tm[1], 'c' => $tm[2], 'd' => $tm[3], 'e' => $tm[4], 'f' => $tm[5]);
11254 // update transformation mark
11255 if ($this->inxobj) {
11256 // we are inside an XObject template
11257 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
11258 $key = key($this->xobjects[$this->xobjid]['transfmrk']);
11259 $this->xobjects[$this->xobjid]['transfmrk'][$key] = strlen($this->xobjects[$this->xobjid]['outdata']);
11260 }
11261 } elseif (end($this->transfmrk[$this->page]) !== false) {
11262 $key = key($this->transfmrk[$this->page]);
11264 }
11265 }
References $page, $transfmatrix_key, $xobjid, _out(), and sprintf.
Referenced by Rotate(), Scale(), Skew(), and Translate().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Translate()
| TCPDF::Translate | ( | $t_x, | |
| $t_y | |||
| ) |
Translate graphic object horizontally and vertically.
- Parameters
-
$t_x (int) movement to the right $t_y (int) movement to the bottom
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11137 of file tcpdf.php.
11137 {
11138 //calculate elements of transformation matrix
11139 $tm = array();
11140 $tm[0] = 1;
11141 $tm[1] = 0;
11142 $tm[2] = 0;
11143 $tm[3] = 1;
11144 $tm[4] = $t_x * $this->k;
11145 $tm[5] = -$t_y * $this->k;
11146 //translate the coordinate system
11147 $this->Transform($tm);
11148 }
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:
◆ TranslateX()
| TCPDF::TranslateX | ( | $t_x | ) |
Translate graphic object horizontally.
- Parameters
-
$t_x (int) movement to the right (or left for RTL)
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11114 of file tcpdf.php.
11114 {
11115 $this->Translate($t_x, 0);
11116 }
Translate($t_x, $t_y)
Translate graphic object horizontally and vertically.
Definition: tcpdf.php:11137
References Translate().
Here is the call graph for this function:
◆ TranslateY()
| TCPDF::TranslateY | ( | $t_y | ) |
Translate graphic object vertically.
- Parameters
-
$t_y (int) movement to the bottom
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11125 of file tcpdf.php.
References Translate().
Here is the call graph for this function:
◆ unhtmlentities()
| TCPDF::unhtmlentities | ( | $text_to_convert | ) |
Reverse function for htmlentities.
Convert entities in UTF-8.
- Parameters
-
$text_to_convert (string) Text to convert.
- Returns
- string converted text string
Definition at line 10427 of file tcpdf.php.
10427 {
10428 return @html_entity_decode($text_to_convert, ENT_QUOTES, $this->encoding);
10429 }
Referenced by _putannotsobjs(), _putbookmarks(), and getHtmlDomArray().
Here is the caller graph for this function:
◆ unserializeTCPDFtagParameters()
|
protected |
Unserialize parameters to be used with TCPDF tag in HTML code.
- Parameters
-
$data (string) serialized data
- Returns
- array containing unserialized data static
Definition at line 17072 of file tcpdf.php.
17072 {
17073 $hash = substr($data, 0, 32);
17074 $encoded = substr($data, 32);
17077 }
17078 return json_decode(urldecode($encoded), true);
17079 }
References $data, Error(), and getHashForTCPDFtagParams().
Here is the call graph for this function:
◆ Write()
| 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.
- Parameters
-
$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: - L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
$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: - 0 = disabled
- 1 = horizontal scaling only if text is larger than cell width
- 2 = forced horizontal scaling to fit cell width
- 3 = character spacing only if text is larger than cell width
- 4 = forced character spacing to fit cell width
$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. 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
- Returns
- mixed Return the number of cells or the remaining string if $firstline = true.
- Since
- 1.5
Definition at line 6272 of file tcpdf.php.
6272 {
6273 // check page for no-write regions and adapt page margins if necessary
6276 // fix empty text
6278 }
6279 if ($margin === '') {
6280 // set default margins
6281 $margin = $this->cell_margin;
6282 }
6283 // remove carriage returns
6285 // check if string contains arabic text
6287 $arabic = true;
6288 } else {
6289 $arabic = false;
6290 }
6291 // check if string contains RTL text
6292 if ($arabic OR ($this->tmprtl == 'R') OR preg_match(TCPDF_FONT_DATA::$uni_RE_PATTERN_RTL, $s)) {
6293 $rtlmode = true;
6294 } else {
6295 $rtlmode = false;
6296 }
6297 // get a char width
6299 // get array of unicode values
6300 $chars = TCPDF_FONTS::UTF8StringToArray($s, $this->isunicode, $this->CurrentFont);
6301 // calculate maximum width for a single character on string
6303 array_walk($chrw, array($this, 'getRawCharWidth'));
6304 $maxchwidth = max($chrw);
6305 // get array of chars
6306 $uchars = TCPDF_FONTS::UTF8ArrayToUniArray($chars, $this->isunicode);
6307 // get the number of characters
6308 $nb = count($chars);
6309 // replacement for SHY character (minus symbol)
6310 $shy_replacement = 45;
6311 $shy_replacement_char = TCPDF_FONTS::unichr($shy_replacement, $this->isunicode);
6312 // widht for SHY replacement
6313 $shy_replacement_width = $this->GetCharWidth($shy_replacement);
6314 // page width
6316 // calculate remaining line width ($w)
6317 if ($this->rtl) {
6319 } else {
6321 }
6322 // max column width
6323 $wmax = ($w - $wadj);
6324 if (!$firstline) {
6325 $wmax -= ($this->cell_padding['L'] + $this->cell_padding['R']);
6326 }
6327 if ((!$firstline) AND (($chrwidth > $wmax) OR ($maxchwidth > $wmax))) {
6328 // the maximum width character do not fit on column
6329 return '';
6330 }
6331 // minimum row height
6333 // max Y
6334 $maxy = $this->y + $maxh - max($row_height, $h);
6335 $start_page = $this->page;
6336 $i = 0; // character position
6337 $j = 0; // current starting position
6338 $sep = -1; // position of the last blank space
6339 $prevsep = $sep; // previous separator
6340 $shy = false; // true if the last blank is a soft hypen (SHY)
6341 $prevshy = $shy; // previous shy mode
6343 $nl = 0; //number of lines
6344 $linebreak = false;
6345 $pc = 0; // previous character
6346 // for each character
6347 while ($i < $nb) {
6348 if (($maxh > 0) AND ($this->y > $maxy) ) {
6349 break;
6350 }
6351 //Get the current character
6352 $c = $chars[$i];
6353 if ($c == 10) { // 10 = "\n" = new line
6354 //Explicit line break
6355 if ($align == 'J') {
6356 if ($this->rtl) {
6357 $talign = 'R';
6358 } else {
6359 $talign = 'L';
6360 }
6361 } else {
6362 $talign = $align;
6363 }
6364 $tmpstr = TCPDF_FONTS::UniArrSubString($uchars, $j, $i);
6365 if ($firstline) {
6366 $startx = $this->x;
6367 $tmparr = array_slice($chars, $j, ($i - $j));
6368 if ($rtlmode) {
6369 $tmparr = TCPDF_FONTS::utf8Bidi($tmparr, $tmpstr, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6370 }
6371 $linew = $this->GetArrStringWidth($tmparr);
6372 unset($tmparr);
6373 if ($this->rtl) {
6374 $this->endlinex = $startx - $linew;
6375 } else {
6376 $this->endlinex = $startx + $linew;
6377 }
6378 $w = $linew;
6379 $tmpcellpadding = $this->cell_padding;
6380 if ($maxh == 0) {
6381 $this->SetCellPadding(0);
6382 }
6383 }
6385 $tmpstr = $this->stringRightTrim($tmpstr);
6386 }
6387 // Skip newlines at the beginning of a page or column
6388 if (!empty($tmpstr) OR ($this->y < ($this->PageBreakTrigger - $row_height))) {
6390 }
6391 unset($tmpstr);
6392 if ($firstline) {
6393 $this->cell_padding = $tmpcellpadding;
6395 }
6396 ++$nl;
6397 $j = $i + 1;
6398 $l = 0;
6399 $sep = -1;
6400 $prevsep = $sep;
6401 $shy = false;
6402 // account for margin changes
6404 $this->AcceptPageBreak();
6405 if ($this->rtl) {
6406 $this->x -= $margin['R'];
6407 } else {
6408 $this->x += $margin['L'];
6409 }
6410 $this->lMargin += $margin['L'];
6411 $this->rMargin += $margin['R'];
6412 }
6415 } else {
6416 // 160 is the non-breaking space.
6417 // 173 is SHY (Soft Hypen).
6418 // \p{Z} or \p{Separator}: any kind of Unicode whitespace or invisible separator.
6419 // \p{Lo} or \p{Other_Letter}: a Unicode letter or ideograph that does not have lowercase and uppercase variants.
6420 // \p{Lo} is needed because Chinese characters are packed next to each other without spaces in between.
6421 if (($c != 160)
6422 AND (($c == 173)
6423 OR preg_match($this->re_spaces, TCPDF_FONTS::unichr($c, $this->isunicode))
6424 OR (($c == 45)
6425 AND ($i < ($nb - 1))
6427 AND @preg_match('/[\p{L}]/'.$this->re_space['m'], TCPDF_FONTS::unichr($chars[($i + 1)], $this->isunicode))
6428 )
6429 )
6430 ) {
6431 // update last blank space position
6432 $prevsep = $sep;
6433 $sep = $i;
6434 // check if is a SHY
6435 if (($c == 173) OR ($c == 45)) {
6436 $prevshy = $shy;
6437 $shy = true;
6438 if ($pc == 45) {
6439 $tmp_shy_replacement_width = 0;
6440 $tmp_shy_replacement_char = '';
6441 } else {
6442 $tmp_shy_replacement_width = $shy_replacement_width;
6443 $tmp_shy_replacement_char = $shy_replacement_char;
6444 }
6445 } else {
6446 $shy = false;
6447 }
6448 }
6449 // update string length
6451 // with bidirectional algorithm some chars may be changed affecting the line length
6452 // *** very slow ***
6453 $l = $this->GetArrStringWidth(TCPDF_FONTS::utf8Bidi(array_slice($chars, $j, ($i - $j)), '', $this->tmprtl, $this->isunicode, $this->CurrentFont));
6454 } else {
6456 }
6459 $sep = $prevsep;
6460 $shy = $prevshy;
6461 }
6462 // we have reached the end of column
6463 if ($sep == -1) {
6464 // check if the line was already started
6465 if (($this->rtl AND ($this->x <= ($this->w - $this->rMargin - $this->cell_padding['R'] - $margin['R'] - $chrwidth)))
6466 OR ((!$this->rtl) AND ($this->x >= ($this->lMargin + $this->cell_padding['L'] + $margin['L'] + $chrwidth)))) {
6467 // print a void cell and go to next line
6469 $linebreak = true;
6470 if ($firstline) {
6472 }
6473 } else {
6474 // truncate the word because do not fit on column
6475 $tmpstr = TCPDF_FONTS::UniArrSubString($uchars, $j, $i);
6476 if ($firstline) {
6477 $startx = $this->x;
6478 $tmparr = array_slice($chars, $j, ($i - $j));
6479 if ($rtlmode) {
6480 $tmparr = TCPDF_FONTS::utf8Bidi($tmparr, $tmpstr, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6481 }
6482 $linew = $this->GetArrStringWidth($tmparr);
6483 unset($tmparr);
6484 if ($this->rtl) {
6485 $this->endlinex = $startx - $linew;
6486 } else {
6487 $this->endlinex = $startx + $linew;
6488 }
6489 $w = $linew;
6490 $tmpcellpadding = $this->cell_padding;
6491 if ($maxh == 0) {
6492 $this->SetCellPadding(0);
6493 }
6494 }
6496 $tmpstr = $this->stringRightTrim($tmpstr);
6497 }
6499 unset($tmpstr);
6500 if ($firstline) {
6501 $this->cell_padding = $tmpcellpadding;
6503 }
6504 $j = $i;
6505 --$i;
6506 }
6507 } else {
6508 // word wrapping
6509 if ($this->rtl AND (!$firstblock) AND ($sep < $i)) {
6510 $endspace = 1;
6511 } else {
6512 $endspace = 0;
6513 }
6514 // check the length of the next string
6515 $strrest = TCPDF_FONTS::UniArrSubString($uchars, ($sep + $endspace));
6516 $nextstr = TCPDF_STATIC::pregSplit('/'.$this->re_space['p'].'/', $this->re_space['m'], $this->stringTrim($strrest));
6518 // truncate the word because do not fit on a full page width
6519 $tmpstr = TCPDF_FONTS::UniArrSubString($uchars, $j, $i);
6520 if ($firstline) {
6521 $startx = $this->x;
6522 $tmparr = array_slice($chars, $j, ($i - $j));
6523 if ($rtlmode) {
6524 $tmparr = TCPDF_FONTS::utf8Bidi($tmparr, $tmpstr, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6525 }
6526 $linew = $this->GetArrStringWidth($tmparr);
6527 unset($tmparr);
6528 if ($this->rtl) {
6529 $this->endlinex = ($startx - $linew);
6530 } else {
6531 $this->endlinex = ($startx + $linew);
6532 }
6533 $w = $linew;
6534 $tmpcellpadding = $this->cell_padding;
6535 if ($maxh == 0) {
6536 $this->SetCellPadding(0);
6537 }
6538 }
6540 $tmpstr = $this->stringRightTrim($tmpstr);
6541 }
6543 unset($tmpstr);
6544 if ($firstline) {
6545 $this->cell_padding = $tmpcellpadding;
6547 }
6548 $j = $i;
6549 --$i;
6550 } else {
6551 // word wrapping
6552 if ($shy) {
6553 // add hypen (minus symbol) at the end of the line
6554 $shy_width = $tmp_shy_replacement_width;
6555 if ($this->rtl) {
6556 $shy_char_left = $tmp_shy_replacement_char;
6557 $shy_char_right = '';
6558 } else {
6559 $shy_char_left = '';
6560 $shy_char_right = $tmp_shy_replacement_char;
6561 }
6562 } else {
6563 $shy_width = 0;
6564 $shy_char_left = '';
6565 $shy_char_right = '';
6566 }
6567 $tmpstr = TCPDF_FONTS::UniArrSubString($uchars, $j, ($sep + $endspace));
6568 if ($firstline) {
6569 $startx = $this->x;
6570 $tmparr = array_slice($chars, $j, (($sep + $endspace) - $j));
6571 if ($rtlmode) {
6572 $tmparr = TCPDF_FONTS::utf8Bidi($tmparr, $tmpstr, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6573 }
6574 $linew = $this->GetArrStringWidth($tmparr);
6575 unset($tmparr);
6576 if ($this->rtl) {
6577 $this->endlinex = $startx - $linew - $shy_width;
6578 } else {
6579 $this->endlinex = $startx + $linew + $shy_width;
6580 }
6581 $w = $linew;
6582 $tmpcellpadding = $this->cell_padding;
6583 if ($maxh == 0) {
6584 $this->SetCellPadding(0);
6585 }
6586 }
6587 // print the line
6589 $tmpstr = $this->stringRightTrim($tmpstr);
6590 }
6591 $this->Cell($w, $h, $shy_char_left.$tmpstr.$shy_char_right, 0, 1, $align, $fill, $link, $stretch);
6592 unset($tmpstr);
6593 if ($firstline) {
6594 if ($chars[$sep] == 45) {
6595 $endspace += 1;
6596 }
6597 // return the remaining text
6598 $this->cell_padding = $tmpcellpadding;
6600 }
6601 $i = $sep;
6602 $sep = -1;
6603 $shy = false;
6604 $j = ($i + 1);
6605 }
6606 }
6607 // account for margin changes
6609 $this->AcceptPageBreak();
6610 if ($this->rtl) {
6611 $this->x -= $margin['R'];
6612 } else {
6613 $this->x += $margin['L'];
6614 }
6615 $this->lMargin += $margin['L'];
6616 $this->rMargin += $margin['R'];
6617 }
6620 if ($linebreak) {
6621 $linebreak = false;
6622 } else {
6623 ++$nl;
6624 $l = 0;
6625 }
6626 }
6627 }
6628 // save last character
6629 $pc = $c;
6630 ++$i;
6631 } // end while i < nb
6632 // print last substring (if any)
6634 switch ($align) {
6635 case 'J':
6636 case 'C': {
6638 break;
6639 }
6640 case 'L': {
6641 if ($this->rtl) {
6643 } else {
6645 }
6646 break;
6647 }
6648 case 'R': {
6649 if ($this->rtl) {
6651 } else {
6653 }
6654 break;
6655 }
6656 default: {
6658 break;
6659 }
6660 }
6661 $tmpstr = TCPDF_FONTS::UniArrSubString($uchars, $j, $nb);
6662 if ($firstline) {
6663 $startx = $this->x;
6664 $tmparr = array_slice($chars, $j, ($nb - $j));
6665 if ($rtlmode) {
6666 $tmparr = TCPDF_FONTS::utf8Bidi($tmparr, $tmpstr, $this->tmprtl, $this->isunicode, $this->CurrentFont);
6667 }
6668 $linew = $this->GetArrStringWidth($tmparr);
6669 unset($tmparr);
6670 if ($this->rtl) {
6671 $this->endlinex = $startx - $linew;
6672 } else {
6673 $this->endlinex = $startx + $linew;
6674 }
6675 $w = $linew;
6676 $tmpcellpadding = $this->cell_padding;
6677 if ($maxh == 0) {
6678 $this->SetCellPadding(0);
6679 }
6680 }
6682 $tmpstr = $this->stringRightTrim($tmpstr);
6683 }
6685 unset($tmpstr);
6686 if ($firstline) {
6687 $this->cell_padding = $tmpcellpadding;
6689 }
6690 ++$nl;
6691 }
6692 if ($firstline) {
6693 return '';
6694 }
6695 return $nl;
6696 }
static $uni_RE_PATTERN_ARABIC
Pattern to test Arabic strings using regular expressions.
Definition: tcpdf_font_data.php:114
static $uni_RE_PATTERN_RTL
Pattern to test RTL (Righ-To-Left) strings using regular expressions.
Definition: tcpdf_font_data.php:96
static pregSplit($pattern, $modifiers, $subject, $limit=NULL, $flags=NULL)
Split string by a regular expression.
Definition: tcpdf_static.php:1823
getRemainingWidth()
Returns the remaining width between the current position and margins.
Definition: tcpdf.php:6703
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(), getCellHeight(), GetCharWidth(), getRemainingWidth(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), TCPDF_STATIC\pregSplit(), SetCellPadding(), stringRightTrim(), stringTrim(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\unichr(), TCPDF_FONTS\UTF8ArrayToUniArray(), TCPDF_FONTS\utf8Bidi(), and TCPDF_FONTS\UTF8StringToArray().
Referenced by addHtmlLink(), MC_TCPDF\ChapterBody(), MultiCell(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ write1DBarcode()
| TCPDF::write1DBarcode | ( | $code, | |
| $type, | |||
$x = '', |
|||
$y = '', |
|||
$w = '', |
|||
$h = '', |
|||
$xres = '', |
|||
$style = '', |
|||
$align = '' |
|||
| ) |
Print a Linear Barcode.
- Parameters
-
$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: - boolean $style['border'] if true prints a border
- int $style['padding'] padding to leave around the barcode in user units (set to 'auto' for automatic padding)
- int $style['hpadding'] horizontal padding in user units (set to 'auto' for automatic padding)
- int $style['vpadding'] vertical padding in user units (set to 'auto' for automatic padding)
- array $style['fgcolor'] color array for bars and text
- mixed $style['bgcolor'] color array for background (set to false for transparent)
- boolean $style['text'] if true prints text below the barcode
- string $style['label'] override default label
- string $style['font'] font name for text
- int $style['fontsize'] font size for text
- int $style['stretchtext']: 0 = disabled; 1 = horizontal scaling only if necessary; 2 = forced horizontal scaling; 3 = character spacing only if necessary; 4 = forced character spacing.
- string $style['position'] horizontal position of the containing barcode cell on the page: L = left margin; C = center; R = right margin.
- string $style['align'] horizontal position of the barcode on the containing rectangle: L = left; C = center; R = right.
- string $style['stretch'] if true stretch the barcode to best fit the available width, otherwise uses $xres resolution for a single bar.
- string $style['fitwidth'] if true reduce the width to fit the barcode width + padding. When this option is enabled the 'stretch' option is automatically disabled.
- string $style['cellfitalign'] this option works only when 'fitwidth' is true and 'position' is unset or empty. Set the horizontal position of the containing barcode cell inside the specified rectangle: L = left; C = center; R = right.
$align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
- Since
- 3.1.000 (2008-06-09)
Definition at line 15197 of file tcpdf.php.
15197 {
15199 return;
15200 }
15201 require_once(dirname(__FILE__).'/tcpdf_barcodes_1d.php');
15202 // save current graphic settings
15203 $gvars = $this->getGraphicVars();
15204 // create new barcode object
15206 $arrcode = $barcodeobj->getBarcodeArray();
15207 if (($arrcode === false) OR empty($arrcode) OR ($arrcode['maxw'] <= 0)) {
15209 }
15210 if ($arrcode['maxh'] <= 0) {
15211 $arrcode['maxh'] = 1;
15212 }
15213 // set default values
15217 // keep this for backward compatibility
15220 }
15224 } else {
15226 }
15227 }
15229 // disable stretch
15231 }
15235 } else {
15237 }
15238 }
15241 }
15244 }
15247 }
15248 $fontsize = 0;
15251 }
15255 }
15257 }
15260 }
15263 }
15266 }
15267 // check page for no-write regions and adapt page margins if necessary
15270 if ($this->rtl) {
15272 } else {
15274 }
15275 }
15276 // padding
15278 $padding = 0;
15281 } else {
15283 }
15284 // horizontal padding
15286 $hpadding = $padding;
15289 } else {
15291 }
15292 // vertical padding
15294 $vpadding = $padding;
15296 $vpadding = ($hpadding / 2);
15297 } else {
15299 }
15300 // calculate xres (single bar width)
15303 $xres = $max_xres;
15304 } else {
15307 }
15308 if ($xres > $max_xres) {
15309 // correct xres to fit on $w
15310 $xres = $max_xres;
15311 }
15314 $hpadding = 10 * $xres;
15316 $vpadding = ($hpadding / 2);
15317 }
15318 }
15319 }
15321 $wold = $w;
15325 case 'L': {
15326 if ($this->rtl) {
15328 }
15329 break;
15330 }
15331 case 'R': {
15332 if (!$this->rtl) {
15334 }
15335 break;
15336 }
15337 case 'C': {
15338 if ($this->rtl) {
15340 } else {
15342 }
15343 break;
15344 }
15345 default : {
15346 break;
15347 }
15348 }
15349 }
15350 }
15351 $text_height = $this->getCellHeight($fontsize / $this->k);
15352 // height
15354 // set default height
15356 }
15357 $barh = $h - $text_height - (2 * $vpadding);
15358 if ($barh <=0) {
15359 // try to reduce font or padding to fit barcode on available height
15362 $text_height = $this->getCellHeight($fontsize / $this->k);
15364 }
15365 if ($vpadding > 0) {
15366 $vpadding = (($h - $text_height) / 4);
15367 }
15368 $barh = $h - $text_height - (2 * $vpadding);
15369 }
15370 // fit the barcode on available space
15372 // set alignment
15374 // set alignment
15375 if ($this->rtl) {
15377 $xpos = $this->lMargin;
15379 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15381 $xpos = $this->w - $this->rMargin - $w;
15382 } else {
15384 }
15385 $this->img_rb_x = $xpos;
15386 } else {
15388 $xpos = $this->lMargin;
15390 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15392 $xpos = $this->w - $this->rMargin - $w;
15393 } else {
15394 $xpos = $x;
15395 }
15396 $this->img_rb_x = $xpos + $w;
15397 }
15398 $xpos_rect = $xpos;
15401 }
15403 case 'L': {
15404 $xpos = $xpos_rect + $hpadding;
15405 break;
15406 }
15407 case 'R': {
15409 break;
15410 }
15411 case 'C':
15412 default : {
15414 break;
15415 }
15416 }
15417 $xpos_text = $xpos;
15418 // barcode is always printed in LTR direction
15419 $tempRTL = $this->rtl;
15420 $this->rtl = false;
15421 // print background color
15426 }
15427 // set foreground color
15430 // print bars
15432 $bw = ($v['w'] * $xres);
15433 if ($v['t']) {
15434 // draw a vertical bar
15436 $this->Rect($xpos, $ypos, $bw, ($v['h'] * $barh / $arrcode['maxh']), 'F', array(), $style['fgcolor']);
15437 }
15438 $xpos += $bw;
15439 }
15440 // print text
15444 } else {
15445 $label = $code;
15446 }
15447 $txtwidth = ($arrcode['maxw'] * $xres);
15450 }
15451 // print text
15452 $this->x = $xpos_text;
15453 $this->y = $y + $vpadding + $barh;
15454 $cellpadding = $this->cell_padding;
15455 $this->SetCellPadding(0);
15456 $this->Cell($txtwidth, '', $label, 0, 0, 'C', false, '', $style['stretchtext'], false, 'T', 'T');
15457 $this->cell_padding = $cellpadding;
15458 }
15459 // restore original direction
15460 $this->rtl = $tempRTL;
15461 // restore previous settings
15462 $this->setGraphicVars($gvars);
15463 // set pointer to align the next text/objects
15464 switch($align) {
15465 case 'T':{
15466 $this->y = $y;
15467 $this->x = $this->img_rb_x;
15468 break;
15469 }
15470 case 'M':{
15472 $this->x = $this->img_rb_x;
15473 break;
15474 }
15475 case 'B':{
15476 $this->y = $this->img_rb_y;
15477 $this->x = $this->img_rb_x;
15478 break;
15479 }
15480 case 'N':{
15481 $this->SetY($this->img_rb_y);
15482 break;
15483 }
15484 default:{
15485 break;
15486 }
15487 }
15488 $this->endlinex = $this->img_rb_x;
15489 }
PHP class to creates array representations for common 1D barcodes to be used with TCPDF (http://www....
Definition: tcpdf_barcodes_1d.php:50
References $barcodeobj, $cell_padding, $code, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $rtl, $style, $w, $x, $y, Cell(), checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getCellHeight(), 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:
◆ write2DBarcode()
| TCPDF::write2DBarcode | ( | $code, | |
| $type, | |||
$x = '', |
|||
$y = '', |
|||
$w = '', |
|||
$h = '', |
|||
$style = '', |
|||
$align = '', |
|||
$distort = false |
|||
| ) |
Print 2D Barcode.
- Parameters
-
$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: - boolean $style['border'] if true prints a border around the barcode
- int $style['padding'] padding to leave around the barcode in barcode units (set to 'auto' for automatic padding)
- int $style['hpadding'] horizontal padding in barcode units (set to 'auto' for automatic padding)
- int $style['vpadding'] vertical padding in barcode units (set to 'auto' for automatic padding)
- int $style['module_width'] width of a single module in points
- int $style['module_height'] height of a single module in points
- array $style['fgcolor'] color array for bars and text
- mixed $style['bgcolor'] color array for background or false for transparent
- string $style['position'] barcode position on the page: L = left margin; C = center; R = right margin; S = stretch
- $style['module_width'] width of a single module in points
- $style['module_height'] height of a single module in points
$align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be: - T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
$distort (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio
- Since
- 4.5.037 (2009-04-07)
Definition at line 15516 of file tcpdf.php.
15516 {
15518 return;
15519 }
15520 require_once(dirname(__FILE__).'/tcpdf_barcodes_2d.php');
15521 // save current graphic settings
15522 $gvars = $this->getGraphicVars();
15523 // create new barcode object
15525 $arrcode = $barcodeobj->getBarcodeArray();
15526 if (($arrcode === false) OR empty($arrcode) OR !isset($arrcode['num_rows']) OR ($arrcode['num_rows'] == 0) OR !isset($arrcode['num_cols']) OR ($arrcode['num_cols'] == 0)) {
15528 }
15529 // set default values
15532 }
15535 }
15538 }
15541 }
15542 // padding
15547 }
15552 }
15557 }
15560 // cell (module) dimension
15563 }
15566 }
15569 }
15572 }
15573 // check page for no-write regions and adapt page margins if necessary
15575 // number of barcode columns and rows
15576 $rows = $arrcode['num_rows'];
15577 $cols = $arrcode['num_cols'];
15578 if (($rows <= 0) || ($cols <= 0)){
15580 }
15581 // module width and height
15584 if (($mw <= 0) OR ($mh <= 0)) {
15586 }
15587 // get max dimensions
15588 if ($this->rtl) {
15590 } else {
15591 $maxw = $this->w - $this->rMargin - $x;
15592 }
15593 $maxh = ($this->h - $this->tMargin - $this->bMargin);
15594 $ratioHW = ((($rows * $mh) + $hpad) / (($cols * $mw) + $vpad));
15595 $ratioWH = ((($cols * $mw) + $vpad) / (($rows * $mh) + $hpad));
15596 if (!$distort) {
15597 if (($maxw * $ratioHW) > $maxh) {
15598 $maxw = $maxh * $ratioWH;
15599 }
15600 if (($maxh * $ratioWH) > $maxw) {
15601 $maxh = $maxw * $ratioHW;
15602 }
15603 }
15604 // set maximum dimensions
15606 $w = $maxw;
15607 }
15609 $h = $maxh;
15610 }
15611 // set dimensions
15613 $w = ($cols + $hpad) * ($mw / $this->k);
15614 $h = ($rows + $vpad) * ($mh / $this->k);
15619 }
15620 // barcode size (excluding padding)
15621 $bw = ($w * $cols) / ($cols + $hpad);
15622 $bh = ($h * $rows) / ($rows + $vpad);
15623 // dimension of single barcode cell unit
15624 $cw = $bw / $cols;
15625 $ch = $bh / $rows;
15626 if (!$distort) {
15627 if (($cw / $ch) > ($mw / $mh)) {
15628 // correct horizontal distortion
15629 $cw = $ch * $mw / $mh;
15630 $bw = $cw * $cols;
15632 } else {
15633 // correct vertical distortion
15634 $ch = $cw * $mh / $mw;
15635 $bh = $ch * $rows;
15637 }
15638 }
15639 // fit the barcode on available space
15641 // set alignment
15643 // set alignment
15644 if ($this->rtl) {
15646 $xpos = $this->lMargin;
15648 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15650 $xpos = $this->w - $this->rMargin - $w;
15651 } else {
15653 }
15654 $this->img_rb_x = $xpos;
15655 } else {
15657 $xpos = $this->lMargin;
15659 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15661 $xpos = $this->w - $this->rMargin - $w;
15662 } else {
15663 $xpos = $x;
15664 }
15665 $this->img_rb_x = $xpos + $w;
15666 }
15669 // barcode is always printed in LTR direction
15670 $tempRTL = $this->rtl;
15671 $this->rtl = false;
15672 // print background color
15677 }
15678 // set foreground color
15680 // print barcode cells
15681 // for each row
15683 $xr = $xstart;
15684 // for each column
15685 for ($c = 0; $c < $cols; ++$c) {
15687 // draw a single barcode cell
15689 }
15690 $xr += $cw;
15691 }
15692 $ystart += $ch;
15693 }
15694 // restore original direction
15695 $this->rtl = $tempRTL;
15696 // restore previous settings
15697 $this->setGraphicVars($gvars);
15698 // set pointer to align the next text/objects
15699 switch($align) {
15700 case 'T':{
15701 $this->y = $y;
15702 $this->x = $this->img_rb_x;
15703 break;
15704 }
15705 case 'M':{
15707 $this->x = $this->img_rb_x;
15708 break;
15709 }
15710 case 'B':{
15711 $this->y = $this->img_rb_y;
15712 $this->x = $this->img_rb_x;
15713 break;
15714 }
15715 case 'N':{
15716 $this->SetY($this->img_rb_y);
15717 break;
15718 }
15719 default:{
15720 break;
15721 }
15722 }
15723 $this->endlinex = $this->img_rb_x;
15724 }
PHP class to creates array representations for 2D barcodes to be used with TCPDF (http://www....
Definition: tcpdf_barcodes_2d.php:50
References $barcodeobj, $bMargin, $code, $h, $img_rb_x, $img_rb_y, $lMargin, $r, $rtl, $style, $w, $x, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getGraphicVars(), Rect(), SetDrawColorArray(), setGraphicVars(), and SetY().
Here is the call graph for this function:
◆ writeHTML()
| 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.
- Parameters
-
$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: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
Definition at line 17120 of file tcpdf.php.
17120 {
17121 $gvars = $this->getGraphicVars();
17122 // store current values
17123 $prev_cell_margin = $this->cell_margin;
17124 $prev_cell_padding = $this->cell_padding;
17125 $prevPage = $this->page;
17126 $prevlMargin = $this->lMargin;
17127 $prevrMargin = $this->rMargin;
17128 $curfontname = $this->FontFamily;
17129 $curfontstyle = $this->FontStyle;
17130 $curfontsize = $this->FontSizePt;
17131 $curfontascent = $this->getFontAscent($curfontname, $curfontstyle, $curfontsize);
17132 $curfontdescent = $this->getFontDescent($curfontname, $curfontstyle, $curfontsize);
17133 $curfontstretcing = $this->font_stretching;
17134 $curfonttracking = $this->font_spacing;
17135 $this->newline = true;
17137 $startlinepage = $this->page;
17138 $minstartliney = $this->y;
17139 $maxbottomliney = 0;
17140 $startlinex = $this->x;
17141 $startliney = $this->y;
17142 $yshift = 0;
17143 $loop = 0;
17144 $curpos = 0;
17145 $this_method_vars = array();
17146 $undo = false;
17147 $fontaligned = false;
17148 $reverse_dir = false; // true when the text direction is reversed
17149 $this->premode = false;
17150 if ($this->inxobj) {
17151 // we are inside an XObject template
17152 $pask = count($this->xobjects[$this->xobjid]['annotations']);
17153 } elseif (isset($this->PageAnnots[$this->page])) {
17154 $pask = count($this->PageAnnots[$this->page]);
17155 } else {
17156 $pask = 0;
17157 }
17158 if ($this->inxobj) {
17159 // we are inside an XObject template
17160 $startlinepos = strlen($this->xobjects[$this->xobjid]['outdata']);
17161 } elseif (!$this->InFooter) {
17162 if (isset($this->footerlen[$this->page])) {
17164 } else {
17166 }
17167 $startlinepos = $this->footerpos[$this->page];
17168 } else {
17169 // we are inside the footer
17170 $startlinepos = $this->pagelen[$this->page];
17171 }
17172 $lalign = $align;
17173 $plalign = $align;
17174 if ($this->rtl) {
17176 } else {
17178 }
17180 if ($cell) {
17181 if ($this->rtl) {
17182 $this->x -= $this->cell_padding['R'];
17183 $this->lMargin += $this->cell_padding['R'];
17184 } else {
17185 $this->x += $this->cell_padding['L'];
17186 $this->rMargin += $this->cell_padding['L'];
17187 }
17188 }
17189 if ($this->customlistindent >= 0) {
17190 $this->listindent = $this->customlistindent;
17191 } else {
17193 }
17194 $this->listindentlevel = 0;
17195 // save previous states
17196 $prev_cell_height_ratio = $this->cell_height_ratio;
17197 $prev_listnum = $this->listnum;
17198 $prev_listordered = $this->listordered;
17199 $prev_listcount = $this->listcount;
17200 $prev_lispacer = $this->lispacer;
17201 $this->listnum = 0;
17202 $this->listordered = array();
17203 $this->listcount = array();
17204 $this->lispacer = '';
17206 // reset row height
17207 $this->resetLastH();
17208 }
17210 $maxel = count($dom);
17211 $key = 0;
17212 while ($key < $maxel) {
17213 if ($dom[$key]['tag'] AND $dom[$key]['opening'] AND $dom[$key]['hide']) {
17214 // store the node key
17215 $hidden_node_key = $key;
17216 if ($dom[$key]['self']) {
17217 // skip just this self-closing tag
17218 ++$key;
17219 } else {
17220 // skip this and all children tags
17221 while (($key < $maxel) AND (!$dom[$key]['tag'] OR $dom[$key]['opening'] OR ($dom[$key]['parent'] != $hidden_node_key))) {
17222 // skip hidden objects
17223 ++$key;
17224 }
17225 ++$key;
17226 }
17227 }
17228 if ($dom[$key]['tag'] AND isset($dom[$key]['attribute']['pagebreak'])) {
17229 // check for pagebreak
17230 if (($dom[$key]['attribute']['pagebreak'] == 'true') OR ($dom[$key]['attribute']['pagebreak'] == 'left') OR ($dom[$key]['attribute']['pagebreak'] == 'right')) {
17231 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17232 $this->checkPageBreak($this->PageBreakTrigger + 1);
17233 $this->htmlvspace = ($this->PageBreakTrigger + 1);
17234 }
17235 if ((($dom[$key]['attribute']['pagebreak'] == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
17236 OR (($dom[$key]['attribute']['pagebreak'] == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
17237 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17238 $this->checkPageBreak($this->PageBreakTrigger + 1);
17239 $this->htmlvspace = ($this->PageBreakTrigger + 1);
17240 }
17241 }
17242 if ($dom[$key]['tag'] AND $dom[$key]['opening'] AND isset($dom[$key]['attribute']['nobr']) AND ($dom[$key]['attribute']['nobr'] == 'true')) {
17243 if (isset($dom[($dom[$key]['parent'])]['attribute']['nobr']) AND ($dom[($dom[$key]['parent'])]['attribute']['nobr'] == 'true')) {
17244 $dom[$key]['attribute']['nobr'] = false;
17245 } else {
17246 // store current object
17247 $this->startTransaction();
17248 // save this method vars
17250 $this_method_vars['ln'] = $ln;
17251 $this_method_vars['fill'] = $fill;
17252 $this_method_vars['reseth'] = $reseth;
17253 $this_method_vars['cell'] = $cell;
17254 $this_method_vars['align'] = $align;
17255 $this_method_vars['gvars'] = $gvars;
17256 $this_method_vars['prevPage'] = $prevPage;
17257 $this_method_vars['prev_cell_margin'] = $prev_cell_margin;
17258 $this_method_vars['prev_cell_padding'] = $prev_cell_padding;
17259 $this_method_vars['prevlMargin'] = $prevlMargin;
17260 $this_method_vars['prevrMargin'] = $prevrMargin;
17261 $this_method_vars['curfontname'] = $curfontname;
17262 $this_method_vars['curfontstyle'] = $curfontstyle;
17263 $this_method_vars['curfontsize'] = $curfontsize;
17264 $this_method_vars['curfontascent'] = $curfontascent;
17265 $this_method_vars['curfontdescent'] = $curfontdescent;
17266 $this_method_vars['curfontstretcing'] = $curfontstretcing;
17267 $this_method_vars['curfonttracking'] = $curfonttracking;
17268 $this_method_vars['minstartliney'] = $minstartliney;
17269 $this_method_vars['maxbottomliney'] = $maxbottomliney;
17270 $this_method_vars['yshift'] = $yshift;
17271 $this_method_vars['startlinepage'] = $startlinepage;
17272 $this_method_vars['startlinepos'] = $startlinepos;
17273 $this_method_vars['startlinex'] = $startlinex;
17274 $this_method_vars['startliney'] = $startliney;
17276 $this_method_vars['loop'] = $loop;
17277 $this_method_vars['curpos'] = $curpos;
17278 $this_method_vars['pask'] = $pask;
17279 $this_method_vars['lalign'] = $lalign;
17280 $this_method_vars['plalign'] = $plalign;
17282 $this_method_vars['prev_cell_height_ratio'] = $prev_cell_height_ratio;
17283 $this_method_vars['prev_listnum'] = $prev_listnum;
17284 $this_method_vars['prev_listordered'] = $prev_listordered;
17285 $this_method_vars['prev_listcount'] = $prev_listcount;
17286 $this_method_vars['prev_lispacer'] = $prev_lispacer;
17287 $this_method_vars['fontaligned'] = $fontaligned;
17288 $this_method_vars['key'] = $key;
17289 $this_method_vars['dom'] = $dom;
17290 }
17291 }
17292 // print THEAD block
17293 if (($dom[$key]['value'] == 'tr') AND isset($dom[$key]['thead']) AND $dom[$key]['thead']) {
17294 if (isset($dom[$key]['parent']) AND isset($dom[$dom[$key]['parent']]['thead']) AND !TCPDF_STATIC::empty_string($dom[$dom[$key]['parent']]['thead'])) {
17295 $this->inthead = true;
17296 // print table header (thead)
17298 // check if we are on a new page or on a new column
17299 if (($this->y < $this->start_transaction_y) OR ($this->checkPageBreak($this->lasth, '', false))) {
17300 // we are on a new page or on a new column and the total object height is less than the available vertical space.
17301 // restore previous object
17303 // restore previous values
17304 foreach ($this_method_vars as $vkey => $vval) {
17305 $$vkey = $vval;
17306 }
17307 // disable table header
17308 $tmp_thead = $this->thead;
17309 $this->thead = '';
17310 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17311 $pre_y = $this->y;
17313 // fix for multicolumn mode
17314 $startliney = $this->y;
17315 }
17316 $this->start_transaction_page = $this->page;
17317 $this->start_transaction_y = $this->y;
17318 // restore table header
17319 $this->thead = $tmp_thead;
17320 // fix table border properties
17321 if (isset($dom[$dom[$key]['parent']]['attribute']['cellspacing'])) {
17322 $tmp_cellspacing = $this->getHTMLUnitToUnits($dom[$dom[$key]['parent']]['attribute']['cellspacing'], 1, 'px');
17323 } elseif (isset($dom[$dom[$key]['parent']]['border-spacing'])) {
17324 $tmp_cellspacing = $dom[$dom[$key]['parent']]['border-spacing']['V'];
17325 } else {
17326 $tmp_cellspacing = 0;
17327 }
17330 $dom[$dom[$key]['parent']]['borderposition']['y'] = $this->y + $tmp_cellspacing;
17331 $xoffset = ($this->x - $dom[$dom[$key]['parent']]['borderposition']['x']);
17332 $dom[$dom[$key]['parent']]['borderposition']['x'] += $xoffset;
17333 $dom[$dom[$key]['parent']]['borderposition']['xmax'] += $xoffset;
17334 // print table header (thead)
17336 }
17337 }
17338 // move $key index forward to skip THEAD block
17339 while ( ($key < $maxel) AND (!(
17340 ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'tr') AND (!isset($dom[$key]['thead']) OR !$dom[$key]['thead']))
17341 OR ($dom[$key]['tag'] AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == 'table'))) )) {
17342 ++$key;
17343 }
17344 }
17345 if ($dom[$key]['tag'] OR ($key == 0)) {
17346 if ((($dom[$key]['value'] == 'table') OR ($dom[$key]['value'] == 'tr')) AND (isset($dom[$key]['align']))) {
17348 }
17349 // vertically align image in line
17350 if ((!$this->newline) AND ($dom[$key]['value'] == 'img') AND (isset($dom[$key]['height'])) AND ($dom[$key]['height'] > 0)) {
17351 // get image height
17352 $imgh = $this->getHTMLUnitToUnits($dom[$key]['height'], ($dom[$key]['fontsize'] / $this->k), 'px');
17353 $autolinebreak = false;
17354 if (!empty($dom[$key]['width'])) {
17355 $imgw = $this->getHTMLUnitToUnits($dom[$key]['width'], ($dom[$key]['fontsize'] / $this->k), 'px', false);
17356 if (($imgw <= ($this->w - $this->lMargin - $this->rMargin - $this->cell_padding['L'] - $this->cell_padding['R']))
17357 AND ((($this->rtl) AND (($this->x - $imgw) < ($this->lMargin + $this->cell_padding['L'])))
17358 OR ((!$this->rtl) AND (($this->x + $imgw) > ($this->w - $this->rMargin - $this->cell_padding['R']))))) {
17359 // add automatic line break
17360 $autolinebreak = true;
17362 if ((!$dom[($key-1)]['tag']) AND ($dom[($key-1)]['value'] == ' ')) {
17363 // go back to evaluate this line break
17364 --$key;
17365 }
17366 }
17367 }
17368 if (!$autolinebreak) {
17370 $pre_y = $this->y;
17371 // check for page break
17373 // fix for multicolumn mode
17374 $startliney = $this->y;
17375 }
17376 }
17377 if ($this->page > $startlinepage) {
17378 // fix line splitted over two pages
17379 if (isset($this->footerlen[$startlinepage])) {
17380 $curpos = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17381 }
17382 // line to be moved one page forward
17383 $pagebuff = $this->getPageBuffer($startlinepage);
17384 $linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
17385 $tstart = substr($pagebuff, 0, $startlinepos);
17386 $tend = substr($this->getPageBuffer($startlinepage), $curpos);
17387 // remove line from previous page
17389 $pagebuff = $this->getPageBuffer($this->page);
17390 $tstart = substr($pagebuff, 0, $this->cntmrk[$this->page]);
17391 $tend = substr($pagebuff, $this->cntmrk[$this->page]);
17392 // add line start to current page
17393 $yshift = ($minstartliney - $this->y);
17394 if ($fontaligned) {
17395 $yshift += ($curfontsize / $this->k);
17396 }
17399 // shift the annotations and links
17400 if (isset($this->PageAnnots[$this->page])) {
17401 $next_pask = count($this->PageAnnots[$this->page]);
17402 } else {
17403 $next_pask = 0;
17404 }
17405 if (isset($this->PageAnnots[$startlinepage])) {
17406 foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
17407 if ($pak >= $pask) {
17408 $this->PageAnnots[$this->page][] = $pac;
17409 unset($this->PageAnnots[$startlinepage][$pak]);
17410 $npak = count($this->PageAnnots[$this->page]) - 1;
17412 }
17413 }
17414 }
17415 $pask = $next_pask;
17416 $startlinepos = $this->cntmrk[$this->page];
17417 $startlinepage = $this->page;
17418 $startliney = $this->y;
17419 $this->newline = false;
17420 }
17421 $this->y += ($this->getCellHeight($curfontsize / $this->k) - ($curfontdescent * $this->cell_height_ratio) - $imgh);
17422 $minstartliney = min($this->y, $minstartliney);
17423 $maxbottomliney = ($startliney + $this->getCellHeight($curfontsize / $this->k));
17424 }
17425 } elseif (isset($dom[$key]['fontname']) OR isset($dom[$key]['fontstyle']) OR isset($dom[$key]['fontsize']) OR isset($dom[$key]['line-height'])) {
17426 // account for different font size
17427 $pfontname = $curfontname;
17428 $pfontstyle = $curfontstyle;
17429 $pfontsize = $curfontsize;
17430 $fontname = (isset($dom[$key]['fontname']) ? $dom[$key]['fontname'] : $curfontname);
17431 $fontstyle = (isset($dom[$key]['fontstyle']) ? $dom[$key]['fontstyle'] : $curfontstyle);
17432 $fontsize = (isset($dom[$key]['fontsize']) ? $dom[$key]['fontsize'] : $curfontsize);
17433 $fontascent = $this->getFontAscent($fontname, $fontstyle, $fontsize);
17434 $fontdescent = $this->getFontDescent($fontname, $fontstyle, $fontsize);
17435 if (($fontname != $curfontname) OR ($fontstyle != $curfontstyle) OR ($fontsize != $curfontsize)
17436 OR ($this->cell_height_ratio != $dom[$key]['line-height'])
17437 OR ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'li')) ) {
17438 if (($key < ($maxel - 1)) AND (
17439 ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'li'))
17440 OR ($this->cell_height_ratio != $dom[$key]['line-height'])
17441 OR (!$this->newline AND is_numeric($fontsize) AND is_numeric($curfontsize)
17442 AND ($fontsize >= 0) AND ($curfontsize >= 0)
17443 AND (($fontsize != $curfontsize) OR ($fontstyle != $curfontstyle) OR ($fontname != $curfontname)))
17444 )) {
17445 if ($this->page > $startlinepage) {
17446 // fix lines splitted over two pages
17447 if (isset($this->footerlen[$startlinepage])) {
17448 $curpos = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17449 }
17450 // line to be moved one page forward
17451 $pagebuff = $this->getPageBuffer($startlinepage);
17452 $linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
17453 $tstart = substr($pagebuff, 0, $startlinepos);
17454 $tend = substr($this->getPageBuffer($startlinepage), $curpos);
17455 // remove line start from previous page
17457 $pagebuff = $this->getPageBuffer($this->page);
17458 $tstart = substr($pagebuff, 0, $this->cntmrk[$this->page]);
17459 $tend = substr($pagebuff, $this->cntmrk[$this->page]);
17460 // add line start to current page
17461 $yshift = ($minstartliney - $this->y);
17464 // shift the annotations and links
17465 if (isset($this->PageAnnots[$this->page])) {
17466 $next_pask = count($this->PageAnnots[$this->page]);
17467 } else {
17468 $next_pask = 0;
17469 }
17470 if (isset($this->PageAnnots[$startlinepage])) {
17471 foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
17472 if ($pak >= $pask) {
17473 $this->PageAnnots[$this->page][] = $pac;
17474 unset($this->PageAnnots[$startlinepage][$pak]);
17475 $npak = count($this->PageAnnots[$this->page]) - 1;
17477 }
17478 }
17479 }
17480 $pask = $next_pask;
17481 $startlinepos = $this->cntmrk[$this->page];
17482 $startlinepage = $this->page;
17483 $startliney = $this->y;
17484 }
17485 if (!isset($dom[$key]['line-height'])) {
17487 }
17488 if (!$dom[$key]['block']) {
17489 if (!(isset($dom[($key + 1)]) AND $dom[($key + 1)]['tag'] AND (!$dom[($key + 1)]['opening']) AND ($dom[($key + 1)]['value'] != 'li') AND $dom[$key]['tag'] AND (!$dom[$key]['opening']))) {
17490 $this->y += (((($curfontsize * $this->cell_height_ratio) - ($fontsize * $dom[$key]['line-height'])) / $this->k) + $curfontascent - $fontascent - $curfontdescent + $fontdescent) / 2;
17491 }
17492 if (($dom[$key]['value'] != 'sup') AND ($dom[$key]['value'] != 'sub')) {
17493 $current_line_align_data = array($key, $minstartliney, $maxbottomliney);
17494 if (isset($line_align_data) AND (($line_align_data[0] == ($key - 1)) OR (($line_align_data[0] == ($key - 2)) AND (isset($dom[($key - 1)])) AND (preg_match('/^([\s]+)$/', $dom[($key - 1)]['value']) > 0)))) {
17495 $minstartliney = min($this->y, $line_align_data[1]);
17496 $maxbottomliney = max(($this->y + $this->getCellHeight($fontsize / $this->k)), $line_align_data[2]);
17497 } else {
17498 $minstartliney = min($this->y, $minstartliney);
17499 $maxbottomliney = max(($this->y + $this->getCellHeight($fontsize / $this->k)), $maxbottomliney);
17500 }
17501 $line_align_data = $current_line_align_data;
17502 }
17503 }
17504 $this->cell_height_ratio = $dom[$key]['line-height'];
17505 $fontaligned = true;
17506 }
17507 $this->SetFont($fontname, $fontstyle, $fontsize);
17508 // reset row height
17509 $this->resetLastH();
17510 $curfontname = $fontname;
17511 $curfontstyle = $fontstyle;
17512 $curfontsize = $fontsize;
17513 $curfontascent = $fontascent;
17514 $curfontdescent = $fontdescent;
17515 }
17516 }
17517 // set text rendering mode
17519 $textfill = isset($dom[$key]['fill']) ? $dom[$key]['fill'] : (($this->textrendermode % 2) == 0);
17520 $textclip = isset($dom[$key]['clip']) ? $dom[$key]['clip'] : ($this->textrendermode > 3);
17521 $this->setTextRenderingMode($textstroke, $textfill, $textclip);
17522 if (isset($dom[$key]['font-stretch']) AND ($dom[$key]['font-stretch'] !== false)) {
17524 }
17525 if (isset($dom[$key]['letter-spacing']) AND ($dom[$key]['letter-spacing'] !== false)) {
17527 }
17528 if (($plalign == 'J') AND $dom[$key]['block']) {
17529 $plalign = '';
17530 }
17531 // get current position on page buffer
17532 $curpos = $this->pagelen[$startlinepage];
17533 if (isset($dom[$key]['bgcolor']) AND ($dom[$key]['bgcolor'] !== false)) {
17535 $wfill = true;
17536 } else {
17537 $wfill = $fill | false;
17538 }
17539 if (isset($dom[$key]['fgcolor']) AND ($dom[$key]['fgcolor'] !== false)) {
17541 }
17542 if (isset($dom[$key]['strokecolor']) AND ($dom[$key]['strokecolor'] !== false)) {
17544 }
17545 if (isset($dom[$key]['align'])) {
17546 $lalign = $dom[$key]['align'];
17547 }
17549 $lalign = $align;
17550 }
17551 }
17552 // align lines
17553 if ($this->newline AND (strlen($dom[$key]['value']) > 0) AND ($dom[$key]['value'] != 'td') AND ($dom[$key]['value'] != 'th')) {
17555 $fontaligned = false;
17556 // we are at the beginning of a new line
17557 if (isset($startlinex)) {
17558 $yshift = ($minstartliney - $startliney);
17559 if (($yshift > 0) OR ($this->page > $startlinepage)) {
17560 $yshift = 0;
17561 }
17562 $t_x = 0;
17563 // the last line must be shifted to be aligned as requested
17564 $linew = abs($this->endlinex - $startlinex);
17565 if ($this->inxobj) {
17566 // we are inside an XObject template
17567 $pstart = substr($this->xobjects[$this->xobjid]['outdata'], 0, $startlinepos);
17568 if (isset($opentagpos)) {
17569 $midpos = $opentagpos;
17570 } else {
17571 $midpos = 0;
17572 }
17573 if ($midpos > 0) {
17574 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
17575 $pend = substr($this->xobjects[$this->xobjid]['outdata'], $midpos);
17576 } else {
17577 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos);
17578 $pend = '';
17579 }
17580 } else {
17581 $pstart = substr($this->getPageBuffer($startlinepage), 0, $startlinepos);
17582 if (isset($opentagpos) AND isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
17583 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17584 $midpos = min($opentagpos, $this->footerpos[$startlinepage]);
17585 } elseif (isset($opentagpos)) {
17586 $midpos = $opentagpos;
17587 } elseif (isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
17588 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17589 $midpos = $this->footerpos[$startlinepage];
17590 } else {
17591 $midpos = 0;
17592 }
17593 if ($midpos > 0) {
17594 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
17595 $pend = substr($this->getPageBuffer($startlinepage), $midpos);
17596 } else {
17597 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos);
17598 $pend = '';
17599 }
17600 }
17601 if ((isset($plalign) AND ((($plalign == 'C') OR ($plalign == 'J') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
17602 // calculate shifting amount
17603 $tw = $w;
17605 $tw += $this->cell_padding['R'];
17606 }
17607 if ($this->lMargin != $prevlMargin) {
17608 $tw += ($prevlMargin - $this->lMargin);
17609 }
17610 if ($this->rMargin != $prevrMargin) {
17611 $tw += ($prevrMargin - $this->rMargin);
17612 }
17613 $one_space_width = $this->GetStringWidth(chr(32));
17614 $no = 0; // number of spaces on a line contained on a single block
17616 // remove left space if exist
17618 if ($pos1 > 0) {
17619 $pos1 = intval($pos1);
17622 $spacelen = 2;
17623 } else {
17625 $spacelen = 1;
17626 }
17627 if ($pos1 == $pos2) {
17628 $pmid = substr($pmid, 0, ($pos1 + 2)).substr($pmid, ($pos1 + 2 + $spacelen));
17629 if (substr($pmid, $pos1, 4) == '[()]') {
17630 $linew -= $one_space_width;
17631 } elseif ($pos1 == strpos($pmid, '[(')) {
17632 $no = 1;
17633 }
17634 }
17635 }
17636 } else { // LTR
17637 // remove right space if exist
17639 if ($pos1 > 0) {
17640 $pos1 = intval($pos1);
17643 $spacelen = 2;
17644 } else {
17646 $spacelen = 1;
17647 }
17648 if ($pos1 == $pos2) {
17649 $pmid = substr($pmid, 0, ($pos1 - $spacelen)).substr($pmid, $pos1);
17650 $linew -= $one_space_width;
17651 }
17652 }
17653 }
17654 $mdiff = ($tw - $linew);
17655 if ($plalign == 'C') {
17656 if ($this->rtl) {
17657 $t_x = -($mdiff / 2);
17658 } else {
17659 $t_x = ($mdiff / 2);
17660 }
17661 } elseif ($plalign == 'R') {
17662 // right alignment on LTR document
17663 $t_x = $mdiff;
17664 } elseif ($plalign == 'L') {
17665 // left alignment on RTL document
17666 $t_x = -$mdiff;
17667 } elseif (($plalign == 'J') AND ($plalign == $lalign)) {
17668 // Justification
17670 // align text on the left
17671 $t_x = -$mdiff;
17672 }
17673 $ns = 0; // number of spaces
17674 $pmidtemp = $pmid;
17675 // escape special characters
17676 $pmidtemp = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmidtemp);
17677 $pmidtemp = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmidtemp);
17678 // search spaces
17679 if (preg_match_all('/\[\(([^\)]*)\)\]/x', $pmidtemp, $lnstring, PREG_PATTERN_ORDER)) {
17680 $spacestr = $this->getSpaceString();
17681 $maxkk = count($lnstring[1]) - 1;
17682 for ($kk=0; $kk <= $maxkk; ++$kk) {
17683 // restore special characters
17684 $lnstring[1][$kk] = str_replace('#!#OP#!#', '(', $lnstring[1][$kk]);
17685 $lnstring[1][$kk] = str_replace('#!#CP#!#', ')', $lnstring[1][$kk]);
17686 // store number of spaces on the strings
17687 $lnstring[2][$kk] = substr_count($lnstring[1][$kk], $spacestr);
17688 // count total spaces on line
17689 $ns += $lnstring[2][$kk];
17690 $lnstring[3][$kk] = $ns;
17691 }
17692 if ($ns == 0) {
17693 $ns = 1;
17694 }
17695 // calculate additional space to add to each existing space
17696 $spacewidth = ($mdiff / ($ns - $no)) * $this->k;
17697 if ($this->FontSize <= 0) {
17698 $this->FontSize = 1;
17699 }
17700 $spacewidthu = -1000 * ($mdiff + (($ns + $no) * $one_space_width)) / $ns / $this->FontSize;
17701 if ($this->font_spacing != 0) {
17702 // fixed spacing mode
17703 $osw = -1000 * $this->font_spacing / $this->FontSize;
17704 $spacewidthu += $osw;
17705 }
17706 $nsmax = $ns;
17707 $ns = 0;
17708 reset($lnstring);
17709 $offset = 0;
17710 $strcount = 0;
17711 $prev_epsposbeg = 0;
17712 $textpos = 0;
17714 $textpos = $this->wPt;
17715 }
17716 while (preg_match('/([0-9\.\+\-]*)[\s](Td|cm|m|l|c|re)[\s]/x', $pmid, $strpiece, PREG_OFFSET_CAPTURE, $offset) == 1) {
17717 // check if we are inside a string section '[( ... )]'
17718 $stroffset = strpos($pmid, '[(', $offset);
17719 if (($stroffset !== false) AND ($stroffset <= $strpiece[2][1])) {
17720 // set offset to the end of string section
17721 $offset = strpos($pmid, ')]', $stroffset);
17722 while (($offset !== false) AND ($pmid[($offset - 1)] == '\\')) {
17723 $offset = strpos($pmid, ')]', ($offset + 1));
17724 }
17725 if ($offset === false) {
17727 }
17728 continue;
17729 }
17731 $spacew = ($spacewidth * ($nsmax - $ns));
17732 } else {
17733 $spacew = ($spacewidth * $ns);
17734 }
17735 $offset = $strpiece[2][1] + strlen($strpiece[2][0]);
17736 $epsposend = strpos($pmid, $this->epsmarker.'Q', $offset);
17737 if ($epsposend !== null) {
17738 $epsposend += strlen($this->epsmarker.'Q');
17739 $epsposbeg = strpos($pmid, 'q'.$this->epsmarker, $offset);
17740 if ($epsposbeg === null) {
17741 $epsposbeg = strpos($pmid, 'q'.$this->epsmarker, ($prev_epsposbeg - 6));
17742 $prev_epsposbeg = $epsposbeg;
17743 }
17744 if (($epsposbeg > 0) AND ($epsposend > 0) AND ($offset > $epsposbeg) AND ($offset < $epsposend)) {
17745 // shift EPS images
17747 $pmid_b = substr($pmid, 0, $epsposbeg);
17748 $pmid_m = substr($pmid, $epsposbeg, ($epsposend - $epsposbeg));
17749 $pmid_e = substr($pmid, $epsposend);
17750 $pmid = $pmid_b."\nq\n".$trx."\n".$pmid_m."\nQ\n".$pmid_e;
17751 $offset = $epsposend;
17752 continue;
17753 }
17754 }
17755 $currentxpos = 0;
17756 // shift blocks of code
17757 switch ($strpiece[2][0]) {
17758 case 'Td':
17759 case 'cm':
17760 case 'm':
17761 case 'l': {
17762 // get current X position
17763 preg_match('/([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s]('.$strpiece[2][0].')([\s]*)/x', $pmid, $xmatches);
17764 if (!isset($xmatches[1])) {
17765 break;
17766 }
17767 $currentxpos = $xmatches[1];
17768 $textpos = $currentxpos;
17769 if (($strcount <= $maxkk) AND ($strpiece[2][0] == 'Td')) {
17770 $ns = $lnstring[3][$strcount];
17772 $spacew = ($spacewidth * ($nsmax - $ns));
17773 }
17774 ++$strcount;
17775 }
17776 // justify block
17777 if (preg_match('/([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s]('.$strpiece[2][0].')([\s]*)/x', $pmid, $pmatch) == 1) {
17778 $newpmid = sprintf('%F',(floatval($pmatch[1]) + $spacew)).' '.$pmatch[2].' x*#!#*x'.$pmatch[3].$pmatch[4];
17779 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17780 unset($pmatch, $newpmid);
17781 }
17782 break;
17783 }
17784 case 're': {
17785 // justify block
17787 $this->lispacer = '';
17788 continue;
17789 }
17790 preg_match('/([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s](re)([\s]*)/x', $pmid, $xmatches);
17791 if (!isset($xmatches[1])) {
17792 break;
17793 }
17794 $currentxpos = $xmatches[1];
17795 $x_diff = 0;
17796 $w_diff = 0;
17798 if ($currentxpos < $textpos) {
17799 $x_diff = ($spacewidth * ($nsmax - $lnstring[3][$strcount]));
17800 $w_diff = ($spacewidth * $lnstring[2][$strcount]);
17801 } else {
17802 if ($strcount > 0) {
17803 $x_diff = ($spacewidth * ($nsmax - $lnstring[3][($strcount - 1)]));
17804 $w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
17805 }
17806 }
17807 } else { // LTR
17808 if ($currentxpos > $textpos) {
17809 if ($strcount > 0) {
17810 $x_diff = ($spacewidth * $lnstring[3][($strcount - 1)]);
17811 }
17812 $w_diff = ($spacewidth * $lnstring[2][$strcount]);
17813 } else {
17814 if ($strcount > 1) {
17815 $x_diff = ($spacewidth * $lnstring[3][($strcount - 2)]);
17816 }
17817 if ($strcount > 0) {
17818 $w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
17819 }
17820 }
17821 }
17822 if (preg_match('/('.$xmatches[1].')[\s]('.$xmatches[2].')[\s]('.$xmatches[3].')[\s]('.$strpiece[1][0].')[\s](re)([\s]*)/x', $pmid, $pmatch) == 1) {
17825 $newpmid = $newx.' '.$pmatch[2].' '.$neww.' '.$pmatch[4].' x*#!#*x'.$pmatch[5].$pmatch[6];
17826 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17827 unset($pmatch, $newpmid, $newx, $neww);
17828 }
17829 break;
17830 }
17831 case 'c': {
17832 // get current X position
17833 preg_match('/([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s](c)([\s]*)/x', $pmid, $xmatches);
17834 if (!isset($xmatches[1])) {
17835 break;
17836 }
17837 $currentxpos = $xmatches[1];
17838 // justify block
17839 if (preg_match('/('.$xmatches[1].')[\s]('.$xmatches[2].')[\s]('.$xmatches[3].')[\s]('.$xmatches[4].')[\s]('.$xmatches[5].')[\s]('.$strpiece[1][0].')[\s](c)([\s]*)/x', $pmid, $pmatch) == 1) {
17843 $newpmid = $newx1.' '.$pmatch[2].' '.$newx2.' '.$pmatch[4].' '.$newx3.' '.$pmatch[6].' x*#!#*x'.$pmatch[7].$pmatch[8];
17844 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17845 unset($pmatch, $newpmid, $newx1, $newx2, $newx3);
17846 }
17847 break;
17848 }
17849 }
17850 // shift the annotations and links
17851 $cxpos = ($currentxpos / $this->k);
17853 if ($this->inxobj) {
17854 // we are inside an XObject template
17855 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
17856 if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
17857 if ($cxpos > $lmpos) {
17859 $this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
17860 } else {
17861 $this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
17862 }
17863 break;
17864 }
17865 }
17866 } elseif (isset($this->PageAnnots[$this->page])) {
17867 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
17868 if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
17869 if ($cxpos > $lmpos) {
17872 } else {
17874 }
17875 break;
17876 }
17877 }
17878 }
17879 } // end of while
17880 // remove markers
17881 $pmid = str_replace('x*#!#*x', '', $pmid);
17883 // multibyte characters
17884 $spacew = $spacewidthu;
17885 if ($this->font_stretching != 100) {
17886 // word spacing is affected by stretching
17887 $spacew /= ($this->font_stretching / 100);
17888 }
17889 // escape special characters
17890 $pos = 0;
17891 $pmid = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmid);
17892 $pmid = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmid);
17893 if (preg_match_all('/\[\(([^\)]*)\)\]/x', $pmid, $pamatch) > 0) {
17894 foreach($pamatch[0] as $pk => $pmatch) {
17895 $replace = $pamatch[1][$pk];
17896 $replace = str_replace('#!#OP#!#', '(', $replace);
17897 $replace = str_replace('#!#CP#!#', ')', $replace);
17899 $pos = strpos($pmid, $pmatch, $pos);
17900 if ($pos !== FALSE) {
17901 $pmid = substr_replace($pmid, $newpmid, $pos, strlen($pmatch));
17902 }
17903 ++$pos;
17904 }
17905 unset($pamatch);
17906 }
17907 if ($this->inxobj) {
17908 // we are inside an XObject template
17910 } else {
17912 }
17913 $endlinepos = strlen($pstart."\n".$pmid."\n");
17914 } else {
17915 // non-unicode (single-byte characters)
17916 if ($this->font_stretching != 100) {
17917 // word spacing (Tw) is affected by stretching
17918 $spacewidth /= ($this->font_stretching / 100);
17919 }
17921 $pmid = preg_replace("/\[\(/x", $rs.' [(', $pmid);
17922 if ($this->inxobj) {
17923 // we are inside an XObject template
17925 } else {
17927 }
17928 $endlinepos = strlen($pstart."\n".$pmid."\nBT 0 Tw ET\n");
17929 }
17930 }
17931 } // end of J
17932 } // end if $startlinex
17933 if (($t_x != 0) OR ($yshift < 0)) {
17934 // shift the line
17936 $pstart .= "\nq\n".$trx."\n".$pmid."\nQ\n";
17937 $endlinepos = strlen($pstart);
17938 if ($this->inxobj) {
17939 // we are inside an XObject template
17941 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
17942 if ($pak >= $pask) {
17945 }
17946 }
17947 } else {
17948 $this->setPageBuffer($startlinepage, $pstart.$pend);
17949 // shift the annotations and links
17950 if (isset($this->PageAnnots[$this->page])) {
17951 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
17952 if ($pak >= $pask) {
17955 }
17956 }
17957 }
17958 }
17959 $this->y -= $yshift;
17960 }
17961 }
17962 $pbrk = $this->checkPageBreak($this->lasth);
17963 $this->newline = false;
17964 $startlinex = $this->x;
17965 $startliney = $this->y;
17966 if ($dom[$dom[$key]['parent']]['value'] == 'sup') {
17967 $startliney -= ((0.3 * $this->FontSizePt) / $this->k);
17968 } elseif ($dom[$dom[$key]['parent']]['value'] == 'sub') {
17969 $startliney -= (($this->FontSizePt / 0.7) / $this->k);
17970 } else {
17971 $minstartliney = $startliney;
17972 $maxbottomliney = ($this->y + $this->getCellHeight($fontsize / $this->k));
17973 }
17974 $startlinepage = $this->page;
17975 if (isset($endlinepos) AND (!$pbrk)) {
17976 $startlinepos = $endlinepos;
17977 } else {
17978 if ($this->inxobj) {
17979 // we are inside an XObject template
17980 $startlinepos = strlen($this->xobjects[$this->xobjid]['outdata']);
17981 } elseif (!$this->InFooter) {
17982 if (isset($this->footerlen[$this->page])) {
17984 } else {
17986 }
17987 $startlinepos = $this->footerpos[$this->page];
17988 } else {
17989 $startlinepos = $this->pagelen[$this->page];
17990 }
17991 }
17992 unset($endlinepos);
17993 $plalign = $lalign;
17994 if (isset($this->PageAnnots[$this->page])) {
17995 $pask = count($this->PageAnnots[$this->page]);
17996 } else {
17997 $pask = 0;
17998 }
17999 if (!($dom[$key]['tag'] AND !$dom[$key]['opening'] AND ($dom[$key]['value'] == 'table')
18000 AND (isset($this->emptypagemrk[$this->page]))
18001 AND ($this->emptypagemrk[$this->page] == $this->pagelen[$this->page]))) {
18002 $this->SetFont($fontname, $fontstyle, $fontsize);
18003 if ($wfill) {
18004 $this->SetFillColorArray($this->bgcolor);
18005 }
18006 }
18007 } // end newline
18008 if (isset($opentagpos)) {
18009 unset($opentagpos);
18010 }
18011 if ($dom[$key]['tag']) {
18012 if ($dom[$key]['opening']) {
18013 // get text indentation (if any)
18014 if (isset($dom[$key]['text-indent']) AND $dom[$key]['block']) {
18015 $this->textindent = $dom[$key]['text-indent'];
18016 $this->newline = true;
18017 }
18018 // table
18019 if (($dom[$key]['value'] == 'table') AND isset($dom[$key]['cols']) AND ($dom[$key]['cols'] > 0)) {
18020 // available page width
18021 if ($this->rtl) {
18022 $wtmp = $this->x - $this->lMargin;
18023 } else {
18024 $wtmp = $this->w - $this->rMargin - $this->x;
18025 }
18026 // get cell spacing
18027 if (isset($dom[$key]['attribute']['cellspacing'])) {
18029 $cellspacing = array('H' => $clsp, 'V' => $clsp);
18030 } elseif (isset($dom[$key]['border-spacing'])) {
18031 $cellspacing = $dom[$key]['border-spacing'];
18032 } else {
18033 $cellspacing = array('H' => 0, 'V' => 0);
18034 }
18035 // table width
18036 if (isset($dom[$key]['width'])) {
18038 } else {
18039 $table_width = $wtmp;
18040 }
18041 $table_width -= (2 * $cellspacing['H']);
18042 if (!$this->inthead) {
18043 $this->y += $cellspacing['V'];
18044 }
18045 if ($this->rtl) {
18046 $cellspacingx = -$cellspacing['H'];
18047 } else {
18048 $cellspacingx = $cellspacing['H'];
18049 }
18050 // total table width without cellspaces
18051 $table_columns_width = ($table_width - ($cellspacing['H'] * ($dom[$key]['cols'] - 1)));
18052 // minimum column width
18053 // tcpdf-patch: begin
18054 if ($table_columns_width == 0 || $dom[$key]['cols'] == 0)
18055 {
18056 $table_min_column_width = 1;
18057 }
18058 else
18059 {
18060 $table_min_column_width = ($table_columns_width / $dom[$key]['cols']);
18061 }
18062 if ($dom[$key]['cols'] != 0)
18063 {
18064 // array of custom column widths
18065 $table_colwidths = array_fill(0, $dom[$key]['cols'], $table_min_column_width);
18066 }
18067 // tcpdf-patch: end
18068 }
18069 // table row
18070 if ($dom[$key]['value'] == 'tr') {
18071 // reset column counter
18072 $colid = 0;
18073 }
18074 // table cell
18075 if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
18076 $trid = $dom[$key]['parent'];
18077 $table_el = $dom[$trid]['parent'];
18078 if (!isset($dom[$table_el]['cols'])) {
18079 $dom[$table_el]['cols'] = $dom[$trid]['cols'];
18080 }
18081 // store border info
18082 $tdborder = 0;
18083 if (isset($dom[$key]['border']) AND !empty($dom[$key]['border'])) {
18084 $tdborder = $dom[$key]['border'];
18085 }
18086 $colspan = intval($dom[$key]['attribute']['colspan']);
18087 if ($colspan <= 0) {
18088 $colspan = 1;
18089 }
18090 $old_cell_padding = $this->cell_padding;
18091 if (isset($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'])) {
18092 $crclpd = $this->getHTMLUnitToUnits($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'], 1, 'px');
18093 $current_cell_padding = array('L' => $crclpd, 'T' => $crclpd, 'R' => $crclpd, 'B' => $crclpd);
18094 } elseif (isset($dom[($dom[$trid]['parent'])]['padding'])) {
18095 $current_cell_padding = $dom[($dom[$trid]['parent'])]['padding'];
18096 } else {
18097 $current_cell_padding = array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0);
18098 }
18099 $this->cell_padding = $current_cell_padding;
18100 if (isset($dom[$key]['height'])) {
18101 // minimum cell height
18103 } else {
18104 $cellh = 0;
18105 }
18106 if (isset($dom[$key]['content'])) {
18107 $cell_content = $dom[$key]['content'];
18108 } else {
18109 $cell_content = ' ';
18110 }
18111 $tagtype = $dom[$key]['value'];
18112 $parentid = $key;
18113 while (($key < $maxel) AND (!(($dom[$key]['tag']) AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == $tagtype) AND ($dom[$key]['parent'] == $parentid)))) {
18114 // move $key index forward
18115 ++$key;
18116 }
18117 if (!isset($dom[$trid]['startpage'])) {
18119 } else {
18121 }
18122 if (!isset($dom[$trid]['startcolumn'])) {
18124 } elseif ($this->current_column != $dom[$trid]['startcolumn']) {
18125 $tmpx = $this->x;
18127 $this->x = $tmpx;
18128 }
18129 if (!isset($dom[$trid]['starty'])) {
18131 } else {
18132 $this->y = $dom[$trid]['starty'];
18133 }
18134 if (!isset($dom[$trid]['startx'])) {
18136 $this->x += $cellspacingx;
18137 } else {
18138 $this->x += ($cellspacingx / 2);
18139 }
18140 if (isset($dom[$parentid]['attribute']['rowspan'])) {
18141 $rowspan = intval($dom[$parentid]['attribute']['rowspan']);
18142 } else {
18143 $rowspan = 1;
18144 }
18145 // skip row-spanned cells started on the previous rows
18146 if (isset($dom[$table_el]['rowspans'])) {
18147 $rsk = 0;
18148 $rskmax = count($dom[$table_el]['rowspans']);
18149 while ($rsk < $rskmax) {
18150 $trwsp = $dom[$table_el]['rowspans'][$rsk];
18151 $rsstartx = $trwsp['startx'];
18152 $rsendx = $trwsp['endx'];
18153 // account for margin changes
18154 if ($trwsp['startpage'] < $this->page) {
18155 if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$trwsp['startpage']]['orm'])) {
18157 $rsstartx -= $dl;
18158 $rsendx -= $dl;
18159 } elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$trwsp['startpage']]['olm'])) {
18161 $rsstartx += $dl;
18162 $rsendx += $dl;
18163 }
18164 }
18165 if (($trwsp['rowspan'] > 0)
18166 AND ($rsstartx > ($this->x - $cellspacing['H'] - $current_cell_padding['L'] - $this->feps))
18167 AND ($rsstartx < ($this->x + $cellspacing['H'] + $current_cell_padding['R'] + $this->feps))
18168 AND (($trwsp['starty'] < ($this->y - $this->feps)) OR ($trwsp['startpage'] < $this->page) OR ($trwsp['startcolumn'] < $this->current_column))) {
18169 // set the starting X position of the current cell
18170 $this->x = $rsendx + $cellspacingx;
18171 // increment column indicator
18172 $colid += $trwsp['colspan'];
18173 if (($trwsp['rowspan'] == 1)
18174 AND (isset($dom[$trid]['endy']))
18175 AND (isset($dom[$trid]['endpage']))
18176 AND (isset($dom[$trid]['endcolumn']))
18177 AND ($trwsp['endpage'] == $dom[$trid]['endpage'])
18178 AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
18179 // set ending Y position for row
18180 $dom[$table_el]['rowspans'][$rsk]['endy'] = max($dom[$trid]['endy'], $trwsp['endy']);
18181 $dom[$trid]['endy'] = $dom[$table_el]['rowspans'][$rsk]['endy'];
18182 }
18183 $rsk = 0;
18184 } else {
18185 ++$rsk;
18186 }
18187 }
18188 }
18189 if (isset($dom[$parentid]['width'])) {
18190 // user specified width
18192 $tmpcw = ($cellw / $colspan);
18193 for ($i = 0; $i < $colspan; ++$i) {
18194 $table_colwidths[($colid + $i)] = $tmpcw;
18195 }
18196 } else {
18197 // inherit column width
18198 $cellw = 0;
18199 for ($i = 0; $i < $colspan; ++$i) {
18200 $cellw += (isset($table_colwidths[($colid + $i)]) ? $table_colwidths[($colid + $i)] : 0);
18201 }
18202 }
18203 $cellw += (($colspan - 1) * $cellspacing['H']);
18204 // increment column indicator
18205 $colid += $colspan;
18206 // add rowspan information to table element
18207 if ($rowspan > 1) {
18208 $trsid = array_push($dom[$table_el]['rowspans'], array('trid' => $trid, 'rowspan' => $rowspan, 'mrowspan' => $rowspan, 'colspan' => $colspan, 'startpage' => $this->page, 'startcolumn' => $this->current_column, 'startx' => $this->x, 'starty' => $this->y));
18209 }
18210 $cellid = array_push($dom[$trid]['cellpos'], array('startx' => $this->x));
18211 if ($rowspan > 1) {
18212 $dom[$trid]['cellpos'][($cellid - 1)]['rowspanid'] = ($trsid - 1);
18213 }
18214 // push background colors
18215 if (isset($dom[$parentid]['bgcolor']) AND ($dom[$parentid]['bgcolor'] !== false)) {
18216 $dom[$trid]['cellpos'][($cellid - 1)]['bgcolor'] = $dom[$parentid]['bgcolor'];
18217 }
18218 // store border info
18219 if (isset($tdborder) AND !empty($tdborder)) {
18220 $dom[$trid]['cellpos'][($cellid - 1)]['border'] = $tdborder;
18221 }
18222 $prevLastH = $this->lasth;
18223 // store some info for multicolumn mode
18224 if ($this->rtl) {
18226 } else {
18228 }
18229 $this->colxshift['s'] = $cellspacing;
18230 $this->colxshift['p'] = $current_cell_padding;
18231 // ****** write the cell content ******
18232 $this->MultiCell($cellw, $cellh, $cell_content, false, $lalign, false, 2, '', '', true, 0, true, true, 0, 'T', false);
18233 // restore some values
18234 $this->colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
18235 $this->lasth = $prevLastH;
18236 $this->cell_padding = $old_cell_padding;
18237 $dom[$trid]['cellpos'][($cellid - 1)]['endx'] = $this->x;
18238 // update the end of row position
18239 if ($rowspan <= 1) {
18240 if (isset($dom[$trid]['endy'])) {
18241 if (($this->page == $dom[$trid]['endpage']) AND ($this->current_column == $dom[$trid]['endcolumn'])) {
18242 $dom[$trid]['endy'] = max($this->y, $dom[$trid]['endy']);
18243 } elseif (($this->page > $dom[$trid]['endpage']) OR ($this->current_column > $dom[$trid]['endcolumn'])) {
18245 }
18246 } else {
18248 }
18249 if (isset($dom[$trid]['endpage'])) {
18250 $dom[$trid]['endpage'] = max($this->page, $dom[$trid]['endpage']);
18251 } else {
18253 }
18254 if (isset($dom[$trid]['endcolumn'])) {
18255 $dom[$trid]['endcolumn'] = max($this->current_column, $dom[$trid]['endcolumn']);
18256 } else {
18258 }
18259 } else {
18260 // account for row-spanned cells
18261 $dom[$table_el]['rowspans'][($trsid - 1)]['endx'] = $this->x;
18262 $dom[$table_el]['rowspans'][($trsid - 1)]['endy'] = $this->y;
18263 $dom[$table_el]['rowspans'][($trsid - 1)]['endpage'] = $this->page;
18264 $dom[$table_el]['rowspans'][($trsid - 1)]['endcolumn'] = $this->current_column;
18265 }
18266 if (isset($dom[$table_el]['rowspans'])) {
18267 // update endy and endpage on rowspanned cells
18269 if ($trwsp['rowspan'] > 0) {
18270 if (isset($dom[$trid]['endpage'])) {
18271 if (($trwsp['endpage'] == $dom[$trid]['endpage']) AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
18273 } elseif (($trwsp['endpage'] < $dom[$trid]['endpage']) OR ($trwsp['endcolumn'] < $dom[$trid]['endcolumn'])) {
18277 } else {
18278 $dom[$trid]['endy'] = $this->pagedim[$dom[$trid]['endpage']]['hk'] - $this->pagedim[$dom[$trid]['endpage']]['bm'];
18279 }
18280 }
18281 }
18282 }
18283 }
18284 $this->x += ($cellspacingx / 2);
18285 } else {
18286 // opening tag (or self-closing tag)
18287 if (!isset($opentagpos)) {
18288 if ($this->inxobj) {
18289 // we are inside an XObject template
18290 $opentagpos = strlen($this->xobjects[$this->xobjid]['outdata']);
18291 } elseif (!$this->InFooter) {
18292 if (isset($this->footerlen[$this->page])) {
18294 } else {
18296 }
18297 $opentagpos = $this->footerpos[$this->page];
18298 }
18299 }
18300 $dom = $this->openHTMLTagHandler($dom, $key, $cell);
18301 }
18302 } else { // closing tag
18303 $prev_numpages = $this->numpages;
18304 $old_bordermrk = $this->bordermrk[$this->page];
18305 $dom = $this->closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney);
18306 if ($this->bordermrk[$this->page] > $old_bordermrk) {
18307 $startlinepos += ($this->bordermrk[$this->page] - $old_bordermrk);
18308 }
18309 if ($prev_numpages > $this->numpages) {
18310 $startlinepage = $this->page;
18311 }
18312 }
18313 } elseif (strlen($dom[$key]['value']) > 0) {
18314 // print list-item
18316 $this->SetFont($pfontname, $pfontstyle, $pfontsize);
18317 $this->resetLastH();
18318 $minstartliney = $this->y;
18319 $maxbottomliney = ($startliney + $this->getCellHeight($this->FontSize));
18320 if (is_numeric($pfontsize) AND ($pfontsize > 0)) {
18321 $this->putHtmlListBullet($this->listnum, $this->lispacer, $pfontsize);
18322 }
18323 $this->SetFont($curfontname, $curfontstyle, $curfontsize);
18324 $this->resetLastH();
18325 if (is_numeric($pfontsize) AND ($pfontsize > 0) AND is_numeric($curfontsize) AND ($curfontsize > 0) AND ($pfontsize != $curfontsize)) {
18326 $pfontascent = $this->getFontAscent($pfontname, $pfontstyle, $pfontsize);
18327 $pfontdescent = $this->getFontDescent($pfontname, $pfontstyle, $pfontsize);
18328 $this->y += ($this->getCellHeight(($pfontsize - $curfontsize) / $this->k) + $pfontascent - $curfontascent - $pfontdescent + $curfontdescent) / 2;
18329 $minstartliney = min($this->y, $minstartliney);
18330 $maxbottomliney = max(($this->y + $this->getCellHeight($pfontsize / $this->k)), $maxbottomliney);
18331 }
18332 }
18333 // text
18334 $this->htmlvspace = 0;
18336 // reverse spaces order
18337 $lsp = ''; // left spaces
18338 $rsp = ''; // right spaces
18339 if (preg_match('/^('.$this->re_space['p'].'+)/'.$this->re_space['m'], $dom[$key]['value'], $matches)) {
18340 $lsp = $matches[1];
18341 }
18342 if (preg_match('/('.$this->re_space['p'].'+)$/'.$this->re_space['m'], $dom[$key]['value'], $matches)) {
18343 $rsp = $matches[1];
18344 }
18345 $dom[$key]['value'] = $rsp.$this->stringTrim($dom[$key]['value']).$lsp;
18346 }
18348 if (!$this->premode) {
18349 $prelen = strlen($dom[$key]['value']);
18351 // right trim except non-breaking space
18353 } else {
18354 // left trim except non-breaking space
18356 }
18357 $postlen = strlen($dom[$key]['value']);
18358 if (($postlen == 0) AND ($prelen > 0)) {
18359 $dom[$key]['trimmed_space'] = true;
18360 }
18361 }
18363 $firstblock = true;
18364 } else {
18365 $firstblock = false;
18366 // replace empty multiple spaces string with a single space
18367 $dom[$key]['value'] = preg_replace('/^'.$this->re_space['p'].'+$/'.$this->re_space['m'], chr(32), $dom[$key]['value']);
18368 }
18369 $strrest = '';
18370 if ($this->rtl) {
18371 $this->x -= $this->textindent;
18372 } else {
18373 $this->x += $this->textindent;
18374 }
18375 if (!isset($dom[$key]['trimmed_space']) OR !$dom[$key]['trimmed_space']) {
18377 if (!empty($this->HREF) AND (isset($this->HREF['url']))) {
18378 // HTML <a> Link
18379 $hrefcolor = '';
18380 if (isset($dom[($dom[$key]['parent'])]['fgcolor']) AND ($dom[($dom[$key]['parent'])]['fgcolor'] !== false)) {
18381 $hrefcolor = $dom[($dom[$key]['parent'])]['fgcolor'];
18382 }
18383 $hrefstyle = -1;
18384 if (isset($dom[($dom[$key]['parent'])]['fontstyle']) AND ($dom[($dom[$key]['parent'])]['fontstyle'] !== false)) {
18385 $hrefstyle = $dom[($dom[$key]['parent'])]['fontstyle'];
18386 }
18387 $strrest = $this->addHtmlLink($this->HREF['url'], $dom[$key]['value'], $wfill, true, $hrefcolor, $hrefstyle, true);
18388 } else {
18389 $wadj = 0; // space to leave for block continuity
18390 if ($this->rtl) {
18391 $cwa = ($this->x - $this->lMargin);
18392 } else {
18393 $cwa = ($this->w - $this->rMargin - $this->x);
18394 }
18395 if (($strlinelen < $cwa) AND (isset($dom[($key + 1)])) AND ($dom[($key + 1)]['tag']) AND (!$dom[($key + 1)]['block'])) {
18396 // check the next text blocks for continuity
18397 $nkey = ($key + 1);
18398 $write_block = true;
18399 $same_textdir = true;
18400 $tmp_fontname = $this->FontFamily;
18401 $tmp_fontstyle = $this->FontStyle;
18402 $tmp_fontsize = $this->FontSizePt;
18403 while ($write_block AND isset($dom[$nkey])) {
18404 if ($dom[$nkey]['tag']) {
18405 if ($dom[$nkey]['block']) {
18406 // end of block
18407 $write_block = false;
18408 }
18410 $tmp_fontstyle = isset($dom[$nkey]['fontstyle']) ? $dom[$nkey]['fontstyle'] : $this->FontStyle;
18412 $same_textdir = ($dom[$nkey]['dir'] == $dom[$key]['dir']);
18413 } else {
18414 $nextstr = TCPDF_STATIC::pregSplit('/'.$this->re_space['p'].'+/', $this->re_space['m'], $dom[$nkey]['value']);
18415 if (isset($nextstr[0]) AND $same_textdir) {
18416 $wadj += $this->GetStringWidth($nextstr[0], $tmp_fontname, $tmp_fontstyle, $tmp_fontsize);
18417 if (isset($nextstr[1])) {
18418 $write_block = false;
18419 }
18420 }
18421 }
18422 ++$nkey;
18423 }
18424 }
18425 if (($wadj > 0) AND (($strlinelen + $wadj) >= $cwa)) {
18426 $wadj = 0;
18427 $nextstr = TCPDF_STATIC::pregSplit('/'.$this->re_space['p'].'/', $this->re_space['m'], $dom[$key]['value']);
18428 $numblks = count($nextstr);
18429 if ($numblks > 1) {
18430 // try to split on blank spaces
18431 $wadj = ($cwa - $strlinelen + $this->GetStringWidth($nextstr[($numblks - 1)]));
18432 } else {
18433 // set the entire block on new line
18434 $wadj = $this->GetStringWidth($nextstr[0]);
18435 }
18436 }
18437 // check for reversed text direction
18438 if (($wadj > 0) AND (($this->rtl AND ($this->tmprtl === 'L')) OR (!$this->rtl AND ($this->tmprtl === 'R')))) {
18439 // LTR text on RTL direction or RTL text on LTR direction
18440 $reverse_dir = true;
18441 $this->rtl = !$this->rtl;
18442 $revshift = ($strlinelen + $wadj + 0.000001); // add little quantity for rounding problems
18443 if ($this->rtl) {
18444 $this->x += $revshift;
18445 } else {
18446 $this->x -= $revshift;
18447 }
18448 $xws = $this->x;
18449 }
18450 // ****** write only until the end of the line and get the rest ******
18451 $strrest = $this->Write($this->lasth, $dom[$key]['value'], '', $wfill, '', false, 0, true, $firstblock, 0, $wadj);
18452 // restore default direction
18453 if ($reverse_dir AND ($wadj == 0)) {
18454 $this->x = $xws;
18455 $this->rtl = !$this->rtl;
18456 $reverse_dir = false;
18457 }
18458 }
18459 }
18460 $this->textindent = 0;
18461 if (strlen($strrest) > 0) {
18462 // store the remaining string on the previous $key position
18463 $this->newline = true;
18464 if ($strrest == $dom[$key]['value']) {
18465 // used to avoid infinite loop
18466 ++$loop;
18467 } else {
18468 $loop = 0;
18469 }
18470 $dom[$key]['value'] = $strrest;
18471 if ($cell) {
18472 if ($this->rtl) {
18473 $this->x -= $this->cell_padding['R'];
18474 } else {
18475 $this->x += $this->cell_padding['L'];
18476 }
18477 }
18478 if ($loop < 3) {
18479 --$key;
18480 }
18481 } else {
18482 $loop = 0;
18483 // add the positive font spacing of the last character (if any)
18484 if ($this->font_spacing > 0) {
18485 if ($this->rtl) {
18486 $this->x -= $this->font_spacing;
18487 } else {
18488 $this->x += $this->font_spacing;
18489 }
18490 }
18491 }
18492 }
18493 ++$key;
18494 if (isset($dom[$key]['tag']) AND $dom[$key]['tag'] AND (!isset($dom[$key]['opening']) OR !$dom[$key]['opening']) AND isset($dom[($dom[$key]['parent'])]['attribute']['nobr']) AND ($dom[($dom[$key]['parent'])]['attribute']['nobr'] == 'true')) {
18495 // check if we are on a new page or on a new column
18496 if ((!$undo) AND (($this->y < $this->start_transaction_y) OR (($dom[$key]['value'] == 'tr') AND ($dom[($dom[$key]['parent'])]['endy'] < $this->start_transaction_y)))) {
18497 // we are on a new page or on a new column and the total object height is less than the available vertical space.
18498 // restore previous object
18500 // restore previous values
18501 foreach ($this_method_vars as $vkey => $vval) {
18502 $$vkey = $vval;
18503 }
18504 if (!empty($dom[$key]['thead'])) {
18505 $this->inthead = true;
18506 }
18507 // add a page (or trig AcceptPageBreak() for multicolumn mode)
18508 $pre_y = $this->y;
18510 $startliney = $this->y;
18511 }
18512 $undo = true; // avoid infinite loop
18513 } else {
18514 $undo = false;
18515 }
18516 }
18517 } // end for each $key
18518 // align the last line
18519 if (isset($startlinex)) {
18520 $yshift = ($minstartliney - $startliney);
18521 if (($yshift > 0) OR ($this->page > $startlinepage)) {
18522 $yshift = 0;
18523 }
18524 $t_x = 0;
18525 // the last line must be shifted to be aligned as requested
18526 $linew = abs($this->endlinex - $startlinex);
18527 if ($this->inxobj) {
18528 // we are inside an XObject template
18529 $pstart = substr($this->xobjects[$this->xobjid]['outdata'], 0, $startlinepos);
18530 if (isset($opentagpos)) {
18531 $midpos = $opentagpos;
18532 } else {
18533 $midpos = 0;
18534 }
18535 if ($midpos > 0) {
18536 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
18537 $pend = substr($this->xobjects[$this->xobjid]['outdata'], $midpos);
18538 } else {
18539 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos);
18540 $pend = '';
18541 }
18542 } else {
18543 $pstart = substr($this->getPageBuffer($startlinepage), 0, $startlinepos);
18544 if (isset($opentagpos) AND isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
18545 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
18546 $midpos = min($opentagpos, $this->footerpos[$startlinepage]);
18547 } elseif (isset($opentagpos)) {
18548 $midpos = $opentagpos;
18549 } elseif (isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
18550 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
18551 $midpos = $this->footerpos[$startlinepage];
18552 } else {
18553 $midpos = 0;
18554 }
18555 if ($midpos > 0) {
18556 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
18557 $pend = substr($this->getPageBuffer($startlinepage), $midpos);
18558 } else {
18559 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos);
18560 $pend = '';
18561 }
18562 }
18563 if ((isset($plalign) AND ((($plalign == 'C') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
18564 // calculate shifting amount
18565 $tw = $w;
18566 if ($this->lMargin != $prevlMargin) {
18567 $tw += ($prevlMargin - $this->lMargin);
18568 }
18569 if ($this->rMargin != $prevrMargin) {
18570 $tw += ($prevrMargin - $this->rMargin);
18571 }
18572 $one_space_width = $this->GetStringWidth(chr(32));
18573 $no = 0; // number of spaces on a line contained on a single block
18575 // remove left space if exist
18577 if ($pos1 > 0) {
18578 $pos1 = intval($pos1);
18581 $spacelen = 2;
18582 } else {
18584 $spacelen = 1;
18585 }
18586 if ($pos1 == $pos2) {
18587 $pmid = substr($pmid, 0, ($pos1 + 2)).substr($pmid, ($pos1 + 2 + $spacelen));
18588 if (substr($pmid, $pos1, 4) == '[()]') {
18589 $linew -= $one_space_width;
18590 } elseif ($pos1 == strpos($pmid, '[(')) {
18591 $no = 1;
18592 }
18593 }
18594 }
18595 } else { // LTR
18596 // remove right space if exist
18598 if ($pos1 > 0) {
18599 $pos1 = intval($pos1);
18602 $spacelen = 2;
18603 } else {
18605 $spacelen = 1;
18606 }
18607 if ($pos1 == $pos2) {
18608 $pmid = substr($pmid, 0, ($pos1 - $spacelen)).substr($pmid, $pos1);
18609 $linew -= $one_space_width;
18610 }
18611 }
18612 }
18613 $mdiff = ($tw - $linew);
18614 if ($plalign == 'C') {
18615 if ($this->rtl) {
18616 $t_x = -($mdiff / 2);
18617 } else {
18618 $t_x = ($mdiff / 2);
18619 }
18620 } elseif ($plalign == 'R') {
18621 // right alignment on LTR document
18622 $t_x = $mdiff;
18623 } elseif ($plalign == 'L') {
18624 // left alignment on RTL document
18625 $t_x = -$mdiff;
18626 }
18627 } // end if startlinex
18628 if (($t_x != 0) OR ($yshift < 0)) {
18629 // shift the line
18631 $pstart .= "\nq\n".$trx."\n".$pmid."\nQ\n";
18632 $endlinepos = strlen($pstart);
18633 if ($this->inxobj) {
18634 // we are inside an XObject template
18636 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
18637 if ($pak >= $pask) {
18640 }
18641 }
18642 } else {
18643 $this->setPageBuffer($startlinepage, $pstart.$pend);
18644 // shift the annotations and links
18645 if (isset($this->PageAnnots[$this->page])) {
18646 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
18647 if ($pak >= $pask) {
18650 }
18651 }
18652 }
18653 }
18654 $this->y -= $yshift;
18655 $yshift = 0;
18656 }
18657 }
18658 // restore previous values
18659 $this->setGraphicVars($gvars);
18660 if ($this->num_columns > 1) {
18661 $this->selectColumn();
18662 } elseif ($this->page > $prevPage) {
18665 }
18666 // restore previous list state
18667 $this->cell_height_ratio = $prev_cell_height_ratio;
18668 $this->listnum = $prev_listnum;
18669 $this->listordered = $prev_listordered;
18670 $this->listcount = $prev_listcount;
18671 $this->lispacer = $prev_lispacer;
18672 if ($ln AND (!($cell AND ($dom[$key-1]['value'] == 'table')))) {
18673 $this->Ln($this->lasth);
18674 if (($this->y < $maxbottomliney) AND ($startlinepage == $this->page)) {
18675 $this->y = $maxbottomliney;
18676 }
18677 }
18678 unset($dom);
18679 }
static revstrpos($haystack, $needle, $offset=0)
Find position of last occurrence of a substring in a string.
Definition: tcpdf_static.php:1507
putHtmlListBullet($listdepth, $listtype='', $size=10)
Output an HTML list bullet or ordered item symbol.
Definition: tcpdf.php:20343
rollbackTransaction($self=false)
This method allows to undo the latest transaction by returning the latest saved TCPDF object with sta...
Definition: tcpdf.php:21663
closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney=0)
Process closing tags.
Definition: tcpdf.php:19359
startTransaction()
Stores a copy of the current TCPDF object used for undo operation.
Definition: tcpdf.php:21632
$listordered
HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
Definition: tcpdf.php:722
addHtmlLink($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false)
Output anchor link.
Definition: tcpdf.php:10374
References $cell_height_ratio, $cell_margin, $cell_padding, $current_column, $customlistindent, $feps, $font_spacing, $font_stretching, $FontFamily, $FontSize, $FontSizePt, $FontStyle, $html, $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(), getCellHeight(), getFontAscent(), getFontDescent(), getGraphicVars(), getHtmlDomArray(), getHTMLUnitToUnits(), getPageBuffer(), getSpaceString(), GetStringWidth(), inPageBody(), isRTLTextDir(), isUnicodeFont(), Ln(), MultiCell(), openHTMLTagHandler(), TCPDF_STATIC\pregSplit(), putHtmlListBullet(), resetLastH(), TCPDF_STATIC\revstrpos(), rollbackTransaction(), selectColumn(), SetDrawColorArray(), SetFillColorArray(), SetFont(), setFontSpacing(), setFontStretching(), setGraphicVars(), setPage(), setPageBuffer(), SetTextColorArray(), setTextRenderingMode(), sprintf, startTransaction(), stringLeftTrim(), stringRightTrim(), Write(), and writeHTML().
Referenced by MC_TCPDF\ChapterBody(), MultiCell(), setTableHeader(), and writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ writeHTMLCell()
| 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.
- Parameters
-
$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: - L : left align
- C : center
- R : right align
- '' : empty string : left for LTR or right for RTL
$autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.
- See also
- Multicell(), writeHTML()
Definition at line 17103 of file tcpdf.php.
17103 {
17104 return $this->MultiCell($w, $h, $html, $border, $align, $fill, $ln, $x, $y, $reseth, 0, true, $autopadding, 0, 'T', false);
17105 }
References $border, $h, $html, $w, $x, $y, and MultiCell().
Here is the call graph for this function:
Field Documentation
◆ $alpha
|
protected |
Alpha mode array.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
- Since
- 5.9.152 (2012-03-23)
Definition at line 1795 of file tcpdf.php.
Referenced by _outellipticalarc(), Cell(), getAlpha(), and ImagePngAlpha().
◆ $annotation_fonts
|
protected |
◆ $author
|
protected |
◆ $AutoPageBreak
|
protected |
Automatic page breaking.
Definition at line 446 of file tcpdf.php.
Referenced by AcceptPageBreak(), getAutoPageBreak(), MYPDF\Header(), and setPageOrientation().
◆ $barcode
|
protected |
Barcode to print on page footer (only if set).
Definition at line 619 of file tcpdf.php.
Referenced by Footer(), and getBarcode().
◆ $bgcolor
|
protected |
◆ $bMargin
|
protected |
Page break margin.
Definition at line 274 of file tcpdf.php.
Referenced by getBreakMargin(), MYPDF\Header(), MultiCell(), setPageOrientation(), and write2DBarcode().
◆ $booklet
|
protected |
◆ $bordermrk
|
protected |
◆ $buffer
|
protected |
◆ $bufferlen
|
protected |
◆ $cache_file_length
|
protected |
◆ $cell_height_ratio
|
protected |
Default cell height ratio.
- Since
- 3.0.014 (2008-05-23)
Definition at line 924 of file tcpdf.php.
Referenced by getCellHeight(), getCellHeightRatio(), getHtmlDomArray(), openHTMLTagHandler(), and writeHTML().
◆ $cell_margin
|
protected |
Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
- Since
- 5.9.000 (2010-10-04)
Definition at line 288 of file tcpdf.php.
Referenced by Cell(), getCellCode(), getCellMargins(), getCSSMargin(), getHtmlDomArray(), MultiCell(), Write(), and writeHTML().
◆ $cell_padding
|
protected |
Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
- Since
- 5.9.000 (2010-10-03)
Definition at line 281 of file tcpdf.php.
Referenced by adjustCellPadding(), Cell(), getCellCode(), getCellPaddings(), getCSSPadding(), getHtmlDomArray(), getNumLines(), getStringHeight(), MultiCell(), openHTMLTagHandler(), setTableHeader(), Write(), write1DBarcode(), and writeHTML().
◆ $check_page_regions
|
protected |
Boolean value true when page region check is active.
Definition at line 1561 of file tcpdf.php.
Referenced by MultiCell().
◆ $clMargin
|
protected |
◆ $cntmrk
|
protected |
◆ $ColorFlag
|
protected |
◆ $column_start_page
|
protected |
◆ $columns
|
protected |
◆ $colxshift
|
protected |
◆ $compress
|
protected |
Compression flag.
Definition at line 184 of file tcpdf.php.
Referenced by _putimages(), _putpages(), _puttruetypeunicode(), and SetCompression().
◆ $CoreFonts
◆ $creator
|
protected |
◆ $crMargin
|
protected |
◆ $CurOrientation
|
protected |
Current page orientation (P = Portrait, L = Landscape).
Definition at line 190 of file tcpdf.php.
Referenced by _beginpage(), and setPageOrientation().
◆ $current_column
|
protected |
Current column number.
- Since
- 4.9.001 (2010-03-28)
Definition at line 1436 of file tcpdf.php.
Referenced by MultiCell(), and writeHTML().
◆ $CurrentFont
◆ $currpagegroup
|
protected |
Current page group number.
- Since
- 3.0.000 (2008-03-27)
Definition at line 903 of file tcpdf.php.
Referenced by _beginpage(), and getGroupPageNo().
◆ $custom_xmp
|
protected |
◆ $customlistindent
|
protected |
HTML PARSER: custom indent amount for lists.
Negative value means disabled.
- Since
- 4.2.007 (2008-11-12)
Definition at line 1106 of file tcpdf.php.
Referenced by writeHTML().
◆ $default_form_prop
|
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.
- Since
- 4.8.000 (2009-09-07)
Definition at line 1338 of file tcpdf.php.
Referenced by getFormDefaultProp().
◆ $default_graphic_vars
|
protected |
◆ $default_monospaced_font
|
protected |
Default monospace font.
- Since
- 4.5.025 (2009-03-10)
Definition at line 1219 of file tcpdf.php.
Referenced by getHtmlDomArray().
◆ $default_table_columns
|
protected |
◆ $dests
|
protected |
A dictionary of names and corresponding destinations (Dests key on document Catalog).
- Since
- 5.9.097 (2011-06-23)
Definition at line 1575 of file tcpdf.php.
Referenced by getDestination(), and startPage().
◆ $diffs
|
protected |
◆ $doc_creation_timestamp
|
protected |
Document creation date-time.
- Since
- 5.9.152 (2012-03-22)
Definition at line 1765 of file tcpdf.php.
Referenced by __construct(), _datestring(), and getDocCreationTimestamp().
◆ $doc_modification_timestamp
|
protected |
Document modification date-time.
- Since
- 5.9.152 (2012-03-22)
Definition at line 1772 of file tcpdf.php.
Referenced by getDocModificationTimestamp().
◆ $docinfounicode
|
protected |
◆ $dpi
|
protected |
DPI (Dot Per Inch) Document Resolution (do not change).
- Since
- 3.0.000 (2008-03-27)
Definition at line 882 of file tcpdf.php.
Referenced by Image(), ImagePngAlpha(), and setPageUnit().
◆ $DrawColor
◆ $efnames
|
protected |
◆ $embeddedfiles
|
protected |
◆ $empty_signature_appearance
|
protected |
◆ $emptypagemrk
|
protected |
◆ $encoding
|
protected |
Default encoding.
- Since
- 1.53.0.TC010
Definition at line 771 of file tcpdf.php.
Referenced by __construct().
◆ $encryptdata
|
protected |
◆ $encrypted
|
protected |
◆ $endlinex
|
protected |
◆ $epsmarker
|
protected |
◆ $extgstates
|
protected |
◆ $feps
|
protected |
Epsilon value used for float calculations.
- Since
- 4.2.000 (2008-10-29)
Definition at line 1092 of file tcpdf.php.
Referenced by writeHTML().
◆ $fgcolor
|
protected |
Current foreground color.
Definition at line 716 of file tcpdf.php.
Referenced by addHtmlLink(), Cell(), and getHtmlDomArray().
◆ $fhPt
|
protected |
Height of page format in points.
Definition at line 214 of file tcpdf.php.
Referenced by setPageOrientation().
◆ $file_id
|
protected |
◆ $FillColor
◆ $font_obj_ids
|
protected |
◆ $font_spacing
|
protected |
Increases or decreases the space between characters in a text by the specified amount (tracking).
- Since
- 5.9.000 (2010-09-29)
Definition at line 1547 of file tcpdf.php.
Referenced by getCellCode(), GetCharWidth(), getHtmlDomArray(), and writeHTML().
◆ $font_stretching
|
protected |
Percentage of character stretching.
- Since
- 5.9.000 (2010-09-29)
Definition at line 1540 of file tcpdf.php.
Referenced by getCellCode(), getHtmlDomArray(), and writeHTML().
◆ $font_subsetting
|
protected |
◆ $FontAscent
|
protected |
Current font ascent (distance between font top and baseline).
- Since
- 2.8.000 (2007-03-29)
Definition at line 379 of file tcpdf.php.
Referenced by getCellCode().
◆ $FontDescent
|
protected |
Current font descent (distance between font bottom and baseline).
- Since
- 2.8.000 (2007-03-29)
Definition at line 386 of file tcpdf.php.
Referenced by getCellCode().
◆ $FontFamily
|
protected |
Current font family.
Definition at line 366 of file tcpdf.php.
Referenced by AddFont(), GetArrStringWidth(), getFontFamily(), getHtmlDomArray(), isCharDefined(), replaceMissingChars(), and writeHTML().
◆ $FontFiles
|
protected |
◆ $fontkeys
|
protected |
◆ $fontlist
|
protected |
◆ $fonts
◆ $FontSize
|
protected |
Current font size in user unit.
Definition at line 416 of file tcpdf.php.
Referenced by getCellCode(), getFontSize(), and writeHTML().
◆ $FontSizePt
|
protected |
Current font size in points.
Definition at line 410 of file tcpdf.php.
Referenced by _dolinethroughw(), _dooverlinew(), _dounderlinew(), GetArrStringWidth(), getFontSizePt(), getHtmlDomArray(), MultiCell(), SetFont(), and writeHTML().
◆ $FontStyle
|
protected |
Current font style.
Definition at line 372 of file tcpdf.php.
Referenced by addHtmlLink(), GetArrStringWidth(), getFontStyle(), getHtmlDomArray(), and writeHTML().
◆ $footer_font
|
protected |
Default font used on page footer.
Definition at line 607 of file tcpdf.php.
Referenced by getFooterFont().
◆ $footer_line_color
|
protected |
◆ $footer_margin
|
protected |
Minimum distance between footer and bottom page margin.
Definition at line 581 of file tcpdf.php.
Referenced by getFooterMargin(), and setFooter().
◆ $footer_text_color
|
protected |
◆ $footerlen
|
protected |
◆ $footerpos
|
protected |
◆ $force_srgb
|
protected |
◆ $form_action
|
protected |
Current form action (used during XHTML rendering).
- Since
- 4.8.000 (2009-09-07)
Definition at line 1352 of file tcpdf.php.
Referenced by openHTMLTagHandler().
◆ $form_enctype
|
protected |
◆ $form_mode
|
protected |
◆ $form_obj_id
|
protected |
◆ $fwPt
|
protected |
Width of page format in points.
Definition at line 208 of file tcpdf.php.
Referenced by setPageOrientation().
◆ $gdgammacache
|
protected |
◆ $gradients
|
protected |
◆ $h
|
protected |
Current height of page in user unit.
Definition at line 238 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().
◆ $header_font
|
protected |
Default font used on page header.
Definition at line 601 of file tcpdf.php.
Referenced by getHeaderFont().
◆ $header_line_color
|
protected |
Color for header line (RGB array).
- Since
- 5.9.174 (2012-07-25)
Definition at line 669 of file tcpdf.php.
Referenced by getHeaderData().
◆ $header_logo
|
protected |
◆ $header_logo_width
|
protected |
Width of header image logo in user units.
Definition at line 643 of file tcpdf.php.
Referenced by getHeaderData().
◆ $header_margin
|
protected |
Minimum distance between header and top page margin.
Definition at line 575 of file tcpdf.php.
Referenced by getHeaderMargin(), and Header().
◆ $header_string
|
protected |
String to pring on page header after title.
Definition at line 655 of file tcpdf.php.
Referenced by getHeaderData().
◆ $header_text_color
|
protected |
Color for header text (RGB array).
- Since
- 5.9.174 (2012-07-25)
Definition at line 662 of file tcpdf.php.
Referenced by getHeaderData().
◆ $header_title
|
protected |
Title to be printed on default page header.
Definition at line 649 of file tcpdf.php.
Referenced by getHeaderData().
◆ $header_xobj_autoreset
|
protected |
◆ $header_xobjid
|
protected |
◆ $hPt
|
protected |
Current height of page in points.
Definition at line 226 of file tcpdf.php.
Referenced by setPageOrientation().
◆ $HREF
|
protected |
◆ $htmlLinkColorArray
|
protected |
Default color for html links.
- Since
- 4.4.003 (2008-12-09)
Definition at line 1142 of file tcpdf.php.
Referenced by getHtmlDomArray().
◆ $htmlLinkFontStyle
|
protected |
Default font style to add to html links.
- Since
- 4.4.003 (2008-12-09)
Definition at line 1149 of file tcpdf.php.
Referenced by getHtmlDomArray().
◆ $htmlvspace
|
protected |
◆ $imagekeys
|
protected |
◆ $images
◆ $img_rb_x
|
protected |
The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
- Since
- 2002-07-31
Definition at line 526 of file tcpdf.php.
Referenced by getImageRBX(), Image(), ImageEps(), write1DBarcode(), and write2DBarcode().
◆ $img_rb_y
|
protected |
The right-bottom corner Y coordinate of last inserted image.
- Since
- 2002-07-31
Definition at line 534 of file tcpdf.php.
Referenced by getImageRBY(), Image(), ImageEps(), write1DBarcode(), and write2DBarcode().
◆ $imgscale
|
protected |
Adjusting factor to convert pixels to user units.
- Since
- 2004-06-14
Definition at line 542 of file tcpdf.php.
Referenced by getImageScale().
◆ $InFooter
|
protected |
◆ $InHeader
|
protected |
◆ $internal_encoding
|
protected |
◆ $inthead
|
protected |
◆ $intmrk
|
protected |
◆ $inxobj
|
protected |
◆ $isunicode
|
protected |
Boolean flag set to true when the input text is unicode (require unicode fonts).
- Since
- 2005-01-02
Definition at line 550 of file tcpdf.php.
Referenced by _putinfo(), and _putXMP().
◆ $javascript
|
protected |
◆ $jpeg_quality
|
protected |
◆ $js_objects
|
protected |
◆ $k
|
protected |
Scale factor (number of points in user unit).
Definition at line 202 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(), MultiCell(), openHTMLTagHandler(), RadioButton(), replaceMissingChars(), Rotate(), Scale(), setColorArray(), SetFontSize(), setPageOrientation(), Skew(), Translate(), write1DBarcode(), and writeHTML().
◆ $keywords
|
protected |
◆ $l
|
protected |
Language templates.
Definition at line 613 of file tcpdf.php.
Referenced by _putannotsobjs(), _putbookmarks(), and Write().
◆ $last_enc_key
|
protected |
◆ $last_enc_key_c
|
protected |
◆ $lasth
|
protected |
Height of last cell printed.
Definition at line 306 of file tcpdf.php.
Referenced by getLastH(), getNumLines(), getStringHeight(), Ln(), setFooter(), setHeader(), and writeHTML().
◆ $LayoutMode
◆ $linestyleCap
|
protected |
◆ $linestyleDash
|
protected |
◆ $linestyleJoin
|
protected |
◆ $linestyleWidth
|
protected |
◆ $linethrough
|
protected |
◆ $LineWidth
|
protected |
Line width in user unit.
Definition at line 312 of file tcpdf.php.
Referenced by adjustCellPadding(), Arrow(), getCellBorder(), and GetLineWidth().
◆ $links
|
protected |
◆ $lispacer
|
protected |
◆ $listcount
|
protected |
HTML PARSER: array count list items on nested lists.
Definition at line 728 of file tcpdf.php.
Referenced by writeHTML().
◆ $listindent
|
protected |
HTML PARSER: indent amount for lists.
Definition at line 740 of file tcpdf.php.
Referenced by openHTMLTagHandler().
◆ $listindentlevel
|
protected |
HTML PARSER: current list indententation level.
Definition at line 746 of file tcpdf.php.
Referenced by openHTMLTagHandler().
◆ $listnum
|
protected |
HTML PARSER: current list nesting level.
Definition at line 734 of file tcpdf.php.
Referenced by openHTMLTagHandler(), and writeHTML().
◆ $listordered
|
protected |
HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
Definition at line 722 of file tcpdf.php.
Referenced by writeHTML().
◆ $lisymbol
|
protected |
Symbol used for HTML unordered list items.
- Since
- 4.0.028 (2008-09-26)
Definition at line 1057 of file tcpdf.php.
Referenced by openHTMLTagHandler().
◆ $lMargin
|
protected |
Left margin.
Definition at line 244 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().
◆ $maxselcol
|
protected |
◆ $n
|
protected |
Current object number.
Definition at line 148 of file tcpdf.php.
Referenced by _datastring(), _datestring(), _encrypt_data(), _enddoc(), _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _objectkey(), _putannotsobjs(), _putAPXObject(), _putbookmarks(), _putfonts(), _putpages(), _putshaders(), _putspotcolors(), _textstring(), addEmptySignatureAppearance(), addExtGState(), addJavascriptObject(), AddLink(), Button(), CoonsPatchMesh(), Gradient(), RadioButton(), setSignature(), and TextField().
◆ $n_dests
|
protected |
◆ $n_js
|
protected |
◆ $newline
|
protected |
Boolean flag to indicate if a new line is created.
- Since
- 3.2.000 (2008-07-01)
Definition at line 994 of file tcpdf.php.
Referenced by setHeader(), and writeHTML().
◆ $newpagegroup
|
protected |
Array of page numbers were a new page group was started (the page numbers are the keys of the array).
- Since
- 3.0.000 (2008-03-27)
Definition at line 889 of file tcpdf.php.
Referenced by startPageGroup().
◆ $num_columns
|
protected |
Number of colums.
- Since
- 4.9.001 (2010-03-28)
Definition at line 1429 of file tcpdf.php.
Referenced by MultiCell().
◆ $numfonts
|
protected |
◆ $numimages
|
protected |
◆ $numpages
|
protected |
Counts the number of pages.
- Since
- 4.5.000 (2008-12-31)
Definition at line 1156 of file tcpdf.php.
Referenced by _putannotsobjs(), _putpages(), getNumPages(), startPage(), and writeHTML().
◆ $objcopy
|
protected |
◆ $offsets
|
protected |
◆ $opencell
|
protected |
◆ $openMarkedContent
|
protected |
◆ $original_lMargin
|
protected |
Original left margin value.
- Since
- 1.53.0.TC013
Definition at line 588 of file tcpdf.php.
Referenced by Header(), setFooter(), setHeader(), and setPageOrientation().
◆ $original_rMargin
|
protected |
Original right margin value.
- Since
- 1.53.0.TC013
Definition at line 595 of file tcpdf.php.
Referenced by Header(), setFooter(), setHeader(), and setPageOrientation().
◆ $OutlineRoot
|
protected |
◆ $outlines
|
protected |
Outlines for bookmark.
- Since
- 2.1.002 (2008-02-12)
Definition at line 838 of file tcpdf.php.
Referenced by startPage().
◆ $overline
◆ $overprint
|
protected |
Overprint mode array.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
- Since
- 5.9.152 (2012-03-23)
Definition at line 1787 of file tcpdf.php.
Referenced by getOverprint().
◆ $page
|
protected |
Current page number.
Definition at line 142 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().
◆ $page_boxes
|
protected |
◆ $page_obj_id
|
protected |
◆ $page_regions
|
protected |
◆ $PageAnnots
|
protected |
◆ $PageBreakTrigger
|
protected |
Threshold used to trigger page breaks.
Definition at line 452 of file tcpdf.php.
Referenced by fitBlock().
◆ $pagedim
◆ $pagegroups
|
protected |
◆ $pagelen
|
protected |
Array containing page lengths in bytes.
- Since
- 4.5.000 (2008-12-31)
Definition at line 1163 of file tcpdf.php.
Referenced by _putpages().
◆ $PageMode
|
protected |
◆ $pageobjects
|
protected |
◆ $pageopen
|
protected |
◆ $pages
◆ $pdfa_mode
|
protected |
◆ $pdflayers
|
protected |
◆ $pdfunit
|
protected |
◆ $PDFVersion
|
protected |
◆ $premode
|
protected |
◆ $print_footer
|
protected |
◆ $print_header
|
protected |
◆ $radio_groups
|
protected |
◆ $radiobutton_groups
|
protected |
◆ $rasterize_vector_images
|
protected |
◆ $re_space
|
protected |
◆ $re_spaces
|
protected |
◆ $rMargin
|
protected |
Right margin.
Definition at line 250 of file tcpdf.php.
Referenced by __construct(), _beginpage(), AddPage(), fitBlock(), getCellCode(), getCSSBorderMargin(), getCSSMargin(), getCSSPadding(), MultiCell(), openHTMLTagHandler(), SetMargins(), setPageOrientation(), setTableHeader(), SetY(), Write(), and writeHTML().
◆ $rtl
|
protected |
Boolean flag to indicate if the document language is Right-To-Left.
- Since
- 2.0.000
Definition at line 785 of file tcpdf.php.
Referenced by getRTL(), write1DBarcode(), write2DBarcode(), and writeHTML().
◆ $sig_obj_id
|
protected |
◆ $sign
|
protected |
◆ $signature_appearance
|
protected |
◆ $signature_data
|
protected |
◆ $signature_max_length
|
protected |
◆ $spot_colors
|
protected |
Array of Spot colors.
- Since
- 4.0.024 (2008-09-12)
Definition at line 1050 of file tcpdf.php.
Referenced by colorRegistrationBar(), and getAllSpotColors().
◆ $start_transaction_page
|
protected |
Store page number when startTransaction() is called.
- Since
- 4.8.006 (2009-09-23)
◆ $start_transaction_y
|
protected |
Store Y position when startTransaction() is called.
- Since
- 4.9.001 (2010-03-28)
◆ $starting_page_number
|
protected |
◆ $state
◆ $strokecolor
|
protected |
Current stroke color.
- Since
- 4.9.008 (2010-04-03)
Definition at line 1478 of file tcpdf.php.
Referenced by Cell(), and getHtmlDomArray().
◆ $subject
|
protected |
◆ $svg_tag_depth
|
protected |
◆ $svgclipid
|
protected |
◆ $svgclipmode
|
protected |
◆ $svgclippaths
|
protected |
◆ $svgcliptm
|
protected |
◆ $svgdefs
|
protected |
◆ $svgdefsmode
|
protected |
◆ $svgdir
|
protected |
◆ $svggradientid
|
protected |
◆ $svggradients
|
protected |
◆ $svgstyles
|
protected |
◆ $svgtext
|
protected |
◆ $svgtextmode
|
protected |
◆ $svgunit
|
protected |
◆ $tagvspaces
|
protected |
◆ $tcpdflink
|
protected |
◆ $tempfontsize
|
protected |
◆ $TextColor
|
protected |
Commands for text color.
Definition at line 434 of file tcpdf.php.
Referenced by setColor(), and setSpotColor().
◆ $textindent
|
protected |
Text indentation value (used for text-indent CSS attribute).
- Since
- 4.8.006 (2009-09-23)
Definition at line 1394 of file tcpdf.php.
Referenced by writeHTML().
◆ $textrendermode
|
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.
- Since
- 4.9.008 (2010-04-03)
Definition at line 1464 of file tcpdf.php.
Referenced by Text().
◆ $textstrokewidth
|
protected |
Text stroke width in doc units.
- Since
- 4.9.008 (2010-04-03)
Definition at line 1471 of file tcpdf.php.
Referenced by getHtmlDomArray(), Text(), and writeHTML().
◆ $thead
|
protected |
Table header content to be repeated on each new page.
- Since
- 4.5.030 (2009-03-20)
Definition at line 1240 of file tcpdf.php.
Referenced by getHtmlDomArray(), setFooter(), setHeader(), and writeHTML().
◆ $theadMargins
|
protected |
Margins used for table header.
- Since
- 4.5.030 (2009-03-20)
Definition at line 1247 of file tcpdf.php.
Referenced by setFooter(), and setHeader().
◆ $title
|
protected |
Document title.
Definition at line 488 of file tcpdf.php.
Referenced by _putbookmarks(), MC_TCPDF\ChapterTitle(), MC_TCPDF\PrintChapter(), and SetTitle().
◆ $tMargin
|
protected |
Top margin.
Definition at line 268 of file tcpdf.php.
Referenced by _beginpage(), checkPageBreak(), fitBlock(), MultiCell(), setPageOrientation(), and setTableHeader().
◆ $tmprtl
|
protected |
◆ $tocpage
|
protected |
Boolean flag true when we are on TOC (Table Of Content) page.
Definition at line 1491 of file tcpdf.php.
Referenced by AddPage(), endPage(), and startPage().
◆ $transfmatrix
|
protected |
◆ $transfmatrix_key
|
protected |
Current key for transformation matrix.
- Since
- 4.8.005 (2009-09-17)
Definition at line 1078 of file tcpdf.php.
Referenced by StartTransform(), StopTransform(), and Transform().
◆ $transfmrk
|
protected |
◆ $tsa_data
|
protected |
◆ $tsa_timestamp
|
protected |
◆ $txtshadow
|
protected |
◆ $underline
◆ $ur
|
protected |
◆ $viewer_preferences
|
protected |
PDF viewer preferences.
- Since
- 3.1.000 (2008-06-09)
Definition at line 931 of file tcpdf.php.
Referenced by _putviewerpreferences().
◆ $w
|
protected |
Current width of page in user unit.
Definition at line 232 of file tcpdf.php.
Referenced by _addfield(), _dolinethrough(), _dolinethroughw(), _dooverline(), _dooverlinew(), _dounderline(), _dounderlinew(), _outRect(), _putAPXObject(), addEmptySignatureAppearance(), Annotation(), Bookmark(), Button(), Cell(), Clip(), MYPDF\ColoredTable(), 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().
◆ $wPt
|
protected |
Current width of page in points.
Definition at line 220 of file tcpdf.php.
Referenced by setPageOrientation(), and writeHTML().
◆ $x
|
protected |
Current horizontal position in user unit for cell positioning.
Definition at line 294 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(), registrationMarkCMYK(), 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().
◆ $xobjects
|
protected |
◆ $xobjid
|
protected |
Current XObject ID.
- Since
- 5.8.017 (2010-08-24)
Definition at line 1533 of file tcpdf.php.
Referenced by _out(), addExtGState(), AddFont(), Annotation(), CoonsPatchMesh(), Gradient(), Image(), MultiCell(), setSpotColor(), StartTransform(), Transform(), and writeHTML().
◆ $y
|
protected |
Current vertical position in user unit for cell positioning.
Definition at line 300 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(), registrationMarkCMYK(), 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().
◆ $ZoomMode
The documentation for this class was generated from the following file:
- libs/composer/vendor/tecnickcom/tcpdf/tcpdf.php
