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;
1922 $this->linestyleWidth = sprintf('%F w', ($this->LineWidth * $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:13994
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:21891
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(), getFontsList(), getGraphicVars(), TCPDF_STATIC\getRandomSeed(), PDF_FONT_NAME_MAIN, SetAutoPageBreak(), setCellMargins(), setCellPaddings(), SetCompression(), SetDisplayMode(), SetFont(), setFooterFont(), setHeaderFont(), SetMargins(), setPageFormat(), setPageUnit(), setPDFVersion(), setSpacesRE(), setTextShadow(), 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:7757
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 12581 of file tcpdf.php.
12581 {
12582 if ($this->rtl) {
12584 }
12585 // the followind avoid fields duplication after saving the document
12586 $this->javascript .= "if (getField('tcpdfdocsaved').value != 'saved') {";
12588 $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";
12589 $this->javascript .= 'f'.$name.'.textSize='.$this->FontSizePt.";\n";
12590 while (list($key, $val) = each($prop)) {
12591 if (strcmp(substr($key, -5), 'Color') == 0) {
12592 $val = TCPDF_COLORS::_JScolor($val);
12593 } else {
12594 $val = "'".$val."'";
12595 }
12596 $this->javascript .= 'f'.$name.'.'.$key.'='.$val.";\n";
12597 }
12598 if ($this->rtl) {
12599 $this->x -= $w;
12600 } else {
12601 $this->x += $w;
12602 }
12603 $this->javascript .= '}';
12604 }
References $h, $k, $w, $x, $y, and TCPDF_COLORS\_JScolor().
Referenced by Button(), ListBox(), RadioButton(), and TextField().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 10010 of file tcpdf.php.
10010 {
10011 ++$this->page;
10012 $this->pageobjects[$this->page] = array();
10014 // initialize array for graphics tranformation positions inside a page buffer
10015 $this->transfmrk[$this->page] = array();
10016 $this->state = 2;
10018 if (isset($this->CurOrientation)) {
10019 $orientation = $this->CurOrientation;
10020 } elseif ($this->fwPt > $this->fhPt) {
10021 // landscape
10022 $orientation = 'L';
10023 } else {
10024 // portrait
10025 $orientation = 'P';
10026 }
10027 }
10029 $this->pagedim[$this->page] = $this->pagedim[($this->page - 1)];
10030 $this->setPageOrientation($orientation);
10031 } else {
10032 $this->setPageFormat($format, $orientation);
10033 }
10034 if ($this->rtl) {
10035 $this->x = $this->w - $this->rMargin;
10036 } else {
10037 $this->x = $this->lMargin;
10038 }
10039 $this->y = $this->tMargin;
10040 if (isset($this->newpagegroup[$this->page])) {
10041 // start a new group
10042 $this->currpagegroup = $this->newpagegroup[$this->page];
10043 $this->pagegroups[$this->currpagegroup] = 1;
10044 } elseif (isset($this->currpagegroup) AND ($this->currpagegroup > 0)) {
10045 ++$this->pagegroups[$this->currpagegroup];
10046 }
10047 }
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 10169 of file tcpdf.php.
10169 {
10172 }
10175 }
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 10231 of file tcpdf.php.
10231 {
10234 }
10236 }
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 7757 of file tcpdf.php.
7757 {
7758 if ($destroyall AND !$preserve_objcopy) {
7759 // remove all temporary files
7761 if (!empty($tmpfiles)) {
7762 array_map('unlink', $tmpfiles);
7763 }
7764 }
7765 $preserve = array(
7766 'file_id',
7767 'internal_encoding',
7768 'state',
7769 'bufferlen',
7770 'buffer',
7771 'cached_files',
7772 'sign',
7773 'signature_data',
7774 'signature_max_length',
7775 'byterange_string',
7776 'tsa_timestamp',
7777 'tsa_data'
7778 );
7779 foreach (array_keys(get_object_vars($this)) as $val) {
7780 if ($destroyall OR !in_array($val, $preserve)) {
7781 if ((!$preserve_objcopy OR ($val != 'objcopy')) AND ($val != 'file_id') AND isset($this->$val)) {
7782 unset($this->$val);
7783 }
7784 }
7785 }
7786 }
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 7792 of file tcpdf.php.
7792 {
7793 //Check for locale-related bug
7794 if (1.1 == 1) {
7796 }
7797 //Check for decimal separator
7798 if (sprintf('%.1F', 1.0) != '1.0') {
7799 setlocale(LC_NUMERIC, 'C');
7800 }
7801 }
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().
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 10117 of file tcpdf.php.
10117 {
10120 }
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 10130 of file tcpdf.php.
10130 {
10132 return sprintf('%F %F %F %F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew + ($this->FontSizePt / 3)), $w * $this->k, $linew);
10133 }
References $FontSizePt, $w, $x, and $y.
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 10143 of file tcpdf.php.
10143 {
10146 }
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 10156 of file tcpdf.php.
10156 {
10158 return sprintf('%F %F %F %F re f', $x * $this->k, (($this->h - $y + $this->FontAscent) * $this->k) - $linew, $w * $this->k, $linew);
10159
10160 }
References $FontSizePt, $w, $x, and $y.
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 10092 of file tcpdf.php.
10092 {
10095 }
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 10105 of file tcpdf.php.
10105 {
10107 return sprintf('%F %F %F %F re f', $x * $this->k, ((($this->h - $y) * $this->k) + $linew), $w * $this->k, $linew);
10108 }
References $FontSizePt, $w, $x, and $y.
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 10463 of file tcpdf.php.
10463 {
10464 if (!$this->encrypted) {
10465 return $s;
10466 }
10467 switch ($this->encryptdata['mode']) {
10468 case 0: // RC4-40
10469 case 1: { // RC4-128
10470 $s = TCPDF_STATIC::_RC4($this->_objectkey($n), $s, $this->last_enc_key, $this->last_enc_key_c);
10471 break;
10472 }
10473 case 2: { // AES-128
10475 break;
10476 }
10477 case 3: { // AES-256
10479 break;
10480 }
10481 }
10482 return $s;
10483 }
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:10443
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 9919 of file tcpdf.php.
9919 {
9920 if (isset($this->CurrentFont['fontkey']) AND isset($this->CurrentFont['subsetchars'])) {
9921 // save subset chars of the previous font
9922 $this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
9923 }
9924 $this->state = 1;
9925 $this->_putheader();
9926 $this->_putpages();
9927 $this->_putresources();
9928 // empty signature fields
9929 if (!empty($this->empty_signature_appearance)) {
9930 foreach ($this->empty_signature_appearance as $key => $esa) {
9931 // widget annotation for empty signature
9939 $signame = $esa['name'].sprintf(' [%03d]', ($key + 1));
9945 }
9946 }
9947 // Signature
9948 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9949 // widget annotation for signature
9954 $out .= ' /P '.$this->page_obj_id[($this->signature_appearance['page'])].' 0 R'; // link to signature appearance page
9963 // signature
9964 $this->_putsignature();
9965 }
9966 // Info
9967 $objid_info = $this->_putinfo();
9968 // Catalog
9969 $objid_catalog = $this->_putcatalog();
9970 // Cross-ref
9971 $o = $this->bufferlen;
9972 // XREF section
9976 $freegen = ($this->n + 2);
9978 if (!isset($this->offsets[$i]) AND ($i > 1)) {
9980 ++$freegen;
9981 } else {
9983 }
9984 }
9985 // TRAILER
9991 if ($this->encrypted) {
9993 }
9998 $this->_out($o);
10000 $this->state = 3; // end-of-doc
10001 }
_putsignature()
Add certification signature (DocMDP or UR3) You can set only one signature type.
Definition: tcpdf.php:13290
_getobj($objid='')
Return the starting object string for the selected object ID.
Definition: tcpdf.php:10075
_putinfo()
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3....
Definition: tcpdf.php:9452
References $bufferlen, $n, $out, _getobj(), _out(), _putcatalog(), _putheader(), _putinfo(), _putpages(), _putresources(), _putsignature(), and setFontSubBuffer().
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 10053 of file tcpdf.php.
10053 {
10055 $this->state = 1;
10056 }
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 10707 of file tcpdf.php.
10707 {
10708 $psw = ''; // password to be returned
10709 $psw_array = TCPDF_FONTS::utf8Bidi(TCPDF_FONTS::UTF8StringToArray($password, $this->isunicode, $this->CurrentFont), $password, $this->rtl, $this->isunicode, $this->CurrentFont);
10710 foreach ($psw_array as $c) {
10711 $psw .= TCPDF_FONTS::unichr($c, $this->isunicode);
10712 }
10713 return substr($psw, 0, 127);
10714 }
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 10722 of file tcpdf.php.
10722 {
10723 $keybytelen = ($this->encryptdata['Length'] / 8);
10724 if (!$this->encryptdata['pubkey']) { // standard mode
10725 if ($this->encryptdata['mode'] == 3) { // AES-256
10726 // generate 256 bit random key
10727 $this->encryptdata['key'] = substr(hash('sha256', TCPDF_STATIC::getRandomSeed(), true), 0, $keybytelen);
10728 // truncate passwords
10729 $this->encryptdata['user_password'] = $this->_fixAES256Password($this->encryptdata['user_password']);
10730 $this->encryptdata['owner_password'] = $this->_fixAES256Password($this->encryptdata['owner_password']);
10731 // Compute U value
10733 // Compute UE value
10735 // Compute O value
10737 // Compute OE value
10739 // Compute P value
10740 $this->encryptdata['P'] = $this->encryptdata['protection'];
10741 // Computing the encryption dictionary's Perms (permissions) value
10742 $perms = TCPDF_STATIC::getEncPermissionsString($this->encryptdata['protection']); // bytes 0-3
10743 $perms .= chr(255).chr(255).chr(255).chr(255); // bytes 4-7
10744 if (isset($this->encryptdata['CF']['EncryptMetadata']) AND (!$this->encryptdata['CF']['EncryptMetadata'])) { // byte 8
10745 $perms .= 'F';
10746 } else {
10747 $perms .= 'T';
10748 }
10749 $perms .= 'adb'; // bytes 9-11
10750 $perms .= 'nick'; // bytes 12-15
10752 } else { // RC4-40, RC4-128, AES-128
10753 // Pad passwords
10754 $this->encryptdata['user_password'] = substr($this->encryptdata['user_password'].TCPDF_STATIC::$enc_padding, 0, 32);
10755 $this->encryptdata['owner_password'] = substr($this->encryptdata['owner_password'].TCPDF_STATIC::$enc_padding, 0, 32);
10756 // Compute O value
10758 // get default permissions (reverse byte order)
10760 // Compute encryption key
10761 $tmp = TCPDF_STATIC::_md5_16($this->encryptdata['user_password'].$this->encryptdata['O'].$permissions.$this->encryptdata['fileid']);
10762 if ($this->encryptdata['mode'] > 0) {
10763 for ($i = 0; $i < 50; ++$i) {
10764 $tmp = TCPDF_STATIC::_md5_16(substr($tmp, 0, $keybytelen));
10765 }
10766 }
10767 $this->encryptdata['key'] = substr($tmp, 0, $keybytelen);
10768 // Compute U value
10770 // Compute P value
10771 $this->encryptdata['P'] = $this->encryptdata['protection'];
10772 }
10773 } else { // Public-Key mode
10774 // random 20-byte seed
10776 $recipient_bytes = '';
10777 foreach ($this->encryptdata['pubkeys'] as $pubkey) {
10778 // for each public certificate
10779 if (isset($pubkey['p'])) {
10780 $pkprotection = TCPDF_STATIC::getUserPermissionCode($pubkey['p'], $this->encryptdata['mode']);
10781 } else {
10782 $pkprotection = $this->encryptdata['protection'];
10783 }
10784 // get default permissions (reverse byte order)
10785 $pkpermissions = TCPDF_STATIC::getEncPermissionsString($pkprotection);
10786 // envelope data
10787 $envelope = $seed.$pkpermissions;
10788 // write the envelope data to a temporary file
10791 if (!$f) {
10793 }
10794 $envelope_length = strlen($envelope);
10795 fwrite($f, $envelope, $envelope_length);
10796 fclose($f);
10798 if (!openssl_pkcs7_encrypt($tempkeyfile, $tempencfile, $pubkey['c'], array(), PKCS7_BINARY | PKCS7_DETACHED)) {
10800 }
10801 // read encryption signature
10802 $signature = file_get_contents($tempencfile, false, null, $envelope_length);
10803 // extract signature
10804 $signature = substr($signature, strpos($signature, 'Content-Disposition'));
10805 $tmparr = explode("\n\n", $signature);
10806 $signature = trim($tmparr[1]);
10807 unset($tmparr);
10808 // decode signature
10809 $signature = base64_decode($signature);
10810 // convert signature to hex
10811 $hexsignature = current(unpack('H*', $signature));
10812 // store signature on recipients array
10813 $this->encryptdata['Recipients'][] = $hexsignature;
10814 // The bytes of each item in the Recipients array of PKCS#7 objects in the order in which they appear in the array
10815 $recipient_bytes .= $signature;
10816 }
10817 // calculate encryption key
10818 if ($this->encryptdata['mode'] == 3) { // AES-256
10819 $this->encryptdata['key'] = substr(hash('sha256', $seed.$recipient_bytes, true), 0, $keybytelen);
10820 } else { // RC4-40, RC4-128, AES-128
10821 $this->encryptdata['key'] = substr(sha1($seed.$recipient_bytes, true), 0, $keybytelen);
10822 }
10823 }
10824 }
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:10707
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 8058 of file tcpdf.php.
8058 {
8059 if (!(isset($this->PageAnnots[$n]) OR ($this->sign AND isset($this->signature_data['cert_type'])))) {
8060 return '';
8061 }
8065 if (!in_array($val['n'], $this->radio_groups)) {
8067 }
8068 }
8069 // add radiobutton groups
8074 }
8075 }
8076 }
8077 }
8078 if ($this->sign AND ($n == $this->signature_appearance['page']) AND isset($this->signature_data['cert_type'])) {
8079 // set reference for signature object
8081 }
8082 if (!empty($this->empty_signature_appearance)) {
8083 foreach ($this->empty_signature_appearance as $esa) {
8085 // set reference for empty signature objects
8087 }
8088 }
8089 }
8092 }
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 10075 of file tcpdf.php.
10075 {
10076 if ($objid === '') {
10077 ++$this->n;
10078 $objid = $this->n;
10079 }
10080 $this->offsets[$objid] = $this->bufferlen;
10081 $this->pageobjects[$this->page][] = $objid;
10082 return $objid.' 0 obj';
10083 }
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 10261 of file tcpdf.php.
10261 {
10263 // default to current object
10265 }
10267 }
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 9353 of file tcpdf.php.
9353 {
9355 foreach ($this->xobjects as $id => $objid) {
9357 }
9359 }
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 10063 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 10443 of file tcpdf.php.
10443 {
10445 if ($this->encryptdata['mode'] == 2) { // AES-128
10446 // AES padding
10447 $objkey .= "\x73\x41\x6C\x54"; // sAlT
10448 }
10449 $objkey = substr(TCPDF_STATIC::_md5_16($objkey), 0, (($this->encryptdata['Length'] / 8) + 5));
10450 $objkey = substr($objkey, 0, 16);
10451 return $objkey;
10452 }
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 10694 of file tcpdf.php.
10694 {
10695 $hashkey = hash('sha256', $this->encryptdata['owner_password'].$this->encryptdata['OKS'].$this->encryptdata['U'], true);
10697 }
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 10274 of file tcpdf.php.
10274 {
10275 if ($this->state == 2) {
10276 if ($this->inxobj) {
10277 // we are inside an XObject template
10279 } elseif ((!$this->InFooter) AND isset($this->footerlen[$this->page]) AND ($this->footerlen[$this->page] > 0)) {
10280 // puts data before page footer
10281 $pagebuff = $this->getPageBuffer($this->page);
10282 $page = substr($pagebuff, 0, -$this->footerlen[$this->page]);
10283 $footer = substr($pagebuff, -$this->footerlen[$this->page]);
10285 // update footer position
10287 } else {
10288 // set page data
10290 }
10291 } elseif ($this->state > 0) {
10292 // set general data
10294 }
10295 }
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 11433 of file tcpdf.php.
11433 {
11434 if ($this->state == 2) {
11435 $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)));
11436 }
11437 }
References _out().
Referenced by _outellipticalarc(), Curve(), Polycurve(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 11449 of file tcpdf.php.
11449 {
11450 if ($this->state == 2) {
11451 $this->_out(sprintf('%F %F %F %F v', ($x2 * $this->k), (($this->h - $y2) * $this->k), ($x3 * $this->k), (($this->h - $y3) * $this->k)));
11452 }
11453 }
References _out().
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 11465 of file tcpdf.php.
11465 {
11466 if ($this->state == 2) {
11467 $this->_out(sprintf('%F %F %F %F y', ($x1 * $this->k), (($this->h - $y1) * $this->k), ($x3 * $this->k), (($this->h - $y3) * $this->k)));
11468 }
11469 }
References _out().
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 11694 of file tcpdf.php.
11694 {
11695 if (($rx <= 0) OR ($ry < 0)) {
11696 return;
11697 }
11699 if ($nc < 2) {
11700 $nc = 2;
11701 }
11702 $xmin = 2147483647;
11703 $ymin = 2147483647;
11704 $xmax = 0;
11705 $ymax = 0;
11706 if ($pie) {
11707 // center of the arc
11709 }
11710 $xang = deg2rad((float) $xang);
11711 $angs = deg2rad((float) $angs);
11712 $angf = deg2rad((float) $angf);
11713 if ($svg) {
11714 $as = $angs;
11715 $af = $angf;
11716 } else {
11717 $as = atan2((sin($angs) / $ry), (cos($angs) / $rx));
11718 $af = atan2((sin($angf) / $ry), (cos($angf) / $rx));
11719 }
11720 if ($as < 0) {
11721 $as += (2 * M_PI);
11722 }
11723 if ($af < 0) {
11724 $af += (2 * M_PI);
11725 }
11726 if ($ccw AND ($as > $af)) {
11727 // reverse rotation
11728 $as -= (2 * M_PI);
11729 } elseif (!$ccw AND ($as < $af)) {
11730 // reverse rotation
11731 $af -= (2 * M_PI);
11732 }
11733 $total_angle = ($af - $as);
11734 if ($nc < 2) {
11735 $nc = 2;
11736 }
11737 // total arcs to draw
11738 $nc *= (2 * abs($total_angle) / M_PI);
11739 $nc = round($nc) + 1;
11740 // angle of each arc
11741 $arcang = ($total_angle / $nc);
11742 // center point in PDF coordinates
11743 $x0 = $xc;
11744 $y0 = ($this->h - $yc);
11745 // starting angle
11746 $ang = $as;
11747 $alpha = sin($arcang) * ((sqrt(4 + (3 * pow(tan(($arcang) / 2), 2))) - 1) / 3);
11748 $cos_xang = cos($xang);
11749 $sin_xang = sin($xang);
11750 $cos_ang = cos($ang);
11751 $sin_ang = sin($ang);
11752 // first arc point
11753 $px1 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
11754 $py1 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
11755 // first Bezier control point
11756 $qx1 = ($alpha * ((-$rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
11757 $qy1 = ($alpha * ((-$rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
11758 if ($pie) {
11759 // line from center to arc starting point
11760 $this->_outLine($px1, $this->h - $py1);
11761 } elseif ($startpoint) {
11762 // arc starting point
11763 $this->_outPoint($px1, $this->h - $py1);
11764 }
11765 // draw arcs
11766 for ($i = 1; $i <= $nc; ++$i) {
11767 // starting angle
11768 $ang = $as + ($i * $arcang);
11769 if ($i == $nc) {
11770 $ang = $af;
11771 }
11772 $cos_ang = cos($ang);
11773 $sin_ang = sin($ang);
11774 // second arc point
11775 $px2 = $x0 + ($rx * $cos_xang * $cos_ang) - ($ry * $sin_xang * $sin_ang);
11776 $py2 = $y0 + ($rx * $sin_xang * $cos_ang) + ($ry * $cos_xang * $sin_ang);
11777 // second Bezier control point
11778 $qx2 = ($alpha * ((-$rx * $cos_xang * $sin_ang) - ($ry * $sin_xang * $cos_ang)));
11779 $qy2 = ($alpha * ((-$rx * $sin_xang * $sin_ang) + ($ry * $cos_xang * $cos_ang)));
11780 // draw arc
11781 $cx1 = ($px1 + $qx1);
11782 $cy1 = ($this->h - ($py1 + $qy1));
11783 $cx2 = ($px2 - $qx2);
11784 $cy2 = ($this->h - ($py2 - $qy2));
11785 $cx3 = $px2;
11786 $cy3 = ($this->h - $py2);
11787 $this->_outCurve($cx1, $cy1, $cx2, $cy2, $cx3, $cy3);
11788 // get bounding box coordinates
11789 $xmin = min($xmin, $cx1, $cx2, $cx3);
11790 $ymin = min($ymin, $cy1, $cy2, $cy3);
11791 $xmax = max($xmax, $cx1, $cx2, $cx3);
11792 $ymax = max($ymax, $cy1, $cy2, $cy3);
11793 // move to next point
11794 $px1 = $px2;
11795 $py1 = $py2;
11796 $qx1 = $qx2;
11797 $qy1 = $qy2;
11798 }
11799 if ($pie) {
11801 // get bounding box coordinates
11802 $xmin = min($xmin, $xc);
11803 $ymin = min($ymin, $yc);
11804 $xmax = max($xmax, $xc);
11805 $ymax = max($ymax, $yc);
11806 }
11807 return array($xmin, $ymin, $xmax, $ymax);
11808 }
_outCurve($x1, $y1, $x2, $y2, $x3, $y3)
Append a cubic Bezier curve to the current path.
Definition: tcpdf.php:11433
_outPoint($x, $y)
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line s...
Definition: tcpdf.php:11385
_outLine($x, $y)
Append a straight line segment from the current point to the point (x, y).
Definition: tcpdf.php:11399
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 11399 of file tcpdf.php.
11399 {
11400 if ($this->state == 2) {
11402 }
11403 }
References $x, $y, and _out().
Referenced by _outellipticalarc(), Line(), Polygon(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 11385 of file tcpdf.php.
11385 {
11386 if ($this->state == 2) {
11388 }
11389 }
References $x, $y, and _out().
Referenced by _outellipticalarc(), Curve(), Line(), Polycurve(), Polygon(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 11415 of file tcpdf.php.
11415 {
11416 if ($this->state == 2) {
11417 $this->_out(sprintf('%F %F %F %F re %s', ($x * $this->k), (($this->h - $y) * $this->k), ($w * $this->k), (-$h * $this->k), $op));
11418 }
11419 }
References $h, $w, $x, $y, and _out().
Referenced by Rect().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _outRestoreGraphicsState()
|
protected |
Outputs the "restore graphics state" operator 'Q'.
Definition at line 20667 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 20659 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 10656 of file tcpdf.php.
10656 {
10657 if ($this->encryptdata['mode'] < 3) { // RC4-40, RC4-128, AES-128
10659 if ($this->encryptdata['mode'] > 0) {
10660 for ($i = 0; $i < 50; ++$i) {
10661 $tmp = TCPDF_STATIC::_md5_16($tmp);
10662 }
10663 }
10664 $owner_key = substr($tmp, 0, ($this->encryptdata['Length'] / 8));
10665 $enc = TCPDF_STATIC::_RC4($owner_key, $this->encryptdata['user_password'], $this->last_enc_key, $this->last_enc_key_c);
10666 if ($this->encryptdata['mode'] > 0) {
10667 $len = strlen($owner_key);
10668 for ($i = 1; $i <= 19; ++$i) {
10669 $ek = '';
10670 for ($j = 0; $j < $len; ++$j) {
10671 $ek .= chr(ord($owner_key[$j]) ^ $i);
10672 }
10673 $enc = TCPDF_STATIC::_RC4($ek, $enc, $this->last_enc_key, $this->last_enc_key_c);
10674 }
10675 }
10676 return $enc;
10677 } elseif ($this->encryptdata['mode'] == 3) { // AES-256
10679 // Owner Validation Salt
10680 $this->encryptdata['OVS'] = substr($seed, 0, 8);
10681 // Owner Key Salt
10682 $this->encryptdata['OKS'] = substr($seed, 8, 16);
10683 return hash('sha256', $this->encryptdata['owner_password'].$this->encryptdata['OVS'].$this->encryptdata['U'], true).$this->encryptdata['OVS'].$this->encryptdata['OKS'];
10684 }
10685 }
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 8102 of file tcpdf.php.
8102 {
8103 // reset object counter
8106 // set page annotations
8109 // create annotation object for grouping radiobuttons
8110 if (isset($this->radiobutton_groups[$n][$pl['txt']]) AND is_array($this->radiobutton_groups[$n][$pl['txt']])) {
8112 $annots = '<<';
8113 $annots .= ' /Type /Annot';
8114 $annots .= ' /Subtype /Widget';
8115 $annots .= ' /Rect [0 0 0 0]';
8117 // read only
8118 $annots .= ' /F 68';
8119 $annots .= ' /Ff 49153';
8120 } else {
8121 $annots .= ' /F 4'; // default print for PDF/A
8122 $annots .= ' /Ff 49152';
8123 }
8124 $annots .= ' /T '.$this->_datastring($pl['txt'], $radio_button_obj_id);
8125 if (isset($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) {
8126 $annots .= ' /TU '.$this->_datastring($pl['opt']['tu'], $radio_button_obj_id);
8127 }
8128 $annots .= ' /FT /Btn';
8129 $annots .= ' /Kids [';
8130 $defval = '';
8133 $annots .= ' '.$data['kid'].' 0 R';
8136 }
8137 }
8138 }
8139 $annots .= ' ]';
8140 if (!empty($defval)) {
8141 $annots .= ' /V /'.$defval;
8142 }
8143 $annots .= ' >>';
8145 $this->form_obj_id[] = $radio_button_obj_id;
8146 // store object id to be used on Parent entry of Kids
8148 }
8149 $formfield = false;
8150 $pl['opt'] = array_change_key_case($pl['opt'], CASE_LOWER);
8156 // create new annotation object
8157 $annots = '<</Type /Annot';
8158 $annots .= ' /Subtype /'.$pl['opt']['subtype'];
8159 $annots .= ' /Rect ['.$rect.']';
8160 $ft = array('Btn', 'Tx', 'Ch', 'Sig');
8161 if (isset($pl['opt']['ft']) AND in_array($pl['opt']['ft'], $ft)) {
8162 $annots .= ' /FT /'.$pl['opt']['ft'];
8163 $formfield = true;
8164 }
8165 $annots .= ' /Contents '.$this->_textstring($pl['txt'], $annot_obj_id);
8168 $annots .= ' /M '.$this->_datestring($annot_obj_id, $this->doc_modification_timestamp);
8169 if (isset($pl['opt']['f'])) {
8170 $fval = 0;
8171 if (is_array($pl['opt']['f'])) {
8172 foreach ($pl['opt']['f'] as $f) {
8173 switch (strtolower($f)) {
8174 case 'invisible': {
8175 $fval += 1 << 0;
8176 break;
8177 }
8178 case 'hidden': {
8179 $fval += 1 << 1;
8180 break;
8181 }
8182 case 'print': {
8183 $fval += 1 << 2;
8184 break;
8185 }
8186 case 'nozoom': {
8187 $fval += 1 << 3;
8188 break;
8189 }
8190 case 'norotate': {
8191 $fval += 1 << 4;
8192 break;
8193 }
8194 case 'noview': {
8195 $fval += 1 << 5;
8196 break;
8197 }
8198 case 'readonly': {
8199 $fval += 1 << 6;
8200 break;
8201 }
8202 case 'locked': {
8203 $fval += 1 << 8;
8204 break;
8205 }
8206 case 'togglenoview': {
8207 $fval += 1 << 9;
8208 break;
8209 }
8210 case 'lockedcontents': {
8211 $fval += 1 << 10;
8212 break;
8213 }
8214 default: {
8215 break;
8216 }
8217 }
8218 }
8219 } else {
8220 $fval = intval($pl['opt']['f']);
8221 }
8222 } else {
8223 $fval = 4;
8224 }
8225 if ($this->pdfa_mode) {
8226 // force print flag for PDF/A mode
8227 $fval |= 4;
8228 }
8229 $annots .= ' /F '.intval($fval);
8230 if (isset($pl['opt']['as']) AND is_string($pl['opt']['as'])) {
8231 $annots .= ' /AS /'.$pl['opt']['as'];
8232 }
8233 if (isset($pl['opt']['ap'])) {
8234 // appearance stream
8235 $annots .= ' /AP <<';
8236 if (is_array($pl['opt']['ap'])) {
8237 foreach ($pl['opt']['ap'] as $apmode => $apdef) {
8238 // $apmode can be: n = normal; r = rollover; d = down;
8239 $annots .= ' /'.strtoupper($apmode);
8240 if (is_array($apdef)) {
8241 $annots .= ' <<';
8242 foreach ($apdef as $apstate => $stream) {
8243 // reference to XObject that define the appearance for this mode-state
8245 $annots .= ' /'.$apstate.' '.$apsobjid.' 0 R';
8246 }
8247 $annots .= ' >>';
8248 } else {
8249 // reference to XObject that define the appearance for this mode
8251 $annots .= ' '.$apsobjid.' 0 R';
8252 }
8253 }
8254 } else {
8255 $annots .= $pl['opt']['ap'];
8256 }
8257 $annots .= ' >>';
8258 }
8259 if (isset($pl['opt']['bs']) AND (is_array($pl['opt']['bs']))) {
8260 $annots .= ' /BS <<';
8261 $annots .= ' /Type /Border';
8262 if (isset($pl['opt']['bs']['w'])) {
8263 $annots .= ' /W '.intval($pl['opt']['bs']['w']);
8264 }
8265 $bstyles = array('S', 'D', 'B', 'I', 'U');
8266 if (isset($pl['opt']['bs']['s']) AND in_array($pl['opt']['bs']['s'], $bstyles)) {
8267 $annots .= ' /S /'.$pl['opt']['bs']['s'];
8268 }
8269 if (isset($pl['opt']['bs']['d']) AND (is_array($pl['opt']['bs']['d']))) {
8270 $annots .= ' /D [';
8271 foreach ($pl['opt']['bs']['d'] as $cord) {
8272 $annots .= ' '.intval($cord);
8273 }
8274 $annots .= ']';
8275 }
8276 $annots .= ' >>';
8277 } else {
8278 $annots .= ' /Border [';
8279 if (isset($pl['opt']['border']) AND (count($pl['opt']['border']) >= 3)) {
8280 $annots .= intval($pl['opt']['border'][0]).' ';
8281 $annots .= intval($pl['opt']['border'][1]).' ';
8282 $annots .= intval($pl['opt']['border'][2]);
8283 if (isset($pl['opt']['border'][3]) AND is_array($pl['opt']['border'][3])) {
8284 $annots .= ' [';
8285 foreach ($pl['opt']['border'][3] as $dash) {
8286 $annots .= intval($dash).' ';
8287 }
8288 $annots .= ']';
8289 }
8290 } else {
8291 $annots .= '0 0 0';
8292 }
8293 $annots .= ']';
8294 }
8295 if (isset($pl['opt']['be']) AND (is_array($pl['opt']['be']))) {
8296 $annots .= ' /BE <<';
8297 $bstyles = array('S', 'C');
8298 if (isset($pl['opt']['be']['s']) AND in_array($pl['opt']['be']['s'], $bstyles)) {
8299 $annots .= ' /S /'.$pl['opt']['bs']['s'];
8300 } else {
8301 $annots .= ' /S /S';
8302 }
8303 if (isset($pl['opt']['be']['i']) AND ($pl['opt']['be']['i'] >= 0) AND ($pl['opt']['be']['i'] <= 2)) {
8304 $annots .= ' /I '.sprintf(' %F', $pl['opt']['be']['i']);
8305 }
8306 $annots .= '>>';
8307 }
8308 if (isset($pl['opt']['c']) AND (is_array($pl['opt']['c'])) AND !empty($pl['opt']['c'])) {
8309 $annots .= ' /C '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['c']);
8310 }
8311 //$annots .= ' /StructParent ';
8312 //$annots .= ' /OC ';
8313 $markups = array('text', 'freetext', 'line', 'square', 'circle', 'polygon', 'polyline', 'highlight', 'underline', 'squiggly', 'strikeout', 'stamp', 'caret', 'ink', 'fileattachment', 'sound');
8314 if (in_array(strtolower($pl['opt']['subtype']), $markups)) {
8315 // this is a markup type
8316 if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
8317 $annots .= ' /T '.$this->_textstring($pl['opt']['t'], $annot_obj_id);
8318 }
8319 //$annots .= ' /Popup ';
8320 if (isset($pl['opt']['ca'])) {
8321 $annots .= ' /CA '.sprintf('%F', floatval($pl['opt']['ca']));
8322 }
8323 if (isset($pl['opt']['rc'])) {
8324 $annots .= ' /RC '.$this->_textstring($pl['opt']['rc'], $annot_obj_id);
8325 }
8326 $annots .= ' /CreationDate '.$this->_datestring($annot_obj_id, $this->doc_creation_timestamp);
8327 //$annots .= ' /IRT ';
8328 if (isset($pl['opt']['subj'])) {
8329 $annots .= ' /Subj '.$this->_textstring($pl['opt']['subj'], $annot_obj_id);
8330 }
8331 //$annots .= ' /RT ';
8332 //$annots .= ' /IT ';
8333 //$annots .= ' /ExData ';
8334 }
8335 $lineendings = array('Square', 'Circle', 'Diamond', 'OpenArrow', 'ClosedArrow', 'None', 'Butt', 'ROpenArrow', 'RClosedArrow', 'Slash');
8336 // Annotation types
8337 switch (strtolower($pl['opt']['subtype'])) {
8338 case 'text': {
8339 if (isset($pl['opt']['open'])) {
8340 $annots .= ' /Open '. (strtolower($pl['opt']['open']) == 'true' ? 'true' : 'false');
8341 }
8342 $iconsapp = array('Comment', 'Help', 'Insert', 'Key', 'NewParagraph', 'Note', 'Paragraph');
8343 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8344 $annots .= ' /Name /'.$pl['opt']['name'];
8345 } else {
8346 $annots .= ' /Name /Note';
8347 }
8348 $statemodels = array('Marked', 'Review');
8349 if (isset($pl['opt']['statemodel']) AND in_array($pl['opt']['statemodel'], $statemodels)) {
8350 $annots .= ' /StateModel /'.$pl['opt']['statemodel'];
8351 } else {
8352 $pl['opt']['statemodel'] = 'Marked';
8353 $annots .= ' /StateModel /'.$pl['opt']['statemodel'];
8354 }
8355 if ($pl['opt']['statemodel'] == 'Marked') {
8356 $states = array('Accepted', 'Unmarked');
8357 } else {
8358 $states = array('Accepted', 'Rejected', 'Cancelled', 'Completed', 'None');
8359 }
8360 if (isset($pl['opt']['state']) AND in_array($pl['opt']['state'], $states)) {
8361 $annots .= ' /State /'.$pl['opt']['state'];
8362 } else {
8363 if ($pl['opt']['statemodel'] == 'Marked') {
8364 $annots .= ' /State /Unmarked';
8365 } else {
8366 $annots .= ' /State /None';
8367 }
8368 }
8369 break;
8370 }
8371 case 'link': {
8372 if (is_string($pl['txt'])) {
8373 if ($pl['txt'][0] == '#') {
8374 // internal destination
8375 $annots .= ' /Dest /'.TCPDF_STATIC::encodeNameObject(substr($pl['txt'], 1));
8376 } elseif ($pl['txt'][0] == '%') {
8377 // embedded PDF file
8379 $annots .= ' /A << /S /GoToE /D [0 /Fit] /NewWindow true /T << /R /C /P '.($n - 1).' /A '.$this->embeddedfiles[$filename]['a'].' >> >>';
8380 } elseif ($pl['txt'][0] == '*') {
8381 // embedded generic file
8383 $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});';
8384 $annots .= ' /A << /S /JavaScript /JS '.$this->_textstring($jsa, $annot_obj_id).'>>';
8385 } else {
8386 $parsedUrl = parse_url($pl['txt']);
8387 if (empty($parsedUrl['scheme']) AND (strtolower(substr($parsedUrl['path'], -4)) == '.pdf')) {
8388 // relative link to a PDF file
8389 $dest = '[0 /Fit]'; // default page 0
8390 if (!empty($parsedUrl['fragment'])) {
8391 // check for named destination
8392 $tmp = explode('=', $parsedUrl['fragment']);
8393 $dest = '('.((count($tmp) == 2) ? $tmp[1] : $tmp[0]).')';
8394 }
8395 $annots .= ' /A <</S /GoToR /D '.$dest.' /F '.$this->_datastring($this->unhtmlentities($parsedUrl['path']), $annot_obj_id).' /NewWindow true>>';
8396 } else {
8397 // external URI link
8398 $annots .= ' /A <</S /URI /URI '.$this->_datastring($this->unhtmlentities($pl['txt']), $annot_obj_id).'>>';
8399 }
8400 }
8401 } elseif (isset($this->links[$pl['txt']])) {
8402 // internal link ID
8405 $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)));
8406 }
8407 }
8408 $hmodes = array('N', 'I', 'O', 'P');
8409 if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmodes)) {
8410 $annots .= ' /H /'.$pl['opt']['h'];
8411 } else {
8412 $annots .= ' /H /I';
8413 }
8414 //$annots .= ' /PA ';
8415 //$annots .= ' /Quadpoints ';
8416 break;
8417 }
8418 case 'freetext': {
8419 if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) {
8420 $annots .= ' /DA ('.$pl['opt']['da'].')';
8421 }
8422 if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) {
8423 $annots .= ' /Q '.intval($pl['opt']['q']);
8424 }
8425 if (isset($pl['opt']['rc'])) {
8426 $annots .= ' /RC '.$this->_textstring($pl['opt']['rc'], $annot_obj_id);
8427 }
8428 if (isset($pl['opt']['ds'])) {
8429 $annots .= ' /DS '.$this->_textstring($pl['opt']['ds'], $annot_obj_id);
8430 }
8431 if (isset($pl['opt']['cl']) AND is_array($pl['opt']['cl'])) {
8432 $annots .= ' /CL [';
8433 foreach ($pl['opt']['cl'] as $cl) {
8434 $annots .= sprintf('%F ', $cl * $this->k);
8435 }
8436 $annots .= ']';
8437 }
8438 $tfit = array('FreeText', 'FreeTextCallout', 'FreeTextTypeWriter');
8439 if (isset($pl['opt']['it']) AND in_array($pl['opt']['it'], $tfit)) {
8440 $annots .= ' /IT /'.$pl['opt']['it'];
8441 }
8442 if (isset($pl['opt']['rd']) AND is_array($pl['opt']['rd'])) {
8448 }
8449 if (isset($pl['opt']['le']) AND in_array($pl['opt']['le'], $lineendings)) {
8450 $annots .= ' /LE /'.$pl['opt']['le'];
8451 }
8452 break;
8453 }
8454 case 'line': {
8455 break;
8456 }
8457 case 'square': {
8458 break;
8459 }
8460 case 'circle': {
8461 break;
8462 }
8463 case 'polygon': {
8464 break;
8465 }
8466 case 'polyline': {
8467 break;
8468 }
8469 case 'highlight': {
8470 break;
8471 }
8472 case 'underline': {
8473 break;
8474 }
8475 case 'squiggly': {
8476 break;
8477 }
8478 case 'strikeout': {
8479 break;
8480 }
8481 case 'stamp': {
8482 break;
8483 }
8484 case 'caret': {
8485 break;
8486 }
8487 case 'ink': {
8488 break;
8489 }
8490 case 'popup': {
8491 break;
8492 }
8493 case 'fileattachment': {
8494 if ($this->pdfa_mode) {
8495 // embedded files are not allowed in PDF/A mode
8496 break;
8497 }
8498 if (!isset($pl['opt']['fs'])) {
8499 break;
8500 }
8504 $iconsapp = array('Graph', 'Paperclip', 'PushPin', 'Tag');
8505 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8506 $annots .= ' /Name /'.$pl['opt']['name'];
8507 } else {
8508 $annots .= ' /Name /PushPin';
8509 }
8510 // index (zero-based) of the annotation in the Annots array of this page
8512 }
8513 break;
8514 }
8515 case 'sound': {
8516 if (!isset($pl['opt']['fs'])) {
8517 break;
8518 }
8521 // ... TO BE COMPLETED ...
8522 // /R /C /B /E /CO /CP
8524 $iconsapp = array('Speaker', 'Mic');
8525 if (isset($pl['opt']['name']) AND in_array($pl['opt']['name'], $iconsapp)) {
8526 $annots .= ' /Name /'.$pl['opt']['name'];
8527 } else {
8528 $annots .= ' /Name /Speaker';
8529 }
8530 }
8531 break;
8532 }
8533 case 'movie': {
8534 break;
8535 }
8536 case 'widget': {
8537 $hmode = array('N', 'I', 'O', 'P', 'T');
8538 if (isset($pl['opt']['h']) AND in_array($pl['opt']['h'], $hmode)) {
8539 $annots .= ' /H /'.$pl['opt']['h'];
8540 }
8541 if (isset($pl['opt']['mk']) AND (is_array($pl['opt']['mk'])) AND !empty($pl['opt']['mk'])) {
8542 $annots .= ' /MK <<';
8543 if (isset($pl['opt']['mk']['r'])) {
8544 $annots .= ' /R '.$pl['opt']['mk']['r'];
8545 }
8546 if (isset($pl['opt']['mk']['bc']) AND (is_array($pl['opt']['mk']['bc']))) {
8547 $annots .= ' /BC '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bc']);
8548 }
8549 if (isset($pl['opt']['mk']['bg']) AND (is_array($pl['opt']['mk']['bg']))) {
8550 $annots .= ' /BG '.TCPDF_COLORS::getColorStringFromArray($pl['opt']['mk']['bg']);
8551 }
8552 if (isset($pl['opt']['mk']['ca'])) {
8553 $annots .= ' /CA '.$pl['opt']['mk']['ca'];
8554 }
8555 if (isset($pl['opt']['mk']['rc'])) {
8556 $annots .= ' /RC '.$pl['opt']['mk']['rc'];
8557 }
8558 if (isset($pl['opt']['mk']['ac'])) {
8559 $annots .= ' /AC '.$pl['opt']['mk']['ac'];
8560 }
8561 if (isset($pl['opt']['mk']['i'])) {
8564 $annots .= ' /I '.$info['n'].' 0 R';
8565 }
8566 }
8567 if (isset($pl['opt']['mk']['ri'])) {
8570 $annots .= ' /RI '.$info['n'].' 0 R';
8571 }
8572 }
8573 if (isset($pl['opt']['mk']['ix'])) {
8576 $annots .= ' /IX '.$info['n'].' 0 R';
8577 }
8578 }
8579 if (isset($pl['opt']['mk']['if']) AND (is_array($pl['opt']['mk']['if'])) AND !empty($pl['opt']['mk']['if'])) {
8580 $annots .= ' /IF <<';
8581 $if_sw = array('A', 'B', 'S', 'N');
8582 if (isset($pl['opt']['mk']['if']['sw']) AND in_array($pl['opt']['mk']['if']['sw'], $if_sw)) {
8583 $annots .= ' /SW /'.$pl['opt']['mk']['if']['sw'];
8584 }
8585 $if_s = array('A', 'P');
8586 if (isset($pl['opt']['mk']['if']['s']) AND in_array($pl['opt']['mk']['if']['s'], $if_s)) {
8587 $annots .= ' /S /'.$pl['opt']['mk']['if']['s'];
8588 }
8589 if (isset($pl['opt']['mk']['if']['a']) AND (is_array($pl['opt']['mk']['if']['a'])) AND !empty($pl['opt']['mk']['if']['a'])) {
8590 $annots .= sprintf(' /A [%F %F]', $pl['opt']['mk']['if']['a'][0], $pl['opt']['mk']['if']['a'][1]);
8591 }
8592 if (isset($pl['opt']['mk']['if']['fb']) AND ($pl['opt']['mk']['if']['fb'])) {
8593 $annots .= ' /FB true';
8594 }
8595 $annots .= '>>';
8596 }
8597 if (isset($pl['opt']['mk']['tp']) AND ($pl['opt']['mk']['tp'] >= 0) AND ($pl['opt']['mk']['tp'] <= 6)) {
8598 $annots .= ' /TP '.intval($pl['opt']['mk']['tp']);
8599 }
8600 $annots .= '>>';
8601 } // end MK
8602 // --- Entries for field dictionaries ---
8604 // set parent
8606 }
8607 if (isset($pl['opt']['t']) AND is_string($pl['opt']['t'])) {
8608 $annots .= ' /T '.$this->_datastring($pl['opt']['t'], $annot_obj_id);
8609 }
8610 if (isset($pl['opt']['tu']) AND is_string($pl['opt']['tu'])) {
8611 $annots .= ' /TU '.$this->_datastring($pl['opt']['tu'], $annot_obj_id);
8612 }
8613 if (isset($pl['opt']['tm']) AND is_string($pl['opt']['tm'])) {
8614 $annots .= ' /TM '.$this->_datastring($pl['opt']['tm'], $annot_obj_id);
8615 }
8616 if (isset($pl['opt']['ff'])) {
8617 if (is_array($pl['opt']['ff'])) {
8618 // array of bit settings
8619 $flag = 0;
8620 foreach($pl['opt']['ff'] as $val) {
8621 $flag += 1 << ($val - 1);
8622 }
8623 } else {
8624 $flag = intval($pl['opt']['ff']);
8625 }
8626 $annots .= ' /Ff '.$flag;
8627 }
8628 if (isset($pl['opt']['maxlen'])) {
8629 $annots .= ' /MaxLen '.intval($pl['opt']['maxlen']);
8630 }
8631 if (isset($pl['opt']['v'])) {
8632 $annots .= ' /V';
8633 if (is_array($pl['opt']['v'])) {
8634 foreach ($pl['opt']['v'] AS $optval) {
8635 if (is_float($optval)) {
8636 $optval = sprintf('%F', $optval);
8637 }
8638 $annots .= ' '.$optval;
8639 }
8640 } else {
8641 $annots .= ' '.$this->_textstring($pl['opt']['v'], $annot_obj_id);
8642 }
8643 }
8644 if (isset($pl['opt']['dv'])) {
8645 $annots .= ' /DV';
8646 if (is_array($pl['opt']['dv'])) {
8647 foreach ($pl['opt']['dv'] AS $optval) {
8648 if (is_float($optval)) {
8649 $optval = sprintf('%F', $optval);
8650 }
8651 $annots .= ' '.$optval;
8652 }
8653 } else {
8654 $annots .= ' '.$this->_textstring($pl['opt']['dv'], $annot_obj_id);
8655 }
8656 }
8657 if (isset($pl['opt']['rv'])) {
8658 $annots .= ' /RV';
8659 if (is_array($pl['opt']['rv'])) {
8660 foreach ($pl['opt']['rv'] AS $optval) {
8661 if (is_float($optval)) {
8662 $optval = sprintf('%F', $optval);
8663 }
8664 $annots .= ' '.$optval;
8665 }
8666 } else {
8667 $annots .= ' '.$this->_textstring($pl['opt']['rv'], $annot_obj_id);
8668 }
8669 }
8670 if (isset($pl['opt']['a']) AND !empty($pl['opt']['a'])) {
8671 $annots .= ' /A << '.$pl['opt']['a'].' >>';
8672 }
8673 if (isset($pl['opt']['aa']) AND !empty($pl['opt']['aa'])) {
8674 $annots .= ' /AA << '.$pl['opt']['aa'].' >>';
8675 }
8676 if (isset($pl['opt']['da']) AND !empty($pl['opt']['da'])) {
8677 $annots .= ' /DA ('.$pl['opt']['da'].')';
8678 }
8679 if (isset($pl['opt']['q']) AND ($pl['opt']['q'] >= 0) AND ($pl['opt']['q'] <= 2)) {
8680 $annots .= ' /Q '.intval($pl['opt']['q']);
8681 }
8682 if (isset($pl['opt']['opt']) AND (is_array($pl['opt']['opt'])) AND !empty($pl['opt']['opt'])) {
8683 $annots .= ' /Opt [';
8684 foreach($pl['opt']['opt'] AS $copt) {
8685 if (is_array($copt)) {
8686 $annots .= ' ['.$this->_textstring($copt[0], $annot_obj_id).' '.$this->_textstring($copt[1], $annot_obj_id).']';
8687 } else {
8688 $annots .= ' '.$this->_textstring($copt, $annot_obj_id);
8689 }
8690 }
8691 $annots .= ']';
8692 }
8693 if (isset($pl['opt']['ti'])) {
8694 $annots .= ' /TI '.intval($pl['opt']['ti']);
8695 }
8696 if (isset($pl['opt']['i']) AND (is_array($pl['opt']['i'])) AND !empty($pl['opt']['i'])) {
8697 $annots .= ' /I [';
8698 foreach($pl['opt']['i'] AS $copt) {
8699 $annots .= intval($copt).' ';
8700 }
8701 $annots .= ']';
8702 }
8703 break;
8704 }
8705 case 'screen': {
8706 break;
8707 }
8708 case 'printermark': {
8709 break;
8710 }
8711 case 'trapnet': {
8712 break;
8713 }
8714 case 'watermark': {
8715 break;
8716 }
8717 case '3d': {
8718 break;
8719 }
8720 default: {
8721 break;
8722 }
8723 }
8724 $annots .= '>>';
8725 // create new annotation object
8728 // store reference of form object
8729 $this->form_obj_id[] = $annot_obj_id;
8730 }
8731 }
8732 }
8733 } // end for each page
8734 }
_putAPXObject($w=0, $h=0, $stream='')
Put appearance streams XObject used to define annotation's appearance states.
Definition: tcpdf.php:8745
References $d, $data, $filename, $info, $k, $l, $n, $numpages, $r, $t, _datastring(), _getobj(), _out(), _putAPXObject(), _textstring(), getImageBuffer(), and unhtmlentities().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 8745 of file tcpdf.php.
8745 {
8746 $stream = trim($stream);
8748 $this->xobjects['AX'.$this->n] = array('n' => $this->n);
8753 if ($this->compress) {
8754 $stream = gzcompress($stream);
8756 }
8761 $stream = $this->_getrawstream($stream);
8768 }
References $h, $n, $out, $w, _getobj(), _getrawstream(), and _out().
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 12368 of file tcpdf.php.
12368 {
12369 $nb = count($this->outlines);
12370 if ($nb == 0) {
12371 return;
12372 }
12373 // sort bookmarks
12374 $this->sortBookmarks();
12375 $lru = array();
12376 $level = 0;
12377 foreach ($this->outlines as $i => $o) {
12378 if ($o['l'] > 0) {
12379 $parent = $lru[($o['l'] - 1)];
12380 //Set parent and last pointers
12381 $this->outlines[$i]['parent'] = $parent;
12382 $this->outlines[$parent]['last'] = $i;
12383 if ($o['l'] > $level) {
12384 //Level increasing: set first pointer
12385 $this->outlines[$parent]['first'] = $i;
12386 }
12387 } else {
12388 $this->outlines[$i]['parent'] = $nb;
12389 }
12390 if (($o['l'] <= $level) AND ($i > 0)) {
12391 //Set prev and next pointers
12392 $prev = $lru[$o['l']];
12393 $this->outlines[$prev]['next'] = $i;
12394 $this->outlines[$i]['prev'] = $prev;
12395 }
12396 $lru[$o['l']] = $i;
12397 $level = $o['l'];
12398 }
12399 //Outline items
12400 $n = $this->n + 1;
12401 $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';
12402 foreach ($this->outlines as $i => $o) {
12403 $oid = $this->_newobj();
12404 // covert HTML title to string
12412 if (isset($o['prev'])) {
12414 }
12415 if (isset($o['next'])) {
12417 }
12418 if (isset($o['first'])) {
12420 }
12421 if (isset($o['last'])) {
12423 }
12424 if (isset($o['u']) AND !empty($o['u'])) {
12425 // link
12426 if (is_string($o['u'])) {
12427 if ($o['u'][0] == '#') {
12428 // internal destination
12430 } elseif ($o['u'][0] == '%') {
12431 // embedded PDF file
12433 $out .= ' /A <</S /GoToE /D [0 /Fit] /NewWindow true /T << /R /C /P '.($o['p'] - 1).' /A '.$this->embeddedfiles[$filename]['a'].' >> >>';
12434 } elseif ($o['u'][0] == '*') {
12435 // embedded generic file
12437 $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});';
12439 } else {
12440 // external URI link
12442 }
12443 } elseif (isset($this->links[$o['u']])) {
12444 // internal link ID
12447 $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)));
12448 }
12449 }
12450 } elseif (isset($this->page_obj_id[($o['p'])])) {
12451 // link to a page
12452 $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)));
12453 }
12454 // set font style
12455 $style = 0;
12456 if (!empty($o['s'])) {
12457 // bold
12458 if (strpos($o['s'], 'B') !== false) {
12459 $style |= 2;
12460 }
12461 // oblique
12462 if (strpos($o['s'], 'I') !== false) {
12463 $style |= 1;
12464 }
12465 }
12467 // set bookmark color
12468 if (isset($o['c']) AND is_array($o['c']) AND (count($o['c']) == 3)) {
12469 $color = array_values($o['c']);
12471 } else {
12472 // black
12474 }
12479 }
12480 //Outline root
12481 $this->OutlineRoot = $this->_newobj();
12482 $this->_out('<< /Type /Outlines /First '.$n.' 0 R /Last '.($n + $lru[0]).' 0 R >>'."\n".'endobj');
12483 }
References $filename, $l, $n, $out, $style, $title, _newobj(), _out(), sortBookmarks(), 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 9651 of file tcpdf.php.
9651 {
9652 // put XMP
9653 $xmpobj = $this->_putXMP();
9654 // if required, add standard sRGB_IEC61966-2.1 blackscaled ICC colour profile
9655 if ($this->pdfa_mode OR $this->force_srgb) {
9656 $iccobj = $this->_newobj();
9657 $icc = file_get_contents(dirname(__FILE__).'/include/sRGB.icc');
9658 $filter = '';
9659 if ($this->compress) {
9660 $filter = ' /Filter /FlateDecode';
9661 $icc = gzcompress($icc);
9662 }
9663 $icc = $this->_getrawstream($icc);
9664 $this->_out('<</N 3 '.$filter.'/Length '.strlen($icc).'>> stream'."\n".$icc."\n".'endstream'."\n".'endobj');
9665 }
9666 // start catalog
9667 $oid = $this->_newobj();
9670 //$out .= ' /Extensions <<>>';
9672 //$out .= ' /PageLabels ' //...;
9674 if ((!$this->pdfa_mode) AND !empty($this->n_js)) {
9676 }
9677 if (!empty($this->efnames)) {
9679 foreach ($this->efnames AS $fn => $fref) {
9681 }
9683 }
9685 if (!empty($this->dests)) {
9687 }
9691 }
9694 }
9695 if (count($this->outlines) > 0) {
9698 }
9699 //$out .= ' /Threads []';
9700 if ($this->ZoomMode == 'fullpage') {
9702 } elseif ($this->ZoomMode == 'fullwidth') {
9704 } elseif ($this->ZoomMode == 'real') {
9706 } elseif (!is_string($this->ZoomMode)) {
9707 $out .= sprintf(' /OpenAction ['.$this->page_obj_id[1].' 0 R /XYZ null null %F]', ($this->ZoomMode / 100));
9708 }
9709 //$out .= ' /AA <<>>';
9710 //$out .= ' /URI <<>>';
9712 //$out .= ' /StructTreeRoot <<>>';
9713 //$out .= ' /MarkInfo <<>>';
9714 if (isset($this->l['a_meta_language'])) {
9716 }
9717 //$out .= ' /SpiderInfo <<>>';
9718 // set OutputIntent to sRGB IEC61966-2.1 if required
9719 if ($this->pdfa_mode OR $this->force_srgb) {
9729 }
9730 //$out .= ' /PieceInfo <<>>';
9731 if (!empty($this->pdflayers)) {
9732 $lyrobjs = '';
9733 $lyrobjs_off = '';
9734 $lyrobjs_lock = '';
9735 foreach ($this->pdflayers as $layer) {
9736 $layer_obj_ref = ' '.$layer['objid'].' 0 R';
9737 $lyrobjs .= $layer_obj_ref;
9738 if ($layer['view'] === false) {
9739 $lyrobjs_off .= $layer_obj_ref;
9740 }
9741 if ($layer['lock']) {
9742 $lyrobjs_lock .= $layer_obj_ref;
9743 }
9744 }
9759 //$out .= ' /RBGroups ['..']';
9760 //$out .= ' /Locked ['..']';
9763 }
9764 // AcroForm
9765 if (!empty($this->form_obj_id)
9766 OR ($this->sign AND isset($this->signature_data['cert_type']))
9767 OR !empty($this->empty_signature_appearance)) {
9769 $objrefs = '';
9770 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9771 // set reference for signature object
9772 $objrefs .= $this->sig_obj_id.' 0 R';
9773 }
9774 if (!empty($this->empty_signature_appearance)) {
9775 foreach ($this->empty_signature_appearance as $esa) {
9776 // set reference for empty signature objects
9777 $objrefs .= ' '.$esa['objid'].' 0 R';
9778 }
9779 }
9780 if (!empty($this->form_obj_id)) {
9781 foreach($this->form_obj_id as $objid) {
9782 $objrefs .= ' '.$objid.' 0 R';
9783 }
9784 }
9786 // It's better to turn off this value and set the appearance stream for each annotation (/AP) to avoid conflicts with signature fields.
9787 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
9789 }
9790 if ($this->sign AND isset($this->signature_data['cert_type'])) {
9791 if ($this->signature_data['cert_type'] > 0) {
9793 } else {
9795 }
9796 }
9797 //$out .= ' /CO ';
9798 if (isset($this->annotation_fonts) AND !empty($this->annotation_fonts)) {
9801 foreach ($this->annotation_fonts as $fontkey => $fontid) {
9803 }
9805 }
9809 //$out .= ' /XFA ';
9811 // signatures
9812 if ($this->sign AND isset($this->signature_data['cert_type'])
9813 AND (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A'))) {
9814 if ($this->signature_data['cert_type'] > 0) {
9816 } else {
9818 }
9819 }
9820 }
9821 //$out .= ' /Legal <<>>';
9822 //$out .= ' /Requirements []';
9823 //$out .= ' /Collection <<>>';
9824 //$out .= ' /NeedsRendering true';
9828 return $oid;
9829 }
References $out, _getrawstream(), _newobj(), _out(), _putviewerpreferences(), _putXMP(), TCPDF_STATIC\empty_string(), and getFontBuffer().
Referenced by _enddoc().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 9031 of file tcpdf.php.
9031 {
9032 $cidoffset = 0;
9033 if (!isset($font['cw'][1])) {
9034 $cidoffset = 31;
9035 }
9036 if (isset($font['cidinfo']['uni2cid'])) {
9037 // convert unicode to cid.
9038 $uni2cid = $font['cidinfo']['uni2cid'];
9039 $cw = array();
9040 foreach ($font['cw'] as $uni => $width) {
9041 if (isset($uni2cid[$uni])) {
9042 $cw[($uni2cid[$uni] + $cidoffset)] = $width;
9043 } elseif ($uni < 256) {
9044 $cw[$uni] = $width;
9045 } // else unknown character
9046 }
9047 $font = array_merge($font, array('cw' => $cw));
9048 }
9049 $name = $font['name'];
9050 $enc = $font['enc'];
9051 if ($enc) {
9052 $longname = $name.'-'.$enc;
9053 } else {
9054 $longname = $name;
9055 }
9061 if ($enc) {
9063 }
9068 $oid = $this->_newobj();
9072 $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry'], $oid);
9073 $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering'], $oid);
9074 $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement'];
9082 $this->_newobj();
9083 $s = '<</Type /FontDescriptor /FontName /'.$name;
9086 if (is_float($v)) {
9087 $v = sprintf('%F', $v);
9088 }
9089 $s .= ' /'.$k.' '.$v.'';
9090 }
9091 }
9092 $s .= '>>';
9093 $s .= "\n".'endobj';
9094 $this->_out($s);
9095 }
References $k, $out, _getobj(), _newobj(), and _out().
Here is the call graph for this function:
◆ _putdests()
|
protected |
Insert Named Destinations.
- Since
- 5.9.098 (2011-06-23)
Definition at line 12260 of file tcpdf.php.
12260 {
12261 if (empty($this->dests)) {
12262 return;
12263 }
12264 $this->n_dests = $this->_newobj();
12266 foreach($this->dests as $name => $o) {
12267 $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)));
12268 }
12272 }
References $out, _newobj(), and _out().
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 10491 of file tcpdf.php.
10491 {
10492 if (!$this->encrypted) {
10493 return;
10494 }
10497 if (!isset($this->encryptdata['Filter']) OR empty($this->encryptdata['Filter'])) {
10498 $this->encryptdata['Filter'] = 'Standard';
10499 }
10501 if (isset($this->encryptdata['SubFilter']) AND !empty($this->encryptdata['SubFilter'])) {
10503 }
10504 if (!isset($this->encryptdata['V']) OR empty($this->encryptdata['V'])) {
10505 $this->encryptdata['V'] = 1;
10506 }
10507 // V is a code specifying the algorithm to be used in encrypting and decrypting the document
10509 if (isset($this->encryptdata['Length']) AND !empty($this->encryptdata['Length'])) {
10510 // The length of the encryption key, in bits. The value shall be a multiple of 8, in the range 40 to 256
10512 } else {
10514 }
10515 if ($this->encryptdata['V'] >= 4) {
10516 if (!isset($this->encryptdata['StmF']) OR empty($this->encryptdata['StmF'])) {
10517 $this->encryptdata['StmF'] = 'Identity';
10518 }
10519 if (!isset($this->encryptdata['StrF']) OR empty($this->encryptdata['StrF'])) {
10520 // The name of the crypt filter that shall be used when decrypting all strings in the document.
10521 $this->encryptdata['StrF'] = 'Identity';
10522 }
10523 // A dictionary whose keys shall be crypt filter names and whose values shall be the corresponding crypt filter dictionaries.
10524 if (isset($this->encryptdata['CF']) AND !empty($this->encryptdata['CF'])) {
10528 if (isset($this->encryptdata['CF']['CFM']) AND !empty($this->encryptdata['CF']['CFM'])) {
10529 // The method used
10531 if ($this->encryptdata['pubkey']) {
10533 foreach ($this->encryptdata['Recipients'] as $rec) {
10535 }
10537 if (isset($this->encryptdata['CF']['EncryptMetadata']) AND (!$this->encryptdata['CF']['EncryptMetadata'])) {
10539 } else {
10541 }
10542 }
10543 } else {
10545 }
10546 if (isset($this->encryptdata['CF']['AuthEvent']) AND !empty($this->encryptdata['CF']['AuthEvent'])) {
10547 // The event to be used to trigger the authorization that is required to access encryption keys used by this filter.
10549 } else {
10551 }
10552 if (isset($this->encryptdata['CF']['Length']) AND !empty($this->encryptdata['CF']['Length'])) {
10553 // The bit length of the encryption key.
10555 }
10557 }
10558 // The name of the crypt filter that shall be used by default when decrypting streams.
10560 // The name of the crypt filter that shall be used when decrypting all strings in the document.
10562 if (isset($this->encryptdata['EFF']) AND !empty($this->encryptdata['EFF'])) {
10563 // The name of the crypt filter that shall be used when encrypting embedded file streams that do not have their own crypt filter specifier.
10565 }
10566 }
10567 // Additional encryption dictionary entries for the standard security handler
10568 if ($this->encryptdata['pubkey']) {
10569 if (($this->encryptdata['V'] < 4) AND isset($this->encryptdata['Recipients']) AND !empty($this->encryptdata['Recipients'])) {
10571 foreach ($this->encryptdata['Recipients'] as $rec) {
10573 }
10575 }
10576 } else {
10578 if ($this->encryptdata['V'] == 5) { // AES-256
10583 } elseif ($this->encryptdata['V'] == 4) { // AES-128
10585 } elseif ($this->encryptdata['V'] < 2) { // RC-40
10587 } else { // RC-128
10589 }
10593 if (isset($this->encryptdata['EncryptMetadata']) AND (!$this->encryptdata['EncryptMetadata'])) {
10595 } else {
10597 }
10598 }
10602 }
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 13842 of file tcpdf.php.
13842 {
13843 foreach ($this->extgstates as $i => $ext) {
13847 if (is_float($v)) {
13848 $v = sprintf('%F', $v);
13849 } elseif ($v === true) {
13850 $v = 'true';
13851 } elseif ($v === false) {
13852 $v = 'false';
13853 }
13855 }
13859 }
13860 }
References $k, $out, _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putfonts()
|
protected |
Output fonts.
Definition at line 8775 of file tcpdf.php.
8775 {
8776 $nf = $this->n;
8777 foreach ($this->diffs as $diff) {
8778 //Encodings
8779 $this->_newobj();
8780 $this->_out('<< /Type /Encoding /BaseEncoding /WinAnsiEncoding /Differences ['.$diff.'] >>'."\n".'endobj');
8781 }
8782 $mqr = TCPDF_STATIC::get_mqr();
8785 // search and get font file to embedd
8788 $font = file_get_contents($fontfile);
8791 $header = (ord($font[0]) == 128);
8793 // strip first binary header
8794 $font = substr($font, 6);
8795 }
8797 // strip second binary header
8799 }
8800 } elseif ($info['subset'] AND ((!$compressed) OR ($compressed AND function_exists('gzcompress')))) {
8801 if ($compressed) {
8802 // uncompress font
8803 $font = gzuncompress($font);
8804 }
8805 // merge subset characters
8806 $subsetchars = array(); // used chars
8808 $fontinfo = $this->getFontBuffer($fontkey);
8809 $subsetchars += $fontinfo['subsetchars'];
8810 }
8811 // rebuild a font subset
8812 $font = TCPDF_FONTS::_getTrueTypeFontSubset($font, $subsetchars);
8813 // calculate new font length
8815 if ($compressed) {
8816 // recompress font
8817 $font = gzcompress($font);
8818 }
8819 }
8820 $this->_newobj();
8822 $stream = $this->_getrawstream($font);
8824 if ($compressed) {
8826 }
8830 }
8835 }
8836 }
8837 TCPDF_STATIC::set_mqr($mqr);
8839 //Font objects
8840 $font = $this->getFontBuffer($k);
8841 $type = $font['type'];
8842 $name = $font['name'];
8843 if ($type == 'core') {
8844 // standard core font
8850 if ((strtolower($name) != 'symbol') AND (strtolower($name) != 'zapfdingbats')) {
8852 }
8854 // add default font for annotations
8856 }
8860 } elseif (($type == 'Type1') OR ($type == 'TrueType')) {
8861 // additional Type1 or TrueType font
8870 if ($font['enc']) {
8871 if (isset($font['diff'])) {
8873 } else {
8875 }
8876 }
8880 // Widths
8881 $this->_newobj();
8882 $s = '[';
8883 for ($i = 32; $i < 256; ++$i) {
8884 if (isset($font['cw'][$i])) {
8885 $s .= $font['cw'][$i].' ';
8886 } else {
8887 $s .= $font['dw'].' ';
8888 }
8889 }
8890 $s .= ']';
8891 $s .= "\n".'endobj';
8892 $this->_out($s);
8893 //Descriptor
8894 $this->_newobj();
8895 $s = '<</Type /FontDescriptor /FontName /'.$name;
8896 foreach ($font['desc'] as $fdk => $fdv) {
8897 if (is_float($fdv)) {
8898 $fdv = sprintf('%F', $fdv);
8899 }
8900 $s .= ' /'.$fdk.' '.$fdv.'';
8901 }
8903 $s .= ' /FontFile'.($type == 'Type1' ? '' : '2').' '.$this->FontFiles[$font['file']]['n'].' 0 R';
8904 }
8905 $s .= '>>';
8906 $s .= "\n".'endobj';
8907 $this->_out($s);
8908 } else {
8909 // additional types
8910 $mtd = '_put'.strtolower($type);
8911 if (!method_exists($this, $mtd)) {
8913 }
8914 $this->$mtd($font);
8915 }
8916 }
8917 }
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
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(), and TCPDF_STATIC\set_mqr().
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 9101 of file tcpdf.php.
9101 {
9105 // set object for alternate images array
9107 $altoid = $this->_newobj();
9110 if (isset($this->xobjects['I'.$altimage[0]]['n'])) {
9113 if ($altimage[1] === true) {
9115 } else {
9117 }
9119 }
9120 }
9124 }
9125 // set image object
9126 $oid = $this->_newobj();
9127 $this->xobjects['I'.$info['i']] = array('n' => $oid);
9135 }
9136 // set color space
9137 $icc = false;
9139 // ICC Colour Space
9140 $icc = true;
9143 // Indexed Colour Space
9144 $out .= ' /ColorSpace [/Indexed /DeviceRGB '.((strlen($info['pal']) / 3) - 1).' '.($this->n + 1).' 0 R]';
9145 } else {
9146 // Device Colour Space
9148 }
9151 }
9153 if (isset($altoid) AND ($altoid > 0)) {
9154 // reference to alternate images dictionary
9156 }
9158 // external stream
9163 }
9166 } else {
9169 }
9172 }
9174 $trns = '';
9178 for ($i = 0; $i < $count_info; ++$i) {
9180 // this is not a binary type mask @TODO: create a SMask
9181 $trns = '';
9182 break;
9184 // store the first fully transparent value
9185 $trns .= $i.' '.$i.' ';
9186 }
9187 }
9188 } else {
9189 // grayscale or RGB
9190 for ($i = 0; $i < $count_info; ++$i) {
9193 }
9194 }
9195 }
9196 // Colour Key Masking
9197 if (!empty($trns)) {
9199 }
9200 }
9204 }
9207 if ($icc) {
9208 // ICC colour profile
9209 $this->_newobj();
9211 $icc = $this->_getrawstream($icc);
9212 $this->_out('<</N '.$info['ch'].' /Alternate /'.$info['cs'].' '.$filter.'/Length '.strlen($icc).'>> stream'."\n".$icc."\n".'endstream'."\n".'endobj');
9214 // colour palette
9215 $this->_newobj();
9217 $pal = $this->_getrawstream($pal);
9218 $this->_out('<<'.$filter.'/Length '.strlen($pal).'>> stream'."\n".$pal."\n".'endstream'."\n".'endobj');
9219 }
9220 }
9221 }
setImageSubBuffer($image, $key, $data)
Set image buffer content for a specified sub-key.
Definition: tcpdf.php:20764
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 9452 of file tcpdf.php.
9452 {
9453 $oid = $this->_newobj();
9455 // store current isunicode value
9456 $prev_isunicode = $this->isunicode;
9457 if ($this->docinfounicode) {
9458 $this->isunicode = true;
9459 }
9461 // The document's title.
9463 }
9465 // The name of the person who created the document.
9467 }
9469 // The subject of the document.
9471 }
9473 // Keywords associated with the document.
9475 }
9477 // 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.
9479 }
9480 // restore previous isunicode value
9481 $this->isunicode = $prev_isunicode;
9482 // default producer
9484 // The date and time the document was created, in human-readable form
9486 // The date and time the document was most recently modified, in human-readable form
9488 // A name object indicating whether the document has been modified to include trapping information
9493 return $oid;
9494 }
$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 12523 of file tcpdf.php.
12523 {
12524 if ($this->pdfa_mode OR (empty($this->javascript) AND empty($this->js_objects))) {
12525 return;
12526 }
12527 if (strpos($this->javascript, 'this.addField') > 0) {
12528 if (!$this->ur['enabled']) {
12529 //$this->setUserRights();
12530 }
12531 // the following two lines are used to avoid form fields duplication after saving
12532 // The addField method only works when releasing user rights (UR3)
12533 $jsa = sprintf("ftcpdfdocsaved=this.addField('%s','%s',%d,[%F,%F,%F,%F]);", 'tcpdfdocsaved', 'text', 0, 0, 1, 0, 1);
12534 $jsb = "getField('tcpdfdocsaved').value='saved';";
12535 $this->javascript = $jsa."\n".$this->javascript."\n".$jsb;
12536 }
12537 // name tree for javascript
12538 $this->n_js = '<< /Names [';
12539 if (!empty($this->javascript)) {
12540 $this->n_js .= ' (EmbeddedJS) '.($this->n + 1).' 0 R';
12541 }
12542 if (!empty($this->js_objects)) {
12543 foreach ($this->js_objects as $key => $val) {
12544 if ($val['onload']) {
12545 $this->n_js .= ' (JS'.$key.') '.$key.' 0 R';
12546 }
12547 }
12548 }
12549 $this->n_js .= ' ] >>';
12550 // default Javascript object
12551 if (!empty($this->javascript)) {
12552 $obj_id = $this->_newobj();
12558 }
12559 // additional Javascript objects
12560 if (!empty($this->js_objects)) {
12561 foreach ($this->js_objects as $key => $val) {
12562 $out = $this->_getobj($key)."\n".' << /S /JavaScript /JS '.$this->_textstring($val['js'], $key).' >>'."\n".'endobj';
12564 }
12565 }
12566 }
References $out, _getobj(), _newobj(), and _out().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putocg()
|
protected |
Put pdf layers.
- Since
- 3.0.000 (2008-03-27)
Definition at line 13698 of file tcpdf.php.
13698 {
13699 if (empty($this->pdflayers)) {
13700 return;
13701 }
13702 foreach ($this->pdflayers as $key => $layer) {
13707 if (isset($layer['print']) AND ($layer['print'] !== NULL)) {
13709 }
13714 }
13715 }
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 7896 of file tcpdf.php.
7896 {
7898 // get internal aliases for page numbers
7899 $pnalias = $this->getAllInternalPageNumberAliases();
7900 $num_pages = $this->numpages;
7901 $ptpa = TCPDF_STATIC::formatPageNumber(($this->starting_page_number + $num_pages - 1));
7903 $ptp_num_chars = $this->GetNumChars($ptpa);
7904 $pagegroupnum = 0;
7905 $groupnum = 0;
7906 $ptgu = 1;
7907 $ptga = 1;
7908 $ptg_num_chars = 1;
7910 // get current page
7912 $pagelen = strlen($temppage);
7913 // set replacements for total pages number
7916 $pnp_num_chars = $this->GetNumChars($pnpa);
7917 $pdiff = 0; // difference used for right shift alignment of page numbers
7918 $gdiff = 0; // difference used for right shift alignment of page group numbers
7919 if (!empty($this->pagegroups)) {
7921 $pagegroupnum = 0;
7922 ++$groupnum;
7923 $ptga = TCPDF_STATIC::formatPageNumber($this->pagegroups[$groupnum]);
7925 $ptg_num_chars = $this->GetNumChars($ptga);
7926 }
7927 ++$pagegroupnum;
7928 $pnga = TCPDF_STATIC::formatPageNumber($pagegroupnum);
7930 $png_num_chars = $this->GetNumChars($pnga);
7931 // replace page numbers
7932 $replace = array();
7933 $replace[] = array($ptgu, $ptg_num_chars, 9, $pnalias[2]['u']);
7934 $replace[] = array($ptga, $ptg_num_chars, 7, $pnalias[2]['a']);
7935 $replace[] = array($pngu, $png_num_chars, 9, $pnalias[3]['u']);
7936 $replace[] = array($pnga, $png_num_chars, 7, $pnalias[3]['a']);
7937 list($temppage, $gdiff) = TCPDF_STATIC::replacePageNumAliases($temppage, $replace, $gdiff);
7938 }
7939 // replace page numbers
7940 $replace = array();
7941 $replace[] = array($ptpu, $ptp_num_chars, 9, $pnalias[0]['u']);
7942 $replace[] = array($ptpa, $ptp_num_chars, 7, $pnalias[0]['a']);
7943 $replace[] = array($pnpu, $pnp_num_chars, 9, $pnalias[1]['u']);
7944 $replace[] = array($pnpa, $pnp_num_chars, 7, $pnalias[1]['a']);
7945 list($temppage, $pdiff) = TCPDF_STATIC::replacePageNumAliases($temppage, $replace, $pdiff);
7946 // replace right shift alias
7947 $temppage = $this->replaceRightShiftPageNumAliases($temppage, $pnalias[4], max($pdiff, $gdiff));
7948 // replace EPS marker
7949 $temppage = str_replace($this->epsmarker, '', $temppage);
7950 //Page
7955 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
7957 }
7959 foreach ($this->page_boxes as $box) {
7961 $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']);
7962 }
7963 if (isset($this->pagedim[$n]['BoxColorInfo']) AND !empty($this->pagedim[$n]['BoxColorInfo'])) {
7965 foreach ($this->page_boxes as $box) {
7973 }
7976 }
7979 }
7983 foreach ($dashes as $dash) {
7985 }
7987 }
7989 }
7990 }
7992 }
7995 if (!$this->pdfa_mode) {
7997 }
7999 // page transitions
8002 }
8007 }
8010 }
8013 }
8016 }
8019 }
8022 }
8025 }
8027 }
8033 //Page content
8034 $p = ($this->compress) ? gzcompress($temppage) : $temppage;
8035 $this->_newobj();
8036 $p = $this->_getrawstream($p);
8037 $this->_out('<<'.$filter.'/Length '.strlen($p).'>> stream'."\n".$p."\n".'endstream'."\n".'endobj');
8038 }
8039 //Pages root
8042 foreach($this->page_obj_id as $page_obj) {
8044 }
8048 }
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:7848
getAllInternalPageNumberAliases()
Return an array containing all internal page aliases.
Definition: tcpdf.php:7830
References $compress, $k, $n, $numpages, $out, $pagelen, _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\formatPageNumber(), getAllInternalPageNumberAliases(), GetNumChars(), getPageBuffer(), TCPDF_STATIC\replacePageNumAliases(), replaceRightShiftPageNumAliases(), and TCPDF_FONTS\UTF8ToUTF16BE().
Referenced by _enddoc().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _putresourcedict()
|
protected |
Output Resources Dictionary.
Definition at line 9365 of file tcpdf.php.
9365 {
9369 foreach ($this->fontkeys as $fontkey) {
9370 $font = $this->getFontBuffer($fontkey);
9372 }
9377 // layers
9378 if (!empty($this->pdflayers)) {
9380 foreach ($this->pdflayers as $layer) {
9382 }
9384 }
9385 if (!$this->pdfa_mode) {
9386 // transparency
9387 if (isset($this->extgstates) AND !empty($this->extgstates)) {
9390 if (isset($extgstate['name'])) {
9392 } else {
9394 }
9396 }
9398 }
9399 if (isset($this->gradients) AND !empty($this->gradients)) {
9400 $gp = '';
9401 $gs = '';
9402 foreach ($this->gradients as $id => $grad) {
9403 // gradient patterns
9404 $gp .= ' /p'.$id.' '.$grad['pattern'].' 0 R';
9405 // gradient shadings
9406 $gs .= ' /Sh'.$id.' '.$grad['id'].' 0 R';
9407 }
9410 }
9411 }
9412 // spot colors
9413 if (isset($this->spot_colors) AND !empty($this->spot_colors)) {
9415 foreach ($this->spot_colors as $color) {
9417 }
9419 }
9423 }
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 9429 of file tcpdf.php.
9429 {
9430 $this->_putextgstates();
9431 $this->_putocg();
9432 $this->_putfonts();
9433 $this->_putimages();
9434 $this->_putspotcolors();
9435 $this->_putshaders();
9436 $this->_putxobjects();
9437 $this->_putresourcedict();
9438 $this->_putdests();
9439 $this->_putEmbeddedFiles();
9440 $this->_putannotsobjs();
9441 $this->_putjavascript();
9442 $this->_putbookmarks();
9443 $this->_putencryption();
9444 }
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 14578 of file tcpdf.php.
14578 {
14579 if ($this->pdfa_mode) {
14580 return;
14581 }
14582 $idt = count($this->gradients); //index for transparency gradients
14583 foreach ($this->gradients as $id => $grad) {
14584 if (($grad['type'] == 2) OR ($grad['type'] == 3)) {
14585 $fc = $this->_newobj();
14589 $functions = '';
14590 $bounds = '';
14591 $encode = '';
14592 $i = 1;
14593 $num_cols = count($grad['colors']);
14594 $lastcols = $num_cols - 1;
14595 for ($i = 1; $i < $num_cols; ++$i) {
14596 $functions .= ($fc + $i).' 0 R ';
14597 if ($i < $lastcols) {
14598 $bounds .= sprintf('%F ', $grad['colors'][$i]['offset']);
14599 }
14600 $encode .= '0 1 ';
14601 }
14608 for ($i = 1; $i < $num_cols; ++$i) {
14609 $this->_newobj();
14619 }
14620 // set transparency functions
14621 if ($grad['transparency']) {
14622 $ft = $this->_newobj();
14626 $functions = '';
14627 $i = 1;
14628 $num_cols = count($grad['colors']);
14629 for ($i = 1; $i < $num_cols; ++$i) {
14630 $functions .= ($ft + $i).' 0 R ';
14631 }
14638 for ($i = 1; $i < $num_cols; ++$i) {
14639 $this->_newobj();
14649 }
14650 }
14651 }
14652 // set shading object
14653 $this->_newobj();
14655 if (isset($grad['colspace'])) {
14657 } else {
14659 }
14660 if (isset($grad['background']) AND !empty($grad['background'])) {
14662 }
14663 if (isset($grad['antialias']) AND ($grad['antialias'] === true)) {
14665 }
14666 if ($grad['type'] == 2) {
14667 $out .= ' '.sprintf('/Coords [%F %F %F %F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3]);
14672 } elseif ($grad['type'] == 3) {
14673 //x0, y0, r0, x1, y1, r1
14674 //at this this time radius of inner circle is 0
14675 $out .= ' '.sprintf('/Coords [%F %F 0 %F %F %F]', $grad['coords'][0], $grad['coords'][1], $grad['coords'][2], $grad['coords'][3], $grad['coords'][4]);
14680 } elseif ($grad['type'] == 6) {
14689 }
14692 if ($grad['transparency']) {
14693 $shading_transparency = preg_replace('/\/ColorSpace \/[^\s]+/si', '/ColorSpace /DeviceGray', $out);
14694 $shading_transparency = preg_replace('/\/Function [0-9]+ /si', '/Function '.$ft.' ', $shading_transparency);
14695 }
14697 // set pattern object
14698 $this->_newobj();
14705 // set shading and pattern for transparency mask
14706 if ($grad['transparency']) {
14707 // luminosity pattern
14708 $idgs = $id + $idt;
14709 $this->_newobj();
14710 $this->_out($shading_transparency);
14712 $this->_newobj();
14719 // luminosity XObject
14720 $oid = $this->_newobj();
14721 $this->xobjects['LX'.$oid] = array('n' => $oid);
14722 $filter = '';
14723 $stream = 'q /a0 gs /Pattern cs /p'.$idgs.' scn 0 0 '.$this->wPt.' '.$this->hPt.' re f Q';
14724 if ($this->compress) {
14725 $filter = ' /Filter /FlateDecode';
14726 $stream = gzcompress($stream);
14727 }
14728 $stream = $this->_getrawstream($stream);
14731 $rect = sprintf('%F %F', $this->wPt, $this->hPt);
14742 // SMask
14743 $this->_newobj();
14746 // ExtGState
14747 $this->_newobj();
14750 $this->extgstates[] = array('n' => $this->n, 'name' => 'TGS'.$id);
14751 }
14752 }
14753 }
References $n, $out, _getrawstream(), _newobj(), and _out().
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 13290 of file tcpdf.php.
13290 {
13291 if ((!$this->sign) OR (!isset($this->signature_data['cert_type']))) {
13292 return;
13293 }
13294 $sigobjid = ($this->sig_obj_id + 1);
13301 if (empty($this->signature_data['approval']) OR ($this->signature_data['approval'] != 'A')) {
13304 if ($this->signature_data['cert_type'] > 0) {
13310 } else {
13317 }
13320 }
13323 }
13326 }
13329 }
13332 }
13333 }
13335 // optional digest data (values must be calculated and replaced later)
13336 //$out .= ' /Data ********** 0 R';
13337 //$out .= ' /DigestMethod/MD5';
13338 //$out .= ' /DigestLocation[********** 34]';
13339 //$out .= ' /DigestValue<********************************>';
13342 }
13343 if (isset($this->signature_data['info']['Name']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Name'])) {
13345 }
13346 if (isset($this->signature_data['info']['Location']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Location'])) {
13347 $out .= ' /Location '.$this->_textstring($this->signature_data['info']['Location'], $sigobjid);
13348 }
13349 if (isset($this->signature_data['info']['Reason']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['Reason'])) {
13351 }
13352 if (isset($this->signature_data['info']['ContactInfo']) AND !TCPDF_STATIC::empty_string($this->signature_data['info']['ContactInfo'])) {
13353 $out .= ' /ContactInfo '.$this->_textstring($this->signature_data['info']['ContactInfo'], $sigobjid);
13354 }
13359 }
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 9333 of file tcpdf.php.
9333 {
9334 foreach ($this->spot_colors as $name => $color) {
9335 $this->_newobj();
9340 $out .= ' '.sprintf('/C1 [%F %F %F %F] ', ($color['C'] / 100), ($color['M'] / 100), ($color['Y'] / 100), ($color['K'] / 100));
9344 }
9345 }
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 8927 of file tcpdf.php.
8927 {
8928 $fontname = '';
8929 if ($font['subset']) {
8930 // change name for font subsetting
8931 $subtag = sprintf('%06u', $font['i']);
8932 $subtag = strtr($subtag, '0123456789', 'ABCDEFGHIJ');
8933 $fontname .= $subtag.'+';
8934 }
8935 $fontname .= $font['name'];
8936 // Type0 Font
8937 // A composite font composed of other fonts, organized hierarchically
8949 // ToUnicode map for Identity-H
8950 $stream = TCPDF_FONT_DATA::$uni_identity_h;
8951 // ToUnicode Object
8952 $this->_newobj();
8953 $stream = ($this->compress) ? gzcompress($stream) : $stream;
8955 $stream = $this->_getrawstream($stream);
8956 $this->_out('<<'.$filter.'/Length '.strlen($stream).'>> stream'."\n".$stream."\n".'endstream'."\n".'endobj');
8957 // CIDFontType2
8958 // A CIDFont whose glyph descriptions are based on TrueType font technology
8959 $oid = $this->_newobj();
8963 // A dictionary containing entries that define the character collection of the CIDFont.
8964 $cidinfo = '/Registry '.$this->_datastring($font['cidinfo']['Registry'], $oid);
8965 $cidinfo .= ' /Ordering '.$this->_datastring($font['cidinfo']['Ordering'], $oid);
8966 $cidinfo .= ' /Supplement '.$font['cidinfo']['Supplement'];
8973 }
8977 // Font descriptor
8978 // A font descriptor describing the CIDFont default metrics other than its glyph widths
8979 $this->_newobj();
8982 foreach ($font['desc'] as $key => $value) {
8983 if (is_float($value)) {
8984 $value = sprintf('%F', $value);
8985 }
8987 }
8988 $fontdir = false;
8990 // A stream containing a TrueType font
8992 $fontdir = $this->FontFiles[$font['file']]['fontdir'];
8993 }
8998 $this->_newobj();
8999 // Embed CIDToGIDMap
9000 // A specification of the mapping from CIDs to glyph indices
9001 // search and get CTG font file to embedd
9002 $ctgfile = strtolower($font['ctg']);
9003 // search and get ctg font file to embedd
9004 $fontfile = TCPDF_FONTS::getFontFullPath($ctgfile, $fontdir);
9007 }
9008 $stream = $this->_getrawstream(file_get_contents($fontfile));
9010 if (substr($fontfile, -2) == '.z') { // check file extension
9011 // Decompresses data encoded using the public-domain
9012 // zlib/deflate compression method, reproducing the
9013 // original text or binary data
9015 }
9020 }
9021 }
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(), and TCPDF_FONTS\getFontFullPath().
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 9838 of file tcpdf.php.
9838 {
9839 $vp = $this->viewer_preferences;
9841 if ($this->rtl) {
9843 } else {
9845 }
9846 if (isset($vp['HideToolbar']) AND ($vp['HideToolbar'])) {
9848 }
9849 if (isset($vp['HideMenubar']) AND ($vp['HideMenubar'])) {
9851 }
9852 if (isset($vp['HideWindowUI']) AND ($vp['HideWindowUI'])) {
9854 }
9855 if (isset($vp['FitWindow']) AND ($vp['FitWindow'])) {
9857 }
9858 if (isset($vp['CenterWindow']) AND ($vp['CenterWindow'])) {
9860 }
9861 if (isset($vp['DisplayDocTitle']) AND ($vp['DisplayDocTitle'])) {
9863 }
9864 if (isset($vp['NonFullScreenPageMode'])) {
9866 }
9867 if (isset($vp['ViewArea'])) {
9869 }
9870 if (isset($vp['ViewClip'])) {
9872 }
9873 if (isset($vp['PrintArea'])) {
9875 }
9876 if (isset($vp['PrintClip'])) {
9878 }
9879 if (isset($vp['PrintScaling'])) {
9881 }
9884 }
9885 if (isset($vp['PickTrayByPDFSize'])) {
9886 if ($vp['PickTrayByPDFSize']) {
9888 } else {
9890 }
9891 }
9892 if (isset($vp['PrintPageRange'])) {
9893 $PrintPageRangeNum = '';
9895 $PrintPageRangeNum .= ' '.($v - 1).'';
9896 }
9898 }
9899 if (isset($vp['NumCopies'])) {
9901 }
9904 }
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 9513 of file tcpdf.php.
9513 {
9514 $oid = $this->_newobj();
9515 // store current isunicode value
9516 $prev_isunicode = $this->isunicode;
9517 $this->isunicode = true;
9518 $prev_encrypted = $this->encrypted;
9519 $this->encrypted = false;
9520 // set XMP data
9521 $xmp = '<?xpacket begin="'.TCPDF_FONTS::unichr(0xfeff, $this->isunicode).'" id="W5M0MpCehiHzreSzNTczkc9d"?>'."\n";
9522 $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";
9523 $xmp .= "\t".'<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">'."\n";
9524 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">'."\n";
9525 $xmp .= "\t\t\t".'<dc:format>application/pdf</dc:format>'."\n";
9526 $xmp .= "\t\t\t".'<dc:title>'."\n";
9527 $xmp .= "\t\t\t\t".'<rdf:Alt>'."\n";
9528 $xmp .= "\t\t\t\t\t".'<rdf:li xml:lang="x-default">'.TCPDF_STATIC::_escapeXML($this->title).'</rdf:li>'."\n";
9529 $xmp .= "\t\t\t\t".'</rdf:Alt>'."\n";
9530 $xmp .= "\t\t\t".'</dc:title>'."\n";
9531 $xmp .= "\t\t\t".'<dc:creator>'."\n";
9532 $xmp .= "\t\t\t\t".'<rdf:Seq>'."\n";
9534 $xmp .= "\t\t\t\t".'</rdf:Seq>'."\n";
9535 $xmp .= "\t\t\t".'</dc:creator>'."\n";
9536 $xmp .= "\t\t\t".'<dc:description>'."\n";
9537 $xmp .= "\t\t\t\t".'<rdf:Alt>'."\n";
9538 $xmp .= "\t\t\t\t\t".'<rdf:li xml:lang="x-default">'.TCPDF_STATIC::_escapeXML($this->subject).'</rdf:li>'."\n";
9539 $xmp .= "\t\t\t\t".'</rdf:Alt>'."\n";
9540 $xmp .= "\t\t\t".'</dc:description>'."\n";
9541 $xmp .= "\t\t\t".'<dc:subject>'."\n";
9542 $xmp .= "\t\t\t\t".'<rdf:Bag>'."\n";
9544 $xmp .= "\t\t\t\t".'</rdf:Bag>'."\n";
9545 $xmp .= "\t\t\t".'</dc:subject>'."\n";
9546 $xmp .= "\t\t".'</rdf:Description>'."\n";
9547 // convert doc creation date format
9548 $dcdate = TCPDF_STATIC::getFormattedDate($this->doc_creation_timestamp);
9549 $doccreationdate = substr($dcdate, 0, 4).'-'.substr($dcdate, 4, 2).'-'.substr($dcdate, 6, 2);
9550 $doccreationdate .= 'T'.substr($dcdate, 8, 2).':'.substr($dcdate, 10, 2).':'.substr($dcdate, 12, 2);
9551 $doccreationdate .= substr($dcdate, 14, 3).':'.substr($dcdate, 18, 2);
9552 $doccreationdate = TCPDF_STATIC::_escapeXML($doccreationdate);
9553 // convert doc modification date format
9554 $dmdate = TCPDF_STATIC::getFormattedDate($this->doc_modification_timestamp);
9555 $docmoddate = substr($dmdate, 0, 4).'-'.substr($dmdate, 4, 2).'-'.substr($dmdate, 6, 2);
9556 $docmoddate .= 'T'.substr($dmdate, 8, 2).':'.substr($dmdate, 10, 2).':'.substr($dmdate, 12, 2);
9557 $docmoddate .= substr($dmdate, 14, 3).':'.substr($dmdate, 18, 2);
9558 $docmoddate = TCPDF_STATIC::_escapeXML($docmoddate);
9559 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:xmp="http://ns.adobe.com/xap/1.0/">'."\n";
9560 $xmp .= "\t\t\t".'<xmp:CreateDate>'.$doccreationdate.'</xmp:CreateDate>'."\n";
9561 $xmp .= "\t\t\t".'<xmp:CreatorTool>'.$this->creator.'</xmp:CreatorTool>'."\n";
9562 $xmp .= "\t\t\t".'<xmp:ModifyDate>'.$docmoddate.'</xmp:ModifyDate>'."\n";
9563 $xmp .= "\t\t\t".'<xmp:MetadataDate>'.$doccreationdate.'</xmp:MetadataDate>'."\n";
9564 $xmp .= "\t\t".'</rdf:Description>'."\n";
9565 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">'."\n";
9566 $xmp .= "\t\t\t".'<pdf:Keywords>'.TCPDF_STATIC::_escapeXML($this->keywords).'</pdf:Keywords>'."\n";
9567 $xmp .= "\t\t\t".'<pdf:Producer>'.TCPDF_STATIC::_escapeXML(TCPDF_STATIC::getTCPDFProducer()).'</pdf:Producer>'."\n";
9568 $xmp .= "\t\t".'</rdf:Description>'."\n";
9569 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/">'."\n";
9570 $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);
9571 $xmp .= "\t\t\t".'<xmpMM:DocumentID>'.$uuid.'</xmpMM:DocumentID>'."\n";
9572 $xmp .= "\t\t\t".'<xmpMM:InstanceID>'.$uuid.'</xmpMM:InstanceID>'."\n";
9573 $xmp .= "\t\t".'</rdf:Description>'."\n";
9574 if ($this->pdfa_mode) {
9575 $xmp .= "\t\t".'<rdf:Description rdf:about="" xmlns:pdfaid="http://www.aiim.org/pdfa/ns/id/">'."\n";
9576 $xmp .= "\t\t\t".'<pdfaid:part>1</pdfaid:part>'."\n";
9577 $xmp .= "\t\t\t".'<pdfaid:conformance>B</pdfaid:conformance>'."\n";
9578 $xmp .= "\t\t".'</rdf:Description>'."\n";
9579 }
9580 // XMP extension schemas
9581 $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";
9582 $xmp .= "\t\t\t".'<pdfaExtension:schemas>'."\n";
9583 $xmp .= "\t\t\t\t".'<rdf:Bag>'."\n";
9584 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9585 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://ns.adobe.com/pdf/1.3/</pdfaSchema:namespaceURI>'."\n";
9586 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>pdf</pdfaSchema:prefix>'."\n";
9587 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>Adobe PDF Schema</pdfaSchema:schema>'."\n";
9588 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9589 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9590 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://ns.adobe.com/xap/1.0/mm/</pdfaSchema:namespaceURI>'."\n";
9591 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>xmpMM</pdfaSchema:prefix>'."\n";
9592 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>XMP Media Management Schema</pdfaSchema:schema>'."\n";
9593 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:property>'."\n";
9594 $xmp .= "\t\t\t\t\t\t\t".'<rdf:Seq>'."\n";
9595 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9596 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9597 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>UUID based identifier for specific incarnation of a document</pdfaProperty:description>'."\n";
9598 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>InstanceID</pdfaProperty:name>'."\n";
9599 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>URI</pdfaProperty:valueType>'."\n";
9600 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9601 $xmp .= "\t\t\t\t\t\t\t".'</rdf:Seq>'."\n";
9602 $xmp .= "\t\t\t\t\t\t".'</pdfaSchema:property>'."\n";
9603 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9604 $xmp .= "\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9605 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:namespaceURI>http://www.aiim.org/pdfa/ns/id/</pdfaSchema:namespaceURI>'."\n";
9606 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:prefix>pdfaid</pdfaSchema:prefix>'."\n";
9607 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:schema>PDF/A ID Schema</pdfaSchema:schema>'."\n";
9608 $xmp .= "\t\t\t\t\t\t".'<pdfaSchema:property>'."\n";
9609 $xmp .= "\t\t\t\t\t\t\t".'<rdf:Seq>'."\n";
9610 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9611 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9612 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Part of PDF/A standard</pdfaProperty:description>'."\n";
9613 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>part</pdfaProperty:name>'."\n";
9614 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Integer</pdfaProperty:valueType>'."\n";
9615 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9616 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9617 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9618 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Amendment of PDF/A standard</pdfaProperty:description>'."\n";
9619 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>amd</pdfaProperty:name>'."\n";
9620 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Text</pdfaProperty:valueType>'."\n";
9621 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9622 $xmp .= "\t\t\t\t\t\t\t\t".'<rdf:li rdf:parseType="Resource">'."\n";
9623 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:category>internal</pdfaProperty:category>'."\n";
9624 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:description>Conformance level of PDF/A standard</pdfaProperty:description>'."\n";
9625 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:name>conformance</pdfaProperty:name>'."\n";
9626 $xmp .= "\t\t\t\t\t\t\t\t\t".'<pdfaProperty:valueType>Text</pdfaProperty:valueType>'."\n";
9627 $xmp .= "\t\t\t\t\t\t\t\t".'</rdf:li>'."\n";
9628 $xmp .= "\t\t\t\t\t\t\t".'</rdf:Seq>'."\n";
9629 $xmp .= "\t\t\t\t\t\t".'</pdfaSchema:property>'."\n";
9630 $xmp .= "\t\t\t\t\t".'</rdf:li>'."\n";
9631 $xmp .= "\t\t\t\t".'</rdf:Bag>'."\n";
9632 $xmp .= "\t\t\t".'</pdfaExtension:schemas>'."\n";
9633 $xmp .= "\t\t".'</rdf:Description>'."\n";
9634 $xmp .= "\t".'</rdf:RDF>'."\n";
9635 $xmp .= $this->custom_xmp;
9636 $xmp .= '</x:xmpmeta>'."\n";
9637 $xmp .= '<?xpacket end="w"?>';
9638 $out = '<< /Type /Metadata /Subtype /XML /Length '.strlen($xmp).' >> stream'."\n".$xmp."\n".'endstream'."\n".'endobj';
9639 // restore previous isunicode value
9640 $this->isunicode = $prev_isunicode;
9641 $this->encrypted = $prev_encrypted;
9643 return $oid;
9644 }
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 9230 of file tcpdf.php.
9230 {
9239 if ($this->compress) {
9240 $stream = gzcompress($stream);
9242 }
9243 $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));
9247 if (!$this->pdfa_mode) {
9248 // transparency
9254 } else {
9256 }
9258 }
9260 }
9262 $gp = '';
9263 $gs = '';
9265 // gradient patterns
9266 $gp .= ' /p'.$id.' '.$this->gradients[$id]['pattern'].' 0 R';
9267 // gradient shadings
9268 $gs .= ' /Sh'.$id.' '.$this->gradients[$id]['id'].' 0 R';
9269 }
9272 }
9273 }
9274 // spot colors
9279 }
9281 }
9282 // fonts
9287 }
9289 }
9290 // images or nested xobjects
9295 }
9298 }
9300 }
9303 // set transparency group
9308 }
9311 }
9314 }
9315 }
9317 }
9324 }
9325 }
9326 }
References $data, $k, $out, _getobj(), _getrawstream(), and _out().
Referenced by _putresources().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ _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 10245 of file tcpdf.php.
10245 {
10246 if ($this->isunicode) {
10247 //Convert string to UTF-16BE
10249 }
10251 }
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 10644 of file tcpdf.php.
10644 {
10645 $hashkey = hash('sha256', $this->encryptdata['user_password'].$this->encryptdata['UKS'], true);
10647 }
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 10611 of file tcpdf.php.
10611 {
10612 if ($this->encryptdata['mode'] == 0) { // RC4-40
10613 return TCPDF_STATIC::_RC4($this->encryptdata['key'], TCPDF_STATIC::$enc_padding, $this->last_enc_key, $this->last_enc_key_c);
10614 } elseif ($this->encryptdata['mode'] < 3) { // RC4-128, AES-128
10616 $enc = TCPDF_STATIC::_RC4($this->encryptdata['key'], $tmp, $this->last_enc_key, $this->last_enc_key_c);
10617 $len = strlen($tmp);
10618 for ($i = 1; $i <= 19; ++$i) {
10619 $ek = '';
10620 for ($j = 0; $j < $len; ++$j) {
10621 $ek .= chr(ord($this->encryptdata['key'][$j]) ^ $i);
10622 }
10623 $enc = TCPDF_STATIC::_RC4($ek, $enc, $this->last_enc_key, $this->last_enc_key_c);
10624 }
10625 $enc .= str_repeat("\x00", 16);
10626 return substr($enc, 0, 32);
10627 } elseif ($this->encryptdata['mode'] == 3) { // AES-256
10629 // User Validation Salt
10630 $this->encryptdata['UVS'] = substr($seed, 0, 8);
10631 // User Key Salt
10632 $this->encryptdata['UKS'] = substr($seed, 8, 16);
10633 return hash('sha256', $this->encryptdata['user_password'].$this->encryptdata['UVS'], true).$this->encryptdata['UVS'].$this->encryptdata['UKS'];
10634 }
10635 }
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 13468 of file tcpdf.php.
13468 {
13469 ++$this->n;
13470 $this->empty_signature_appearance[] = array('objid' => $this->n) + $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
13471 }
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:13486
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 13798 of file tcpdf.php.
13798 {
13799 if ($this->pdfa_mode) {
13800 // transparencies are not allowed in PDF/A mode
13801 return;
13802 }
13803 // check if this ExtGState already exist
13804 foreach ($this->extgstates as $i => $ext) {
13805 if ($ext['parms'] == $parms) {
13806 if ($this->inxobj) {
13807 // we are inside an XObject template
13809 }
13810 // return reference to existing ExtGState
13811 return $i;
13812 }
13813 }
13814 $n = (count($this->extgstates) + 1);
13816 if ($this->inxobj) {
13817 // we are inside an XObject template
13819 }
13821 }
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
4339 $styles = array('' => '', 'B' => ',Bold', 'I' => ',Italic', 'BI' => ',BoldItalic');
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, $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 10375 of file tcpdf.php.
10375 {
10377 // convert url to internal link
10379 if (isset($lnkdata[0]) ) {
10380 $page = substr($lnkdata[0], 1);
10381 if (isset($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
10382 $lnky = floatval($lnkdata[1]);
10383 } else {
10384 $lnky = 0;
10385 }
10388 }
10389 }
10390 // store current settings
10391 $prevcolor = $this->fgcolor;
10392 $prevstyle = $this->FontStyle;
10393 if (empty($color)) {
10394 $this->SetTextColorArray($this->htmlLinkColorArray);
10395 } else {
10396 $this->SetTextColorArray($color);
10397 }
10400 } else {
10402 }
10403 $ret = $this->Write($this->lasth, $name, $url, $fill, '', false, 0, $firstline, $firstblock, 0);
10404 // restore settings
10406 $this->SetTextColorArray($prevcolor);
10408 }
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 21488 of file tcpdf.php.
21488 {
21489 $filler = ' ';
21490 $prev_htmlLinkColorArray = $this->htmlLinkColorArray;
21491 $prev_htmlLinkFontStyle = $this->htmlLinkFontStyle;
21492 // set new style for link
21493 $this->htmlLinkColorArray = array();
21494 $this->htmlLinkFontStyle = '';
21495 $page_first = $this->getPage();
21496 $page_fill_start = false;
21497 $page_fill_end = false;
21498 // get the font type used for numbers in each template
21499 $current_font = $this->FontFamily;
21502 foreach ($dom as $key => $value) {
21503 if ($value['value'] == '#TOC_PAGE_NUMBER#') {
21506 }
21507 }
21508 }
21509 $this->SetFont($current_font);
21510 $maxpage = 0; //used for pages on attached documents
21511 foreach ($this->outlines as $key => $outline) {
21512 // get HTML template
21515 $pagenum = $outline['p'];
21516 } else {
21517 // placemark to be replaced with the correct number
21518 $pagenum = '{#'.($outline['p']).'}';
21519 if ($templates['F'.$outline['l']]) {
21520 $pagenum = '{'.$pagenum.'}';
21521 }
21522 $maxpage = max($maxpage, $outline['p']);
21523 }
21524 // replace templates with current values
21527 // add link to page
21529 // write bookmark entry
21531 }
21532 // restore link styles
21533 $this->htmlLinkColorArray = $prev_htmlLinkColorArray;
21534 $this->htmlLinkFontStyle = $prev_htmlLinkFontStyle;
21535 // move TOC page and replace numbers
21536 $page_last = $this->getPage();
21537 $numpages = ($page_last - $page_first + 1);
21538 // account for booklet mode
21539 if ($this->booklet) {
21540 // check if a blank page is required before TOC
21541 $page_fill_start = ((($page_first % 2) == 0) XOR (($page % 2) == 0));
21542 $page_fill_end = (!((($numpages % 2) == 0) XOR ($page_fill_start)));
21543 if ($page_fill_start) {
21544 // add a page at the end (to be moved before TOC)
21545 $this->addPage();
21546 ++$page_last;
21547 ++$numpages;
21548 }
21549 if ($page_fill_end) {
21550 // add a page at the end
21551 $this->addPage();
21552 ++$page_last;
21553 ++$numpages;
21554 }
21555 }
21556 $maxpage = max($maxpage, $page_last);
21558 for ($p = $page_first; $p <= $page_last; ++$p) {
21559 // get page data
21560 $temppage = $this->getPageBuffer($p);
21562 // update page numbers
21563 $a = '{#'.$n.'}';
21564 // get page number aliases
21565 $pnalias = $this->getInternalPageNumberAliases($a);
21566 // calculate replacement number
21569 } else {
21570 $np = $n;
21571 }
21572 $na = TCPDF_STATIC::formatTOCPageNumber(($this->starting_page_number + $np - 1));
21574 // replace aliases with numbers
21575 foreach ($pnalias['u'] as $u) {
21576 if ($correct_align) {
21577 $sfill = str_repeat($filler, (strlen($u) - strlen($nu.' ')));
21578 if ($this->rtl) {
21579 $nr = $nu.TCPDF_FONTS::UTF8ToUTF16BE(' '.$sfill, false, $this->isunicode, $this->CurrentFont);
21580 } else {
21581 $nr = TCPDF_FONTS::UTF8ToUTF16BE($sfill.' ', false, $this->isunicode, $this->CurrentFont).$nu;
21582 }
21583 } else {
21584 $nr = $nu;
21585 }
21586 $temppage = str_replace($u, $nr, $temppage);
21587 }
21588 foreach ($pnalias['a'] as $a) {
21589 if ($correct_align) {
21590 $sfill = str_repeat($filler, (strlen($a) - strlen($na.' ')));
21591 if ($this->rtl) {
21592 $nr = $na.' '.$sfill;
21593 } else {
21594 $nr = $sfill.' '.$na;
21595 }
21596 } else {
21597 $nr = $na;
21598 }
21599 $temppage = str_replace($a, $nr, $temppage);
21600 }
21601 }
21602 // save changes
21603 $this->setPageBuffer($p, $temppage);
21604 }
21605 // move pages
21607 if ($page_fill_start) {
21608 $this->movePage($page_last, $page_first);
21609 }
21612 }
21613 }
21614 }
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:12303
writeHTML($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='')
Allows to preserve some HTML formatting (limited support).
Definition: tcpdf.php:17121
getInternalPageNumberAliases($a='')
Return an array containing variations for the basic page number alias.
Definition: tcpdf.php:7809
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 19895 of file tcpdf.php.
19895 {
19896 if ($firsttag) {
19897 $this->Ln(0, $cell);
19898 $this->htmlvspace = 0;
19899 return;
19900 }
19901 if ($lasttag) {
19902 $this->Ln($hbz, $cell);
19903 $this->htmlvspace = 0;
19904 return;
19905 }
19906 if ($hb < $this->htmlvspace) {
19907 $hd = 0;
19908 } else {
19909 $hd = $hb - $this->htmlvspace;
19910 $this->htmlvspace = $hb;
19911 }
19912 $this->Ln(($hbz + $hd), $cell);
19913 }
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 12507 of file tcpdf.php.
12507 {
12508 if ($this->pdfa_mode) {
12509 // javascript is not allowed in PDF/A mode
12510 return false;
12511 }
12512 ++$this->n;
12515 }
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 22536 of file tcpdf.php.
22536 {
22537 if (!isset($region['page']) OR empty($region['page'])) {
22539 }
22540 if (isset($region['xt']) AND isset($region['xb']) AND ($region['xt'] > 0) AND ($region['xb'] > 0)
22541 AND isset($region['yt']) AND isset($region['yb']) AND ($region['yt'] >= 0) AND ($region['yt'] < $region['yb'])
22542 AND isset($region['side']) AND (($region['side'] == 'L') OR ($region['side'] == 'R'))) {
22543 $this->page_regions[] = $region;
22544 }
22545 }
◆ 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 21278 of file tcpdf.php.
21278 {
21279 $fontsize = $this->FontSizePt;
21280 $fontfamily = $this->FontFamily;
21281 $fontstyle = $this->FontStyle;
21283 $spacer = $this->GetStringWidth(chr(32)) * 4;
21284 $lmargin = $this->lMargin;
21285 $rmargin = $this->rMargin;
21286 $x_start = $this->GetX();
21287 $page_first = $this->page;
21288 $current_page = $this->page;
21289 $page_fill_start = false;
21290 $page_fill_end = false;
21293 $numbersfont = $this->default_monospaced_font;
21294 }
21296 $filler = ' ';
21297 }
21299 $gap = ' ';
21300 } else {
21301 $gap = '';
21303 $page = 1;
21304 }
21305 }
21306 $this->SetFont($numbersfont, $fontstyle, $fontsize);
21308 $maxpage = 0; //used for pages on attached documents
21309 foreach ($this->outlines as $key => $outline) {
21310 // check for extra pages (used for attachments)
21311 if (($this->page > $page_first) AND ($outline['p'] >= $this->numpages)) {
21312 $outline['p'] += ($this->page - $page_first);
21313 }
21314 if ($this->rtl) {
21315 $aligntext = 'R';
21316 $alignnum = 'L';
21317 } else {
21318 $aligntext = 'L';
21319 $alignnum = 'R';
21320 }
21321 if ($outline['l'] == 0) {
21323 } else {
21325 }
21327 // check for page break
21329 // set margins and X position
21331 $this->lMargin = $lmargin;
21332 $this->rMargin = $rmargin;
21333 } else {
21335 if ($this->rtl) {
21337 } else {
21339 }
21340 }
21341 $lmargin = $this->lMargin;
21342 $rmargin = $this->rMargin;
21343 $current_page = $this->page;
21345 }
21346 $this->SetX($x_start);
21347 $indent = ($spacer * $outline['l']);
21348 if ($this->rtl) {
21349 $this->x -= $indent;
21350 $this->rMargin = $this->w - $this->x;
21351 } else {
21352 $this->x += $indent;
21353 $this->lMargin = $this->x;
21354 }
21355 $link = $this->AddLink();
21357 // write the text
21358 if ($this->rtl) {
21360 } else {
21362 }
21364 if ($this->rtl) {
21365 $tw = $this->x - $this->lMargin;
21366 } else {
21367 $tw = $this->w - $this->rMargin - $this->x;
21368 }
21369 $this->SetFont($numbersfont, $fontstyle, $fontsize);
21371 $pagenum = $outline['p'];
21372 } else {
21373 // placemark to be replaced with the correct number
21374 $pagenum = '{#'.($outline['p']).'}';
21376 $pagenum = '{'.$pagenum.'}';
21377 }
21378 $maxpage = max($maxpage, $outline['p']);
21379 }
21380 $fw = ($tw - $this->GetStringWidth($pagenum.$filler));
21381 $wfiller = $this->GetStringWidth($filler);
21382 if ($wfiller > 0) {
21383 $numfills = floor($fw / $wfiller);
21384 } else {
21385 $numfills = 0;
21386 }
21387 if ($numfills > 0) {
21388 $rowfill = str_repeat($filler, $numfills);
21389 } else {
21390 $rowfill = '';
21391 }
21392 if ($this->rtl) {
21393 $pagenum = $pagenum.$gap.$rowfill;
21394 } else {
21395 $pagenum = $rowfill.$gap.$pagenum;
21396 }
21397 // write the number
21398 $this->Cell($tw, 0, $pagenum, 0, 1, $alignnum, 0, $link, 0);
21399 }
21400 $page_last = $this->getPage();
21401 $numpages = ($page_last - $page_first + 1);
21402 // account for booklet mode
21403 if ($this->booklet) {
21404 // check if a blank page is required before TOC
21405 $page_fill_start = ((($page_first % 2) == 0) XOR (($page % 2) == 0));
21406 $page_fill_end = (!((($numpages % 2) == 0) XOR ($page_fill_start)));
21407 if ($page_fill_start) {
21408 // add a page at the end (to be moved before TOC)
21409 $this->addPage();
21410 ++$page_last;
21411 ++$numpages;
21412 }
21413 if ($page_fill_end) {
21414 // add a page at the end
21415 $this->addPage();
21416 ++$page_last;
21417 ++$numpages;
21418 }
21419 }
21420 $maxpage = max($maxpage, $page_last);
21422 for ($p = $page_first; $p <= $page_last; ++$p) {
21423 // get page data
21424 $temppage = $this->getPageBuffer($p);
21426 // update page numbers
21427 $a = '{#'.$n.'}';
21428 // get page number aliases
21429 $pnalias = $this->getInternalPageNumberAliases($a);
21430 // calculate replacement number
21433 } else {
21434 $np = $n;
21435 }
21436 $na = TCPDF_STATIC::formatTOCPageNumber(($this->starting_page_number + $np - 1));
21438 // replace aliases with numbers
21439 foreach ($pnalias['u'] as $u) {
21440 $sfill = str_repeat($filler, max(0, (strlen($u) - strlen($nu.' '))));
21441 if ($this->rtl) {
21442 $nr = $nu.TCPDF_FONTS::UTF8ToUTF16BE(' '.$sfill, false, $this->isunicode, $this->CurrentFont);
21443 } else {
21444 $nr = TCPDF_FONTS::UTF8ToUTF16BE($sfill.' ', false, $this->isunicode, $this->CurrentFont).$nu;
21445 }
21446 $temppage = str_replace($u, $nr, $temppage);
21447 }
21448 foreach ($pnalias['a'] as $a) {
21449 $sfill = str_repeat($filler, max(0, (strlen($a) - strlen($na.' '))));
21450 if ($this->rtl) {
21451 $nr = $na.' '.$sfill;
21452 } else {
21453 $nr = $sfill.' '.$na;
21454 }
21455 $temppage = str_replace($a, $nr, $temppage);
21456 }
21457 }
21458 // save changes
21459 $this->setPageBuffer($p, $temppage);
21460 }
21461 // move pages
21463 if ($page_fill_start) {
21464 $this->movePage($page_last, $page_first);
21465 }
21468 }
21469 }
21470 }
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:22573
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:6829
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 13546 of file tcpdf.php.
13546 {
13547 if (!$this->tsa_timestamp) {
13548 return $signature;
13549 }
13550 //@TODO: implement this feature
13551 return $signature;
13552 }
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 12142 of file tcpdf.php.
12142 {
12143 // getting arrow direction angle
12144 // 0 deg angle is when both arms go along X axis. angle grows clockwise.
12145 $dir_angle = atan2(($y0 - $y1), ($x0 - $x1));
12146 if ($dir_angle < 0) {
12147 $dir_angle += (2 * M_PI);
12148 }
12149 $arm_angle = deg2rad($arm_angle);
12150 $sx1 = $x1;
12151 $sy1 = $y1;
12152 if ($head_style > 0) {
12153 // calculate the stopping point for the arrow shaft
12154 $sx1 = $x1 + (($arm_size - $this->LineWidth) * cos($dir_angle));
12155 $sy1 = $y1 + (($arm_size - $this->LineWidth) * sin($dir_angle));
12156 }
12157 // main arrow line / shaft
12158 $this->Line($x0, $y0, $sx1, $sy1);
12159 // left arrowhead arm tip
12160 $x2L = $x1 + ($arm_size * cos($dir_angle + $arm_angle));
12161 $y2L = $y1 + ($arm_size * sin($dir_angle + $arm_angle));
12162 // right arrowhead arm tip
12163 $x2R = $x1 + ($arm_size * cos($dir_angle - $arm_angle));
12164 $y2R = $y1 + ($arm_size * sin($dir_angle - $arm_angle));
12165 $mode = 'D';
12166 $style = array();
12167 switch ($head_style) {
12168 case 0: {
12169 // draw only arrowhead arms
12170 $mode = 'D';
12171 $style = array(1, 1, 0);
12172 break;
12173 }
12174 case 1: {
12175 // draw closed arrowhead, but no fill
12176 $mode = 'D';
12177 break;
12178 }
12179 case 2: {
12180 // closed and filled arrowhead
12181 $mode = 'DF';
12182 break;
12183 }
12184 case 3: {
12185 // filled arrowhead
12186 $mode = 'F';
12187 break;
12188 }
12189 }
12191 }
Polygon($p, $style='', $line_style=array(), $fill_color=array(), $closed=true)
Draws a polygon.
Definition: tcpdf.php:11862
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 12303 of file tcpdf.php.
12303 {
12304 if ($level < 0) {
12305 $level = 0;
12306 }
12307 if (isset($this->outlines[0])) {
12308 $lastoutline = end($this->outlines);
12309 $maxlevel = $lastoutline['l'] + 1;
12310 } else {
12311 $maxlevel = 0;
12312 }
12313 if ($level > $maxlevel) {
12314 $level = $maxlevel;
12315 }
12318 } elseif ($y < 0) {
12319 $y = 0;
12320 } elseif ($y > $this->h) {
12322 }
12325 } elseif ($x < 0) {
12326 $x = 0;
12327 } elseif ($x > $this->w) {
12329 }
12330 $fixed = false;
12333 // this page number will not be changed when moving/add/deleting pages
12334 $fixed = true;
12335 }
12339 return;
12340 }
12341 }
12342 $this->outlines[] = array('t' => $txt, 'l' => $level, 'x' => $x, 'y' => $y, 'p' => $page, 'f' => $fixed, 's' => strtoupper($style), 'c' => $color, 'u' => $link);
12343 }
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 13123 of file tcpdf.php.
13123 {
13126 }
13129 }
13130 // check page for no-write regions and adapt page margins if necessary
13134 $this->javascript .= 'f'.$name.".buttonSetCaption('".addslashes($caption)."');\n";
13135 $this->javascript .= 'f'.$name.".setAction('MouseUp','".addslashes($action)."');\n";
13136 $this->javascript .= 'f'.$name.".highlight='push';\n";
13137 $this->javascript .= 'f'.$name.".print=false;\n";
13138 return;
13139 }
13140 // get default style
13141 $prop = array_merge($this->getFormDefaultProp(), $prop);
13142 $prop['Pushbutton'] = 'true';
13143 $prop['highlight'] = 'push';
13144 $prop['display'] = 'display.noPrint';
13145 // get annotation data
13146 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
13147 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
13148 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
13149 $popt['da'] = $fontstyle;
13150 // build appearance stream
13151 $popt['ap'] = array();
13152 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
13155 $border = array(
13156 'L' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(231)),
13157 'R' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(51)),
13158 'T' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(231)),
13159 'B' => array('width' => $bw, 'cap' => 'square', 'join' => 'miter', 'dash' => 0, 'color' => array(51)));
13160 $this->SetFillColor(204);
13162 $this->endTemplate();
13163 --$this->n;
13164 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
13165 unset($this->xobjects[$tmpid]);
13166 $popt['ap']['n'] .= 'Q EMC';
13167 // set additional default options
13168 if (!isset($popt['mk'])) {
13169 $popt['mk'] = array();
13170 }
13171 $ann_obj_id = ($this->n + 1);
13172 if (!empty($action) AND !is_array($action)) {
13173 $ann_obj_id = ($this->n + 2);
13174 }
13178 // merge options
13179 $opt = array_merge($popt, $opt);
13180 // set remaining annotation data
13181 $opt['Subtype'] = 'Widget';
13182 $opt['ft'] = 'Btn';
13183 $opt['t'] = $caption;
13184 $opt['v'] = $name;
13185 if (!empty($action)) {
13186 if (is_array($action)) {
13187 // form action options as on section 12.7.5 of PDF32000_2008.
13188 $opt['aa'] = '/D <<';
13189 $bmode = array('SubmitForm', 'ResetForm', 'ImportData');
13190 foreach ($action AS $key => $val) {
13191 if (($key == 'S') AND in_array($val, $bmode)) {
13192 $opt['aa'] .= ' /S /'.$val;
13193 } elseif (($key == 'F') AND (!empty($val))) {
13194 $opt['aa'] .= ' /F '.$this->_datastring($val, $ann_obj_id);
13195 } elseif (($key == 'Fields') AND is_array($val) AND !empty($val)) {
13196 $opt['aa'] .= ' /Fields [';
13197 foreach ($val AS $field) {
13198 $opt['aa'] .= ' '.$this->_textstring($field, $ann_obj_id);
13199 }
13200 $opt['aa'] .= ']';
13201 } elseif (($key == 'Flags')) {
13202 $ff = 0;
13203 if (is_array($val)) {
13204 foreach ($val AS $flag) {
13205 switch ($flag) {
13206 case 'Include/Exclude': {
13207 $ff += 1 << 0;
13208 break;
13209 }
13210 case 'IncludeNoValueFields': {
13211 $ff += 1 << 1;
13212 break;
13213 }
13214 case 'ExportFormat': {
13215 $ff += 1 << 2;
13216 break;
13217 }
13218 case 'GetMethod': {
13219 $ff += 1 << 3;
13220 break;
13221 }
13222 case 'SubmitCoordinates': {
13223 $ff += 1 << 4;
13224 break;
13225 }
13226 case 'XFDF': {
13227 $ff += 1 << 5;
13228 break;
13229 }
13230 case 'IncludeAppendSaves': {
13231 $ff += 1 << 6;
13232 break;
13233 }
13234 case 'IncludeAnnotations': {
13235 $ff += 1 << 7;
13236 break;
13237 }
13238 case 'SubmitPDF': {
13239 $ff += 1 << 8;
13240 break;
13241 }
13242 case 'CanonicalFormat': {
13243 $ff += 1 << 9;
13244 break;
13245 }
13246 case 'ExclNonUserAnnots': {
13247 $ff += 1 << 10;
13248 break;
13249 }
13250 case 'ExclFKey': {
13251 $ff += 1 << 11;
13252 break;
13253 }
13254 case 'EmbedForm': {
13255 $ff += 1 << 13;
13256 break;
13257 }
13258 }
13259 }
13260 } else {
13261 $ff = intval($val);
13262 }
13263 $opt['aa'] .= ' /Flags '.$ff;
13264 }
13265 }
13266 $opt['aa'] .= ' >>';
13267 } else {
13268 // Javascript action or raw action command
13269 $js_obj_id = $this->addJavascriptObject($action);
13270 $opt['aa'] = '/D '.$js_obj_id.' 0 R';
13271 }
13272 }
13274 if ($this->rtl) {
13275 $this->x -= $w;
13276 } else {
13277 $this->x += $w;
13278 }
13279 }
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:22294
_addfield($type, $name, $x, $y, $w, $h, $prop)
Adds a javascript form field.
Definition: tcpdf.php:12581
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:12507
References $border, $h, $js, $k, $n, $w, $x, $y, _addfield(), _textstring(), addJavascriptObject(), Annotation(), Cell(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), SetFillColor(), 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:13910
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 13043 of file tcpdf.php.
13043 {
13046 }
13049 }
13050 // check page for no-write regions and adapt page margins if necessary
13054 return;
13055 }
13056 if (!isset($prop['value'])) {
13057 $prop['value'] = array('Yes');
13058 }
13059 // get default style
13060 $prop = array_merge($this->getFormDefaultProp(), $prop);
13061 $prop['borderStyle'] = 'inset';
13062 // get annotation data
13063 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
13064 // set additional default options
13065 $font = 'zapfdingbats';
13066 if ($this->pdfa_mode) {
13067 // all fonts must be embedded
13068 $font = 'pdfa'.$font;
13069 }
13070 $this->AddFont($font);
13071 $tmpfont = $this->getFontBuffer($font);
13072 $this->annotation_fonts[$tmpfont['fontkey']] = $tmpfont['i'];
13073 $fontstyle = sprintf('/F%d %F Tf %s', $tmpfont['i'], $this->FontSizePt, $this->TextColor);
13074 $popt['da'] = $fontstyle;
13075 // build appearance stream
13076 $popt['ap'] = array();
13077 $popt['ap']['n'] = array();
13079 $fy = (($w - ((($tmpfont['desc']['Ascent'] - $tmpfont['desc']['Descent']) * $this->FontSizePt / 1000) / $this->k)) * $this->k);
13080 $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);
13081 $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);
13082 // merge options
13083 $opt = array_merge($popt, $opt);
13084 // set remaining annotation data
13085 $opt['Subtype'] = 'Widget';
13086 $opt['ft'] = 'Btn';
13087 $opt['t'] = $name;
13089 $onvalue = 'Yes';
13090 }
13091 $opt['opt'] = array($onvalue);
13092 if ($checked) {
13093 $opt['v'] = array('/Yes');
13094 $opt['as'] = 'Yes';
13095 } else {
13096 $opt['v'] = array('/Off');
13097 $opt['as'] = 'Off';
13098 }
13100 if ($this->rtl) {
13101 $this->x -= $w;
13102 } else {
13103 $this->x += $w;
13104 }
13105 }
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 22573 of file tcpdf.php.
22573 {
22574 // set default values
22577 }
22580 }
22581 if (!$this->check_page_regions OR empty($this->page_regions)) {
22582 // no page regions defined
22584 }
22587 }
22588 // check for page break
22590 // the content will be printed on a new page
22593 }
22594 if ($this->num_columns > 1) {
22595 if ($this->rtl) {
22596 $this->lMargin = ($this->columns[$this->current_column]['x'] - $this->columns[$this->current_column]['w']);
22597 } else {
22598 $this->rMargin = ($this->w - $this->columns[$this->current_column]['x'] - $this->columns[$this->current_column]['w']);
22599 }
22600 } else {
22601 if ($this->rtl) {
22602 $this->lMargin = max($this->clMargin, $this->original_lMargin);
22603 } else {
22604 $this->rMargin = max($this->crMargin, $this->original_rMargin);
22605 }
22606 }
22607 // adjust coordinates and page margins
22608 foreach ($this->page_regions as $regid => $regdata) {
22609 if ($regdata['page'] == $this->page) {
22610 // check region boundaries
22612 // Y is inside the region
22613 $minv = ($regdata['xb'] - $regdata['xt']) / ($regdata['yb'] - $regdata['yt']); // inverse of angular coefficient
22616 $xt = (($yt - $regdata['yt']) * $minv) + $regdata['xt'];
22617 $xb = (($yb - $regdata['yt']) * $minv) + $regdata['xt'];
22618 if ($regdata['side'] == 'L') { // left side
22619 $new_margin = max($xt, $xb);
22620 if ($this->lMargin < $new_margin) {
22621 if ($this->rtl) {
22622 // adjust left page margin
22623 $this->lMargin = max(0, $new_margin);
22624 }
22626 // adjust x position
22627 $x = $new_margin;
22628 if ($new_margin > ($this->w - $this->rMargin)) {
22629 // adjust y position
22631 }
22632 }
22633 }
22634 } elseif ($regdata['side'] == 'R') { // right side
22635 $new_margin = min($xt, $xb);
22636 if (($this->w - $this->rMargin) > $new_margin) {
22637 if (!$this->rtl) {
22638 // adjust right page margin
22639 $this->rMargin = max(0, ($this->w - $new_margin));
22640 }
22642 // adjust x position
22643 $x = $new_margin;
22644 if ($new_margin > $this->lMargin) {
22645 // adjust y position
22647 }
22648 }
22649 }
22650 }
22651 }
22652 }
22653 }
22655 }
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 11825 of file tcpdf.php.
11825 {
11827 }
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:11653
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 14444 of file tcpdf.php.
14444 {
14445 if ($this->state != 2) {
14446 return;
14447 }
14448 if ($this->rtl) {
14450 }
14451 //save current Graphic State
14452 $s = 'q';
14453 //set clipping area
14454 $s .= sprintf(' %F %F %F %F re W n', $x*$this->k, ($this->h-$y)*$this->k, $w*$this->k, -$h*$this->k);
14455 //set up transformation matrix for gradient
14456 $s .= sprintf(' %F 0 0 %F %F %F cm', $w*$this->k, $h*$this->k, $x*$this->k, ($this->h-($y+$h))*$this->k);
14457 $this->_out($s);
14458 }
References $h, $w, $x, $y, and _out().
Referenced by CoonsPatchMesh(), LinearGradient(), and RadialGradient().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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:21836
setEqualColumns($numcols=0, $width=0, $y='')
Set multiple columns of the same size.
Definition: tcpdf.php:21676
_outRestoreGraphicsState()
Outputs the "restore graphics state" operator 'Q'.
Definition: tcpdf.php:20667
References $k, _destroy(), _enddoc(), _outRestoreGraphicsState(), _outSaveGraphicsState(), AddPage(), Cell(), 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 19348 of file tcpdf.php.
19348 {
19349 $tag = $dom[$key];
19350 $parent = $dom[($dom[$key]['parent'])];
19351 $lasttag = ((!isset($dom[($key + 1)])) OR ((!isset($dom[($key + 2)])) AND ($dom[($key + 1)]['value'] == 'marker')));
19352 $in_table_head = false;
19353 // maximum x position (used to draw borders)
19354 if ($this->rtl) {
19355 $xmax = $this->w;
19356 } else {
19357 $xmax = 0;
19358 }
19359 if ($tag['block']) {
19360 $hbz = 0; // distance from y to line bottom
19361 $hb = 0; // vertical space between block tags
19362 // calculate vertical space for block tags
19363 if (isset($this->tagvspaces[$tag['value']][1]['h']) AND ($this->tagvspaces[$tag['value']][1]['h'] >= 0)) {
19364 $pre_h = $this->tagvspaces[$tag['value']][1]['h'];
19365 } elseif (isset($parent['fontsize'])) {
19367 } else {
19368 $pre_h = $this->getCellHeight($this->FontSize);
19369 }
19370 if (isset($this->tagvspaces[$tag['value']][1]['n'])) {
19371 $cn = $this->tagvspaces[$tag['value']][1]['n'];
19372 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
19373 $cn = 0.6;
19374 } else {
19375 $cn = 1;
19376 }
19377 if ((!isset($this->tagvspaces[$tag['value']])) AND ($tag['value'] == 'div')) {
19378 $hb = 0;
19379 } else {
19380 $hb = ($cn * $pre_h);
19381 }
19382 if ($maxbottomliney > $this->PageBreakTrigger) {
19383 $hbz = $this->getCellHeight($this->FontSize);
19384 } elseif ($this->y < $maxbottomliney) {
19385 $hbz = ($maxbottomliney - $this->y);
19386 }
19387 }
19388 // Closing tag
19389 switch($tag['value']) {
19390 case 'tr': {
19391 $table_el = $dom[($dom[$key]['parent'])]['parent'];
19392 if (!isset($parent['endy'])) {
19393 $dom[($dom[$key]['parent'])]['endy'] = $this->y;
19395 }
19396 if (!isset($parent['endpage'])) {
19397 $dom[($dom[$key]['parent'])]['endpage'] = $this->page;
19399 }
19400 if (!isset($parent['endcolumn'])) {
19401 $dom[($dom[$key]['parent'])]['endcolumn'] = $this->current_column;
19403 }
19404 // update row-spanned cells
19405 if (isset($dom[$table_el]['rowspans'])) {
19409 if (($dom[$table_el]['rowspans'][$k]['endpage'] == $parent['endpage']) AND ($dom[$table_el]['rowspans'][$k]['endcolumn'] == $parent['endcolumn'])) {
19410 $dom[($dom[$key]['parent'])]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $parent['endy']);
19411 } elseif (($dom[$table_el]['rowspans'][$k]['endpage'] > $parent['endpage']) OR ($dom[$table_el]['rowspans'][$k]['endcolumn'] > $parent['endcolumn'])) {
19415 }
19416 }
19417 }
19418 // report new endy and endpage to the rowspanned cells
19421 $dom[$table_el]['rowspans'][$k]['endpage'] = max($dom[$table_el]['rowspans'][$k]['endpage'], $dom[($dom[$key]['parent'])]['endpage']);
19423 $dom[$table_el]['rowspans'][$k]['endcolumn'] = max($dom[$table_el]['rowspans'][$k]['endcolumn'], $dom[($dom[$key]['parent'])]['endcolumn']);
19425 $dom[$table_el]['rowspans'][$k]['endy'] = max($dom[$table_el]['rowspans'][$k]['endy'], $dom[($dom[$key]['parent'])]['endy']);
19427 }
19428 }
19429 // update remaining rowspanned cells
19435 }
19436 }
19437 }
19438 $prev_page = $this->page;
19440 if ($this->num_columns > 1) {
19441 if (($prev_page < $this->page)
19442 AND ((($this->current_column == 0) AND ($dom[($dom[$key]['parent'])]['endcolumn'] == ($this->num_columns - 1)))
19443 OR ($this->current_column == $dom[($dom[$key]['parent'])]['endcolumn']))) {
19444 // page jump
19445 $this->selectColumn(0);
19446 $dom[($dom[$key]['parent'])]['endcolumn'] = 0;
19447 $dom[($dom[$key]['parent'])]['endy'] = $this->y;
19448 } else {
19450 $this->y = $dom[($dom[$key]['parent'])]['endy'];
19451 }
19452 } else {
19453 $this->y = $dom[($dom[$key]['parent'])]['endy'];
19454 }
19455 if (isset($dom[$table_el]['attribute']['cellspacing'])) {
19457 } elseif (isset($dom[$table_el]['border-spacing'])) {
19458 $this->y += $dom[$table_el]['border-spacing']['V'];
19459 }
19460 $this->Ln(0, $cell);
19461 if ($this->current_column == $parent['startcolumn']) {
19462 $this->x = $parent['startx'];
19463 }
19464 // account for booklet mode
19465 if ($this->page > $parent['startpage']) {
19466 if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$parent['startpage']]['orm'])) {
19467 $this->x -= ($this->pagedim[$this->page]['orm'] - $this->pagedim[$parent['startpage']]['orm']);
19468 } elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$parent['startpage']]['olm'])) {
19469 $this->x += ($this->pagedim[$this->page]['olm'] - $this->pagedim[$parent['startpage']]['olm']);
19470 }
19471 }
19472 break;
19473 }
19474 case 'tablehead':
19475 // closing tag used for the thead part
19476 $in_table_head = true;
19477 $this->inthead = false;
19478 case 'table': {
19479 $table_el = $parent;
19480 // set default border
19481 if (isset($table_el['attribute']['border']) AND ($table_el['attribute']['border'] > 0)) {
19482 // set default border
19483 $border = array('LTRB' => array('width' => $this->getCSSBorderWidth($table_el['attribute']['border']), 'cap'=>'square', 'join'=>'miter', 'dash'=> 0, 'color'=>array(0,0,0)));
19484 } else {
19485 $border = 0;
19486 }
19487 $default_border = $border;
19488 // fix bottom line alignment of last line before page break
19489 foreach ($dom[($dom[$key]['parent'])]['trids'] as $j => $trkey) {
19490 // update row-spanned cells
19491 if (isset($dom[($dom[$key]['parent'])]['rowspans'])) {
19493 if (isset($prevtrkey) AND ($trwsp['trid'] == $prevtrkey) AND ($trwsp['mrowspan'] > 0)) {
19495 }
19498 }
19499 }
19500 }
19501 if (isset($prevtrkey) AND ($dom[$trkey]['startpage'] > $dom[$prevtrkey]['endpage'])) {
19502 $pgendy = $this->pagedim[$dom[$prevtrkey]['endpage']]['hk'] - $this->pagedim[$dom[$prevtrkey]['endpage']]['bm'];
19503 $dom[$prevtrkey]['endy'] = $pgendy;
19504 // update row-spanned cells
19505 if (isset($dom[($dom[$key]['parent'])]['rowspans'])) {
19507 if (($trwsp['trid'] == $prevtrkey) AND ($trwsp['mrowspan'] >= 0) AND ($trwsp['endpage'] == $dom[$prevtrkey]['endpage'])) {
19510 }
19511 }
19512 }
19513 }
19514 $prevtrkey = $trkey;
19515 $table_el = $dom[($dom[$key]['parent'])];
19516 }
19517 // for each row
19518 if (count($table_el['trids']) > 0) {
19519 unset($xmax);
19520 }
19521 foreach ($table_el['trids'] as $j => $trkey) {
19522 $parent = $dom[$trkey];
19523 if (!isset($xmax)) {
19524 $xmax = $parent['cellpos'][(count($parent['cellpos']) - 1)]['endx'];
19525 }
19526 // for each cell on the row
19528 if (isset($cellpos['rowspanid']) AND ($cellpos['rowspanid'] >= 0)) {
19529 $cellpos['startx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['startx'];
19530 $cellpos['endx'] = $table_el['rowspans'][($cellpos['rowspanid'])]['endx'];
19531 $endy = $table_el['rowspans'][($cellpos['rowspanid'])]['endy'];
19532 $startpage = $table_el['rowspans'][($cellpos['rowspanid'])]['startpage'];
19533 $endpage = $table_el['rowspans'][($cellpos['rowspanid'])]['endpage'];
19534 $startcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['startcolumn'];
19535 $endcolumn = $table_el['rowspans'][($cellpos['rowspanid'])]['endcolumn'];
19536 } else {
19537 $endy = $parent['endy'];
19538 $startpage = $parent['startpage'];
19539 $endpage = $parent['endpage'];
19540 $startcolumn = $parent['startcolumn'];
19541 $endcolumn = $parent['endcolumn'];
19542 }
19543 if ($this->num_columns == 0) {
19544 $this->num_columns = 1;
19545 }
19546 if (isset($cellpos['border'])) {
19548 }
19549 if (isset($cellpos['bgcolor']) AND ($cellpos['bgcolor']) !== false) {
19551 $fill = true;
19552 } else {
19553 $fill = false;
19554 }
19559 // get border modes
19563 // design borders around HTML cells.
19565 $ccode = '';
19567 if ($this->num_columns < 2) {
19568 // single-column mode
19569 $this->x = $x;
19570 $this->y = $this->tMargin;
19571 }
19572 // account for margin changes
19576 } elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
19578 }
19579 }
19580 if ($startpage == $endpage) { // single page
19581 $deltacol = 0;
19582 $deltath = 0;
19583 for ($column = $startcolumn; $column <= $endcolumn; ++$column) { // for each column
19584 $this->selectColumn($column);
19585 if ($startcolumn == $endcolumn) { // single column
19586 $cborder = $border;
19588 $this->y = $y;
19589 $this->x = $x;
19590 } elseif ($column == $startcolumn) { // first column
19591 $cborder = $border_start;
19592 $this->y = $starty;
19593 $this->x = $x;
19595 if ($this->rtl) {
19596 $deltacol = $this->x + $this->rMargin - $this->w;
19597 } else {
19598 $deltacol = $this->x - $this->lMargin;
19599 }
19600 } elseif ($column == $endcolumn) { // end column
19601 $cborder = $border_end;
19603 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19604 }
19605 $this->x += $deltacol;
19607 } else { // middle column
19608 $cborder = $border_middle;
19610 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19611 }
19612 $this->x += $deltacol;
19614 }
19616 } // end for each column
19618 $deltacol = 0;
19619 $deltath = 0;
19621 $this->selectColumn($column);
19622 if ($column == $startcolumn) { // first column
19623 $cborder = $border_start;
19624 $this->y = $starty;
19625 $this->x = $x;
19627 if ($this->rtl) {
19628 $deltacol = $this->x + $this->rMargin - $this->w;
19629 } else {
19630 $deltacol = $this->x - $this->lMargin;
19631 }
19632 } else { // middle column
19633 $cborder = $border_middle;
19635 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19636 }
19637 $this->x += $deltacol;
19639 }
19641 } // end for each column
19643 $deltacol = 0;
19644 $deltath = 0;
19645 for ($column = 0; $column <= $endcolumn; ++$column) { // for each column
19646 $this->selectColumn($column);
19647 if ($column == $endcolumn) { // end column
19648 $cborder = $border_end;
19650 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19651 }
19652 $this->x += $deltacol;
19654 } else { // middle column
19655 $cborder = $border_middle;
19657 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19658 }
19659 $this->x += $deltacol;
19661 }
19663 } // end for each column
19664 } else { // middle page
19665 $deltacol = 0;
19666 $deltath = 0;
19668 $this->selectColumn($column);
19669 $cborder = $border_middle;
19671 $this->y = $this->columns[$column]['th']['\''.$page.'\''];
19672 }
19673 $this->x += $deltacol;
19676 } // end for each column
19677 }
19678 if (!empty($cborder) OR !empty($fill)) {
19679 $offsetlen = strlen($ccode);
19680 // draw border and fill
19681 if ($this->inxobj) {
19682 // we are inside an XObject template
19683 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
19684 $pagemarkkey = key($this->xobjects[$this->xobjid]['transfmrk']);
19687 } else {
19690 }
19692 $pstart = substr($pagebuff, 0, $pagemark);
19693 $pend = substr($pagebuff, $pagemark);
19695 } else {
19696 // draw border and fill
19697 if (end($this->transfmrk[$this->page]) !== false) {
19698 $pagemarkkey = key($this->transfmrk[$this->page]);
19699 $pagemark = $this->transfmrk[$this->page][$pagemarkkey];
19700 } elseif ($this->InFooter) {
19701 $pagemark = $this->footerpos[$this->page];
19702 } else {
19703 $pagemark = $this->intmrk[$this->page];
19704 }
19705 $pagebuff = $this->getPageBuffer($this->page);
19706 $pstart = substr($pagebuff, 0, $pagemark);
19707 $pend = substr($pagebuff, $pagemark);
19708 $this->setPageBuffer($this->page, $pstart.$ccode.$pend);
19709 }
19710 }
19711 } // end for each page
19712 // restore default border
19713 $border = $default_border;
19714 } // end for each cell on the row
19715 if (isset($table_el['attribute']['cellspacing'])) {
19717 } elseif (isset($table_el['border-spacing'])) {
19718 $this->y += $table_el['border-spacing']['V'];
19719 }
19720 $this->Ln(0, $cell);
19721 $this->x = $parent['startx'];
19722 if ($endpage > $startpage) {
19723 if (($this->rtl) AND ($this->pagedim[$endpage]['orm'] != $this->pagedim[$startpage]['orm'])) {
19724 $this->x += ($this->pagedim[$endpage]['orm'] - $this->pagedim[$startpage]['orm']);
19725 } elseif ((!$this->rtl) AND ($this->pagedim[$endpage]['olm'] != $this->pagedim[$startpage]['olm'])) {
19726 $this->x += ($this->pagedim[$endpage]['olm'] - $this->pagedim[$startpage]['olm']);
19727 }
19728 }
19729 }
19730 if (!$in_table_head) { // we are not inside a thead section
19731 $this->cell_padding = $table_el['old_cell_padding'];
19732 // reset row height
19733 $this->resetLastH();
19734 if (($this->page == ($this->numpages - 1)) AND ($this->pageopen[$this->numpages])) {
19736 if (($plendiff > 0) AND ($plendiff < 60)) {
19737 $pagediff = substr($this->getPageBuffer($this->numpages), $this->emptypagemrk[$this->numpages], $plendiff);
19738 if (substr($pagediff, 0, 5) == 'BT /F') {
19739 // the difference is only a font setting
19740 $plendiff = 0;
19741 }
19742 }
19743 if ($plendiff == 0) {
19744 // remove last blank page
19745 $this->deletePage($this->numpages);
19746 }
19747 }
19748 if (isset($this->theadMargins['top'])) {
19749 // restore top margin
19750 $this->tMargin = $this->theadMargins['top'];
19751 }
19752 if (!isset($table_el['attribute']['nested']) OR ($table_el['attribute']['nested'] != 'true')) {
19753 // reset main table header
19754 $this->thead = '';
19755 $this->theadMargins = array();
19757 }
19758 }
19759 $parent = $table_el;
19760 break;
19761 }
19762 case 'a': {
19763 $this->HREF = '';
19764 break;
19765 }
19766 case 'sup': {
19768 break;
19769 }
19770 case 'sub': {
19772 break;
19773 }
19774 case 'div': {
19776 break;
19777 }
19778 case 'blockquote': {
19779 if ($this->rtl) {
19780 $this->rMargin -= $this->listindent;
19781 } else {
19782 $this->lMargin -= $this->listindent;
19783 }
19784 --$this->listindentlevel;
19786 break;
19787 }
19788 case 'p': {
19790 break;
19791 }
19792 case 'pre': {
19794 $this->premode = false;
19795 break;
19796 }
19797 case 'dl': {
19798 --$this->listnum;
19799 if ($this->listnum <= 0) {
19800 $this->listnum = 0;
19802 } else {
19804 }
19805 $this->resetLastH();
19806 break;
19807 }
19808 case 'dt': {
19809 $this->lispacer = '';
19811 break;
19812 }
19813 case 'dd': {
19814 $this->lispacer = '';
19815 if ($this->rtl) {
19816 $this->rMargin -= $this->listindent;
19817 } else {
19818 $this->lMargin -= $this->listindent;
19819 }
19820 --$this->listindentlevel;
19822 break;
19823 }
19824 case 'ul':
19825 case 'ol': {
19826 --$this->listnum;
19827 $this->lispacer = '';
19828 if ($this->rtl) {
19829 $this->rMargin -= $this->listindent;
19830 } else {
19831 $this->lMargin -= $this->listindent;
19832 }
19833 --$this->listindentlevel;
19834 if ($this->listnum <= 0) {
19835 $this->listnum = 0;
19837 } else {
19839 }
19840 $this->resetLastH();
19841 break;
19842 }
19843 case 'li': {
19844 $this->lispacer = '';
19846 break;
19847 }
19848 case 'h1':
19849 case 'h2':
19850 case 'h3':
19851 case 'h4':
19852 case 'h5':
19853 case 'h6': {
19855 break;
19856 }
19857 // Form fields (since 4.8.000 - 2009-09-07)
19858 case 'form': {
19859 $this->form_action = '';
19860 $this->form_enctype = 'application/x-www-form-urlencoded';
19861 break;
19862 }
19863 default : {
19864 break;
19865 }
19866 }
19867 // draw border and background (if any)
19868 $this->drawHTMLTagBorder($parent, $xmax);
19869 if (isset($dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'])) {
19870 $pba = $dom[($dom[$key]['parent'])]['attribute']['pagebreakafter'];
19871 // check for pagebreak
19872 if (($pba == 'true') OR ($pba == 'left') OR ($pba == 'right')) {
19873 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19874 $this->checkPageBreak($this->PageBreakTrigger + 1);
19875 }
19876 if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
19877 OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
19878 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19879 $this->checkPageBreak($this->PageBreakTrigger + 1);
19880 }
19881 }
19882 $this->tmprtl = false;
19883 return $dom;
19884 }
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:7508
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:20248
addHTMLVertSpace($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false)
Add vertical spaces if needed.
Definition: tcpdf.php:19895
setPage($pnum, $resetmargins=false)
Move pointer at the specified document page and update page dimensions.
Definition: tcpdf.php:2995
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 14029 of file tcpdf.php.
14029 {
14030 if (strpos($colors, 'ALLSPOT') !== false) {
14031 // expand spot colors
14033 foreach ($this->spot_colors as $spot_color_name => $v) {
14035 }
14039 } else {
14040 $colors = str_replace('ALLSPOT', 'NONE', $colors);
14041 }
14042 }
14043 $bars = explode(',', $colors);
14044 $numbars = count($bars); // number of bars to print
14045 if ($numbars <= 0) {
14046 return;
14047 }
14048 // set bar measures
14049 if ($vertical) {
14050 $coords = array(0, 0, 0, 1);
14053 $xd = $wb; // delta x
14054 $yd = 0; // delta y
14055 } else {
14056 $coords = array(1, 0, 0, 0);
14059 $xd = 0; // delta x
14060 $yd = $hb; // delta y
14061 }
14062 $xb = $x;
14063 $yb = $y;
14064 foreach ($bars as $col) {
14065 switch ($col) {
14066 // set transition colors
14067 case 'A': { // BLACK (GRAYSCALE)
14068 $col_a = array(255);
14069 $col_b = array(0);
14070 break;
14071 }
14072 case 'W': { // WHITE (GRAYSCALE)
14073 $col_a = array(0);
14074 $col_b = array(255);
14075 break;
14076 }
14077 case 'R': { // RED (RGB)
14078 $col_a = array(255,255,255);
14079 $col_b = array(255,0,0);
14080 break;
14081 }
14082 case 'G': { // GREEN (RGB)
14083 $col_a = array(255,255,255);
14084 $col_b = array(0,255,0);
14085 break;
14086 }
14087 case 'B': { // BLUE (RGB)
14088 $col_a = array(255,255,255);
14089 $col_b = array(0,0,255);
14090 break;
14091 }
14092 case 'C': { // CYAN (CMYK)
14093 $col_a = array(0,0,0,0);
14094 $col_b = array(100,0,0,0);
14095 break;
14096 }
14097 case 'M': { // MAGENTA (CMYK)
14098 $col_a = array(0,0,0,0);
14099 $col_b = array(0,100,0,0);
14100 break;
14101 }
14102 case 'Y': { // YELLOW (CMYK)
14103 $col_a = array(0,0,0,0);
14104 $col_b = array(0,0,100,0);
14105 break;
14106 }
14107 case 'K': { // KEY - BLACK (CMYK)
14108 $col_a = array(0,0,0,0);
14109 $col_b = array(0,0,0,100);
14110 break;
14111 }
14112 case 'RGB': { // BLACK REGISTRATION (RGB)
14113 $col_a = array(255,255,255);
14114 $col_b = array(0,0,0);
14115 break;
14116 }
14117 case 'CMYK': { // BLACK REGISTRATION (CMYK)
14118 $col_a = array(0,0,0,0);
14119 $col_b = array(100,100,100,100);
14120 break;
14121 }
14122 case 'ALL': { // SPOT COLOR REGISTRATION
14123 $col_a = array(0,0,0,0,'None');
14124 $col_b = array(100,100,100,100,'All');
14125 break;
14126 }
14127 case 'NONE': { // SKIP THIS COLOR
14128 $col_a = array(0,0,0,0,'None');
14129 $col_b = array(0,0,0,0,'None');
14130 break;
14131 }
14132 default: { // SPECIFIC SPOT COLOR NAME
14133 $col_a = array(0,0,0,0,'None');
14134 $col_b = TCPDF_COLORS::getSpotColor($col, $this->spot_colors);
14135 if ($col_b === false) {
14136 // in case of error defaults to the registration color
14137 $col_b = array(100,100,100,100,'All');
14138 }
14139 break;
14140 }
14141 }
14142 if ($col != 'NONE') {
14143 if ($transition) {
14144 // color gradient
14146 } else {
14147 $this->SetFillColorArray($col_b);
14148 // colored rectangle
14150 }
14151 $xb += $xd;
14152 $yb += $yd;
14153 }
14154 }
14155 }
LinearGradient($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0))
Paints a linear colour gradient.
Definition: tcpdf.php:14311
Rect($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array())
Draws a rectangle.
Definition: tcpdf.php:11512
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 12956 of file tcpdf.php.
12956 {
12959 }
12962 }
12963 // check page for no-write regions and adapt page margins if necessary
12967 $s = '';
12968 foreach ($values as $value) {
12969 if (is_array($value)) {
12970 $s .= ',[\''.addslashes($value[1]).'\',\''.addslashes($value[0]).'\']';
12971 } else {
12972 $s .= ',[\''.addslashes($value).'\',\''.addslashes($value).'\']';
12973 }
12974 }
12975 $this->javascript .= 'f'.$name.'.setItems('.substr($s, 1).');'."\n";
12976 return;
12977 }
12978 // get default style
12979 $prop = array_merge($this->getFormDefaultProp(), $prop);
12980 $prop['Combo'] = true;
12981 // get annotation data
12982 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12983 // set additional default options
12984 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12985 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12986 $popt['da'] = $fontstyle;
12987 // build appearance stream
12988 $popt['ap'] = array();
12989 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12990 $text = '';
12991 foreach($values as $item) {
12992 if (is_array($item)) {
12993 $text .= $item[1]."\n";
12994 } else {
12995 $text .= $item."\n";
12996 }
12997 }
12998 $tmpid = $this->startTemplate($w, $h, false);
12999 $this->MultiCell($w, $h, $text, 0, '', false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
13000 $this->endTemplate();
13001 --$this->n;
13002 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
13003 unset($this->xobjects[$tmpid]);
13004 $popt['ap']['n'] .= 'Q EMC';
13005 // merge options
13006 $opt = array_merge($popt, $opt);
13007 // set remaining annotation data
13008 $opt['Subtype'] = 'Widget';
13009 $opt['ft'] = 'Ch';
13010 $opt['t'] = $name;
13011 $opt['opt'] = $values;
13012 unset($opt['mk']['ca']);
13013 unset($opt['mk']['rc']);
13014 unset($opt['mk']['ac']);
13015 unset($opt['mk']['i']);
13016 unset($opt['mk']['ri']);
13017 unset($opt['mk']['ix']);
13018 unset($opt['mk']['if']);
13019 unset($opt['mk']['tp']);
13020 $this->Annotation($x, $y, $w, $h, $name, $opt, 0);
13021 if ($this->rtl) {
13022 $this->x -= $w;
13023 } else {
13024 $this->x += $w;
13025 }
13026 }
◆ 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 14352 of file tcpdf.php.
14352 {
14353 if ($this->pdfa_mode OR ($this->state != 2)) {
14354 return;
14355 }
14357 $n = count($this->gradients) + 1;
14358 $this->gradients[$n] = array();
14364 //check the coords array if it is the simple array or the multi patch array
14366 //simple array -> convert to multi patch array
14367 if (!isset($col1[1])) {
14368 $col1[1] = $col1[2] = $col1[0];
14369 }
14370 if (!isset($col2[1])) {
14371 $col2[1] = $col2[2] = $col2[0];
14372 }
14373 if (!isset($col3[1])) {
14374 $col3[1] = $col3[2] = $col3[0];
14375 }
14376 if (!isset($col4[1])) {
14377 $col4[1] = $col4[2] = $col4[0];
14378 }
14393 } else {
14394 //multi patch array
14396 }
14397 $bpcd = 65535; //16 bits per coordinate
14398 //build the data stream
14400 $count_patch = count($patch_array);
14401 for ($i=0; $i < $count_patch; ++$i) {
14402 $this->gradients[$n]['stream'] .= chr($patch_array[$i]['f']); //start with the edge flag as 8 bit
14404 for ($j=0; $j < $count_points; ++$j) {
14405 //each point as 16 bit
14406 $patch_array[$i]['points'][$j] = (($patch_array[$i]['points'][$j] - $coords_min) / ($coords_max - $coords_min)) * $bpcd;
14409 }
14412 }
14415 }
14417 for ($j=0; $j < $count_cols; ++$j) {
14418 //each color component as 8 bit
14422 }
14423 }
14424 //paint the gradient
14426 //restore previous Graphic State
14427 $this->_outRestoreGraphicsState();
14428 if ($this->inxobj) {
14429 // we are inside an XObject template
14431 }
14432 }
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 21201 of file tcpdf.php.
21201 {
21203 // default value
21205 }
21207 return false;
21208 }
21209 // close the last page
21210 $this->endPage();
21211 // copy all page-related states
21212 ++$this->numpages;
21213 $this->page = $this->numpages;
21224 }
21227 }
21230 }
21233 }
21235 // start a new group
21237 $this->currpagegroup = $this->newpagegroup[$this->page];
21238 $this->pagegroups[$this->currpagegroup] = 1;
21239 } elseif (isset($this->currpagegroup) AND ($this->currpagegroup > 0)) {
21240 ++$this->pagegroups[$this->currpagegroup];
21241 }
21242 // copy outlines
21243 $tmpoutlines = $this->outlines;
21244 foreach ($tmpoutlines as $key => $outline) {
21246 $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']);
21247 }
21248 }
21249 // copy links
21250 $tmplinks = $this->links;
21251 foreach ($tmplinks as $key => $link) {
21253 $this->links[] = array('p' => $this->page, 'y' => $link['y'], 'f' => $link['f']);
21254 }
21255 }
21256 // return to last page
21258 return true;
21259 }
$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 14169 of file tcpdf.php.
14169 {
14170 $this->SetLineStyle(array('width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $color));
14171 $type = strtoupper($type);
14172 $type = preg_replace('/[^A-Z\-\,]*/', '', $type);
14173 // split type in single components
14174 $type = str_replace('-', ',', $type);
14175 $type = str_replace('TL', 'T,L', $type);
14176 $type = str_replace('TR', 'T,R', $type);
14177 $type = str_replace('BL', 'F,L', $type);
14178 $type = str_replace('BR', 'F,R', $type);
14179 $type = str_replace('A', 'T,L', $type);
14180 $type = str_replace('B', 'T,R', $type);
14181 $type = str_replace('T,RO', 'BO', $type);
14182 $type = str_replace('C', 'F,L', $type);
14183 $type = str_replace('D', 'F,R', $type);
14184 $crops = explode(',', strtoupper($type));
14185 // remove duplicates
14186 $crops = array_unique($crops);
14189 foreach ($crops as $crop) {
14190 switch ($crop) {
14191 case 'T':
14192 case 'TOP': {
14193 $x1 = $x;
14195 $x2 = $x;
14196 $y2 = ($y - $dh);
14197 break;
14198 }
14199 case 'F':
14200 case 'BOTTOM': {
14201 $x1 = $x;
14202 $y1 = ($y + $dh);
14203 $x2 = $x;
14205 break;
14206 }
14207 case 'L':
14208 case 'LEFT': {
14210 $y1 = $y;
14211 $x2 = ($x - $dw);
14212 $y2 = $y;
14213 break;
14214 }
14215 case 'R':
14216 case 'RIGHT': {
14217 $x1 = ($x + $dw);
14218 $y1 = $y;
14220 $y2 = $y;
14221 break;
14222 }
14223 }
14224 $this->Line($x1, $y1, $x2, $y2);
14225 }
14226 }
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 11583 of file tcpdf.php.
11583 {
11584 if ($this->state != 2) {
11585 return;
11586 }
11588 $this->SetFillColorArray($fill_color);
11589 }
11591 if ($line_style) {
11592 $this->SetLineStyle($line_style);
11593 }
11594 $this->_outPoint($x0, $y0);
11595 $this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
11596 $this->_out($op);
11597 }
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 21011 of file tcpdf.php.
21011 {
21013 return false;
21014 }
21015 // delete current page
21016 unset($this->pages[$page]);
21017 unset($this->pagedim[$page]);
21018 unset($this->pagelen[$page]);
21019 unset($this->intmrk[$page]);
21020 unset($this->bordermrk[$page]);
21021 unset($this->cntmrk[$page]);
21023 if (isset($this->offsets[$oid])){
21024 unset($this->offsets[$oid]);
21025 }
21026 }
21027 unset($this->pageobjects[$page]);
21029 unset($this->footerpos[$page]);
21030 }
21032 unset($this->footerlen[$page]);
21033 }
21035 unset($this->transfmrk[$page]);
21036 }
21038 unset($this->PageAnnots[$page]);
21039 }
21040 if (isset($this->newpagegroup) AND !empty($this->newpagegroup)) {
21042 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $page)) {
21043 --$this->pagegroups[$this->newpagegroup[$i]];
21044 break;
21045 }
21046 }
21047 }
21049 unset($this->pageopen[$page]);
21050 }
21051 if ($page < $this->numpages) {
21052 // update remaining pages
21054 $j = $i + 1;
21055 // shift pages
21057 $this->pagedim[$i] = $this->pagedim[$j];
21058 $this->pagelen[$i] = $this->pagelen[$j];
21059 $this->intmrk[$i] = $this->intmrk[$j];
21060 $this->bordermrk[$i] = $this->bordermrk[$j];
21061 $this->cntmrk[$i] = $this->cntmrk[$j];
21062 $this->pageobjects[$i] = $this->pageobjects[$j];
21063 if (isset($this->footerpos[$j])) {
21064 $this->footerpos[$i] = $this->footerpos[$j];
21065 } elseif (isset($this->footerpos[$i])) {
21066 unset($this->footerpos[$i]);
21067 }
21068 if (isset($this->footerlen[$j])) {
21069 $this->footerlen[$i] = $this->footerlen[$j];
21070 } elseif (isset($this->footerlen[$i])) {
21071 unset($this->footerlen[$i]);
21072 }
21073 if (isset($this->transfmrk[$j])) {
21074 $this->transfmrk[$i] = $this->transfmrk[$j];
21075 } elseif (isset($this->transfmrk[$i])) {
21076 unset($this->transfmrk[$i]);
21077 }
21078 if (isset($this->PageAnnots[$j])) {
21079 $this->PageAnnots[$i] = $this->PageAnnots[$j];
21080 } elseif (isset($this->PageAnnots[$i])) {
21081 unset($this->PageAnnots[$i]);
21082 }
21083 if (isset($this->newpagegroup[$j])) {
21084 $this->newpagegroup[$i] = $this->newpagegroup[$j];
21085 unset($this->newpagegroup[$j]);
21086 }
21087 if ($this->currpagegroup == $j) {
21088 $this->currpagegroup = $i;
21089 }
21090 if (isset($this->pageopen[$j])) {
21091 $this->pageopen[$i] = $this->pageopen[$j];
21092 } elseif (isset($this->pageopen[$i])) {
21093 unset($this->pageopen[$i]);
21094 }
21095 }
21096 // remove last page
21097 unset($this->pages[$this->numpages]);
21098 unset($this->pagedim[$this->numpages]);
21099 unset($this->pagelen[$this->numpages]);
21100 unset($this->intmrk[$this->numpages]);
21101 unset($this->bordermrk[$this->numpages]);
21102 unset($this->cntmrk[$this->numpages]);
21103 foreach ($this->pageobjects[$this->numpages] as $oid) {
21104 if (isset($this->offsets[$oid])){
21105 unset($this->offsets[$oid]);
21106 }
21107 }
21108 unset($this->pageobjects[$this->numpages]);
21109 if (isset($this->footerpos[$this->numpages])) {
21110 unset($this->footerpos[$this->numpages]);
21111 }
21112 if (isset($this->footerlen[$this->numpages])) {
21113 unset($this->footerlen[$this->numpages]);
21114 }
21115 if (isset($this->transfmrk[$this->numpages])) {
21116 unset($this->transfmrk[$this->numpages]);
21117 }
21118 if (isset($this->PageAnnots[$this->numpages])) {
21119 unset($this->PageAnnots[$this->numpages]);
21120 }
21121 if (isset($this->newpagegroup[$this->numpages])) {
21122 unset($this->newpagegroup[$this->numpages]);
21123 }
21124 if ($this->currpagegroup == $this->numpages) {
21125 $this->currpagegroup = ($this->numpages - 1);
21126 }
21127 if (isset($this->pagegroups[$this->numpages])) {
21128 unset($this->pagegroups[$this->numpages]);
21129 }
21130 if (isset($this->pageopen[$this->numpages])) {
21131 unset($this->pageopen[$this->numpages]);
21132 }
21133 }
21134 --$this->numpages;
21135 $this->page = $this->numpages;
21136 // adjust outlines
21137 $tmpoutlines = $this->outlines;
21138 foreach ($tmpoutlines as $key => $outline) {
21139 if (!$outline['f']) {
21141 $this->outlines[$key]['p'] = $outline['p'] - 1;
21143 unset($this->outlines[$key]);
21144 }
21145 }
21146 }
21147 // adjust dests
21148 $tmpdests = $this->dests;
21149 foreach ($tmpdests as $key => $dest) {
21150 if (!$dest['f']) {
21152 $this->dests[$key]['p'] = $dest['p'] - 1;
21154 unset($this->dests[$key]);
21155 }
21156 }
21157 }
21158 // adjust links
21159 $tmplinks = $this->links;
21160 foreach ($tmplinks as $key => $link) {
21161 if (!$link['f']) {
21163 $this->links[$key]['p'] = $link['p'] - 1;
21165 unset($this->links[$key]);
21166 }
21167 }
21168 }
21169 // adjust javascript
21170 $jpage = $page;
21171 if (preg_match_all('/this\.addField\(\'([^\']*)\',\'([^\']*)\',([0-9]+)/', $this->javascript, $pamatch) > 0) {
21172 foreach($pamatch[0] as $pk => $pmatch) {
21173 $pagenum = intval($pamatch[3][$pk]) + 1;
21174 if ($pagenum >= $jpage) {
21175 $newpage = ($pagenum - 1);
21176 } elseif ($pagenum == $jpage) {
21177 $newpage = 1;
21178 } else {
21179 $newpage = $pagenum;
21180 }
21181 --$newpage;
21182 $newjs = "this.addField(\'".$pamatch[1][$pk]."\',\'".$pamatch[2][$pk]."\',".$newpage;
21183 $this->javascript = str_replace($pmatch, $newjs, $this->javascript);
21184 }
21185 unset($pamatch);
21186 }
21187 // return to last page
21188 if ($this->numpages > 0) {
21190 }
21191 return true;
21192 }
$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 19937 of file tcpdf.php.
19937 {
19938 if (!isset($tag['borderposition'])) {
19939 // nothing to draw
19940 return;
19941 }
19942 $prev_x = $this->x;
19943 $prev_y = $this->y;
19944 $prev_lasth = $this->lasth;
19945 $border = 0;
19946 $fill = false;
19947 $this->lasth = 0;
19948 if (isset($tag['border']) AND !empty($tag['border'])) {
19949 // get border style
19952 // border for table header
19954 }
19955 }
19956 if (isset($tag['bgcolor']) AND ($tag['bgcolor'] !== false)) {
19957 // get background color
19958 $old_bgcolor = $this->bgcolor;
19960 $fill = true;
19961 }
19963 // nothing to draw
19964 return;
19965 }
19966 if (isset($tag['attribute']['cellspacing'])) {
19968 $cellspacing = array('H' => $clsp, 'V' => $clsp);
19969 } elseif (isset($tag['border-spacing'])) {
19970 $cellspacing = $tag['border-spacing'];
19971 } else {
19972 $cellspacing = array('H' => 0, 'V' => 0);
19973 }
19975 // draw the border externally respect the sqare edge.
19977 }
19978 if ($this->rtl) {
19979 if ($xmax >= $tag['borderposition']['x']) {
19980 $xmax = $tag['borderposition']['xmax'];
19981 }
19983 } else {
19984 if ($xmax <= $tag['borderposition']['x']) {
19985 $xmax = $tag['borderposition']['xmax'];
19986 }
19988 }
19990 return;
19991 }
19993 $startpage = $tag['borderposition']['page'];
19994 $startcolumn = $tag['borderposition']['column'];
19997 $endpage = $this->page;
19999 $currentY = $this->y;
20000 $this->x = $x;
20001 // get latest column
20002 $endcolumn = $this->current_column;
20003 if ($this->num_columns == 0) {
20004 $this->num_columns = 1;
20005 }
20006 // get border modes
20010 // temporary disable page regions
20011 $temp_page_regions = $this->page_regions;
20012 $this->page_regions = array();
20013 // design borders around HTML cells.
20015 $ccode = '';
20017 if ($this->num_columns < 2) {
20018 // single-column mode
20019 $this->x = $x;
20020 $this->y = $this->tMargin;
20021 }
20022 // account for margin changes
20026 } elseif ((!$this->rtl) AND ($this->pagedim[$page]['olm'] != $this->pagedim[$startpage]['olm'])) {
20028 }
20029 }
20030 if ($startpage == $endpage) {
20031 // single page
20032 for ($column = $startcolumn; $column <= $endcolumn; ++$column) { // for each column
20033 $this->selectColumn($column);
20034 if ($startcolumn == $endcolumn) { // single column
20035 $cborder = $border;
20037 $this->y = $starty;
20038 } elseif ($column == $startcolumn) { // first column
20039 $cborder = $border_start;
20040 $this->y = $starty;
20042 } elseif ($column == $endcolumn) { // end column
20043 $cborder = $border_end;
20045 } else { // middle column
20046 $cborder = $border_middle;
20048 }
20050 } // end for each column
20053 $this->selectColumn($column);
20054 if ($column == $startcolumn) { // first column
20055 $cborder = $border_start;
20056 $this->y = $starty;
20058 } else { // middle column
20059 $cborder = $border_middle;
20061 }
20063 } // end for each column
20065 for ($column = 0; $column <= $endcolumn; ++$column) { // for each column
20066 $this->selectColumn($column);
20067 if ($column == $endcolumn) {
20068 // end column
20069 $cborder = $border_end;
20071 } else {
20072 // middle column
20073 $cborder = $border_middle;
20075 }
20077 } // end for each column
20078 } else { // middle page
20080 $this->selectColumn($column);
20081 $cborder = $border_middle;
20084 } // end for each column
20085 }
20086 if ($cborder OR $fill) {
20087 $offsetlen = strlen($ccode);
20088 // draw border and fill
20089 if ($this->inxobj) {
20090 // we are inside an XObject template
20091 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
20092 $pagemarkkey = key($this->xobjects[$this->xobjid]['transfmrk']);
20095 } else {
20098 }
20100 $pstart = substr($pagebuff, 0, $pagemark);
20101 $pend = substr($pagebuff, $pagemark);
20103 } else {
20104 if (end($this->transfmrk[$this->page]) !== false) {
20105 $pagemarkkey = key($this->transfmrk[$this->page]);
20106 $pagemark = $this->transfmrk[$this->page][$pagemarkkey];
20107 } elseif ($this->InFooter) {
20108 $pagemark = $this->footerpos[$this->page];
20109 } else {
20110 $pagemark = $this->intmrk[$this->page];
20111 }
20112 $pagebuff = $this->getPageBuffer($this->page);
20113 $pstart = substr($pagebuff, 0, $pagemark);
20114 $pend = substr($pagebuff, $pagemark);
20115 $this->setPageBuffer($this->page, $pstart.$ccode.$pend);
20116 $this->bordermrk[$this->page] += $offsetlen;
20117 $this->cntmrk[$this->page] += $offsetlen;
20118 }
20119 }
20120 } // end for each page
20121 // restore page regions
20122 $this->page_regions = $temp_page_regions;
20123 if (isset($old_bgcolor)) {
20124 // restore background color
20125 $this->SetFillColorArray($old_bgcolor);
20126 }
20127 // restore pointer position
20128 $this->x = $prev_x;
20129 $this->y = $prev_y;
20130 $this->lasth = $prev_lasth;
20131 }
References $bMargin, $border, $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 11653 of file tcpdf.php.
11653 {
11654 if ($this->state != 2) {
11655 return;
11656 }
11658 $ry = $rx;
11659 }
11661 $this->SetFillColorArray($fill_color);
11662 }
11664 if ($op == 'f') {
11665 $line_style = array();
11666 }
11667 if ($line_style) {
11668 $this->SetLineStyle($line_style);
11669 }
11670 $this->_outellipticalarc($x0, $y0, $rx, $ry, $angle, $astart, $afinish, false, $nc, true, true, false);
11671 $this->_out($op);
11672 }
_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:11694
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 13746 of file tcpdf.php.
13746 {
13747 if ($this->state != 2) {
13748 return;
13749 }
13750 if ($this->openMarkedContent) {
13751 // close existing open marked-content layer
13753 $this->openMarkedContent = false;
13754 }
13755 }
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 24373 of file tcpdf.php.
24373 {
24374 $name = $this->removeTagNamespace($name);
24375 if ($this->svgdefsmode AND !in_array($name, array('defs', 'clipPath', 'linearGradient', 'radialGradient', 'stop'))) {;
24376 if (end($this->svgdefs) !== FALSE) {
24377 $last_svgdefs_id = key($this->svgdefs);
24378 if (isset($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'])) {
24379 foreach($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'] as $child_element) {
24380 if (isset($child_element['attribs']['id']) AND ($child_element['name'] == $name)) {
24381 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$child_element['attribs']['id'].'_CLOSE'] = array('name' => $name, 'attribs' => array('closing_tag' => TRUE, 'content' => $this->svgtext));
24382 return;
24383 }
24384 }
24385 if ($this->svgdefs[$last_svgdefs_id]['name'] == $name) {
24386 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$last_svgdefs_id.'_CLOSE'] = array('name' => $name, 'attribs' => array('closing_tag' => TRUE, 'content' => $this->svgtext));
24387 return;
24388 }
24389 }
24390 }
24391 return;
24392 }
24393 switch($name) {
24394 case 'defs': {
24395 $this->svgdefsmode = false;
24396 break;
24397 }
24398 // clipPath
24399 case 'clipPath': {
24400 $this->svgclipmode = false;
24401 break;
24402 }
24403 case 'svg': {
24404 if (--$this->svg_tag_depth <= 0) {
24405 break;
24406 }
24407 }
24408 case 'g': {
24409 // ungroup: remove last style from array
24410 array_pop($this->svgstyles);
24411 $this->StopTransform();
24412 break;
24413 }
24414 case 'text':
24415 case 'tspan': {
24416 if ($this->svgtextmode['invisible']) {
24417 // This implementation must be fixed to following the rule:
24418 // 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.
24419 break;
24420 }
24421 // print text
24423 //$text = $this->stringTrim($text);
24425 if ($this->svgtextmode['text-anchor'] != 'start') {
24426 // check if string is RTL text
24427 if ($this->svgtextmode['text-anchor'] == 'end') {
24428 if ($this->svgtextmode['rtl']) {
24429 $this->x += $textlen;
24430 } else {
24431 $this->x -= $textlen;
24432 }
24433 } elseif ($this->svgtextmode['text-anchor'] == 'middle') {
24434 if ($this->svgtextmode['rtl']) {
24435 $this->x += ($textlen / 2);
24436 } else {
24437 $this->x -= ($textlen / 2);
24438 }
24439 }
24440 }
24444 if ($name == 'text') {
24445 // store current coordinates
24446 $tmpx = $this->x;
24447 $tmpy = $this->y;
24448 }
24449 // print the text
24451 if ($name == 'text') {
24452 // restore coordinates
24453 $this->x = $tmpx;
24454 $this->y = $tmpy;
24455 }
24456 // restore previous rendering mode
24457 $this->textrendermode = $textrendermode;
24458 $this->textstrokewidth = $textstrokewidth;
24459 $this->svgtext = '';
24460 $this->StopTransform();
24461 if (!$this->svgdefsmode) {
24462 array_pop($this->svgstyles);
24463 }
24464 break;
24465 }
24466 default: {
24467 break;
24468 }
24469 }
24470 }
StopTransform()
Stops a 2D tranformation restoring previous graphic state.
Definition: tcpdf.php:10969
$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 22294 of file tcpdf.php.
22294 {
22295 if (!$this->inxobj) {
22296 // we are not inside a template
22297 return false;
22298 }
22299 $this->inxobj = false;
22300 // restore previous graphic state
22303 }
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(), 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 //$ratio_wh = ($w / $h);
6769 // PATCH BEGIN
6771 {
6773 }
6774 else
6775 {
6776 $ratio_wh = 1;
6777 }
6778 // PATCH END
6779
6783 }
6790 }
6791 }
6793 }
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 15833 of file tcpdf.php.
15833 {
15834 return TCPDF_STATIC::fixHTMLCode($html, $default_css, $tagvs, $tidy_options, $this->tagvspaces);
15835 }
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:13611
write1DBarcode($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='')
Print a Linear Barcode.
Definition: tcpdf.php:15198
getAliasRightShift()
Returns the string alias used right align page numbers.
Definition: tcpdf.php:13585
SetY($y, $resetx=true, $rtloff=false)
Moves the current abscissa back to the left margin and sets the ordinate.
Definition: tcpdf.php:7475
getPageGroupAlias()
Return the alias for the total number of pages in the current page group.
Definition: tcpdf.php:13641
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 13611 of file tcpdf.php.
13611 {
13613 return '{'.TCPDF_STATIC::$alias_tot_pages.'}';
13614 }
13616 }
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 13626 of file tcpdf.php.
13626 {
13628 return '{'.TCPDF_STATIC::$alias_num_page.'}';
13629 }
13631 }
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 13585 of file tcpdf.php.
13585 {
13586 // calculate aproximatively the ratio between widths of aliases and replacements.
13587 $ref = '{'.TCPDF_STATIC::$alias_right_shift.'}{'.TCPDF_STATIC::$alias_tot_pages.'}{'.TCPDF_STATIC::$alias_num_page.'}';
13589 $wrep = $this->GetStringWidth($rep);
13590 if ($wrep > 0) {
13591 $wdiff = max(1, ($this->GetStringWidth($ref) / $wrep));
13592 } else {
13593 $wdiff = 1;
13594 }
13595 $sdiff = sprintf('%F', $wdiff);
13598 $alias = '{'.$alias;
13599 }
13600 return $alias;
13601 }
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(), and isUnicodeFont().
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 7830 of file tcpdf.php.
7830 {
7831 $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);
7832 $pnalias = array();
7835 }
7836 return $pnalias;
7837 }
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 19921 of file tcpdf.php.
19921 {
19922 if ($this->rtl) {
19923 $xmax = $this->lMargin;
19924 } else {
19925 $xmax = $this->w - $this->rMargin;
19926 }
19927 return array('page' => $this->page, 'column' => $this->current_column, 'x' => $this->x, 'y' => $this->y, 'xmax' => $xmax);
19928 }
◆ 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) {
5645 $s .= sprintf('%F %F m ', $xL, $yL);
5646 $s .= sprintf('%F %F l ', $xT, $yT);
5647 $s .= sprintf('%F %F l ', $xR, $yR);
5648 $s .= sprintf('%F %F l ', $xB, $yB);
5649 $s .= 'S ';
5651 $s .= sprintf('%F %F m ', $xT, $yT);
5652 $s .= sprintf('%F %F l ', $xR, $yR);
5653 $s .= sprintf('%F %F l ', $xB, $yB);
5654 $s .= sprintf('%F %F l ', $xL, $yL);
5655 $s .= 'S ';
5657 $s .= sprintf('%F %F m ', $xR, $yR);
5658 $s .= sprintf('%F %F l ', $xB, $yB);
5659 $s .= sprintf('%F %F l ', $xL, $yL);
5660 $s .= sprintf('%F %F l ', $xT, $yT);
5661 $s .= 'S ';
5663 $s .= sprintf('%F %F m ', $xB, $yB);
5664 $s .= sprintf('%F %F l ', $xL, $yL);
5665 $s .= sprintf('%F %F l ', $xT, $yT);
5666 $s .= sprintf('%F %F l ', $xR, $yR);
5667 $s .= 'S ';
5668 }
5669 } elseif (strlen($border) == 2) {
5671 $s .= sprintf('%F %F m ', $xL, $yL);
5672 $s .= sprintf('%F %F l ', $xT, $yT);
5673 $s .= sprintf('%F %F l ', $xR, $yR);
5674 $s .= 'S ';
5676 $s .= sprintf('%F %F m ', $xT, $yT);
5677 $s .= sprintf('%F %F l ', $xR, $yR);
5678 $s .= sprintf('%F %F l ', $xB, $yB);
5679 $s .= 'S ';
5681 $s .= sprintf('%F %F m ', $xR, $yR);
5682 $s .= sprintf('%F %F l ', $xB, $yB);
5683 $s .= sprintf('%F %F l ', $xL, $yL);
5684 $s .= 'S ';
5686 $s .= sprintf('%F %F m ', $xB, $yB);
5687 $s .= sprintf('%F %F l ', $xL, $yL);
5688 $s .= sprintf('%F %F l ', $xT, $yT);
5689 $s .= 'S ';
5691 $s .= sprintf('%F %F m ', $xL, $yL);
5692 $s .= sprintf('%F %F l ', $xT, $yT);
5693 $s .= 'S ';
5694 $s .= sprintf('%F %F m ', $xR, $yR);
5695 $s .= sprintf('%F %F l ', $xB, $yB);
5696 $s .= 'S ';
5698 $s .= sprintf('%F %F m ', $xT, $yT);
5699 $s .= sprintf('%F %F l ', $xR, $yR);
5700 $s .= 'S ';
5701 $s .= sprintf('%F %F m ', $xB, $yB);
5702 $s .= sprintf('%F %F l ', $xL, $yL);
5703 $s .= 'S ';
5704 }
5705 } else { // strlen($border) == 1
5707 $s .= sprintf('%F %F m ', $xL, $yL);
5708 $s .= sprintf('%F %F l ', $xT, $yT);
5709 $s .= 'S ';
5711 $s .= sprintf('%F %F m ', $xT, $yT);
5712 $s .= sprintf('%F %F l ', $xR, $yR);
5713 $s .= 'S ';
5715 $s .= sprintf('%F %F m ', $xR, $yR);
5716 $s .= sprintf('%F %F l ', $xB, $yB);
5717 $s .= 'S ';
5719 $s .= sprintf('%F %F m ', $xB, $yB);
5720 $s .= sprintf('%F %F l ', $xL, $yL);
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, and SetLineStyle().
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
5259 $output[] = $this->replaceChar($ch0, (0xf713 + $ch0 - 0x0e48));
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
5266 $output[] = $this->replaceChar($ch0, (0xf705 + $ch0 - 0x0e48));
5267 } elseif (in_array($ch1, $upvowel)) {
5268 if (in_array($ch2, $longtail)) {
5269 // tonemark at upper left
5270 $output[] = $this->replaceChar($ch0, (0xf713 + $ch0 - 0x0e48));
5271 } else {
5272 // tonemark at upper right (normal position)
5273 $output[] = $ch0;
5274 }
5275 } else {
5276 // tonemark at lower right
5277 $output[] = $this->replaceChar($ch0, (0xf70a + $ch0 - 0x0e48));
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
5292 $output[] = $this->replaceChar($ch0, 0xf710);
5293 } elseif (in_array($ch0, $upvowel)) {
5294 // lower left
5295 $output[] = $this->replaceChar($ch0, (0xf701 + $ch0 - 0x0e34));
5296 } elseif ($ch0 == 0x0e47) {
5297 // lower left mai tai koo
5298 $output[] = $this->replaceChar($ch0, 0xf712);
5299 } else {
5300 // normal character
5301 $output[] = $ch0;
5302 }
5303 } elseif (in_array($ch1, $lowtail) AND in_array($ch0, $lowvowel)) {
5304 // lower vowel
5305 $output[] = $this->replaceChar($ch0, (0xf718 + $ch0 - 0x0e38));
5306 } elseif (($ch0 == 0x0e0d) AND in_array($chn, $lowvowel)) {
5307 // yo ying without lower part
5308 $output[] = $this->replaceChar($ch0, 0xf70f);
5309 } elseif (($ch0 == 0x0e10) AND in_array($chn, $lowvowel)) {
5310 // tho santan without lower part
5311 $output[] = $this->replaceChar($ch0, 0xf700);
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
5357 $rs .= sprintf('BT %F Tz ET ', $this->font_stretching);
5358 }
5359 if ($this->font_spacing != 0) {
5360 // increase/decrease font spacing
5361 $rs .= sprintf('BT %F Tc ET ', ($this->font_spacing * $this->k));
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
5383 $txt2 = str_replace(chr(0).chr(32), ') '.sprintf('%F', $spacewidth).' (', $txt2);
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
5395 $rs .= sprintf('BT %F Tw ET ', $spacewidth);
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
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, $rMargin, $txt, $w, $x, $y, TCPDF_STATIC\_escape(), adjustCellPadding(), TCPDF_FONTS\arrUTF8ToUTF16BE(), checkPageRegions(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), getCellBorder(), getCellHeight(), GetNumChars(), GetStringWidth(), isCharDefined(), isUnicodeFont(), K_THAI_TOPCHARS, Link(), TCPDF_STATIC\removeSHY(), replaceChar(), setFontSubBuffer(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi(), TCPDF_FONTS\UTF8StringToArray(), and TCPDF_FONTS\UTF8ToLatin1().
Referenced by Cell(), and MultiCell().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 13984 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 15864 of file tcpdf.php.
15864 {
15866 case 'none':
15867 case 'hidden': {
15868 $dash = -1;
15869 break;
15870 }
15871 case 'dotted': {
15872 $dash = 1;
15873 break;
15874 }
15875 case 'dashed': {
15876 $dash = 3;
15877 break;
15878 }
15879 case 'double':
15880 case 'groove':
15881 case 'ridge':
15882 case 'inset':
15883 case 'outset':
15884 case 'solid':
15885 default: {
15886 $dash = 0;
15887 break;
15888 }
15889 }
15890 return $dash;
15891 }
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 16059 of file tcpdf.php.
16059 {
16061 $border_spacing = array(); // value to be returned
16063 case 2: {
16066 break;
16067 }
16068 case 1: {
16071 break;
16072 }
16073 default: {
16074 return array('H' => 0, 'V' => 0);
16075 }
16076 }
16077 if ($width == 0) {
16078 $width = $this->w - $this->lMargin - $this->rMargin;
16079 }
16082 return $border_spacing;
16083 }
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 15900 of file tcpdf.php.
15900 {
15901 $bprop = preg_split('/[\s]+/', trim($cssborder));
15903 switch (count($bprop)) {
15904 case 3: {
15905 $width = $bprop[0];
15906 $style = $bprop[1];
15907 $color = $bprop[2];
15908 break;
15909 }
15910 case 2: {
15911 $width = 'medium';
15912 $style = $bprop[0];
15913 $color = $bprop[1];
15914 break;
15915 }
15916 case 1: {
15917 $width = 'medium';
15918 $style = $bprop[0];
15919 $color = 'black';
15920 break;
15921 }
15922 default: {
15923 $width = 'medium';
15925 $color = 'black';
15926 break;
15927 }
15928 }
15930 return array();
15931 }
15936 return array();
15937 }
15941 }
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:15864
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 15844 of file tcpdf.php.
15844 {
15845 if ($width == 'thin') {
15846 $width = (2 / $this->k);
15847 } elseif ($width == 'medium') {
15848 $width = (4 / $this->k);
15849 } elseif ($width == 'thick') {
15850 $width = (6 / $this->k);
15851 } else {
15853 }
15854 return $width;
15855 }
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 16093 of file tcpdf.php.
16093 {
16094 $val = 0; // value to be returned
16095 $spacing = trim($spacing);
16096 switch ($spacing) {
16097 case 'normal': {
16098 $val = 0;
16099 break;
16100 }
16101 case 'inherit': {
16102 if ($parent == 'normal') {
16103 $val = 0;
16104 } else {
16105 $val = $parent;
16106 }
16107 break;
16108 }
16109 default: {
16111 }
16112 }
16113 return $val;
16114 }
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 16124 of file tcpdf.php.
16124 {
16125 $val = 100; // value to be returned
16126 $stretch = trim($stretch);
16127 switch ($stretch) {
16128 case 'ultra-condensed': {
16129 $val = 40;
16130 break;
16131 }
16132 case 'extra-condensed': {
16133 $val = 55;
16134 break;
16135 }
16136 case 'condensed': {
16137 $val = 70;
16138 break;
16139 }
16140 case 'semi-condensed': {
16141 $val = 85;
16142 break;
16143 }
16144 case 'normal': {
16145 $val = 100;
16146 break;
16147 }
16148 case 'semi-expanded': {
16149 $val = 115;
16150 break;
16151 }
16152 case 'expanded': {
16153 $val = 130;
16154 break;
16155 }
16156 case 'extra-expanded': {
16157 $val = 145;
16158 break;
16159 }
16160 case 'ultra-expanded': {
16161 $val = 160;
16162 break;
16163 }
16164 case 'wider': {
16165 $val = ($parent + 10);
16166 break;
16167 }
16168 case 'narrower': {
16169 $val = ($parent - 10);
16170 break;
16171 }
16172 case 'inherit': {
16173 if ($parent == 'normal') {
16174 $val = 100;
16175 } else {
16176 $val = $parent;
16177 }
16178 break;
16179 }
16180 default: {
16182 }
16183 }
16184 return $val;
16185 }
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 16005 of file tcpdf.php.
16005 {
16006 $margin = preg_split('/[\s]+/', trim($cssmargin));
16008 switch (count($margin)) {
16009 case 4: {
16014 break;
16015 }
16016 case 3: {
16021 break;
16022 }
16023 case 2: {
16028 break;
16029 }
16030 case 1: {
16035 break;
16036 }
16037 default: {
16039 }
16040 }
16041 if ($width == 0) {
16042 $width = $this->w - $this->lMargin - $this->rMargin;
16043 }
16044 $cell_margin['T'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['T']), $width, 'px', false);
16045 $cell_margin['R'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['R']), $width, 'px', false);
16046 $cell_margin['B'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['B']), $width, 'px', false);
16047 $cell_margin['L'] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $cell_margin['L']), $width, 'px', false);
16049 }
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 15951 of file tcpdf.php.
15951 {
15952 $padding = preg_split('/[\s]+/', trim($csspadding));
15954 switch (count($padding)) {
15955 case 4: {
15960 break;
15961 }
15962 case 3: {
15967 break;
15968 }
15969 case 2: {
15974 break;
15975 }
15976 case 1: {
15981 break;
15982 }
15983 default: {
15985 }
15986 }
15987 if ($width == 0) {
15988 $width = $this->w - $this->lMargin - $this->rMargin;
15989 }
15995 }
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 10209 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 10219 of file tcpdf.php.
10219 {
10221 }
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 20825 of file tcpdf.php.
20825 {
20826 if (isset($this->fonts[$font])) {
20827 return $this->fonts[$font];
20828 }
20829 return false;
20830 }
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 15807 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 22185 of file tcpdf.php.
22185 {
22186 // remove spaces and symbols
22187 $fontfamily = preg_replace('/[^a-z0-9_\,]/', '', strtolower($fontfamily));
22188 // extract all font names
22189 $fontslist = preg_split('/[,]/', $fontfamily);
22190 // find first valid font name
22191 foreach ($fontslist as $font) {
22192 // replace font variations
22193 $font = preg_replace('/regular$/', '', $font);
22194 $font = preg_replace('/italic$/', 'I', $font);
22195 $font = preg_replace('/oblique$/', 'I', $font);
22196 $font = preg_replace('/bold([I]?)$/', 'B\\1', $font);
22197 // replace common family names and core fonts
22198 $pattern = array();
22199 $replacement = array();
22200 $pattern[] = '/^serif|^cursive|^fantasy|^timesnewroman/';
22201 $replacement[] = 'times';
22202 $pattern[] = '/^sansserif/';
22203 $replacement[] = 'helvetica';
22204 $pattern[] = '/^monospace/';
22205 $replacement[] = 'courier';
22206 $font = preg_replace($pattern, $replacement, $font);
22207 if (in_array(strtolower($font), $this->fontlist) OR in_array($font, $this->fontkeys)) {
22208 return $font;
22209 }
22210 }
22211 // return current font as default
22212 return $this->CurrentFont['fontkey'];
22213 }
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 15797 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 15817 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 10333 of file tcpdf.php.
10333 {
10335 }
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 12628 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 7343 of file tcpdf.php.
7343 {
7344 if (!isset($this->gdgammacache['#'.$c])) {
7345 $colors = imagecolorsforindex($img, $c);
7346 // GD alpha is only 7 bit (0 -> 127)
7347 $this->gdgammacache['#'.$c] = (((127 - $colors['alpha']) / 127) * 255);
7348 // correct gamma
7349 $this->gdgammacache['#'.$c] = (pow(($this->gdgammacache['#'.$c] / 255), 2.2) * 255);
7350 // store the latest values on cache to improve performances
7351 if (count($this->gdgammacache) > 8) {
7352 // remove one element from the cache array
7353 array_shift($this->gdgammacache);
7354 }
7355 }
7356 return $this->gdgammacache['#'.$c];
7357 }
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 20534 of file tcpdf.php.
20534 {
20535 $grapvars = array(
20536 'FontFamily' => $this->FontFamily,
20537 'FontStyle' => $this->FontStyle,
20538 'FontSizePt' => $this->FontSizePt,
20539 'rMargin' => $this->rMargin,
20540 'lMargin' => $this->lMargin,
20541 'cell_padding' => $this->cell_padding,
20542 'cell_margin' => $this->cell_margin,
20543 'LineWidth' => $this->LineWidth,
20544 'linestyleWidth' => $this->linestyleWidth,
20545 'linestyleCap' => $this->linestyleCap,
20546 'linestyleJoin' => $this->linestyleJoin,
20547 'linestyleDash' => $this->linestyleDash,
20548 'textrendermode' => $this->textrendermode,
20549 'textstrokewidth' => $this->textstrokewidth,
20550 'DrawColor' => $this->DrawColor,
20551 'FillColor' => $this->FillColor,
20552 'TextColor' => $this->TextColor,
20553 'ColorFlag' => $this->ColorFlag,
20554 'bgcolor' => $this->bgcolor,
20555 'fgcolor' => $this->fgcolor,
20556 'htmlvspace' => $this->htmlvspace,
20557 'listindent' => $this->listindent,
20558 'listindentlevel' => $this->listindentlevel,
20559 'listnum' => $this->listnum,
20560 'listordered' => $this->listordered,
20561 'listcount' => $this->listcount,
20562 'lispacer' => $this->lispacer,
20563 'cell_height_ratio' => $this->cell_height_ratio,
20564 'font_stretching' => $this->font_stretching,
20565 'font_spacing' => $this->font_spacing,
20566 'alpha' => $this->alpha,
20567 // extended
20568 'lasth' => $this->lasth,
20569 'tMargin' => $this->tMargin,
20570 'bMargin' => $this->bMargin,
20571 'AutoPageBreak' => $this->AutoPageBreak,
20572 'PageBreakTrigger' => $this->PageBreakTrigger,
20573 'x' => $this->x,
20574 'y' => $this->y,
20575 'w' => $this->w,
20576 'h' => $this->h,
20577 'wPt' => $this->wPt,
20578 'hPt' => $this->hPt,
20579 'fwPt' => $this->fwPt,
20580 'fhPt' => $this->fhPt,
20581 'page' => $this->page,
20582 'current_column' => $this->current_column,
20583 'num_columns' => $this->num_columns
20584 );
20585 return $grapvars;
20586 }
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 13669 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 13679 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 17052 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 10313 of file tcpdf.php.
10313 {
10315 }
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 16250 of file tcpdf.php.
16250 {
16251 // array of CSS styles ( selector => properties).
16252 $css = array();
16253 // get CSS array defined at previous call
16254 $matches = array();
16256 if (isset($matches[1][0])) {
16258 }
16260 }
16261 // extract external CSS files
16262 $matches = array();
16264 foreach ($matches[1] as $key => $link) {
16265 $type = array();
16266 if (preg_match('/type[\s]*=[\s]*"text\/css"/', $link, $type)) {
16267 $type = array();
16268 preg_match('/media[\s]*=[\s]*"([^"]*)"/', $link, $type);
16269 // get 'all' and 'print' media, other media types are discarded
16270 // (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
16271 if (empty($type) OR (isset($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
16272 $type = array();
16273 if (preg_match('/href[\s]*=[\s]*"([^"]*)"/', $link, $type) > 0) {
16274 // read CSS data file
16275 $cssdata = TCPDF_STATIC::fileGetContents(trim($type[1]));
16276 if (($cssdata !== FALSE) AND (strlen($cssdata) > 0)) {
16277 $css = array_merge($css, TCPDF_STATIC::extractCSSproperties($cssdata));
16278 }
16279 }
16280 }
16281 }
16282 }
16283 }
16284 // extract style tags
16285 $matches = array();
16287 foreach ($matches[1] as $key => $media) {
16288 $type = array();
16289 preg_match('/media[\s]*=[\s]*"([^"]*)"/', $media, $type);
16290 // get 'all' and 'print' media, other media types are discarded
16291 // (all, braille, embossed, handheld, print, projection, screen, speech, tty, tv)
16292 if (empty($type) OR (isset($type[1]) AND (($type[1] == 'all') OR ($type[1] == 'print')))) {
16293 $cssdata = $matches[2][$key];
16294 $css = array_merge($css, TCPDF_STATIC::extractCSSproperties($cssdata));
16295 }
16296 }
16297 }
16298 // create a special tag to contain the CSS array (used for table content)
16299 $csstagarray = '<cssarray>'.htmlentities(json_encode($css)).'</cssarray>';
16300 // remove head and style blocks
16303 // define block tags
16304 $blocktags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table','tr','td');
16305 // define self-closing tags
16306 $selfclosingtags = array('area','base','basefont','br','hr','input','img','link','meta');
16307 // remove all unsupported tags (the line below lists all supported tags)
16308 $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>');
16309 //replace some blank characters
16311 $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);
16313 $repTable = array("\t" => ' ', "\0" => ' ', "\x0B" => ' ', "\\" => "\\\\");
16315 $offset = 0;
16317 $html_a = substr($html, 0, $offset);
16318 $html_b = substr($html, $offset, ($pos - $offset + 6));
16319 while (preg_match("'<xre([^>]*)>(.*?)\n(.*?)</pre>'si", $html_b)) {
16320 // preserve newlines on <pre> tag
16321 $html_b = preg_replace("'<xre([^>]*)>(.*?)\n(.*?)</pre>'si", "<xre\\1>\\2<br />\\3</pre>", $html_b);
16322 }
16323 while (preg_match("'<xre([^>]*)>(.*?)".$this->re_space['p']."(.*?)</pre>'".$this->re_space['m'], $html_b)) {
16324 // preserve spaces on <pre> tag
16325 $html_b = preg_replace("'<xre([^>]*)>(.*?)".$this->re_space['p']."(.*?)</pre>'".$this->re_space['m'], "<xre\\1>\\2 \\3</pre>", $html_b);
16326 }
16328 $offset = strlen($html_a.$html_b);
16329 }
16330 $offset = 0;
16331 while (($offset < strlen($html)) AND ($pos = strpos($html, '</textarea>', $offset)) !== false) {
16332 $html_a = substr($html, 0, $offset);
16333 $html_b = substr($html, $offset, ($pos - $offset + 11));
16334 while (preg_match("'<textarea([^>]*)>(.*?)\n(.*?)</textarea>'si", $html_b)) {
16335 // preserve newlines on <textarea> tag
16336 $html_b = preg_replace("'<textarea([^>]*)>(.*?)\n(.*?)</textarea>'si", "<textarea\\1>\\2<TBR>\\3</textarea>", $html_b);
16337 $html_b = preg_replace("'<textarea([^>]*)>(.*?)[\"](.*?)</textarea>'si", "<textarea\\1>\\2''\\3</textarea>", $html_b);
16338 }
16340 $offset = strlen($html_a.$html_b);
16341 }
16344 $offset = 0;
16345 while (($offset < strlen($html)) AND ($pos = strpos($html, '</option>', $offset)) !== false) {
16346 $html_a = substr($html, 0, $offset);
16347 $html_b = substr($html, $offset, ($pos - $offset + 9));
16348 while (preg_match("'<option([^>]*)>(.*?)</option>'si", $html_b)) {
16349 $html_b = preg_replace("'<option([\s]+)value=\"([^\"]*)\"([^>]*)>(.*?)</option>'si", "\\2#!TaB!#\\4#!NwL!#", $html_b);
16350 $html_b = preg_replace("'<option([^>]*)>(.*?)</option>'si", "\\2#!NwL!#", $html_b);
16351 }
16353 $offset = strlen($html_a.$html_b);
16354 }
16358 }
16360 // restore textarea newlines
16362 // remove extra spaces from code
16364 $html = preg_replace('/'.$this->re_space['p'].'+<\/(td|th|li|dt|dd)>/'.$this->re_space['m'], '</\\1>', $html);
16366 $html = preg_replace('/'.$this->re_space['p'].'+<(ul|ol|dl|br)/'.$this->re_space['m'], '<\\1', $html);
16367 $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);
16370 $html = preg_replace('/'.$this->re_space['p'].'+<img/'.$this->re_space['m'], chr(32).'<img', $html);
16372 $html = preg_replace('/<img([^>]*)>/xi', '<img\\1><span><marker style="font-size:0"/></span>', $html);
16374 $html = preg_replace('/<textarea([^>]*)>([^<]*)<\/textarea>/xi', '<textarea\\1 value="\\2" />', $html);
16376 $html = preg_replace('/<li([^>]*)>'.$this->re_space['p'].'*<img/'.$this->re_space['m'], '<li\\1><font size="1"> </font><img', $html);
16381 $html = preg_replace('/'.$this->re_space['p'].'+/'.$this->re_space['m'], chr(32), $html); // replace multiple spaces with a single space
16382 // trim string
16384 // fix br tag after li
16386 // fix first image tag alignment
16388 // pattern for generic tag
16389 $tagpattern = '/(<[^>]+>)/';
16390 // explodes the string
16392 // count elements
16393 $maxel = count($a);
16394 $elkey = 0;
16395 $key = 0;
16396 // create an array of elements
16397 $dom = array();
16398 $dom[$key] = array();
16399 // set inheritable properties fot the first void element
16400 // 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
16401 $dom[$key]['tag'] = false;
16402 $dom[$key]['block'] = false;
16403 $dom[$key]['value'] = '';
16404 $dom[$key]['parent'] = 0;
16405 $dom[$key]['hide'] = false;
16412 $dom[$key]['fill'] = (($this->textrendermode % 2) == 0);
16413 $dom[$key]['clip'] = ($this->textrendermode > 3);
16415 $dom[$key]['bgcolor'] = false;
16418 $dom[$key]['align'] = '';
16419 $dom[$key]['listtype'] = '';
16420 $dom[$key]['text-indent'] = 0;
16421 $dom[$key]['text-transform'] = '';
16422 $dom[$key]['border'] = array();
16423 $dom[$key]['dir'] = $this->rtl?'rtl':'ltr';
16425 ++$key;
16426 $level = array();
16427 array_push($level, 0); // root
16428 while ($elkey < $maxel) {
16429 $dom[$key] = array();
16430 $element = $a[$elkey];
16431 $dom[$key]['elkey'] = $elkey;
16432 if (preg_match($tagpattern, $element)) {
16433 // html tag
16434 $element = substr($element, 1, -1);
16435 // get tag name
16436 preg_match('/[\/]?([a-zA-Z0-9]*)/', $element, $tag);
16437 $tagname = strtolower($tag[1]);
16438 // check if we are inside a table header
16439 if ($tagname == 'thead') {
16440 if ($element[0] == '/') {
16442 } else {
16444 }
16445 ++$elkey;
16446 continue;
16447 }
16448 $dom[$key]['tag'] = true;
16449 $dom[$key]['value'] = $tagname;
16450 if (in_array($dom[$key]['value'], $blocktags)) {
16451 $dom[$key]['block'] = true;
16452 } else {
16453 $dom[$key]['block'] = false;
16454 }
16455 if ($element[0] == '/') {
16456 // *** closing html tag
16457 $dom[$key]['opening'] = false;
16458 $dom[$key]['parent'] = end($level);
16459 array_pop($level);
16460 $dom[$key]['hide'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['hide'];
16461 $dom[$key]['fontname'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontname'];
16462 $dom[$key]['fontstyle'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontstyle'];
16463 $dom[$key]['fontsize'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fontsize'];
16464 $dom[$key]['font-stretch'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['font-stretch'];
16465 $dom[$key]['letter-spacing'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['letter-spacing'];
16466 $dom[$key]['stroke'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['stroke'];
16467 $dom[$key]['fill'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fill'];
16468 $dom[$key]['clip'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['clip'];
16469 $dom[$key]['line-height'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['line-height'];
16470 $dom[$key]['bgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['bgcolor'];
16471 $dom[$key]['fgcolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['fgcolor'];
16472 $dom[$key]['strokecolor'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['strokecolor'];
16473 $dom[$key]['align'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['align'];
16474 $dom[$key]['text-transform'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['text-transform'];
16475 $dom[$key]['dir'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['dir'];
16476 if (isset($dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'])) {
16477 $dom[$key]['listtype'] = $dom[($dom[($dom[$key]['parent'])]['parent'])]['listtype'];
16478 }
16479 // set the number of columns in table tag
16480 if (($dom[$key]['value'] == 'tr') AND (!isset($dom[($dom[($dom[$key]['parent'])]['parent'])]['cols']))) {
16481 $dom[($dom[($dom[$key]['parent'])]['parent'])]['cols'] = $dom[($dom[$key]['parent'])]['cols'];
16482 }
16483 if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
16484 $dom[($dom[$key]['parent'])]['content'] = $csstagarray;
16485 for ($i = ($dom[$key]['parent'] + 1); $i < $key; ++$i) {
16486 $dom[($dom[$key]['parent'])]['content'] .= stripslashes($a[$dom[$i]['elkey']]);
16487 }
16488 $key = $i;
16489 // mark nested tables
16490 $dom[($dom[$key]['parent'])]['content'] = str_replace('<table', '<table nested="true"', $dom[($dom[$key]['parent'])]['content']);
16491 // remove thead sections from nested tables
16492 $dom[($dom[$key]['parent'])]['content'] = str_replace('<thead>', '', $dom[($dom[$key]['parent'])]['content']);
16493 $dom[($dom[$key]['parent'])]['content'] = str_replace('</thead>', '', $dom[($dom[$key]['parent'])]['content']);
16494 }
16495 // store header rows on a new table
16496 if (($dom[$key]['value'] == 'tr') AND ($dom[($dom[$key]['parent'])]['thead'] === true)) {
16498 $dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] = $csstagarray.$a[$dom[($dom[($dom[$key]['parent'])]['parent'])]['elkey']];
16499 }
16500 for ($i = $dom[$key]['parent']; $i <= $key; ++$i) {
16501 $dom[($dom[($dom[$key]['parent'])]['parent'])]['thead'] .= $a[$dom[$i]['elkey']];
16502 }
16503 if (!isset($dom[($dom[$key]['parent'])]['attribute'])) {
16504 $dom[($dom[$key]['parent'])]['attribute'] = array();
16505 }
16506 // header elements must be always contained in a single page
16507 $dom[($dom[$key]['parent'])]['attribute']['nobr'] = 'true';
16508 }
16509 if (($dom[$key]['value'] == 'table') AND (!TCPDF_STATIC::empty_string($dom[($dom[$key]['parent'])]['thead']))) {
16510 // remove the nobr attributes from the table header
16511 $dom[($dom[$key]['parent'])]['thead'] = str_replace(' nobr="true"', '', $dom[($dom[$key]['parent'])]['thead']);
16512 $dom[($dom[$key]['parent'])]['thead'] .= '</tablehead>';
16513 }
16514 } else {
16515 // *** opening or self-closing html tag
16516 $dom[$key]['opening'] = true;
16517 $dom[$key]['parent'] = end($level);
16518 if ((substr($element, -1, 1) == '/') OR (in_array($dom[$key]['value'], $selfclosingtags))) {
16519 // self-closing tag
16520 $dom[$key]['self'] = true;
16521 } else {
16522 // opening tag
16523 array_push($level, $key);
16524 $dom[$key]['self'] = false;
16525 }
16526 // copy some values from parent
16527 $parentkey = 0;
16528 if ($key > 0) {
16529 $parentkey = $dom[$key]['parent'];
16530 $dom[$key]['hide'] = $dom[$parentkey]['hide'];
16531 $dom[$key]['fontname'] = $dom[$parentkey]['fontname'];
16532 $dom[$key]['fontstyle'] = $dom[$parentkey]['fontstyle'];
16533 $dom[$key]['fontsize'] = $dom[$parentkey]['fontsize'];
16534 $dom[$key]['font-stretch'] = $dom[$parentkey]['font-stretch'];
16535 $dom[$key]['letter-spacing'] = $dom[$parentkey]['letter-spacing'];
16536 $dom[$key]['stroke'] = $dom[$parentkey]['stroke'];
16537 $dom[$key]['fill'] = $dom[$parentkey]['fill'];
16538 $dom[$key]['clip'] = $dom[$parentkey]['clip'];
16539 $dom[$key]['line-height'] = $dom[$parentkey]['line-height'];
16540 $dom[$key]['bgcolor'] = $dom[$parentkey]['bgcolor'];
16541 $dom[$key]['fgcolor'] = $dom[$parentkey]['fgcolor'];
16542 $dom[$key]['strokecolor'] = $dom[$parentkey]['strokecolor'];
16543 $dom[$key]['align'] = $dom[$parentkey]['align'];
16544 $dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
16545 $dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
16546 $dom[$key]['text-transform'] = $dom[$parentkey]['text-transform'];
16547 $dom[$key]['border'] = array();
16548 $dom[$key]['dir'] = $dom[$parentkey]['dir'];
16549 }
16550 // get attributes
16551 preg_match_all('/([^=\s]*)[\s]*=[\s]*"([^"]*)"/', $element, $attr_array, PREG_PATTERN_ORDER);
16552 $dom[$key]['attribute'] = array(); // reset attribute array
16553 while (list($id, $name) = each($attr_array[1])) {
16554 $dom[$key]['attribute'][strtolower($name)] = $attr_array[2][$id];
16555 }
16556 if (!empty($css)) {
16557 // merge CSS style to current style
16558 list($dom[$key]['csssel'], $dom[$key]['cssdata']) = TCPDF_STATIC::getCSSdataArray($dom, $key, $css);
16559 $dom[$key]['attribute']['style'] = TCPDF_STATIC::getTagStyleFromCSSarray($dom[$key]['cssdata']);
16560 }
16561 // split style attributes
16562 if (isset($dom[$key]['attribute']['style']) AND !empty($dom[$key]['attribute']['style'])) {
16563 // get style attributes
16564 preg_match_all('/([^;:\s]*):([^;]*)/', $dom[$key]['attribute']['style'], $style_array, PREG_PATTERN_ORDER);
16565 $dom[$key]['style'] = array(); // reset style attribute array
16566 while (list($id, $name) = each($style_array[1])) {
16567 // in case of duplicate attribute the last replace the previous
16568 $dom[$key]['style'][strtolower($name)] = trim($style_array[2][$id]);
16569 }
16570 // --- get some style attributes ---
16571 // text direction
16572 if (isset($dom[$key]['style']['direction'])) {
16573 $dom[$key]['dir'] = $dom[$key]['style']['direction'];
16574 }
16575 // display
16576 if (isset($dom[$key]['style']['display'])) {
16577 $dom[$key]['hide'] = (trim(strtolower($dom[$key]['style']['display'])) == 'none');
16578 }
16579 // font family
16580 if (isset($dom[$key]['style']['font-family'])) {
16582 }
16583 // list-style-type
16584 if (isset($dom[$key]['style']['list-style-type'])) {
16585 $dom[$key]['listtype'] = trim(strtolower($dom[$key]['style']['list-style-type']));
16586 if ($dom[$key]['listtype'] == 'inherit') {
16587 $dom[$key]['listtype'] = $dom[$parentkey]['listtype'];
16588 }
16589 }
16590 // text-indent
16591 if (isset($dom[$key]['style']['text-indent'])) {
16593 if ($dom[$key]['text-indent'] == 'inherit') {
16594 $dom[$key]['text-indent'] = $dom[$parentkey]['text-indent'];
16595 }
16596 }
16597 // text-transform
16598 if (isset($dom[$key]['style']['text-transform'])) {
16599 $dom[$key]['text-transform'] = $dom[$key]['style']['text-transform'];
16600 }
16601 // font size
16602 if (isset($dom[$key]['style']['font-size'])) {
16603 $fsize = trim($dom[$key]['style']['font-size']);
16604 $dom[$key]['fontsize'] = $this->getHTMLFontUnits($fsize, $dom[0]['fontsize'], $dom[$parentkey]['fontsize'], 'pt');
16605 }
16606 // font-stretch
16607 if (isset($dom[$key]['style']['font-stretch'])) {
16608 $dom[$key]['font-stretch'] = $this->getCSSFontStretching($dom[$key]['style']['font-stretch'], $dom[$parentkey]['font-stretch']);
16609 }
16610 // letter-spacing
16611 if (isset($dom[$key]['style']['letter-spacing'])) {
16612 $dom[$key]['letter-spacing'] = $this->getCSSFontSpacing($dom[$key]['style']['letter-spacing'], $dom[$parentkey]['letter-spacing']);
16613 }
16614 // line-height (internally is the cell height ratio)
16615 if (isset($dom[$key]['style']['line-height'])) {
16616 $lineheight = trim($dom[$key]['style']['line-height']);
16617 switch ($lineheight) {
16618 // A normal line height. This is default
16619 case 'normal': {
16620 $dom[$key]['line-height'] = $dom[0]['line-height'];
16621 break;
16622 }
16623 case 'inherit': {
16624 $dom[$key]['line-height'] = $dom[$parentkey]['line-height'];
16625 }
16626 default: {
16627 if (is_numeric($lineheight)) {
16628 // convert to percentage of font height
16629 $lineheight = ($lineheight * 100).'%';
16630 }
16632 if (substr($lineheight, -1) !== '%') {
16633 if ($dom[$key]['fontsize'] <= 0) {
16634 $dom[$key]['line-height'] = 1;
16635 } else {
16636 $dom[$key]['line-height'] = (($dom[$key]['line-height'] - $this->cell_padding['T'] - $this->cell_padding['B']) / $dom[$key]['fontsize']);
16637 }
16638 }
16639 }
16640 }
16641 }
16642 // font style
16643 if (isset($dom[$key]['style']['font-weight'])) {
16644 if (strtolower($dom[$key]['style']['font-weight'][0]) == 'n') {
16645 if (strpos($dom[$key]['fontstyle'], 'B') !== false) {
16646 $dom[$key]['fontstyle'] = str_replace('B', '', $dom[$key]['fontstyle']);
16647 }
16648 } elseif (strtolower($dom[$key]['style']['font-weight'][0]) == 'b') {
16649 $dom[$key]['fontstyle'] .= 'B';
16650 }
16651 }
16652 if (isset($dom[$key]['style']['font-style']) AND (strtolower($dom[$key]['style']['font-style'][0]) == 'i')) {
16653 $dom[$key]['fontstyle'] .= 'I';
16654 }
16655 // font color
16656 if (isset($dom[$key]['style']['color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['style']['color']))) {
16657 $dom[$key]['fgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['color'], $this->spot_colors);
16658 } elseif ($dom[$key]['value'] == 'a') {
16660 }
16661 // background color
16662 if (isset($dom[$key]['style']['background-color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['style']['background-color']))) {
16663 $dom[$key]['bgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['background-color'], $this->spot_colors);
16664 }
16665 // text-decoration
16666 if (isset($dom[$key]['style']['text-decoration'])) {
16667 $decors = explode(' ', strtolower($dom[$key]['style']['text-decoration']));
16668 foreach ($decors as $dec) {
16669 $dec = trim($dec);
16671 if ($dec[0] == 'u') {
16672 // underline
16673 $dom[$key]['fontstyle'] .= 'U';
16674 } elseif ($dec[0] == 'l') {
16675 // line-through
16676 $dom[$key]['fontstyle'] .= 'D';
16677 } elseif ($dec[0] == 'o') {
16678 // overline
16679 $dom[$key]['fontstyle'] .= 'O';
16680 }
16681 }
16682 }
16683 } elseif ($dom[$key]['value'] == 'a') {
16685 }
16686 // check for width attribute
16687 if (isset($dom[$key]['style']['width'])) {
16688 $dom[$key]['width'] = $dom[$key]['style']['width'];
16689 }
16690 // check for height attribute
16691 if (isset($dom[$key]['style']['height'])) {
16692 $dom[$key]['height'] = $dom[$key]['style']['height'];
16693 }
16694 // check for text alignment
16695 if (isset($dom[$key]['style']['text-align'])) {
16696 $dom[$key]['align'] = strtoupper($dom[$key]['style']['text-align'][0]);
16697 }
16698 // check for CSS border properties
16699 if (isset($dom[$key]['style']['border'])) {
16701 if (!empty($borderstyle)) {
16702 $dom[$key]['border']['LTRB'] = $borderstyle;
16703 }
16704 }
16705 if (isset($dom[$key]['style']['border-color'])) {
16706 $brd_colors = preg_split('/[\s]+/', trim($dom[$key]['style']['border-color']));
16707 if (isset($brd_colors[3])) {
16708 $dom[$key]['border']['L']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[3], $this->spot_colors);
16709 }
16710 if (isset($brd_colors[1])) {
16711 $dom[$key]['border']['R']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[1], $this->spot_colors);
16712 }
16713 if (isset($brd_colors[0])) {
16714 $dom[$key]['border']['T']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[0], $this->spot_colors);
16715 }
16716 if (isset($brd_colors[2])) {
16717 $dom[$key]['border']['B']['color'] = TCPDF_COLORS::convertHTMLColorToDec($brd_colors[2], $this->spot_colors);
16718 }
16719 }
16720 if (isset($dom[$key]['style']['border-width'])) {
16721 $brd_widths = preg_split('/[\s]+/', trim($dom[$key]['style']['border-width']));
16722 if (isset($brd_widths[3])) {
16724 }
16725 if (isset($brd_widths[1])) {
16727 }
16728 if (isset($brd_widths[0])) {
16730 }
16731 if (isset($brd_widths[2])) {
16733 }
16734 }
16735 if (isset($dom[$key]['style']['border-style'])) {
16736 $brd_styles = preg_split('/[\s]+/', trim($dom[$key]['style']['border-style']));
16737 if (isset($brd_styles[3]) AND ($brd_styles[3]!='none')) {
16738 $dom[$key]['border']['L']['cap'] = 'square';
16739 $dom[$key]['border']['L']['join'] = 'miter';
16741 if ($dom[$key]['border']['L']['dash'] < 0) {
16742 $dom[$key]['border']['L'] = array();
16743 }
16744 }
16745 if (isset($brd_styles[1])) {
16746 $dom[$key]['border']['R']['cap'] = 'square';
16747 $dom[$key]['border']['R']['join'] = 'miter';
16749 if ($dom[$key]['border']['R']['dash'] < 0) {
16750 $dom[$key]['border']['R'] = array();
16751 }
16752 }
16753 if (isset($brd_styles[0])) {
16754 $dom[$key]['border']['T']['cap'] = 'square';
16755 $dom[$key]['border']['T']['join'] = 'miter';
16757 if ($dom[$key]['border']['T']['dash'] < 0) {
16758 $dom[$key]['border']['T'] = array();
16759 }
16760 }
16761 if (isset($brd_styles[2])) {
16762 $dom[$key]['border']['B']['cap'] = 'square';
16763 $dom[$key]['border']['B']['join'] = 'miter';
16765 if ($dom[$key]['border']['B']['dash'] < 0) {
16766 $dom[$key]['border']['B'] = array();
16767 }
16768 }
16769 }
16770 $cellside = array('L' => 'left', 'R' => 'right', 'T' => 'top', 'B' => 'bottom');
16771 foreach ($cellside as $bsk => $bsv) {
16772 if (isset($dom[$key]['style']['border-'.$bsv])) {
16774 if (!empty($borderstyle)) {
16775 $dom[$key]['border'][$bsk] = $borderstyle;
16776 }
16777 }
16778 if (isset($dom[$key]['style']['border-'.$bsv.'-color'])) {
16779 $dom[$key]['border'][$bsk]['color'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['style']['border-'.$bsv.'-color'], $this->spot_colors);
16780 }
16781 if (isset($dom[$key]['style']['border-'.$bsv.'-width'])) {
16782 $dom[$key]['border'][$bsk]['width'] = $this->getCSSBorderWidth($dom[$key]['style']['border-'.$bsv.'-width']);
16783 }
16784 if (isset($dom[$key]['style']['border-'.$bsv.'-style'])) {
16785 $dom[$key]['border'][$bsk]['dash'] = $this->getCSSBorderDashStyle($dom[$key]['style']['border-'.$bsv.'-style']);
16786 if ($dom[$key]['border'][$bsk]['dash'] < 0) {
16787 $dom[$key]['border'][$bsk] = array();
16788 }
16789 }
16790 }
16791 // check for CSS padding properties
16792 if (isset($dom[$key]['style']['padding'])) {
16794 } else {
16796 }
16797 foreach ($cellside as $psk => $psv) {
16798 if (isset($dom[$key]['style']['padding-'.$psv])) {
16799 $dom[$key]['padding'][$psk] = $this->getHTMLUnitToUnits($dom[$key]['style']['padding-'.$psv], 0, 'px', false);
16800 }
16801 }
16802 // check for CSS margin properties
16803 if (isset($dom[$key]['style']['margin'])) {
16805 } else {
16807 }
16808 foreach ($cellside as $psk => $psv) {
16809 if (isset($dom[$key]['style']['margin-'.$psv])) {
16810 $dom[$key]['margin'][$psk] = $this->getHTMLUnitToUnits(str_replace('auto', '0', $dom[$key]['style']['margin-'.$psv]), 0, 'px', false);
16811 }
16812 }
16813 // check for CSS border-spacing properties
16814 if (isset($dom[$key]['style']['border-spacing'])) {
16815 $dom[$key]['border-spacing'] = $this->getCSSBorderMargin($dom[$key]['style']['border-spacing']);
16816 }
16817 // page-break-inside
16818 if (isset($dom[$key]['style']['page-break-inside']) AND ($dom[$key]['style']['page-break-inside'] == 'avoid')) {
16819 $dom[$key]['attribute']['nobr'] = 'true';
16820 }
16821 // page-break-before
16822 if (isset($dom[$key]['style']['page-break-before'])) {
16823 if ($dom[$key]['style']['page-break-before'] == 'always') {
16824 $dom[$key]['attribute']['pagebreak'] = 'true';
16825 } elseif ($dom[$key]['style']['page-break-before'] == 'left') {
16826 $dom[$key]['attribute']['pagebreak'] = 'left';
16827 } elseif ($dom[$key]['style']['page-break-before'] == 'right') {
16828 $dom[$key]['attribute']['pagebreak'] = 'right';
16829 }
16830 }
16831 // page-break-after
16832 if (isset($dom[$key]['style']['page-break-after'])) {
16833 if ($dom[$key]['style']['page-break-after'] == 'always') {
16834 $dom[$key]['attribute']['pagebreakafter'] = 'true';
16835 } elseif ($dom[$key]['style']['page-break-after'] == 'left') {
16836 $dom[$key]['attribute']['pagebreakafter'] = 'left';
16837 } elseif ($dom[$key]['style']['page-break-after'] == 'right') {
16838 $dom[$key]['attribute']['pagebreakafter'] = 'right';
16839 }
16840 }
16841 }
16842 if (isset($dom[$key]['attribute']['display'])) {
16843 $dom[$key]['hide'] = (trim(strtolower($dom[$key]['attribute']['display'])) == 'none');
16844 }
16845 if (isset($dom[$key]['attribute']['border']) AND ($dom[$key]['attribute']['border'] != 0)) {
16847 if (!empty($borderstyle)) {
16848 $dom[$key]['border']['LTRB'] = $borderstyle;
16849 }
16850 }
16851 // check for font tag
16852 if ($dom[$key]['value'] == 'font') {
16853 // font family
16854 if (isset($dom[$key]['attribute']['face'])) {
16856 }
16857 // font size
16858 if (isset($dom[$key]['attribute']['size'])) {
16859 if ($key > 0) {
16860 if ($dom[$key]['attribute']['size'][0] == '+') {
16861 $dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] + intval(substr($dom[$key]['attribute']['size'], 1));
16862 } elseif ($dom[$key]['attribute']['size'][0] == '-') {
16863 $dom[$key]['fontsize'] = $dom[($dom[$key]['parent'])]['fontsize'] - intval(substr($dom[$key]['attribute']['size'], 1));
16864 } else {
16865 $dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
16866 }
16867 } else {
16868 $dom[$key]['fontsize'] = intval($dom[$key]['attribute']['size']);
16869 }
16870 }
16871 }
16872 // force natural alignment for lists
16873 if ((($dom[$key]['value'] == 'ul') OR ($dom[$key]['value'] == 'ol') OR ($dom[$key]['value'] == 'dl'))
16874 AND (!isset($dom[$key]['align']) OR TCPDF_STATIC::empty_string($dom[$key]['align']) OR ($dom[$key]['align'] != 'J'))) {
16875 if ($this->rtl) {
16876 $dom[$key]['align'] = 'R';
16877 } else {
16878 $dom[$key]['align'] = 'L';
16879 }
16880 }
16881 if (($dom[$key]['value'] == 'small') OR ($dom[$key]['value'] == 'sup') OR ($dom[$key]['value'] == 'sub')) {
16882 if (!isset($dom[$key]['attribute']['size']) AND !isset($dom[$key]['style']['font-size'])) {
16884 }
16885 }
16886 if (($dom[$key]['value'] == 'strong') OR ($dom[$key]['value'] == 'b')) {
16887 $dom[$key]['fontstyle'] .= 'B';
16888 }
16889 if (($dom[$key]['value'] == 'em') OR ($dom[$key]['value'] == 'i')) {
16890 $dom[$key]['fontstyle'] .= 'I';
16891 }
16892 if ($dom[$key]['value'] == 'u') {
16893 $dom[$key]['fontstyle'] .= 'U';
16894 }
16895 if (($dom[$key]['value'] == 'del') OR ($dom[$key]['value'] == 's') OR ($dom[$key]['value'] == 'strike')) {
16896 $dom[$key]['fontstyle'] .= 'D';
16897 }
16898 if (!isset($dom[$key]['style']['text-decoration']) AND ($dom[$key]['value'] == 'a')) {
16900 }
16901 if (($dom[$key]['value'] == 'pre') OR ($dom[$key]['value'] == 'tt')) {
16903 }
16904 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)) {
16905 // headings h1, h2, h3, h4, h5, h6
16906 if (!isset($dom[$key]['attribute']['size']) AND !isset($dom[$key]['style']['font-size'])) {
16907 $headsize = (4 - intval($dom[$key]['value']{1})) * 2;
16908 $dom[$key]['fontsize'] = $dom[0]['fontsize'] + $headsize;
16909 }
16910 if (!isset($dom[$key]['style']['font-weight'])) {
16911 $dom[$key]['fontstyle'] .= 'B';
16912 }
16913 }
16914 if (($dom[$key]['value'] == 'table')) {
16915 $dom[$key]['rows'] = 0; // number of rows
16916 $dom[$key]['trids'] = array(); // IDs of TR elements
16917 $dom[$key]['thead'] = ''; // table header rows
16918 }
16919 if (($dom[$key]['value'] == 'tr')) {
16920 $dom[$key]['cols'] = 0;
16922 $dom[$key]['thead'] = true;
16923 // rows on thead block are printed as a separate table
16924 } else {
16925 $dom[$key]['thead'] = false;
16926 // store the number of rows on table element
16927 ++$dom[($dom[$key]['parent'])]['rows'];
16928 // store the TR elements IDs on table element
16929 array_push($dom[($dom[$key]['parent'])]['trids'], $key);
16930 }
16931 }
16932 if (($dom[$key]['value'] == 'th') OR ($dom[$key]['value'] == 'td')) {
16933 if (isset($dom[$key]['attribute']['colspan'])) {
16934 $colspan = intval($dom[$key]['attribute']['colspan']);
16935 } else {
16936 $colspan = 1;
16937 }
16938 $dom[$key]['attribute']['colspan'] = $colspan;
16939 $dom[($dom[$key]['parent'])]['cols'] += $colspan;
16940 }
16941 // text direction
16942 if (isset($dom[$key]['attribute']['dir'])) {
16943 $dom[$key]['dir'] = $dom[$key]['attribute']['dir'];
16944 }
16945 // set foreground color attribute
16946 if (isset($dom[$key]['attribute']['color']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['color']))) {
16947 $dom[$key]['fgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['color'], $this->spot_colors);
16948 } elseif (!isset($dom[$key]['style']['color']) AND ($dom[$key]['value'] == 'a')) {
16950 }
16951 // set background color attribute
16952 if (isset($dom[$key]['attribute']['bgcolor']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['bgcolor']))) {
16953 $dom[$key]['bgcolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['bgcolor'], $this->spot_colors);
16954 }
16955 // set stroke color attribute
16956 if (isset($dom[$key]['attribute']['strokecolor']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['strokecolor']))) {
16957 $dom[$key]['strokecolor'] = TCPDF_COLORS::convertHTMLColorToDec($dom[$key]['attribute']['strokecolor'], $this->spot_colors);
16958 }
16959 // check for width attribute
16960 if (isset($dom[$key]['attribute']['width'])) {
16961 $dom[$key]['width'] = $dom[$key]['attribute']['width'];
16962 }
16963 // check for height attribute
16964 if (isset($dom[$key]['attribute']['height'])) {
16965 $dom[$key]['height'] = $dom[$key]['attribute']['height'];
16966 }
16967 // check for text alignment
16968 if (isset($dom[$key]['attribute']['align']) AND (!TCPDF_STATIC::empty_string($dom[$key]['attribute']['align'])) AND ($dom[$key]['value'] !== 'img')) {
16969 $dom[$key]['align'] = strtoupper($dom[$key]['attribute']['align'][0]);
16970 }
16971 // check for text rendering mode (the following attributes do not exist in HTML)
16972 if (isset($dom[$key]['attribute']['stroke'])) {
16973 // font stroke width
16974 $dom[$key]['stroke'] = $this->getHTMLUnitToUnits($dom[$key]['attribute']['stroke'], $dom[$key]['fontsize'], 'pt', true);
16975 }
16976 if (isset($dom[$key]['attribute']['fill'])) {
16977 // font fill
16978 if ($dom[$key]['attribute']['fill'] == 'true') {
16979 $dom[$key]['fill'] = true;
16980 } else {
16981 $dom[$key]['fill'] = false;
16982 }
16983 }
16984 if (isset($dom[$key]['attribute']['clip'])) {
16985 // clipping mode
16986 if ($dom[$key]['attribute']['clip'] == 'true') {
16987 $dom[$key]['clip'] = true;
16988 } else {
16989 $dom[$key]['clip'] = false;
16990 }
16991 }
16992 } // end opening tag
16993 } else {
16994 // text
16995 $dom[$key]['tag'] = false;
16996 $dom[$key]['block'] = false;
16997 $dom[$key]['parent'] = end($level);
16998 $dom[$key]['dir'] = $dom[$dom[$key]['parent']]['dir'];
16999 if (!empty($dom[$dom[$key]['parent']]['text-transform'])) {
17000 // text-transform for unicode requires mb_convert_case (Multibyte String Functions)
17001 if (function_exists('mb_convert_case')) {
17002 $ttm = array('capitalize' => MB_CASE_TITLE, 'uppercase' => MB_CASE_UPPER, 'lowercase' => MB_CASE_LOWER);
17003 if (isset($ttm[$dom[$dom[$key]['parent']]['text-transform']])) {
17004 $element = mb_convert_case($element, $ttm[$dom[$dom[$key]['parent']]['text-transform']], $this->encoding);
17005 }
17006 } elseif (!$this->isunicode) {
17007 switch ($dom[$dom[$key]['parent']]['text-transform']) {
17008 case 'capitalize': {
17009 $element = ucwords(strtolower($element));
17010 break;
17011 }
17012 case 'uppercase': {
17013 $element = strtoupper($element);
17014 break;
17015 }
17016 case 'lowercase': {
17017 $element = strtolower($element);
17018 break;
17019 }
17020 }
17021 }
17022 }
17024 }
17025 ++$elkey;
17026 ++$key;
17027 }
17028 return $dom;
17029 }
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:16124
getCSSBorderStyle($cssborder)
Returns the border style array from CSS border properties.
Definition: tcpdf.php:15900
getCSSFontSpacing($spacing, $parent=0)
Returns the letter-spacing value from CSS value.
Definition: tcpdf.php:16093
getCSSMargin($cssmargin, $width=0)
Get the internal Cell margin from CSS attribute.
Definition: tcpdf.php:16005
getCSSBorderMargin($cssbspace, $width=0)
Get the border-spacing from CSS attribute.
Definition: tcpdf.php:16059
getHTMLFontUnits($val, $refsize=12, $parent_size=12, $defaultunit='pt')
Convert HTML string containing font size value to points.
Definition: tcpdf.php:16196
getCSSPadding($csspadding, $width=0)
Get the internal Cell padding from CSS attribute.
Definition: tcpdf.php:15951
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 16196 of file tcpdf.php.
16196 {
16197 $refsize = TCPDF_FONTS::getFontRefSize($refsize);
16198 $parent_size = TCPDF_FONTS::getFontRefSize($parent_size, $refsize);
16199 switch ($val) {
16200 case 'xx-small': {
16201 $size = ($refsize - 4);
16202 break;
16203 }
16204 case 'x-small': {
16205 $size = ($refsize - 3);
16206 break;
16207 }
16208 case 'small': {
16209 $size = ($refsize - 2);
16210 break;
16211 }
16212 case 'medium': {
16213 $size = $refsize;
16214 break;
16215 }
16216 case 'large': {
16217 $size = ($refsize + 2);
16218 break;
16219 }
16220 case 'x-large': {
16221 $size = ($refsize + 4);
16222 break;
16223 }
16224 case 'xx-large': {
16225 $size = ($refsize + 6);
16226 break;
16227 }
16228 case 'smaller': {
16229 $size = ($parent_size - 3);
16230 break;
16231 }
16232 case 'larger': {
16233 $size = ($parent_size + 3);
16234 break;
16235 }
16236 default: {
16238 }
16239 }
16241 }
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 20248 of file tcpdf.php.
20248 {
20249 $supportedunits = array('%', 'em', 'ex', 'px', 'in', 'cm', 'mm', 'pc', 'pt');
20250 $retval = 0;
20251 $value = 0;
20252 $unit = 'px';
20253 if ($points) {
20254 $k = 1;
20255 } else {
20257 }
20258 if (in_array($defaultunit, $supportedunits)) {
20259 $unit = $defaultunit;
20260 }
20261 if (is_numeric($htmlval)) {
20262 $value = floatval($htmlval);
20263 } elseif (preg_match('/([0-9\.\-\+]+)/', $htmlval, $mnum)) {
20264 $value = floatval($mnum[1]);
20265 if (preg_match('/([a-z%]+)/', $htmlval, $munit)) {
20266 if (in_array($munit[1], $supportedunits)) {
20267 $unit = $munit[1];
20268 }
20269 }
20270 }
20271 switch ($unit) {
20272 // percentage
20273 case '%': {
20274 $retval = (($value * $refsize) / 100);
20275 break;
20276 }
20277 // relative-size
20278 case 'em': {
20279 $retval = ($value * $refsize);
20280 break;
20281 }
20282 // height of lower case 'x' (about half the font-size)
20283 case 'ex': {
20284 $retval = ($value * ($refsize / 2));
20285 break;
20286 }
20287 // absolute-size
20288 case 'in': {
20290 break;
20291 }
20292 // centimeters
20293 case 'cm': {
20295 break;
20296 }
20297 // millimeters
20298 case 'mm': {
20300 break;
20301 }
20302 // one pica is 12 points
20303 case 'pc': {
20304 $retval = (($value * 12) / $k);
20305 break;
20306 }
20307 // points
20308 case 'pt': {
20309 $retval = ($value / $k);
20310 break;
20311 }
20312 // pixels
20313 case 'px': {
20314 $retval = $this->pixelsToUnits($value);
20315 if ($points) {
20316 $retval *= $this->k;
20317 }
20318 break;
20319 }
20320 }
20321 return $retval;
20322 }
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 20778 of file tcpdf.php.
20778 {
20779 if (isset($this->images[$image])) {
20780 return $this->images[$image];
20781 }
20782 return false;
20783 }
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 7809 of file tcpdf.php.
7809 {
7810 $alias = array();
7811 // build array of Unicode + ASCII variants (the order is important)
7812 $alias = array('u' => array(), 'a' => array());
7813 $u = '{'.$a.'}';
7815 if ($this->isunicode) {
7816 $alias['u'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::UTF8ToLatin1($u, $this->isunicode, $this->CurrentFont));
7817 $alias['u'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::utf8StrRev($u, false, $this->tmprtl, $this->isunicode, $this->CurrentFont));
7818 $alias['a'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::UTF8ToLatin1($a, $this->isunicode, $this->CurrentFont));
7819 $alias['a'][] = TCPDF_STATIC::_escape(TCPDF_FONTS::utf8StrRev($a, false, $this->tmprtl, $this->isunicode, $this->CurrentFont));
7820 }
7822 return $alias;
7823 }
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 11296 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 15746 of file tcpdf.php.
15746 {
15747 $ret = array(
15748 'left' => $this->lMargin,
15749 'right' => $this->rMargin,
15750 'top' => $this->tMargin,
15751 'bottom' => $this->bMargin,
15752 'header' => $this->header_margin,
15753 'footer' => $this->footer_margin,
15754 'cell' => $this->cell_padding,
15755 'padding_left' => $this->cell_padding['L'],
15756 'padding_top' => $this->cell_padding['T'],
15757 'padding_right' => $this->cell_padding['R'],
15758 'padding_bottom' => $this->cell_padding['B']
15759 );
15761 }
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 15773 of file tcpdf.php.
15773 {
15774 $ret = array(
15775 'left' => $this->original_lMargin,
15776 'right' => $this->original_rMargin
15777 );
15779 }
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 13897 of file tcpdf.php.
13897 {
13899 }
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 20731 of file tcpdf.php.
20731 {
20734 }
20735 return false;
20736 }
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 13641 of file tcpdf.php.
13641 {
13643 return '{'.TCPDF_STATIC::$alias_group_tot_pages.'}';
13644 }
13646 }
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 13656 of file tcpdf.php.
13656 {
13658 return '{'.TCPDF_STATIC::$alias_group_num_page.'}';
13659 }
13661 }
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 13486 of file tcpdf.php.
13486 {
13487 $sigapp = array();
13490 } else {
13492 }
13493 if (empty($name)) {
13494 $sigapp['name'] = 'Signature';
13495 } else {
13496 $sigapp['name'] = $name;
13497 }
13503 return $sigapp;
13504 }
References $d, $h, $k, $page, $w, $x, and $y.
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 17038 of file tcpdf.php.
17038 {
17039 $spacestr = chr(32);
17041 $spacestr = chr(0).chr(32);
17042 }
17043 return $spacestr;
17044 }
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 7402 of file tcpdf.php.
7402 {
7403 //Get x position
7404 if ($this->rtl) {
7405 return ($this->w - $this->x);
7406 } else {
7408 }
7409 }
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 7429 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 14471 of file tcpdf.php.
14471 {
14472 if ($this->pdfa_mode OR ($this->state != 2)) {
14473 return;
14474 }
14475 $n = count($this->gradients) + 1;
14476 $this->gradients[$n] = array();
14482 // color space
14483 $numcolspace = count($stops[0]['color']);
14484 $bcolor = array_values($background);
14485 switch($numcolspace) {
14486 case 5: // SPOT
14487 case 4: { // CMYK
14489 if (!empty($background)) {
14490 $this->gradients[$n]['background'] = sprintf('%F %F %F %F', $bcolor[0]/100, $bcolor[1]/100, $bcolor[2]/100, $bcolor[3]/100);
14491 }
14492 break;
14493 }
14494 case 3: { // RGB
14496 if (!empty($background)) {
14497 $this->gradients[$n]['background'] = sprintf('%F %F %F', $bcolor[0]/255, $bcolor[1]/255, $bcolor[2]/255);
14498 }
14499 break;
14500 }
14501 case 1: { // GRAY SCALE
14503 if (!empty($background)) {
14505 }
14506 break;
14507 }
14508 }
14509 $num_stops = count($stops);
14510 $last_stop_id = $num_stops - 1;
14511 foreach ($stops as $key => $stop) {
14513 // offset represents a location along the gradient vector
14514 if (isset($stop['offset'])) {
14516 } else {
14517 if ($key == 0) {
14519 } elseif ($key == $last_stop_id) {
14521 } else {
14522 $offsetstep = (1 - $this->gradients[$n]['colors'][($key - 1)]['offset']) / ($num_stops - $key);
14523 $this->gradients[$n]['colors'][$key]['offset'] = $this->gradients[$n]['colors'][($key - 1)]['offset'] + $offsetstep;
14524 }
14525 }
14526 if (isset($stop['opacity'])) {
14528 if ((!$this->pdfa_mode) AND ($stop['opacity'] < 1)) {
14530 }
14531 } else {
14533 }
14534 // exponent for the exponential interpolation function
14535 if (isset($stop['exponent'])) {
14537 } else {
14539 }
14540 // set colors
14541 $color = array_values($stop['color']);
14542 switch($numcolspace) {
14543 case 5: // SPOT
14544 case 4: { // CMYK
14545 $this->gradients[$n]['colors'][$key]['color'] = sprintf('%F %F %F %F', $color[0]/100, $color[1]/100, $color[2]/100, $color[3]/100);
14546 break;
14547 }
14548 case 3: { // RGB
14549 $this->gradients[$n]['colors'][$key]['color'] = sprintf('%F %F %F', $color[0]/255, $color[1]/255, $color[2]/255);
14550 break;
14551 }
14552 case 1: { // GRAY SCALE
14554 break;
14555 }
14556 }
14557 }
14559 // paint luminosity gradient
14561 }
14562 //paint the gradient
14564 //restore previous Graphic State
14565 $this->_outRestoreGraphicsState();
14566 if ($this->inxobj) {
14567 // we are inside an XObject template
14569 }
14570 }
References $coords, $n, $xobjid, _out(), and _outRestoreGraphicsState().
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:22323
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:22676
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:14835
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 22031 of file tcpdf.php.
22031 {
22033 $word = array(); // last word
22034 $txtarr = array(); // text to be returned
22035 $intag = false; // true if we are inside an HTML tag
22036 $skip = false; // true to skip hyphenation
22037 if (!is_array($patterns)) {
22038 $patterns = TCPDF_STATIC::getHyphenPatternsFromTEX($patterns);
22039 }
22040 // get array of characters
22042 // for each char
22043 foreach ($unichars as $char) {
22045 // letter character
22046 $word[] = $char;
22047 } else {
22048 // other type of character
22050 // hypenate the word
22051 $txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
22052 $word = array();
22053 }
22054 $txtarr[] = $char;
22055 if (chr($char) == '<') {
22056 // we are inside an HTML tag
22057 $intag = true;
22058 } elseif ($intag AND (chr($char) == '>')) {
22059 // end of HTML tag
22060 $intag = false;
22061 // check for style tag
22062 $expected = array(115, 116, 121, 108, 101); // = 'style'
22063 $current = array_slice($txtarr, -6, 5); // last 5 chars
22064 $compare = array_diff($expected, $current);
22065 if (empty($compare)) {
22066 // check if it is a closing tag
22067 $expected = array(47); // = '/'
22068 $current = array_slice($txtarr, -7, 1);
22069 $compare = array_diff($expected, $current);
22070 if (empty($compare)) {
22071 // closing style tag
22072 $skip = false;
22073 } else {
22074 // opening style tag
22075 $skip = true;
22076 }
22077 }
22078 }
22079 }
22080 }
22082 // hypenate the word
22083 $txtarr = array_merge($txtarr, $this->hyphenateWord($word, $patterns, $dictionary, $leftmin, $rightmin, $charmin, $charmax));
22084 }
22085 // convert char array to string and return
22087 }
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:21951
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 21951 of file tcpdf.php.
21951 {
21952 $hyphenword = array(); // hyphens positions
21953 $numchars = count($word);
21954 if ($numchars <= $charmin) {
21955 return $word;
21956 }
21958 // some words will be returned as-is
21959 $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})(\]?)$/';
21960 if (preg_match($pattern, $word_string) > 0) {
21961 // email
21962 return $word;
21963 }
21964 $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})(\]?)$/';
21965 if (preg_match($pattern, $word_string) > 0) {
21966 // URL
21967 return $word;
21968 }
21969 if (isset($dictionary[$word_string])) {
21970 return TCPDF_FONTS::UTF8StringToArray($dictionary[$word_string], $this->isunicode, $this->CurrentFont);
21971 }
21972 // surround word with '_' characters
21973 $tmpword = array_merge(array(46), $word, array(46));
21974 $tmpnumchars = $numchars + 2;
21975 $maxpos = $tmpnumchars - 1;
21976 for ($pos = 0; $pos < $maxpos; ++$pos) {
21977 $imax = min(($tmpnumchars - $pos), $charmax);
21978 for ($i = 1; $i <= $imax; ++$i) {
21979 $subword = strtolower(TCPDF_FONTS::UTF8ArrSubString($tmpword, $pos, ($pos + $i), $this->isunicode));
21980 if (isset($patterns[$subword])) {
21981 $pattern = TCPDF_FONTS::UTF8StringToArray($patterns[$subword], $this->isunicode, $this->CurrentFont);
21982 $pattern_length = count($pattern);
21983 $digits = 1;
21984 for ($j = 0; $j < $pattern_length; ++$j) {
21985 // check if $pattern[$j] is a number = hyphenation level (only numbers from 1 to 5 are valid)
21986 if (($pattern[$j] >= 48) AND ($pattern[$j] <= 57)) {
21987 if ($j == 0) {
21988 $zero = $pos - 1;
21989 } else {
21990 $zero = $pos + $j - $digits;
21991 }
21992 // get hyphenation level
21993 $level = ($pattern[$j] - 48);
21994 // if two levels from two different patterns match at the same point, the higher one is selected.
21995 if (!isset($hyphenword[$zero]) OR ($hyphenword[$zero] < $level)) {
21996 $hyphenword[$zero] = $level;
21997 }
21998 ++$digits;
21999 }
22000 }
22001 }
22002 }
22003 }
22004 $inserted = 0;
22005 $maxpos = $numchars - $rightmin;
22006 for ($i = $leftmin; $i <= $maxpos; ++$i) {
22007 // only odd levels indicate allowed hyphenation points
22008 if (isset($hyphenword[$i]) AND (($hyphenword[$i] % 2) != 0)) {
22009 // 173 = soft hyphen character
22010 array_splice($word, $i + $inserted, 0, 173);
22011 ++$inserted;
22012 }
22013 }
22014 return $word;
22015 }
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 6829 of file tcpdf.php.
6829 {
6830 if ($this->state != 2) {
6831 return;
6832 }
6835 }
6838 }
6839 // check page for no-write regions and adapt page margins if necessary
6841 $exurl = ''; // external streams
6842 $imsize = FALSE;
6843 // check if we are passing an image as file or string
6845 // image from string
6847 } else { // image file
6849 // image as external stream
6851 $exurl = $file;
6852 }
6853 // check if is a local file
6855 // try to encode spaces on filename
6857 if (@file_exists($tfile)) {
6858 $file = $tfile;
6859 }
6860 }
6863 // get existing image data
6868 }
6869 }
6870 }
6872 // copy image to cache
6873 $original_file = $file;
6876 if (!$fp) {
6878 }
6879 fwrite($fp, $imgdata);
6880 fclose($fp);
6881 unset($imgdata);
6882 $imsize = @getimagesize($file);
6883 if ($imsize === FALSE) {
6884 unlink($file);
6885 $file = $original_file;
6886 }
6887 }
6888 if ($imsize === FALSE) {
6890 // get measures from specified data
6893 $imsize = array($pw, $ph);
6894 } else {
6896 }
6897 }
6898 // file hash
6899 $filehash = md5($file);
6900 // get original image width and height in pixels
6901 list($pixw, $pixh) = $imsize;
6902 // calculate image width and height on document
6904 // convert image size to document unit
6907 } elseif ($w <= 0) {
6909 } elseif ($h <= 0) {
6912 if (strlen($fitbox) !== 2) {
6913 // set default alignment
6914 $fitbox = '--';
6915 }
6916 // scale image dimensions proportionally to fit within the ($w, $h) box
6918 // store current height
6919 $oldh = $h;
6920 // calculate new height
6922 // height difference
6923 $hdiff = ($oldh - $h);
6924 // vertical alignment
6925 switch (strtoupper($fitbox[1])) {
6926 case 'T': {
6927 break;
6928 }
6929 case 'M': {
6930 $y += ($hdiff / 2);
6931 break;
6932 }
6933 case 'B': {
6934 $y += $hdiff;
6935 break;
6936 }
6937 }
6938 } else {
6939 // store current width
6940 $oldw = $w;
6941 // calculate new width
6943 // width difference
6944 $wdiff = ($oldw - $w);
6945 // horizontal alignment
6946 switch (strtoupper($fitbox[0])) {
6947 case 'L': {
6948 if ($this->rtl) {
6949 $x -= $wdiff;
6950 }
6951 break;
6952 }
6953 case 'C': {
6954 if ($this->rtl) {
6955 $x -= ($wdiff / 2);
6956 } else {
6957 $x += ($wdiff / 2);
6958 }
6959 break;
6960 }
6961 case 'R': {
6962 if (!$this->rtl) {
6963 $x += $wdiff;
6964 }
6965 break;
6966 }
6967 }
6968 }
6969 }
6970 // fit the image on available space
6972 // calculate new minimum dimensions in pixels
6975 // check if resize is necessary (resize is used only to reduce the image)
6976 $newsize = ($neww * $newh);
6977 $pixsize = ($pixw * $pixh);
6978 if (intval($resize) == 2) {
6979 $resize = true;
6980 } elseif ($newsize >= $pixsize) {
6981 $resize = false;
6982 }
6983 // check if image has been already added on document
6984 $newimage = true;
6986 $newimage = false;
6987 // get existing image data
6990 // check if the newer image is larger
6992 if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
6993 $newimage = true;
6994 }
6995 }
6996 } elseif (($ismask === false) AND ($imgmask === false) AND (strpos($file, '__tcpdf_'.$this->file_id.'_imgmask_') === FALSE)) {
6997 // create temp image file (without alpha channel)
6999 // create temp alpha file
7001 // check for cached images
7002 if (in_array($tempfile_plain, $this->imagekeys)) {
7003 // get existing image data
7005 // check if the newer image is larger
7007 if ((($oldsize < $newsize) AND ($resize)) OR (($oldsize < $pixsize) AND (!$resize))) {
7008 $newimage = true;
7009 } else {
7010 $newimage = false;
7011 // embed mask image
7012 $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false);
7013 // embed image, masked with previously embedded mask
7014 return $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask);
7015 }
7016 }
7017 }
7018 if ($newimage) {
7019 //First use of image, get info
7020 $type = strtolower($type);
7021 if ($type == '') {
7023 } elseif ($type == 'jpg') {
7024 $type = 'jpeg';
7025 }
7026 $mqr = TCPDF_STATIC::get_mqr();
7028 // Specific image handlers (defined on TCPDF_IMAGES CLASS)
7029 $mtd = '_parse'.$type;
7030 // GD image handler function
7031 $gdfunction = 'imagecreatefrom'.$type;
7033 if ((method_exists('TCPDF_IMAGES', $mtd)) AND (!($resize AND (function_exists($gdfunction) OR extension_loaded('imagick'))))) {
7034 // TCPDF image functions
7036 if (($ismask === false) AND ($imgmask === false) AND (strpos($file, '__tcpdf_'.$this->file_id.'_imgmask_') === FALSE)
7038 return $this->ImagePngAlpha($file, $x, $y, $pixw, $pixh, $w, $h, 'PNG', $link, $align, $resize, $dpi, $palign, $filehash);
7039 }
7040 }
7042 try {
7043 // GD library
7046 if ($resize) {
7047 $imgr = imagecreatetruecolor($neww, $newh);
7048 if (($type == 'gif') OR ($type == 'png')) {
7050 }
7051 imagecopyresampled($imgr, $img, 0, 0, 0, 0, $neww, $newh, $pixw, $pixh);
7052 $img = $imgr;
7053 }
7054 if (($type == 'gif') OR ($type == 'png')) {
7056 } else {
7057 $info = TCPDF_IMAGES::_toJPEG($img, $this->jpeg_quality, TCPDF_STATIC::getObjFilename('img', $this->file_id));
7058 }
7059 }
7060 } catch(Exception $e) {
7062 }
7063 }
7065 try {
7066 // ImageMagick library
7068 if ($type == 'svg') {
7070 // image from string
7071 $svgimg = substr($file, 1);
7072 } else {
7073 // get SVG file content
7075 }
7076 if ($svgimg !== FALSE) {
7077 // get width and height
7078 $regs = array();
7079 if (preg_match('/<svg([^>]*)>/si', $svgimg, $regs)) {
7080 $svgtag = $regs[1];
7081 $tmp = array();
7082 if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
7085 $svgtag = preg_replace('/[\s]+width[\s]*=[\s]*"[^"]*"/si', ' width="'.$owu.'"', $svgtag, 1);
7086 } else {
7087 $ow = $w;
7088 }
7089 $tmp = array();
7090 if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $svgtag, $tmp)) {
7093 $svgtag = preg_replace('/[\s]+height[\s]*=[\s]*"[^"]*"/si', ' height="'.$ohu.'"', $svgtag, 1);
7094 } else {
7095 $oh = $h;
7096 }
7097 $tmp = array();
7098 if (!preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $svgtag, $tmp)) {
7099 $vbw = ($ow * $this->imgscale * $this->k);
7100 $vbh = ($oh * $this->imgscale * $this->k);
7101 $vbox = sprintf(' viewBox="0 0 %F %F" ', $vbw, $vbh);
7102 $svgtag = $vbox.$svgtag;
7103 }
7104 $svgimg = preg_replace('/<svg([^>]*)>/si', '<svg'.$svgtag.'>', $svgimg, 1);
7105 }
7106 $img->readImageBlob($svgimg);
7107 }
7108 } else {
7110 }
7111 if ($resize) {
7113 }
7114 $img->setCompressionQuality($this->jpeg_quality);
7117 $img->writeImage($tempname);
7119 unlink($tempname);
7120 $img->destroy();
7121 } catch(Exception $e) {
7123 }
7124 }
7126 // unable to process image
7127 return;
7128 }
7129 TCPDF_STATIC::set_mqr($mqr);
7130 if ($ismask) {
7131 // force grayscale
7133 }
7134 if ($imgmask !== false) {
7136 }
7137 if (!empty($exurl)) {
7139 }
7140 // array of alternative images
7142 // add image to document
7144 }
7145 // set alignment
7147 // set alignment
7148 if ($this->rtl) {
7149 if ($palign == 'L') {
7150 $ximg = $this->lMargin;
7151 } elseif ($palign == 'C') {
7152 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
7153 } elseif ($palign == 'R') {
7154 $ximg = $this->w - $this->rMargin - $w;
7155 } else {
7157 }
7158 $this->img_rb_x = $ximg;
7159 } else {
7160 if ($palign == 'L') {
7161 $ximg = $this->lMargin;
7162 } elseif ($palign == 'C') {
7163 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
7164 } elseif ($palign == 'R') {
7165 $ximg = $this->w - $this->rMargin - $w;
7166 } else {
7167 $ximg = $x;
7168 }
7169 $this->img_rb_x = $ximg + $w;
7170 }
7171 if ($ismask OR $hidden) {
7172 // image is not displayed
7174 }
7175 $xkimg = $ximg * $this->k;
7176 if (!$alt) {
7177 // only non-alternative immages will be set
7178 $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']));
7179 }
7181 $bx = $this->x;
7182 $by = $this->y;
7183 $this->x = $ximg;
7184 if ($this->rtl) {
7185 $this->x += $w;
7186 }
7187 $this->y = $y;
7189 $this->x = $bx;
7190 $this->y = $by;
7191 }
7192 if ($link) {
7194 }
7195 // set pointer to align the next text/objects
7196 switch($align) {
7197 case 'T': {
7198 $this->y = $y;
7199 $this->x = $this->img_rb_x;
7200 break;
7201 }
7202 case 'M': {
7204 $this->x = $this->img_rb_x;
7205 break;
7206 }
7207 case 'B': {
7208 $this->y = $this->img_rb_y;
7209 $this->x = $this->img_rb_x;
7210 break;
7211 }
7212 case 'N': {
7213 $this->SetY($this->img_rb_y);
7214 break;
7215 }
7216 default:{
7217 break;
7218 }
7219 }
7220 $this->endlinex = $this->img_rb_x;
7221 if ($this->inxobj) {
7222 // we are inside an XObject template
7224 }
7226 }
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:7249
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(), and SetY().
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 14835 of file tcpdf.php.
14835 {
14836 if ($this->state != 2) {
14837 return;
14838 }
14840 // convert EPS to raster image using GD or ImageMagick libraries
14841 return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
14842 }
14845 }
14848 }
14849 // check page for no-write regions and adapt page margins if necessary
14854 } else { // EPS/AI file
14856 }
14859 }
14860 $regs = array();
14861 // EPS/AI compatibility check (only checks files created by Adobe Illustrator!)
14863 if (count($regs) > 1) {
14864 $version_str = trim($regs[1]); # e.g. "Adobe Illustrator(R) 8.0"
14865 if (strpos($version_str, 'Adobe Illustrator') !== false) {
14866 $versexp = explode(' ', $version_str);
14867 $version = (float)array_pop($versexp);
14868 if ($version >= 9) {
14870 }
14871 }
14872 }
14873 // strip binary bytes in front of PS-header
14875 if ($start > 0) {
14877 }
14878 // find BoundingBox params
14880 if (count($regs) > 1) {
14881 list($x1, $y1, $x2, $y2) = explode(' ', trim($regs[1]));
14882 } else {
14884 }
14886 if ($start === false) {
14888 }
14889 if ($start === false) {
14891 }
14894 if ($end===false) {
14896 }
14897 if ($end) {
14899 }
14900 // calculate image width and height on document
14904 } elseif ($w <= 0) {
14906 } elseif ($h <= 0) {
14908 }
14909 // fit the image on available space
14911 if ($this->rasterize_vector_images) {
14912 // convert EPS to raster image using GD or ImageMagick libraries
14913 return $this->Image($file, $x, $y, $w, $h, 'EPS', $link, $align, true, 300, $palign, false, false, $border, false, false, $fitonpage);
14914 }
14915 // set scaling factors
14918 // set alignment
14920 // set alignment
14921 if ($this->rtl) {
14922 if ($palign == 'L') {
14923 $ximg = $this->lMargin;
14924 } elseif ($palign == 'C') {
14925 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
14926 } elseif ($palign == 'R') {
14927 $ximg = $this->w - $this->rMargin - $w;
14928 } else {
14930 }
14931 $this->img_rb_x = $ximg;
14932 } else {
14933 if ($palign == 'L') {
14934 $ximg = $this->lMargin;
14935 } elseif ($palign == 'C') {
14936 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
14937 } elseif ($palign == 'R') {
14938 $ximg = $this->w - $this->rMargin - $w;
14939 } else {
14940 $ximg = $x;
14941 }
14942 $this->img_rb_x = $ximg + $w;
14943 }
14944 if ($useBoundingBox) {
14945 $dx = $ximg * $k - $x1;
14947 } else {
14948 $dx = $ximg * $k;
14950 }
14951 // save the current graphic state
14953 // translate
14954 $this->_out(sprintf('%F %F %F %F %F %F cm', 1, 0, 0, 1, $dx, $dy + ($this->hPt - (2 * $y * $k) - ($y2 - $y1))));
14955 // scale
14956 if (isset($scale_x)) {
14957 $this->_out(sprintf('%F %F %F %F %F %F cm', $scale_x, 0, 0, $scale_y, $x1 * (1 - $scale_x), $y2 * (1 - $scale_y)));
14958 }
14959 // handle pc/unix/mac line endings
14961 $u=0;
14962 $cnt = count($lines);
14963 for ($i=0; $i < $cnt; ++$i) {
14964 $line = $lines[$i];
14965 if (($line == '') OR ($line[0] == '%')) {
14966 continue;
14967 }
14968 $len = strlen($line);
14969 // check for spot color names
14970 $color_name = '';
14971 if (strcasecmp('x', substr(trim($line), -1)) == 0) {
14972 if (preg_match('/\([^\)]*\)/', $line, $matches) > 0) {
14973 // extract spot color name
14974 $color_name = $matches[0];
14975 // remove color name from string
14976 $line = str_replace(' '.$color_name, '', $line);
14977 // remove pharentesis from color name
14978 $color_name = substr($color_name, 1, -1);
14979 }
14980 }
14981 $chunks = explode(' ', $line);
14982 $cmd = trim(array_pop($chunks));
14983 // RGB
14985 $b = array_pop($chunks);
14986 $g = array_pop($chunks);
14987 $r = array_pop($chunks);
14988 $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!
14989 continue;
14990 }
14991 $skip = false;
14992 if ($fixoutvals) {
14993 // check for values outside the bounding box
14995 case 'm':
14996 case 'l':
14997 case 'L': {
14998 // skip values outside bounding box
14999 foreach ($chunks as $key => $val) {
15000 if ((($key % 2) == 0) AND (($val < $x1) OR ($val > $x2))) {
15001 $skip = true;
15002 } elseif ((($key % 2) != 0) AND (($val < $y1) OR ($val > $y2))) {
15003 $skip = true;
15004 }
15005 }
15006 }
15007 }
15008 }
15010 case 'm':
15011 case 'l':
15012 case 'v':
15013 case 'y':
15014 case 'c':
15015 case 'k':
15016 case 'K':
15017 case 'g':
15018 case 'G':
15019 case 's':
15020 case 'S':
15021 case 'J':
15022 case 'j':
15023 case 'w':
15024 case 'M':
15025 case 'd':
15026 case 'n': {
15027 if ($skip) {
15028 break;
15029 }
15030 $this->_out($line);
15031 break;
15032 }
15033 case 'x': {// custom fill color
15034 if (empty($color_name)) {
15035 // CMYK color
15036 list($col_c, $col_m, $col_y, $col_k) = $chunks;
15038 } else {
15039 // Spot Color (CMYK + tint)
15040 list($col_c, $col_m, $col_y, $col_k, $col_t) = $chunks;
15041 $this->AddSpotColor($color_name, ($col_c * 100), ($col_m * 100), ($col_y * 100), ($col_k * 100));
15042 $color_cmd = sprintf('/CS%d cs %F scn', $this->spot_colors[$color_name]['i'], (1 - $col_t));
15043 $this->_out($color_cmd);
15044 }
15045 break;
15046 }
15047 case 'X': { // custom stroke color
15048 if (empty($color_name)) {
15049 // CMYK color
15050 list($col_c, $col_m, $col_y, $col_k) = $chunks;
15052 } else {
15053 // Spot Color (CMYK + tint)
15054 list($col_c, $col_m, $col_y, $col_k, $col_t) = $chunks;
15055 $this->AddSpotColor($color_name, ($col_c * 100), ($col_m * 100), ($col_y * 100), ($col_k * 100));
15056 $color_cmd = sprintf('/CS%d CS %F SCN', $this->spot_colors[$color_name]['i'], (1 - $col_t));
15057 $this->_out($color_cmd);
15058 }
15059 break;
15060 }
15061 case 'Y':
15062 case 'N':
15063 case 'V':
15064 case 'L':
15065 case 'C': {
15066 if ($skip) {
15067 break;
15068 }
15069 $line[($len - 1)] = strtolower($cmd);
15070 $this->_out($line);
15071 break;
15072 }
15073 case 'b':
15074 case 'B': {
15076 break;
15077 }
15078 case 'f':
15079 case 'F': {
15080 if ($u > 0) {
15081 $isU = false;
15082 $max = min(($i + 5), $cnt);
15083 for ($j = ($i + 1); $j < $max; ++$j) {
15084 $isU = ($isU OR (($lines[$j] == 'U') OR ($lines[$j] == '*U')));
15085 }
15086 if ($isU) {
15088 }
15089 } else {
15091 }
15092 break;
15093 }
15094 case '*u': {
15095 ++$u;
15096 break;
15097 }
15098 case '*U': {
15099 --$u;
15100 break;
15101 }
15102 }
15103 }
15104 // restore previous graphic state
15107 $bx = $this->x;
15108 $by = $this->y;
15109 $this->x = $ximg;
15110 if ($this->rtl) {
15111 $this->x += $w;
15112 }
15113 $this->y = $y;
15115 $this->x = $bx;
15116 $this->y = $by;
15117 }
15118 if ($link) {
15120 }
15121 // set pointer to align the next text/objects
15122 switch($align) {
15123 case 'T':{
15124 $this->y = $y;
15125 $this->x = $this->img_rb_x;
15126 break;
15127 }
15128 case 'M':{
15130 $this->x = $this->img_rb_x;
15131 break;
15132 }
15133 case 'B':{
15134 $this->y = $this->img_rb_y;
15135 $this->x = $this->img_rb_x;
15136 break;
15137 }
15138 case 'N':{
15139 $this->SetY($this->img_rb_y);
15140 break;
15141 }
15142 default:{
15143 break;
15144 }
15145 }
15146 $this->endlinex = $this->img_rb_x;
15147 }
References $border, $cmd, $data, $file, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $r, $w, $x, $y, _out(), AddSpotColor(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), Image(), Link(), and SetY().
Referenced by Header(), and openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 7249 of file tcpdf.php.
7249 {
7250 // create temp images
7251 if (empty($filehash)) {
7252 $filehash = md5($file);
7253 }
7254 // create temp image file (without alpha channel)
7256 // create temp alpha file
7258 $parsed = false;
7259 $parse_error = '';
7260 // ImageMagick extension
7261 if (($parsed === false) AND extension_loaded('imagick')) {
7262 try {
7263 // ImageMagick library
7266 // clone image object
7268 // extract alpha channel
7269 if (method_exists($img, 'setImageAlphaChannel') AND defined('Imagick::ALPHACHANNEL_EXTRACT')) {
7270 $img->setImageAlphaChannel(Imagick::ALPHACHANNEL_EXTRACT);
7271 } else {
7272 $img->separateImageChannel(8); // 8 = (imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE);
7274 }
7276 $img->writeImage($tempfile_alpha);
7277 // remove alpha channel
7278 if (method_exists($imga, 'setImageMatte')) {
7279 $imga->setImageMatte(false);
7280 } else {
7281 $imga->separateImageChannel(39); // 39 = (imagick::CHANNEL_ALL & ~(imagick::CHANNEL_ALPHA | imagick::CHANNEL_OPACITY | imagick::CHANNEL_MATTE));
7282 }
7283 $imga->setImageFormat('png');
7284 $imga->writeImage($tempfile_plain);
7285 $parsed = true;
7286 } catch (Exception $e) {
7287 // Imagemagick fails, try with GD
7288 $parse_error = 'Imagick library error: '.$e->getMessage();
7289 }
7290 }
7291 // GD extension
7292 if (($parsed === false) AND function_exists('imagecreatefrompng')) {
7293 try {
7294 // generate images
7296 $imgalpha = imagecreate($wpx, $hpx);
7297 // generate gray scale palette (0 -> 255)
7298 for ($c = 0; $c < 256; ++$c) {
7299 ImageColorAllocate($imgalpha, $c, $c, $c);
7300 }
7301 // extract alpha channel
7302 for ($xpx = 0; $xpx < $wpx; ++$xpx) {
7303 for ($ypx = 0; $ypx < $hpx; ++$ypx) {
7304 $color = imagecolorat($img, $xpx, $ypx);
7305 // get and correct gamma color
7307 imagesetpixel($imgalpha, $xpx, $ypx, $alpha);
7308 }
7309 }
7310 imagepng($imgalpha, $tempfile_alpha);
7311 imagedestroy($imgalpha);
7312 // extract image without alpha channel
7313 $imgplain = imagecreatetruecolor($wpx, $hpx);
7314 imagecopy($imgplain, $img, 0, 0, 0, 0, $wpx, $hpx);
7315 imagepng($imgplain, $tempfile_plain);
7316 imagedestroy($imgplain);
7317 $parsed = true;
7318 } catch (Exception $e) {
7319 // GD fails
7320 $parse_error = 'GD library error: '.$e->getMessage();
7321 }
7322 }
7323 if ($parsed === false) {
7324 if (empty($parse_error)) {
7325 $this->Error('TCPDF requires the Imagick or GD extension to handle PNG images with alpha channel.');
7326 } else {
7327 $this->Error($parse_error);
7328 }
7329 }
7330 // embed mask image
7331 $imgmask = $this->Image($tempfile_alpha, $x, $y, $w, $h, 'PNG', '', '', $resize, $dpi, '', true, false);
7332 // embed image, masked with previously embedded mask
7333 $this->Image($tempfile_plain, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, false, $imgmask);
7334 }
getGDgamma($img, $c)
Get the GD-corrected PNG gamma value from alpha color.
Definition: tcpdf.php:7343
References $alpha, $dpi, $file, $h, $img, $w, $x, $y, 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 22676 of file tcpdf.php.
22676 {
22677 if ($this->state != 2) {
22678 return;
22679 }
22680 // reset SVG vars
22681 $this->svggradients = array();
22682 $this->svggradientid = 0;
22683 $this->svgdefsmode = false;
22684 $this->svgdefs = array();
22685 $this->svgclipmode = false;
22686 $this->svgclippaths = array();
22687 $this->svgcliptm = array();
22688 $this->svgclipid = 0;
22689 $this->svgtext = '';
22690 $this->svgtextmode = array();
22692 // convert SVG to raster image using GD or ImageMagick libraries
22693 return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
22694 }
22696 $this->svgdir = '';
22697 $svgdata = substr($file, 1);
22698 } else { // SVG file
22699 $this->svgdir = dirname($file);
22701 }
22702 if ($svgdata === FALSE) {
22704 }
22707 }
22710 }
22711 // check page for no-write regions and adapt page margins if necessary
22714 $ox = 0;
22715 $oy = 0;
22716 $ow = $w;
22717 $oh = $h;
22718 $aspect_ratio_align = 'xMidYMid';
22719 $aspect_ratio_ms = 'meet';
22720 $regs = array();
22721 // get original image width and height
22722 preg_match('/<svg([^>]*)>/si', $svgdata, $regs);
22723 if (isset($regs[1]) AND !empty($regs[1])) {
22724 $tmp = array();
22725 if (preg_match('/[\s]+x[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22727 }
22728 $tmp = array();
22729 if (preg_match('/[\s]+y[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22731 }
22732 $tmp = array();
22733 if (preg_match('/[\s]+width[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22735 }
22736 $tmp = array();
22737 if (preg_match('/[\s]+height[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22739 }
22740 $tmp = array();
22741 $view_box = array();
22742 if (preg_match('/[\s]+viewBox[\s]*=[\s]*"[\s]*([0-9\.\-]+)[\s]+([0-9\.\-]+)[\s]+([0-9\.]+)[\s]+([0-9\.]+)[\s]*"/si', $regs[1], $tmp)) {
22743 if (count($tmp) == 5) {
22744 array_shift($tmp);
22745 foreach ($tmp as $key => $val) {
22747 }
22748 $ox = $view_box[0];
22749 $oy = $view_box[1];
22750 }
22751 // get aspect ratio
22752 $tmp = array();
22753 if (preg_match('/[\s]+preserveAspectRatio[\s]*=[\s]*"([^"]*)"/si', $regs[1], $tmp)) {
22754 $aspect_ratio = preg_split('/[\s]+/si', $tmp[1]);
22755 switch (count($aspect_ratio)) {
22756 case 3: {
22757 $aspect_ratio_align = $aspect_ratio[1];
22758 $aspect_ratio_ms = $aspect_ratio[2];
22759 break;
22760 }
22761 case 2: {
22762 $aspect_ratio_align = $aspect_ratio[0];
22763 $aspect_ratio_ms = $aspect_ratio[1];
22764 break;
22765 }
22766 case 1: {
22767 $aspect_ratio_align = $aspect_ratio[0];
22768 $aspect_ratio_ms = 'meet';
22769 break;
22770 }
22771 }
22772 }
22773 }
22774 }
22775 if ($ow <= 0) {
22776 $ow = 1;
22777 }
22778 if ($oh <= 0) {
22779 $oh = 1;
22780 }
22781 // calculate image width and height on document
22783 // convert image size to document unit
22784 $w = $ow;
22785 $h = $oh;
22786 } elseif ($w <= 0) {
22788 } elseif ($h <= 0) {
22790 }
22791 // fit the image on available space
22793 if ($this->rasterize_vector_images) {
22794 // convert SVG to raster image using GD or ImageMagick libraries
22795 return $this->Image($file, $x, $y, $w, $h, 'SVG', $link, $align, true, 300, $palign, false, false, $border, false, false, false);
22796 }
22797 // set alignment
22799 // set alignment
22800 if ($this->rtl) {
22801 if ($palign == 'L') {
22802 $ximg = $this->lMargin;
22803 } elseif ($palign == 'C') {
22804 $ximg = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22805 } elseif ($palign == 'R') {
22806 $ximg = $this->w - $this->rMargin - $w;
22807 } else {
22809 }
22810 $this->img_rb_x = $ximg;
22811 } else {
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 {
22819 $ximg = $x;
22820 }
22821 $this->img_rb_x = $ximg + $w;
22822 }
22823 // store current graphic vars
22824 $gvars = $this->getGraphicVars();
22825 // store SVG position and scale factors
22826 $svgoffset_x = ($ximg - $ox) * $this->k;
22827 $svgoffset_y = -($y - $oy) * $this->k;
22828 if (isset($view_box[2]) AND ($view_box[2] > 0) AND ($view_box[3] > 0)) {
22829 $ow = $view_box[2];
22830 $oh = $view_box[3];
22831 } else {
22832 if ($ow <= 0) {
22833 $ow = $w;
22834 }
22835 if ($oh <= 0) {
22836 $oh = $h;
22837 }
22838 }
22839 $svgscale_x = $w / $ow;
22840 $svgscale_y = $h / $oh;
22841 // scaling and alignment
22842 if ($aspect_ratio_align != 'none') {
22843 // store current scaling values
22844 $svgscale_old_x = $svgscale_x;
22845 $svgscale_old_y = $svgscale_y;
22846 // force uniform scaling
22847 if ($aspect_ratio_ms == 'slice') {
22848 // the entire viewport is covered by the viewBox
22849 if ($svgscale_x > $svgscale_y) {
22850 $svgscale_y = $svgscale_x;
22851 } elseif ($svgscale_x < $svgscale_y) {
22852 $svgscale_x = $svgscale_y;
22853 }
22854 } else { // meet
22855 // the entire viewBox is visible within the viewport
22856 if ($svgscale_x < $svgscale_y) {
22857 $svgscale_y = $svgscale_x;
22858 } elseif ($svgscale_x > $svgscale_y) {
22859 $svgscale_x = $svgscale_y;
22860 }
22861 }
22862 // correct X alignment
22863 switch (substr($aspect_ratio_align, 1, 3)) {
22864 case 'Min': {
22865 // do nothing
22866 break;
22867 }
22868 case 'Max': {
22870 break;
22871 }
22872 default:
22873 case 'Mid': {
22875 break;
22876 }
22877 }
22878 // correct Y alignment
22879 switch (substr($aspect_ratio_align, 5)) {
22880 case 'Min': {
22881 // do nothing
22882 break;
22883 }
22884 case 'Max': {
22886 break;
22887 }
22888 default:
22889 case 'Mid': {
22891 break;
22892 }
22893 }
22894 }
22895 // store current page break mode
22896 $page_break_mode = $this->AutoPageBreak;
22897 $page_break_margin = $this->getBreakMargin();
22899 $this->SetCellPadding(0);
22901 // save the current graphic state
22903 // set initial clipping mask
22905 // scale and translate
22906 $e = $ox * $this->k * (1 - $svgscale_x);
22907 $f = ($this->h - $oy) * $this->k * (1 - $svgscale_y);
22908 $this->_out(sprintf('%F %F %F %F %F %F cm', $svgscale_x, 0, 0, $svgscale_y, ($e + $svgoffset_x), ($f + $svgoffset_y)));
22909 // creates a new XML parser to be used by the other XML functions
22910 $this->parser = xml_parser_create('UTF-8');
22911 // the following function allows to use parser inside object
22912 xml_set_object($this->parser, $this);
22913 // disable case-folding for this XML parser
22914 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
22915 // sets the element handler functions for the XML parser
22916 xml_set_element_handler($this->parser, 'startSVGElementHandler', 'endSVGElementHandler');
22917 // sets the character data handler function for the XML parser
22918 xml_set_character_data_handler($this->parser, 'segSVGContentHandler');
22919 // start parsing an XML document
22920 if (!xml_parse($this->parser, $svgdata)) {
22921 $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));
22922 $this->Error($error_message);
22923 }
22924 // free this XML parser
22925 xml_parser_free($this->parser);
22926 // restore previous graphic state
22928 // restore graphic vars
22929 $this->setGraphicVars($gvars);
22930 $this->lasth = $gvars['lasth'];
22932 $bx = $this->x;
22933 $by = $this->y;
22934 $this->x = $ximg;
22935 if ($this->rtl) {
22936 $this->x += $w;
22937 }
22938 $this->y = $y;
22940 $this->x = $bx;
22941 $this->y = $by;
22942 }
22943 if ($link) {
22945 }
22946 // set pointer to align the next text/objects
22947 switch($align) {
22948 case 'T':{
22949 $this->y = $y;
22950 $this->x = $this->img_rb_x;
22951 break;
22952 }
22953 case 'M':{
22955 $this->x = $this->img_rb_x;
22956 break;
22957 }
22958 case 'B':{
22959 $this->y = $this->img_rb_y;
22960 $this->x = $this->img_rb_x;
22961 break;
22962 }
22963 case 'N':{
22964 $this->SetY($this->img_rb_y);
22965 break;
22966 }
22967 default:{
22968 // restore pointer to starting position
22969 $this->x = $gvars['x'];
22970 $this->y = $gvars['y'];
22971 $this->page = $gvars['page'];
22972 $this->current_column = $gvars['current_column'];
22973 $this->tMargin = $gvars['tMargin'];
22974 $this->bMargin = $gvars['bMargin'];
22975 $this->w = $gvars['w'];
22976 $this->h = $gvars['h'];
22977 $this->wPt = $gvars['wPt'];
22978 $this->hPt = $gvars['hPt'];
22979 $this->fwPt = $gvars['fwPt'];
22980 $this->fhPt = $gvars['fhPt'];
22981 break;
22982 }
22983 }
22984 $this->endlinex = $this->img_rb_x;
22985 // restore page break
22986 $this->SetAutoPageBreak($page_break_mode, $page_break_margin);
22987 $this->cell_padding = $cell_padding;
22988 }
SetCellPadding($pad)
Set the same internal Cell padding for top, right, bottom, left-.
Definition: tcpdf.php:2627
References $border, $file, $h, $w, $x, $y, and TCPDF_STATIC\fileGetContents().
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 22173 of file tcpdf.php.
22173 {
22174 return (($this->CurrentFont['type'] == 'TrueTypeUnicode') OR ($this->CurrentFont['type'] == 'cidfont0'));
22175 }
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 11482 of file tcpdf.php.
11482 {
11483 if ($this->state != 2) {
11484 return;
11485 }
11488 }
11489 $this->_outPoint($x1, $y1);
11490 $this->_outLine($x2, $y2);
11492 }
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 14311 of file tcpdf.php.
14311 {
14313 $this->Gradient(2, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
14314 }
Gradient($type, $coords, $stops, $background=array(), $antialias=false)
Output gradient.
Definition: tcpdf.php:14471
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 12870 of file tcpdf.php.
12870 {
12873 }
12876 }
12877 // check page for no-write regions and adapt page margins if necessary
12881 $s = '';
12882 foreach ($values as $value) {
12883 if (is_array($value)) {
12884 $s .= ',[\''.addslashes($value[1]).'\',\''.addslashes($value[0]).'\']';
12885 } else {
12886 $s .= ',[\''.addslashes($value).'\',\''.addslashes($value).'\']';
12887 }
12888 }
12889 $this->javascript .= 'f'.$name.'.setItems('.substr($s, 1).');'."\n";
12890 return;
12891 }
12892 // get default style
12893 $prop = array_merge($this->getFormDefaultProp(), $prop);
12894 // get annotation data
12895 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12896 // set additional default values
12897 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12898 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12899 $popt['da'] = $fontstyle;
12900 // build appearance stream
12901 $popt['ap'] = array();
12902 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12903 $text = '';
12904 foreach($values as $item) {
12905 if (is_array($item)) {
12906 $text .= $item[1]."\n";
12907 } else {
12908 $text .= $item."\n";
12909 }
12910 }
12911 $tmpid = $this->startTemplate($w, $h, false);
12912 $this->MultiCell($w, $h, $text, 0, '', false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
12913 $this->endTemplate();
12914 --$this->n;
12915 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
12916 unset($this->xobjects[$tmpid]);
12917 $popt['ap']['n'] .= 'Q EMC';
12918 // merge options
12919 $opt = array_merge($popt, $opt);
12920 // set remaining annotation data
12921 $opt['Subtype'] = 'Widget';
12922 $opt['ft'] = 'Ch';
12923 $opt['t'] = $name;
12924 $opt['opt'] = $values;
12925 unset($opt['mk']['ca']);
12926 unset($opt['mk']['rc']);
12927 unset($opt['mk']['ac']);
12928 unset($opt['mk']['i']);
12929 unset($opt['mk']['ri']);
12930 unset($opt['mk']['ix']);
12931 unset($opt['mk']['if']);
12932 unset($opt['mk']['tp']);
12933 $this->Annotation($x, $y, $w, $h, $name, $opt, 0);
12934 if ($this->rtl) {
12935 $this->x -= $w;
12936 } else {
12937 $this->x += $w;
12938 }
12939 }
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 7368 of file tcpdf.php.
7368 {
7369 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'])) {
7370 // revove vertical space from the top of the column
7371 return;
7372 }
7373 if ($cell) {
7374 if ($this->rtl) {
7375 $cellpadding = $this->cell_padding['R'];
7376 } else {
7377 $cellpadding = $this->cell_padding['L'];
7378 }
7379 } else {
7380 $cellpadding = 0;
7381 }
7382 if ($this->rtl) {
7383 $this->x = $this->w - $this->rMargin - $cellpadding;
7384 } else {
7385 $this->x = $this->lMargin + $cellpadding;
7386 }
7389 }
7390 $this->y += $h;
7391 $this->newline = true;
7392 }
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 11067 of file tcpdf.php.
11067 {
11069 }
Scale($s_x, $s_y, $x='', $y='')
Vertical and horizontal non-proportional Scaling.
Definition: tcpdf.php:11034
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 11103 of file tcpdf.php.
11103 {
11106 }
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 11090 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 11078 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 20840 of file tcpdf.php.
20840 {
20841 if (($frompage > $this->numpages) OR ($frompage <= $topage)) {
20842 return false;
20843 }
20844 if ($frompage == $this->page) {
20845 // close the page before moving it
20846 $this->endPage();
20847 }
20848 // move all page-related states
20849 $tmppage = $this->getPageBuffer($frompage);
20850 $tmppagedim = $this->pagedim[$frompage];
20851 $tmppagelen = $this->pagelen[$frompage];
20852 $tmpintmrk = $this->intmrk[$frompage];
20853 $tmpbordermrk = $this->bordermrk[$frompage];
20854 $tmpcntmrk = $this->cntmrk[$frompage];
20855 $tmppageobjects = $this->pageobjects[$frompage];
20856 if (isset($this->footerpos[$frompage])) {
20857 $tmpfooterpos = $this->footerpos[$frompage];
20858 }
20859 if (isset($this->footerlen[$frompage])) {
20860 $tmpfooterlen = $this->footerlen[$frompage];
20861 }
20862 if (isset($this->transfmrk[$frompage])) {
20863 $tmptransfmrk = $this->transfmrk[$frompage];
20864 }
20865 if (isset($this->PageAnnots[$frompage])) {
20866 $tmpannots = $this->PageAnnots[$frompage];
20867 }
20868 if (isset($this->newpagegroup) AND !empty($this->newpagegroup)) {
20869 for ($i = $frompage; $i > $topage; --$i) {
20870 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $frompage)) {
20871 --$this->pagegroups[$this->newpagegroup[$i]];
20872 break;
20873 }
20874 }
20875 for ($i = $topage; $i > 0; --$i) {
20876 if (isset($this->newpagegroup[$i]) AND (($i + $this->pagegroups[$this->newpagegroup[$i]]) > $topage)) {
20877 ++$this->pagegroups[$this->newpagegroup[$i]];
20878 break;
20879 }
20880 }
20881 }
20882 for ($i = $frompage; $i > $topage; --$i) {
20883 $j = $i - 1;
20884 // shift pages down
20886 $this->pagedim[$i] = $this->pagedim[$j];
20887 $this->pagelen[$i] = $this->pagelen[$j];
20888 $this->intmrk[$i] = $this->intmrk[$j];
20889 $this->bordermrk[$i] = $this->bordermrk[$j];
20890 $this->cntmrk[$i] = $this->cntmrk[$j];
20891 $this->pageobjects[$i] = $this->pageobjects[$j];
20892 if (isset($this->footerpos[$j])) {
20893 $this->footerpos[$i] = $this->footerpos[$j];
20894 } elseif (isset($this->footerpos[$i])) {
20895 unset($this->footerpos[$i]);
20896 }
20897 if (isset($this->footerlen[$j])) {
20898 $this->footerlen[$i] = $this->footerlen[$j];
20899 } elseif (isset($this->footerlen[$i])) {
20900 unset($this->footerlen[$i]);
20901 }
20902 if (isset($this->transfmrk[$j])) {
20903 $this->transfmrk[$i] = $this->transfmrk[$j];
20904 } elseif (isset($this->transfmrk[$i])) {
20905 unset($this->transfmrk[$i]);
20906 }
20907 if (isset($this->PageAnnots[$j])) {
20908 $this->PageAnnots[$i] = $this->PageAnnots[$j];
20909 } elseif (isset($this->PageAnnots[$i])) {
20910 unset($this->PageAnnots[$i]);
20911 }
20912 if (isset($this->newpagegroup[$j])) {
20913 $this->newpagegroup[$i] = $this->newpagegroup[$j];
20914 unset($this->newpagegroup[$j]);
20915 }
20916 if ($this->currpagegroup == $j) {
20917 $this->currpagegroup = $i;
20918 }
20919 }
20920 $this->setPageBuffer($topage, $tmppage);
20921 $this->pagedim[$topage] = $tmppagedim;
20922 $this->pagelen[$topage] = $tmppagelen;
20923 $this->intmrk[$topage] = $tmpintmrk;
20924 $this->bordermrk[$topage] = $tmpbordermrk;
20925 $this->cntmrk[$topage] = $tmpcntmrk;
20926 $this->pageobjects[$topage] = $tmppageobjects;
20927 if (isset($tmpfooterpos)) {
20928 $this->footerpos[$topage] = $tmpfooterpos;
20929 } elseif (isset($this->footerpos[$topage])) {
20930 unset($this->footerpos[$topage]);
20931 }
20932 if (isset($tmpfooterlen)) {
20933 $this->footerlen[$topage] = $tmpfooterlen;
20934 } elseif (isset($this->footerlen[$topage])) {
20935 unset($this->footerlen[$topage]);
20936 }
20937 if (isset($tmptransfmrk)) {
20938 $this->transfmrk[$topage] = $tmptransfmrk;
20939 } elseif (isset($this->transfmrk[$topage])) {
20940 unset($this->transfmrk[$topage]);
20941 }
20942 if (isset($tmpannots)) {
20943 $this->PageAnnots[$topage] = $tmpannots;
20944 } elseif (isset($this->PageAnnots[$topage])) {
20945 unset($this->PageAnnots[$topage]);
20946 }
20947 // adjust outlines
20948 $tmpoutlines = $this->outlines;
20949 foreach ($tmpoutlines as $key => $outline) {
20950 if (!$outline['f']) {
20951 if (($outline['p'] >= $topage) AND ($outline['p'] < $frompage)) {
20952 $this->outlines[$key]['p'] = ($outline['p'] + 1);
20953 } elseif ($outline['p'] == $frompage) {
20954 $this->outlines[$key]['p'] = $topage;
20955 }
20956 }
20957 }
20958 // adjust dests
20959 $tmpdests = $this->dests;
20960 foreach ($tmpdests as $key => $dest) {
20961 if (!$dest['f']) {
20962 if (($dest['p'] >= $topage) AND ($dest['p'] < $frompage)) {
20963 $this->dests[$key]['p'] = ($dest['p'] + 1);
20964 } elseif ($dest['p'] == $frompage) {
20965 $this->dests[$key]['p'] = $topage;
20966 }
20967 }
20968 }
20969 // adjust links
20970 $tmplinks = $this->links;
20971 foreach ($tmplinks as $key => $link) {
20972 if (!$link['f']) {
20973 if (($link['p'] >= $topage) AND ($link['p'] < $frompage)) {
20974 $this->links[$key]['p'] = ($link['p'] + 1);
20975 } elseif ($link['p'] == $frompage) {
20976 $this->links[$key]['p'] = $topage;
20977 }
20978 }
20979 }
20980 // adjust javascript
20981 $jfrompage = $frompage;
20982 $jtopage = $topage;
20983 if (preg_match_all('/this\.addField\(\'([^\']*)\',\'([^\']*)\',([0-9]+)/', $this->javascript, $pamatch) > 0) {
20984 foreach($pamatch[0] as $pk => $pmatch) {
20985 $pagenum = intval($pamatch[3][$pk]) + 1;
20986 if (($pagenum >= $jtopage) AND ($pagenum < $jfrompage)) {
20987 $newpage = ($pagenum + 1);
20988 } elseif ($pagenum == $jfrompage) {
20989 $newpage = $jtopage;
20990 } else {
20991 $newpage = $pagenum;
20992 }
20993 --$newpage;
20994 $newjs = "this.addField(\'".$pamatch[1][$pk]."\',\'".$pamatch[2][$pk]."\',".$newpage;
20995 $this->javascript = str_replace($pmatch, $newjs, $this->javascript);
20996 }
20997 unset($pamatch);
20998 }
20999 // return to last page
21001 return true;
21002 }
◆ 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
5946 for ($column = $startcolumn; $column <= $endcolumn; ++$column) { // for each column
5947 $this->selectColumn($column);
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;
5957 } elseif ($column == $startcolumn) { // first column
5958 $cborder = $border_start;
5959 $this->y = $oy;
5961 } elseif ($column == $endcolumn) { // end column
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
5976 $this->selectColumn($column);
5977 if ($this->rtl) {
5978 $this->x -= $mc_margin['R'];
5979 } else {
5980 $this->x += $mc_margin['L'];
5981 }
5982 if ($column == $startcolumn) { // first column
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
5994 for ($column = 0; $column <= $endcolumn; ++$column) { // for each column
5995 $this->selectColumn($column);
5996 if ($this->rtl) {
5997 $this->x -= $mc_margin['R'];
5998 } else {
5999 $this->x += $mc_margin['L'];
6000 }
6001 if ($column == $endcolumn) {
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
6018 $this->selectColumn($column);
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, $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 18678 of file tcpdf.php.
18678 {
18679 $tag = $dom[$key];
18680 $parent = $dom[($dom[$key]['parent'])];
18681 $firsttag = ($key == 1);
18682 // check for text direction attribute
18683 if (isset($tag['dir'])) {
18685 } else {
18686 $this->tmprtl = false;
18687 }
18688 if ($tag['block']) {
18689 $hbz = 0; // distance from y to line bottom
18690 $hb = 0; // vertical space between block tags
18691 // calculate vertical space for block tags
18692 if (isset($this->tagvspaces[$tag['value']][0]['h']) AND ($this->tagvspaces[$tag['value']][0]['h'] >= 0)) {
18693 $cur_h = $this->tagvspaces[$tag['value']][0]['h'];
18694 } elseif (isset($tag['fontsize'])) {
18696 } else {
18697 $cur_h = $this->getCellHeight($this->FontSize);
18698 }
18699 if (isset($this->tagvspaces[$tag['value']][0]['n'])) {
18700 $on = $this->tagvspaces[$tag['value']][0]['n'];
18701 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
18702 $on = 0.6;
18703 } else {
18704 $on = 1;
18705 }
18706 if ((!isset($this->tagvspaces[$tag['value']])) AND (in_array($tag['value'], array('div', 'dt', 'dd', 'li', 'br', 'hr')))) {
18707 $hb = 0;
18708 } else {
18709 $hb = ($on * $cur_h);
18710 }
18711 if (($this->htmlvspace <= 0) AND ($on > 0)) {
18712 if (isset($parent['fontsize'])) {
18714 } else {
18715 $hbz = $this->getCellHeight($this->FontSize);
18716 }
18717 }
18718 if (isset($dom[($key - 1)]) AND ($dom[($key - 1)]['value'] == 'table')) {
18719 // fix vertical space after table
18720 $hbz = 0;
18721 }
18722 // closing vertical space
18723 $hbc = 0;
18724 if (isset($this->tagvspaces[$tag['value']][1]['h']) AND ($this->tagvspaces[$tag['value']][1]['h'] >= 0)) {
18725 $pre_h = $this->tagvspaces[$tag['value']][1]['h'];
18726 } elseif (isset($parent['fontsize'])) {
18728 } else {
18729 $pre_h = $this->getCellHeight($this->FontSize);
18730 }
18731 if (isset($this->tagvspaces[$tag['value']][1]['n'])) {
18732 $cn = $this->tagvspaces[$tag['value']][1]['n'];
18733 } elseif (preg_match('/[h][0-9]/', $tag['value']) > 0) {
18734 $cn = 0.6;
18735 } else {
18736 $cn = 1;
18737 }
18738 if (isset($this->tagvspaces[$tag['value']][1])) {
18739 $hbc = ($cn * $pre_h);
18740 }
18741 }
18742 // Opening tag
18743 switch($tag['value']) {
18744 case 'table': {
18745 $cp = 0;
18746 $cs = 0;
18747 $dom[$key]['rowspans'] = array();
18748 if (!isset($dom[$key]['attribute']['nested']) OR ($dom[$key]['attribute']['nested'] != 'true')) {
18749 $this->htmlvspace = 0;
18750 // set table header
18752 // set table header
18753 $this->thead = $dom[$key]['thead'];
18754 if (!isset($this->theadMargins) OR (empty($this->theadMargins))) {
18755 $this->theadMargins = array();
18760 $this->theadMargins['cell'] = $cell;
18762 }
18763 }
18764 }
18765 // store current margins and page
18767 if (isset($tag['attribute']['cellpadding'])) {
18769 $this->SetCellPadding($pad);
18770 } elseif (isset($tag['padding'])) {
18771 $this->cell_padding = $tag['padding'];
18772 }
18773 if (isset($tag['attribute']['cellspacing'])) {
18775 } elseif (isset($tag['border-spacing'])) {
18776 $cs = $tag['border-spacing']['V'];
18777 }
18778 $prev_y = $this->y;
18779 if ($this->checkPageBreak(((2 * $cp) + (2 * $cs) + $this->lasth), '', false) OR ($this->y < $prev_y)) {
18780 $this->inthead = true;
18781 // add a page (or trig AcceptPageBreak() for multicolumn mode)
18782 $this->checkPageBreak($this->PageBreakTrigger + 1);
18783 }
18784 break;
18785 }
18786 case 'tr': {
18787 // array of columns positions
18788 $dom[$key]['cellpos'] = array();
18789 break;
18790 }
18791 case 'hr': {
18792 if ((isset($tag['height'])) AND ($tag['height'] != '')) {
18794 } else {
18795 $hrHeight = $this->GetLineWidth();
18796 }
18797 $this->addHTMLVertSpace($hbz, max($hb, ($hrHeight / 2)), $cell, $firsttag);
18800 $wtmp = $this->w - $this->lMargin - $this->rMargin;
18801 if ($cell) {
18802 $wtmp -= ($this->cell_padding['L'] + $this->cell_padding['R']);
18803 }
18804 if ((isset($tag['width'])) AND ($tag['width'] != '')) {
18806 } else {
18807 $hrWidth = $wtmp;
18808 }
18809 $prevlinewidth = $this->GetLineWidth();
18810 $this->SetLineWidth($hrHeight);
18812 $this->SetLineWidth($prevlinewidth);
18813 $this->addHTMLVertSpace(max($hbc, ($hrHeight / 2)), 0, $cell, !isset($dom[($key + 1)]));
18814 break;
18815 }
18816 case 'a': {
18817 if (array_key_exists('href', $tag['attribute'])) {
18818 $this->HREF['url'] = $tag['attribute']['href'];
18819 }
18820 break;
18821 }
18822 case 'img': {
18823 if (!empty($tag['attribute']['src'])) {
18824 if ($tag['attribute']['src'][0] === '@') {
18825 // data stream
18826 $tag['attribute']['src'] = '@'.base64_decode(substr($tag['attribute']['src'], 1));
18827 $type = '';
18828 } else {
18829 // get image type
18831 }
18832 if (!isset($tag['width'])) {
18833 $tag['width'] = 0;
18834 }
18835 if (!isset($tag['height'])) {
18836 $tag['height'] = 0;
18837 }
18838 //if (!isset($tag['attribute']['align'])) {
18839 // the only alignment supported is "bottom"
18840 // further development is required for other modes.
18841 $tag['attribute']['align'] = 'bottom';
18842 //}
18843 switch($tag['attribute']['align']) {
18844 case 'top': {
18845 $align = 'T';
18846 break;
18847 }
18848 case 'middle': {
18849 $align = 'M';
18850 break;
18851 }
18852 case 'bottom': {
18853 $align = 'B';
18854 break;
18855 }
18856 default: {
18857 $align = 'B';
18858 break;
18859 }
18860 }
18861 $prevy = $this->y;
18862 $xpos = $this->x;
18863 $imglink = '';
18865 $imglink = $this->HREF['url'];
18866 if ($imglink[0] == '#') {
18867 // convert url to internal link
18868 $lnkdata = explode(',', $imglink);
18869 if (isset($lnkdata[0])) {
18870 $page = intval(substr($lnkdata[0], 1));
18873 }
18874 if (isset($lnkdata[1]) AND (strlen($lnkdata[1]) > 0)) {
18875 $lnky = floatval($lnkdata[1]);
18876 } else {
18877 $lnky = 0;
18878 }
18879 $imglink = $this->AddLink();
18881 }
18882 }
18883 }
18884 $border = 0;
18885 if (isset($tag['border']) AND !empty($tag['border'])) {
18886 // currently only support 1 (frame) or a combination of 'LTRB'
18888 }
18889 $iw = '';
18890 if (isset($tag['width'])) {
18892 }
18893 $ih = '';
18894 if (isset($tag['height'])) {
18896 }
18897 if (($type == 'eps') OR ($type == 'ai')) {
18898 $this->ImageEps($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, true, $align, '', $border, true);
18899 } elseif ($type == 'svg') {
18900 $this->ImageSVG($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, $imglink, $align, '', $border, true);
18901 } else {
18902 $this->Image($tag['attribute']['src'], $xpos, $this->y, $iw, $ih, '', $imglink, $align, false, 300, '', false, false, $border, false, false, true);
18903 }
18904 switch($align) {
18905 case 'T': {
18906 $this->y = $prevy;
18907 break;
18908 }
18909 case 'M': {
18910 $this->y = (($this->img_rb_y + $prevy - ($this->getCellHeight($tag['fontsize'] / $this->k))) / 2);
18911 break;
18912 }
18913 case 'B': {
18914 $this->y = $this->img_rb_y - ($this->getCellHeight($tag['fontsize'] / $this->k) - ($this->getFontDescent($tag['fontname'], $tag['fontstyle'], $tag['fontsize']) * $this->cell_height_ratio));
18915 break;
18916 }
18917 }
18918 }
18919 break;
18920 }
18921 case 'dl': {
18922 ++$this->listnum;
18923 if ($this->listnum == 1) {
18924 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18925 } else {
18926 $this->addHTMLVertSpace(0, 0, $cell, $firsttag);
18927 }
18928 break;
18929 }
18930 case 'dt': {
18931 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18932 break;
18933 }
18934 case 'dd': {
18935 if ($this->rtl) {
18936 $this->rMargin += $this->listindent;
18937 } else {
18938 $this->lMargin += $this->listindent;
18939 }
18940 ++$this->listindentlevel;
18941 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18942 break;
18943 }
18944 case 'ul':
18945 case 'ol': {
18946 ++$this->listnum;
18947 if ($tag['value'] == 'ol') {
18949 } else {
18951 }
18952 if (isset($tag['attribute']['start'])) {
18954 } else {
18955 $this->listcount[$this->listnum] = 0;
18956 }
18957 if ($this->rtl) {
18958 $this->rMargin += $this->listindent;
18959 $this->x -= $this->listindent;
18960 } else {
18961 $this->lMargin += $this->listindent;
18962 $this->x += $this->listindent;
18963 }
18964 ++$this->listindentlevel;
18965 if ($this->listnum == 1) {
18966 if ($key > 1) {
18967 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18968 }
18969 } else {
18970 $this->addHTMLVertSpace(0, 0, $cell, $firsttag);
18971 }
18972 break;
18973 }
18974 case 'li': {
18975 if ($key > 2) {
18976 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
18977 }
18978 if ($this->listordered[$this->listnum]) {
18979 // ordered item
18980 if (isset($parent['attribute']['type']) AND !TCPDF_STATIC::empty_string($parent['attribute']['type'])) {
18981 $this->lispacer = $parent['attribute']['type'];
18983 $this->lispacer = $parent['listtype'];
18984 } elseif (isset($this->lisymbol) AND !TCPDF_STATIC::empty_string($this->lisymbol)) {
18985 $this->lispacer = $this->lisymbol;
18986 } else {
18987 $this->lispacer = '#';
18988 }
18989 ++$this->listcount[$this->listnum];
18990 if (isset($tag['attribute']['value'])) {
18992 }
18993 } else {
18994 // unordered item
18995 if (isset($parent['attribute']['type']) AND !TCPDF_STATIC::empty_string($parent['attribute']['type'])) {
18996 $this->lispacer = $parent['attribute']['type'];
18998 $this->lispacer = $parent['listtype'];
18999 } elseif (isset($this->lisymbol) AND !TCPDF_STATIC::empty_string($this->lisymbol)) {
19000 $this->lispacer = $this->lisymbol;
19001 } else {
19002 $this->lispacer = '!';
19003 }
19004 }
19005 break;
19006 }
19007 case 'blockquote': {
19008 if ($this->rtl) {
19009 $this->rMargin += $this->listindent;
19010 } else {
19011 $this->lMargin += $this->listindent;
19012 }
19013 ++$this->listindentlevel;
19014 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19015 break;
19016 }
19017 case 'br': {
19018 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19019 break;
19020 }
19021 case 'div': {
19022 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19023 break;
19024 }
19025 case 'p': {
19026 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19027 break;
19028 }
19029 case 'pre': {
19030 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19031 $this->premode = true;
19032 break;
19033 }
19034 case 'sup': {
19036 break;
19037 }
19038 case 'sub': {
19040 break;
19041 }
19042 case 'h1':
19043 case 'h2':
19044 case 'h3':
19045 case 'h4':
19046 case 'h5':
19047 case 'h6': {
19048 $this->addHTMLVertSpace($hbz, $hb, $cell, $firsttag);
19049 break;
19050 }
19051 // Form fields (since 4.8.000 - 2009-09-07)
19052 case 'form': {
19053 if (isset($tag['attribute']['action'])) {
19054 $this->form_action = $tag['attribute']['action'];
19055 } else {
19057 }
19058 if (isset($tag['attribute']['enctype'])) {
19059 $this->form_enctype = $tag['attribute']['enctype'];
19060 } else {
19061 $this->form_enctype = 'application/x-www-form-urlencoded';
19062 }
19063 if (isset($tag['attribute']['method'])) {
19064 $this->form_mode = $tag['attribute']['method'];
19065 } else {
19066 $this->form_mode = 'post';
19067 }
19068 break;
19069 }
19070 case 'input': {
19071 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19072 $name = $tag['attribute']['name'];
19073 } else {
19074 break;
19075 }
19076 $prop = array();
19077 $opt = array();
19078 if (isset($tag['attribute']['readonly']) AND !TCPDF_STATIC::empty_string($tag['attribute']['readonly'])) {
19079 $prop['readonly'] = true;
19080 }
19081 if (isset($tag['attribute']['value']) AND !TCPDF_STATIC::empty_string($tag['attribute']['value'])) {
19082 $value = $tag['attribute']['value'];
19083 }
19084 if (isset($tag['attribute']['maxlength']) AND !TCPDF_STATIC::empty_string($tag['attribute']['maxlength'])) {
19085 $opt['maxlen'] = intval($tag['attribute']['maxlength']);
19086 }
19088 if (isset($tag['attribute']['size']) AND !TCPDF_STATIC::empty_string($tag['attribute']['size'])) {
19090 } else {
19092 }
19093 if (isset($tag['attribute']['checked']) AND (($tag['attribute']['checked'] == 'checked') OR ($tag['attribute']['checked'] == 'true'))) {
19094 $checked = true;
19095 } else {
19096 $checked = false;
19097 }
19098 if (isset($tag['align'])) {
19099 switch ($tag['align']) {
19100 case 'C': {
19101 $opt['q'] = 1;
19102 break;
19103 }
19104 case 'R': {
19105 $opt['q'] = 2;
19106 break;
19107 }
19108 case 'L':
19109 default: {
19110 break;
19111 }
19112 }
19113 }
19114 switch ($tag['attribute']['type']) {
19115 case 'text': {
19116 if (isset($value)) {
19117 $opt['v'] = $value;
19118 }
19120 break;
19121 }
19122 case 'password': {
19123 if (isset($value)) {
19124 $opt['v'] = $value;
19125 }
19126 $prop['password'] = 'true';
19128 break;
19129 }
19130 case 'checkbox': {
19131 if (!isset($value)) {
19132 break;
19133 }
19135 break;
19136 }
19137 case 'radio': {
19138 if (!isset($value)) {
19139 break;
19140 }
19142 break;
19143 }
19144 case 'submit': {
19145 if (!isset($value)) {
19146 $value = 'submit';
19147 }
19149 $h *= 1.6;
19150 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19151 $action = array();
19152 $action['S'] = 'SubmitForm';
19154 if ($this->form_enctype != 'FDF') {
19155 $action['Flags'] = array('ExportFormat');
19156 }
19157 if ($this->form_mode == 'get') {
19158 $action['Flags'] = array('GetMethod');
19159 }
19161 break;
19162 }
19163 case 'reset': {
19164 if (!isset($value)) {
19165 $value = 'reset';
19166 }
19168 $h *= 1.6;
19169 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19171 break;
19172 }
19173 case 'file': {
19174 $prop['fileSelect'] = 'true';
19176 if (!isset($value)) {
19177 $value = '*';
19178 }
19180 $h *= 1.2;
19181 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19182 $jsaction = 'var f=this.getField(\''.$name.'\'); f.browseForFileToSubmit();';
19183 $this->Button('FB_'.$name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19184 break;
19185 }
19186 case 'hidden': {
19187 if (isset($value)) {
19189 }
19190 $opt['f'] = array('invisible', 'hidden');
19191 $this->TextField($name, 0, 0, $prop, $opt, '', '', false);
19192 break;
19193 }
19194 case 'image': {
19195 // THIS TYPE MUST BE FIXED
19196 if (isset($tag['attribute']['src']) AND !TCPDF_STATIC::empty_string($tag['attribute']['src'])) {
19197 $img = $tag['attribute']['src'];
19198 } else {
19199 break;
19200 }
19201 $value = 'img';
19202 //$opt['mk'] = array('i'=>$img, 'tp'=>1, 'if'=>array('sw'=>'A', 's'=>'A', 'fb'=>false));
19203 if (isset($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
19204 $jsaction = $tag['attribute']['onclick'];
19205 } else {
19206 $jsaction = '';
19207 }
19208 $this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19209 break;
19210 }
19211 case 'button': {
19212 if (!isset($value)) {
19213 $value = ' ';
19214 }
19215 $w = $this->GetStringWidth($value) * 1.5;
19216 $h *= 1.6;
19217 $prop = array('lineWidth'=>1, 'borderStyle'=>'beveled', 'fillColor'=>array(196, 196, 196), 'strokeColor'=>array(255, 255, 255));
19218 if (isset($tag['attribute']['onclick']) AND !empty($tag['attribute']['onclick'])) {
19219 $jsaction = $tag['attribute']['onclick'];
19220 } else {
19221 $jsaction = '';
19222 }
19223 $this->Button($name, $w, $h, $value, $jsaction, $prop, $opt, '', '', false);
19224 break;
19225 }
19226 }
19227 break;
19228 }
19229 case 'textarea': {
19230 $prop = array();
19231 $opt = array();
19232 if (isset($tag['attribute']['readonly']) AND !TCPDF_STATIC::empty_string($tag['attribute']['readonly'])) {
19233 $prop['readonly'] = true;
19234 }
19235 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19236 $name = $tag['attribute']['name'];
19237 } else {
19238 break;
19239 }
19240 if (isset($tag['attribute']['value']) AND !TCPDF_STATIC::empty_string($tag['attribute']['value'])) {
19242 }
19243 if (isset($tag['attribute']['cols']) AND !TCPDF_STATIC::empty_string($tag['attribute']['cols'])) {
19244 $w = intval($tag['attribute']['cols']) * $this->GetStringWidth(chr(32)) * 2;
19245 } else {
19246 $w = 40;
19247 }
19248 if (isset($tag['attribute']['rows']) AND !TCPDF_STATIC::empty_string($tag['attribute']['rows'])) {
19249 $h = intval($tag['attribute']['rows']) * $this->getCellHeight($this->FontSize);
19250 } else {
19251 $h = 10;
19252 }
19253 $prop['multiline'] = 'true';
19254 $this->TextField($name, $w, $h, $prop, $opt, '', '', false);
19255 break;
19256 }
19257 case 'select': {
19258 $h = $this->getCellHeight($this->FontSize);
19259 if (isset($tag['attribute']['size']) AND !TCPDF_STATIC::empty_string($tag['attribute']['size'])) {
19260 $h *= ($tag['attribute']['size'] + 1);
19261 }
19262 $prop = array();
19263 $opt = array();
19264 if (isset($tag['attribute']['name']) AND !TCPDF_STATIC::empty_string($tag['attribute']['name'])) {
19265 $name = $tag['attribute']['name'];
19266 } else {
19267 break;
19268 }
19269 $w = 0;
19270 if (isset($tag['attribute']['opt']) AND !TCPDF_STATIC::empty_string($tag['attribute']['opt'])) {
19271 $options = explode('#!NwL!#', $tag['attribute']['opt']);
19272 $values = array();
19273 foreach ($options as $val) {
19274 if (strpos($val, '#!TaB!#') !== false) {
19275 $opts = explode('#!TaB!#', $val);
19276 $values[] = $opts;
19277 $w = max($w, $this->GetStringWidth($opts[1]));
19278 } else {
19279 $values[] = $val;
19280 $w = max($w, $this->GetStringWidth($val));
19281 }
19282 }
19283 } else {
19284 break;
19285 }
19286 $w *= 2;
19287 if (isset($tag['attribute']['multiple']) AND ($tag['attribute']['multiple']='multiple')) {
19288 $prop['multipleSelection'] = 'true';
19289 $this->ListBox($name, $w, $h, $values, $prop, $opt, '', '', false);
19290 } else {
19291 $this->ComboBox($name, $w, $h, $values, $prop, $opt, '', '', false);
19292 }
19293 break;
19294 }
19295 case 'tcpdf': {
19297 // Special tag used to call TCPDF methods
19298 if (isset($tag['attribute']['method'])) {
19299 $tcpdf_method = $tag['attribute']['method'];
19300 if (method_exists($this, $tcpdf_method)) {
19301 if (isset($tag['attribute']['params']) AND (!empty($tag['attribute']['params']))) {
19302 $params = $this->unserializeTCPDFtagParameters($tag['attribute']['params']);
19303 call_user_func_array(array($this, $tcpdf_method), $params);
19304 } else {
19305 $this->$tcpdf_method();
19306 }
19307 $this->newline = true;
19308 }
19309 }
19310 }
19311 break;
19312 }
19313 default: {
19314 break;
19315 }
19316 }
19317 // define tags that support borders and background colors
19318 $bordertags = array('blockquote','br','dd','dl','div','dt','h1','h2','h3','h4','h5','h6','hr','li','ol','p','pre','ul','tcpdf','table');
19319 if (in_array($tag['value'], $bordertags)) {
19320 // set border
19321 $dom[$key]['borderposition'] = $this->getBorderStartPosition();
19322 }
19323 if ($dom[$key]['self'] AND isset($dom[$key]['attribute']['pagebreakafter'])) {
19324 $pba = $dom[$key]['attribute']['pagebreakafter'];
19325 // check for pagebreak
19326 if (($pba == 'true') OR ($pba == 'left') OR ($pba == 'right')) {
19327 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19328 $this->checkPageBreak($this->PageBreakTrigger + 1);
19329 }
19330 if ((($pba == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
19331 OR (($pba == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
19332 // add a page (or trig AcceptPageBreak() for multicolumn mode)
19333 $this->checkPageBreak($this->PageBreakTrigger + 1);
19334 }
19335 }
19336 return $dom;
19337 }
TextField($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false)
Creates a text field.
Definition: tcpdf.php:12646
RadioButton($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false)
Creates a RadioButton field.
Definition: tcpdf.php:12767
CheckBox($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false)
Creates a CheckBox field.
Definition: tcpdf.php:13043
Button($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false)
Creates a button field.
Definition: tcpdf.php:13123
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, Line(), RadioButton(), SetCellPadding(), SetLineWidth(), SetLink(), setTempRTL(), SetXY(), TextField(), and v().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 7559 of file tcpdf.php.
7559 {
7560 //Output PDF to some destination
7561 //Finish document if necessary
7562 if ($this->state < 3) {
7563 $this->Close();
7564 }
7565 //Normalize parameters
7566 if (is_bool($dest)) {
7567 $dest = $dest ? 'D' : 'F';
7568 }
7569 $dest = strtoupper($dest);
7570 if ($dest[0] != 'F') {
7571 $name = preg_replace('/[\s]+/', '_', $name);
7572 $name = preg_replace('/[^a-zA-Z0-9_\.-]/', '', $name);
7573 }
7574 if ($this->sign) {
7575 // *** apply digital signature to the document ***
7576 // get the document content
7577 $pdfdoc = $this->getBuffer();
7578 // remove last newline
7579 $pdfdoc = substr($pdfdoc, 0, -1);
7580 // remove filler space
7581 $byterange_string_len = strlen(TCPDF_STATIC::$byterange_string);
7582 // define the ByteRange
7583 $byte_range = array();
7584 $byte_range[0] = 0;
7585 $byte_range[1] = strpos($pdfdoc, TCPDF_STATIC::$byterange_string) + $byterange_string_len + 10;
7586 $byte_range[2] = $byte_range[1] + $this->signature_max_length + 2;
7587 $byte_range[3] = strlen($pdfdoc) - $byte_range[2];
7588 $pdfdoc = substr($pdfdoc, 0, $byte_range[1]).substr($pdfdoc, $byte_range[2]);
7589 // replace the ByteRange
7590 $byterange = sprintf('/ByteRange[0 %u %u %u]', $byte_range[1], $byte_range[2], $byte_range[3]);
7591 $byterange .= str_repeat(' ', ($byterange_string_len - strlen($byterange)));
7592 $pdfdoc = str_replace(TCPDF_STATIC::$byterange_string, $byterange, $pdfdoc);
7593 // write the document to a temporary folder
7596 if (!$f) {
7598 }
7599 $pdfdoc_length = strlen($pdfdoc);
7600 fwrite($f, $pdfdoc, $pdfdoc_length);
7601 fclose($f);
7602 // get digital signature via openssl library
7604 if (empty($this->signature_data['extracerts'])) {
7605 openssl_pkcs7_sign($tempdoc, $tempsign, $this->signature_data['signcert'], array($this->signature_data['privkey'], $this->signature_data['password']), array(), PKCS7_BINARY | PKCS7_DETACHED);
7606 } else {
7607 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']);
7608 }
7609 // read signature
7610 $signature = file_get_contents($tempsign);
7611 // extract signature
7612 $signature = substr($signature, $pdfdoc_length);
7613 $signature = substr($signature, (strpos($signature, "%%EOF\n\n------") + 13));
7614 $tmparr = explode("\n\n", $signature);
7615 $signature = $tmparr[1];
7616 // decode signature
7617 $signature = base64_decode(trim($signature));
7618 // add TSA timestamp to signature
7619 $signature = $this->applyTSA($signature);
7620 // convert signature to hex
7621 $signature = current(unpack('H*', $signature));
7622 $signature = str_pad($signature, $this->signature_max_length, '0');
7623 // Add signature to the document
7624 $this->buffer = substr($pdfdoc, 0, $byte_range[1]).'<'.$signature.'>'.substr($pdfdoc, $byte_range[1]);
7625 $this->bufferlen = strlen($this->buffer);
7626 }
7627 switch($dest) {
7628 case 'I': {
7629 // Send PDF to the standard output
7630 if (ob_get_contents()) {
7632 }
7633 if (php_sapi_name() != 'cli') {
7634 // send output to a browser
7635 header('Content-Type: application/pdf');
7636 if (headers_sent()) {
7638 }
7639 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7640 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7641 header('Pragma: public');
7642 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7643 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7644 header('Content-Disposition: inline; filename="'.basename($name).'"');
7646 } else {
7647 echo $this->getBuffer();
7648 }
7649 break;
7650 }
7651 case 'D': {
7652 // download PDF as file
7653 if (ob_get_contents()) {
7655 }
7656 header('Content-Description: File Transfer');
7657 if (headers_sent()) {
7659 }
7660 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7661 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7662 header('Pragma: public');
7663 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7664 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7665 // force download dialog
7666 if (strpos(php_sapi_name(), 'cgi') === false) {
7667 header('Content-Type: application/force-download');
7668 header('Content-Type: application/octet-stream', false);
7669 header('Content-Type: application/download', false);
7670 header('Content-Type: application/pdf', false);
7671 } else {
7672 header('Content-Type: application/pdf');
7673 }
7674 // use the Content-Disposition header to supply a recommended filename
7675 header('Content-Disposition: attachment; filename="'.basename($name).'"');
7676 header('Content-Transfer-Encoding: binary');
7678 break;
7679 }
7680 case 'F':
7681 case 'FI':
7682 case 'FD': {
7683 // save PDF to a local file
7685 if (!$f) {
7687 }
7688 fwrite($f, $this->getBuffer(), $this->bufferlen);
7689 fclose($f);
7690 if ($dest == 'FI') {
7691 // send headers to browser
7692 header('Content-Type: application/pdf');
7693 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7694 //header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
7695 header('Pragma: public');
7696 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7697 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7698 header('Content-Disposition: inline; filename="'.basename($name).'"');
7699 TCPDF_STATIC::sendOutputData(file_get_contents($name), filesize($name));
7700 } elseif ($dest == 'FD') {
7701 // send headers to browser
7702 if (ob_get_contents()) {
7704 }
7705 header('Content-Description: File Transfer');
7706 if (headers_sent()) {
7708 }
7709 header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
7710 header('Pragma: public');
7711 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
7712 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
7713 // force download dialog
7714 if (strpos(php_sapi_name(), 'cgi') === false) {
7715 header('Content-Type: application/force-download');
7716 header('Content-Type: application/octet-stream', false);
7717 header('Content-Type: application/download', false);
7718 header('Content-Type: application/pdf', false);
7719 } else {
7720 header('Content-Type: application/pdf');
7721 }
7722 // use the Content-Disposition header to supply a recommended filename
7723 header('Content-Disposition: attachment; filename="'.basename($name).'"');
7724 header('Content-Transfer-Encoding: binary');
7725 TCPDF_STATIC::sendOutputData(file_get_contents($name), filesize($name));
7726 }
7727 break;
7728 }
7729 case 'E': {
7730 // return PDF as base64 mime multi-part email attachment (RFC 2045)
7731 $retval = 'Content-Type: application/pdf;'."\r\n";
7732 $retval .= ' name="'.$name.'"'."\r\n";
7733 $retval .= 'Content-Transfer-Encoding: base64'."\r\n";
7734 $retval .= 'Content-Disposition: attachment;'."\r\n";
7735 $retval .= ' filename="'.$name.'"'."\r\n\r\n";
7737 return $retval;
7738 }
7739 case 'S': {
7740 // returns PDF as a string
7742 }
7743 default: {
7745 }
7746 }
7747 return '';
7748 }
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(), and TCPDF_STATIC\sendOutputData().
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 13689 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 14770 of file tcpdf.php.
14770 {
14772 }
PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2)
Draw the sector of an ellipse.
Definition: tcpdf.php:14791
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 14791 of file tcpdf.php.
14791 {
14792 if ($this->state != 2) {
14793 return;
14794 }
14795 if ($this->rtl) {
14797 }
14799 if ($op == 'f') {
14800 $line_style = array();
14801 }
14802 if ($cw) {
14803 $d = $b;
14804 $b = (360 - $a + $o);
14805 $a = (360 - $d + $o);
14806 } else {
14807 $b += $o;
14808 $a += $o;
14809 }
14811 $this->_out($op);
14812 }
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 10417 of file tcpdf.php.
10417 {
10419 }
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 11613 of file tcpdf.php.
11613 {
11614 if ($this->state != 2) {
11615 return;
11616 }
11618 $this->SetFillColorArray($fill_color);
11619 }
11621 if ($op == 'f') {
11622 $line_style = array();
11623 }
11624 if ($line_style) {
11625 $this->SetLineStyle($line_style);
11626 }
11627 $this->_outPoint($x0, $y0);
11628 foreach ($segments as $segment) {
11629 list($x1, $y1, $x2, $y2, $x3, $y3) = $segment;
11630 $this->_outCurve($x1, $y1, $x2, $y2, $x3, $y3);
11631 }
11632 $this->_out($op);
11633 }
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 11862 of file tcpdf.php.
11862 {
11863 if ($this->state != 2) {
11864 return;
11865 }
11866 $nc = count($p); // number of coordinates
11867 $np = $nc / 2; // number of points
11868 if ($closed) {
11869 // close polygon by adding the first 2 points at the end (one line)
11870 for ($i = 0; $i < 4; ++$i) {
11871 $p[$nc + $i] = $p[$i];
11872 }
11873 // copy style for the last added line
11874 if (isset($line_style[0])) {
11875 $line_style[$np] = $line_style[0];
11876 }
11877 $nc += 4;
11878 }
11880 $this->SetFillColorArray($fill_color);
11881 }
11883 if ($op == 'f') {
11884 $line_style = array();
11885 }
11886 $draw = true;
11887 if ($line_style) {
11888 if (isset($line_style['all'])) {
11890 } else {
11891 $draw = false;
11892 if ($op == 'B') {
11893 // draw fill
11894 $op = 'f';
11895 $this->_outPoint($p[0], $p[1]);
11896 for ($i = 2; $i < $nc; $i = $i + 2) {
11897 $this->_outLine($p[$i], $p[$i + 1]);
11898 }
11899 $this->_out($op);
11900 }
11901 // draw outline
11902 $this->_outPoint($p[0], $p[1]);
11903 for ($i = 2; $i < $nc; $i = $i + 2) {
11904 $line_num = ($i / 2) - 1;
11905 if (isset($line_style[$line_num])) {
11906 if ($line_style[$line_num] != 0) {
11907 if (is_array($line_style[$line_num])) {
11909 $this->SetLineStyle($line_style[$line_num]);
11910 $this->_outPoint($p[$i - 2], $p[$i - 1]);
11911 $this->_outLine($p[$i], $p[$i + 1]);
11913 $this->_outPoint($p[$i], $p[$i + 1]);
11914 } else {
11915 $this->_outLine($p[$i], $p[$i + 1]);
11916 }
11917 }
11918 } else {
11919 $this->_outLine($p[$i], $p[$i + 1]);
11920 }
11921 }
11922 $this->_out($op);
11923 }
11924 }
11925 if ($draw) {
11926 $this->_outPoint($p[0], $p[1]);
11927 for ($i = 2; $i < $nc; $i = $i + 2) {
11928 $this->_outLine($p[$i], $p[$i + 1]);
11929 }
11930 $this->_out($op);
11931 }
11932 }
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 11843 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 22323 of file tcpdf.php.
22323 {
22324 if ($this->state != 2) {
22325 return;
22326 }
22327 if (!isset($this->xobjects[$id])) {
22329 }
22330 if ($this->inxobj) {
22331 if ($id == $this->xobjid) {
22332 // close current template
22333 $this->endTemplate();
22334 } else {
22335 // use the template as resource for the template currently opened
22337 }
22338 }
22339 // set default values
22342 }
22345 }
22346 // check page for no-write regions and adapt page margins if necessary
22348 $ow = $this->xobjects[$id]['w'];
22349 if ($ow <= 0) {
22350 $ow = 1;
22351 }
22352 $oh = $this->xobjects[$id]['h'];
22353 if ($oh <= 0) {
22354 $oh = 1;
22355 }
22356 // calculate template width and height on document
22358 $w = $ow;
22359 $h = $oh;
22360 } elseif ($w <= 0) {
22362 } elseif ($h <= 0) {
22364 }
22365 // fit the template on available space
22367 // set page alignment
22369 // set alignment
22370 if ($this->rtl) {
22371 if ($palign == 'L') {
22372 $xt = $this->lMargin;
22373 } elseif ($palign == 'C') {
22374 $xt = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
22375 } elseif ($palign == 'R') {
22376 $xt = $this->w - $this->rMargin - $w;
22377 } else {
22379 }
22380 $rb_x = $xt;
22381 } else {
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 {
22389 $xt = $x;
22390 }
22391 $rb_x = $xt + $w;
22392 }
22393 // print XObject Template + Transformation matrix
22394 $this->StartTransform();
22395 // translate and scale
22396 $sx = ($w / $ow);
22397 $sy = ($h / $oh);
22398 $tm = array();
22399 $tm[0] = $sx;
22400 $tm[1] = 0;
22401 $tm[2] = 0;
22402 $tm[3] = $sy;
22403 $tm[4] = $xt * $this->k;
22405 $this->Transform($tm);
22406 // set object
22408 $this->StopTransform();
22409 // add annotations
22410 if (!empty($this->xobjects[$id]['annotations'])) {
22411 foreach ($this->xobjects[$id]['annotations'] as $annot) {
22412 // transform original coordinates
22413 $coordlt = TCPDF_STATIC::getTransformationMatrixProduct($tm, array(1, 0, 0, 1, ($annot['x'] * $this->k), (-$annot['y'] * $this->k)));
22414 $ax = ($coordlt[4] / $this->k);
22416 $coordrb = TCPDF_STATIC::getTransformationMatrixProduct($tm, array(1, 0, 0, 1, (($annot['x'] + $annot['w']) * $this->k), ((-$annot['y'] - $annot['h']) * $this->k)));
22417 $aw = ($coordrb[4] / $this->k) - $ax;
22420 }
22421 }
22422 // set pointer to align the next text/objects
22423 switch($align) {
22424 case 'T': {
22425 $this->y = $y;
22426 $this->x = $rb_x;
22427 break;
22428 }
22429 case 'M': {
22431 $this->x = $rb_x;
22432 break;
22433 }
22434 case 'B': {
22435 $this->y = $rb_y;
22436 $this->x = $rb_x;
22437 break;
22438 }
22439 case 'N': {
22440 $this->SetY($rb_y);
22441 break;
22442 }
22443 default:{
22444 break;
22445 }
22446 }
22447 }
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 20332 of file tcpdf.php.
20332 {
20333 if ($this->state != 2) {
20334 return;
20335 }
20337 $fill = '';
20339 $color = $this->fgcolor;
20341 $width = 0;
20342 $textitem = '';
20343 $tmpx = $this->x;
20345 if ($listtype == '^') {
20346 // special symbol used for avoid justification of rect bullet
20347 $this->lispacer = '';
20348 return;
20349 } elseif ($listtype == '!') {
20350 // set default list type for unordered list
20351 $deftypes = array('disc', 'circle', 'square');
20352 $listtype = $deftypes[($listdepth - 1) % 3];
20353 } elseif ($listtype == '#') {
20354 // set default list type for ordered list
20355 $listtype = 'decimal';
20356 } elseif (substr($listtype, 0, 4) == 'img|') {
20357 // custom image type ('img|type|width|height|image.ext')
20359 $listtype = 'img';
20360 }
20361 switch ($listtype) {
20362 // unordered types
20363 case 'none': {
20364 break;
20365 }
20366 case 'disc': {
20368 $lspace += (2 * $r);
20369 if ($this->rtl) {
20370 $this->x += $lspace;
20371 } else {
20372 $this->x -= $lspace;
20373 }
20374 $this->Circle(($this->x + $r), ($this->y + ($this->lasth / 2)), $r, 0, 360, 'F', array(), $color, 8);
20375 break;
20376 }
20377 case 'circle': {
20379 $lspace += (2 * $r);
20380 if ($this->rtl) {
20381 $this->x += $lspace;
20382 } else {
20383 $this->x -= $lspace;
20384 }
20385 $prev_line_style = $this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor;
20386 $new_line_style = array('width' => ($r / 3), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'phase' => 0, 'color'=>$color);
20387 $this->Circle(($this->x + $r), ($this->y + ($this->lasth / 2)), ($r * (1 - (1/6))), 0, 360, 'D', $new_line_style, array(), 8);
20389 break;
20390 }
20391 case 'square': {
20393 $lspace += $l;
20394 if ($this->rtl) {;
20395 $this->x += $lspace;
20396 } else {
20397 $this->x -= $lspace;
20398 }
20400 break;
20401 }
20402 case 'img': {
20403 // 1=>type, 2=>width, 3=>height, 4=>image.ext
20404 $lspace += $img[2];
20405 if ($this->rtl) {;
20406 $this->x += $lspace;
20407 } else {
20408 $this->x -= $lspace;
20409 }
20410 $imgtype = strtolower($img[1]);
20411 $prev_y = $this->y;
20412 switch ($imgtype) {
20413 case 'svg': {
20414 $this->ImageSVG($img[4], $this->x, ($this->y + (($this->lasth - $img[3]) / 2)), $img[2], $img[3], '', 'T', '', 0, false);
20415 break;
20416 }
20417 case 'ai':
20418 case 'eps': {
20419 $this->ImageEps($img[4], $this->x, ($this->y + (($this->lasth - $img[3]) / 2)), $img[2], $img[3], '', true, 'T', '', 0, false);
20420 break;
20421 }
20422 default: {
20423 $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);
20424 break;
20425 }
20426 }
20427 $this->y = $prev_y;
20428 break;
20429 }
20430 // ordered types
20431 // $this->listcount[$this->listnum];
20432 // $textitem
20433 case '1':
20434 case 'decimal': {
20435 $textitem = $this->listcount[$this->listnum];
20436 break;
20437 }
20438 case 'decimal-leading-zero': {
20439 $textitem = sprintf('%02d', $this->listcount[$this->listnum]);
20440 break;
20441 }
20442 case 'i':
20443 case 'lower-roman': {
20444 $textitem = strtolower(TCPDF_STATIC::intToRoman($this->listcount[$this->listnum]));
20445 break;
20446 }
20447 case 'I':
20448 case 'upper-roman': {
20449 $textitem = TCPDF_STATIC::intToRoman($this->listcount[$this->listnum]);
20450 break;
20451 }
20452 case 'a':
20453 case 'lower-alpha':
20454 case 'lower-latin': {
20455 $textitem = chr(97 + $this->listcount[$this->listnum] - 1);
20456 break;
20457 }
20458 case 'A':
20459 case 'upper-alpha':
20460 case 'upper-latin': {
20461 $textitem = chr(65 + $this->listcount[$this->listnum] - 1);
20462 break;
20463 }
20464 case 'lower-greek': {
20465 $textitem = TCPDF_FONTS::unichr((945 + $this->listcount[$this->listnum] - 1), $this->isunicode);
20466 break;
20467 }
20468 /*
20469 // Types to be implemented (special handling)
20470 case 'hebrew': {
20471 break;
20472 }
20473 case 'armenian': {
20474 break;
20475 }
20476 case 'georgian': {
20477 break;
20478 }
20479 case 'cjk-ideographic': {
20480 break;
20481 }
20482 case 'hiragana': {
20483 break;
20484 }
20485 case 'katakana': {
20486 break;
20487 }
20488 case 'hiragana-iroha': {
20489 break;
20490 }
20491 case 'katakana-iroha': {
20492 break;
20493 }
20494 */
20495 default: {
20496 $textitem = $this->listcount[$this->listnum];
20497 }
20498 }
20500 // Check whether we need a new page or new column
20501 $prev_y = $this->y;
20504 $tmpx = $this->x;
20505 }
20506 // print ordered item
20507 if ($this->rtl) {
20508 $textitem = '.'.$textitem;
20509 } else {
20510 $textitem = $textitem.'.';
20511 }
20512 $lspace += $this->GetStringWidth($textitem);
20513 if ($this->rtl) {
20514 $this->x += $lspace;
20515 } else {
20516 $this->x -= $lspace;
20517 }
20519 }
20520 $this->x = $tmpx;
20521 $this->lispacer = '^';
20522 // restore colors
20525 $this->SettextColorArray($color);
20526 }
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:11825
References $h, $img, $l, $r, $size, $x, $y, TCPDF_STATIC\empty_string(), TCPDF_STATIC\intToRoman(), and TCPDF_FONTS\unichr().
Referenced by writeHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 14329 of file tcpdf.php.
14329 {
14331 $this->Gradient(3, $coords, array(array('color' => $col1, 'offset' => 0, 'exponent' => 1), array('color' => $col2, 'offset' => 1, 'exponent' => 1)), array(), false);
14332 }
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 12767 of file tcpdf.php.
12767 {
12770 }
12773 }
12774 // check page for no-write regions and adapt page margins if necessary
12778 return;
12779 }
12781 $onvalue = 'On';
12782 }
12783 if ($checked) {
12784 $defval = $onvalue;
12785 } else {
12786 $defval = 'Off';
12787 }
12788 // set font
12789 $font = 'zapfdingbats';
12790 if ($this->pdfa_mode) {
12791 // all fonts must be embedded
12792 $font = 'pdfa'.$font;
12793 }
12794 $this->AddFont($font);
12795 $tmpfont = $this->getFontBuffer($font);
12796 // set data for parent group
12797 if (!isset($this->radiobutton_groups[$this->page])) {
12798 $this->radiobutton_groups[$this->page] = array();
12799 }
12800 if (!isset($this->radiobutton_groups[$this->page][$name])) {
12801 $this->radiobutton_groups[$this->page][$name] = array();
12802 ++$this->n;
12804 $this->radio_groups[] = $this->n;
12805 }
12806 $kid = ($this->n + 1);
12807 // save object ID to be added on Kids entry on parent object
12809 // get default style
12810 $prop = array_merge($this->getFormDefaultProp(), $prop);
12811 $prop['NoToggleToOff'] = 'true';
12812 $prop['Radio'] = 'true';
12813 $prop['borderStyle'] = 'inset';
12814 // get annotation data
12815 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12816 // set additional default options
12817 $this->annotation_fonts[$tmpfont['fontkey']] = $tmpfont['i'];
12818 $fontstyle = sprintf('/F%d %F Tf %s', $tmpfont['i'], $this->FontSizePt, $this->TextColor);
12819 $popt['da'] = $fontstyle;
12820 // build appearance stream
12821 $popt['ap'] = array();
12822 $popt['ap']['n'] = array();
12824 $fy = (($w - ((($tmpfont['desc']['Ascent'] - $tmpfont['desc']['Descent']) * $this->FontSizePt / 1000) / $this->k)) * $this->k);
12825 $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);
12826 $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);
12827 if (!isset($popt['mk'])) {
12828 $popt['mk'] = array();
12829 }
12830 $popt['mk']['ca'] = '(l)';
12831 // merge options
12832 $opt = array_merge($popt, $opt);
12833 // set remaining annotation data
12834 $opt['Subtype'] = 'Widget';
12835 $opt['ft'] = 'Btn';
12836 if ($checked) {
12837 $opt['v'] = array('/'.$onvalue);
12838 $opt['as'] = $onvalue;
12839 } else {
12840 $opt['as'] = 'Off';
12841 }
12842 // store readonly flag
12843 if (!isset($this->radiobutton_groups[$this->page][$name]['#readonly#'])) {
12845 }
12848 if ($this->rtl) {
12849 $this->x -= $w;
12850 } else {
12851 $this->x += $w;
12852 }
12853 }
References $js, $k, $n, $page, $w, $x, $y, _addfield(), AddFont(), Annotation(), checkPageRegions(), TCPDF_STATIC\empty_string(), getAbsFontMeasure(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFontBuffer(), and getFormDefaultProp().
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 11512 of file tcpdf.php.
11512 {
11513 if ($this->state != 2) {
11514 return;
11515 }
11518 }
11520 // set background color
11521 $this->SetFillColorArray($fill_color);
11522 }
11525 //set global style for border
11527 $border_style = array();
11528 } else {
11529 // remove stroke operator from style
11530 $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*' );
11533 }
11534 }
11535 }
11539 }
11541 $border_style2 = array();
11543 $length = strlen($line);
11544 for ($i = 0; $i < $length; ++$i) {
11545 $border_style2[$line[$i]] = $value;
11546 }
11547 }
11548 $border_style = $border_style2;
11551 }
11554 }
11557 }
11560 }
11561 }
11562 }
_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:11415
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 14240 of file tcpdf.php.
14240 {
14241 $line_style = array('width' => max((0.5 / $this->k),($r / 30)), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $cola);
14242 $this->SetFillColorArray($cola);
14246 if ($double) {
14247 $ri = $r * 0.5;
14248 $this->SetFillColorArray($colb);
14251 $this->SetFillColorArray($cola);
14255 }
14256 }
PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90)
Draw the sector of a circle.
Definition: tcpdf.php:14770
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 14267 of file tcpdf.php.
14267 {
14268 // line width
14269 $lw = max((0.5 / $this->k),($r / 8));
14270 // internal radius
14271 $ri = ($r * 0.6);
14272 // external radius
14273 $re = ($r * 1.3);
14274 // Cyan
14275 $this->SetFillColorArray(array(100,0,0,0));
14277 // Magenta
14278 $this->SetFillColorArray(array(0,100,0,0));
14280 // Yellow
14281 $this->SetFillColorArray(array(0,0,100,0));
14283 // Key - black
14284 $this->SetFillColorArray(array(0,0,0,100));
14286 // registration color
14287 $line_style = array('width' => $lw, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(100,100,100,100,'All'));
14289 // external circle
14291 // cross lines
14296 }
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 11963 of file tcpdf.php.
11963 {
11964 if (3 > $ns) {
11965 $ns = 3;
11966 }
11967 if ($draw_circle) {
11968 $this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
11969 }
11970 $p = array();
11971 for ($i = 0; $i < $ns; ++$i) {
11972 $a = $angle + ($i * 360 / $ns);
11973 $a_rad = deg2rad((float) $a);
11974 $p[] = $x0 + ($r * sin($a_rad));
11975 $p[] = $y0 + ($r * cos($a_rad));
11976 }
11978 }
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 22555 of file tcpdf.php.
22555 {
22556 if (isset($this->page_regions[$key])) {
22557 unset($this->page_regions[$key]);
22558 }
22559 }
◆ 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 7848 of file tcpdf.php.
7848 {
7849 foreach ($aliases as $type => $alias) {
7850 foreach ($alias as $a) {
7851 // find position of compensation factor
7852 $startnum = (strpos($a, ':') + 1);
7853 $a = substr($a, 0, $startnum);
7855 // end of alias
7857 // string to be replaced
7858 $aa = substr($page, $pos, ($endnum - $pos + 1));
7859 // get compensation factor
7860 $ratio = substr($page, ($pos + $startnum), ($endnum - $pos - $startnum));
7861 $ratio = preg_replace('/[^0-9\.]/', '', $ratio);
7862 $ratio = floatval($ratio);
7863 if ($type == 'u') {
7864 $chrdiff = floor(($diff + 12) * $ratio);
7865 $shift = str_repeat(' ', $chrdiff);
7867 } else {
7868 $chrdiff = floor(($diff + 11) * $ratio);
7869 $shift = str_repeat(' ', $chrdiff);
7870 }
7872 }
7873 }
7874 }
7876 }
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 21708 of file tcpdf.php.
21708 {
21709 $this->lMargin = $this->original_lMargin;
21710 $this->rMargin = $this->original_rMargin;
21711 $this->setEqualColumns();
21712 }
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 21652 of file tcpdf.php.
21652 {
21653 if (isset($this->objcopy)) {
21655 if ($self) {
21656 $objvars = get_object_vars($this->objcopy);
21657 foreach ($objvars as $key => $value) {
21658 $this->$key = $value;
21659 }
21660 }
21662 }
21663 return $this;
21664 }
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 11160 of file tcpdf.php.
11160 {
11163 }
11166 }
11169 //calculate elements of transformation matrix
11170 $tm = array();
11171 $tm[0] = cos(deg2rad($angle));
11172 $tm[1] = sin(deg2rad($angle));
11173 $tm[2] = -$tm[1];
11174 $tm[3] = $tm[0];
11177 //rotate the coordinate system around ($x,$y)
11178 $this->Transform($tm);
11179 }
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 12053 of file tcpdf.php.
12053 {
12054 $this->RoundedRectXY($x, $y, $w, $h, $r, $r, $round_corner, $style, $border_style, $fill_color);
12055 }
RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array())
Draws a rounded rectangle.
Definition: tcpdf.php:12072
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 12072 of file tcpdf.php.
12072 {
12073 if ($this->state != 2) {
12074 return;
12075 }
12076 if (($round_corner == '0000') OR (($rx == $ry) AND ($rx == 0))) {
12077 // Not rounded
12079 return;
12080 }
12081 // Rounded
12083 $this->SetFillColorArray($fill_color);
12084 }
12086 if ($op == 'f') {
12087 $border_style = array();
12088 }
12091 }
12092 $MyArc = 4 / 3 * (sqrt(2) - 1);
12097 if ($round_corner[0]) {
12098 $this->_outCurve($xc + ($rx * $MyArc), $yc - $ry, $xc + $rx, $yc - ($ry * $MyArc), $xc + $rx, $yc);
12099 } else {
12101 }
12105 if ($round_corner[1]) {
12106 $this->_outCurve($xc + $rx, $yc + ($ry * $MyArc), $xc + ($rx * $MyArc), $yc + $ry, $xc, $yc + $ry);
12107 } else {
12109 }
12113 if ($round_corner[2]) {
12114 $this->_outCurve($xc - ($rx * $MyArc), $yc + $ry, $xc - $rx, $yc + ($ry * $MyArc), $xc - $rx, $yc);
12115 } else {
12117 }
12121 if ($round_corner[3]) {
12122 $this->_outCurve($xc - $rx, $yc - ($ry * $MyArc), $xc - ($rx * $MyArc), $yc - $ry, $xc, $yc - $ry);
12123 } else {
12126 }
12127 $this->_out($op);
12128 }
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 11034 of file tcpdf.php.
11034 {
11037 }
11040 }
11041 if (($s_x == 0) OR ($s_y == 0)) {
11043 }
11046 //calculate elements of transformation matrix
11047 $s_x /= 100;
11048 $s_y /= 100;
11049 $tm = array();
11050 $tm[0] = $s_x;
11051 $tm[1] = 0;
11052 $tm[2] = 0;
11053 $tm[3] = $s_y;
11054 $tm[4] = $x * (1 - $s_x);
11055 $tm[5] = $y * (1 - $s_y);
11056 //scale the coordinate system
11057 $this->Transform($tm);
11058 }
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 10994 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 11020 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 11007 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 24480 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 21735 of file tcpdf.php.
21735 {
21736 if (is_string($col)) {
21737 $col = $this->current_column;
21738 } elseif ($col >= $this->num_columns) {
21739 $col = 0;
21740 }
21741 $xshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
21742 $enable_thead = false;
21743 if ($this->num_columns > 1) {
21744 if ($col != $this->current_column) {
21745 // move Y pointer at the top of the column
21746 if ($this->column_start_page == $this->page) {
21747 $this->y = $this->columns[$col]['y'];
21748 } else {
21749 $this->y = $this->tMargin;
21750 }
21751 // Avoid to write table headers more than once
21752 if (($this->page > $this->maxselcol['page']) OR (($this->page == $this->maxselcol['page']) AND ($col > $this->maxselcol['column']))) {
21753 $enable_thead = true;
21755 $this->maxselcol['column'] = $col;
21756 }
21757 }
21758 $xshift = $this->colxshift;
21759 // set X position of the current column by case
21761 // calculate column X position
21762 $colpos = 0;
21763 for ($i = 0; $i < $col; ++$i) {
21764 $colpos += ($this->columns[$i]['w'] + $this->columns[$i]['s']);
21765 }
21766 if ($this->rtl) {
21767 $x = $this->w - $this->original_rMargin - $colpos;
21771 } else {
21772 $x = $this->original_lMargin + $colpos;
21776 }
21778 }
21779 $this->current_column = $col;
21780 // fix for HTML mode
21781 $this->newline = true;
21782 // print HTML table header (if any)
21784 if ($enable_thead) {
21785 // print table header
21787 $this->y += $xshift['s']['V'];
21788 // store end of header position
21789 if (!isset($this->columns[$col]['th'])) {
21790 $this->columns[$col]['th'] = array();
21791 }
21793 $this->lasth = 0;
21794 } elseif (isset($this->columns[$col]['th']['\''.$this->page.'\''])) {
21795 $this->y = $this->columns[$col]['th']['\''.$this->page.'\''];
21796 }
21797 }
21798 // account for an html table cell over multiple columns
21799 if ($this->rtl) {
21800 $this->rMargin += $xshift['x'];
21801 $this->x -= ($xshift['x'] + $xshift['p']['R']);
21802 } else {
21803 $this->lMargin += $xshift['x'];
21804 $this->x += $xshift['x'] + $xshift['p']['L'];
21805 }
21806 }
$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 17062 of file tcpdf.php.
17062 {
17063 $encoded = urlencode(json_encode($data));
17065 }
getHashForTCPDFtagParams($data)
Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance...
Definition: tcpdf.php:17052
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 7520 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 7543 of file tcpdf.php.
7543 {
7546 }
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 7531 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 13910 of file tcpdf.php.
13910 {
13911 if ($this->pdfa_mode) {
13912 // transparency is not allowed in PDF/A mode
13913 return;
13914 }
13915 $stroking = floatval($stroking);
13917 // default value if not set
13918 $nonstroking = $stroking;
13919 } else {
13920 $nonstroking = floatval($nonstroking);
13921 }
13922 if ($bm[0] == '/') {
13923 // remove trailing slash
13924 $bm = substr($bm, 1);
13925 }
13926 if (!in_array($bm, array('Normal', 'Multiply', 'Screen', 'Overlay', 'Darken', 'Lighten', 'ColorDodge', 'ColorBurn', 'HardLight', 'SoftLight', 'Difference', 'Exclusion', 'Hue', 'Saturation', 'Color', 'Luminosity'))) {
13927 $bm = 'Normal';
13928 }
13929 $ais = $ais ? true : false;
13930 $this->alpha = array('CA' => $stroking, 'ca' => $nonstroking, 'BM' => '/'.$bm, 'AIS' => $ais);
13931 $gs = $this->addExtGState($this->alpha);
13932 $this->setExtGState($gs);
13933 }
addExtGState($parms)
Add transparency parameters to the current extgstate.
Definition: tcpdf.php:13798
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 20162 of file tcpdf.php.
20162 {
20163 $this->booklet = $booklet;
20164 if ($inner >= 0) {
20165 $this->lMargin = $inner;
20166 }
20167 if ($outer >= 0) {
20168 $this->rMargin = $outer;
20169 }
20170 }
◆ 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 12286 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);
3912 $pdfcolor = sprintf('%F ', ($col1 / 255));
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);
3920 $pdfcolor = sprintf('%F %F %F ', ($col1 / 255), ($col2 / 255), ($col3 / 255));
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(), and setSpotColor().
Referenced by setColorArray(), SetDrawColor(), SetFillColor(), and SetTextColor().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 21721 of file tcpdf.php.
21721 {
21722 $this->columns = $columns;
21723 $this->num_columns = count($columns);
21724 $this->current_column = 0;
21725 $this->column_start_page = $this->page;
21726 $this->selectColumn(0);
21727 }
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 12207 of file tcpdf.php.
12207 {
12208 // remove unsupported characters
12209 $name = TCPDF_STATIC::encodeNameObject($name);
12211 return false;
12212 }
12215 } elseif ($y < 0) {
12216 $y = 0;
12217 } elseif ($y > $this->h) {
12219 }
12222 } elseif ($x < 0) {
12223 $x = 0;
12224 } elseif ($x > $this->w) {
12226 }
12227 $fixed = false;
12230 // this page number will not be changed when moving/add/deleting pages
12231 $fixed = true;
12232 }
12236 return;
12237 }
12238 }
12240 return $name;
12241 }
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 }
2820 $this->LayoutMode = TCPDF_STATIC::getPageLayoutMode($layout);
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 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 10183 of file tcpdf.php.
10183 {
10184 if (is_string($time)) {
10185 $time = TCPDF_STATIC::getTimestamp($time);
10186 }
10187 $this->doc_creation_timestamp = intval($time);
10188 }
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 10196 of file tcpdf.php.
10196 {
10197 if (is_string($time)) {
10198 $time = TCPDF_STATIC::getTimestamp($time);
10199 }
10200 $this->doc_modification_timestamp = intval($time);
10201 }
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 21676 of file tcpdf.php.
21676 {
21677 $this->columns = array();
21678 if ($numcols < 2) {
21679 $numcols = 0;
21680 $this->columns = array();
21681 } else {
21682 // maximum column width
21683 $maxwidth = ($this->w - $this->original_lMargin - $this->original_rMargin) / $numcols;
21684 if (($width == 0) OR ($width > $maxwidth)) {
21685 $width = $maxwidth;
21686 }
21689 }
21690 // space between columns
21691 $space = (($this->w - $this->original_lMargin - $this->original_rMargin - ($numcols * $width)) / ($numcols - 1));
21692 // fill the columns array (with, space, starting Y position)
21693 for ($i = 0; $i < $numcols; ++$i) {
21695 }
21696 }
21697 $this->num_columns = $numcols;
21698 $this->current_column = 0;
21699 $this->column_start_page = $this->page;
21700 $this->selectColumn(0);
21701 }
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 13829 of file tcpdf.php.
13829 {
13830 if ($this->pdfa_mode OR ($this->state != 2)) {
13831 // transparency is not allowed in PDF/A mode
13832 return;
13833 }
13835 }
References _out().
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 9503 of file tcpdf.php.
9503 {
9504 $this->custom_xmp = $xmp;
9505 }
◆ 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 20792 of file tcpdf.php.
20792 {
20793 $this->fonts[$font] = $data;
20794 if (!in_array($font, $this->fontkeys)) {
20795 $this->fontkeys[] = $font;
20796 // store object ID for current font
20797 ++$this->n;
20798 $this->font_obj_ids[$font] = $this->n;
20800 }
20801 }
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, and _out().
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 22478 of file tcpdf.php.
22478 {
22479 $this->font_spacing = $spacing;
22480 }
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 22456 of file tcpdf.php.
22456 {
22457 $this->font_stretching = $perc;
22458 }
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 20811 of file tcpdf.php.
20811 {
20812 if (!isset($this->fonts[$font])) {
20813 $this->setFontBuffer($font, array());
20814 }
20815 $this->fonts[$font][$key] = $data;
20816 }
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 22106 of file tcpdf.php.
22106 {
22107 if ($this->pdfa_mode) {
22108 $this->font_subsetting = false;
22109 } else {
22110 $this->font_subsetting = $enable ? true : false;
22111 }
22112 }
◆ 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 10323 of file tcpdf.php.
10323 {
10324 $this->footer_font = $font;
10325 }
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 20595 of file tcpdf.php.
20595 {
20596 if ($this->state != 2) {
20597 return;
20598 }
20599 $this->FontFamily = $gvars['FontFamily'];
20600 $this->FontStyle = $gvars['FontStyle'];
20601 $this->FontSizePt = $gvars['FontSizePt'];
20602 $this->rMargin = $gvars['rMargin'];
20603 $this->lMargin = $gvars['lMargin'];
20604 $this->cell_padding = $gvars['cell_padding'];
20605 $this->cell_margin = $gvars['cell_margin'];
20606 $this->LineWidth = $gvars['LineWidth'];
20607 $this->linestyleWidth = $gvars['linestyleWidth'];
20608 $this->linestyleCap = $gvars['linestyleCap'];
20609 $this->linestyleJoin = $gvars['linestyleJoin'];
20610 $this->linestyleDash = $gvars['linestyleDash'];
20611 $this->textrendermode = $gvars['textrendermode'];
20612 $this->textstrokewidth = $gvars['textstrokewidth'];
20613 $this->DrawColor = $gvars['DrawColor'];
20614 $this->FillColor = $gvars['FillColor'];
20615 $this->TextColor = $gvars['TextColor'];
20616 $this->ColorFlag = $gvars['ColorFlag'];
20617 $this->bgcolor = $gvars['bgcolor'];
20618 $this->fgcolor = $gvars['fgcolor'];
20619 $this->htmlvspace = $gvars['htmlvspace'];
20620 $this->listindent = $gvars['listindent'];
20621 $this->listindentlevel = $gvars['listindentlevel'];
20622 $this->listnum = $gvars['listnum'];
20623 $this->listordered = $gvars['listordered'];
20624 $this->listcount = $gvars['listcount'];
20625 $this->lispacer = $gvars['lispacer'];
20626 $this->cell_height_ratio = $gvars['cell_height_ratio'];
20627 $this->font_stretching = $gvars['font_stretching'];
20628 $this->font_spacing = $gvars['font_spacing'];
20629 $this->alpha = $gvars['alpha'];
20630 if ($extended) {
20631 // restore extended values
20632 $this->lasth = $gvars['lasth'];
20633 $this->tMargin = $gvars['tMargin'];
20634 $this->bMargin = $gvars['bMargin'];
20635 $this->AutoPageBreak = $gvars['AutoPageBreak'];
20636 $this->PageBreakTrigger = $gvars['PageBreakTrigger'];
20637 $this->x = $gvars['x'];
20638 $this->y = $gvars['y'];
20639 $this->w = $gvars['w'];
20640 $this->h = $gvars['h'];
20641 $this->wPt = $gvars['wPt'];
20642 $this->hPt = $gvars['hPt'];
20643 $this->fwPt = $gvars['fwPt'];
20644 $this->fhPt = $gvars['fhPt'];
20645 $this->page = $gvars['page'];
20646 $this->current_column = $gvars['current_column'];
20647 $this->num_columns = $gvars['num_columns'];
20648 }
20649 $this->_out(''.$this->linestyleWidth.' '.$this->linestyleCap.' '.$this->linestyleJoin.' '.$this->linestyleDash.' '.$this->DrawColor.' '.$this->FillColor.'');
20651 $this->SetFont($this->FontFamily, $this->FontStyle, $this->FontSizePt);
20652 }
20653 }
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 10303 of file tcpdf.php.
10303 {
10304 $this->header_font = $font;
10305 }
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 20233 of file tcpdf.php.
20233 {
20234 $this->htmlLinkColorArray = $color;
20235 $this->htmlLinkFontStyle = $fontstyle;
20236 }
◆ 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 20202 of file tcpdf.php.
20202 {
20203 $this->tagvspaces = $tagvs;
20204 }
◆ 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 20746 of file tcpdf.php.
20746 {
20748 $this->imagekeys[$this->numimages] = $image;
20750 ++$this->numimages;
20751 }
20752 $this->images[$image] = $data;
20754 }
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 20764 of file tcpdf.php.
20764 {
20765 if (!isset($this->images[$image])) {
20766 $this->setImageBuffer($image, array());
20767 }
20768 $this->images[$image][$key] = $data;
20769 }
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 13952 of file tcpdf.php.
13952 {
13953 if (($quality < 1) OR ($quality > 100)) {
13954 $quality = 75;
13955 }
13956 $this->jpeg_quality = intval($quality);
13957 }
◆ 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 10343 of file tcpdf.php.
10343 {
10344 $this->l = $language;
10345 if (isset($this->l['a_meta_dir'])) {
10346 $this->rtl = $this->l['a_meta_dir']=='rtl' ? true : false;
10347 } else {
10348 $this->rtl = false;
10349 }
10350 }
◆ 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 11323 of file tcpdf.php.
11323 {
11324 $s = ''; // string to be returned
11326 return;
11327 }
11331 $s .= $this->linestyleWidth.' ';
11332 }
11334 $ca = array('butt' => 0, 'round'=> 1, 'square' => 2);
11337 $s .= $this->linestyleCap.' ';
11338 }
11339 }
11341 $ja = array('miter' => 0, 'round' => 1, 'bevel' => 2);
11344 $s .= $this->linestyleJoin.' ';
11345 }
11346 }
11348 $dash_string = '';
11352 } else {
11354 }
11355 $dash_string = '';
11357 if ($i) {
11358 $dash_string .= ' ';
11359 }
11360 $dash_string .= sprintf('%F', $v);
11361 }
11362 }
11365 }
11367 $s .= $this->linestyleDash.' ';
11368 }
11371 }
11373 $this->_out($s);
11374 }
11375 return $s;
11376 }
References $ret, $style, $tab, _out(), and SetDrawColorArray().
Referenced by cropMark(), Curve(), Ellipse(), Footer(), getCellBorder(), Header(), Line(), Polycurve(), Polygon(), Rect(), and RoundedRectXY().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 11280 of file tcpdf.php.
11280 {
11281 //Set line width
11282 $this->LineWidth = $width;
11283 $this->linestyleWidth = sprintf('%F w', ($width * $this->k));
11284 if ($this->state == 2) {
11285 $this->_out($this->linestyleWidth);
11286 }
11287 }
References _out().
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 20139 of file tcpdf.php.
20139 {
20140 // check for custom image symbol
20141 if (substr($symbol, 0, 4) == 'img|') {
20142 $this->lisymbol = $symbol;
20143 return;
20144 }
20145 $symbol = strtolower($symbol);
20146 $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');
20147 if (in_array($symbol, $valid_symbols)) {
20148 $this->lisymbol = $symbol;
20149 } else {
20150 $this->lisymbol = '';
20151 }
20152 }
◆ 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 20222 of file tcpdf.php.
20222 {
20223 $this->opencell = $isopen;
20224 }
◆ 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 13871 of file tcpdf.php.
13871 {
13872 if ($this->state != 2) {
13873 return;
13874 }
13875 $stroking = $stroking ? true : false;
13877 // default value if not set
13878 $nonstroking = $stroking;
13879 } else {
13880 $nonstroking = $nonstroking ? true : false;
13881 }
13882 if (($mode != 0) AND ($mode != 1)) {
13883 $mode = 0;
13884 }
13885 $this->overprint = array('OP' => $stroking, 'op' => $nonstroking, 'OPM' => $mode);
13886 $gs = $this->addExtGState($this->overprint);
13887 $this->setExtGState($gs);
13888 }
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 7883 of file tcpdf.php.
7883 {
7884 $this->page_boxes = array();
7885 foreach ($boxes as $box) {
7887 $this->page_boxes[] = $box;
7888 }
7889 }
7890 }
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 20711 of file tcpdf.php.
20711 {
20712 if ($append) {
20714 } else {
20716 }
20719 } else {
20721 }
20722 }
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 22516 of file tcpdf.php.
22516 {
22517 // empty current regions array
22518 $this->page_regions = array();
22519 // add regions
22521 $this->addPageRegion($data);
22522 }
22523 }
◆ 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 13994 of file tcpdf.php.
13994 {
13995 if ($this->pdfa_mode) {
13996 // PDF/A mode
13997 $this->PDFVersion = '1.4';
13998 } else {
13999 $this->PDFVersion = $version;
14000 }
14001 }
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 10840 of file tcpdf.php.
10840 {
10841 if ($this->pdfa_mode) {
10842 // encryption is not allowed in PDF/A mode
10843 return;
10844 }
10846 if (($pubkeys !== null) AND (is_array($pubkeys))) {
10847 // public-key mode
10848 $this->encryptdata['pubkeys'] = $pubkeys;
10849 if ($mode == 0) {
10850 // public-Key Security requires at least 128 bit
10851 $mode = 1;
10852 }
10853 if (!function_exists('openssl_pkcs7_encrypt')) {
10855 }
10856 // Set Public-Key filter (available are: Entrust.PPKEF, Adobe.PPKLite, Adobe.PubSec)
10857 $this->encryptdata['pubkey'] = true;
10858 $this->encryptdata['Filter'] = 'Adobe.PubSec';
10859 $this->encryptdata['StmF'] = 'DefaultCryptFilter';
10860 $this->encryptdata['StrF'] = 'DefaultCryptFilter';
10861 } else {
10862 // standard mode (password mode)
10863 $this->encryptdata['pubkey'] = false;
10864 $this->encryptdata['Filter'] = 'Standard';
10865 $this->encryptdata['StmF'] = 'StdCF';
10866 $this->encryptdata['StrF'] = 'StdCF';
10867 }
10868 if ($mode > 1) { // AES
10869 if (!extension_loaded('openssl') && !extension_loaded('mcrypt')) {
10870 $this->Error('AES encryption requires openssl or mcrypt extension (http://www.php.net/manual/en/mcrypt.requirements.php).');
10871 }
10872 if (extension_loaded('openssl') && !in_array('aes-256-cbc', openssl_get_cipher_methods())) {
10874 }
10875 if (extension_loaded('mcrypt') && mcrypt_get_cipher_name(MCRYPT_RIJNDAEL_128) === false) {
10877 }
10878 if (($mode == 3) AND !function_exists('hash')) {
10879 // the Hash extension requires no external libraries and is enabled by default as of PHP 5.1.2.
10880 $this->Error('AES 256 encryption requires HASH Message Digest Framework (http://www.php.net/manual/en/book.hash.php).');
10881 }
10882 }
10883 if ($owner_pass === null) {
10884 $owner_pass = md5(TCPDF_STATIC::getRandomSeed());
10885 }
10886 $this->encryptdata['user_password'] = $user_pass;
10887 $this->encryptdata['owner_password'] = $owner_pass;
10888 $this->encryptdata['mode'] = $mode;
10889 switch ($mode) {
10890 case 0: { // RC4 40 bit
10891 $this->encryptdata['V'] = 1;
10892 $this->encryptdata['Length'] = 40;
10893 $this->encryptdata['CF']['CFM'] = 'V2';
10894 break;
10895 }
10896 case 1: { // RC4 128 bit
10897 $this->encryptdata['V'] = 2;
10898 $this->encryptdata['Length'] = 128;
10899 $this->encryptdata['CF']['CFM'] = 'V2';
10900 if ($this->encryptdata['pubkey']) {
10901 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s4';
10902 $this->encryptdata['Recipients'] = array();
10903 }
10904 break;
10905 }
10906 case 2: { // AES 128 bit
10907 $this->encryptdata['V'] = 4;
10908 $this->encryptdata['Length'] = 128;
10909 $this->encryptdata['CF']['CFM'] = 'AESV2';
10910 $this->encryptdata['CF']['Length'] = 128;
10911 if ($this->encryptdata['pubkey']) {
10912 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s5';
10913 $this->encryptdata['Recipients'] = array();
10914 }
10915 break;
10916 }
10917 case 3: { // AES 256 bit
10918 $this->encryptdata['V'] = 5;
10919 $this->encryptdata['Length'] = 256;
10920 $this->encryptdata['CF']['CFM'] = 'AESV3';
10921 $this->encryptdata['CF']['Length'] = 256;
10922 if ($this->encryptdata['pubkey']) {
10923 $this->encryptdata['SubFilter'] = 'adbe.pkcs7.s5';
10924 $this->encryptdata['Recipients'] = array();
10925 }
10926 break;
10927 }
10928 }
10929 $this->encrypted = true;
10931 $this->_generateencryptionkey();
10932 }
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 13415 of file tcpdf.php.
13415 {
13416 // to create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
13417 // to export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
13418 // to convert pfx certificate to pem: openssl
13419 // OpenSSL> pkcs12 -in <cert.pfx> -out <cert.crt> -nodes
13420 $this->sign = true;
13421 ++$this->n;
13424 $this->signature_data = array();
13425 if (strlen($signing_cert) == 0) {
13427 }
13428 if (strlen($private_key) == 0) {
13429 $private_key = $signing_cert;
13430 }
13431 $this->signature_data['signcert'] = $signing_cert;
13432 $this->signature_data['privkey'] = $private_key;
13433 $this->signature_data['password'] = $private_key_password;
13434 $this->signature_data['extracerts'] = $extracerts;
13435 $this->signature_data['cert_type'] = $cert_type;
13437 $this->signature_data['approval'] = $approval;
13438 }
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 13452 of file tcpdf.php.
13452 {
13453 $this->signature_appearance = $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
13454 }
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);
3738 $pdfcolor = sprintf('/CS%d ', $this->spot_colors[$name]['i']);
3739 switch ($type) {
3740 case 'draw': {
3741 $pdfcolor .= sprintf('CS %F SCN', $tint);
3742 $this->DrawColor = $pdfcolor;
3743 $this->strokecolor = $spotcolor;
3744 break;
3745 }
3746 case 'fill': {
3747 $pdfcolor .= sprintf('cs %F scn', $tint);
3748 $this->FillColor = $pdfcolor;
3749 $this->bgcolor = $spotcolor;
3750 break;
3751 }
3752 case 'text': {
3753 $pdfcolor .= sprintf('cs %F scn', $tint);
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(), and TCPDF_COLORS\getSpotColor().
Referenced by setColor(), SetDrawSpotColor(), SetFillSpotColor(), and SetTextSpotColor().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 23036 of file tcpdf.php.
23036 {
23037 if ($this->state != 2) {
23038 return;
23039 }
23040 $objstyle = '';
23042 if (!isset($svgstyle['opacity'])) {
23043 return $objstyle;
23044 }
23045 // clip-path
23046 $regs = array();
23047 if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['clip-path'], $regs)) {
23048 $clip_path = $this->svgclippaths[$regs[1]];
23049 foreach ($clip_path as $cp) {
23051 }
23052 }
23053 // opacity
23054 if ($svgstyle['opacity'] != 1) {
23056 }
23057 // color
23059 $this->SetFillColorArray($fill_color);
23060 // text color
23061 $text_color = TCPDF_COLORS::convertHTMLColorToDec($svgstyle['text-color'], $this->spot_colors);
23062 $this->SetTextColorArray($text_color);
23063 // clip
23064 if (preg_match('/rect\(([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)[\s]*([a-z0-9\-\.]*)\)/si', $svgstyle['clip'], $regs)) {
23069 $cx = $x + $left;
23070 $cy = $y + $top;
23071 $cw = $w - $left - $right;
23072 $ch = $h - $top - $bottom;
23073 if ($svgstyle['clip-rule'] == 'evenodd') {
23074 $clip_rule = 'CNZ';
23075 } else {
23076 $clip_rule = 'CEO';
23077 }
23078 $this->Rect($cx, $cy, $cw, $ch, $clip_rule, array(), array());
23079 }
23080 // fill
23081 $regs = array();
23082 if (preg_match('/url\([\s]*\#([^\)]*)\)/si', $svgstyle['fill'], $regs)) {
23083 // gradient
23084 $gradient = $this->svggradients[$regs[1]];
23085 if (isset($gradient['xref'])) {
23086 // reference to another gradient definition
23087 $newgradient = $this->svggradients[$gradient['xref']];
23088 $newgradient['coords'] = $gradient['coords'];
23089 $newgradient['mode'] = $gradient['mode'];
23090 $newgradient['type'] = $gradient['type'];
23091 $newgradient['gradientUnits'] = $gradient['gradientUnits'];
23092 if (isset($gradient['gradientTransform'])) {
23093 $newgradient['gradientTransform'] = $gradient['gradientTransform'];
23094 }
23095 $gradient = $newgradient;
23096 }
23097 //save current Graphic State
23098 $this->_outSaveGraphicsState();
23099 //set clipping area
23100 if (!empty($clip_function) AND method_exists($this, $clip_function)) {
23101 $bbox = call_user_func_array(array($this, $clip_function), $clip_params);
23102 if ((!isset($gradient['type']) OR ($gradient['type'] != 3)) AND is_array($bbox) AND (count($bbox) == 4)) {
23104 }
23105 }
23106 if ($gradient['mode'] == 'measure') {
23107 if (!isset($gradient['coords'][4])) {
23108 $gradient['coords'][4] = 0.5;
23109 }
23110 if (isset($gradient['gradientTransform']) AND !empty($gradient['gradientTransform'])) {
23111 $gtm = $gradient['gradientTransform'];
23112 // apply transformation matrix
23113 $xa = ($gtm[0] * $gradient['coords'][0]) + ($gtm[2] * $gradient['coords'][1]) + $gtm[4];
23114 $ya = ($gtm[1] * $gradient['coords'][0]) + ($gtm[3] * $gradient['coords'][1]) + $gtm[5];
23115 $xb = ($gtm[0] * $gradient['coords'][2]) + ($gtm[2] * $gradient['coords'][3]) + $gtm[4];
23116 $yb = ($gtm[1] * $gradient['coords'][2]) + ($gtm[3] * $gradient['coords'][3]) + $gtm[5];
23117 $r = sqrt(pow(($gtm[0] * $gradient['coords'][4]), 2) + pow(($gtm[1] * $gradient['coords'][4]), 2));
23118 $gradient['coords'][0] = $xa;
23119 $gradient['coords'][1] = $ya;
23120 $gradient['coords'][2] = $xb;
23121 $gradient['coords'][3] = $yb;
23123 }
23124 // convert SVG coordinates to user units
23125 $gradient['coords'][0] = $this->getHTMLUnitToUnits($gradient['coords'][0], 0, $this->svgunit, false);
23126 $gradient['coords'][1] = $this->getHTMLUnitToUnits($gradient['coords'][1], 0, $this->svgunit, false);
23127 $gradient['coords'][2] = $this->getHTMLUnitToUnits($gradient['coords'][2], 0, $this->svgunit, false);
23128 $gradient['coords'][3] = $this->getHTMLUnitToUnits($gradient['coords'][3], 0, $this->svgunit, false);
23129 $gradient['coords'][4] = $this->getHTMLUnitToUnits($gradient['coords'][4], 0, $this->svgunit, false);
23131 $w = $minlen;
23132 }
23134 $h = $minlen;
23135 }
23136 // shift units
23137 if ($gradient['gradientUnits'] == 'objectBoundingBox') {
23138 // convert to SVG coordinate system
23143 }
23144 // calculate percentages
23150 } elseif ($gradient['mode'] == 'percentage') {
23151 foreach($gradient['coords'] as $key => $val) {
23152 $gradient['coords'][$key] = (intval($val) / 100);
23153 if ($val < 0) {
23154 $gradient['coords'][$key] = 0;
23155 } elseif ($val > 1) {
23156 $gradient['coords'][$key] = 1;
23157 }
23158 }
23159 }
23160 if (($gradient['type'] == 2) AND ($gradient['coords'][0] == $gradient['coords'][2]) AND ($gradient['coords'][1] == $gradient['coords'][3])) {
23161 // single color (no shading)
23162 $gradient['coords'][0] = 1;
23163 $gradient['coords'][1] = 0;
23164 $gradient['coords'][2] = 0.999;
23165 $gradient['coords'][3] = 0;
23166 }
23167 // swap Y coordinates
23168 $tmp = $gradient['coords'][1];
23169 $gradient['coords'][1] = $gradient['coords'][3];
23170 $gradient['coords'][3] = $tmp;
23171 // set transformation map for gradient
23172 $cy = ($this->h - $y);
23173 if ($gradient['type'] == 3) {
23174 // circular gradient
23177 } else {
23178 $cy -= $h;
23179 }
23180 $this->_out(sprintf('%F 0 0 %F %F %F cm', ($w * $this->k), ($h * $this->k), ($x * $this->k), ($cy * $this->k)));
23181 if (count($gradient['stops']) > 1) {
23183 }
23184 } elseif ($svgstyle['fill'] != 'none') {
23186 if ($svgstyle['fill-opacity'] != 1) {
23188 }
23189 $this->SetFillColorArray($fill_color);
23190 if ($svgstyle['fill-rule'] == 'evenodd') {
23191 $objstyle .= 'F*';
23192 } else {
23193 $objstyle .= 'F';
23194 }
23195 }
23196 // stroke
23197 if ($svgstyle['stroke'] != 'none') {
23198 if ($svgstyle['stroke-opacity'] != 1) {
23200 } elseif (preg_match('/rgba\(\d+%?,\s*\d+%?,\s*\d+%?,\s*(\d+(?:\.\d+)?)\)/i', $svgstyle['stroke'], $rgba_matches)) {
23202 }
23203 $stroke_style = array(
23206 'cap' => $svgstyle['stroke-linecap'],
23207 'join' => $svgstyle['stroke-linejoin']
23208 );
23209 if (isset($svgstyle['stroke-dasharray']) AND !empty($svgstyle['stroke-dasharray']) AND ($svgstyle['stroke-dasharray'] != 'none')) {
23210 $stroke_style['dash'] = $svgstyle['stroke-dasharray'];
23211 }
23212 $this->SetLineStyle($stroke_style);
23213 $objstyle .= 'D';
23214 }
23215 // font
23216 $regs = array();
23217 if (!empty($svgstyle['font'])) {
23218 if (preg_match('/font-family[\s]*:[\s]*([^\;\"]*)/si', $svgstyle['font'], $regs)) {
23219 $font_family = $this->getFontFamilyName($regs[1]);
23220 } else {
23221 $font_family = $svgstyle['font-family'];
23222 }
23223 if (preg_match('/font-size[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23224 $font_size = trim($regs[1]);
23225 } else {
23226 $font_size = $svgstyle['font-size'];
23227 }
23228 if (preg_match('/font-style[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23229 $font_style = trim($regs[1]);
23230 } else {
23231 $font_style = $svgstyle['font-style'];
23232 }
23233 if (preg_match('/font-weight[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23234 $font_weight = trim($regs[1]);
23235 } else {
23236 $font_weight = $svgstyle['font-weight'];
23237 }
23238 if (preg_match('/font-stretch[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23239 $font_stretch = trim($regs[1]);
23240 } else {
23241 $font_stretch = $svgstyle['font-stretch'];
23242 }
23243 if (preg_match('/letter-spacing[\s]*:[\s]*([^\s\;\"]*)/si', $svgstyle['font'], $regs)) {
23244 $font_spacing = trim($regs[1]);
23245 } else {
23247 }
23248 } else {
23250 $font_size = $svgstyle['font-size'];
23251 $font_style = $svgstyle['font-style'];
23252 $font_weight = $svgstyle['font-weight'];
23253 $font_stretch = $svgstyle['font-stretch'];
23255 }
23256 $font_size = $this->getHTMLFontUnits($font_size, $this->svgstyles[0]['font-size'], $prevsvgstyle['font-size'], $this->svgunit);
23259 switch ($font_style) {
23260 case 'italic': {
23261 $font_style = 'I';
23262 break;
23263 }
23264 case 'oblique': {
23265 $font_style = 'I';
23266 break;
23267 }
23268 default:
23269 case 'normal': {
23270 $font_style = '';
23271 break;
23272 }
23273 }
23274 switch ($font_weight) {
23275 case 'bold':
23276 case 'bolder': {
23277 $font_style .= 'B';
23278 break;
23279 }
23280 case 'normal': {
23281 if ((substr($font_family, -1) == 'I') AND (substr($font_family, -2, 1) == 'B')) {
23282 $font_family = substr($font_family, 0, -2).'I';
23283 } elseif (substr($font_family, -1) == 'B') {
23284 $font_family = substr($font_family, 0, -1);
23285 }
23286 break;
23287 }
23288 }
23289 switch ($svgstyle['text-decoration']) {
23290 case 'underline': {
23291 $font_style .= 'U';
23292 break;
23293 }
23294 case 'overline': {
23295 $font_style .= 'O';
23296 break;
23297 }
23298 case 'line-through': {
23299 $font_style .= 'D';
23300 break;
23301 }
23302 default:
23303 case 'none': {
23304 break;
23305 }
23306 }
23307 $this->SetFont($font_family, $font_style, $font_size);
23308 $this->setFontStretching($font_stretch);
23310 return $objstyle;
23311 }
startSVGElementHandler($parser, $name, $attribs, $ctm=array())
Sets the opening SVG element handler function for the XML parser.
Definition: tcpdf.php:23706
setFontSpacing($spacing=0)
Set the amount to increase or decrease the space between characters in a text.
Definition: tcpdf.php:22478
References $h, $r, $w, $x, $y, and TCPDF_COLORS\convertHTMLColorToDec().
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 21836 of file tcpdf.php.
21836 {
21837 // Ref.: PDF 32000-1:2008 - 9.3.6 Text Rendering Mode
21838 // convert text rendering parameters
21839 if ($stroke < 0) {
21840 $stroke = 0;
21841 }
21842 if ($fill === true) {
21843 if ($stroke > 0) {
21844 if ($clip === true) {
21845 // Fill, then stroke text and add to path for clipping
21846 $textrendermode = 6;
21847 } else {
21848 // Fill, then stroke text
21849 $textrendermode = 2;
21850 }
21851 $textstrokewidth = $stroke;
21852 } else {
21853 if ($clip === true) {
21854 // Fill text and add to path for clipping
21855 $textrendermode = 4;
21856 } else {
21857 // Fill text
21858 $textrendermode = 0;
21859 }
21860 }
21861 } else {
21862 if ($stroke > 0) {
21863 if ($clip === true) {
21864 // Stroke text and add to path for clipping
21865 $textrendermode = 5;
21866 } else {
21867 // Stroke text
21868 $textrendermode = 1;
21869 }
21870 $textstrokewidth = $stroke;
21871 } else {
21872 if ($clip === true) {
21873 // Add text to path for clipping
21874 $textrendermode = 7;
21875 } else {
21876 // Neither fill nor stroke text (invisible)
21877 $textrendermode = 3;
21878 }
21879 }
21880 }
21881 $this->textrendermode = $textrendermode;
21882 $this->textstrokewidth = $stroke;
21883 }
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 21891 of file tcpdf.php.
21891 {
21894 } else {
21895 $this->txtshadow['enabled'] = false;
21896 }
21899 } else {
21900 $this->txtshadow['depth_w'] = 0;
21901 }
21904 } else {
21905 $this->txtshadow['depth_h'] = 0;
21906 }
21907 if (isset($params['color']) AND ($params['color'] !== false) AND is_array($params['color'])) {
21909 } else {
21911 }
21914 } else {
21915 $this->txtshadow['opacity'] = 1;
21916 }
21917 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'))) {
21919 } else {
21920 $this->txtshadow['blend_mode'] = 'Normal';
21921 }
21922 if ((($this->txtshadow['depth_w'] == 0) AND ($this->txtshadow['depth_h'] == 0)) OR ($this->txtshadow['opacity'] == 0)) {
21923 $this->txtshadow['enabled'] = false;
21924 }
21925 }
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 13518 of file tcpdf.php.
13518 {
13519 $this->tsa_data = array();
13520 if (!function_exists('curl_init')) {
13522 }
13523 if (strlen($tsa_host) == 0) {
13525 }
13526 $this->tsa_data['tsa_host'] = $tsa_host;
13527 if (is_file($tsa_username)) {
13528 $this->tsa_data['tsa_auth'] = $tsa_username;
13529 } else {
13530 $this->tsa_data['tsa_username'] = $tsa_username;
13531 }
13532 $this->tsa_data['tsa_password'] = $tsa_password;
13533 $this->tsa_data['tsa_cert'] = $tsa_cert;
13534 $this->tsa_timestamp = true;
13535 }
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 13378 of file tcpdf.php.
13385 {
13386 $this->ur['enabled'] = $enable;
13387 $this->ur['document'] = $document;
13388 $this->ur['annots'] = $annots;
13389 $this->ur['form'] = $form;
13390 $this->ur['signature'] = $signature;
13391 $this->ur['ef'] = $ef;
13392 $this->ur['formex'] = $formex;
13393 if (!$this->sign) {
13395 }
13396 }
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:13415
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 14012 of file tcpdf.php.
14012 {
14013 $this->viewer_preferences = $preferences;
14014 }
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 13765 of file tcpdf.php.
13765 {
13766 if ($this->state != 2) {
13767 return;
13768 }
13769 $this->endLayer();
13770 switch($v) {
13771 case 'print': {
13773 break;
13774 }
13775 case 'view':
13776 case 'screen': {
13778 break;
13779 }
13780 case 'all': {
13782 break;
13783 }
13784 default: {
13786 break;
13787 }
13788 }
13789 }
startLayer($name='', $print=true, $view=true, $lock=true)
Start a new pdf layer.
Definition: tcpdf.php:13726
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 7442 of file tcpdf.php.
7442 {
7444 if (!$rtloff AND $this->rtl) {
7446 $this->x = $this->w - $x;
7447 } else {
7448 $this->x = abs($x);
7449 }
7450 } else {
7452 $this->x = $x;
7453 } else {
7454 $this->x = $this->w + $x;
7455 }
7456 }
7457 if ($this->x < 0) {
7458 $this->x = 0;
7459 }
7460 if ($this->x > $this->w) {
7461 $this->x = $this->w;
7462 }
7463 }
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 7508 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 7475 of file tcpdf.php.
7475 {
7477 if ($resetx) {
7478 //reset x
7479 if (!$rtloff AND $this->rtl) {
7480 $this->x = $this->w - $this->rMargin;
7481 } else {
7482 $this->x = $this->lMargin;
7483 }
7484 }
7486 $this->y = $y;
7487 } else {
7488 $this->y = $this->h + $y;
7489 }
7490 if ($this->y < 0) {
7491 $this->y = 0;
7492 }
7493 if ($this->y > $this->h) {
7494 $this->y = $this->h;
7495 }
7496 }
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 11217 of file tcpdf.php.
11217 {
11220 }
11223 }
11224 if (($angle_x <= -90) OR ($angle_x >= 90) OR ($angle_y <= -90) OR ($angle_y >= 90)) {
11226 }
11229 //calculate elements of transformation matrix
11230 $tm = array();
11231 $tm[0] = 1;
11232 $tm[1] = tan(deg2rad($angle_y));
11233 $tm[2] = tan(deg2rad($angle_x));
11234 $tm[3] = 1;
11235 $tm[4] = -$tm[2] * $y;
11236 $tm[5] = -$tm[1] * $x;
11237 //skew the coordinate system
11238 $this->Transform($tm);
11239 }
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 11190 of file tcpdf.php.
11190 {
11192 }
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 11203 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 12350 of file tcpdf.php.
12350 {
12351 // get sorting columns
12352 $outline_p = array();
12353 $outline_y = array();
12356 $outline_k[$key] = $key;
12357 }
12358 // sort outlines by page and original position
12359 array_multisort($outline_p, SORT_NUMERIC, SORT_ASC, $outline_k, SORT_NUMERIC, SORT_ASC, $this->outlines);
12360 }
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 12011 of file tcpdf.php.
12011 {
12012 if ($nv < 2) {
12013 $nv = 2;
12014 }
12015 if ($draw_circle) {
12016 $this->Circle($x0, $y0, $r, 0, 360, $circle_style, $circle_outLine_style, $circle_fill_color);
12017 }
12018 $p2 = array();
12019 $visited = array();
12020 for ($i = 0; $i < $nv; ++$i) {
12021 $a = $angle + ($i * 360 / $nv);
12022 $a_rad = deg2rad((float) $a);
12023 $p2[] = $x0 + ($r * sin($a_rad));
12024 $p2[] = $y0 + ($r * cos($a_rad));
12025 $visited[] = false;
12026 }
12027 $p = array();
12028 $i = 0;
12029 do {
12030 $p[] = $p2[$i * 2];
12031 $p[] = $p2[($i * 2) + 1];
12032 $visited[$i] = true;
12033 $i += $ng;
12034 $i %= $nv;
12035 } while (!$visited[$i]);
12037 }
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 13726 of file tcpdf.php.
13726 {
13727 if ($this->state != 2) {
13728 return;
13729 }
13730 $layer = sprintf('LYR%03d', (count($this->pdflayers) + 1));
13731 if (empty($name)) {
13732 $name = $layer;
13733 } else {
13734 $name = preg_replace('/[^a-zA-Z0-9_\-]/', '', $name);
13735 }
13736 $this->pdflayers[] = array('layer' => $layer, 'name' => $name, 'print' => $print, 'view' => $view, 'lock' => $lock);
13737 $this->openMarkedContent = true;
13739 }
References _out().
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 13561 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 23706 of file tcpdf.php.
23706 {
23707 $name = $this->removeTagNamespace($name);
23708 // check if we are in clip mode
23709 if ($this->svgclipmode) {
23710 $this->svgclippaths[$this->svgclipid][] = array('name' => $name, 'attribs' => $attribs, 'tm' => $this->svgcliptm[$this->svgclipid]);
23711 return;
23712 }
23713 if ($this->svgdefsmode AND !in_array($name, array('clipPath', 'linearGradient', 'radialGradient', 'stop'))) {
23714 if (isset($attribs['id'])) {
23715 $attribs['child_elements'] = array();
23716 $this->svgdefs[$attribs['id']] = array('name' => $name, 'attribs' => $attribs);
23717 return;
23718 }
23719 if (end($this->svgdefs) !== FALSE) {
23720 $last_svgdefs_id = key($this->svgdefs);
23721 if (isset($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'])) {
23722 $attribs['id'] = 'DF_'.(count($this->svgdefs[$last_svgdefs_id]['attribs']['child_elements']) + 1);
23723 $this->svgdefs[$last_svgdefs_id]['attribs']['child_elements'][$attribs['id']] = array('name' => $name, 'attribs' => $attribs);
23724 return;
23725 }
23726 }
23727 return;
23728 }
23729 $clipping = false;
23730 if ($parser == 'clip-path') {
23731 // set clipping mode
23732 $clipping = true;
23733 }
23734 // get styling properties
23735 $prev_svgstyle = $this->svgstyles[max(0,(count($this->svgstyles) - 1))]; // previous style
23736 $svgstyle = $this->svgstyles[0]; // set default style
23737 if ($clipping AND !isset($attribs['fill']) AND (!isset($attribs['style']) OR (!preg_match('/[;\"\s]{1}fill[\s]*:[\s]*([^;\"]*)/si', $attribs['style'], $attrval)))) {
23738 // default fill attribute for clipping
23739 $attribs['fill'] = 'none';
23740 }
23741 if (isset($attribs['style']) AND !TCPDF_STATIC::empty_string($attribs['style']) AND ($attribs['style'][0] != ';')) {
23742 // fix style for regular expression
23743 $attribs['style'] = ';'.$attribs['style'];
23744 }
23745 foreach ($prev_svgstyle as $key => $val) {
23747 // inherit previous value
23748 $svgstyle[$key] = $val;
23749 }
23751 // specific attribute settings
23752 if ($attribs[$key] == 'inherit') {
23753 $svgstyle[$key] = $val;
23754 } else {
23755 $svgstyle[$key] = $attribs[$key];
23756 }
23758 // CSS style syntax
23759 $attrval = array();
23760 if (preg_match('/[;\"\s]{1}'.$key.'[\s]*:[\s]*([^;\"]*)/si', $attribs['style'], $attrval) AND isset($attrval[1])) {
23761 if ($attrval[1] == 'inherit') {
23762 $svgstyle[$key] = $val;
23763 } else {
23764 $svgstyle[$key] = $attrval[1];
23765 }
23766 }
23767 }
23768 }
23769 // transformation matrix
23770 if (!empty($ctm)) {
23771 $tm = $ctm;
23772 } else {
23773 $tm = array(1,0,0,1,0,0);
23774 }
23775 if (isset($attribs['transform']) AND !empty($attribs['transform'])) {
23776 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, TCPDF_STATIC::getSVGTransformMatrix($attribs['transform']));
23777 }
23778 $svgstyle['transfmatrix'] = $tm;
23779 $invisible = false;
23780 if (($svgstyle['visibility'] == 'hidden') OR ($svgstyle['visibility'] == 'collapse') OR ($svgstyle['display'] == 'none')) {
23781 // the current graphics element is invisible (nothing is painted)
23782 $invisible = true;
23783 }
23784 // process tag
23785 switch($name) {
23786 case 'defs': {
23787 $this->svgdefsmode = true;
23788 break;
23789 }
23790 // clipPath
23791 case 'clipPath': {
23792 if ($invisible) {
23793 break;
23794 }
23795 $this->svgclipmode = true;
23796 if (!isset($attribs['id'])) {
23797 $attribs['id'] = 'CP_'.(count($this->svgcliptm) + 1);
23798 }
23799 $this->svgclipid = $attribs['id'];
23800 $this->svgclippaths[$this->svgclipid] = array();
23801 $this->svgcliptm[$this->svgclipid] = $tm;
23802 break;
23803 }
23804 case 'svg': {
23805 // start of SVG object
23806 if(++$this->svg_tag_depth <= 1) {
23807 break;
23808 }
23809 // inner SVG
23810 array_push($this->svgstyles, $svgstyle);
23811 $this->StartTransform();
23812 $svgX = (isset($attribs['x'])?$attribs['x']:0);
23813 $svgY = (isset($attribs['y'])?$attribs['y']:0);
23814 $svgW = (isset($attribs['width'])?$attribs['width']:0);
23815 $svgH = (isset($attribs['height'])?$attribs['height']:0);
23816 // set x, y position using transform matrix
23817 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, array( 1, 0, 0, 1, $svgX, $svgY));
23818 $this->SVGTransform($tm);
23819 // set clipping for width and height
23820 $x = 0;
23821 $y = 0;
23822 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):$this->w);
23823 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):$this->h);
23824 // draw clipping rect
23826 // parse viewbox, calculate extra transformation matrix
23827 if (isset($attribs['viewBox'])) {
23828 $tmp = array();
23829 preg_match_all("/[0-9]+/", $attribs['viewBox'], $tmp);
23830 $tmp = $tmp[0];
23831 if (sizeof($tmp) == 4) {
23832 $vx = $tmp[0];
23833 $vy = $tmp[1];
23834 $vw = $tmp[2];
23835 $vh = $tmp[3];
23836 // get aspect ratio
23837 $tmp = array();
23838 $aspectX = 'xMid';
23839 $aspectY = 'YMid';
23840 $fit = 'meet';
23841 if (isset($attribs['preserveAspectRatio'])) {
23842 if($attribs['preserveAspectRatio'] == 'none') {
23843 $fit = 'none';
23844 } else {
23845 preg_match_all('/[a-zA-Z]+/', $attribs['preserveAspectRatio'], $tmp);
23846 $tmp = $tmp[0];
23847 if ((sizeof($tmp) == 2) AND (strlen($tmp[0]) == 8) AND (in_array($tmp[1], array('meet', 'slice', 'none')))) {
23848 $aspectX = substr($tmp[0], 0, 4);
23849 $aspectY = substr($tmp[0], 4, 4);
23850 $fit = $tmp[1];
23851 }
23852 }
23853 }
23854 $wr = ($svgW / $vw);
23855 $hr = ($svgH / $vh);
23856 $ax = $ay = 0;
23857 if ((($fit == 'meet') AND ($hr < $wr)) OR (($fit == 'slice') AND ($hr > $wr))) {
23858 if ($aspectX == 'xMax') {
23859 $ax = (($vw * ($wr / $hr)) - $vw);
23860 }
23861 if ($aspectX == 'xMid') {
23862 $ax = ((($vw * ($wr / $hr)) - $vw) / 2);
23863 }
23864 $wr = $hr;
23865 } elseif ((($fit == 'meet') AND ($hr > $wr)) OR (($fit == 'slice') AND ($hr < $wr))) {
23866 if ($aspectY == 'YMax') {
23867 $ay = (($vh * ($hr / $wr)) - $vh);
23868 }
23869 if ($aspectY == 'YMid') {
23870 $ay = ((($vh * ($hr / $wr)) - $vh) / 2);
23871 }
23872 $hr = $wr;
23873 }
23874 $newtm = array($wr, 0, 0, $hr, (($wr * ($ax - $vx)) - $svgX), (($hr * ($ay - $vy)) - $svgY));
23875 $tm = TCPDF_STATIC::getTransformationMatrixProduct($tm, $newtm);
23876 $this->SVGTransform($tm);
23877 }
23878 }
23879 $this->setSVGStyles($svgstyle, $prev_svgstyle);
23880 break;
23881 }
23882 case 'g': {
23883 // group together related graphics elements
23884 array_push($this->svgstyles, $svgstyle);
23885 $this->StartTransform();
23891 $this->SVGTransform($tm);
23892 $this->setSVGStyles($svgstyle, $prev_svgstyle);
23893 break;
23894 }
23895 case 'linearGradient': {
23896 if ($this->pdfa_mode) {
23897 break;
23898 }
23899 if (!isset($attribs['id'])) {
23900 $attribs['id'] = 'GR_'.(count($this->svggradients) + 1);
23901 }
23902 $this->svggradientid = $attribs['id'];
23903 $this->svggradients[$this->svggradientid] = array();
23906 if (isset($attribs['gradientUnits'])) {
23908 } else {
23910 }
23911 //$attribs['spreadMethod']
23912 if (((!isset($attribs['x1'])) AND (!isset($attribs['y1'])) AND (!isset($attribs['x2'])) AND (!isset($attribs['y2'])))
23913 OR ((isset($attribs['x1']) AND (substr($attribs['x1'], -1) == '%'))
23914 OR (isset($attribs['y1']) AND (substr($attribs['y1'], -1) == '%'))
23915 OR (isset($attribs['x2']) AND (substr($attribs['x2'], -1) == '%'))
23916 OR (isset($attribs['y2']) AND (substr($attribs['y2'], -1) == '%')))) {
23918 } else {
23920 }
23921 $x1 = (isset($attribs['x1'])?$attribs['x1']:'0');
23922 $y1 = (isset($attribs['y1'])?$attribs['y1']:'0');
23923 $x2 = (isset($attribs['x2'])?$attribs['x2']:'100');
23924 $y2 = (isset($attribs['y2'])?$attribs['y2']:'0');
23925 if (isset($attribs['gradientTransform'])) {
23926 $this->svggradients[$this->svggradientid]['gradientTransform'] = TCPDF_STATIC::getSVGTransformMatrix($attribs['gradientTransform']);
23927 }
23929 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
23930 // gradient is defined on another place
23932 }
23933 break;
23934 }
23935 case 'radialGradient': {
23936 if ($this->pdfa_mode) {
23937 break;
23938 }
23939 if (!isset($attribs['id'])) {
23940 $attribs['id'] = 'GR_'.(count($this->svggradients) + 1);
23941 }
23942 $this->svggradientid = $attribs['id'];
23943 $this->svggradients[$this->svggradientid] = array();
23946 if (isset($attribs['gradientUnits'])) {
23948 } else {
23950 }
23951 //$attribs['spreadMethod']
23952 if (((!isset($attribs['cx'])) AND (!isset($attribs['cy'])))
23953 OR ((isset($attribs['cx']) AND (substr($attribs['cx'], -1) == '%'))
23954 OR (isset($attribs['cy']) AND (substr($attribs['cy'], -1) == '%')))) {
23956 } elseif (isset($attribs['r']) AND is_numeric($attribs['r']) AND ($attribs['r']) <= 1) {
23958 } else {
23960 }
23961 $cx = (isset($attribs['cx']) ? $attribs['cx'] : 0.5);
23962 $cy = (isset($attribs['cy']) ? $attribs['cy'] : 0.5);
23963 $fx = (isset($attribs['fx']) ? $attribs['fx'] : $cx);
23964 $fy = (isset($attribs['fy']) ? $attribs['fy'] : $cy);
23966 if (isset($attribs['gradientTransform'])) {
23967 $this->svggradients[$this->svggradientid]['gradientTransform'] = TCPDF_STATIC::getSVGTransformMatrix($attribs['gradientTransform']);
23968 }
23970 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
23971 // gradient is defined on another place
23973 }
23974 break;
23975 }
23976 case 'stop': {
23977 // gradient stops
23978 if (substr($attribs['offset'], -1) == '%') {
23979 $offset = floatval(substr($attribs['offset'], -1)) / 100;
23980 } else {
23981 $offset = floatval($attribs['offset']);
23982 if ($offset > 1) {
23983 $offset /= 100;
23984 }
23985 }
23986 $stop_color = isset($svgstyle['stop-color'])?TCPDF_COLORS::convertHTMLColorToDec($svgstyle['stop-color'], $this->spot_colors):'black';
23987 $opacity = isset($svgstyle['stop-opacity'])?$svgstyle['stop-opacity']:1;
23988 $this->svggradients[$this->svggradientid]['stops'][] = array('offset' => $offset, 'color' => $stop_color, 'opacity' => $opacity);
23989 break;
23990 }
23991 // paths
23992 case 'path': {
23993 if ($invisible) {
23994 break;
23995 }
23996 if (isset($attribs['d'])) {
24004 if ($clipping) {
24005 $this->SVGTransform($tm);
24007 } else {
24008 $this->StartTransform();
24009 $this->SVGTransform($tm);
24010 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'SVGPath', array($d, 'CNZ'));
24011 if (!empty($obstyle)) {
24013 }
24014 $this->StopTransform();
24015 }
24016 }
24017 }
24018 break;
24019 }
24020 // shapes
24021 case 'rect': {
24022 if ($invisible) {
24023 break;
24024 }
24025 $x = (isset($attribs['x'])?$this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false):0);
24026 $y = (isset($attribs['y'])?$this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false):0);
24027 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):0);
24028 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):0);
24029 $rx = (isset($attribs['rx'])?$this->getHTMLUnitToUnits($attribs['rx'], 0, $this->svgunit, false):0);
24030 $ry = (isset($attribs['ry'])?$this->getHTMLUnitToUnits($attribs['ry'], 0, $this->svgunit, false):$rx);
24031 if ($clipping) {
24032 $this->SVGTransform($tm);
24034 } else {
24035 $this->StartTransform();
24036 $this->SVGTransform($tm);
24037 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'RoundedRectXY', array($x, $y, $w, $h, $rx, $ry, '1111', 'CNZ'));
24038 if (!empty($obstyle)) {
24040 }
24041 $this->StopTransform();
24042 }
24043 break;
24044 }
24045 case 'circle': {
24046 if ($invisible) {
24047 break;
24048 }
24049 $r = (isset($attribs['r']) ? $this->getHTMLUnitToUnits($attribs['r'], 0, $this->svgunit, false) : 0);
24050 $cx = (isset($attribs['cx']) ? $this->getHTMLUnitToUnits($attribs['cx'], 0, $this->svgunit, false) : (isset($attribs['x']) ? $this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false) : 0));
24051 $cy = (isset($attribs['cy']) ? $this->getHTMLUnitToUnits($attribs['cy'], 0, $this->svgunit, false) : (isset($attribs['y']) ? $this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false) : 0));
24056 if ($clipping) {
24057 $this->SVGTransform($tm);
24059 } else {
24060 $this->StartTransform();
24061 $this->SVGTransform($tm);
24062 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Circle', array($cx, $cy, $r, 0, 360, 'CNZ'));
24063 if (!empty($obstyle)) {
24065 }
24066 $this->StopTransform();
24067 }
24068 break;
24069 }
24070 case 'ellipse': {
24071 if ($invisible) {
24072 break;
24073 }
24074 $rx = (isset($attribs['rx']) ? $this->getHTMLUnitToUnits($attribs['rx'], 0, $this->svgunit, false) : 0);
24075 $ry = (isset($attribs['ry']) ? $this->getHTMLUnitToUnits($attribs['ry'], 0, $this->svgunit, false) : 0);
24076 $cx = (isset($attribs['cx']) ? $this->getHTMLUnitToUnits($attribs['cx'], 0, $this->svgunit, false) : (isset($attribs['x']) ? $this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false) : 0));
24077 $cy = (isset($attribs['cy']) ? $this->getHTMLUnitToUnits($attribs['cy'], 0, $this->svgunit, false) : (isset($attribs['y']) ? $this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false) : 0));
24078 $x = ($cx - $rx);
24079 $y = ($cy - $ry);
24080 $w = (2 * $rx);
24081 $h = (2 * $ry);
24082 if ($clipping) {
24083 $this->SVGTransform($tm);
24085 } else {
24086 $this->StartTransform();
24087 $this->SVGTransform($tm);
24088 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Ellipse', array($cx, $cy, $rx, $ry, 0, 0, 360, 'CNZ'));
24089 if (!empty($obstyle)) {
24090 $this->Ellipse($cx, $cy, $rx, $ry, 0, 0, 360, $obstyle, array(), array(), 8);
24091 }
24092 $this->StopTransform();
24093 }
24094 break;
24095 }
24096 case 'line': {
24097 if ($invisible) {
24098 break;
24099 }
24100 $x1 = (isset($attribs['x1'])?$this->getHTMLUnitToUnits($attribs['x1'], 0, $this->svgunit, false):0);
24101 $y1 = (isset($attribs['y1'])?$this->getHTMLUnitToUnits($attribs['y1'], 0, $this->svgunit, false):0);
24102 $x2 = (isset($attribs['x2'])?$this->getHTMLUnitToUnits($attribs['x2'], 0, $this->svgunit, false):0);
24103 $y2 = (isset($attribs['y2'])?$this->getHTMLUnitToUnits($attribs['y2'], 0, $this->svgunit, false):0);
24104 $x = $x1;
24105 $y = $y1;
24106 $w = abs($x2 - $x1);
24107 $h = abs($y2 - $y1);
24108 if (!$clipping) {
24109 $this->StartTransform();
24110 $this->SVGTransform($tm);
24111 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Line', array($x1, $y1, $x2, $y2));
24112 $this->Line($x1, $y1, $x2, $y2);
24113 $this->StopTransform();
24114 }
24115 break;
24116 }
24117 case 'polyline':
24118 case 'polygon': {
24119 if ($invisible) {
24120 break;
24121 }
24122 $points = (isset($attribs['points'])?$attribs['points']:'0 0');
24123 $points = trim($points);
24124 // note that point may use a complex syntax not covered here
24125 $points = preg_split('/[\,\s]+/si', $points);
24126 if (count($points) < 4) {
24127 break;
24128 }
24129 $p = array();
24130 $xmin = 2147483647;
24131 $xmax = 0;
24132 $ymin = 2147483647;
24133 $ymax = 0;
24134 foreach ($points as $key => $val) {
24136 if (($key % 2) == 0) {
24137 // X coordinate
24138 $xmin = min($xmin, $p[$key]);
24139 $xmax = max($xmax, $p[$key]);
24140 } else {
24141 // Y coordinate
24142 $ymin = min($ymin, $p[$key]);
24143 $ymax = max($ymax, $p[$key]);
24144 }
24145 }
24146 $x = $xmin;
24147 $y = $ymin;
24148 $w = ($xmax - $xmin);
24149 $h = ($ymax - $ymin);
24150 if ($name == 'polyline') {
24151 $this->StartTransform();
24152 $this->SVGTransform($tm);
24153 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'PolyLine', array($p, 'CNZ'));
24154 if (!empty($obstyle)) {
24155 $this->PolyLine($p, $obstyle, array(), array());
24156 }
24157 $this->StopTransform();
24158 } else { // polygon
24159 if ($clipping) {
24160 $this->SVGTransform($tm);
24162 } else {
24163 $this->StartTransform();
24164 $this->SVGTransform($tm);
24165 $obstyle = $this->setSVGStyles($svgstyle, $prev_svgstyle, $x, $y, $w, $h, 'Polygon', array($p, 'CNZ'));
24166 if (!empty($obstyle)) {
24168 }
24169 $this->StopTransform();
24170 }
24171 }
24172 break;
24173 }
24174 // image
24175 case 'image': {
24176 if ($invisible) {
24177 break;
24178 }
24179 if (!isset($attribs['xlink:href']) OR empty($attribs['xlink:href'])) {
24180 break;
24181 }
24182 $x = (isset($attribs['x'])?$this->getHTMLUnitToUnits($attribs['x'], 0, $this->svgunit, false):0);
24183 $y = (isset($attribs['y'])?$this->getHTMLUnitToUnits($attribs['y'], 0, $this->svgunit, false):0);
24184 $w = (isset($attribs['width'])?$this->getHTMLUnitToUnits($attribs['width'], 0, $this->svgunit, false):0);
24185 $h = (isset($attribs['height'])?$this->getHTMLUnitToUnits($attribs['height'], 0, $this->svgunit, false):0);
24187 if (!$clipping) {
24188 $this->StartTransform();
24189 $this->SVGTransform($tm);
24192 // embedded image encoded as base64
24194 } else {
24195 // fix image path
24196 if (!TCPDF_STATIC::empty_string($this->svgdir) AND (($img[0] == '.') OR (basename($img) == $img))) {
24197 // replace relative path with full server path
24199 }
24200 if (($img[0] == '/') AND !empty($_SERVER['DOCUMENT_ROOT']) AND ($_SERVER['DOCUMENT_ROOT'] != '/')) {
24202 if (($findroot === false) OR ($findroot > 1)) {
24205 } else {
24207 }
24208 }
24209 }
24211 $testscrtype = @parse_url($img);
24212 if (!isset($testscrtype['query']) OR empty($testscrtype['query'])) {
24213 // convert URL to server path
24215 }
24216 }
24217 // get image type
24219 if (($imgtype == 'eps') OR ($imgtype == 'ai')) {
24221 } elseif ($imgtype == 'svg') {
24222 // store SVG vars
24234 // restore SVG vars
24235 $this->svggradients = $svggradients;
24236 $this->svggradientid = $svggradientid;
24237 $this->svgdefsmode = $svgdefsmode;
24238 $this->svgdefs = $svgdefs;
24239 $this->svgclipmode = $svgclipmode;
24240 $this->svgclippaths = $svgclippaths;
24241 $this->svgcliptm = $svgcliptm;
24242 $this->svgclipid = $svgclipid;
24243 $this->svgtext = $svgtext;
24244 $this->svgtextmode = $svgtextmode;
24245 } else {
24247 }
24248 $this->StopTransform();
24249 }
24250 break;
24251 }
24252 // text
24253 case 'text':
24254 case 'tspan': {
24255 if (isset($this->svgtextmode['text-anchor']) AND !empty($this->svgtext)) {
24256 // @TODO: unsupported feature
24257 }
24258 // only basic support - advanced features must be implemented
24259 $this->svgtextmode['invisible'] = $invisible;
24260 if ($invisible) {
24261 break;
24262 }
24263 array_push($this->svgstyles, $svgstyle);
24264 if (isset($attribs['x'])) {
24266 } elseif ($name == 'tspan') {
24268 } else {
24269 $x = 0;
24270 }
24271 if (isset($attribs['dx'])) {
24273 }
24274 if (isset($attribs['y'])) {
24276 } elseif ($name == 'tspan') {
24278 } else {
24279 $y = 0;
24280 }
24281 if (isset($attribs['dy'])) {
24283 }
24284 $svgstyle['text-color'] = $svgstyle['fill'];
24285 $this->svgtext = '';
24286 if (isset($svgstyle['text-anchor'])) {
24287 $this->svgtextmode['text-anchor'] = $svgstyle['text-anchor'];
24288 } else {
24289 $this->svgtextmode['text-anchor'] = 'start';
24290 }
24291 if (isset($svgstyle['direction'])) {
24292 if ($svgstyle['direction'] == 'rtl') {
24293 $this->svgtextmode['rtl'] = true;
24294 } else {
24295 $this->svgtextmode['rtl'] = false;
24296 }
24297 } else {
24298 $this->svgtextmode['rtl'] = false;
24299 }
24300 if (isset($svgstyle['stroke']) AND ($svgstyle['stroke'] != 'none') AND isset($svgstyle['stroke-width']) AND ($svgstyle['stroke-width'] > 0)) {
24301 $this->svgtextmode['stroke'] = $this->getHTMLUnitToUnits($svgstyle['stroke-width'], 0, $this->svgunit, false);
24302 } else {
24303 $this->svgtextmode['stroke'] = false;
24304 }
24305 $this->StartTransform();
24306 $this->SVGTransform($tm);
24308 $this->x = $x;
24309 $this->y = $y;
24310 break;
24311 }
24312 // use
24313 case 'use': {
24314 if (isset($attribs['xlink:href']) AND !empty($attribs['xlink:href'])) {
24315 $svgdefid = substr($attribs['xlink:href'], 1);
24316 if (isset($this->svgdefs[$svgdefid])) {
24317 $use = $this->svgdefs[$svgdefid];
24318 if (isset($attribs['xlink:href'])) {
24319 unset($attribs['xlink:href']);
24320 }
24321 if (isset($attribs['id'])) {
24322 unset($attribs['id']);
24323 }
24324 if (isset($use['attribs']['x']) AND isset($attribs['x'])) {
24325 $attribs['x'] += $use['attribs']['x'];
24326 }
24327 if (isset($use['attribs']['y']) AND isset($attribs['y'])) {
24328 $attribs['y'] += $use['attribs']['y'];
24329 }
24330 if (empty($attribs['style'])) {
24331 $attribs['style'] = '';
24332 }
24333 if (!empty($use['attribs']['style'])) {
24334 // merge styles
24335 $attribs['style'] = str_replace(';;',';',';'.$use['attribs']['style'].$attribs['style']);
24336 }
24337 $attribs = array_merge($use['attribs'], $attribs);
24339 return;
24340 }
24341 }
24342 break;
24343 }
24344 default: {
24345 break;
24346 }
24347 } // end of switch
24348 // process child elements
24349 if (!empty($attribs['child_elements'])) {
24350 $child_elements = $attribs['child_elements'];
24351 unset($attribs['child_elements']);
24352 foreach($child_elements as $child_element) {
24353 if (empty($child_element['attribs']['closing_tag'])) {
24354 $this->startSVGElementHandler('child-tag', $child_element['name'], $child_element['attribs']);
24355 } else {
24356 if (isset($child_element['attribs']['content'])) {
24357 $this->svgtext = $child_element['attribs']['content'];
24358 }
24360 }
24361 }
24362 }
24363 }
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:24373
PolyLine($p, $style='', $line_style=array(), $fill_color=array())
Draws a polygonal line.
Definition: tcpdf.php:11843
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:23036
if((!isset($_SERVER['DOCUMENT_ROOT'])) OR(empty($_SERVER['DOCUMENT_ROOT']))) $_SERVER['DOCUMENT_ROOT']
Definition: tcpdf_autoconfig.php:54
References $_SERVER, $d, $h, $img, $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 22229 of file tcpdf.php.
22229 {
22230 if ($this->inxobj) {
22231 // we are already inside an XObject template
22232 return false;
22233 }
22234 $this->inxobj = true;
22235 ++$this->n;
22236 // XObject ID
22237 $this->xobjid = 'XT'.$this->n;
22238 // object ID
22240 // store current graphic state
22242 // initialize data
22253 // set new environment
22254 $this->num_columns = 1;
22255 $this->current_column = 0;
22259 }
22262 }
22267 $this->w = $w;
22268 $this->h = $h;
22269 $this->wPt = $this->w * $this->k;
22270 $this->hPt = $this->h * $this->k;
22271 $this->fwPt = $this->wPt;
22272 $this->fhPt = $this->hPt;
22273 $this->x = 0;
22274 $this->y = 0;
22275 $this->lMargin = 0;
22276 $this->rMargin = 0;
22277 $this->tMargin = 0;
22278 $this->bMargin = 0;
22279 // set group mode
22282 }
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 21621 of file tcpdf.php.
21621 {
21622 if (isset($this->objcopy)) {
21623 // remove previous copy
21624 $this->commitTransaction();
21625 }
21626 // record current page number and Y position
21627 $this->start_transaction_page = $this->page;
21628 $this->start_transaction_y = $this->y;
21629 // clone current object
21630 $this->objcopy = TCPDF_STATIC::objclone($this);
21631 }
commitTransaction()
Delete the copy of the current TCPDF object used for undo operation.
Definition: tcpdf.php:21638
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 10946 of file tcpdf.php.
10946 {
10947 if ($this->state != 2) {
10948 return;
10949 }
10950 $this->_outSaveGraphicsState();
10951 if ($this->inxobj) {
10952 // we are inside an XObject template
10953 $this->xobjects[$this->xobjid]['transfmrk'][] = strlen($this->xobjects[$this->xobjid]['outdata']);
10954 } else {
10956 }
10957 ++$this->transfmatrix_key;
10958 $this->transfmatrix[$this->transfmatrix_key] = array();
10959 }
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 10969 of file tcpdf.php.
10969 {
10970 if ($this->state != 2) {
10971 return;
10972 }
10973 $this->_outRestoreGraphicsState();
10974 if (isset($this->transfmatrix[$this->transfmatrix_key])) {
10975 array_pop($this->transfmatrix[$this->transfmatrix_key]);
10976 --$this->transfmatrix_key;
10977 }
10978 if ($this->inxobj) {
10979 // we are inside an XObject template
10980 array_pop($this->xobjects[$this->xobjid]['transfmrk']);
10981 } else {
10982 array_pop($this->transfmrk[$this->page]);
10983 }
10984 }
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 22134 of file tcpdf.php.
22134 {
22135 return preg_replace('/^'.$this->re_space['p'].'+/'.$this->re_space['m'], $replace, $str);
22136 }
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 22147 of file tcpdf.php.
22147 {
22148 return preg_replace('/'.$this->re_space['p'].'+$/'.$this->re_space['m'], $replace, $str);
22149 }
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 22160 of file tcpdf.php.
22160 {
22161 $str = $this->stringLeftTrim($str, $replace);
22162 $str = $this->stringRightTrim($str, $replace);
22163 return $str;
22164 }
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 23331 of file tcpdf.php.
23331 {
23332 if ($this->state != 2) {
23333 return;
23334 }
23335 // set fill/stroke style
23337 if (empty($op)) {
23338 return;
23339 }
23340 $paths = array();
23343 $x = 0;
23344 $y = 0;
23345 $x1 = 0;
23346 $y1 = 0;
23347 $x2 = 0;
23348 $y2 = 0;
23349 $xmin = 2147483647;
23350 $xmax = 0;
23351 $ymin = 2147483647;
23352 $ymax = 0;
23353 $relcoord = false;
23355 $firstcmd = true; // used to print first point
23356 // draw curve pieces
23357 foreach ($paths as $key => $val) {
23358 // get curve type
23359 $cmd = trim($val[1]);
23361 // use relative coordinated instead of absolute
23362 $relcoord = true;
23363 $xoffset = $x;
23364 $yoffset = $y;
23365 } else {
23366 $relcoord = false;
23367 $xoffset = 0;
23368 $yoffset = 0;
23369 }
23370 $params = array();
23371 if (isset($val[2])) {
23372 // get curve parameters
23373 $rawparams = preg_split('/([\,\s]+)/si', trim($val[2]));
23374 $params = array();
23375 foreach ($rawparams as $ck => $cp) {
23378 // approximate little values to zero
23379 $params[$ck] = 0;
23380 }
23381 }
23382 }
23383 // store current origin point
23384 $x0 = $x;
23385 $y0 = $y;
23387 case 'M': { // moveto
23389 if (($ck % 2) == 0) {
23390 $x = $cp + $xoffset;
23391 } else {
23392 $y = $cp + $yoffset;
23394 if ($ck == 1) {
23396 $firstcmd = false;
23397 } else {
23399 }
23400 $x0 = $x;
23401 $y0 = $y;
23402 }
23403 $xmin = min($xmin, $x);
23404 $ymin = min($ymin, $y);
23405 $xmax = max($xmax, $x);
23406 $ymax = max($ymax, $y);
23407 if ($relcoord) {
23408 $xoffset = $x;
23409 $yoffset = $y;
23410 }
23411 }
23412 }
23413 break;
23414 }
23415 case 'L': { // lineto
23417 if (($ck % 2) == 0) {
23418 $x = $cp + $xoffset;
23419 } else {
23420 $y = $cp + $yoffset;
23423 $x0 = $x;
23424 $y0 = $y;
23425 }
23426 $xmin = min($xmin, $x);
23427 $ymin = min($ymin, $y);
23428 $xmax = max($xmax, $x);
23429 $ymax = max($ymax, $y);
23430 if ($relcoord) {
23431 $xoffset = $x;
23432 $yoffset = $y;
23433 }
23434 }
23435 }
23436 break;
23437 }
23438 case 'H': { // horizontal lineto
23440 $x = $cp + $xoffset;
23443 $x0 = $x;
23444 $y0 = $y;
23445 }
23446 $xmin = min($xmin, $x);
23447 $xmax = max($xmax, $x);
23448 if ($relcoord) {
23449 $xoffset = $x;
23450 }
23451 }
23452 break;
23453 }
23454 case 'V': { // vertical lineto
23456 $y = $cp + $yoffset;
23459 $x0 = $x;
23460 $y0 = $y;
23461 }
23462 $ymin = min($ymin, $y);
23463 $ymax = max($ymax, $y);
23464 if ($relcoord) {
23465 $yoffset = $y;
23466 }
23467 }
23468 break;
23469 }
23470 case 'C': { // curveto
23472 $params[$ck] = $cp;
23473 if ((($ck + 1) % 6) == 0) {
23474 $x1 = $params[($ck - 5)] + $xoffset;
23475 $y1 = $params[($ck - 4)] + $yoffset;
23476 $x2 = $params[($ck - 3)] + $xoffset;
23477 $y2 = $params[($ck - 2)] + $yoffset;
23481 $xmin = min($xmin, $x, $x1, $x2);
23482 $ymin = min($ymin, $y, $y1, $y2);
23483 $xmax = max($xmax, $x, $x1, $x2);
23484 $ymax = max($ymax, $y, $y1, $y2);
23485 if ($relcoord) {
23486 $xoffset = $x;
23487 $yoffset = $y;
23488 }
23489 }
23490 }
23491 break;
23492 }
23493 case 'S': { // shorthand/smooth curveto
23495 $params[$ck] = $cp;
23496 if ((($ck + 1) % 4) == 0) {
23497 if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'C') OR (strtoupper($paths[($key - 1)][1]) == 'S'))) {
23498 $x1 = (2 * $x) - $x2;
23499 $y1 = (2 * $y) - $y2;
23500 } else {
23501 $x1 = $x;
23502 $y1 = $y;
23503 }
23504 $x2 = $params[($ck - 3)] + $xoffset;
23505 $y2 = $params[($ck - 2)] + $yoffset;
23509 $xmin = min($xmin, $x, $x1, $x2);
23510 $ymin = min($ymin, $y, $y1, $y2);
23511 $xmax = max($xmax, $x, $x1, $x2);
23512 $ymax = max($ymax, $y, $y1, $y2);
23513 if ($relcoord) {
23514 $xoffset = $x;
23515 $yoffset = $y;
23516 }
23517 }
23518 }
23519 break;
23520 }
23521 case 'Q': { // quadratic Bezier curveto
23523 $params[$ck] = $cp;
23524 if ((($ck + 1) % 4) == 0) {
23525 // convert quadratic points to cubic points
23526 $x1 = $params[($ck - 3)] + $xoffset;
23527 $y1 = $params[($ck - 2)] + $yoffset;
23528 $xa = ($x + (2 * $x1)) / 3;
23529 $ya = ($y + (2 * $y1)) / 3;
23532 $xb = ($x + (2 * $x1)) / 3;
23533 $yb = ($y + (2 * $y1)) / 3;
23535 $xmin = min($xmin, $x, $xa, $xb);
23536 $ymin = min($ymin, $y, $ya, $yb);
23537 $xmax = max($xmax, $x, $xa, $xb);
23538 $ymax = max($ymax, $y, $ya, $yb);
23539 if ($relcoord) {
23540 $xoffset = $x;
23541 $yoffset = $y;
23542 }
23543 }
23544 }
23545 break;
23546 }
23547 case 'T': { // shorthand/smooth quadratic Bezier curveto
23549 $params[$ck] = $cp;
23550 if (($ck % 2) != 0) {
23551 if (($key > 0) AND ((strtoupper($paths[($key - 1)][1]) == 'Q') OR (strtoupper($paths[($key - 1)][1]) == 'T'))) {
23552 $x1 = (2 * $x) - $x1;
23553 $y1 = (2 * $y) - $y1;
23554 } else {
23555 $x1 = $x;
23556 $y1 = $y;
23557 }
23558 // convert quadratic points to cubic points
23559 $xa = ($x + (2 * $x1)) / 3;
23560 $ya = ($y + (2 * $y1)) / 3;
23563 $xb = ($x + (2 * $x1)) / 3;
23564 $yb = ($y + (2 * $y1)) / 3;
23566 $xmin = min($xmin, $x, $xa, $xb);
23567 $ymin = min($ymin, $y, $ya, $yb);
23568 $xmax = max($xmax, $x, $xa, $xb);
23569 $ymax = max($ymax, $y, $ya, $yb);
23570 if ($relcoord) {
23571 $xoffset = $x;
23572 $yoffset = $y;
23573 }
23574 }
23575 }
23576 break;
23577 }
23578 case 'A': { // elliptical arc
23580 $params[$ck] = $cp;
23581 if ((($ck + 1) % 7) == 0) {
23582 $x0 = $x;
23583 $y0 = $y;
23584 $rx = abs($params[($ck - 6)]);
23585 $ry = abs($params[($ck - 5)]);
23586 $ang = -$rawparams[($ck - 4)];
23587 $angle = deg2rad($ang);
23588 $fa = $rawparams[($ck - 3)]; // large-arc-flag
23589 $fs = $rawparams[($ck - 2)]; // sweep-flag
23593 // endpoints are almost identical
23594 $xmin = min($xmin, $x);
23595 $ymin = min($ymin, $y);
23596 $xmax = max($xmax, $x);
23597 $ymax = max($ymax, $y);
23598 } else {
23599 $cos_ang = cos($angle);
23600 $sin_ang = sin($angle);
23601 $a = (($x0 - $x) / 2);
23602 $b = (($y0 - $y) / 2);
23603 $xa = ($a * $cos_ang) - ($b * $sin_ang);
23604 $ya = ($a * $sin_ang) + ($b * $cos_ang);
23605 $rx2 = $rx * $rx;
23606 $ry2 = $ry * $ry;
23607 $xa2 = $xa * $xa;
23608 $ya2 = $ya * $ya;
23609 $delta = ($xa2 / $rx2) + ($ya2 / $ry2);
23610 if ($delta > 1) {
23611 $rx *= sqrt($delta);
23612 $ry *= sqrt($delta);
23613 $rx2 = $rx * $rx;
23614 $ry2 = $ry * $ry;
23615 }
23616 $numerator = (($rx2 * $ry2) - ($rx2 * $ya2) - ($ry2 * $xa2));
23617 if ($numerator < 0) {
23618 $root = 0;
23619 } else {
23620 $root = sqrt($numerator / (($rx2 * $ya2) + ($ry2 * $xa2)));
23621 }
23622 if ($fa == $fs){
23623 $root *= -1;
23624 }
23625 $cax = $root * (($rx * $ya) / $ry);
23626 $cay = -$root * (($ry * $xa) / $rx);
23627 // coordinates of ellipse center
23628 $cx = ($cax * $cos_ang) - ($cay * $sin_ang) + (($x0 + $x) / 2);
23629 $cy = ($cax * $sin_ang) + ($cay * $cos_ang) + (($y0 + $y) / 2);
23630 // get angles
23631 $angs = TCPDF_STATIC::getVectorsAngle(1, 0, (($xa - $cax) / $rx), (($cay - $ya) / $ry));
23632 $dang = TCPDF_STATIC::getVectorsAngle((($xa - $cax) / $rx), (($ya - $cay) / $ry), ((-$xa - $cax) / $rx), ((-$ya - $cay) / $ry));
23633 if (($fs == 0) AND ($dang > 0)) {
23634 $dang -= (2 * M_PI);
23635 } elseif (($fs == 1) AND ($dang < 0)) {
23636 $dang += (2 * M_PI);
23637 }
23638 $angf = $angs - $dang;
23639 if ((($fs == 0) AND ($angs > $angf)) OR (($fs == 1) AND ($angs < $angf))) {
23640 // reverse angles
23641 $tmp = $angs;
23642 $angs = $angf;
23643 $angf = $tmp;
23644 }
23645 $angs = round(rad2deg($angs), 6);
23646 $angf = round(rad2deg($angf), 6);
23647 // covent angles to positive values
23648 if (($angs < 0) AND ($angf < 0)) {
23649 $angs += 360;
23650 $angf += 360;
23651 }
23652 $pie = false;
23653 if (($key == 0) AND (isset($paths[($key + 1)][1])) AND (trim($paths[($key + 1)][1]) == 'z')) {
23654 $pie = true;
23655 }
23656 list($axmin, $aymin, $axmax, $aymax) = $this->_outellipticalarc($cx, $cy, $rx, $ry, $ang, $angs, $angf, $pie, 2, false, ($fs == 0), true);
23657 $xmin = min($xmin, $x, $axmin);
23658 $ymin = min($ymin, $y, $aymin);
23659 $xmax = max($xmax, $x, $axmax);
23660 $ymax = max($ymax, $y, $aymax);
23661 }
23662 if ($relcoord) {
23663 $xoffset = $x;
23664 $yoffset = $y;
23665 }
23666 }
23667 }
23668 break;
23669 }
23670 case 'Z': {
23672 break;
23673 }
23674 }
23675 $firstcmd = false;
23676 } // end foreach
23677 if (!empty($op)) {
23678 $this->_out($op);
23679 }
23680 return array($xmin, $ymin, ($xmax - $xmin), ($ymax - $ymin));
23681 }
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 23017 of file tcpdf.php.
23017 {
23019 }
◆ 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 20178 of file tcpdf.php.
20178 {
20179 if ($reverse) {
20180 // swap left and right margins
20181 $mtemp = $this->original_lMargin;
20182 $this->original_lMargin = $this->original_rMargin;
20183 $this->original_rMargin = $mtemp;
20184 $deltam = $this->original_lMargin - $this->original_rMargin;
20185 $this->lMargin += $deltam;
20186 $this->rMargin -= $deltam;
20187 }
20188 }
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 12646 of file tcpdf.php.
12646 {
12649 }
12652 }
12653 // check page for no-write regions and adapt page margins if necessary
12657 return;
12658 }
12659 // get default style
12660 $prop = array_merge($this->getFormDefaultProp(), $prop);
12661 // get annotation data
12662 $popt = TCPDF_STATIC::getAnnotOptFromJSProp($prop, $this->spot_colors, $this->rtl);
12663 // set default appearance stream
12664 $this->annotation_fonts[$this->CurrentFont['fontkey']] = $this->CurrentFont['i'];
12665 $fontstyle = sprintf('/F%d %F Tf %s', $this->CurrentFont['i'], $this->FontSizePt, $this->TextColor);
12666 $popt['da'] = $fontstyle;
12667 // build appearance stream
12668 $popt['ap'] = array();
12669 $popt['ap']['n'] = '/Tx BMC q '.$fontstyle.' ';
12671 if (isset($prop['value']) AND !empty($prop['value'])) {
12673 } elseif (isset($opt['v']) AND !empty($opt['v'])) {
12675 }
12677 $align = '';
12678 if (isset($popt['q'])) {
12679 switch ($popt['q']) {
12680 case 0: {
12681 $align = 'L';
12682 break;
12683 }
12684 case 1: {
12685 $align = 'C';
12686 break;
12687 }
12688 case 2: {
12689 $align = 'R';
12690 break;
12691 }
12692 default: {
12693 $align = '';
12694 break;
12695 }
12696 }
12697 }
12698 $this->MultiCell($w, $h, $text, 0, $align, false, 0, 0, 0, true, 0, false, true, 0, 'T', false);
12699 $this->endTemplate();
12700 --$this->n;
12701 $popt['ap']['n'] .= $this->xobjects[$tmpid]['outdata'];
12702 unset($this->xobjects[$tmpid]);
12703 $popt['ap']['n'] .= 'Q EMC';
12704 // merge options
12705 $opt = array_merge($popt, $opt);
12706 // remove some conflicting options
12707 unset($opt['bs']);
12708 // set remaining annotation data
12709 $opt['Subtype'] = 'Widget';
12710 $opt['ft'] = 'Tx';
12711 $opt['t'] = $name;
12712 // Additional annotation's parameters (check _putannotsobj() method):
12713 //$opt['f']
12714 //$opt['as']
12715 //$opt['bs']
12716 //$opt['be']
12717 //$opt['c']
12718 //$opt['border']
12719 //$opt['h']
12720 //$opt['mk'];
12721 //$opt['mk']['r']
12722 //$opt['mk']['bc'];
12723 //$opt['mk']['bg'];
12724 unset($opt['mk']['ca']);
12725 unset($opt['mk']['rc']);
12726 unset($opt['mk']['ac']);
12727 unset($opt['mk']['i']);
12728 unset($opt['mk']['ri']);
12729 unset($opt['mk']['ix']);
12730 unset($opt['mk']['if']);
12731 //$opt['mk']['if']['sw'];
12732 //$opt['mk']['if']['s'];
12733 //$opt['mk']['if']['a'];
12734 //$opt['mk']['if']['fb'];
12735 unset($opt['mk']['tp']);
12736 //$opt['tu']
12737 //$opt['tm']
12738 //$opt['ff']
12739 //$opt['v']
12740 //$opt['dv']
12741 //$opt['a']
12742 //$opt['aa']
12743 //$opt['q']
12745 if ($this->rtl) {
12746 $this->x -= $w;
12747 } else {
12748 $this->x += $w;
12749 }
12750 }
References $h, $js, $n, $text, $w, $x, $y, _addfield(), Annotation(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), MultiCell(), and startTemplate().
Referenced by openHTMLTagHandler().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ Transform()
|
protected |
Apply graphic transformations.
- Parameters
-
$tm (array) transformation matrix
- Since
- 2.1.000 (2008-01-07)
- See also
- StartTransform(), StopTransform()
Definition at line 11248 of file tcpdf.php.
11248 {
11249 if ($this->state != 2) {
11250 return;
11251 }
11253 // add tranformation matrix
11254 $this->transfmatrix[$this->transfmatrix_key][] = array('a' => $tm[0], 'b' => $tm[1], 'c' => $tm[2], 'd' => $tm[3], 'e' => $tm[4], 'f' => $tm[5]);
11255 // update transformation mark
11256 if ($this->inxobj) {
11257 // we are inside an XObject template
11258 if (end($this->xobjects[$this->xobjid]['transfmrk']) !== false) {
11259 $key = key($this->xobjects[$this->xobjid]['transfmrk']);
11260 $this->xobjects[$this->xobjid]['transfmrk'][$key] = strlen($this->xobjects[$this->xobjid]['outdata']);
11261 }
11262 } elseif (end($this->transfmrk[$this->page]) !== false) {
11263 $key = key($this->transfmrk[$this->page]);
11265 }
11266 }
References $page, $transfmatrix_key, $xobjid, and _out().
Referenced by Rotate(), Scale(), Skew(), and Translate().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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 11138 of file tcpdf.php.
11138 {
11139 //calculate elements of transformation matrix
11140 $tm = array();
11141 $tm[0] = 1;
11142 $tm[1] = 0;
11143 $tm[2] = 0;
11144 $tm[3] = 1;
11145 $tm[4] = $t_x * $this->k;
11146 $tm[5] = -$t_y * $this->k;
11147 //translate the coordinate system
11148 $this->Transform($tm);
11149 }
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 11115 of file tcpdf.php.
11115 {
11116 $this->Translate($t_x, 0);
11117 }
Translate($t_x, $t_y)
Translate graphic object horizontally and vertically.
Definition: tcpdf.php:11138
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 11126 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 10428 of file tcpdf.php.
10428 {
10429 return @html_entity_decode($text_to_convert, ENT_QUOTES, $this->encoding);
10430 }
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 17073 of file tcpdf.php.
17073 {
17074 $hash = substr($data, 0, 32);
17075 $encoded = substr($data, 32);
17078 }
17079 return json_decode(urldecode($encoded), true);
17080 }
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 15198 of file tcpdf.php.
15198 {
15200 return;
15201 }
15202 require_once(dirname(__FILE__).'/tcpdf_barcodes_1d.php');
15203 // save current graphic settings
15204 $gvars = $this->getGraphicVars();
15205 // create new barcode object
15207 $arrcode = $barcodeobj->getBarcodeArray();
15208 if (($arrcode === false) OR empty($arrcode) OR ($arrcode['maxw'] <= 0)) {
15210 }
15211 if ($arrcode['maxh'] <= 0) {
15212 $arrcode['maxh'] = 1;
15213 }
15214 // set default values
15218 // keep this for backward compatibility
15221 }
15225 } else {
15227 }
15228 }
15230 // disable stretch
15232 }
15236 } else {
15238 }
15239 }
15242 }
15245 }
15248 }
15249 $fontsize = 0;
15252 }
15256 }
15258 }
15261 }
15264 }
15267 }
15268 // check page for no-write regions and adapt page margins if necessary
15271 if ($this->rtl) {
15273 } else {
15275 }
15276 }
15277 // padding
15279 $padding = 0;
15282 } else {
15284 }
15285 // horizontal padding
15287 $hpadding = $padding;
15290 } else {
15292 }
15293 // vertical padding
15295 $vpadding = $padding;
15297 $vpadding = ($hpadding / 2);
15298 } else {
15300 }
15301 // calculate xres (single bar width)
15304 $xres = $max_xres;
15305 } else {
15308 }
15309 if ($xres > $max_xres) {
15310 // correct xres to fit on $w
15311 $xres = $max_xres;
15312 }
15315 $hpadding = 10 * $xres;
15317 $vpadding = ($hpadding / 2);
15318 }
15319 }
15320 }
15322 $wold = $w;
15326 case 'L': {
15327 if ($this->rtl) {
15329 }
15330 break;
15331 }
15332 case 'R': {
15333 if (!$this->rtl) {
15335 }
15336 break;
15337 }
15338 case 'C': {
15339 if ($this->rtl) {
15341 } else {
15343 }
15344 break;
15345 }
15346 default : {
15347 break;
15348 }
15349 }
15350 }
15351 }
15352 $text_height = $this->getCellHeight($fontsize / $this->k);
15353 // height
15355 // set default height
15357 }
15358 $barh = $h - $text_height - (2 * $vpadding);
15359 if ($barh <=0) {
15360 // try to reduce font or padding to fit barcode on available height
15363 $text_height = $this->getCellHeight($fontsize / $this->k);
15365 }
15366 if ($vpadding > 0) {
15367 $vpadding = (($h - $text_height) / 4);
15368 }
15369 $barh = $h - $text_height - (2 * $vpadding);
15370 }
15371 // fit the barcode on available space
15373 // set alignment
15375 // set alignment
15376 if ($this->rtl) {
15378 $xpos = $this->lMargin;
15380 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15382 $xpos = $this->w - $this->rMargin - $w;
15383 } else {
15385 }
15386 $this->img_rb_x = $xpos;
15387 } else {
15389 $xpos = $this->lMargin;
15391 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15393 $xpos = $this->w - $this->rMargin - $w;
15394 } else {
15395 $xpos = $x;
15396 }
15397 $this->img_rb_x = $xpos + $w;
15398 }
15399 $xpos_rect = $xpos;
15402 }
15404 case 'L': {
15405 $xpos = $xpos_rect + $hpadding;
15406 break;
15407 }
15408 case 'R': {
15410 break;
15411 }
15412 case 'C':
15413 default : {
15415 break;
15416 }
15417 }
15418 $xpos_text = $xpos;
15419 // barcode is always printed in LTR direction
15420 $tempRTL = $this->rtl;
15421 $this->rtl = false;
15422 // print background color
15427 }
15428 // set foreground color
15431 // print bars
15433 $bw = ($v['w'] * $xres);
15434 if ($v['t']) {
15435 // draw a vertical bar
15437 $this->Rect($xpos, $ypos, $bw, ($v['h'] * $barh / $arrcode['maxh']), 'F', array(), $style['fgcolor']);
15438 }
15439 $xpos += $bw;
15440 }
15441 // print text
15445 } else {
15446 $label = $code;
15447 }
15448 $txtwidth = ($arrcode['maxw'] * $xres);
15451 }
15452 // print text
15453 $this->x = $xpos_text;
15454 $this->y = $y + $vpadding + $barh;
15455 $cellpadding = $this->cell_padding;
15456 $this->SetCellPadding(0);
15457 $this->Cell($txtwidth, '', $label, 0, 0, 'C', false, '', $style['stretchtext'], false, 'T', 'T');
15458 $this->cell_padding = $cellpadding;
15459 }
15460 // restore original direction
15461 $this->rtl = $tempRTL;
15462 // restore previous settings
15463 $this->setGraphicVars($gvars);
15464 // set pointer to align the next text/objects
15465 switch($align) {
15466 case 'T':{
15467 $this->y = $y;
15468 $this->x = $this->img_rb_x;
15469 break;
15470 }
15471 case 'M':{
15473 $this->x = $this->img_rb_x;
15474 break;
15475 }
15476 case 'B':{
15477 $this->y = $this->img_rb_y;
15478 $this->x = $this->img_rb_x;
15479 break;
15480 }
15481 case 'N':{
15482 $this->SetY($this->img_rb_y);
15483 break;
15484 }
15485 default:{
15486 break;
15487 }
15488 }
15489 $this->endlinex = $this->img_rb_x;
15490 }
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 15517 of file tcpdf.php.
15517 {
15519 return;
15520 }
15521 require_once(dirname(__FILE__).'/tcpdf_barcodes_2d.php');
15522 // save current graphic settings
15523 $gvars = $this->getGraphicVars();
15524 // create new barcode object
15526 $arrcode = $barcodeobj->getBarcodeArray();
15527 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)) {
15529 }
15530 // set default values
15533 }
15536 }
15539 }
15542 }
15543 // padding
15548 }
15553 }
15558 }
15561 // cell (module) dimension
15564 }
15567 }
15570 }
15573 }
15574 // check page for no-write regions and adapt page margins if necessary
15576 // number of barcode columns and rows
15577 $rows = $arrcode['num_rows'];
15578 $cols = $arrcode['num_cols'];
15579 if (($rows <= 0) || ($cols <= 0)){
15581 }
15582 // module width and height
15585 if (($mw <= 0) OR ($mh <= 0)) {
15587 }
15588 // get max dimensions
15589 if ($this->rtl) {
15591 } else {
15592 $maxw = $this->w - $this->rMargin - $x;
15593 }
15594 $maxh = ($this->h - $this->tMargin - $this->bMargin);
15595 $ratioHW = ((($rows * $mh) + $hpad) / (($cols * $mw) + $vpad));
15596 $ratioWH = ((($cols * $mw) + $vpad) / (($rows * $mh) + $hpad));
15597 if (!$distort) {
15598 if (($maxw * $ratioHW) > $maxh) {
15599 $maxw = $maxh * $ratioWH;
15600 }
15601 if (($maxh * $ratioWH) > $maxw) {
15602 $maxh = $maxw * $ratioHW;
15603 }
15604 }
15605 // set maximum dimensions
15607 $w = $maxw;
15608 }
15610 $h = $maxh;
15611 }
15612 // set dimensions
15614 $w = ($cols + $hpad) * ($mw / $this->k);
15615 $h = ($rows + $vpad) * ($mh / $this->k);
15620 }
15621 // barcode size (excluding padding)
15622 $bw = ($w * $cols) / ($cols + $hpad);
15623 $bh = ($h * $rows) / ($rows + $vpad);
15624 // dimension of single barcode cell unit
15625 $cw = $bw / $cols;
15626 $ch = $bh / $rows;
15627 if (!$distort) {
15628 if (($cw / $ch) > ($mw / $mh)) {
15629 // correct horizontal distortion
15630 $cw = $ch * $mw / $mh;
15631 $bw = $cw * $cols;
15633 } else {
15634 // correct vertical distortion
15635 $ch = $cw * $mh / $mw;
15636 $bh = $ch * $rows;
15638 }
15639 }
15640 // fit the barcode on available space
15642 // set alignment
15644 // set alignment
15645 if ($this->rtl) {
15647 $xpos = $this->lMargin;
15649 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15651 $xpos = $this->w - $this->rMargin - $w;
15652 } else {
15654 }
15655 $this->img_rb_x = $xpos;
15656 } else {
15658 $xpos = $this->lMargin;
15660 $xpos = ($this->w + $this->lMargin - $this->rMargin - $w) / 2;
15662 $xpos = $this->w - $this->rMargin - $w;
15663 } else {
15664 $xpos = $x;
15665 }
15666 $this->img_rb_x = $xpos + $w;
15667 }
15670 // barcode is always printed in LTR direction
15671 $tempRTL = $this->rtl;
15672 $this->rtl = false;
15673 // print background color
15678 }
15679 // set foreground color
15681 // print barcode cells
15682 // for each row
15684 $xr = $xstart;
15685 // for each column
15686 for ($c = 0; $c < $cols; ++$c) {
15688 // draw a single barcode cell
15690 }
15691 $xr += $cw;
15692 }
15693 $ystart += $ch;
15694 }
15695 // restore original direction
15696 $this->rtl = $tempRTL;
15697 // restore previous settings
15698 $this->setGraphicVars($gvars);
15699 // set pointer to align the next text/objects
15700 switch($align) {
15701 case 'T':{
15702 $this->y = $y;
15703 $this->x = $this->img_rb_x;
15704 break;
15705 }
15706 case 'M':{
15708 $this->x = $this->img_rb_x;
15709 break;
15710 }
15711 case 'B':{
15712 $this->y = $this->img_rb_y;
15713 $this->x = $this->img_rb_x;
15714 break;
15715 }
15716 case 'N':{
15717 $this->SetY($this->img_rb_y);
15718 break;
15719 }
15720 default:{
15721 break;
15722 }
15723 }
15724 $this->endlinex = $this->img_rb_x;
15725 }
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 17121 of file tcpdf.php.
17121 {
17122 $gvars = $this->getGraphicVars();
17123 // store current values
17124 $prev_cell_margin = $this->cell_margin;
17125 $prev_cell_padding = $this->cell_padding;
17126 $prevPage = $this->page;
17127 $prevlMargin = $this->lMargin;
17128 $prevrMargin = $this->rMargin;
17129 $curfontname = $this->FontFamily;
17130 $curfontstyle = $this->FontStyle;
17131 $curfontsize = $this->FontSizePt;
17132 $curfontascent = $this->getFontAscent($curfontname, $curfontstyle, $curfontsize);
17133 $curfontdescent = $this->getFontDescent($curfontname, $curfontstyle, $curfontsize);
17134 $curfontstretcing = $this->font_stretching;
17135 $curfonttracking = $this->font_spacing;
17136 $this->newline = true;
17138 $startlinepage = $this->page;
17139 $minstartliney = $this->y;
17140 $maxbottomliney = 0;
17141 $startlinex = $this->x;
17142 $startliney = $this->y;
17143 $yshift = 0;
17144 $loop = 0;
17145 $curpos = 0;
17146 $this_method_vars = array();
17147 $undo = false;
17148 $fontaligned = false;
17149 $reverse_dir = false; // true when the text direction is reversed
17150 $this->premode = false;
17151 if ($this->inxobj) {
17152 // we are inside an XObject template
17153 $pask = count($this->xobjects[$this->xobjid]['annotations']);
17154 } elseif (isset($this->PageAnnots[$this->page])) {
17155 $pask = count($this->PageAnnots[$this->page]);
17156 } else {
17157 $pask = 0;
17158 }
17159 if ($this->inxobj) {
17160 // we are inside an XObject template
17161 $startlinepos = strlen($this->xobjects[$this->xobjid]['outdata']);
17162 } elseif (!$this->InFooter) {
17163 if (isset($this->footerlen[$this->page])) {
17165 } else {
17167 }
17168 $startlinepos = $this->footerpos[$this->page];
17169 } else {
17170 // we are inside the footer
17171 $startlinepos = $this->pagelen[$this->page];
17172 }
17173 $lalign = $align;
17174 $plalign = $align;
17175 if ($this->rtl) {
17177 } else {
17179 }
17181 if ($cell) {
17182 if ($this->rtl) {
17183 $this->x -= $this->cell_padding['R'];
17184 $this->lMargin += $this->cell_padding['R'];
17185 } else {
17186 $this->x += $this->cell_padding['L'];
17187 $this->rMargin += $this->cell_padding['L'];
17188 }
17189 }
17190 if ($this->customlistindent >= 0) {
17191 $this->listindent = $this->customlistindent;
17192 } else {
17194 }
17195 $this->listindentlevel = 0;
17196 // save previous states
17197 $prev_cell_height_ratio = $this->cell_height_ratio;
17198 $prev_listnum = $this->listnum;
17199 $prev_listordered = $this->listordered;
17200 $prev_listcount = $this->listcount;
17201 $prev_lispacer = $this->lispacer;
17202 $this->listnum = 0;
17203 $this->listordered = array();
17204 $this->listcount = array();
17205 $this->lispacer = '';
17207 // reset row height
17208 $this->resetLastH();
17209 }
17211 $maxel = count($dom);
17212 $key = 0;
17213 while ($key < $maxel) {
17214 if ($dom[$key]['tag'] AND $dom[$key]['opening'] AND $dom[$key]['hide']) {
17215 // store the node key
17216 $hidden_node_key = $key;
17217 if ($dom[$key]['self']) {
17218 // skip just this self-closing tag
17219 ++$key;
17220 } else {
17221 // skip this and all children tags
17222 while (($key < $maxel) AND (!$dom[$key]['tag'] OR $dom[$key]['opening'] OR ($dom[$key]['parent'] != $hidden_node_key))) {
17223 // skip hidden objects
17224 ++$key;
17225 }
17226 ++$key;
17227 }
17228 }
17229 if ($dom[$key]['tag'] AND isset($dom[$key]['attribute']['pagebreak'])) {
17230 // check for pagebreak
17231 if (($dom[$key]['attribute']['pagebreak'] == 'true') OR ($dom[$key]['attribute']['pagebreak'] == 'left') OR ($dom[$key]['attribute']['pagebreak'] == 'right')) {
17232 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17233 $this->checkPageBreak($this->PageBreakTrigger + 1);
17234 $this->htmlvspace = ($this->PageBreakTrigger + 1);
17235 }
17236 if ((($dom[$key]['attribute']['pagebreak'] == 'left') AND (((!$this->rtl) AND (($this->page % 2) == 0)) OR (($this->rtl) AND (($this->page % 2) != 0))))
17237 OR (($dom[$key]['attribute']['pagebreak'] == 'right') AND (((!$this->rtl) AND (($this->page % 2) != 0)) OR (($this->rtl) AND (($this->page % 2) == 0))))) {
17238 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17239 $this->checkPageBreak($this->PageBreakTrigger + 1);
17240 $this->htmlvspace = ($this->PageBreakTrigger + 1);
17241 }
17242 }
17243 if ($dom[$key]['tag'] AND $dom[$key]['opening'] AND isset($dom[$key]['attribute']['nobr']) AND ($dom[$key]['attribute']['nobr'] == 'true')) {
17244 if (isset($dom[($dom[$key]['parent'])]['attribute']['nobr']) AND ($dom[($dom[$key]['parent'])]['attribute']['nobr'] == 'true')) {
17245 $dom[$key]['attribute']['nobr'] = false;
17246 } else {
17247 // store current object
17248 $this->startTransaction();
17249 // save this method vars
17251 $this_method_vars['ln'] = $ln;
17252 $this_method_vars['fill'] = $fill;
17253 $this_method_vars['reseth'] = $reseth;
17254 $this_method_vars['cell'] = $cell;
17255 $this_method_vars['align'] = $align;
17256 $this_method_vars['gvars'] = $gvars;
17257 $this_method_vars['prevPage'] = $prevPage;
17258 $this_method_vars['prev_cell_margin'] = $prev_cell_margin;
17259 $this_method_vars['prev_cell_padding'] = $prev_cell_padding;
17260 $this_method_vars['prevlMargin'] = $prevlMargin;
17261 $this_method_vars['prevrMargin'] = $prevrMargin;
17262 $this_method_vars['curfontname'] = $curfontname;
17263 $this_method_vars['curfontstyle'] = $curfontstyle;
17264 $this_method_vars['curfontsize'] = $curfontsize;
17265 $this_method_vars['curfontascent'] = $curfontascent;
17266 $this_method_vars['curfontdescent'] = $curfontdescent;
17267 $this_method_vars['curfontstretcing'] = $curfontstretcing;
17268 $this_method_vars['curfonttracking'] = $curfonttracking;
17269 $this_method_vars['minstartliney'] = $minstartliney;
17270 $this_method_vars['maxbottomliney'] = $maxbottomliney;
17271 $this_method_vars['yshift'] = $yshift;
17272 $this_method_vars['startlinepage'] = $startlinepage;
17273 $this_method_vars['startlinepos'] = $startlinepos;
17274 $this_method_vars['startlinex'] = $startlinex;
17275 $this_method_vars['startliney'] = $startliney;
17277 $this_method_vars['loop'] = $loop;
17278 $this_method_vars['curpos'] = $curpos;
17279 $this_method_vars['pask'] = $pask;
17280 $this_method_vars['lalign'] = $lalign;
17281 $this_method_vars['plalign'] = $plalign;
17283 $this_method_vars['prev_cell_height_ratio'] = $prev_cell_height_ratio;
17284 $this_method_vars['prev_listnum'] = $prev_listnum;
17285 $this_method_vars['prev_listordered'] = $prev_listordered;
17286 $this_method_vars['prev_listcount'] = $prev_listcount;
17287 $this_method_vars['prev_lispacer'] = $prev_lispacer;
17288 $this_method_vars['fontaligned'] = $fontaligned;
17289 $this_method_vars['key'] = $key;
17290 $this_method_vars['dom'] = $dom;
17291 }
17292 }
17293 // print THEAD block
17294 if (($dom[$key]['value'] == 'tr') AND isset($dom[$key]['thead']) AND $dom[$key]['thead']) {
17295 if (isset($dom[$key]['parent']) AND isset($dom[$dom[$key]['parent']]['thead']) AND !TCPDF_STATIC::empty_string($dom[$dom[$key]['parent']]['thead'])) {
17296 $this->inthead = true;
17297 // print table header (thead)
17299 // check if we are on a new page or on a new column
17300 if (($this->y < $this->start_transaction_y) OR ($this->checkPageBreak($this->lasth, '', false))) {
17301 // we are on a new page or on a new column and the total object height is less than the available vertical space.
17302 // restore previous object
17304 // restore previous values
17305 foreach ($this_method_vars as $vkey => $vval) {
17306 $$vkey = $vval;
17307 }
17308 // disable table header
17309 $tmp_thead = $this->thead;
17310 $this->thead = '';
17311 // add a page (or trig AcceptPageBreak() for multicolumn mode)
17312 $pre_y = $this->y;
17314 // fix for multicolumn mode
17315 $startliney = $this->y;
17316 }
17317 $this->start_transaction_page = $this->page;
17318 $this->start_transaction_y = $this->y;
17319 // restore table header
17320 $this->thead = $tmp_thead;
17321 // fix table border properties
17322 if (isset($dom[$dom[$key]['parent']]['attribute']['cellspacing'])) {
17323 $tmp_cellspacing = $this->getHTMLUnitToUnits($dom[$dom[$key]['parent']]['attribute']['cellspacing'], 1, 'px');
17324 } elseif (isset($dom[$dom[$key]['parent']]['border-spacing'])) {
17325 $tmp_cellspacing = $dom[$dom[$key]['parent']]['border-spacing']['V'];
17326 } else {
17327 $tmp_cellspacing = 0;
17328 }
17331 $dom[$dom[$key]['parent']]['borderposition']['y'] = $this->y + $tmp_cellspacing;
17332 $xoffset = ($this->x - $dom[$dom[$key]['parent']]['borderposition']['x']);
17333 $dom[$dom[$key]['parent']]['borderposition']['x'] += $xoffset;
17334 $dom[$dom[$key]['parent']]['borderposition']['xmax'] += $xoffset;
17335 // print table header (thead)
17337 }
17338 }
17339 // move $key index forward to skip THEAD block
17340 while ( ($key < $maxel) AND (!(
17341 ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'tr') AND (!isset($dom[$key]['thead']) OR !$dom[$key]['thead']))
17342 OR ($dom[$key]['tag'] AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == 'table'))) )) {
17343 ++$key;
17344 }
17345 }
17346 if ($dom[$key]['tag'] OR ($key == 0)) {
17347 if ((($dom[$key]['value'] == 'table') OR ($dom[$key]['value'] == 'tr')) AND (isset($dom[$key]['align']))) {
17349 }
17350 // vertically align image in line
17351 if ((!$this->newline) AND ($dom[$key]['value'] == 'img') AND (isset($dom[$key]['height'])) AND ($dom[$key]['height'] > 0)) {
17352 // get image height
17353 $imgh = $this->getHTMLUnitToUnits($dom[$key]['height'], ($dom[$key]['fontsize'] / $this->k), 'px');
17354 $autolinebreak = false;
17355 if (!empty($dom[$key]['width'])) {
17356 $imgw = $this->getHTMLUnitToUnits($dom[$key]['width'], ($dom[$key]['fontsize'] / $this->k), 'px', false);
17357 if (($imgw <= ($this->w - $this->lMargin - $this->rMargin - $this->cell_padding['L'] - $this->cell_padding['R']))
17358 AND ((($this->rtl) AND (($this->x - $imgw) < ($this->lMargin + $this->cell_padding['L'])))
17359 OR ((!$this->rtl) AND (($this->x + $imgw) > ($this->w - $this->rMargin - $this->cell_padding['R']))))) {
17360 // add automatic line break
17361 $autolinebreak = true;
17363 if ((!$dom[($key-1)]['tag']) AND ($dom[($key-1)]['value'] == ' ')) {
17364 // go back to evaluate this line break
17365 --$key;
17366 }
17367 }
17368 }
17369 if (!$autolinebreak) {
17371 $pre_y = $this->y;
17372 // check for page break
17374 // fix for multicolumn mode
17375 $startliney = $this->y;
17376 }
17377 }
17378 if ($this->page > $startlinepage) {
17379 // fix line splitted over two pages
17380 if (isset($this->footerlen[$startlinepage])) {
17381 $curpos = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17382 }
17383 // line to be moved one page forward
17384 $pagebuff = $this->getPageBuffer($startlinepage);
17385 $linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
17386 $tstart = substr($pagebuff, 0, $startlinepos);
17387 $tend = substr($this->getPageBuffer($startlinepage), $curpos);
17388 // remove line from previous page
17390 $pagebuff = $this->getPageBuffer($this->page);
17391 $tstart = substr($pagebuff, 0, $this->cntmrk[$this->page]);
17392 $tend = substr($pagebuff, $this->cntmrk[$this->page]);
17393 // add line start to current page
17394 $yshift = ($minstartliney - $this->y);
17395 if ($fontaligned) {
17396 $yshift += ($curfontsize / $this->k);
17397 }
17398 $try = sprintf('1 0 0 1 0 %F cm', ($yshift * $this->k));
17400 // shift the annotations and links
17401 if (isset($this->PageAnnots[$this->page])) {
17402 $next_pask = count($this->PageAnnots[$this->page]);
17403 } else {
17404 $next_pask = 0;
17405 }
17406 if (isset($this->PageAnnots[$startlinepage])) {
17407 foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
17408 if ($pak >= $pask) {
17409 $this->PageAnnots[$this->page][] = $pac;
17410 unset($this->PageAnnots[$startlinepage][$pak]);
17411 $npak = count($this->PageAnnots[$this->page]) - 1;
17413 }
17414 }
17415 }
17416 $pask = $next_pask;
17417 $startlinepos = $this->cntmrk[$this->page];
17418 $startlinepage = $this->page;
17419 $startliney = $this->y;
17420 $this->newline = false;
17421 }
17422 $this->y += ($this->getCellHeight($curfontsize / $this->k) - ($curfontdescent * $this->cell_height_ratio) - $imgh);
17423 $minstartliney = min($this->y, $minstartliney);
17424 $maxbottomliney = ($startliney + $this->getCellHeight($curfontsize / $this->k));
17425 }
17426 } elseif (isset($dom[$key]['fontname']) OR isset($dom[$key]['fontstyle']) OR isset($dom[$key]['fontsize']) OR isset($dom[$key]['line-height'])) {
17427 // account for different font size
17428 $pfontname = $curfontname;
17429 $pfontstyle = $curfontstyle;
17430 $pfontsize = $curfontsize;
17431 $fontname = (isset($dom[$key]['fontname']) ? $dom[$key]['fontname'] : $curfontname);
17432 $fontstyle = (isset($dom[$key]['fontstyle']) ? $dom[$key]['fontstyle'] : $curfontstyle);
17433 $fontsize = (isset($dom[$key]['fontsize']) ? $dom[$key]['fontsize'] : $curfontsize);
17434 $fontascent = $this->getFontAscent($fontname, $fontstyle, $fontsize);
17435 $fontdescent = $this->getFontDescent($fontname, $fontstyle, $fontsize);
17436 if (($fontname != $curfontname) OR ($fontstyle != $curfontstyle) OR ($fontsize != $curfontsize)
17437 OR ($this->cell_height_ratio != $dom[$key]['line-height'])
17438 OR ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'li')) ) {
17439 if (($key < ($maxel - 1)) AND (
17440 ($dom[$key]['tag'] AND $dom[$key]['opening'] AND ($dom[$key]['value'] == 'li'))
17441 OR ($this->cell_height_ratio != $dom[$key]['line-height'])
17442 OR (!$this->newline AND is_numeric($fontsize) AND is_numeric($curfontsize)
17443 AND ($fontsize >= 0) AND ($curfontsize >= 0)
17444 AND (($fontsize != $curfontsize) OR ($fontstyle != $curfontstyle) OR ($fontname != $curfontname)))
17445 )) {
17446 if ($this->page > $startlinepage) {
17447 // fix lines splitted over two pages
17448 if (isset($this->footerlen[$startlinepage])) {
17449 $curpos = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17450 }
17451 // line to be moved one page forward
17452 $pagebuff = $this->getPageBuffer($startlinepage);
17453 $linebeg = substr($pagebuff, $startlinepos, ($curpos - $startlinepos));
17454 $tstart = substr($pagebuff, 0, $startlinepos);
17455 $tend = substr($this->getPageBuffer($startlinepage), $curpos);
17456 // remove line start from previous page
17458 $pagebuff = $this->getPageBuffer($this->page);
17459 $tstart = substr($pagebuff, 0, $this->cntmrk[$this->page]);
17460 $tend = substr($pagebuff, $this->cntmrk[$this->page]);
17461 // add line start to current page
17462 $yshift = ($minstartliney - $this->y);
17463 $try = sprintf('1 0 0 1 0 %F cm', ($yshift * $this->k));
17465 // shift the annotations and links
17466 if (isset($this->PageAnnots[$this->page])) {
17467 $next_pask = count($this->PageAnnots[$this->page]);
17468 } else {
17469 $next_pask = 0;
17470 }
17471 if (isset($this->PageAnnots[$startlinepage])) {
17472 foreach ($this->PageAnnots[$startlinepage] as $pak => $pac) {
17473 if ($pak >= $pask) {
17474 $this->PageAnnots[$this->page][] = $pac;
17475 unset($this->PageAnnots[$startlinepage][$pak]);
17476 $npak = count($this->PageAnnots[$this->page]) - 1;
17478 }
17479 }
17480 }
17481 $pask = $next_pask;
17482 $startlinepos = $this->cntmrk[$this->page];
17483 $startlinepage = $this->page;
17484 $startliney = $this->y;
17485 }
17486 if (!isset($dom[$key]['line-height'])) {
17488 }
17489 if (!$dom[$key]['block']) {
17490 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']))) {
17491 $this->y += (((($curfontsize * $this->cell_height_ratio) - ($fontsize * $dom[$key]['line-height'])) / $this->k) + $curfontascent - $fontascent - $curfontdescent + $fontdescent) / 2;
17492 }
17493 if (($dom[$key]['value'] != 'sup') AND ($dom[$key]['value'] != 'sub')) {
17494 $current_line_align_data = array($key, $minstartliney, $maxbottomliney);
17495 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)))) {
17496 $minstartliney = min($this->y, $line_align_data[1]);
17497 $maxbottomliney = max(($this->y + $this->getCellHeight($fontsize / $this->k)), $line_align_data[2]);
17498 } else {
17499 $minstartliney = min($this->y, $minstartliney);
17500 $maxbottomliney = max(($this->y + $this->getCellHeight($fontsize / $this->k)), $maxbottomliney);
17501 }
17502 $line_align_data = $current_line_align_data;
17503 }
17504 }
17505 $this->cell_height_ratio = $dom[$key]['line-height'];
17506 $fontaligned = true;
17507 }
17508 $this->SetFont($fontname, $fontstyle, $fontsize);
17509 // reset row height
17510 $this->resetLastH();
17511 $curfontname = $fontname;
17512 $curfontstyle = $fontstyle;
17513 $curfontsize = $fontsize;
17514 $curfontascent = $fontascent;
17515 $curfontdescent = $fontdescent;
17516 }
17517 }
17518 // set text rendering mode
17520 $textfill = isset($dom[$key]['fill']) ? $dom[$key]['fill'] : (($this->textrendermode % 2) == 0);
17521 $textclip = isset($dom[$key]['clip']) ? $dom[$key]['clip'] : ($this->textrendermode > 3);
17522 $this->setTextRenderingMode($textstroke, $textfill, $textclip);
17523 if (isset($dom[$key]['font-stretch']) AND ($dom[$key]['font-stretch'] !== false)) {
17525 }
17526 if (isset($dom[$key]['letter-spacing']) AND ($dom[$key]['letter-spacing'] !== false)) {
17528 }
17529 if (($plalign == 'J') AND $dom[$key]['block']) {
17530 $plalign = '';
17531 }
17532 // get current position on page buffer
17533 $curpos = $this->pagelen[$startlinepage];
17534 if (isset($dom[$key]['bgcolor']) AND ($dom[$key]['bgcolor'] !== false)) {
17536 $wfill = true;
17537 } else {
17538 $wfill = $fill | false;
17539 }
17540 if (isset($dom[$key]['fgcolor']) AND ($dom[$key]['fgcolor'] !== false)) {
17542 }
17543 if (isset($dom[$key]['strokecolor']) AND ($dom[$key]['strokecolor'] !== false)) {
17545 }
17546 if (isset($dom[$key]['align'])) {
17547 $lalign = $dom[$key]['align'];
17548 }
17550 $lalign = $align;
17551 }
17552 }
17553 // align lines
17554 if ($this->newline AND (strlen($dom[$key]['value']) > 0) AND ($dom[$key]['value'] != 'td') AND ($dom[$key]['value'] != 'th')) {
17556 $fontaligned = false;
17557 // we are at the beginning of a new line
17558 if (isset($startlinex)) {
17559 $yshift = ($minstartliney - $startliney);
17560 if (($yshift > 0) OR ($this->page > $startlinepage)) {
17561 $yshift = 0;
17562 }
17563 $t_x = 0;
17564 // the last line must be shifted to be aligned as requested
17565 $linew = abs($this->endlinex - $startlinex);
17566 if ($this->inxobj) {
17567 // we are inside an XObject template
17568 $pstart = substr($this->xobjects[$this->xobjid]['outdata'], 0, $startlinepos);
17569 if (isset($opentagpos)) {
17570 $midpos = $opentagpos;
17571 } else {
17572 $midpos = 0;
17573 }
17574 if ($midpos > 0) {
17575 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
17576 $pend = substr($this->xobjects[$this->xobjid]['outdata'], $midpos);
17577 } else {
17578 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos);
17579 $pend = '';
17580 }
17581 } else {
17582 $pstart = substr($this->getPageBuffer($startlinepage), 0, $startlinepos);
17583 if (isset($opentagpos) AND isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
17584 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17585 $midpos = min($opentagpos, $this->footerpos[$startlinepage]);
17586 } elseif (isset($opentagpos)) {
17587 $midpos = $opentagpos;
17588 } elseif (isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
17589 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
17590 $midpos = $this->footerpos[$startlinepage];
17591 } else {
17592 $midpos = 0;
17593 }
17594 if ($midpos > 0) {
17595 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
17596 $pend = substr($this->getPageBuffer($startlinepage), $midpos);
17597 } else {
17598 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos);
17599 $pend = '';
17600 }
17601 }
17602 if ((isset($plalign) AND ((($plalign == 'C') OR ($plalign == 'J') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
17603 // calculate shifting amount
17604 $tw = $w;
17606 $tw += $this->cell_padding['R'];
17607 }
17608 if ($this->lMargin != $prevlMargin) {
17609 $tw += ($prevlMargin - $this->lMargin);
17610 }
17611 if ($this->rMargin != $prevrMargin) {
17612 $tw += ($prevrMargin - $this->rMargin);
17613 }
17614 $one_space_width = $this->GetStringWidth(chr(32));
17615 $no = 0; // number of spaces on a line contained on a single block
17617 // remove left space if exist
17619 if ($pos1 > 0) {
17620 $pos1 = intval($pos1);
17623 $spacelen = 2;
17624 } else {
17626 $spacelen = 1;
17627 }
17628 if ($pos1 == $pos2) {
17629 $pmid = substr($pmid, 0, ($pos1 + 2)).substr($pmid, ($pos1 + 2 + $spacelen));
17630 if (substr($pmid, $pos1, 4) == '[()]') {
17631 $linew -= $one_space_width;
17632 } elseif ($pos1 == strpos($pmid, '[(')) {
17633 $no = 1;
17634 }
17635 }
17636 }
17637 } else { // LTR
17638 // remove right space if exist
17640 if ($pos1 > 0) {
17641 $pos1 = intval($pos1);
17644 $spacelen = 2;
17645 } else {
17647 $spacelen = 1;
17648 }
17649 if ($pos1 == $pos2) {
17650 $pmid = substr($pmid, 0, ($pos1 - $spacelen)).substr($pmid, $pos1);
17651 $linew -= $one_space_width;
17652 }
17653 }
17654 }
17655 $mdiff = ($tw - $linew);
17656 if ($plalign == 'C') {
17657 if ($this->rtl) {
17658 $t_x = -($mdiff / 2);
17659 } else {
17660 $t_x = ($mdiff / 2);
17661 }
17662 } elseif ($plalign == 'R') {
17663 // right alignment on LTR document
17664 $t_x = $mdiff;
17665 } elseif ($plalign == 'L') {
17666 // left alignment on RTL document
17667 $t_x = -$mdiff;
17668 } elseif (($plalign == 'J') AND ($plalign == $lalign)) {
17669 // Justification
17671 // align text on the left
17672 $t_x = -$mdiff;
17673 }
17674 $ns = 0; // number of spaces
17675 $pmidtemp = $pmid;
17676 // escape special characters
17677 $pmidtemp = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmidtemp);
17678 $pmidtemp = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmidtemp);
17679 // search spaces
17680 if (preg_match_all('/\[\(([^\)]*)\)\]/x', $pmidtemp, $lnstring, PREG_PATTERN_ORDER)) {
17681 $spacestr = $this->getSpaceString();
17682 $maxkk = count($lnstring[1]) - 1;
17683 for ($kk=0; $kk <= $maxkk; ++$kk) {
17684 // restore special characters
17685 $lnstring[1][$kk] = str_replace('#!#OP#!#', '(', $lnstring[1][$kk]);
17686 $lnstring[1][$kk] = str_replace('#!#CP#!#', ')', $lnstring[1][$kk]);
17687 // store number of spaces on the strings
17688 $lnstring[2][$kk] = substr_count($lnstring[1][$kk], $spacestr);
17689 // count total spaces on line
17690 $ns += $lnstring[2][$kk];
17691 $lnstring[3][$kk] = $ns;
17692 }
17693 if ($ns == 0) {
17694 $ns = 1;
17695 }
17696 // calculate additional space to add to each existing space
17697 $spacewidth = ($mdiff / ($ns - $no)) * $this->k;
17698 if ($this->FontSize <= 0) {
17699 $this->FontSize = 1;
17700 }
17701 $spacewidthu = -1000 * ($mdiff + (($ns + $no) * $one_space_width)) / $ns / $this->FontSize;
17702 if ($this->font_spacing != 0) {
17703 // fixed spacing mode
17704 $osw = -1000 * $this->font_spacing / $this->FontSize;
17705 $spacewidthu += $osw;
17706 }
17707 $nsmax = $ns;
17708 $ns = 0;
17709 reset($lnstring);
17710 $offset = 0;
17711 $strcount = 0;
17712 $prev_epsposbeg = 0;
17713 $textpos = 0;
17715 $textpos = $this->wPt;
17716 }
17717 while (preg_match('/([0-9\.\+\-]*)[\s](Td|cm|m|l|c|re)[\s]/x', $pmid, $strpiece, PREG_OFFSET_CAPTURE, $offset) == 1) {
17718 // check if we are inside a string section '[( ... )]'
17719 $stroffset = strpos($pmid, '[(', $offset);
17720 if (($stroffset !== false) AND ($stroffset <= $strpiece[2][1])) {
17721 // set offset to the end of string section
17722 $offset = strpos($pmid, ')]', $stroffset);
17723 while (($offset !== false) AND ($pmid[($offset - 1)] == '\\')) {
17724 $offset = strpos($pmid, ')]', ($offset + 1));
17725 }
17726 if ($offset === false) {
17728 }
17729 continue;
17730 }
17732 $spacew = ($spacewidth * ($nsmax - $ns));
17733 } else {
17734 $spacew = ($spacewidth * $ns);
17735 }
17736 $offset = $strpiece[2][1] + strlen($strpiece[2][0]);
17737 $epsposend = strpos($pmid, $this->epsmarker.'Q', $offset);
17738 if ($epsposend !== null) {
17739 $epsposend += strlen($this->epsmarker.'Q');
17740 $epsposbeg = strpos($pmid, 'q'.$this->epsmarker, $offset);
17741 if ($epsposbeg === null) {
17742 $epsposbeg = strpos($pmid, 'q'.$this->epsmarker, ($prev_epsposbeg - 6));
17743 $prev_epsposbeg = $epsposbeg;
17744 }
17745 if (($epsposbeg > 0) AND ($epsposend > 0) AND ($offset > $epsposbeg) AND ($offset < $epsposend)) {
17746 // shift EPS images
17747 $trx = sprintf('1 0 0 1 %F 0 cm', $spacew);
17748 $pmid_b = substr($pmid, 0, $epsposbeg);
17749 $pmid_m = substr($pmid, $epsposbeg, ($epsposend - $epsposbeg));
17750 $pmid_e = substr($pmid, $epsposend);
17751 $pmid = $pmid_b."\nq\n".$trx."\n".$pmid_m."\nQ\n".$pmid_e;
17752 $offset = $epsposend;
17753 continue;
17754 }
17755 }
17756 $currentxpos = 0;
17757 // shift blocks of code
17758 switch ($strpiece[2][0]) {
17759 case 'Td':
17760 case 'cm':
17761 case 'm':
17762 case 'l': {
17763 // get current X position
17764 preg_match('/([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s]('.$strpiece[2][0].')([\s]*)/x', $pmid, $xmatches);
17765 if (!isset($xmatches[1])) {
17766 break;
17767 }
17768 $currentxpos = $xmatches[1];
17769 $textpos = $currentxpos;
17770 if (($strcount <= $maxkk) AND ($strpiece[2][0] == 'Td')) {
17771 $ns = $lnstring[3][$strcount];
17773 $spacew = ($spacewidth * ($nsmax - $ns));
17774 }
17775 ++$strcount;
17776 }
17777 // justify block
17778 if (preg_match('/([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s]('.$strpiece[2][0].')([\s]*)/x', $pmid, $pmatch) == 1) {
17779 $newpmid = sprintf('%F',(floatval($pmatch[1]) + $spacew)).' '.$pmatch[2].' x*#!#*x'.$pmatch[3].$pmatch[4];
17780 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17781 unset($pmatch, $newpmid);
17782 }
17783 break;
17784 }
17785 case 're': {
17786 // justify block
17788 $this->lispacer = '';
17789 continue;
17790 }
17791 preg_match('/([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]([0-9\.\+\-]*)[\s]('.$strpiece[1][0].')[\s](re)([\s]*)/x', $pmid, $xmatches);
17792 if (!isset($xmatches[1])) {
17793 break;
17794 }
17795 $currentxpos = $xmatches[1];
17796 $x_diff = 0;
17797 $w_diff = 0;
17799 if ($currentxpos < $textpos) {
17800 $x_diff = ($spacewidth * ($nsmax - $lnstring[3][$strcount]));
17801 $w_diff = ($spacewidth * $lnstring[2][$strcount]);
17802 } else {
17803 if ($strcount > 0) {
17804 $x_diff = ($spacewidth * ($nsmax - $lnstring[3][($strcount - 1)]));
17805 $w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
17806 }
17807 }
17808 } else { // LTR
17809 if ($currentxpos > $textpos) {
17810 if ($strcount > 0) {
17811 $x_diff = ($spacewidth * $lnstring[3][($strcount - 1)]);
17812 }
17813 $w_diff = ($spacewidth * $lnstring[2][$strcount]);
17814 } else {
17815 if ($strcount > 1) {
17816 $x_diff = ($spacewidth * $lnstring[3][($strcount - 2)]);
17817 }
17818 if ($strcount > 0) {
17819 $w_diff = ($spacewidth * $lnstring[2][($strcount - 1)]);
17820 }
17821 }
17822 }
17823 if (preg_match('/('.$xmatches[1].')[\s]('.$xmatches[2].')[\s]('.$xmatches[3].')[\s]('.$strpiece[1][0].')[\s](re)([\s]*)/x', $pmid, $pmatch) == 1) {
17824 $newx = sprintf('%F',(floatval($pmatch[1]) + $x_diff));
17825 $neww = sprintf('%F',(floatval($pmatch[3]) + $w_diff));
17826 $newpmid = $newx.' '.$pmatch[2].' '.$neww.' '.$pmatch[4].' x*#!#*x'.$pmatch[5].$pmatch[6];
17827 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17828 unset($pmatch, $newpmid, $newx, $neww);
17829 }
17830 break;
17831 }
17832 case 'c': {
17833 // get current X position
17834 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);
17835 if (!isset($xmatches[1])) {
17836 break;
17837 }
17838 $currentxpos = $xmatches[1];
17839 // justify block
17840 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) {
17841 $newx1 = sprintf('%F',(floatval($pmatch[1]) + $spacew));
17842 $newx2 = sprintf('%F',(floatval($pmatch[3]) + $spacew));
17843 $newx3 = sprintf('%F',(floatval($pmatch[5]) + $spacew));
17844 $newpmid = $newx1.' '.$pmatch[2].' '.$newx2.' '.$pmatch[4].' '.$newx3.' '.$pmatch[6].' x*#!#*x'.$pmatch[7].$pmatch[8];
17845 $pmid = str_replace($pmatch[0], $newpmid, $pmid);
17846 unset($pmatch, $newpmid, $newx1, $newx2, $newx3);
17847 }
17848 break;
17849 }
17850 }
17851 // shift the annotations and links
17852 $cxpos = ($currentxpos / $this->k);
17854 if ($this->inxobj) {
17855 // we are inside an XObject template
17856 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
17857 if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
17858 if ($cxpos > $lmpos) {
17860 $this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
17861 } else {
17862 $this->xobjects[$this->xobjid]['annotations'][$pak]['w'] += (($spacewidth * $pac['numspaces']) / $this->k);
17863 }
17864 break;
17865 }
17866 }
17867 } elseif (isset($this->PageAnnots[$this->page])) {
17868 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
17869 if (($pac['y'] >= $minstartliney) AND (($pac['x'] * $this->k) >= ($currentxpos - $this->feps)) AND (($pac['x'] * $this->k) <= ($currentxpos + $this->feps))) {
17870 if ($cxpos > $lmpos) {
17873 } else {
17875 }
17876 break;
17877 }
17878 }
17879 }
17880 } // end of while
17881 // remove markers
17882 $pmid = str_replace('x*#!#*x', '', $pmid);
17884 // multibyte characters
17885 $spacew = $spacewidthu;
17886 if ($this->font_stretching != 100) {
17887 // word spacing is affected by stretching
17888 $spacew /= ($this->font_stretching / 100);
17889 }
17890 // escape special characters
17891 $pos = 0;
17892 $pmid = preg_replace('/[\\\][\(]/x', '\\#!#OP#!#', $pmid);
17893 $pmid = preg_replace('/[\\\][\)]/x', '\\#!#CP#!#', $pmid);
17894 if (preg_match_all('/\[\(([^\)]*)\)\]/x', $pmid, $pamatch) > 0) {
17895 foreach($pamatch[0] as $pk => $pmatch) {
17896 $replace = $pamatch[1][$pk];
17897 $replace = str_replace('#!#OP#!#', '(', $replace);
17898 $replace = str_replace('#!#CP#!#', ')', $replace);
17899 $newpmid = '[('.str_replace(chr(0).chr(32), ') '.sprintf('%F', $spacew).' (', $replace).')]';
17900 $pos = strpos($pmid, $pmatch, $pos);
17901 if ($pos !== FALSE) {
17902 $pmid = substr_replace($pmid, $newpmid, $pos, strlen($pmatch));
17903 }
17904 ++$pos;
17905 }
17906 unset($pamatch);
17907 }
17908 if ($this->inxobj) {
17909 // we are inside an XObject template
17911 } else {
17913 }
17914 $endlinepos = strlen($pstart."\n".$pmid."\n");
17915 } else {
17916 // non-unicode (single-byte characters)
17917 if ($this->font_stretching != 100) {
17918 // word spacing (Tw) is affected by stretching
17919 $spacewidth /= ($this->font_stretching / 100);
17920 }
17921 $rs = sprintf('%F Tw', $spacewidth);
17922 $pmid = preg_replace("/\[\(/x", $rs.' [(', $pmid);
17923 if ($this->inxobj) {
17924 // we are inside an XObject template
17926 } else {
17928 }
17929 $endlinepos = strlen($pstart."\n".$pmid."\nBT 0 Tw ET\n");
17930 }
17931 }
17932 } // end of J
17933 } // end if $startlinex
17934 if (($t_x != 0) OR ($yshift < 0)) {
17935 // shift the line
17936 $trx = sprintf('1 0 0 1 %F %F cm', ($t_x * $this->k), ($yshift * $this->k));
17937 $pstart .= "\nq\n".$trx."\n".$pmid."\nQ\n";
17938 $endlinepos = strlen($pstart);
17939 if ($this->inxobj) {
17940 // we are inside an XObject template
17942 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
17943 if ($pak >= $pask) {
17946 }
17947 }
17948 } else {
17949 $this->setPageBuffer($startlinepage, $pstart.$pend);
17950 // shift the annotations and links
17951 if (isset($this->PageAnnots[$this->page])) {
17952 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
17953 if ($pak >= $pask) {
17956 }
17957 }
17958 }
17959 }
17960 $this->y -= $yshift;
17961 }
17962 }
17963 $pbrk = $this->checkPageBreak($this->lasth);
17964 $this->newline = false;
17965 $startlinex = $this->x;
17966 $startliney = $this->y;
17967 if ($dom[$dom[$key]['parent']]['value'] == 'sup') {
17968 $startliney -= ((0.3 * $this->FontSizePt) / $this->k);
17969 } elseif ($dom[$dom[$key]['parent']]['value'] == 'sub') {
17970 $startliney -= (($this->FontSizePt / 0.7) / $this->k);
17971 } else {
17972 $minstartliney = $startliney;
17973 $maxbottomliney = ($this->y + $this->getCellHeight($fontsize / $this->k));
17974 }
17975 $startlinepage = $this->page;
17976 if (isset($endlinepos) AND (!$pbrk)) {
17977 $startlinepos = $endlinepos;
17978 } else {
17979 if ($this->inxobj) {
17980 // we are inside an XObject template
17981 $startlinepos = strlen($this->xobjects[$this->xobjid]['outdata']);
17982 } elseif (!$this->InFooter) {
17983 if (isset($this->footerlen[$this->page])) {
17985 } else {
17987 }
17988 $startlinepos = $this->footerpos[$this->page];
17989 } else {
17990 $startlinepos = $this->pagelen[$this->page];
17991 }
17992 }
17993 unset($endlinepos);
17994 $plalign = $lalign;
17995 if (isset($this->PageAnnots[$this->page])) {
17996 $pask = count($this->PageAnnots[$this->page]);
17997 } else {
17998 $pask = 0;
17999 }
18000 if (!($dom[$key]['tag'] AND !$dom[$key]['opening'] AND ($dom[$key]['value'] == 'table')
18001 AND (isset($this->emptypagemrk[$this->page]))
18002 AND ($this->emptypagemrk[$this->page] == $this->pagelen[$this->page]))) {
18003 $this->SetFont($fontname, $fontstyle, $fontsize);
18004 if ($wfill) {
18005 $this->SetFillColorArray($this->bgcolor);
18006 }
18007 }
18008 } // end newline
18009 if (isset($opentagpos)) {
18010 unset($opentagpos);
18011 }
18012 if ($dom[$key]['tag']) {
18013 if ($dom[$key]['opening']) {
18014 // get text indentation (if any)
18015 if (isset($dom[$key]['text-indent']) AND $dom[$key]['block']) {
18016 $this->textindent = $dom[$key]['text-indent'];
18017 $this->newline = true;
18018 }
18019 // table
18020 if (($dom[$key]['value'] == 'table') AND isset($dom[$key]['cols']) AND ($dom[$key]['cols'] > 0)) {
18021 // available page width
18022 if ($this->rtl) {
18023 $wtmp = $this->x - $this->lMargin;
18024 } else {
18025 $wtmp = $this->w - $this->rMargin - $this->x;
18026 }
18027 // get cell spacing
18028 if (isset($dom[$key]['attribute']['cellspacing'])) {
18030 $cellspacing = array('H' => $clsp, 'V' => $clsp);
18031 } elseif (isset($dom[$key]['border-spacing'])) {
18032 $cellspacing = $dom[$key]['border-spacing'];
18033 } else {
18034 $cellspacing = array('H' => 0, 'V' => 0);
18035 }
18036 // table width
18037 if (isset($dom[$key]['width'])) {
18039 } else {
18040 $table_width = $wtmp;
18041 }
18042 $table_width -= (2 * $cellspacing['H']);
18043 if (!$this->inthead) {
18044 $this->y += $cellspacing['V'];
18045 }
18046 if ($this->rtl) {
18047 $cellspacingx = -$cellspacing['H'];
18048 } else {
18049 $cellspacingx = $cellspacing['H'];
18050 }
18051 // total table width without cellspaces
18052 $table_columns_width = ($table_width - ($cellspacing['H'] * ($dom[$key]['cols'] - 1)));
18053 // minimum column width
18054 $table_min_column_width = ($table_columns_width / $dom[$key]['cols']);
18055 // array of custom column widths
18056 $table_colwidths = array_fill(0, $dom[$key]['cols'], $table_min_column_width);
18057 }
18058 // table row
18059 if ($dom[$key]['value'] == 'tr') {
18060 // reset column counter
18061 $colid = 0;
18062 }
18063 // table cell
18064 if (($dom[$key]['value'] == 'td') OR ($dom[$key]['value'] == 'th')) {
18065 $trid = $dom[$key]['parent'];
18066 $table_el = $dom[$trid]['parent'];
18067 if (!isset($dom[$table_el]['cols'])) {
18068 $dom[$table_el]['cols'] = $dom[$trid]['cols'];
18069 }
18070 // store border info
18071 $tdborder = 0;
18072 if (isset($dom[$key]['border']) AND !empty($dom[$key]['border'])) {
18073 $tdborder = $dom[$key]['border'];
18074 }
18075 $colspan = intval($dom[$key]['attribute']['colspan']);
18076 if ($colspan <= 0) {
18077 $colspan = 1;
18078 }
18079 $old_cell_padding = $this->cell_padding;
18080 if (isset($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'])) {
18081 $crclpd = $this->getHTMLUnitToUnits($dom[($dom[$trid]['parent'])]['attribute']['cellpadding'], 1, 'px');
18082 $current_cell_padding = array('L' => $crclpd, 'T' => $crclpd, 'R' => $crclpd, 'B' => $crclpd);
18083 } elseif (isset($dom[($dom[$trid]['parent'])]['padding'])) {
18084 $current_cell_padding = $dom[($dom[$trid]['parent'])]['padding'];
18085 } else {
18086 $current_cell_padding = array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0);
18087 }
18088 $this->cell_padding = $current_cell_padding;
18089 if (isset($dom[$key]['height'])) {
18090 // minimum cell height
18092 } else {
18093 $cellh = 0;
18094 }
18095 if (isset($dom[$key]['content'])) {
18096 $cell_content = $dom[$key]['content'];
18097 } else {
18098 $cell_content = ' ';
18099 }
18100 $tagtype = $dom[$key]['value'];
18101 $parentid = $key;
18102 while (($key < $maxel) AND (!(($dom[$key]['tag']) AND (!$dom[$key]['opening']) AND ($dom[$key]['value'] == $tagtype) AND ($dom[$key]['parent'] == $parentid)))) {
18103 // move $key index forward
18104 ++$key;
18105 }
18106 if (!isset($dom[$trid]['startpage'])) {
18108 } else {
18110 }
18111 if (!isset($dom[$trid]['startcolumn'])) {
18113 } elseif ($this->current_column != $dom[$trid]['startcolumn']) {
18114 $tmpx = $this->x;
18116 $this->x = $tmpx;
18117 }
18118 if (!isset($dom[$trid]['starty'])) {
18120 } else {
18121 $this->y = $dom[$trid]['starty'];
18122 }
18123 if (!isset($dom[$trid]['startx'])) {
18125 $this->x += $cellspacingx;
18126 } else {
18127 $this->x += ($cellspacingx / 2);
18128 }
18129 if (isset($dom[$parentid]['attribute']['rowspan'])) {
18130 $rowspan = intval($dom[$parentid]['attribute']['rowspan']);
18131 } else {
18132 $rowspan = 1;
18133 }
18134 // skip row-spanned cells started on the previous rows
18135 if (isset($dom[$table_el]['rowspans'])) {
18136 $rsk = 0;
18137 $rskmax = count($dom[$table_el]['rowspans']);
18138 while ($rsk < $rskmax) {
18139 $trwsp = $dom[$table_el]['rowspans'][$rsk];
18140 $rsstartx = $trwsp['startx'];
18141 $rsendx = $trwsp['endx'];
18142 // account for margin changes
18143 if ($trwsp['startpage'] < $this->page) {
18144 if (($this->rtl) AND ($this->pagedim[$this->page]['orm'] != $this->pagedim[$trwsp['startpage']]['orm'])) {
18146 $rsstartx -= $dl;
18147 $rsendx -= $dl;
18148 } elseif ((!$this->rtl) AND ($this->pagedim[$this->page]['olm'] != $this->pagedim[$trwsp['startpage']]['olm'])) {
18150 $rsstartx += $dl;
18151 $rsendx += $dl;
18152 }
18153 }
18154 if (($trwsp['rowspan'] > 0)
18155 AND ($rsstartx > ($this->x - $cellspacing['H'] - $current_cell_padding['L'] - $this->feps))
18156 AND ($rsstartx < ($this->x + $cellspacing['H'] + $current_cell_padding['R'] + $this->feps))
18157 AND (($trwsp['starty'] < ($this->y - $this->feps)) OR ($trwsp['startpage'] < $this->page) OR ($trwsp['startcolumn'] < $this->current_column))) {
18158 // set the starting X position of the current cell
18159 $this->x = $rsendx + $cellspacingx;
18160 // increment column indicator
18161 $colid += $trwsp['colspan'];
18162 if (($trwsp['rowspan'] == 1)
18163 AND (isset($dom[$trid]['endy']))
18164 AND (isset($dom[$trid]['endpage']))
18165 AND (isset($dom[$trid]['endcolumn']))
18166 AND ($trwsp['endpage'] == $dom[$trid]['endpage'])
18167 AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
18168 // set ending Y position for row
18169 $dom[$table_el]['rowspans'][$rsk]['endy'] = max($dom[$trid]['endy'], $trwsp['endy']);
18170 $dom[$trid]['endy'] = $dom[$table_el]['rowspans'][$rsk]['endy'];
18171 }
18172 $rsk = 0;
18173 } else {
18174 ++$rsk;
18175 }
18176 }
18177 }
18178 if (isset($dom[$parentid]['width'])) {
18179 // user specified width
18181 $tmpcw = ($cellw / $colspan);
18182 for ($i = 0; $i < $colspan; ++$i) {
18183 $table_colwidths[($colid + $i)] = $tmpcw;
18184 }
18185 } else {
18186 // inherit column width
18187 $cellw = 0;
18188 for ($i = 0; $i < $colspan; ++$i) {
18189 $cellw += (isset($table_colwidths[($colid + $i)]) ? $table_colwidths[($colid + $i)] : 0);
18190 }
18191 }
18192 $cellw += (($colspan - 1) * $cellspacing['H']);
18193 // increment column indicator
18194 $colid += $colspan;
18195 // add rowspan information to table element
18196 if ($rowspan > 1) {
18197 $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));
18198 }
18199 $cellid = array_push($dom[$trid]['cellpos'], array('startx' => $this->x));
18200 if ($rowspan > 1) {
18201 $dom[$trid]['cellpos'][($cellid - 1)]['rowspanid'] = ($trsid - 1);
18202 }
18203 // push background colors
18204 if (isset($dom[$parentid]['bgcolor']) AND ($dom[$parentid]['bgcolor'] !== false)) {
18205 $dom[$trid]['cellpos'][($cellid - 1)]['bgcolor'] = $dom[$parentid]['bgcolor'];
18206 }
18207 // store border info
18208 if (isset($tdborder) AND !empty($tdborder)) {
18209 $dom[$trid]['cellpos'][($cellid - 1)]['border'] = $tdborder;
18210 }
18211 $prevLastH = $this->lasth;
18212 // store some info for multicolumn mode
18213 if ($this->rtl) {
18215 } else {
18217 }
18218 $this->colxshift['s'] = $cellspacing;
18219 $this->colxshift['p'] = $current_cell_padding;
18220 // ****** write the cell content ******
18221 $this->MultiCell($cellw, $cellh, $cell_content, false, $lalign, false, 2, '', '', true, 0, true, true, 0, 'T', false);
18222 // restore some values
18223 $this->colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
18224 $this->lasth = $prevLastH;
18225 $this->cell_padding = $old_cell_padding;
18226 $dom[$trid]['cellpos'][($cellid - 1)]['endx'] = $this->x;
18227 // update the end of row position
18228 if ($rowspan <= 1) {
18229 if (isset($dom[$trid]['endy'])) {
18230 if (($this->page == $dom[$trid]['endpage']) AND ($this->current_column == $dom[$trid]['endcolumn'])) {
18231 $dom[$trid]['endy'] = max($this->y, $dom[$trid]['endy']);
18232 } elseif (($this->page > $dom[$trid]['endpage']) OR ($this->current_column > $dom[$trid]['endcolumn'])) {
18234 }
18235 } else {
18237 }
18238 if (isset($dom[$trid]['endpage'])) {
18239 $dom[$trid]['endpage'] = max($this->page, $dom[$trid]['endpage']);
18240 } else {
18242 }
18243 if (isset($dom[$trid]['endcolumn'])) {
18244 $dom[$trid]['endcolumn'] = max($this->current_column, $dom[$trid]['endcolumn']);
18245 } else {
18247 }
18248 } else {
18249 // account for row-spanned cells
18250 $dom[$table_el]['rowspans'][($trsid - 1)]['endx'] = $this->x;
18251 $dom[$table_el]['rowspans'][($trsid - 1)]['endy'] = $this->y;
18252 $dom[$table_el]['rowspans'][($trsid - 1)]['endpage'] = $this->page;
18253 $dom[$table_el]['rowspans'][($trsid - 1)]['endcolumn'] = $this->current_column;
18254 }
18255 if (isset($dom[$table_el]['rowspans'])) {
18256 // update endy and endpage on rowspanned cells
18258 if ($trwsp['rowspan'] > 0) {
18259 if (isset($dom[$trid]['endpage'])) {
18260 if (($trwsp['endpage'] == $dom[$trid]['endpage']) AND ($trwsp['endcolumn'] == $dom[$trid]['endcolumn'])) {
18262 } elseif (($trwsp['endpage'] < $dom[$trid]['endpage']) OR ($trwsp['endcolumn'] < $dom[$trid]['endcolumn'])) {
18266 } else {
18267 $dom[$trid]['endy'] = $this->pagedim[$dom[$trid]['endpage']]['hk'] - $this->pagedim[$dom[$trid]['endpage']]['bm'];
18268 }
18269 }
18270 }
18271 }
18272 }
18273 $this->x += ($cellspacingx / 2);
18274 } else {
18275 // opening tag (or self-closing tag)
18276 if (!isset($opentagpos)) {
18277 if ($this->inxobj) {
18278 // we are inside an XObject template
18279 $opentagpos = strlen($this->xobjects[$this->xobjid]['outdata']);
18280 } elseif (!$this->InFooter) {
18281 if (isset($this->footerlen[$this->page])) {
18283 } else {
18285 }
18286 $opentagpos = $this->footerpos[$this->page];
18287 }
18288 }
18289 $dom = $this->openHTMLTagHandler($dom, $key, $cell);
18290 }
18291 } else { // closing tag
18292 $prev_numpages = $this->numpages;
18293 $old_bordermrk = $this->bordermrk[$this->page];
18294 $dom = $this->closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney);
18295 if ($this->bordermrk[$this->page] > $old_bordermrk) {
18296 $startlinepos += ($this->bordermrk[$this->page] - $old_bordermrk);
18297 }
18298 if ($prev_numpages > $this->numpages) {
18299 $startlinepage = $this->page;
18300 }
18301 }
18302 } elseif (strlen($dom[$key]['value']) > 0) {
18303 // print list-item
18305 $this->SetFont($pfontname, $pfontstyle, $pfontsize);
18306 $this->resetLastH();
18307 $minstartliney = $this->y;
18308 $maxbottomliney = ($startliney + $this->getCellHeight($this->FontSize));
18309 if (is_numeric($pfontsize) AND ($pfontsize > 0)) {
18310 $this->putHtmlListBullet($this->listnum, $this->lispacer, $pfontsize);
18311 }
18312 $this->SetFont($curfontname, $curfontstyle, $curfontsize);
18313 $this->resetLastH();
18314 if (is_numeric($pfontsize) AND ($pfontsize > 0) AND is_numeric($curfontsize) AND ($curfontsize > 0) AND ($pfontsize != $curfontsize)) {
18315 $pfontascent = $this->getFontAscent($pfontname, $pfontstyle, $pfontsize);
18316 $pfontdescent = $this->getFontDescent($pfontname, $pfontstyle, $pfontsize);
18317 $this->y += ($this->getCellHeight(($pfontsize - $curfontsize) / $this->k) + $pfontascent - $curfontascent - $pfontdescent + $curfontdescent) / 2;
18318 $minstartliney = min($this->y, $minstartliney);
18319 $maxbottomliney = max(($this->y + $this->getCellHeight($pfontsize / $this->k)), $maxbottomliney);
18320 }
18321 }
18322 // text
18323 $this->htmlvspace = 0;
18325 // reverse spaces order
18326 $lsp = ''; // left spaces
18327 $rsp = ''; // right spaces
18328 if (preg_match('/^('.$this->re_space['p'].'+)/'.$this->re_space['m'], $dom[$key]['value'], $matches)) {
18329 $lsp = $matches[1];
18330 }
18331 if (preg_match('/('.$this->re_space['p'].'+)$/'.$this->re_space['m'], $dom[$key]['value'], $matches)) {
18332 $rsp = $matches[1];
18333 }
18334 $dom[$key]['value'] = $rsp.$this->stringTrim($dom[$key]['value']).$lsp;
18335 }
18337 if (!$this->premode) {
18338 $prelen = strlen($dom[$key]['value']);
18340 // right trim except non-breaking space
18342 } else {
18343 // left trim except non-breaking space
18345 }
18346 $postlen = strlen($dom[$key]['value']);
18347 if (($postlen == 0) AND ($prelen > 0)) {
18348 $dom[$key]['trimmed_space'] = true;
18349 }
18350 }
18352 $firstblock = true;
18353 } else {
18354 $firstblock = false;
18355 // replace empty multiple spaces string with a single space
18356 $dom[$key]['value'] = preg_replace('/^'.$this->re_space['p'].'+$/'.$this->re_space['m'], chr(32), $dom[$key]['value']);
18357 }
18358 $strrest = '';
18359 if ($this->rtl) {
18360 $this->x -= $this->textindent;
18361 } else {
18362 $this->x += $this->textindent;
18363 }
18364 if (!isset($dom[$key]['trimmed_space']) OR !$dom[$key]['trimmed_space']) {
18366 if (!empty($this->HREF) AND (isset($this->HREF['url']))) {
18367 // HTML <a> Link
18368 $hrefcolor = '';
18369 if (isset($dom[($dom[$key]['parent'])]['fgcolor']) AND ($dom[($dom[$key]['parent'])]['fgcolor'] !== false)) {
18370 $hrefcolor = $dom[($dom[$key]['parent'])]['fgcolor'];
18371 }
18372 $hrefstyle = -1;
18373 if (isset($dom[($dom[$key]['parent'])]['fontstyle']) AND ($dom[($dom[$key]['parent'])]['fontstyle'] !== false)) {
18374 $hrefstyle = $dom[($dom[$key]['parent'])]['fontstyle'];
18375 }
18376 $strrest = $this->addHtmlLink($this->HREF['url'], $dom[$key]['value'], $wfill, true, $hrefcolor, $hrefstyle, true);
18377 } else {
18378 $wadj = 0; // space to leave for block continuity
18379 if ($this->rtl) {
18380 $cwa = ($this->x - $this->lMargin);
18381 } else {
18382 $cwa = ($this->w - $this->rMargin - $this->x);
18383 }
18384 if (($strlinelen < $cwa) AND (isset($dom[($key + 1)])) AND ($dom[($key + 1)]['tag']) AND (!$dom[($key + 1)]['block'])) {
18385 // check the next text blocks for continuity
18386 $nkey = ($key + 1);
18387 $write_block = true;
18388 $same_textdir = true;
18389 $tmp_fontname = $this->FontFamily;
18390 $tmp_fontstyle = $this->FontStyle;
18391 $tmp_fontsize = $this->FontSizePt;
18392 while ($write_block AND isset($dom[$nkey])) {
18393 if ($dom[$nkey]['tag']) {
18394 if ($dom[$nkey]['block']) {
18395 // end of block
18396 $write_block = false;
18397 }
18399 $tmp_fontstyle = isset($dom[$nkey]['fontstyle']) ? $dom[$nkey]['fontstyle'] : $this->FontStyle;
18401 $same_textdir = ($dom[$nkey]['dir'] == $dom[$key]['dir']);
18402 } else {
18403 $nextstr = TCPDF_STATIC::pregSplit('/'.$this->re_space['p'].'+/', $this->re_space['m'], $dom[$nkey]['value']);
18404 if (isset($nextstr[0]) AND $same_textdir) {
18405 $wadj += $this->GetStringWidth($nextstr[0], $tmp_fontname, $tmp_fontstyle, $tmp_fontsize);
18406 if (isset($nextstr[1])) {
18407 $write_block = false;
18408 }
18409 }
18410 }
18411 ++$nkey;
18412 }
18413 }
18414 if (($wadj > 0) AND (($strlinelen + $wadj) >= $cwa)) {
18415 $wadj = 0;
18416 $nextstr = TCPDF_STATIC::pregSplit('/'.$this->re_space['p'].'/', $this->re_space['m'], $dom[$key]['value']);
18417 $numblks = count($nextstr);
18418 if ($numblks > 1) {
18419 // try to split on blank spaces
18420 $wadj = ($cwa - $strlinelen + $this->GetStringWidth($nextstr[($numblks - 1)]));
18421 } else {
18422 // set the entire block on new line
18423 $wadj = $this->GetStringWidth($nextstr[0]);
18424 }
18425 }
18426 // check for reversed text direction
18427 if (($wadj > 0) AND (($this->rtl AND ($this->tmprtl === 'L')) OR (!$this->rtl AND ($this->tmprtl === 'R')))) {
18428 // LTR text on RTL direction or RTL text on LTR direction
18429 $reverse_dir = true;
18430 $this->rtl = !$this->rtl;
18431 $revshift = ($strlinelen + $wadj + 0.000001); // add little quantity for rounding problems
18432 if ($this->rtl) {
18433 $this->x += $revshift;
18434 } else {
18435 $this->x -= $revshift;
18436 }
18437 $xws = $this->x;
18438 }
18439 // ****** write only until the end of the line and get the rest ******
18440 $strrest = $this->Write($this->lasth, $dom[$key]['value'], '', $wfill, '', false, 0, true, $firstblock, 0, $wadj);
18441 // restore default direction
18442 if ($reverse_dir AND ($wadj == 0)) {
18443 $this->x = $xws;
18444 $this->rtl = !$this->rtl;
18445 $reverse_dir = false;
18446 }
18447 }
18448 }
18449 $this->textindent = 0;
18450 if (strlen($strrest) > 0) {
18451 // store the remaining string on the previous $key position
18452 $this->newline = true;
18453 if ($strrest == $dom[$key]['value']) {
18454 // used to avoid infinite loop
18455 ++$loop;
18456 } else {
18457 $loop = 0;
18458 }
18459 $dom[$key]['value'] = $strrest;
18460 if ($cell) {
18461 if ($this->rtl) {
18462 $this->x -= $this->cell_padding['R'];
18463 } else {
18464 $this->x += $this->cell_padding['L'];
18465 }
18466 }
18467 if ($loop < 3) {
18468 --$key;
18469 }
18470 } else {
18471 $loop = 0;
18472 // add the positive font spacing of the last character (if any)
18473 if ($this->font_spacing > 0) {
18474 if ($this->rtl) {
18475 $this->x -= $this->font_spacing;
18476 } else {
18477 $this->x += $this->font_spacing;
18478 }
18479 }
18480 }
18481 }
18482 ++$key;
18483 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')) {
18484 // check if we are on a new page or on a new column
18485 if ((!$undo) AND (($this->y < $this->start_transaction_y) OR (($dom[$key]['value'] == 'tr') AND ($dom[($dom[$key]['parent'])]['endy'] < $this->start_transaction_y)))) {
18486 // we are on a new page or on a new column and the total object height is less than the available vertical space.
18487 // restore previous object
18489 // restore previous values
18490 foreach ($this_method_vars as $vkey => $vval) {
18491 $$vkey = $vval;
18492 }
18493 if (!empty($dom[$key]['thead'])) {
18494 $this->inthead = true;
18495 }
18496 // add a page (or trig AcceptPageBreak() for multicolumn mode)
18497 $pre_y = $this->y;
18499 $startliney = $this->y;
18500 }
18501 $undo = true; // avoid infinite loop
18502 } else {
18503 $undo = false;
18504 }
18505 }
18506 } // end for each $key
18507 // align the last line
18508 if (isset($startlinex)) {
18509 $yshift = ($minstartliney - $startliney);
18510 if (($yshift > 0) OR ($this->page > $startlinepage)) {
18511 $yshift = 0;
18512 }
18513 $t_x = 0;
18514 // the last line must be shifted to be aligned as requested
18515 $linew = abs($this->endlinex - $startlinex);
18516 if ($this->inxobj) {
18517 // we are inside an XObject template
18518 $pstart = substr($this->xobjects[$this->xobjid]['outdata'], 0, $startlinepos);
18519 if (isset($opentagpos)) {
18520 $midpos = $opentagpos;
18521 } else {
18522 $midpos = 0;
18523 }
18524 if ($midpos > 0) {
18525 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos, ($midpos - $startlinepos));
18526 $pend = substr($this->xobjects[$this->xobjid]['outdata'], $midpos);
18527 } else {
18528 $pmid = substr($this->xobjects[$this->xobjid]['outdata'], $startlinepos);
18529 $pend = '';
18530 }
18531 } else {
18532 $pstart = substr($this->getPageBuffer($startlinepage), 0, $startlinepos);
18533 if (isset($opentagpos) AND isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
18534 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
18535 $midpos = min($opentagpos, $this->footerpos[$startlinepage]);
18536 } elseif (isset($opentagpos)) {
18537 $midpos = $opentagpos;
18538 } elseif (isset($this->footerlen[$startlinepage]) AND (!$this->InFooter)) {
18539 $this->footerpos[$startlinepage] = $this->pagelen[$startlinepage] - $this->footerlen[$startlinepage];
18540 $midpos = $this->footerpos[$startlinepage];
18541 } else {
18542 $midpos = 0;
18543 }
18544 if ($midpos > 0) {
18545 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos, ($midpos - $startlinepos));
18546 $pend = substr($this->getPageBuffer($startlinepage), $midpos);
18547 } else {
18548 $pmid = substr($this->getPageBuffer($startlinepage), $startlinepos);
18549 $pend = '';
18550 }
18551 }
18552 if ((isset($plalign) AND ((($plalign == 'C') OR (($plalign == 'R') AND (!$this->rtl)) OR (($plalign == 'L') AND ($this->rtl)))))) {
18553 // calculate shifting amount
18554 $tw = $w;
18555 if ($this->lMargin != $prevlMargin) {
18556 $tw += ($prevlMargin - $this->lMargin);
18557 }
18558 if ($this->rMargin != $prevrMargin) {
18559 $tw += ($prevrMargin - $this->rMargin);
18560 }
18561 $one_space_width = $this->GetStringWidth(chr(32));
18562 $no = 0; // number of spaces on a line contained on a single block
18564 // remove left space if exist
18566 if ($pos1 > 0) {
18567 $pos1 = intval($pos1);
18570 $spacelen = 2;
18571 } else {
18573 $spacelen = 1;
18574 }
18575 if ($pos1 == $pos2) {
18576 $pmid = substr($pmid, 0, ($pos1 + 2)).substr($pmid, ($pos1 + 2 + $spacelen));
18577 if (substr($pmid, $pos1, 4) == '[()]') {
18578 $linew -= $one_space_width;
18579 } elseif ($pos1 == strpos($pmid, '[(')) {
18580 $no = 1;
18581 }
18582 }
18583 }
18584 } else { // LTR
18585 // remove right space if exist
18587 if ($pos1 > 0) {
18588 $pos1 = intval($pos1);
18591 $spacelen = 2;
18592 } else {
18594 $spacelen = 1;
18595 }
18596 if ($pos1 == $pos2) {
18597 $pmid = substr($pmid, 0, ($pos1 - $spacelen)).substr($pmid, $pos1);
18598 $linew -= $one_space_width;
18599 }
18600 }
18601 }
18602 $mdiff = ($tw - $linew);
18603 if ($plalign == 'C') {
18604 if ($this->rtl) {
18605 $t_x = -($mdiff / 2);
18606 } else {
18607 $t_x = ($mdiff / 2);
18608 }
18609 } elseif ($plalign == 'R') {
18610 // right alignment on LTR document
18611 $t_x = $mdiff;
18612 } elseif ($plalign == 'L') {
18613 // left alignment on RTL document
18614 $t_x = -$mdiff;
18615 }
18616 } // end if startlinex
18617 if (($t_x != 0) OR ($yshift < 0)) {
18618 // shift the line
18619 $trx = sprintf('1 0 0 1 %F %F cm', ($t_x * $this->k), ($yshift * $this->k));
18620 $pstart .= "\nq\n".$trx."\n".$pmid."\nQ\n";
18621 $endlinepos = strlen($pstart);
18622 if ($this->inxobj) {
18623 // we are inside an XObject template
18625 foreach ($this->xobjects[$this->xobjid]['annotations'] as $pak => $pac) {
18626 if ($pak >= $pask) {
18629 }
18630 }
18631 } else {
18632 $this->setPageBuffer($startlinepage, $pstart.$pend);
18633 // shift the annotations and links
18634 if (isset($this->PageAnnots[$this->page])) {
18635 foreach ($this->PageAnnots[$this->page] as $pak => $pac) {
18636 if ($pak >= $pask) {
18639 }
18640 }
18641 }
18642 }
18643 $this->y -= $yshift;
18644 $yshift = 0;
18645 }
18646 }
18647 // restore previous values
18648 $this->setGraphicVars($gvars);
18649 if ($this->num_columns > 1) {
18650 $this->selectColumn();
18651 } elseif ($this->page > $prevPage) {
18654 }
18655 // restore previous list state
18656 $this->cell_height_ratio = $prev_cell_height_ratio;
18657 $this->listnum = $prev_listnum;
18658 $this->listordered = $prev_listordered;
18659 $this->listcount = $prev_listcount;
18660 $this->lispacer = $prev_lispacer;
18661 if ($ln AND (!($cell AND ($dom[$key-1]['value'] == 'table')))) {
18662 $this->Ln($this->lasth);
18663 if (($this->y < $maxbottomliney) AND ($startlinepage == $this->page)) {
18664 $this->y = $maxbottomliney;
18665 }
18666 }
18667 unset($dom);
18668 }
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:20332
rollbackTransaction($self=false)
This method allows to undo the latest transaction by returning the latest saved TCPDF object with sta...
Definition: tcpdf.php:21652
closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney=0)
Process closing tags.
Definition: tcpdf.php:19348
startTransaction()
Stores a copy of the current TCPDF object used for undo operation.
Definition: tcpdf.php:21621
$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:10375
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(), 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 17104 of file tcpdf.php.
17104 {
17105 return $this->MultiCell($w, $h, $html, $border, $align, $fill, $ln, $x, $y, $reseth, 0, true, $autopadding, 0, 'T', false);
17106 }
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:
- Services/PDFGeneration/classes/tcpdf/tcpdf.php
